Update tests for error classes

Author: Kevin Paulisse

bin/octocatalog-diff

@@ -24,7 +24,10 @@ logger = Logger.new(STDERR)
 logger.level = Logger::DEBUG if config_test
 
 options = OctocatalogDiff::API::V1.config(logger: logger, test: config_test)
-exit(0) if config_test
+if config_test
+  logger.info 'Exiting now because --config-test was specified'
+  exit(0)
+end
 
 argv = ARGV.dup
 exit_code = OctocatalogDiff::Cli.cli(argv, Logger.new(STDERR), options)

doc/dev/api/v1/catalog.md

@@ -6,8 +6,17 @@
 
 ```
 catalog_obj = OctocatalogDiff::API::V1.catalog(
-  filename: "String",
-  logger: Logger,
-  test: <true|false>
+
 )
 ```
+
+## Options
+
+
+**NOTE**: Additional options as described in the [options reference](/doc/optionsref.md) may also have an effect on catalog generation.
+
+## Return value
+
+The return value is an [`OctocatalogDiff::Catalog`](/doc/dev/api/v1/octocatalogdiff-catalog.md) object.
+
+## Exceptions

spec/octocatalog-diff/integration/api_catalog_compile_spec.rb

@@ -55,7 +55,7 @@
       }
       expect do
         described_class.catalog(options)
-      end.to raise_error(OctocatalogDiff::Util::Catalogs::CatalogError)
+      end.to raise_error(OctocatalogDiff::Errors::CatalogError)
     end
   end
 

spec/octocatalog-diff/integration/convert_file_resources_spec.rb

@@ -118,7 +118,7 @@
         ]
       )
       expect(result[:exitcode]).to eq(-1)
-      expect(result[:exception]).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+      expect(result[:exception]).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
       expect(result[:exception].message).to match(/failed to compile with Errno::ENOENT/)
       expect(result[:exception].message).to match(%r{Unable to resolve 'puppet:///modules/test/foo-new'})
     end

spec/octocatalog-diff/integration/pe_enc_spec.rb

@@ -129,7 +129,7 @@ def self.respond(code, message, content_type = nil, body = '')
     }
     result = OctocatalogDiff::Integration.integration(opts)
     expect(result[:exitcode]).to eq(-1)
-    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
     expect(result[:exception].message).to match(/OpenSSL::SSL::SSLError/)
   end
 
@@ -194,7 +194,7 @@ def self.respond(code, message, content_type = nil, body = '')
     }
     result = OctocatalogDiff::Integration.integration(opts)
     expect(result[:exitcode]).to eq(-1)
-    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
     expect(result[:exception].message).to match(/Failed ENC: Response from https:.+rspec-node.xyz.github.net was 403/)
   end
 
@@ -212,7 +212,7 @@ def self.respond(code, message, content_type = nil, body = '')
     }
     result = OctocatalogDiff::Integration.integration(opts)
     expect(result[:exitcode]).to eq(-1)
-    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
     expect(result[:exception].message).to match(/Failed ENC: Response from https:.+rspec-node.xyz.github.net was 403/)
   end
 

spec/octocatalog-diff/integration/preserve_environments_spec.rb

@@ -22,8 +22,8 @@
         expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
       end
 
-      it 'should raise OctocatalogDiff::Util::Catalogs::CatalogError' do
-        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+      it 'should raise OctocatalogDiff::Errors::CatalogError' do
+        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
       end
 
       it 'should fail because ::bar could not be located' do
@@ -98,7 +98,7 @@
 
       it 'should exit with error status due modules in production environment not being found' do
         expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
         expect(@result.exception.message).to match(/Errno::ENOENT: No such file or directory - Environment directory/)
       end
     end
@@ -121,7 +121,7 @@
 
       it 'should error on missing environment' do
         expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
         expect(@result.exception.message).to match(%r{Environment directory .+/environments/fluffy does not exist})
       end
     end
@@ -208,7 +208,7 @@
 
         it 'should error on missing site directory' do
           expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
           expect(@result.exception.message).to match(/Could not find class (::)?sitetest/)
         end
       end
@@ -231,7 +231,7 @@
 
         it 'should error on missing module' do
           expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
           expect(@result.exception.message).to match(/Could not find class (::)?foo/)
         end
       end
@@ -254,7 +254,7 @@
 
         it 'should raise exception due to missing symlink request' do
           expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
           expect(@result.exception.message).to match(%r{Catalog for 'from' \(origin/master\) failed.+ Errno::ENOENT})
           expect(@result.exception.message).to match(%r{Specified directory .+/preserve-environments/fluffy doesn't exist})
         end
@@ -303,7 +303,7 @@
 
         it 'should error on missing site directory' do
           expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+          expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
           expect(@result.exception.message).to match(/Could not find class (::)?sitetest/)
         end
       end
@@ -326,7 +326,7 @@
 
       it 'should error on missing site directory' do
         expect(@result.exitcode).to eq(-1), OctocatalogDiff::Integration.format_exception(@result)
-        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Util::Catalogs::CatalogError)
+        expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::CatalogError)
         expect(@result.exception.message).to match(/Could not find class (::)?sitetest/)
       end
     end

spec/octocatalog-diff/integration/puppetdb_spec.rb

@@ -22,7 +22,7 @@
     opts = { argv: ['-n', 'not-found-node.github.net'], spec_repo: 'tiny-repo' }
     result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
     expect(result[:exitcode]).to eq(-1), OctocatalogDiff::Integration.format_exception(result)
-    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+    expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
     expect(result[:exception].message).to match(/FactRetrievalError: Node not-found-node.github.net not found in PuppetDB/)
   end
 end
@@ -53,7 +53,7 @@
       opts = { argv: args, spec_repo: 'tiny-repo' }
       result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
       expect(result[:exitcode]).to eq(-1), OctocatalogDiff::Integration.format_exception(result)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::SSL::SSLError/)
     end
 
@@ -71,7 +71,7 @@
       opts = { argv: args, spec_repo: 'tiny-repo' }
       result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
       expect(result[:exitcode]).to eq(-1), OctocatalogDiff::Integration.format_exception(result)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::SSL::SSLError/)
     end
   end
@@ -88,7 +88,7 @@
     it 'should fail to connect to authenticated puppetdb with no client cert', retry: 3 do
       opts = { argv: ['-n', 'rspec-node.github.net'], spec_repo: 'tiny-repo' }
       result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::SSL::SSLError/)
     end
 
@@ -127,7 +127,7 @@
       opts = { argv: arg, spec_repo: 'tiny-repo' }
       result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
       expect(result[:exitcode]).to eq(-1), OctocatalogDiff::Integration.format_exception(result)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::PKey::RSAError/)
     end
 
@@ -140,7 +140,7 @@
       opts = { argv: arg, spec_repo: 'tiny-repo' }
       result = OctocatalogDiff::Integration.integration_with_puppetdb(s_opts, opts)
       expect(result[:exitcode]).to eq(-1), OctocatalogDiff::Integration.format_exception(result)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::PKey::RSAError/)
     end
   end

spec/octocatalog-diff/integration/puppetmaster_spec.rb

@@ -157,7 +157,7 @@ def self.response(method, uri, _headers, body)
       }
       result = OctocatalogDiff::Integration.integration(opts)
       expect(result[:exitcode]).to eq(-1)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/OpenSSL::SSL::SSLError/)
     end
 
@@ -174,7 +174,7 @@ def self.response(method, uri, _headers, body)
       }
       result = OctocatalogDiff::Integration.integration(opts)
       expect(result[:exitcode]).to eq(-1)
-      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Util::Catalogs::CatalogError')
+      expect(result[:exception].class.to_s).to eq('OctocatalogDiff::Errors::CatalogError')
       expect(result[:exception].message).to match(/foobaz.local: 404/)
     end