octocatalog-diff 0.5.1

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

@@ -0,0 +1,12 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:include_tags) do
+  has_weight 140
+
+  def parse(parser, options)
+    parser.on('--[no-]include-tags', 'Include changes to tags in the diff output') do |x|
+      options[:include_tags] = x
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:master_cache_branch) do
+  has_weight 160
+
+  def parse(parser, options)
+    parser.on('--master-cache-branch BRANCH', 'Branch to cache') do |x|
+      options[:master_cache_branch] = x
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# Output file 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(:output_file) do
+  has_weight 90
+
+  def parse(parser, options)
+    parser.on('--output-file FILENAME', '-o', 'Output results into FILENAME') do |filename|
+      path = File.absolute_path(filename)
+      options[:output_file] = path
+      options[:format] = :text
+      options[:colors] = false
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# Output format 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(:output_format) do
+  has_weight 100
+
+  def parse(parser, options)
+    valid = %w(text json)
+    parser.on('--output-format FORMAT', "Output format: #{valid.join(',')}") do |fmt|
+      raise ArgumentError, "Invalid format. Must be one of: #{valid.join(',')}" unless valid.include?(fmt)
+      options[:format] = fmt.to_sym
+      options[:format] = :color_text if options[:format] == :text && options[:colors]
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:parallel) do
+  has_weight 300
+
+  def parse(parser, options)
+    parser.on('--[no-]parallel', 'Enable or disable parallel processing') do |x|
+      options[:parallel] = x
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:parser) do
+  has_weight 270
+
+  def parse(parser, options)
+    supported_parsers = %w(default future)
+    parser_str = supported_parsers.join(', ')
+
+    # --parser sets both parser-to and parser-from
+    parser.on('--parser PARSER_NAME', "Specify parser (#{parser_str})") do |x|
+      unless supported_parsers.include?(x)
+        raise ArgumentError, "--parser must be one of: #{parser_str}"
+      end
+      unless options[:parser_from].nil? || options[:parser_from] == x.to_sym
+        raise ArgumentError, '--parser conflicts with --parser-from'
+      end
+      unless options[:parser_to].nil? || options[:parser_to] == x.to_sym
+        raise ArgumentError, '--parser conflicts with --parser-to'
+      end
+      options[:parser_from] = x.to_sym
+      options[:parser_to] = x.to_sym
+    end
+
+    # --parser-from sets parser for the 'from' branch
+    parser.on('--parser-from PARSER_NAME', "Specify parser (#{parser_str})") do |x|
+      unless supported_parsers.include?(x)
+        raise ArgumentError, "--parser-from must be one of: #{parser_str}"
+      end
+      unless options[:parser_from].nil? || options[:parser_from] == x.to_sym
+        raise ArgumentError, '--parser incompatible with --parser-from'
+      end
+      options[:parser_from] = x.to_sym
+    end
+
+    # --parser-to sets parser for the 'to' branch
+    parser.on('--parser-to PARSER_NAME', "Specify parser (#{parser_str})") do |x|
+      unless supported_parsers.include?(x)
+        raise ArgumentError, "--parser-to must be one of: #{parser_str}"
+      end
+      unless options[:parser_to].nil? || options[:parser_to] == x.to_sym
+        raise ArgumentError, '--parser incompatible with --parser-to'
+      end
+      options[:parser_to] = x.to_sym
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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.
+# @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(:pass_env_vars) do
+  has_weight 600
+
+  def parse(parser, options)
+    descriptive_text = 'Environment variables to pass'
+    parser.on('--pass-env-vars VAR1[,VAR2[,...]]', Array, descriptive_text) do |res|
+      options[:pass_env_vars] ||= []
+      res.each do |item|
+        raise ArgumentError, "Environment variable #{item} must be in alphanumeric format!" unless item =~ /^\w+$/
+        options[:pass_env_vars] << item
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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.
+# @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(:pe_enc_ssl_ca) do
+  has_weight 352
+
+  def parse(parser, options)
+    parser.on('--pe-enc-ssl-ca FILENAME', 'CA certificate that signed the ENC API certificate') do |x|
+      raise Errno::ENOENT, "--pe-enc-ssl-ca #{x} does not point to a valid file" unless File.file?(x)
+      options[:pe_enc_ssl_ca] = x
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:pe_enc_ssl_client_cert) do
+  has_weight 353
+
+  def parse(parser, options)
+    parser.on('--pe-enc-ssl-client-cert FILENAME', 'SSL client certificate to connect to PE ENC') do |x|
+      raise Errno::ENOENT, "--pe-enc-ssl-client-cert #{x} does not point to a valid file" unless File.file?(x)
+      options[:pe_enc_ssl_client_cert] = File.read(x)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# Specify the client key for connecting to Puppet Enterprise ENC. This must be specified along with
+# --pe-enc-ssl-client-cert in order to work.
+# @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(:pe_enc_ssl_client_key) do
+  has_weight 354
+
+  def parse(parser, options)
+    parser.on('--pe-enc-ssl-client-key FILENAME', 'SSL client key to connect to PE ENC') do |x|
+      raise Errno::ENOENT, "--pe-enc-ssl-client-key #{x} does not point to a valid file" unless File.file?(x)
+      options[:pe_enc_ssl_client_key] = File.read(x)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# Specify the access token to access the Puppet Enterprise ENC. Refer to
+# https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
+# details on generating and obtaining a token. Use this option to specify the text
+# of the token. (Use --pe-enc-token-file to read the content of the token from a 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(:pe_enc_token) do
+  has_weight 351
+
+  def parse(parser, options)
+    parser.on('--pe-enc-token TOKEN', 'Token to access the Puppet Enterprise ENC API') do |token|
+      options[:pe_enc_token] = token
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# Specify the access token to access the Puppet Enterprise ENC. Refer to
+# https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
+# details on generating and obtaining a token. Use this option if the token is stored
+# in a file, to read the content of the token from the 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(:pe_enc_token_file) do
+  has_weight 351
+
+  def parse(parser, options)
+    parser.on('--pe-enc-token-file PATH', 'Path containing token for PE node classifier, relative or absolute') do |x|
+      proposed_token_path = x.start_with?('/') ? x : File.join(options[:basedir], x)
+      raise Errno::ENOENT, "Provided token (#{proposed_token_path}) does not exist" unless File.file?(proposed_token_path)
+      options[:pe_enc_token] = File.read(proposed_token_path)
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'uri'
+
+# Specify the URL to the Puppet Enterprise ENC API. By default, the node classifier service
+# listens on port 4433 and all endpoints are relative to the /classifier-api/ path. That means
+# the likely value for this option will be something like:
+# https://your-pe-console-server:4433/classifier-api
+# @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(:pe_enc_url) do
+  has_weight 350
+
+  def parse(parser, options)
+    parser.on('--pe-enc-url URL', 'Base URL for Puppet Enterprise ENC endpoint') do |url|
+      obj = URI.parse(url)
+      raise ArgumentError, 'PE ENC URL must be https' unless obj.is_a?(URI::HTTPS)
+      options[:pe_enc_url] = url
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# Set --puppet-binary, --to-puppet-binary, --from-puppet-binary
+# @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(:puppet_binary) do
+  has_weight 300
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-binary',
+      option_name: 'puppet_binary',
+      desc: 'Full path to puppet binary'
+    )
+  end
+end

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

@@ -0,0 +1,16 @@
+# Specify the hostname, or hostname:port, for the Puppet Master.
+# @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(:puppet_master) do
+  has_weight 320
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-master',
+      option_name: 'puppet_master',
+      desc: 'Hostname or Hostname:PortNumber for Puppet Master'
+    )
+  end
+end

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

@@ -0,0 +1,20 @@
+# Specify the API version to use for the Puppet Master. This makes it possible to authenticate to a
+# version 3.x PuppetMaster by specifying the API version as 2, or for a version 4.x PuppetMaster by
+# specifying API version as 3.
+# @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(:puppet_master_api_version) do
+  has_weight 320
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-master-api-version',
+      option_name: 'puppet_master_api_version',
+      desc: 'Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x)',
+      validator: ->(x) { x =~ /^[23]$/ || raise(ArgumentError, 'Only API versions 2 and 3 are supported') },
+      translator: ->(x) { x.to_i }
+    )
+  end
+end

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

@@ -0,0 +1,19 @@
+# Specify the CA certificate for Puppet Master. 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.
+# @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(:puppet_master_ssl_ca) do
+  has_weight 320
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-master-ssl-ca',
+      option_name: 'puppet_master_ssl_ca',
+      desc: 'Full path to CA certificate that signed the Puppet Master certificate',
+      validator: ->(x) { File.file?(x) || raise(Errno::ENOENT, "SSL CA cert #{x} does not exist") }
+    )
+  end
+end

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

@@ -0,0 +1,19 @@
+# Specify the SSL client certificate for Puppet Master. This makes it possible to authenticate with a
+# client certificate keypair to the Puppet Master.
+# @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(:puppet_master_ssl_client_cert) do
+  has_weight 320
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-master-ssl-client-cert',
+      option_name: 'puppet_master_ssl_client_cert',
+      desc: 'Full path to certificate file for SSL client auth to Puppet Master',
+      validator: ->(x) { File.file?(x) || raise(Errno::ENOENT, "Suggested certificate #{x} does not exist") },
+      translator: ->(x) { File.read(x) }
+    )
+  end
+end

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

@@ -0,0 +1,19 @@
+# Specify the SSL client key for Puppet Master. This makes it possible to authenticate with a
+# client certificate keypair to the Puppet Master.
+# @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(:puppet_master_ssl_client_key) do
+  has_weight 320
+
+  def parse(parser, options)
+    OctocatalogDiff::CatalogDiff::Cli::Options.option_globally_or_per_branch(
+      parser: parser,
+      options: options,
+      cli_name: 'puppet-master-ssl-client-key',
+      option_name: 'puppet_master_ssl_client_key',
+      desc: 'Full path to key file for SSL client auth to Puppet Master',
+      validator: ->(x) { File.file?(x) || raise(Errno::ENOENT, "Suggested key #{x} does not exist") },
+      translator: ->(x) { File.read(x) }
+    )
+  end
+end

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

@@ -0,0 +1,15 @@
+# Specify the CA certificate for PuppetDB. 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.
+# @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(:puppetdb_ssl_ca) do
+  has_weight 310
+
+  def parse(parser, options)
+    parser.on('--puppetdb-ssl-ca FILENAME', 'CA certificate that signed the PuppetDB certificate') do |x|
+      raise Errno::ENOENT, "--puppetdb-ssl-ca #{x} does not point to a valid file" unless File.file?(x)
+      options[:puppetdb_ssl_ca] = x
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# Specify the client certificate for connecting to PuppetDB. This must be specified along with
+# --puppetdb-ssl-client-key in order to work.
+# @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(:puppetdb_ssl_client_cert) do
+  has_weight 310
+
+  def parse(parser, options)
+    parser.on('--puppetdb-ssl-client-cert FILENAME', 'SSL client certificate to connect to PuppetDB') do |x|
+      raise Errno::ENOENT, "--puppetdb-ssl-client-cert #{x} does not point to a valid file" unless File.file?(x)
+      options[:puppetdb_ssl_client_cert] = File.read(x)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# Specify the client key for connecting to PuppetDB. This must be specified along with
+# --puppetdb-ssl-client-cert in order to work.
+# @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(:puppetdb_ssl_client_key) do
+  has_weight 310
+
+  def parse(parser, options)
+    parser.on('--puppetdb-ssl-client-key FILENAME', 'SSL client key to connect to PuppetDB') do |x|
+      raise Errno::ENOENT, "--puppetdb-ssl-client-key #{x} does not point to a valid file" unless File.file?(x)
+      options[:puppetdb_ssl_client_key] = File.read(x)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# Specify the password for a PEM or PKCS12 private key on the command line.
+# Note that `--puppetdb-ssl-client-password-file` is slightly more secure because
+# the text of the password won't appear in the process list.
+# @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(:puppetdb_ssl_client_cert) do
+  has_weight 310
+
+  def parse(parser, options)
+    parser.on('--puppetdb-ssl-client-password PASSWORD', 'Password for SSL client key to connect to PuppetDB') do |x|
+      options[:puppetdb_ssl_client_password] = x
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# Specify the password for a PEM or PKCS12 private key, by reading it from a 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(:puppetdb_ssl_client_password_file) do
+  has_weight 310
+
+  def parse(parser, options)
+    parser.on('--puppetdb-ssl-client-password-file FILENAME', 'Read password for SSL client key from a file') do |x|
+      raise Errno::ENOENT, "--puppetdb-ssl-client-password-file #{x} does not point to a valid file" unless File.file?(x)
+      options[:puppetdb_ssl_client_password] = File.read(x)
+    end
+  end
+end