Merge pull request #71 from github/kpaulisse-integration-test-datatype-display

Add integration test demonstrating #70

Author: kpaulisse

lib/octocatalog-diff/catalog-diff/display/text.rb

@@ -395,8 +395,9 @@ def self.adjust_for_display_datatype_changes(diff, option, logger = nil)
               else
                 # Adjust the display and return modified object
                 msg = "Adjust display for #{diff_obj[1].gsub(/\f/, '::')}: " \
-                      "#{diff_obj[2].inspect} -> #{x2}; "\
-                      "#{diff_obj[3].inspect} -> #{x3}"
+                      "old=#{x2.inspect} new=#{x3.inspect} "\
+                      "(extra debugging: #{diff_obj[2].inspect} -> #{x2}; "\
+                      "#{diff_obj[3].inspect} -> #{x3})"
                 logger.debug(msg) if logger
                 diff_obj[2] = x2
                 diff_obj[3] = x3

spec/octocatalog-diff/fixtures/diffs/datatype-differences.json

@@ -0,0 +1,33 @@
+[
+  [
+    "+",
+    "File\f/tmp/foo",
+    {
+      "type": "File",
+      "title": "/tmp/new-file/ignored/one",
+      "exported": false,
+      "parameters": {
+        "content": "new repo",
+        "tag": "ignored_catalog_diff"
+      }
+    },
+    {
+      "file": "/var/folders/dw/xxx/T/yyy/environments/production/modules/mymodule/manifests/resource2.pp",
+      "line": 17
+    }
+  ],
+  [
+    "~",
+    "File\f/tmp/bar\fparameters\fmode",
+    755,
+    "755",
+    {
+      "file": "/var/folders/dw/xxx/T/yyy/environments/production/modules/mymodule/manifests/resource2.pp",
+      "line": 27
+    },
+    {
+      "file": "/var/folders/dw/xxx/T/yyy/environments/production/modules/mymodule/manifests/resource2.pp",
+      "line": 27
+    }
+  ]
+]

spec/octocatalog-diff/integration/datatype_display_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'integration_helper'
+
+require 'json'
+
+require OctocatalogDiff::Spec.require_path('/api/v1')
+require OctocatalogDiff::Spec.require_path('/cli/printer')
+
+describe 'datatype display integration' do
+  let(:diff_array_1) { JSON.parse(OctocatalogDiff::Spec.fixture_read('diffs/datatype-differences.json')) }
+  let(:diff_array_2) { JSON.parse(OctocatalogDiff::Spec.fixture_read('diffs/ignore-tags-reversed.json')) }
+
+  before(:each) do
+    @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
+    @stdout_cache = $stdout
+    @stderr_cache = $stderr
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after(:each) do
+    $stdout = @stdout_cache
+    $stderr = @stderr_cache
+  end
+
+  context 'display enabled' do
+    let(:options) { { display_datatype_changes: true, format: :text } }
+    context 'with datatype changes' do
+      it 'should display proper differences and debug messages' do
+        subject = OctocatalogDiff::Cli::Printer.new(options, @logger)
+        subject.printer(diff_array_1)
+        expect($stderr.string).to eq('')
+        stdout = $stdout.string.split(/\n/).map(&:strip)
+        expect(stdout).to include('File[/tmp/bar] =>')
+        expect(stdout).to include('- 755')
+        expect(stdout).to include('+ "755"')
+        r = Regexp.escape('Adjust display for File::/tmp/bar::parameters::mode: old=755 new="\"755\""')
+        expect(@logger_str.string).to match(Regexp.new(r))
+      end
+    end
+
+    context 'with no datatype changes' do
+      it 'should display proper differences and debug messages' do
+        subject = OctocatalogDiff::Cli::Printer.new(options, @logger)
+        subject.printer(diff_array_2)
+        expect($stderr.string).to eq('')
+        stdout = $stdout.string.split(/\n/).map(&:strip)
+        expect(stdout).to include('Mymodule::Resource2[three] =>')
+        expect(stdout).to include('- BAR-NEW')
+        expect(stdout).to include('+ BAR-OLD')
+        expect(@logger_str.string).not_to match(/Adjust display for/)
+      end
+    end
+  end
+
+  context 'display disabled' do
+    let(:options) { { display_datatype_changes: false, format: :text } }
+    context 'with datatype changes' do
+      it 'should display proper differences and debug messages' do
+        subject = OctocatalogDiff::Cli::Printer.new(options, @logger)
+        subject.printer(diff_array_1)
+        expect($stderr.string).to eq('')
+        stdout = $stdout.string.split(/\n/).map(&:strip)
+        expect(stdout).to include('+ File[/tmp/foo]')
+        expect(stdout).not_to include('File[/tmp/bar] =>')
+        expect(@logger_str.string).to match(%r{Adjust display for File::/tmp/bar::parameters::mode: 755 != "755" DELETED})
+      end
+    end
+
+    context 'with no datatype changes' do
+      it 'should display proper differences and debug messages' do
+        subject = OctocatalogDiff::Cli::Printer.new(options, @logger)
+        subject.printer(diff_array_2)
+        expect($stderr.string).to eq('')
+        stdout = $stdout.string.split(/\n/).map(&:strip)
+        expect(stdout).to include('Mymodule::Resource2[three] =>')
+        expect(stdout).to include('- BAR-NEW')
+        expect(stdout).to include('+ BAR-OLD')
+        expect(@logger_str.string).not_to match(/Adjust display for/)
+      end
+    end
+  end
+end