Make catalog-diff return API objects

Author: Kevin Paulisse

lib/octocatalog-diff/api/v1/catalog-diff.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'catalog'
 require_relative 'common'
+require_relative 'diff'
 require_relative '../../util/catalogs'
 require_relative '../../catalog-util/cached_master_directory'
 
@@ -18,7 +20,6 @@ class CatalogDiff
         # @param :logger [Logger] Logger object (be sure to configure log level)
         # Other catalog-diff parameters are required
         # @return [OpenStruct] { :diffs (Array); :from (OctocatalogDiff::Catalog), :to (OctocatalogDiff::Catalog) }
-
         def self.catalog_diff(options = nil)
           # Validate the required options.
           unless options.is_a?(Hash)
@@ -56,9 +57,9 @@ def self.catalog_diff(options = nil)
 
           # Return diffs and catalogs in expected format
           OpenStruct.new(
-            diffs: diffs,
-            from: catalogs[:from],
-            to: catalogs[:to]
+            diffs: diffs.map { |x| OctocatalogDiff::API::V1::Diff.new(x) },
+            from: OctocatalogDiff::API::V1::Catalog.new(catalogs[:from]),
+            to: OctocatalogDiff::API::V1::Catalog.new(catalogs[:to])
           )
         end
       end

lib/octocatalog-diff/api/v1/diff.rb

@@ -14,7 +14,8 @@ module V1
       #   [4] File and line of the "old" catalog
       #   [5] File and line of the "new" catalog
       # This object seeks to preserve this traditional structure, while providing methods to make it
-      # easier to deal with.
+      # easier to deal with. We recommend using the named options, rather than #raw or the indexed array,
+      # as the raw object and indexed array are not guaranteed to be stable.
       class Diff
         attr_reader :raw
 
@@ -48,12 +49,18 @@ def change_type_word
           raise ArgumentError, "No change type corresponds to #{@raw[0].inspect}"
         end
 
-        # Public: Get the type_title string
+        # Public: Get the type_title_structure string
         # @return [?] Type_title_structure
-        def type_title
+        def type_title_structure
           @raw[1]
         end
 
+        # Public: For shortening, `tts` = `Type Title Structure`
+        # @return [?] Type_title_structure
+        def tts
+          type_title_structure
+        end
+
         # Public: Get the resource type
         # @return [String] Resource type
         def type

lib/octocatalog-diff/cli.rb

@@ -112,14 +112,15 @@ def self.cli(argv = ARGV, logger = Logger.new(STDERR), opts = {})
 
       # Compile catalogs and do catalog-diff
       catalog_diff = OctocatalogDiff::API::V1::CatalogDiff.catalog_diff(options.merge(logger: logger))
+      diffs = catalog_diff.diffs.map(&:raw)
 
       # Display diffs
       printer_obj = OctocatalogDiff::Cli::Printer.new(options, logger)
-      printer_obj.printer(catalog_diff.diffs, catalog_diff.from.compilation_dir, catalog_diff.to.compilation_dir)
+      printer_obj.printer(diffs, catalog_diff.from.compilation_dir, catalog_diff.to.compilation_dir)
 
       # Return the diff object if requested (generally for testing) or otherwise return exit code
-      return catalog_diff.diffs if opts[:RETURN_DIFFS]
-      catalog_diff.diffs.any? ? EXITCODE_SUCCESS_WITH_DIFFS : EXITCODE_SUCCESS_NO_DIFFS
+      return diffs if opts[:RETURN_DIFFS]
+      diffs.any? ? EXITCODE_SUCCESS_WITH_DIFFS : EXITCODE_SUCCESS_NO_DIFFS
     end
 
     # Parse command line options with 'optparse'. Returns a hash with the parsed arguments.

spec/octocatalog-diff/integration/api_catalog_compile_spec.rb

@@ -23,7 +23,8 @@
     end
 
     it 'should return a catalog object' do
-      expect(@result).to be_a_kind_of(OctocatalogDiff::Catalog)
+      expect(@result).to be_a_kind_of(OctocatalogDiff::API::V1::Catalog)
+      expect(@result.raw).to be_a_kind_of(OctocatalogDiff::Catalog)
     end
 
     it 'should be a valid catalog' do

spec/octocatalog-diff/tests/api/v1/catalog-diff_spec.rb

@@ -10,6 +10,11 @@
 
 describe OctocatalogDiff::API::V1::CatalogDiff do
   describe '#catalog_diff' do
+    before(:each) do
+      @from_catalog = OctocatalogDiff::Catalog.new(backend: :noop)
+      @to_catalog = OctocatalogDiff::Catalog.new(backend: :noop)
+    end
+
     it 'should raise error if no options are passed' do
       expect { described_class.catalog_diff }.to raise_error(ArgumentError)
     end
@@ -20,21 +25,22 @@
 
     context 'with :cached_master_dir undefined' do
       before(:each) do
-        catalog_obj = OpenStruct.new(catalogs: { from: 'from-catalog', to: 'to-catalog' })
+        catalog_obj = OpenStruct.new(catalogs: { from: @from_catalog, to: @to_catalog })
         expect(OctocatalogDiff::Util::Catalogs).to receive(:new).and_return(catalog_obj)
 
         diffs_obj = double
-        allow(diffs_obj).to receive(:diffs).and_return(['diff-1', 'diff-2'])
+        allow(diffs_obj).to receive(:diffs).and_return([['diff-1'], ['diff-2']])
         expect(OctocatalogDiff::Cli::Diffs).to receive(:new).and_return(diffs_obj)
 
         logger, @logger_str = OctocatalogDiff::Spec.setup_logger
         @result = described_class.catalog_diff(logger: logger, node: 'foo')
       end
 
       it 'should return the expected data structure' do
-        expect(@result.diffs).to eq(['diff-1', 'diff-2'])
-        expect(@result.from).to eq('from-catalog')
-        expect(@result.to).to eq('to-catalog')
+        expect(@result.diffs[0].raw).to eq(['diff-1'])
+        expect(@result.diffs[1].raw).to eq(['diff-2'])
+        expect(@result.from.raw).to eq(@from_catalog)
+        expect(@result.to.raw).to eq(@to_catalog)
       end
 
       it 'should log the expected messages' do
@@ -48,10 +54,9 @@
 
     context 'with :cached_master_dir defined' do
       before(:each) do
-        @from_catalog = double
         expect(@from_catalog).to receive(:"compilation_dir=").with('foo')
 
-        catalog_obj = OpenStruct.new(catalogs: { from: @from_catalog, to: 'to-catalog' })
+        catalog_obj = OpenStruct.new(catalogs: { from: @from_catalog, to: @to_catalog })
         expect(OctocatalogDiff::Util::Catalogs).to receive(:new).and_return(catalog_obj)
 
         expect(OctocatalogDiff::CatalogUtil::CachedMasterDirectory).to receive(:save_catalog_in_cache_dir).and_return('yes')
@@ -66,8 +71,8 @@
 
       it 'should return the expected data structure' do
         expect(@result.diffs).to eq([])
-        expect(@result.from).to eq(@from_catalog)
-        expect(@result.to).to eq('to-catalog')
+        expect(@result.from.raw).to eq(@from_catalog)
+        expect(@result.to.raw).to eq(@to_catalog)
       end
 
       it 'should log the expected messages' do