octocatalog-diff 0.5.6 → 0.6.0

data/lib/octocatalog-diff/bootstrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 require 'shellwords'
 

data/lib/octocatalog-diff/catalog-diff/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'cli/catalogs'
 require_relative 'cli/diffs'
 require_relative 'cli/options'
@@ -164,7 +166,8 @@ module OctocatalogDiff
         logger.level = Logger::ERROR if options[:quiet]
 
         # Some debugging information up front
-        logger.debug "Running octocatalog-diff #{VERSION} with ruby #{RUBY_VERSION}"
+        version_display = ENV['OCTOCATALOG_DIFF_CUSTOM_VERSION'] || VERSION
+        logger.debug "Running octocatalog-diff #{version_display} with ruby #{RUBY_VERSION}"
         logger.debug "Command line arguments: #{argv_save.inspect}"
         logger.debug "Running on host #{Socket.gethostname} (#{RUBY_PLATFORM})"
       end

data/lib/octocatalog-diff/catalog-diff/cli/catalogs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'open3'
 require 'yaml'
@@ -155,6 +157,7 @@ module OctocatalogDiff
             task = OctocatalogDiff::Util::Parallel::Task.new(
               method: method(:build_catalog),
               validator: method(:catalog_validator),
+              validator_args: { task: key },
               description: "build_catalog for #{@options["#{key}_env".to_sym]}",
               args: args
             )
@@ -195,7 +198,7 @@ module OctocatalogDiff
               # and remove the compilation directory (which is a tmpdir) to reveal only the relative
               # path to the files involved.
               dir = catalog.compilation_dir || ''
-              dir_regex = Regexp.new(Regexp.escape(dir) + '/environments/production/')
+              dir_regex = Regexp.new(Regexp.escape(dir) + '/environments/[^/]+/')
               error_display = catalog.error_message.split("\n").map do |line|
                 line.sub(/^Error:/, '[Puppet Error]').gsub(dir_regex, '')
               end.join("\n")
@@ -229,9 +232,12 @@ module OctocatalogDiff
 
         # Validate a catalog in the parallel execution
         # @param catalog [OctocatalogDiff::Catalog] Catalog object
+        # @param logger [Logger] Logger object (presently unused)
+        # @param args [Hash] Additional arguments set specifically for validator
         # @return [Boolean] true if catalog is valid, false otherwise
-        def catalog_validator(catalog = nil, _logger = @logger)
+        def catalog_validator(catalog = nil, _logger = @logger, args = {})
           return false unless catalog.is_a?(OctocatalogDiff::Catalog)
+          catalog.validate_references if args[:task] == :to
           catalog.valid?
         end
       end

data/lib/octocatalog-diff/catalog-diff/cli/diffs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../differ'
 
 module OctocatalogDiff

data/lib/octocatalog-diff/catalog-diff/cli/helpers/fact_override.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module OctocatalogDiff
@@ -26,8 +28,7 @@ module OctocatalogDiff
               unless input.include?('=')
                 raise ArgumentError, "Fact override '#{input}' is not in 'key=(data type)value' format"
               end
-              input.strip!
-              @key, raw_value = input.split('=', 2)
+              @key, raw_value = input.strip.split('=', 2)
               @value = parsed_value(raw_value)
             elsif key.nil?
               message = "Define a key when the input is not a string (#{input.class} => #{input.inspect})"

data/lib/octocatalog-diff/catalog-diff/cli/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../cli'
 require_relative '../../facts'
 require_relative '../../version'
@@ -28,6 +30,10 @@ module OctocatalogDiff
             @weight || DEFAULT_WEIGHT
           end
 
+          def self.name
+            self::NAME
+          end
+
           def self.newoption(name, &block)
             klass = Class.new(OctocatalogDiff::CatalogDiff::Cli::Options::Option)
             klass.const_set('NAME', name)
@@ -59,12 +65,18 @@ module OctocatalogDiff
         end
 
         # Read in *.rb files in the 'options' directory and create classes from them.
-        # Sort the classes according to weight and return the list of sorted classes.
+        # Sort the classes according to weight and name and return the list of sorted classes.
         # @return [Array<Class>] Sorted classes
         def self.option_classes
           files = Dir.glob(File.join(File.dirname(__FILE__), 'options', '*.rb'))
           files.each { |file| load file } # Populates self.classes
-          classes.sort { |a, b| a.weight <=> b.weight }
+          classes.sort do |a, b|
+            [
+              a.weight <=> b.weight,
+              a.name.downcase <=> b.name.downcase,
+              a.object_id <=> b.object_id
+            ].find(&:nonzero?)
+          end
         end
 
         # Sets up options that can be defined globally or for just one branch. For example, with a

data/lib/octocatalog-diff/catalog-diff/cli/options/basedir.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option to set the base checkout directory of puppet repository
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/bootstrap_current.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option to bootstrap the current directory (by default, the bootstrap script is NOT
 # run when the catalog builds in the current directory).
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/bootstrap_environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow the bootstrap environment to be set up via the command line.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/bootstrap_script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow specification of a bootstrap script. This runs after checking out the directory, and before running
 # puppet there. Good for running librarian to install modules, and anything else site-specific that needs
 # to be done.

data/lib/octocatalog-diff/catalog-diff/cli/options/bootstrap_then_exit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option to bootstrap directories and then exit
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/bootstrapped_dirs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow (or create) directories that are already bootstrapped. Handy to allow "bootstrap once, build many"
 # to save time when diffing multiple catalogs on this system.
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/cached_master_dir.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Cache a bootstrapped checkout of 'master' and use that for time-saving when the SHA
 # has not changed.
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/catalog_only.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # When set, --catalog-only will only compile the catalog for the 'to' branch, and skip any
 # diffing activity. The catalog will be printed to STDOUT or written to the output file.
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Color printing option
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/command_line.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Provide additional command line flags to set when running Puppet to compile catalogs.
+# @param parser [OptionParser object] The OptionParser argument
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:command_line) do
+  has_weight 510
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'command-line',
+      option_name: 'command_line',
+      desc: 'Command line arguments',
+      datatype: []
+    )
+  end
+end

data/lib/octocatalog-diff/catalog-diff/cli/options/compare_file_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # When a file is specified with `source => 'puppet:///modules/something/foo.txt'`, remove
 # the 'source' attribute and populate the 'content' attribute with the text of the file.
 # This allows for a diff of the content, rather than a diff of the location, which is

data/lib/octocatalog-diff/catalog-diff/cli/options/create_symlinks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Specify which directories from the base should be symlinked into the temporary compilation
+# environment. This is useful only in conjunction with `--preserve-environments`.
+# @param parser [OptionParser object] The OptionParser argument
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:create_symlinks) do
+  has_weight 503
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'create-symlinks',
+      option_name: 'create_symlinks',
+      desc: 'Symlinks to create',
+      datatype: []
+    )
+  end
+end

data/lib/octocatalog-diff/catalog-diff/cli/options/debug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Debugging option
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/debug_bootstrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option to print debugging output for the bootstrap script in addition to the normal
 # debugging output. Note that `--debug` must also be enabled for this option to have
 # any effect.

data/lib/octocatalog-diff/catalog-diff/cli/options/display_datatype_changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Toggle on or off the display of data type changes when the string representation
 # is the same. For example with this enabled, '42' (the string) and 42 (the integer)
 # will be displayed as a difference. With this disabled, this is not displayed as a

data/lib/octocatalog-diff/catalog-diff/cli/options/display_detail_add.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provide ability to display details of 'added' resources in the output.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/display_source_file_line.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Display source filename and line number for diffs
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/enc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Path to external node classifier, relative to the base directory of the checkout.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/environment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Specify the environment to use when compiling the catalog. This is useful only in conjunction
+# with `--preserve-environments`.
+# @param parser [OptionParser object] The OptionParser argument
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:environment) do
+  has_weight 502
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'environment',
+      option_name: 'environment',
+      desc: 'Environment for catalog compilation'
+    )
+  end
+end

data/lib/octocatalog-diff/catalog-diff/cli/options/existing_catalogs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 # If pre-compiled catalogs are available, these can be used to short-circuit the build process.

data/lib/octocatalog-diff/catalog-diff/cli/options/fact_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow an existing fact file to be provided, to avoid pulling facts from PuppetDB.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/fact_override.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow override of facts on the command line. Fact overrides can be supplied for the 'to' or 'from' catalog,
 # or for both. There is some attempt to handle data types here (since all items on the command line are strings)
 # by permitting a data type specification as well.

data/lib/octocatalog-diff/catalog-diff/cli/options/facts_terminus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Get the facts terminus. Generally this is 'yaml' and a fact file will be loaded from PuppetDB or
 # elsewhere in the environment. However it can be set to 'facter' which will run facter on the host
 # on which this is running.

data/lib/octocatalog-diff/catalog-diff/cli/options/from_puppetdb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Set --from-puppetdb to pull most recent catalog from PuppetDB instead of compiling
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provide ability to set custom header or to display no header at all
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/hiera_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify a relative path to the Hiera yaml file
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/hiera_path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
 # Puppet control repo template, the value of this should be 'hieradata', which is the default.
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/hiera_path_strip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify the path to strip off the datadir to munge hiera.yaml file
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/hostname.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Set hostname, which is used to look up facts in PuppetDB, and in the header of diff display.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/ignore.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Options used when comparing catalogs - set ignored changes.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/ignore_attr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify attributes to ignore
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/ignore_tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provide ability to set one or more tags, which will cause catalog-diff
 # to ignore any changes for any defined type where this tag is set.
 # @param parser [OptionParser object] The OptionParser argument

data/lib/octocatalog-diff/catalog-diff/cli/options/include_tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Options used when comparing catalogs - tags are generally ignored; you can un-ignore them.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/master_cache_branch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Allow override of the branch that is cached. This defaults to 'origin/master'.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/output_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Output file option
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/output_format.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Output format option
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/parallel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Disable or enable parallel processing of catalogs.
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Enable future parser for both branches or for just one
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.

data/lib/octocatalog-diff/catalog-diff/cli/options/pass_env_vars.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # One or more environment variables that should be made available to the Puppet binary when parsing
 # the catalog. For example, --pass-env-vars FOO,BAR will make the FOO and BAR environment variables
 # available. Setting these variables is your responsibility outside of octocatalog-diff.

data/lib/octocatalog-diff/catalog-diff/cli/options/pe_enc_ssl_ca.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify the CA certificate for the Puppet Enterprise ENC. If specified, this will enable SSL verification
 # that the certificate being presented has been signed by this CA, and that the common name
 # matches the name you are using to connecting.

data/lib/octocatalog-diff/catalog-diff/cli/options/pe_enc_ssl_client_cert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify the client certificate for connecting to the Puppet Enterprise ENC. This must be specified along with
 # --pe-enc-ssl-client-key in order to work.
 # @param parser [OptionParser object] The OptionParser argument