inspec 4.3.2 → 4.6.3

data/lib/plugins/inspec-init/lib/inspec-init.rb

@@ -4,7 +4,7 @@ module InspecPlugins
       plugin_name :'inspec-init'
 
       cli_command :init do
-        require_relative 'inspec-init/cli'
+        require_relative "inspec-init/cli"
         InspecPlugins::Init::CLI
       end
     end

data/lib/plugins/inspec-init/lib/inspec-init/cli.rb

@@ -1,17 +1,15 @@
-# encoding: utf-8
-
-require 'pathname'
-require_relative 'renderer'
+require "pathname"
+require_relative "renderer"
 
 module InspecPlugins
   module Init
     class CLI < Inspec.plugin(2, :cli_command)
-      subcommand_desc 'init SUBCOMMAND', 'Generate InSpec code'
+      subcommand_desc "init SUBCOMMAND", "Generate InSpec code"
 
-      TEMPLATES_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates'))
+      TEMPLATES_PATH = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "templates"))
 
-      require_relative 'cli_profile'
-      require_relative 'cli_plugin'
+      require_relative "cli_profile"
+      require_relative "cli_plugin"
     end
   end
 end

data/lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require_relative 'renderer'
+require_relative "renderer"
 
 module InspecPlugins
   module Init
@@ -8,28 +6,28 @@ module InspecPlugins
       #-------------------------------------------------------------------#
       #                 inspec init plugin
       #-------------------------------------------------------------------#
-      desc 'PLUGIN_NAME [options]', 'Generates an InSpec plugin, which can extend the functionality of InSpec itself.'
+      desc "plugin PLUGIN_NAME [options]", "Generates an InSpec plugin, which can extend the functionality of InSpec itself."
       # General options
-      option :prompt, type: :boolean, default: true, desc: 'Interactively prompt for information to put in your generated plugin.'
-      option :detail, type: :string, default: 'full', desc: "How detailed of a plugin to generate. 'full' is a normal full gem with tests; 'core' has tests but no gemspec; 'test-fixture' is stripped down for a test fixture."
+      option :prompt, type: :boolean, default: true, desc: "Interactively prompt for information to put in your generated plugin."
+      option :detail, type: :string, default: "full", desc: "How detailed of a plugin to generate. 'full' is a normal full gem with tests; 'core' has tests but no gemspec; 'test-fixture' is stripped down for a test fixture."
 
       # Templating vars
-      option :author_email, type: :string, default: 'you@example.com', desc: 'Author Email for gemspec'
-      option :author_name, type: :string, default: 'Your Name', desc: 'Author Name for gemspec'
-      option :description, type: :string, default: '', desc: 'Multi-line description of the plugin'
-      option :summary, type: :string, default: 'A plugin with a default summary', desc: 'One-line summary of your plugin'
-      option :license_name, type: :string, default: 'Apache-2.0', desc: 'The name of a license'
-      option :hook, type: :array, default: ['cli_command:my_command'], desc: 'A list of plugin hooks, in the form type1:name1, type2:name2, etc'
+      option :author_email, type: :string, default: "you@example.com", desc: "Author Email for gemspec"
+      option :author_name, type: :string, default: "Your Name", desc: "Author Name for gemspec"
+      option :description, type: :string, default: "", desc: "Multi-line description of the plugin"
+      option :summary, type: :string, default: "A plugin with a default summary", desc: "One-line summary of your plugin"
+      option :license_name, type: :string, default: "Apache-2.0", desc: "The name of a license"
+      option :hook, type: :array, default: ["cli_command:my_command"], desc: "A list of plugin hooks, in the form type1:name1, type2:name2, etc"
       # These vars have calculated defaults
-      option :homepage, type: :string, default: nil, desc: 'A URL for your project, often a GitHub link'
-      option :module_name, type: :string, default: nil, desc: 'Module Name for your plugin package.  Will change plugin name to CamelCase by default.'
-      option :license_text, type: :string, default: '', hide: true
-      option :plugin_name, type: :string, default: '', hide: true # This is here to give a uniform interface
-      option :copyright, type: :string, default: nil, desc: 'A copyright statement, to be added to LICENSE'
+      option :homepage, type: :string, default: nil, desc: "A URL for your project, often a GitHub link"
+      option :module_name, type: :string, default: nil, desc: "Module Name for your plugin package.  Will change plugin name to CamelCase by default."
+      option :license_text, type: :string, default: "", hide: true
+      option :plugin_name, type: :string, default: "", hide: true # This is here to give a uniform interface
+      option :copyright, type: :string, default: nil, desc: "A copyright statement, to be added to LICENSE"
 
       def plugin(plugin_name)
         plugin_type = determine_plugin_type(plugin_name)
-        snake_case = plugin_name.tr('-', '_')
+        snake_case = plugin_name.tr("-", "_")
 
         template_vars = {
           name: plugin_name,
@@ -37,7 +35,7 @@ module InspecPlugins
           snake_case: snake_case,
         }.merge(plugin_vars_from_opts)
 
-        template_path = File.join('plugins', plugin_type + '-plugin-template')
+        template_path = File.join("plugins", plugin_type + "-plugin-template")
 
         render_opts = {
           templates_path: TEMPLATES_PATH,
@@ -47,7 +45,7 @@ module InspecPlugins
         }
         renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)
 
-        renderer.render_with_values(template_path, plugin_type + ' plugin', template_vars)
+        renderer.render_with_values(template_path, plugin_type + " plugin", template_vars)
       end
 
       private
@@ -55,14 +53,14 @@ module InspecPlugins
       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.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.')
+        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
@@ -70,19 +68,19 @@ module InspecPlugins
 
       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.rb') => File.join('lib', plugin_name + '.rb'),
-          File.join('lib', 'inspec-plugin-template', 'cli_command.rb') => File.join('lib', plugin_name, 'cli_command.rb'),
-          File.join('lib', 'inspec-plugin-template', 'plugin.rb') => File.join('lib', plugin_name, 'plugin.rb'),
-          File.join('lib', 'inspec-plugin-template', 'version.rb') => File.join('lib', plugin_name, 'version.rb'),
-          File.join('test', 'functional', 'inspec_plugin_template_test.rb') => File.join('test', 'functional', snake_case + '_test.rb'),
+          "inspec-plugin-template.gemspec" => plugin_name + ".gemspec",
+          File.join("lib", "inspec-plugin-template") => File.join("lib", plugin_name),
+          File.join("lib", "inspec-plugin-template.rb") => File.join("lib", plugin_name + ".rb"),
+          File.join("lib", "inspec-plugin-template", "cli_command.rb") => File.join("lib", plugin_name, "cli_command.rb"),
+          File.join("lib", "inspec-plugin-template", "plugin.rb") => File.join("lib", plugin_name, "plugin.rb"),
+          File.join("lib", "inspec-plugin-template", "version.rb") => File.join("lib", plugin_name, "version.rb"),
+          File.join("test", "functional", "inspec_plugin_template_test.rb") => File.join("test", "functional", snake_case + "_test.rb"),
         }
       end
 
       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('')
+        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)
@@ -90,15 +88,15 @@ module InspecPlugins
           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.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_hook_option(options[:hook]))
       end
 
       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[: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
@@ -110,17 +108,17 @@ module InspecPlugins
           summary: {},
           description: { mode: :multiline },
           module_name: {},
-          copyright: { default_setter: proc { options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_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' },
+              { 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] } }
+          homepage: { default_setter: proc { options[:homepage] ||= "https://github.com/" + options[:author_email].split("@").first + "/" + options[:plugin_name] } },
           # TODO: Handle hooks, when we ever have more than one type of plugin
         }
 
@@ -132,7 +130,7 @@ module InspecPlugins
       end
 
       def prompt_for_options(option_order) # rubocop: disable Metrics/AbcSize
-        option_defs = self.class.all_commands['plugin'].options
+        option_defs = self.class.all_commands["plugin"].options
 
         option_order.each do |opt_name, prompt_options|
           opt_def = option_defs[opt_name]
@@ -140,15 +138,15 @@ module InspecPlugins
 
           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.'
+            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])
+            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])
+            options[opt_name] = ui.prompt.ask("Enter " + opt_def.description + ":", default: options[opt_name])
           end
         end
       end
@@ -156,11 +154,11 @@ module InspecPlugins
       def parse_hook_option(raw_option)
         hooks_by_type = {}
         raw_option.each do |entry|
-          parts = entry.split(':')
+          parts = entry.split(":")
           type = parts.first.to_sym
           name = parts.last
           if hooks_by_type.key?(type)
-            ui.error 'The InSpec plugin generator can currently only generate one hook of each type'
+            ui.error "The InSpec plugin generator can currently only generate one hook of each type"
             ui.exit(:usage_error)
           end
           hooks_by_type[type] = name
@@ -168,19 +166,19 @@ module InspecPlugins
 
         vars = { hooks: hooks_by_type }
         if hooks_by_type.key?(:cli_command)
-          vars[:command_name_dashes] = hooks_by_type[:cli_command].tr('_', '-')
-          vars[:command_name_snake] = hooks_by_type[:cli_command].tr('-', '_')
+          vars[:command_name_dashes] = hooks_by_type[:cli_command].tr("_", "-")
+          vars[:command_name_snake] = hooks_by_type[:cli_command].tr("-", "_")
         end
         vars
       end
 
       def fetch_license_text(license_name)
         case license_name
-        when 'Proprietary'
+        when "Proprietary"
           <<~EOL
             Proprietary software.  All Rights Reserved.
           EOL
-        when 'Apache-2.0'
+        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.
@@ -193,7 +191,7 @@ module InspecPlugins
             limitations under the License.
 
           EOL
-        when 'BSD-3-Clause'
+        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:
@@ -209,31 +207,31 @@ module InspecPlugins
 
       def make_skip_list
         case options[:detail]
-        when 'full'
+        when "full"
           []
-        when 'core'
+        when "core"
           [
-            'Gemfile',
-            'inspec-plugin-template.gemspec',
-            'LICENSE',
-            'Rakefile',
+            "Gemfile",
+            "inspec-plugin-template.gemspec",
+            "LICENSE",
+            "Rakefile",
           ]
-        when 'test-fixture'
+        when "test-fixture"
           [
-            '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.rb'),
-            File.join('test', 'functional', 'README.md'),
-            File.join('test', 'unit', 'cli_args_test.rb'),
-            File.join('test', 'unit', 'plugin_def_test.rb'),
-            File.join('test', 'unit', 'README.md'),
-            File.join('test', 'unit'),
-            File.join('test', 'helper.rb'),
-            File.join('test'),
+            "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.rb"),
+            File.join("test", "functional", "README.md"),
+            File.join("test", "unit", "cli_args_test.rb"),
+            File.join("test", "unit", "plugin_def_test.rb"),
+            File.join("test", "unit", "README.md"),
+            File.join("test", "unit"),
+            File.join("test", "helper.rb"),
+            File.join("test"),
           ]
         else
           ui.error "Unrecognized value for 'detail': #{options[:detail]} - expected one of full, core, test-fixture"

data/lib/plugins/inspec-init/lib/inspec-init/cli_profile.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
-require 'pathname'
-require_relative 'renderer'
+require "pathname"
+require_relative "renderer"
 
 module InspecPlugins
   module Init
@@ -11,8 +9,8 @@ module InspecPlugins
       #-------------------------------------------------------------------#
       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) }
+        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
 
       no_commands do
@@ -21,17 +19,17 @@ module InspecPlugins
         end
       end
 
-      desc 'profile [OPTIONS] NAME', 'Generate a new profile'
-      option :platform, default: 'os', type: :string, aliases: [:p],
+      desc "profile [OPTIONS] NAME", "Generate a new profile"
+      option :platform, default: "os", type: :string, aliases: [:p],
              desc: "Which platform to generate a profile for: choose from #{valid_profile_platforms.join(', ')}"
       option :overwrite, type: :boolean, default: false,
-             desc: 'Overwrites existing directory'
+             desc: "Overwrites existing directory"
       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])
+        template_path = File.join("profiles", options[:platform])
 
         render_opts = {
           templates_path: TEMPLATES_PATH,
@@ -42,7 +40,7 @@ module InspecPlugins
         vars = {
           name: new_profile_name,
         }
-        renderer.render_with_values(template_path, 'profile', vars)
+        renderer.render_with_values(template_path, "profile", vars)
       end
     end
   end

data/lib/plugins/inspec-init/lib/inspec-init/renderer.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'erb'
+require "fileutils"
+require "erb"
 
 module InspecPlugins
   module Init
@@ -24,7 +24,7 @@ module InspecPlugins
         source_dir = File.join(templates_path, template_subdir_path)
 
         # prepare glob for all subdirectories and files
-        template_glob = File.join(source_dir, '**', '{*,.*}')
+        template_glob = File.join(source_dir, "**", "{*,.*}")
 
         # Use the name attribute to define the path to the new thing.
         # May contain slashes.
@@ -43,7 +43,7 @@ module InspecPlugins
           ui.exit(:usage_error)
         end
 
-        ui.headline('InSpec Code Generator')
+        ui.headline("InSpec Code Generator")
 
         ui.plain_line "Creating new #{template_type} at #{ui.emphasis(full_destination_path)}"
 

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/Gemfile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 source 'https://rubygems.org'
 
 gemspec

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/inspec-plugin-template.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 # As plugins are usually packaged and distributed as a RubyGem,
 # we have to provide a .gemspec file, which controls the gembuild
 # and publish process.  This is a fairly generic gemspec.

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # This file is known as the "entry point."
 # This is the file InSpec will try to load if it
 # thinks your plugin is installed.

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/cli_command.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'inspec/resource'
 
 module InspecPlugins::<%= module_name %>

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/plugin.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 # Plugin Definition file
 # The purpose of this file is to declare to InSpec what plugin_types (capabilities)
 # are included in this plugin, and provide hooks that will load them as needed.

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/version.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 # This file simply makes it easier for CI engines to update
 # the version stamp, and provide a clean way for the gemspec
 # to learn the current version.

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/functional/inspec_plugin_template_test.rb

@@ -6,7 +6,7 @@
 # Include our test harness
 require_relative '../helper'
 
-# Because InSpec is a Spec-style test suite, we're going to use MiniTest::Spec
+# Because InSpec is a Spec-style test suite, we're going to use Minitest::Spec
 # here, for familiar look and feel. However, this isn't InSpec (or RSpec) code.
 describe 'inspec list-resources core' do
   # Our helper.rb locates this library from the InSpec install that
@@ -30,11 +30,11 @@ describe 'inspec list-resources core' do
     # think that this plugin we are currently testing is installed as a
     # user plugin, by writing a plugin config file in a temp dir.
     # To use it, just provide a command line, minus the word `inspec`.
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core') }
+    let(:outcome) { run_inspec_process_with_this_plugin("listresources core") }
 
     # Some tests through here use minitest Expectations, which attach to all
     # Objects, and begin with 'must' (positive) or 'wont' (negative)
-    # See https://ruby-doc.org/stdlib-2.1.0/libdoc/minitest/rdoc/MiniTest/Expectations.html
+    # See http://docs.seattlerb.org/minitest/Minitest/Expectations.html
     it("should exit successfully") { outcome.exit_status.must_equal(0) }
     it("should be silent on stderr") { outcome.stderr.must_be_empty }
 
@@ -56,7 +56,7 @@ describe 'inspec list-resources core' do
   describe "when run with a search pattern that matches things" do
     # Notice that the command line is changed here:
     # "list all resources that have the word user in them"
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core user') }
+    let(:outcome) { run_inspec_process_with_this_plugin("listresources core user") }
 
     # Should be well-behaved...
     it("should exit successfully") { outcome.exit_status.must_equal(0) }
@@ -76,7 +76,7 @@ describe 'inspec list-resources core' do
   end
   describe "when run with a search pattern that matches nothing" do
     # Unlikely we'll have a resource with the string 'autogyro' in it.
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core autogyro') }
+    let(:outcome) { run_inspec_process_with_this_plugin("listresources core autogyro") }
 
     # Should be well-behaved...
     it("should exit successfully") { outcome.exit_status.must_equal(0) }