octocatalog-diff 0.5.1

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

@@ -0,0 +1,14 @@
+# 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.
+# @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
+  has_weight 40
+
+  def parse(parser, options)
+    parser.on('--bootstrap-script FILENAME', 'Bootstrap script relative to checkout directory') do |file|
+      options[:bootstrap_script] = file
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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
+  has_weight 70
+
+  def parse(parser, options)
+    parser.on('--bootstrap-then-exit', 'Bootstrap from-dir and/or to-dir and then exit') do
+      options[:bootstrap_then_exit] = true
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:bootstrapped_dirs) do
+  has_weight 60
+
+  def parse(parser, options)
+    these_options = { 'from' => :bootstrapped_from_dir, 'to' => :bootstrapped_to_dir }
+    these_options.each do |tag, hash_key|
+      parser.on("--bootstrapped-#{tag}-dir DIRNAME", "Use a pre-bootstrapped '#{tag}' directory") do |dir|
+        options[hash_key] = File.absolute_path(dir)
+        Dir.mkdir options[hash_key], 0o700 unless Dir.exist?(options[hash_key])
+        raise "Invalid bootstrapped-#{tag}-dir: does not exist" unless Dir.exist?(options[hash_key])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:cached_master_dir) do
+  has_weight 160
+
+  def parse(parser, options)
+    parser.on('--cached-master-dir PATH', 'Cache bootstrapped origin/master at this path') do |path_in|
+      path = File.absolute_path(path_in)
+      unless Dir.exist?(path)
+        begin
+          Dir.mkdir path, 0o755
+        rescue Errno::ENOENT => exc
+          raise Errno::ENOENT, "Invalid cached master directory path: #{exc}"
+        end
+      end
+      options[:cached_master_dir] = path
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:catalog_only) do
+  has_weight 290
+
+  def parse(parser, options)
+    desc = 'Only compile the catalog for the "to" branch but do not diff'
+    parser.on('--[no-]catalog-only', desc) do |x|
+      options[:catalog_only] = x
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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
+  has_weight 80
+
+  def parse(parser, options)
+    parser.on('--[no-]color', 'Enable/disable colors in output') do |color|
+      options[:colors] = color
+      options[:format] = color ? :color_text : :text
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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
+# 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
+  has_weight 210
+
+  def parse(parser, options)
+    parser.on('--[no-]compare-file-text', 'Compare text, not source location, of file resources') do |x|
+      options[:compare_file_text] = x
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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
+  has_weight 110
+
+  def parse(parser, options)
+    parser.on('--[no-]debug', '-d', 'Print debugging messages to STDERR') do |x|
+      options[:debug] = x
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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
+# 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
+  has_weight 280
+
+  def parse(parser, options)
+    desc = 'Display changes in data type even when strings match'
+    parser.on('--[no-]display-datatype-changes', desc) do |x|
+      options[:display_datatype_changes] = x
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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
+  has_weight 250
+
+  def parse(parser, options)
+    parser.on('--[no-]display-detail-add', 'Display parameters and other details for added resources') do |x|
+      options[:display_detail_add] = x
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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
+  has_weight 200
+
+  def parse(parser, options)
+    parser.on('--[no-]display-source', 'Show source file and line for each difference') do |x|
+      options[:display_source_file_line] = x
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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
+  has_weight 240
+
+  def parse(parser, options)
+    parser.on('--no-enc', 'Disable ENC') do
+      options[:no_enc] = true
+      options[:enc] = nil
+      options[:from_enc] = nil
+      options[:to_enc] = nil
+    end
+
+    parser.on('--enc PATH', 'Path to ENC script, relative to checkout directory or absolute') do |x|
+      unless options[:no_enc]
+        proposed_enc_path = x.start_with?('/') ? x : File.join(options[:basedir], x)
+        raise Errno::ENOENT, "Provided ENC (#{proposed_enc_path}) does not exist" unless File.file?(proposed_enc_path)
+        options[:enc] = proposed_enc_path
+      end
+    end
+
+    parser.on('--from-enc PATH', 'Path to ENC script (for the from catalog only)') do |x|
+      options[:from_enc] = x unless options[:no_enc]
+    end
+
+    parser.on('--to-enc PATH', 'Path to ENC script (for the to catalog only)') do |x|
+      options[:to_enc] = x unless options[:no_enc]
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'json'
+
+# If pre-compiled catalogs are available, these can be used to short-circuit the build process.
+# 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
+  has_weight 30
+
+  def parse(parser, options)
+    these_options = { 'from' => :from_catalog, 'to' => :to_catalog }
+    these_options.each do |tag, hash_key|
+      parser.on("--#{tag}-catalog FILENAME", "Use a pre-compiled catalog '#{tag}'") do |catalog_file|
+        path = File.absolute_path(catalog_file)
+        raise Errno::ENOENT, "Invalid '#{hash_key} catalog' file provided" unless File.file?(path)
+        options[hash_key] = path
+        if options[:node].nil?
+          x = JSON.parse(File.read(path))
+          options[:node] ||= x['data']['name'] if x['data'].is_a?(Hash)
+          options[:node] ||= x['name'] if x['name'].is_a?(String)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# 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
+  has_weight 150
+
+  def parse(parser, options)
+    parser.on('--fact-file FILENAME', 'Fact file to use instead of node lookup') do |fact_file|
+      raise Errno::ENOENT, 'Invalid fact file provided' unless File.file?(fact_file)
+      facts = nil
+      local_opts = { fact_file_string: File.read(fact_file) }
+      if fact_file =~ /\.ya?ml$/
+        facts = OctocatalogDiff::Facts.new(local_opts.merge(backend: :yaml))
+      elsif fact_file =~ /\.json$/
+        facts = OctocatalogDiff::Facts.new(local_opts.merge(backend: :json))
+      else
+        raise ArgumentError, 'I do not know how to parse the provided fact file. Needs .yaml or .json extension.'
+      end
+      options[:facts] = facts
+      options[:node] ||= facts.facts['name']
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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
+  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(
+      parser: parser,
+      options: options,
+      cli_name: 'fact-override',
+      option_name: 'fact_override_in',
+      desc: 'Override fact',
+      datatype: []
+    )
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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.
+# @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
+  has_weight 310
+
+  def parse(parser, options)
+    termini = %w(yaml facter)
+    parser.on('--facts-terminus STRING', "Facts terminus: one of #{termini.join(', ')}") do |x|
+      raise ArgumentError, "Invalid facts terminus #{x}; supported: #{termini.join(', ')}" unless termini.include?(x)
+      options[:facts_terminus] = x
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:from_puppetdb) do
+  has_weight 300
+
+  def parse(parser, options)
+    desc = 'Pull "from" catalog from PuppetDB instead of compiling'
+    parser.on('--[no-]from-puppetdb', desc) do |x|
+      options[:from_puppetdb] = x
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:header) do
+  has_weight 260
+
+  def parse(parser, options)
+    parser.on('--no-header', 'Do not print a header') do
+      raise ArgumentError, '--no-header incompatible with --default-header' if options[:header] == :default
+      raise ArgumentError, '--no-header incompatible with --header' unless options[:header].nil?
+      options[:no_header] = true
+    end
+    parser.on('--default-header', 'Print default header with output') do
+      raise ArgumentError, '--default-header incompatible with --header' unless options[:header].nil?
+      raise ArgumentError, '--default-header incompatible with --no-header' unless options[:no_header].nil?
+      options[:header] = :default
+    end
+    parser.on('--header STRING', 'Specify header for output') do |x|
+      raise ArgumentError, '--header incompatible with --default-header' if options[:header] == :default
+      raise ArgumentError, '--header incompatible with --no-header' unless options[:no_header].nil?
+      options[:header] = x
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:hiera_config) do
+  has_weight 180
+
+  def parse(parser, options)
+    parser.on('--hiera-config PATH', 'Relative path to hiera YAML file') do |path_in|
+      raise ArgumentError, '--no-hiera-config incompatible with --hiera-config' if options[:no_hiera_config]
+      options[:hiera_config] = path_in
+    end
+
+    parser.on('--no-hiera-config', 'Disable hiera config file installation') do
+      raise ArgumentError, '--no-hiera-config incompatible with --hiera-config' if options[:hiera_config]
+      options[:no_hiera_config] = true
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:hiera_path_strip) do
+  has_weight 181
+
+  def parse(parser, options)
+    parser.on('--hiera-path-strip PATH', 'Path prefix to strip when munging hiera.yaml') do |path_in|
+      options[:hiera_path_strip] = path_in
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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.
+
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:hostname) do
+  has_weight 1
+
+  def parse(parser, options)
+    parser.on('--hostname HOSTNAME', '-n', 'Use PuppetDB facts from last run of hostname') do |hostname|
+      options[:node] = hostname
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:ignore) do
+  has_weight 130
+
+  def parse(parser, options)
+    descriptive_text = 'More resources to ignore in format type[title]'
+    parser.on('--ignore "Type1[Title1],Type2[Title2],..."', Array, descriptive_text) do |res|
+      options[:ignore] ||= []
+      res.each do |item|
+        if item =~ /\A(.+?)\[(.+)\](.+)/
+          h = { type: Regexp.last_match(1), title: Regexp.last_match(2) }
+          h[:attr] = Regexp.last_match(3).gsub(/(\\f|::)/, "\f")
+          options[:ignore] << h
+        elsif item =~ /^(.+?)\[(.+)\]$/
+          options[:ignore] << { type: Regexp.last_match(1), title: Regexp.last_match(2) }
+        else
+          raise ArgumentError, "Ignore #{item} must be in Type[Title] or Type[Title]::Attribute format!"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# Specify attributes to ignore
+# @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(:ignore_attr) do
+  has_weight 190
+
+  def parse(parser, options)
+    parser.on('--ignore-attr "attr1,attr2,..."', Array, 'Attributes to ignore') do |res|
+      options[:ignore] ||= []
+      res.each do |item|
+        item_subst = item.gsub(/(\\f|::)/, "\f")
+        options[:ignore] << { attr: item_subst }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# 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
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:ignore_tags) do
+  has_weight 400
+
+  def parse(parser, options)
+    parser.on('--no-ignore-tags', 'Disable ignoring based on tags') do
+      if options[:ignore_tags]
+        raise ArgumentError, '--no-ignore-tags incompatible with --ignore-tags'
+      end
+      options[:no_ignore_tags] = true
+    end
+    parser.on('--ignore-tags STRING1[,STRING2[,...]]', Array, 'Specify tags to ignore') do |x|
+      if options[:no_ignore_tags]
+        raise ArgumentError, '--ignore-tags incompatible with --no-ignore-tags'
+      end
+      options[:ignore_tags] ||= []
+      options[:ignore_tags].concat x
+    end
+  end
+end