inspec-core 4.37.20 → 4.37.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e824612959dfc0663c92583fa5a542300d6953bcd32b28cfabf48b0709b9bf6
-  data.tar.gz: 79edead9df8512f94c9472bead2afd509b080f30e68630c912208734dc0b7bf1
+  metadata.gz: c9e4ef72fd93cf8c9de6cf6a6b14473388a1df8edee971d3e9db0dc89e31a756
+  data.tar.gz: 79ab3e58e1f574f6bd34aff949a965ed7c01744745cb09eba4768a420f9fe60b
 SHA512:
-  metadata.gz: fba880eaf388b7ebb28a731ddaaab23a6c0b4f8a75ee70315c75f68d05445cc32c7c09109e5f9a696d8257111d5cf520409bf2d18079255fc7cce9376a3e87e3
-  data.tar.gz: e5bf78b8ee6a067ca8762326093f92c26f97b1c102b0198ec3a494a520bb0a6fc137ff2d6f992e36e3ff690389c2082b3f92484a79266e91e7359a25d8719df7
+  metadata.gz: c1254e07b8263b7f97c53a3a3768db4fd50692d49defe607e2f7ceb42fce86c6a53909472e0b28fe7cbb58cfcdb6255dd549adaca18836ba2475f8644dab4153
+  data.tar.gz: 8b45db91165ebd6a9af3102a4a4f60e9cf1fd404f5cc28452cc4df92e1554cce42a009e40b6a11de1d13569bada66a270d344076965138d32e52aea045a8ca52

data/etc/deprecations.json

@@ -120,6 +120,11 @@
     "object_classes": {
       "action": "warn",
       "suffix": "These classes will be removed in InSpec 5.0."
+    },
+    "cli_option_hook":{
+      "action": "warn",
+      "prefix": "The --hook option is being replaced by the --activator option.",
+      "suffix": "This options will be removed in InSpec 4.0."
     }
   }
 }

data/lib/inspec/version.rb

@@ -1,3 +1,3 @@
 module Inspec
-  VERSION = "4.37.20".freeze
+  VERSION = "4.37.23".freeze
 end

data/lib/plugins/inspec-compliance/lib/inspec-compliance/api.rb

@@ -24,16 +24,8 @@ module InspecPlugins
       # the username of the account is used that is logged in
       def self.profiles(config, profile_filter = nil) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
         owner = config["owner"] || config["user"]
-
-        # Chef Compliance
-        if is_compliance_server?(config)
-          url = "#{config["server"]}/user/compliance"
-        # Chef Automate2
-        elsif is_automate2_server?(config)
+        if is_automate2_server?(config)
           url = "#{config["server"]}/compliance/profiles/search"
-        # Chef Automate
-        elsif is_automate_server?(config)
-          url = "#{config["server"]}/profiles/#{owner}"
         else
           raise ServerConfigurationMissing
         end
@@ -45,12 +37,9 @@ module InspecPlugins
           id, ver = nil
         end
 
-        if is_automate2_server?(config)
-          body = { owner: owner, name: id }.to_json
-          response = InspecPlugins::Compliance::HTTP.post_with_headers(url, headers, body, config["insecure"])
-        else
-          response = InspecPlugins::Compliance::HTTP.get(url, headers, config["insecure"])
-        end
+        body = { owner: owner, name: id }.to_json
+        response = InspecPlugins::Compliance::HTTP.post_with_headers(url, headers, body, config["insecure"])
+
         data = response.body
         response_code = response.code
         case response_code
@@ -58,25 +47,12 @@ module InspecPlugins
           msg = "success"
           profiles = JSON.parse(data)
           # iterate over profiles
-          if is_compliance_server?(config)
-            mapped_profiles = []
-            profiles.values.each do |org|
-              mapped_profiles += org.values
-            end
-          # Chef Automate pre 0.8.0
-          elsif is_automate_server_pre_080?(config)
-            mapped_profiles = profiles.values.flatten
-          elsif is_automate2_server?(config)
-            mapped_profiles = []
-            profiles["profiles"].each do |p|
-              mapped_profiles << p
-            end
-          else
-            mapped_profiles = profiles.map do |e|
-              e["owner_id"] = owner
-              e
-            end
+
+          mapped_profiles = []
+          profiles["profiles"].each do |p|
+            mapped_profiles << p
           end
+
           # filter by name and version if they were specified in profile_filter
           mapped_profiles.select! do |p|
             (!ver || p["version"] == ver) && (!id || p["name"] == id)
@@ -120,26 +96,9 @@ module InspecPlugins
       end
 
       def self.upload(config, owner, profile_name, archive_path)
-        # Chef Compliance
-        if is_compliance_server?(config)
-          url = "#{config["server"]}/owners/#{owner}/compliance/#{profile_name}/tar"
-        # Chef Automate pre 0.8.0
-        elsif is_automate_server_pre_080?(config)
-          url = "#{config["server"]}/#{owner}"
-        elsif is_automate2_server?(config)
-          url = "#{config["server"]}/compliance/profiles?owner=#{owner}"
-        # Chef Automate
-        else
-          url = "#{config["server"]}/profiles/#{owner}"
-        end
-
+        url = "#{config["server"]}/compliance/profiles?owner=#{owner}"
         headers = get_headers(config)
-        if is_automate2_server?(config)
-          res = InspecPlugins::Compliance::HTTP.post_multipart_file(url, headers, archive_path, config["insecure"])
-        else
-          res = InspecPlugins::Compliance::HTTP.post_file(url, headers, archive_path, config["insecure"])
-        end
-
+        res = InspecPlugins::Compliance::HTTP.post_multipart_file(url, headers, archive_path, config["insecure"])
         [res.is_a?(Net::HTTPSuccess), res.body]
       end
 
@@ -210,16 +169,12 @@ module InspecPlugins
 
       def self.get_headers(config)
         token = get_token(config)
-        if is_automate_server?(config) || is_automate2_server?(config)
-          headers = { "chef-delivery-enterprise" => config["automate"]["ent"] }
-          if config["automate"]["token_type"] == "dctoken"
-            headers["x-data-collector-token"] = token
-          else
-            headers["chef-delivery-user"] = config["user"]
-            headers["chef-delivery-token"] = token
-          end
+        headers = { "chef-delivery-enterprise" => config["automate"]["ent"] }
+        if config["automate"]["token_type"] == "dctoken"
+          headers["x-data-collector-token"] = token
         else
-          headers = { "Authorization" => "Bearer #{token}" }
+          headers["chef-delivery-user"] = config["user"]
+          headers["chef-delivery-token"] = token
         end
         headers
       end
@@ -232,16 +187,7 @@ module InspecPlugins
       end
 
       def self.target_url(config, profile)
-        owner, id, ver = profile_split(profile)
-
-        return "#{config["server"]}/compliance/profiles/tar" if is_automate2_server?(config)
-        return "#{config["server"]}/owners/#{owner}/compliance/#{id}/tar" unless is_automate_server?(config)
-
-        if ver.nil?
-          "#{config["server"]}/profiles/#{owner}/#{id}/tar"
-        else
-          "#{config["server"]}/profiles/#{owner}/#{id}/version/#{ver}/tar"
-        end
+        "#{config["server"]}/compliance/profiles/tar"
       end
 
       def self.profile_split(profile)
@@ -260,33 +206,6 @@ module InspecPlugins
         uri.to_s.sub(%r{^compliance:\/\/}, "")
       end
 
-      def self.is_compliance_server?(config)
-        config["server_type"] == "compliance"
-      end
-
-      def self.is_automate_server_pre_080?(config)
-        # Automate versions before 0.8.x do not have a valid version in the config
-        return false unless config["server_type"] == "automate"
-
-        server_version_from_config(config).nil?
-      end
-
-      def self.is_automate_server_080_and_later?(config)
-        # Automate versions 0.8.x and later will have a "version" key in the config
-        # that is properly parsed out via server_version_from_config below
-        return false unless config["server_type"] == "automate"
-
-        !server_version_from_config(config).nil?
-      end
-
-      def self.is_automate2_server?(config)
-        config["server_type"] == "automate2"
-      end
-
-      def self.is_automate_server?(config)
-        config["server_type"] == "automate"
-      end
-
       def self.server_version_from_config(config)
         # Automate versions 0.8.x and later will have a "version" key in the config
         # that looks like: "version":{"api":"compliance","version":"0.8.24"}
@@ -296,87 +215,8 @@ module InspecPlugins
         config["version"]["version"]
       end
 
-      def self.determine_server_type(url, insecure)
-        if target_is_automate2_server?(url, insecure)
-          :automate2
-        elsif target_is_automate_server?(url, insecure)
-          :automate
-        elsif target_is_compliance_server?(url, insecure)
-          :compliance
-        else
-          Inspec::Log.debug("Could not determine server type using known endpoints")
-          nil
-        end
-      end
-
-      def self.target_is_automate2_server?(url, insecure)
-        automate_endpoint = "/dex/auth"
-        response = InspecPlugins::Compliance::HTTP.get(url + automate_endpoint, nil, insecure)
-        if response.code == "400"
-          Inspec::Log.debug(
-            "Received 400 from #{url}#{automate_endpoint} - " \
-            "assuming target is a #{AUTOMATE_PRODUCT_NAME}2 instance"
-          )
-          true
-        else
-          Inspec::Log.debug(
-            "Received #{response.code} from #{url}#{automate_endpoint} - " \
-            "assuming target is not an #{AUTOMATE_PRODUCT_NAME}2 instance"
-          )
-          false
-        end
-      end
-
-      def self.target_is_automate_server?(url, insecure)
-        automate_endpoint = "/compliance/version"
-        response = InspecPlugins::Compliance::HTTP.get(url + automate_endpoint, nil, insecure)
-        case response.code
-        when "401"
-          Inspec::Log.debug(
-            "Received 401 from #{url}#{automate_endpoint} - " \
-            "assuming target is a #{AUTOMATE_PRODUCT_NAME} instance"
-          )
-          true
-        when "200"
-          # Chef Automate currently returns 401 for `/compliance/version` but some
-          # versions of OpsWorks Chef Automate return 200 and a Chef Manage page
-          # when unauthenticated requests are received.
-          if response.body.include?("Are You Looking For the #{SERVER_PRODUCT_NAME}?")
-            Inspec::Log.debug(
-              "Received 200 from #{url}#{automate_endpoint} - " \
-              "assuming target is an #{AUTOMATE_PRODUCT_NAME} instance"
-            )
-            true
-          else
-            Inspec::Log.debug(
-              "Received 200 from #{url}#{automate_endpoint} " \
-              "but did not receive the Chef Manage page - " \
-              "assuming target is not a #{AUTOMATE_PRODUCT_NAME} instance"
-            )
-            false
-          end
-        else
-          Inspec::Log.debug(
-            "Received unexpected status code #{response.code} " \
-            "from #{url}#{automate_endpoint} - " \
-            "assuming target is not a #{AUTOMATE_PRODUCT_NAME} instance"
-          )
-          false
-        end
-      end
-
-      def self.target_is_compliance_server?(url, insecure)
-        # All versions of Chef Compliance return 200 for `/api/version`
-        compliance_endpoint = "/api/version"
-
-        response = InspecPlugins::Compliance::HTTP.get(url + compliance_endpoint, nil, insecure)
-        return false unless response.code == "200"
-
-        Inspec::Log.debug(
-          "Received 200 from #{url}#{compliance_endpoint} - " \
-          "assuming target is a #{AUTOMATE_PRODUCT_NAME} server"
-        )
-        true
+      def self.is_automate2_server?(config)
+        config["server_type"] == "automate2"
       end
     end
   end

data/lib/plugins/inspec-compliance/lib/inspec-compliance/api/login.rb

@@ -11,20 +11,10 @@ module InspecPlugins
         def login(options)
           raise ArgumentError, "Please specify a server using `#{EXEC_NAME} automate login https://SERVER` or `#{EXEC_NAME} compliance login https://SERVER`" unless options["server"]
 
+          options["server_type"] = "automate2"
           options["server"] = URI("https://#{options["server"]}").to_s if URI(options["server"]).scheme.nil?
 
-          options["server_type"] = InspecPlugins::Compliance::API.determine_server_type(options["server"], options["insecure"])
-
-          case options["server_type"]
-          when :automate2
-            Login::Automate2Server.login(options)
-          when :automate
-            Login::AutomateServer.login(options)
-          when :compliance
-            Login::ComplianceServer.login(options)
-          else
-            raise CannotDetermineServerType, "Unable to determine if #{options["server"]} is a #{AUTOMATE_PRODUCT_NAME} or #{COMPLIANCE_PRODUCT_NAME} server"
-          end
+          Login::Automate2Server.login(options)
         end
 
         module Automate2Server
@@ -48,7 +38,7 @@ module InspecPlugins
             config["user"] = options["user"]
             config["owner"] = options["user"]
             config["insecure"] = options["insecure"] || false
-            config["server_type"] = options["server_type"].to_s
+            config["server_type"] = options["server_type"]
             config["token"] = token
             config["version"] = "0"
 
@@ -69,133 +59,6 @@ module InspecPlugins
           end
         end
 
-        module AutomateServer
-          def self.login(options)
-            verify_thor_options(options)
-
-            options["url"] = options["server"] + "/compliance"
-            token = options["dctoken"] || options["token"]
-            success, msg = API::Login.authenticate_login(options)
-            success ? store_access_token(options, token) : msg
-          end
-
-          def self.store_access_token(options, token)
-            token_type = if options["token"]
-                           "usertoken"
-                         else
-                           "dctoken"
-                         end
-
-            config = InspecPlugins::Compliance::Configuration.new
-
-            config.clean
-
-            config["automate"] = {}
-            config["automate"]["ent"] = options["ent"]
-            config["automate"]["token_type"] = token_type
-            config["server"] = options["url"]
-            config["user"] = options["user"]
-            config["insecure"] = options["insecure"] || false
-            config["server_type"] = options["server_type"].to_s
-            config["token"] = token
-            config["version"] = InspecPlugins::Compliance::API.version(config)
-
-            config.store
-            API::Login.configuration_stored_message(config)
-          end
-
-          # Automate login requires `--ent`, `--user`, and either `--token` or `--dctoken`
-          def self.verify_thor_options(o)
-            error_msg = []
-
-            error_msg.push("Please specify a user using `--user='USER'`") if o["user"].nil?
-            error_msg.push("Please specify an enterprise using `--ent='automate'`") if o["ent"].nil?
-
-            if o["token"].nil? && o["dctoken"].nil?
-              error_msg.push("Please specify a token using `--token='AUTOMATE_TOKEN'` or `--dctoken='DATA_COLLECTOR_TOKEN'`")
-            end
-
-            raise ArgumentError, error_msg.join("\n") unless error_msg.empty?
-          end
-        end
-
-        module ComplianceServer
-          include Inspec::Dist
-
-          def self.login(options)
-            compliance_verify_thor_options(options)
-
-            options["url"] = options["server"] + "/api"
-
-            if options["user"] && options["token"]
-              success, msg = API::Login.authenticate_login(options)
-              success ? compliance_store_access_token(options, options["token"]) : msg
-            elsif options["user"] && options["password"]
-              compliance_login_user_pass(options)
-            elsif options["refresh_token"]
-              compliance_login_refresh_token(options)
-            end
-          end
-
-          def self.compliance_login_user_pass(options)
-            success, msg, token = InspecPlugins::Compliance::API.get_token_via_password(
-              options["url"],
-              options["user"],
-              options["password"],
-              options["insecure"]
-            )
-
-            raise msg unless success
-
-            compliance_store_access_token(options, token)
-          end
-
-          def self.compliance_login_refresh_token(options)
-            success, msg, token = InspecPlugins::Compliance::API.get_token_via_refresh_token(
-              options["url"],
-              options["refresh_token"],
-              options["insecure"]
-            )
-
-            raise msg unless success
-
-            compliance_store_access_token(options, token)
-          end
-
-          def self.compliance_store_access_token(options, token)
-            config = InspecPlugins::Compliance::Configuration.new
-            config.clean
-
-            config["user"] = options["user"] if options["user"]
-            config["server"] = options["url"]
-            config["insecure"] = options["insecure"] || false
-            config["server_type"] = options["server_type"].to_s
-            config["token"] = token
-            config["version"] = InspecPlugins::Compliance::API.version(config)
-
-            config.store
-            API::Login.configuration_stored_message(config)
-          end
-
-          # Compliance login requires `--user` or `--refresh_token`
-          # If `--user` then either `--password`, `--token`, or `--refresh-token`, is required
-          def self.compliance_verify_thor_options(o)
-            error_msg = []
-
-            error_msg.push("Please specify a server using `#{EXEC_NAME} automate login https://SERVER` or `#{EXEC_NAME} compliance login https://SERVER`") if o["server"].nil?
-
-            if o["user"].nil? && o["refresh_token"].nil?
-              error_msg.push("Please specify a `--user='USER'` or a `--refresh-token='TOKEN'`")
-            end
-
-            if o["user"] && o["password"].nil? && o["token"].nil? && o["refresh_token"].nil?
-              error_msg.push("Please specify either a `--password`, `--token`, or `--refresh-token`")
-            end
-
-            raise ArgumentError, error_msg.join("\n") unless error_msg.empty?
-          end
-        end
-
         def self.authenticate_login(options)
           InspecPlugins::Compliance::API.authenticate_login_using_version_api(
             options["url"],

data/lib/plugins/inspec-compliance/lib/inspec-compliance/target.rb

@@ -32,16 +32,8 @@ module InspecPlugins
 
       def self.check_compliance_token(uri, config)
         if config["token"].nil? && config["refresh_token"].nil?
-          if config["server_type"] == "automate"
-            server = "automate"
-            msg = "#{EXEC_NAME} [automate|compliance] login https://your_automate_server --user USER --ent ENT --dctoken DCTOKEN or --token USERTOKEN"
-          elsif config["server_type"] == "automate2"
-            server = "automate2"
-            msg = "#{EXEC_NAME} [automate|compliance] login https://your_automate2_server --user USER --token APITOKEN"
-          else
-            server = "compliance"
-            msg = "#{EXEC_NAME} [automate|compliance] login https://your_compliance_server --user admin --insecure --token 'PASTE TOKEN HERE' "
-          end
+          server = "automate2"
+          msg = "#{EXEC_NAME} [automate|compliance] login https://your_automate2_server --user USER --token APITOKEN"
           raise Inspec::FetcherFailure, <<~EOF
 
             Cannot fetch #{uri} because your #{server} token has not been
@@ -119,19 +111,9 @@ module InspecPlugins
 
       # determine the owner_id and the profile name from the url
       def compliance_profile_name
-        m = if InspecPlugins::Compliance::API.is_automate_server_pre_080?(@config)
-              %r{^#{@config['server']}/(?<owner>[^/]+)/(?<id>[^/]+)/tar$}
-            elsif InspecPlugins::Compliance::API.is_automate_server_080_and_later?(@config)
-              %r{^#{@config['server']}/profiles/(?<owner>[^/]+)/(?<id>[^/]+)/tar$}
-            else
-              %r{^#{@config['server']}/owners/(?<owner>[^/]+)/compliance/(?<id>[^/]+)/tar$}
-            end.match(@target)
-
-        if InspecPlugins::Compliance::API.is_automate2_server?(@config)
-          m = {}
-          m[:owner] = @config["profile"][0]
-          m[:id] = @config["profile"][1]
-        end
+        m = {}
+        m[:owner] = @config["profile"][0]
+        m[:id] = @config["profile"][1]
 
         if m.nil?
           raise "Unable to determine compliance profile name. This can be caused by " \

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

@@ -17,7 +17,8 @@ module InspecPlugins
       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 :activator, type: :array, default: ["cli_command:my_command"], desc: "A list of plugin activators, in the form type1:name1, type2:name2, etc"
+      option :hook, type: :array, desc: "Legacy name for --activator - Deprecated."
       # 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."
@@ -29,6 +30,12 @@ module InspecPlugins
         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,
@@ -41,7 +48,7 @@ module InspecPlugins
           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["hooks"].keys),
+          skip_files: make_skip_list(template_vars["activators"].keys),
         }
 
         renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)
@@ -71,12 +78,15 @@ module InspecPlugins
         {
           "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", "reporter.rb") => File.join("lib", plugin_name, "reporter.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"),
+          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
 
@@ -93,7 +103,7 @@ module InspecPlugins
           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]))
+        vars.merge(parse_activator_option(options[:activator]))
       end
 
       def vars_from_defaults
@@ -121,7 +131,7 @@ module InspecPlugins
             ],
           },
           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
+          # TODO: Handle activators, when we ever have more than one type of plugin
         }
 
         prompt_for_options(order)
@@ -153,26 +163,26 @@ module InspecPlugins
         end
       end
 
-      def parse_hook_option(raw_option)
-        hooks_by_type = {}
+      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 hooks_by_type.key?(type)
-            ui.error "The InSpec plugin generator can currently only generate one hook of each type"
+          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
-          hooks_by_type[type] = name
+          activators_by_type[type] = name
         end
 
-        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("-", "_")
-        elsif hooks_by_type.key?(:reporter)
-          vars[:reporter_name_dashes] = hooks_by_type[:reporter].tr("_", "-")
-          vars[:reporter_name_snake] = hooks_by_type[:reporter].tr("-", "_")
+        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
@@ -210,7 +220,7 @@ module InspecPlugins
         end
       end
 
-      def make_skip_list(requested_hooks)
+      def make_skip_list(requested_activators)
         skips = []
         case options[:detail]
         when "full" # rubocop: disable Lint/EmptyWhen
@@ -230,13 +240,13 @@ module InspecPlugins
             "Rakefile",
             File.join("test", "fixtures", "README.md"),
             File.join("test", "fixtures"),
-            File.join("test", "functional", "inspec_plugin_template_test.rb"),
+            File.join("test", "functional", "inspec_plugin_template_test.erb"),
             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", "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.rb"),
+            File.join("test", "helper.erb"),
             File.join("test"),
           ]
         else
@@ -244,17 +254,17 @@ module InspecPlugins
           ui.exit(:usage_error)
         end
 
-        # Remove hook-specific files
-        unless requested_hooks.include?(:cli_command)
+        # Remove activator-specific files
+        unless requested_activators.include?(:cli_command)
           skips += [
-            File.join("lib", "inspec-plugin-template", "cli_command.rb"),
-            File.join("test", "unit", "cli_args_test.rb"),
-            File.join("test", "functional", "inspec_plugin_template_test.rb"),
+            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_hooks.include?(:reporter)
+        unless requested_activators.include?(:reporter)
           skips += [
-            File.join("lib", "inspec-plugin-template", "reporter.rb"),
+            File.join("lib", "inspec-plugin-template", "reporter.erb"),
           ]
         end
 

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

@@ -65,6 +65,7 @@ module InspecPlugins
             # read & render content
             content = render(File.read(source_file), template_values)
             # write file content
+
             File.write(full_destination_item_path, content)
           else
             ui.warning "Ignoring #{ui.emphasis(source_file)}, because its not an file or directoy"

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

@@ -1,11 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 group :development do
-  gem 'bundler'
-  gem 'byebug'
-  gem 'minitest'
-  gem 'rake'
-  gem 'rubocop', '= 0.49.1' # Need to keep in sync with main InSpec project, so config files will work
+  gem "bundler"
+  gem "byebug"
+  gem "minitest"
+  gem "rake"
+  gem "rubocop", "= 0.49.1" # Need to keep in sync with main InSpec project, so config files will work
 end

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

@@ -7,13 +7,13 @@
 
 # This task template will make a task named 'test', and run
 # the tests that it finds.
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs.push 'lib'
+  t.libs.push "lib"
   t.test_files = FileList[
-    'test/unit/*_test.rb',
-    'test/functional/*_test.rb',
+    "test/unit/*_test.rb",
+    "test/functional/*_test.rb",
   ]
   t.verbose = true
   # Ideally, we'd run tests with warnings enabled,
@@ -26,15 +26,15 @@ end
 #------------------------------------------------------------------#
 #                    Code Style Tasks
 #------------------------------------------------------------------#
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new(:lint) do |t|
   # Choices of RuboCop rules to enforce are deeply personal.
   # Here, we set things up so that your plugin will use the Bundler-installed
   # inspec gem's copy of the InSpec project's rubocop.yml file (which
   # is indeed packaged with the inspec gem).
-  require 'inspec/globals'
-  inspec_rubocop_yml = File.join(Inspec.src_root, '.rubocop.yml')
+  require "inspec/globals"
+  inspec_rubocop_yml = File.join(Inspec.src_root, ".rubocop.yml")
 
-  t.options = ['--display-cop-names', '--config', inspec_rubocop_yml]
+  t.options = ["--display-cop-names", "--config", inspec_rubocop_yml]
 end

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

@@ -4,23 +4,23 @@
 
 # It is traditional in a gemspec to dynamically load the current version
 # from a file in the source tree.  The next three lines make that happen.
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require '<%= plugin_name %>/version'
+require "<%= plugin_name %>/version"
 
 Gem::Specification.new do |spec|
   # Importantly, all InSpec plugins must be prefixed with `inspec-` (most
   # plugins) or `train-` (plugins which add new connectivity features).
-  spec.name          = '<%= plugin_name %>'
+  spec.name          = "<%= plugin_name %>"
 
   # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
   spec.version       = InspecPlugins::<%= module_name %>::VERSION
-  spec.authors       = ['<%= author_name %>']
-  spec.email         = ['<%= author_email %>']
-  spec.summary       = '<%= summary %>'
-  spec.description   = '<%= description %>'
-  spec.homepage      = '<%= homepage %>'
-  spec.license       = '<%= license_name %>'
+  spec.authors       = ["<%= author_name %>"]
+  spec.email         = ["<%= author_email %>"]
+  spec.summary       = "<%= summary %>"
+  spec.description   = "<%= description.is_a?(Array) ? description.join(" "): description %>"
+  spec.homepage      = "<%= homepage %>"
+  spec.license       = "<%= license_name %>"
 
   # Though complicated-looking, this is pretty standard for a gemspec.
   # It just filters what will actually be packaged in the gem (leaving
@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.files = %w{
     README.md <%= snake_case %>.gemspec Gemfile
   } + Dir.glob(
-    'lib/**/*', File::FNM_DOTMATCH
+    "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   # If you rely on any other gems, list them here with any constraints.
   # This is how `inspec plugin install` is able to manage your dependencies.
@@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
 
   # All plugins should mention inspec, > 2.2.78
   # 2.2.78 included the v2 Plugin API
-  spec.add_dependency 'inspec', '>=2.2.78', '<4.0.0'
+  spec.add_dependency "inspec", ">= 2.2.78", "< 4.0.0"
 end

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/{inspec-plugin-template.rb → inspec-plugin-template.erb}

@@ -11,4 +11,4 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require '<%= plugin_name %>/plugin'
+require "<%= plugin_name %>/plugin"

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/{cli_command.rb → cli_command.erb}

@@ -1,4 +1,4 @@
-require 'inspec/resource'
+require "inspec/resource"
 
 module InspecPlugins::<%= module_name %>
   # This class will provide the actual CLI implementation.
@@ -21,31 +21,31 @@ module InspecPlugins::<%= module_name %>
     # Note: if you want your command (or subcommand) to have dashes in it,
     # use underscores where you want a dash, and Thor will convert them.
     # Thor will fail to find a command that is directly named with dashes.
-    subcommand_desc '<%= command_name_snake %> [COMMAND]', 'Your Usage Message Here'
+    subcommand_desc "<%= command_name_snake %> [COMMAND]", "Your Usage Message Here"
 
     # The usual rhythm for a Thor CLI file is description, options, command method.
     # Thor just has you call DSL methods in sequence prior to each command.
 
     # Let's make a command, 'do_something'. This will then be available
-    # as `inspec <%= command_name_dashes %> do-something
+    # as `inspec <%= command_name_dashes %> do-something`
     # (Change this method name to be something sensible for your plugin.)
 
     # First, provide a usage / description. This will appear
     # in `inspec help <%= command_name_dashes %>`.
     # As this is a usage message, you should write the command as it should appear
     # to the user (if you want it to have dashes, use dashes)
-    desc 'do-something WHAT [OPTIONS]', 'Does something'
+    desc "do-something WHAT [OPTIONS]", "Does something"
 
     # Let's include an option, -s, to summarize
     # Refer to the Thors docs; there is a lot you can do here.
-    option :summary, desc: 'Include a total at the bottom', \
+    option :summary, desc: "Include a total at the bottom", \
                      type: :boolean, default: true, aliases: [:s]
 
-    # OK, now the actual method itself.  If you provide params, you're telling Thor that
+    # OK, now the actual method itself. If you provide params, you're telling Thor that
     # you accept CLI arguments after all options have been consumed.
     # Note again that the method name has an underscore, but when invoked
     # on the CLI, use a dash.
-    def do_something(what = 'nothing')
+    def do_something(what = "nothing")
       # The code here will *only* be executed if someone actually
       # runs `inspec <%= command_name_dashes %> do-something`.
 
@@ -55,7 +55,7 @@ module InspecPlugins::<%= module_name %>
       # Talk to the user using the `ui` object (see Inspec::UI)
       # ui.error('Whoops!')
 
-      ui.warning('This is a generated plugin with a default implementation.  Edit lib/<%= plugin_name %>/cli_command.rb to make it do what you want.')
+      ui.warning("This is a generated plugin with a default implementation.  Edit lib/<%= plugin_name %>/cli_command.rb to make it do what you want.")
       ui.exit(:success) # or :usage_error
     end
   end

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/{plugin.rb → plugin.erb}

@@ -1,49 +1,49 @@
 # 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.
+# are included in this plugin, and provide activator that will load them as needed.
 
 # It is important that this file load successfully and *quickly*.
 # Your plugin's functionality may never be used on this InSpec run; so we keep things
 # fast and light by only loading heavy things when they are needed.
 
 # Presumably this is light
-require '<%= plugin_name %>/version'
+require "<%= plugin_name %>/version"
 
 # The InspecPlugins namespace is where all plugins should declare themselves.
-# The 'Inspec' capitalization is used throughout the InSpec source code; yes, it's
+# The "Inspec" capitalization is used throughout the InSpec source code; yes, it's
 # strange.
 module InspecPlugins
-  # Pick a reasonable namespace here for your plugin.  A reasonable choice
+  # Pick a reasonable namespace here for your plugin. A reasonable choice
   # would be the CamelCase version of your plugin gem name.
   # <%= plugin_name %> => <%= module_name %>
   module <%= module_name %>
     # This simple class handles the plugin definition, so calling it simply Plugin is OK.
     #   Inspec.plugin returns various Classes, intended to be superclasses for various
     # plugin components. Here, the one-arg form gives you the Plugin Definition superclass,
-    # which mainly gives you access to the hook / plugin_type DSL.
+    # which mainly gives you access to the activator / plugin_type DSL.
     #   The number '2' says you are asking for version 2 of the plugin API. If there are
     # future versions, InSpec promises plugin API v2 will work for at least two more InSpec
     # major versions.
     class Plugin < ::Inspec.plugin(2)
       # Internal machine name of the plugin. InSpec will use this in errors, etc.
-      plugin_name :'<%= plugin_name %>'
+      plugin_name :"<%= plugin_name %>"
 
-      <% if hooks[:cli_command] %>
+      <% if activators[:cli_command] %>
       # Define a new CLI subcommand.
       # The argument here will be used to match against the command line args,
-      # and if the user said `inspec list-resources`, this hook will get called.
-      # Notice that you can define multiple hooks with different names, and they
+      # and if the user said `inspec list-resources`, this activator will get called.
+      # Notice that you can define multiple activators with different names, and they
       # don't have to match the plugin name.
 
       # We'd like this to be list-resources, but Thor does not support hyphens
       # see https://github.com/erikhuda/thor/pull/613
       cli_command :<%= command_name_snake %> do
-        # Calling this hook doesn't mean the subcommand is being executed - just
+        # Calling this activator doesn't mean the subcommand is being executed - just
         # that we should be ready to do so. So, load the file that defines the
         # functionality.
-        # For example, InSpec will activate this hook when `inspec help` is
+        # For example, InSpec will activate this activator when `inspec help` is
         # executed, so that this plugin's usage message will be included in the help.
-        require '<%= plugin_name %>/cli_command'
+        require "<%= plugin_name %>/cli_command"
 
         # Having loaded our functionality, return a class that will let the
         # CLI engine tap into it.
@@ -51,15 +51,15 @@ module InspecPlugins
       end
       <% end %>
 
-      <% if hooks[:reporter] %>
+      <% if activators[:reporter] %>
       # Define a new Reporter.
       # The argument here will be used to match against the CLI --reporter option.
       # `--reporter <%= reporter_name_snake %>` will load your reporter and call its renderer.
       reporter :<%= reporter_name_snake %> do
-        # Calling this hook doesn't mean the reporter is being executed - just
+        # Calling this activator doesn't mean the reporter is being executed - just
         # that we should be ready to do so. So, load the file that defines the
         # functionality.
-        require '<%= plugin_name %>/reporter'
+        require "<%= plugin_name %>/reporter"
 
         # Having loaded our functionality, return a class that will let the
         # reporting engine tap into it.

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/{version.rb → version.erb}

@@ -3,6 +3,6 @@
 # to learn the current version.
 module InspecPlugins
   module <%= module_name %>
-    VERSION = '0.1.0'.freeze
+    VERSION = "0.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-core
 version: !ruby/object:Gem::Version
-  version: 4.37.20
+  version: 4.37.23
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
@@ -712,11 +712,11 @@ files:
 - lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/README.md
 - lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/Rakefile
 - lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/inspec-plugin-template.gemspec
-- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template.rb
-- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/cli_command.rb
-- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/plugin.rb
-- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/reporter.rb
-- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/version.rb
+- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template.erb
+- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/cli_command.erb
+- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/plugin.erb
+- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/reporter.erb
+- lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/lib/inspec-plugin-template/version.erb
 - lib/plugins/inspec-init/templates/profiles/aws/README.md
 - lib/plugins/inspec-init/templates/profiles/aws/controls/example.rb
 - lib/plugins/inspec-init/templates/profiles/aws/inputs.yml