class InspecPlugins::Init::CLI

Constants

TEMPLATES_PATH

Public Class Methods

valid_profile_platforms() click to toggle source

inspec init profile

# File lib/plugins/inspec-init/lib/inspec-init/cli_profile.rb, line 10
def self.valid_profile_platforms
  # Look in the 'template/profiles' directory and detect which platforms are available.
  profile_templates_dir = File.join(TEMPLATES_PATH, "profiles")
  Dir.glob(File.join(profile_templates_dir, "*")).select { |p| File.directory?(p) }.map { |d| File.basename(d) }
end

Public Instance Methods

plugin(plugin_name) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 29
def plugin(plugin_name)
  plugin_type = determine_plugin_type(plugin_name)
  snake_case = plugin_name.tr("-", "_")

  # Handle deprecation of option --hook
  unless options[:hook].nil?
    Inspec.deprecate "cli_option_hook"
    options[:activator] = options.delete(:hook)
  end

  template_vars = {
    name: plugin_name,
    plugin_name: plugin_name,
    snake_case: snake_case,
  }.merge(plugin_vars_from_opts)

  template_path = File.join("plugins", plugin_type + "-plugin-template")

  render_opts = {
    templates_path: TEMPLATES_PATH,
    overwrite: options[:overwrite],
    file_rename_map: make_rename_map(plugin_type, plugin_name, snake_case),
    skip_files: make_skip_list(template_vars["activators"].keys),
  }

  renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)

  renderer.render_with_values(template_path, plugin_type + " plugin", template_vars)
end
profile(new_profile_name) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_profile.rb, line 27
def profile(new_profile_name)
  unless valid_profile_platforms.include?(options[:platform])
    ui.error "Unable to generate profile: No template available for platform '#{options[:platform]}' (expected one of: #{valid_profile_platforms.join(", ")})"
    ui.exit(:usage_error)
  end
  template_path = File.join("profiles", options[:platform])

  render_opts = {
    templates_path: TEMPLATES_PATH,
    overwrite: options[:overwrite],
  }
  renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)

  vars = {
    name: new_profile_name,
  }
  renderer.render_with_values(template_path, "profile", vars)
end
valid_profile_platforms() click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_profile.rb, line 17
def valid_profile_platforms
  self.class.valid_profile_platforms
end

Private Instance Methods

determine_plugin_type(plugin_name) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 61
def determine_plugin_type(plugin_name)
  plugin_type = plugin_name.match(/^(inspec|train)\-/)
  unless plugin_type
    ui.error("Plugin names must begin with either " + ui.emphasis("inspec") + " or " + ui.emphasis("train") + " - saw " + ui.emphasis(plugin_name))
    ui.exit(:usage_error)
  end
  options[:plugin_name] = plugin_name

  plugin_type = plugin_type[1]
  unless plugin_type == "inspec"
    ui.error("Sorry, only InSpec (inspec-) plugins are supported at this time: Train (train-) support is not implemented yet.")
    ui.exit(:usage_error)
  end
  plugin_type
end
fetch_license_text(license_name) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 190
      def fetch_license_text(license_name)
        case license_name
        when "Proprietary"
          <<~EOL
            Proprietary software.  All Rights Reserved.
          EOL
        when "Apache-2.0"
          <<~EOL
             Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
                 http://www.apache.org/licenses/LICENSE-2.0
             Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.

          EOL
        when "BSD-3-Clause"
          <<~EOL
            Modified BSD License
            Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
            1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
            2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
            3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
            THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
          EOL
        else
          '"Other" license selected at plugin generation time - please insert your license here.'
        end
      end
make_rename_map(_plugin_type, plugin_name, snake_case) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 77
def make_rename_map(_plugin_type, plugin_name, snake_case)
  {
    "inspec-plugin-template.gemspec" => plugin_name + ".gemspec",
    File.join("lib", "inspec-plugin-template") => File.join("lib", plugin_name),
    File.join("lib", "inspec-plugin-template.erb") => File.join("lib", plugin_name + ".rb"),
    File.join("lib", "inspec-plugin-template", "cli_command.erb") => File.join("lib", plugin_name, "cli_command.rb"),
    File.join("lib", "inspec-plugin-template", "reporter.erb") => File.join("lib", plugin_name, "reporter.rb"),
    File.join("lib", "inspec-plugin-template", "plugin.erb") => File.join("lib", plugin_name, "plugin.rb"),
    File.join("lib", "inspec-plugin-template", "version.erb") => File.join("lib", plugin_name, "version.rb"),
    File.join("test", "functional", "inspec_plugin_template_test.erb") => File.join("test", "functional", snake_case + "_test.rb"),
    File.join("test", "unit", "cli_args_test.erb") => File.join("test", "unit", "cli_args_test.rb"),
    File.join("test", "unit", "plugin_def_test.erb") => File.join("test", "unit", "plugin_def_test.rb"),
    File.join("test", "helper.erb") => File.join("test", "helper.rb"),
  }
end
make_skip_list(requested_activators) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 223
def make_skip_list(requested_activators)
  skips = []
  case options[:detail]
  when "full" # rubocop: disable Lint/EmptyWhen
    # Do nothing but allow this case for validation
  when "core"
    skips += [
      "Gemfile",
      "inspec-plugin-template.gemspec",
      "LICENSE",
      "Rakefile",
    ]
  when "test-fixture"
    skips += [
      "Gemfile",
      "inspec-plugin-template.gemspec",
      "LICENSE",
      "Rakefile",
      File.join("test", "fixtures", "README.md"),
      File.join("test", "fixtures"),
      File.join("test", "functional", "inspec_plugin_template_test.erb"),
      File.join("test", "functional", "README.md"),
      File.join("test", "unit", "cli_args_test.erb"),
      File.join("test", "unit", "plugin_def_test.erb"),
      File.join("test", "unit", "README.md"),
      File.join("test", "unit"),
      File.join("test", "helper.erb"),
      File.join("test"),
    ]
  else
    ui.error "Unrecognized value for 'detail': #{options[:detail]} - expected one of full, core, test-fixture"
    ui.exit(:usage_error)
  end

  # Remove activator-specific files
  unless requested_activators.include?(:cli_command)
    skips += [
      File.join("lib", "inspec-plugin-template", "cli_command.erb"),
      File.join("test", "unit", "cli_args_test.erb"),
      File.join("test", "functional", "inspec_plugin_template_test.erb"),
    ]
  end
  unless requested_activators.include?(:reporter)
    skips += [
      File.join("lib", "inspec-plugin-template", "reporter.erb"),
    ]
  end

  skips.uniq
end
parse_activator_option(raw_option) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 166
def parse_activator_option(raw_option)
  activators_by_type = {}
  raw_option.each do |entry|
    parts = entry.split(":")
    type = parts.first.to_sym
    name = parts.last
    if activators_by_type.key?(type)
      ui.error "The InSpec plugin generator can currently only generate one activator of each type"
      ui.exit(:usage_error)
    end
    activators_by_type[type] = name
  end

  vars = { activators: activators_by_type }
  if activators_by_type.key?(:cli_command)
    vars[:command_name_dashes] = activators_by_type[:cli_command].tr("_", "-")
    vars[:command_name_snake] = activators_by_type[:cli_command].tr("-", "_")
  elsif activators_by_type.key?(:reporter)
    vars[:reporter_name_dashes] = activators_by_type[:reporter].tr("_", "-")
    vars[:reporter_name_snake] = activators_by_type[:reporter].tr("-", "_")
  end
  vars
end
plugin_vars_from_opts() click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 93
def plugin_vars_from_opts
  # Set dynamic default - module name is straightforward.  Copyright, homepage, and license_text depend on other prompted vars.
  options[:module_name] ||= options[:plugin_name].sub(/^(inspec|train)\-/, "").split("-").map(&:capitalize).join("")

  if options[:prompt] && ui.interactive?
    vars = options.dup.merge(vars_from_prompts)
  elsif !options[:prompt]
    vars = options.dup.merge(vars_from_defaults)

  else
    ui.error("You requested interactive prompting for the template variables, but this does not seem to be an interactive terminal.")
    ui.exit(:usage_error)
  end
  vars.merge(parse_activator_option(options[:activator]))
end
prompt_for_options(option_order) click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 144
def prompt_for_options(option_order) # rubocop: disable Metrics/AbcSize
  option_defs = self.class.all_commands["plugin"].options

  option_order.each do |opt_name, prompt_options|
    opt_def = option_defs[opt_name]
    prompt_options[:default_setter]&.call

    case prompt_options[:mode]
    when :select
      options[opt_name] = ui.prompt.select("Choose " + opt_def.description + ":", prompt_options[:choices])
      if opt_name == :license_name && options[opt_name] == "Other"
        ui.plain_line "OK, be sure to update the " + ui.emphasis("LICENSE") + " file with your license details."
      end
    when :multiline
      options[opt_name] = ui.prompt.multiline("Enter " + opt_def.description + ". Press Control-D to end.", default: options[opt_name])
    else
      # Assume plain ask
      options[opt_name] = ui.prompt.ask("Enter " + opt_def.description + ":", default: options[opt_name])
    end
  end
end
vars_from_defaults() click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 109
def vars_from_defaults
  options[:copyright] ||= "Copyright © " + Date.today.year.to_s + " " + options[:author_name]
  options[:homepage] ||= "https://github.com/" + options[:author_email].split("@").first + "/" + options[:plugin_name]
  options[:license_text] = fetch_license_text(options[:license_name])
  options
end
vars_from_prompts() click to toggle source
# File lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb, line 116
def vars_from_prompts
  order = {
    author_name: {},
    author_email: {},
    summary: {},
    description: { mode: :multiline },
    module_name: {},
    copyright: { default_setter: proc { options[:copyright] ||= "Copyright © " + Date.today.year.to_s + " " + options[:author_name] } },
    license_name: {
      mode: :select,
      choices: [
        { name: "Apache 2.0", value: "Apache-2.0", default: true },
        { name: "Modified BSD", value: "BSD-3-Clause" },
        { name: "Proprietary (Closed Source)", value: "Proprietary" },
        { name: "Other (edit LICENSE yourself)", value: "Other" },
      ],
    },
    homepage: { default_setter: proc { options[:homepage] ||= "https://github.com/" + options[:author_email].split("@").first + "/" + options[:plugin_name] } },
    # TODO: Handle activators, when we ever have more than one type of plugin
  }

  prompt_for_options(order)

  options[:license_text] = fetch_license_text(options[:license_name])

  options
end