Add spec test coverage for YAML ignorer

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-diff/differ.rb

@@ -187,7 +187,7 @@ def equivalent_yaml_files?(diff)
         return false unless diff[0] == '~' || diff[0] == '!'
 
         # Make sure we are comparing file content for a file ending in .yaml or .yml extension
-        return false unless diff[1] =~ /^File\f.+\.ya?ml\fparameters\fcontent$/
+        return false unless diff[1] =~ /^File\f([^\f]+)\.ya?ml\fparameters\fcontent$/
 
         # Attempt to convert the old (diff[2]) and new (diff[3]) into YAML objects. Assuming
         # that doesn't error out, the return value is whether or not they're equal.
@@ -208,7 +208,7 @@ def filter_diffs_for_absent_files(result)
         absent_files = Set.new
         result.each do |diff|
           next unless diff[0] == '~' || diff[0] == '!'
-          next unless diff[1] =~ /^File\f(.+)\fparameters\fensure$/
+          next unless diff[1] =~ /^File\f([^\f]+)\fparameters\fensure$/
           next unless ['absent', 'false', false].include?(diff[3])
           absent_files.add Regexp.last_match(1)
         end

spec/octocatalog-diff/tests/catalog-diff/differ_spec.rb

@@ -532,7 +532,9 @@
       end
     end
   end
+end
 
+describe OctocatalogDiff::CatalogDiff::Differ do
   context 'ignoring only adds / removes / changes' do
     describe '#ignore' do
       before(:all) do
@@ -1279,4 +1281,73 @@
       expect(@logger_str.string).to match(/Exiting filter_diffs_for_absent_files with 7 diffs/)
     end
   end
+
+  describe '#filter_diffs_for_equivalent_yaml_files' do
+    let(:obj) { described_class.allocate }
+    let(:str1a) { "---\n  foo: bar" }
+    let(:str1b) { "---\nfoo: bar" }
+    let(:str2) { "---\n  foo: baz" }
+
+    it 'should not filter out an added resource' do
+      result = [['+', "File\ffoobar.yaml", { 'parameters' => { 'content' => str1a } }]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a removed resource' do
+      result = [['-', "File\ffoobar.yaml", { 'parameters' => { 'content' => str1a } }]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a non-file resource' do
+      result = [['~', "Exec\ffoobar.yaml\fparameters\fcontent", str1a, str1b]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a file whose extension is not .yaml / .yml' do
+      result = [['~', "File\ffoobar.json\fparameters\fcontent", str1a, str1b]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a change with no content change' do
+      result = [['~', "File\ffoobar.json\fparameters\fowner", 'root', 'nobody']]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a change where YAML objects are dissimilar' do
+      result = [['~', "File\ffoobar.yaml\fparameters\fcontent", str1a, str2]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a change where YAML is invalid' do
+      x_str = '---{ "blah": "foo" }'
+      result = [['~', "File\ffoobar.yaml\fparameters\fcontent", x_str, x_str]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should not filter out a change where YAML is unparseable' do
+      x_str = "--- !ruby/object:This::Does::Not::Exist\n  foo: bar"
+      result = [['~', "File\ffoobar.yaml\fparameters\fcontent", x_str, x_str]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(1)
+    end
+
+    it 'should filter out a whitespace-only change to a .yaml file' do
+      result = [['~', "File\ffoobar.yaml\fparameters\fcontent", str1a, str1b]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(0)
+    end
+
+    it 'should filter out a whitespace-only change to a .yml file' do
+      result = [['~', "File\ffoobar.yml\fparameters\fcontent", str1a, str1b]]
+      obj.send(:filter_diffs_for_equivalent_yaml_files, result)
+      expect(result.size).to eq(0)
+    end
+  end
 end