octocatalog-diff 0.6.1 → 1.0.0

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require_relative '../cli'
+require_relative '../facts'
+require_relative '../version'
+
+require 'optparse'
+
+module OctocatalogDiff
+  class Cli
+    # This class contains the option parser. 'parse_options' is the external entry point.
+    class Options
+      # The usage banner.
+      BANNER = 'Usage: catalog-diff -n <hostname> [-f <from environment>] [-t <to environment>]'.freeze
+
+      # List of classes
+      def self.classes
+        @classes ||= []
+      end
+
+      # Define the Option class and newoption() method for use by cli/options/*.rb files
+      class Option
+        DEFAULT_WEIGHT = 999
+        def self.has_weight(w) # rubocop:disable Style/PredicateName
+          @weight = w
+        end
+
+        def self.weight
+          @weight || DEFAULT_WEIGHT
+        end
+
+        def self.name
+          self::NAME
+        end
+
+        def self.newoption(name, &block)
+          klass = Class.new(OctocatalogDiff::Cli::Options::Option)
+          klass.const_set('NAME', name)
+          klass.class_exec(&block)
+          Options.classes.push(klass)
+        end
+      end
+
+      # Method to call all of the other methods in this class. Except in very specific circumstances,
+      # this should be the method called from outside of this class.
+      # @param argv [Array] Array of command line arguments
+      # @param defaults [Hash] Default values
+      # @return [Hash] Parsed options
+      def self.parse_options(argv, defaults = {})
+        options = defaults.dup
+        Options.classes.clear
+        ::OptionParser.new do |parser|
+          parser.banner = "#{BANNER}\n\n"
+          option_classes.each do |klass|
+            obj = klass.new
+            obj.parse(parser, options)
+          end
+          parser.on_tail('-v', '--version', 'Show version information about this program and quit.') do
+            puts "octocatalog-diff #{OctocatalogDiff::Version::VERSION}"
+            exit
+          end
+        end.parse! argv
+        options
+      end
+
+      # Read in *.rb files in the 'options' directory and create classes from them.
+      # 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 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
+      # CLI name of 'puppet-binary' this will acknowledge 3 options: --puppet-binary (global),
+      # --from-puppet-binary (for the from branch only), and --to-puppet-binary (for the to branch
+      # only). The only options that will be created are the 'to' and 'from' variants, but the global
+      # option will populate any of the 'to' and 'from' variants that are missing.
+      # @param :datatype [?] Expected data type
+      def self.option_globally_or_per_branch(opts = {})
+        datatype = opts.fetch(:datatype, '')
+        return option_globally_or_per_branch_string(opts) if datatype.is_a?(String)
+        return option_globally_or_per_branch_array(opts) if datatype.is_a?(Array)
+        raise ArgumentError, "option_globally_or_per_branch not equipped to handle #{datatype.class}"
+      end
+
+      # See description of `option_globally_or_per_branch`. This implements the logic for a string value.
+      # @param :parser [OptionParser object] The OptionParser argument
+      # @param :options [Hash] Options hash being constructed; this is modified in this method.
+      # @param :cli_name [String] Name of option on command line (e.g. puppet-binary)
+      # @param :option_name [Symbol] Name of option in the options hash (e.g. :puppet_binary)
+      # @param :desc [String] Description of option on the command line; will have "for the XX branch" appended
+      def self.option_globally_or_per_branch_string(opts)
+        parser = opts.fetch(:parser)
+        options = opts.fetch(:options)
+        cli_name = opts.fetch(:cli_name)
+        option_name = opts.fetch(:option_name)
+        desc = opts.fetch(:desc)
+
+        flag = "#{cli_name} STRING"
+        from_option = "from_#{option_name}".to_sym
+        to_option = "to_#{option_name}".to_sym
+        parser.on("--#{flag}", "#{desc} globally") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          translated = translate_option(opts[:translator], x)
+          options[to_option] ||= translated
+          options[from_option] ||= translated
+        end
+        parser.on("--to-#{flag}", "#{desc} for the to branch") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          options[to_option] = translate_option(opts[:translator], x)
+        end
+        parser.on("--from-#{flag}", "#{desc} for the from branch") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          options[from_option] = translate_option(opts[:translator], x)
+        end
+      end
+
+      # See description of `option_globally_or_per_branch`. This implements the logic for an array.
+      # @param :parser [OptionParser object] The OptionParser argument
+      # @param :options [Hash] Options hash being constructed; this is modified in this method.
+      # @param :cli_name [String] Name of option on command line (e.g. puppet-binary)
+      # @param :option_name [Symbol] Name of option in the options hash (e.g. :puppet_binary)
+      # @param :desc [String] Description of option on the command line; will have "for the XX branch" appended
+      def self.option_globally_or_per_branch_array(opts = {})
+        parser = opts.fetch(:parser)
+        options = opts.fetch(:options)
+        cli_name = opts.fetch(:cli_name)
+        option_name = opts.fetch(:option_name)
+        desc = opts.fetch(:desc)
+
+        flag = "#{cli_name} STRING1[,STRING2[,...]]"
+        from_option = "from_#{option_name}".to_sym
+        to_option = "to_#{option_name}".to_sym
+        parser.on("--#{flag}", Array, "#{desc} globally") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          translated = translate_option(opts[:translator], x)
+          options[to_option] ||= []
+          options[to_option].concat translated
+          options[from_option] ||= []
+          options[from_option].concat translated
+        end
+        parser.on("--to-#{flag}", Array, "#{desc} for the to branch") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          options[to_option] ||= []
+          options[to_option].concat translate_option(opts[:translator], x)
+        end
+        parser.on("--from-#{flag}", Array, "#{desc} for the from branch") do |x|
+          validate_option(opts[:validator], x) if opts[:validator]
+          options[from_option] ||= []
+          options[from_option].concat translate_option(opts[:translator], x)
+        end
+      end
+
+      # If a validator was provided, run the validator on the supplied value. The validator is expected to
+      # throw an error if there is a problem. Note that the validator runs *before* the translator if both
+      # a validator and translator are supplied.
+      # @param validator [Code] Validation function
+      # @param value [?] Value to validate (typically a String but can really be anything)
+      def self.validate_option(validator, value)
+        validator.call(value)
+      end
+
+      # If a translator was provided, run the translator on the supplied value. The translator is expected
+      # to return the data type needed for the option (typically a String but can really be anything). Note
+      # that the translator runs *after* the validator if both a validator and translator are supplied.
+      # @param translator [Code] Translator function
+      # @param value [?] Original input value
+      # @return [?] Translated value
+      def self.translate_option(translator, value)
+        return value if translator.nil?
+        translator.call(value)
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:basedir) do
+OctocatalogDiff::Cli::Options::Option.newoption(:basedir) do
   has_weight 10
 
   def parse(parser, options)

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

@@ -4,7 +4,7 @@
 # run when the catalog builds in the current directory).
 # @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(:bootstrap_current) do
+OctocatalogDiff::Cli::Options::Option.newoption(:bootstrap_current) do
   has_weight 48
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:bootstrap_environment) do
+OctocatalogDiff::Cli::Options::Option.newoption(:bootstrap_environment) do
   has_weight 50
 
   def parse(parser, options)

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

@@ -5,7 +5,7 @@
 # to be done.
 # @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(:bootstrap_script) do
+OctocatalogDiff::Cli::Options::Option.newoption(:bootstrap_script) do
   has_weight 40
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:bootstrap_then_exit) do
+OctocatalogDiff::Cli::Options::Option.newoption(:bootstrap_then_exit) do
   has_weight 70
 
   def parse(parser, options)

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

@@ -4,7 +4,7 @@
 # to save time when diffing multiple catalogs on this system.
 # @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(:bootstrapped_dirs) do
+OctocatalogDiff::Cli::Options::Option.newoption(:bootstrapped_dirs) do
   has_weight 60
 
   def parse(parser, options)

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

@@ -4,7 +4,7 @@
 # has not changed.
 # @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(:cached_master_dir) do
+OctocatalogDiff::Cli::Options::Option.newoption(:cached_master_dir) do
   has_weight 160
 
   def parse(parser, options)

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

@@ -4,7 +4,7 @@
 # diffing activity. The catalog will be printed to STDOUT or written to the output file.
 # @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(:catalog_only) do
+OctocatalogDiff::Cli::Options::Option.newoption(:catalog_only) do
   has_weight 290
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # Color printing option
 # @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(:color) do
+OctocatalogDiff::Cli::Options::Option.newoption(:color) do
   has_weight 80
 
   def parse(parser, options)

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

@@ -3,11 +3,11 @@
 # 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
+OctocatalogDiff::Cli::Options::Option.newoption(:command_line) do
   has_weight 510
 
   def parse(parser, options)
-    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+    OctocatalogDiff::Cli::Options.option_globally_or_per_branch(
       parser: parser,
       options: options,
       cli_name: 'command-line',

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

@@ -6,7 +6,7 @@
 # what is most often desired.
 # @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(:compare_file_text) do
+OctocatalogDiff::Cli::Options::Option.newoption(:compare_file_text) do
   has_weight 210
 
   def parse(parser, options)

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

@@ -4,11 +4,11 @@
 # 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
+OctocatalogDiff::Cli::Options::Option.newoption(:create_symlinks) do
   has_weight 503
 
   def parse(parser, options)
-    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+    OctocatalogDiff::Cli::Options.option_globally_or_per_branch(
       parser: parser,
       options: options,
       cli_name: 'create-symlinks',

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

@@ -3,7 +3,7 @@
 # Debugging option
 # @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(:debug) do
+OctocatalogDiff::Cli::Options::Option.newoption(:debug) do
   has_weight 110
 
   def parse(parser, options)

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

@@ -5,7 +5,7 @@
 # any effect.
 # @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(:debug_bootstrap) do
+OctocatalogDiff::Cli::Options::Option.newoption(:debug_bootstrap) do
   has_weight 49
 
   def parse(parser, options)

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

@@ -6,7 +6,7 @@
 # difference.
 # @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(:display_datatype_changes) do
+OctocatalogDiff::Cli::Options::Option.newoption(:display_datatype_changes) do
   has_weight 280
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:display_detail_add) do
+OctocatalogDiff::Cli::Options::Option.newoption(:display_detail_add) do
   has_weight 250
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:display_source_file_line) do
+OctocatalogDiff::Cli::Options::Option.newoption(:display_source_file_line) do
   has_weight 200
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:enc) do
+OctocatalogDiff::Cli::Options::Option.newoption(:enc) do
   has_weight 240
 
   def parse(parser, options)

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Allow override of ENC parameters on the command line. ENC parameter 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. For parameters nested in hashes, use `::` as the delimiter.
+OctocatalogDiff::Cli::Options::Option.newoption(:enc_override) do
+  has_weight 322
+
+  def parse(parser, options)
+    # Set 'enc_override_in' because more processing is needed, once the command line options
+    # have been parsed, to make this into the final form 'enc_override'.
+    OctocatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'enc-override',
+      option_name: 'enc_override_in',
+      desc: 'Override parameter from ENC',
+      datatype: []
+    )
+  end
+end

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

@@ -4,11 +4,11 @@
 # 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
+OctocatalogDiff::Cli::Options::Option.newoption(:environment) do
   has_weight 502
 
   def parse(parser, options)
-    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+    OctocatalogDiff::Cli::Options.option_globally_or_per_branch(
       parser: parser,
       options: options,
       cli_name: 'environment',

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

@@ -6,7 +6,7 @@ require 'json'
 # These files must exist and be in Puppet catalog format.
 # @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(:existing_catalogs) do
+OctocatalogDiff::Cli::Options::Option.newoption(:existing_catalogs) do
   has_weight 30
 
   def parse(parser, options)

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

@@ -3,7 +3,7 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:fact_file) do
+OctocatalogDiff::Cli::Options::Option.newoption(:fact_file) do
   has_weight 150
 
   def parse(parser, options)

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

@@ -3,13 +3,13 @@
 # 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.
-OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:fact_override) do
+OctocatalogDiff::Cli::Options::Option.newoption(:fact_override) do
   has_weight 320
 
   def parse(parser, options)
     # Set 'fact_override_in' because more processing is needed, once the command line options
     # have been parsed, to make this into the final form 'fact_override'.
-    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+    OctocatalogDiff::Cli::Options.option_globally_or_per_branch(
       parser: parser,
       options: options,
       cli_name: 'fact-override',

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

@@ -5,7 +5,7 @@
 # on which this is running.
 # @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(:facts_terminus) do
+OctocatalogDiff::Cli::Options::Option.newoption(:facts_terminus) do
   has_weight 310
 
   def parse(parser, options)