Separate unit and integration tests for compilation_dir

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-diff/filter/compilation_dir.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../api/v1/diff'
+require_relative '../filter'
 
 module OctocatalogDiff
   module CatalogDiff
@@ -25,7 +26,6 @@ def filtered?(diff_in, options = {})
           dir2_rexp = Regexp.escape(dir2)
           dir = Regexp.new("(?:#{dir1_rexp}|#{dir2_rexp})")
           diff = OctocatalogDiff::API::V1::Diff.new(diff_in)
-          #          raise "Called on #{diff.inspect} with #{options.inspect}"
 
           # Check for added/removed resources where the title of the resource includes the compilation directory
           if (diff.addition? || diff.removal?) && diff.title.match(dir)

spec/octocatalog-diff/integration/compilation_dir_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative '../tests/spec_helper'
+require OctocatalogDiff::Spec.require_path('/catalog')
+require OctocatalogDiff::Spec.require_path('/catalog-diff/filter/compilation_dir')
+require OctocatalogDiff::Spec.require_path('/cli/diffs')
+
+describe OctocatalogDiff::CatalogDiff::Filter::CompilationDir do
+  before(:all) do
+    @cat_compilation_dir_1 = OctocatalogDiff::Catalog.new(
+      node: 'my.rspec.node',
+      basedir: '/path/to/catalog1',
+      json: File.read(OctocatalogDiff::Spec.fixture_path('catalogs/compilation-dir-1.json'))
+    )
+    @cat_compilation_dir_2 = OctocatalogDiff::Catalog.new(
+      node: 'my.rspec.node',
+      basedir: '/path/to/catalog2',
+      json: File.read(OctocatalogDiff::Spec.fixture_path('catalogs/compilation-dir-2.json'))
+    )
+  end
+
+  before(:each) do
+    @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
+  end
+
+  it 'should remove +/- full title changes due to compilation dirs' do
+    opts = {
+      ignore: [
+        { type: 'Varies_Due_To_Compilation_Dir_2' },
+        { type: 'Varies_Due_To_Compilation_Dir_3' },
+        { type: 'Varies_Due_To_Compilation_Dir_4' }
+      ]
+    }
+    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
+    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
+    expect(result).to eq([])
+    expect(@logger_str.string).to match(%r{Varies_Due_To_Compilation_Dir_1\[/path/to/catalog2\] .*Suppressed})
+    expect(@logger_str.string).to match(%r{Varies_Due_To_Compilation_Dir_1\[/path/to/catalog1\] .*Suppressed})
+  end
+
+  it 'should remove +/- partial title changes due to compilation dirs' do
+    opts = { ignore:
+      [
+        { type: 'Varies_Due_To_Compilation_Dir_1' },
+        { type: 'Varies_Due_To_Compilation_Dir_3' },
+        { type: 'Varies_Due_To_Compilation_Dir_4' }
+      ] }
+    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
+    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
+    expect(result).to eq([])
+    r1 = %r{Varies_Due_To_Compilation_Dir_2\[/aldsfjalkfjalksfd/path/to/catalog2/dflkjasfkljasdf\].*Suppressed}
+    expect(@logger_str.string).to match(r1)
+    r2 = %r{Varies_Due_To_Compilation_Dir_2\[/aldsfjalkfjalksfd/path/to/catalog1/dflkjasfkljasdf\].*Suppressed}
+    expect(@logger_str.string).to match(r2)
+  end
+
+  it 'should remove ~ changes due to compilation dirs' do
+    opts = { ignore:
+      [
+        { type: 'Varies_Due_To_Compilation_Dir_1' },
+        { type: 'Varies_Due_To_Compilation_Dir_2' },
+        { type: 'Varies_Due_To_Compilation_Dir_4' },
+        { attr: "parameters\fdir_in_first_cat" },
+        { attr: "parameters\fdir_in_second_cat" }
+      ] }
+    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
+    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
+    expect(result).to eq([])
+    expect(@logger_str.string).to match(/WARN -- : Resource key.*parameters => dir .*Suppressed/)
+    expect(@logger_str.string).to match(/WARN -- : Resource key.*parameters => dir_in_middle .*Suppressed/)
+  end
+
+  it 'should warn but not remove non-matching ! changes due to compilation dirs' do
+    opts = { ignore:
+      [
+        { type: 'Varies_Due_To_Compilation_Dir_1' },
+        { type: 'Varies_Due_To_Compilation_Dir_2' },
+        { type: 'Varies_Due_To_Compilation_Dir_4' },
+        { attr: "parameters\fdir" },
+        { attr: "parameters\fdir_in_middle" }
+      ] }
+    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
+    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
+    expect(result.size).to eq(2)
+    common_str = "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\f"
+    expect(result[0][1]).to eq("#{common_str}dir_in_first_cat")
+    expect(result[1][1]).to eq("#{common_str}dir_in_second_cat")
+    expect(@logger_str.string).to match(/WARN.+Varies_Due_To_Compilation_Dir_3\[Common Title\] parameters => dir.*verify/)
+  end
+
+  it 'should warn but not remove non-matching ~ changes due to compilation dirs' do
+    opts = { ignore:
+      [
+        { type: 'Varies_Due_To_Compilation_Dir_1' },
+        { type: 'Varies_Due_To_Compilation_Dir_2' },
+        { type: 'Varies_Due_To_Compilation_Dir_3' }
+      ] }
+    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
+    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
+    answer = [[
+      '~',
+      "Varies_Due_To_Compilation_Dir_4\fCommon Title\fparameters\fdir",
+      '/path/to/catalog1/onetime',
+      '/path/to/catalog2/twotimes',
+      { 'file' => nil, 'line' => nil },
+      { 'file' => nil, 'line' => nil }
+    ]]
+    expect(result).to eq(answer)
+    expect(@logger_str.string).to match(/WARN -- : Resource key Varies_Due_To_Compilation_Dir_4.*please verify/)
+  end
+end

spec/octocatalog-diff/tests/catalog-diff/filter/compilation_dir_spec.rb

@@ -1,111 +1,180 @@
 # frozen_string_literal: true
 
 require_relative '../../spec_helper'
-require OctocatalogDiff::Spec.require_path('/catalog')
 require OctocatalogDiff::Spec.require_path('/catalog-diff/filter/compilation_dir')
-require OctocatalogDiff::Spec.require_path('/cli/diffs')
 
 describe OctocatalogDiff::CatalogDiff::Filter::CompilationDir do
-  before(:all) do
-    @cat_compilation_dir_1 = OctocatalogDiff::Catalog.new(
-      node: 'my.rspec.node',
-      basedir: '/path/to/catalog1',
-      json: File.read(OctocatalogDiff::Spec.fixture_path('catalogs/compilation-dir-1.json'))
-    )
-    @cat_compilation_dir_2 = OctocatalogDiff::Catalog.new(
-      node: 'my.rspec.node',
-      basedir: '/path/to/catalog2',
-      json: File.read(OctocatalogDiff::Spec.fixture_path('catalogs/compilation-dir-2.json'))
-    )
-  end
+  let(:opts) { { from_compilation_dir: '/path/to/catalog1', to_compilation_dir: '/path/to/catalog2' } }
 
   before(:each) do
     @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
   end
 
-  it 'should remove +/- full title changes due to compilation dirs' do
-    opts = {
-      ignore: [
-        { type: 'Varies_Due_To_Compilation_Dir_2' },
-        { type: 'Varies_Due_To_Compilation_Dir_3' },
-        { type: 'Varies_Due_To_Compilation_Dir_4' }
+  subject { described_class.new([], @logger) }
+
+  context '+/- full title change' do
+    it 'should remove due to compilation dirs in to-catalog' do
+      diff = [
+        '+',
+        "Varies_Due_To_Compilation_Dir_1\f/path/to/catalog2",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/path/to/catalog2',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
       ]
-    }
-    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
-    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
-    expect(result).to eq([])
-    expect(@logger_str.string).to match(%r{Varies_Due_To_Compilation_Dir_1\[/path/to/catalog2\] .*Suppressed})
-    expect(@logger_str.string).to match(%r{Varies_Due_To_Compilation_Dir_1\[/path/to/catalog1\] .*Suppressed})
-  end
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
 
-  it 'should remove +/- partial title changes due to compilation dirs' do
-    opts = { ignore:
-      [
-        { type: 'Varies_Due_To_Compilation_Dir_1' },
-        { type: 'Varies_Due_To_Compilation_Dir_3' },
-        { type: 'Varies_Due_To_Compilation_Dir_4' }
-      ] }
-    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
-    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
-    expect(result).to eq([])
-    r1 = %r{Varies_Due_To_Compilation_Dir_2\[/aldsfjalkfjalksfd/path/to/catalog2/dflkjasfkljasdf\].*Suppressed}
-    expect(@logger_str.string).to match(r1)
-    r2 = %r{Varies_Due_To_Compilation_Dir_2\[/aldsfjalkfjalksfd/path/to/catalog1/dflkjasfkljasdf\].*Suppressed}
-    expect(@logger_str.string).to match(r2)
+    it 'should remove due to compilation dirs in from-catalog' do
+      diff = [
+        '-',
+        "Varies_Due_To_Compilation_Dir_1\f/path/to/catalog1",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/path/to/catalog1',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
+
+    it 'should not remove a non-matching directory' do
+      diff = [
+        '-',
+        "Varies_Due_To_Compilation_Dir_1\f/path/to/catalog3",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/path/to/catalog3',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(false)
+    end
   end
 
-  it 'should remove ~ changes due to compilation dirs' do
-    opts = { ignore:
-      [
-        { type: 'Varies_Due_To_Compilation_Dir_1' },
-        { type: 'Varies_Due_To_Compilation_Dir_2' },
-        { type: 'Varies_Due_To_Compilation_Dir_4' },
-        { attr: "parameters\fdir_in_first_cat" },
-        { attr: "parameters\fdir_in_second_cat" }
-      ] }
-    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
-    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
-    expect(result).to eq([])
-    expect(@logger_str.string).to match(/WARN -- : Resource key.*parameters => dir .*Suppressed/)
-    expect(@logger_str.string).to match(/WARN -- : Resource key.*parameters => dir_in_middle .*Suppressed/)
+  context '+/- partial title change' do
+    it 'should remove due to compilation dirs in to-catalog' do
+      diff = [
+        '+',
+        "Varies_Due_To_Compilation_Dir_1\f/aldsfjalkfjalksfd/path/to/catalog2/aldsfjalkfjalksfd",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/aldsfjalkfjalksfd/path/to/catalog2/aldsfjalkfjalksfd',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
+
+    it 'should remove due to compilation dirs in from-catalog' do
+      diff = [
+        '-',
+        "Varies_Due_To_Compilation_Dir_1\f/aldsfjalkfjalksfd/path/to/catalog1/aldsfjalkfjalksfd",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/aldsfjalkfjalksfd/path/to/catalog1/aldsfjalkfjalksfd',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
+
+    it 'should not remove a non-matching directory' do
+      diff = [
+        '-',
+        "Varies_Due_To_Compilation_Dir_1\f/aldsfjalkfjalksfd/path/to/catalog3/aldsfjalkfjalksfd",
+        {
+          'type' => 'Varies_Due_To_Compilation_Dir_1',
+          'title' => '/aldsfjalkfjalksfd/path/to/catalog3/aldsfjalkfjalksfd',
+          'tags' => ['ignoreme'],
+          'exported' => false
+        },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(false)
+    end
   end
 
-  it 'should warn but not remove non-matching ! changes due to compilation dirs' do
-    opts = { ignore:
-      [
-        { type: 'Varies_Due_To_Compilation_Dir_1' },
-        { type: 'Varies_Due_To_Compilation_Dir_2' },
-        { type: 'Varies_Due_To_Compilation_Dir_4' },
-        { attr: "parameters\fdir" },
-        { attr: "parameters\fdir_in_middle" }
-      ] }
-    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
-    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
-    expect(result.size).to eq(2)
-    common_str = "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\f"
-    expect(result[0][1]).to eq("#{common_str}dir_in_first_cat")
-    expect(result[1][1]).to eq("#{common_str}dir_in_second_cat")
-    expect(@logger_str.string).to match(/WARN.+Varies_Due_To_Compilation_Dir_3\[Common Title\] parameters => dir.*verify/)
+  context '~ value changes' do
+    it 'should remove a change where directories are a partial match' do
+      diff = [
+        '~',
+        "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\fdir_in_middle",
+        '/asdfjkafds/path/to/catalog1/slkdfjasflkd',
+        '/asdfjkafds/path/to/catalog2/slkdfjasflkd',
+        { 'file' => nil, 'line' => nil },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
+
+    it 'should remove a change where directories are a full match' do
+      diff = [
+        '~',
+        "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\fdir",
+        '/path/to/catalog1',
+        '/path/to/catalog2',
+        { 'file' => nil, 'line' => nil },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(true)
+    end
+
+    it 'should not remove a change where directories are inverted' do
+      diff = [
+        '~',
+        "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\fdir",
+        '/path/to/catalog2',
+        '/path/to/catalog1',
+        { 'file' => nil, 'line' => nil },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(false)
+    end
+
+    it 'should not remove a change where directories do not match' do
+      diff = [
+        '~',
+        "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\fdir",
+        '/var/tmp/alsdfksfmd',
+        '/var/tmp/adfklweoif',
+        { 'file' => nil, 'line' => nil },
+        { 'file' => nil, 'line' => nil }
+      ]
+      expect(subject.filtered?(diff, opts)).to eq(false)
+    end
   end
 
-  it 'should warn but not remove non-matching ~ changes due to compilation dirs' do
-    opts = { ignore:
+  context '~ partial indeterminate matches' do
+    let(:diff) do
       [
-        { type: 'Varies_Due_To_Compilation_Dir_1' },
-        { type: 'Varies_Due_To_Compilation_Dir_2' },
-        { type: 'Varies_Due_To_Compilation_Dir_3' }
-      ] }
-    testobj = OctocatalogDiff::Cli::Diffs.new(opts, @logger)
-    result = testobj.diffs(from: @cat_compilation_dir_1, to: @cat_compilation_dir_2)
-    answer = [[
-      '~',
-      "Varies_Due_To_Compilation_Dir_4\fCommon Title\fparameters\fdir",
-      '/path/to/catalog1/onetime',
-      '/path/to/catalog2/twotimes',
-      { 'file' => nil, 'line' => nil },
-      { 'file' => nil, 'line' => nil }
-    ]]
-    expect(result).to eq(answer)
-    expect(@logger_str.string).to match(/WARN -- : Resource key Varies_Due_To_Compilation_Dir_4.*please verify/)
+        '~',
+        "Varies_Due_To_Compilation_Dir_3\fCommon Title\fparameters\fdir",
+        '/var/tmp/alsdfksfmd',
+        '/path/to/catalog2',
+        { 'file' => nil, 'line' => nil },
+        { 'file' => nil, 'line' => nil }
+      ]
+    end
+
+    it 'should not remove changes that do not match fully' do
+      expect(subject.filtered?(diff, opts)).to eq(false)
+    end
+
+    it 'should log warning message' do
+      subject.filtered?(diff, opts)
+      expect(@logger_str.string).to match(/WARN.*Varies_Due_To_Compilation_Dir_3\[Common Title\] parameters => dir.+differences/)
+    end
   end
 end