Create wrapper class around OctocatalogDiff::Catalog

Author: Kevin Paulisse

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'catalog'
 require_relative 'common'
 require_relative '../../util/catalogs'
 
@@ -31,7 +32,7 @@ def self.catalog(options = nil)
             to_catalog: nil, # Forces a compile
           )
           cat_obj = OctocatalogDiff::Util::Catalogs.new(catalog_opts, logger)
-          cat_obj.catalogs[:to]
+          OctocatalogDiff::API::V1::Catalog.new(cat_obj.catalogs[:to])
         end
       end
     end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative '../../catalog'
+
+require 'ostruct'
+
+module OctocatalogDiff
+  module API
+    module V1
+      # This is a wrapper class around OctocatalogDiff::Catalog. This contains the methods we
+      # are choosing to expose, and will be a compatibility layer should underlying methods
+      # change in the future. The raw object will be available as `#raw` but this is not
+      # guaranteed to be stable.
+      class Catalog
+        attr_reader :raw
+
+        # Constructor: Accepts a raw OctocatalogDiff::Catalog object and stores it.
+        # @param raw [OctocatalogDiff::Catalog] Catalog object
+        def initialize(raw)
+          unless raw.is_a?(OctocatalogDiff::Catalog)
+            raise ArgumentError, 'OctocatalogDiff::API::V1::Catalog#initialize expects OctocatalogDiff::Catalog argument'
+          end
+          @raw = raw
+        end
+
+        # Public: Get the builder for the catalog
+        # @return [String] Class of backend used
+        def builder
+          @raw.builder
+        end
+
+        # Public: Get the JSON for the catalog
+        # @return [String] Catalog JSON
+        def catalog_json
+          @raw.catalog_json
+        end
+
+        # Public: Get the compilation directory
+        # @return [String] Compilation directory
+        def compilation_dir
+          @raw.compilation_dir
+        end
+
+        # Public: Get the error message
+        # @return [String] Error message, or nil if no error
+        def error_message
+          @raw.error_message
+        end
+
+        # Public: Get the Puppet version used to compile the catalog
+        # @return [String] Puppet version
+        def puppet_version
+          @raw.puppet_version
+        end
+
+        # Public: Get a specific resource identified by type and title.
+        # This is intended for use when a O(1) lookup is required.
+        # @param :type [String] Type of resource
+        # @param :title [String] Title of resource
+        # @return [Hash] Resource item
+        def resource(opts = {})
+          @raw.resource(opts)
+        end
+
+        # Public: Get the resources in the catalog
+        # @return [Array] Resource array
+        def resources
+          @raw.resources
+        end
+
+        # Public: Determine if the catalog build was successful.
+        # @return [Boolean] Whether the catalog is valid
+        def valid?
+          @raw.valid?
+        end
+      end
+    end
+  end
+end

lib/octocatalog-diff/cli.rb

@@ -158,7 +158,7 @@ def self.setup_logger(logger, options, argv_save)
     # Compile the catalog only
     def self.catalog_only(logger, options)
       opts = options.merge(logger: logger)
-      to_catalog = OctocatalogDiff::API::V1::CatalogCompile.catalog(opts)
+      to_catalog = OctocatalogDiff::API::V1::CatalogCompile.catalog(opts).raw
 
       # If the catalog compilation failed, an exception would have been thrown. So if
       # we get here, the catalog succeeded. Dump the catalog to the appropriate place

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

@@ -46,6 +46,7 @@
 
     it 'should call OctocatalogDiff::Util::Catalogs and return to-key' do
       obj = OpenStruct.new(catalogs: { to: 'to-catalog', from: 'from-catalog' })
+      expect(OctocatalogDiff::API::V1::Catalog).to receive(:new).with('to-catalog').and_return('to-catalog')
       expect(OctocatalogDiff::Util::Catalogs).to receive(:new).and_return(obj)
       result = described_class.catalog({})
       expect(result).to eq('to-catalog')