inspec 4.3.2 → 4.6.3

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

@@ -1,19 +1,21 @@
-# encoding: utf-8
+require "inspec/dist"
 
 module InspecPlugins
   module Compliance
     class API
       module Login
+        include Inspec::Dist
+
         class CannotDetermineServerType < StandardError; end
 
         def login(options)
-          raise ArgumentError, 'Please specify a server using `inspec compliance login https://SERVER`' unless options['server']
+          raise ArgumentError, "Please specify a server using `#{EXEC_NAME} compliance login https://SERVER`" unless options["server"]
 
-          options['server'] = URI("https://#{options['server']}").to_s if URI(options['server']).scheme.nil?
+          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'])
+          options["server_type"] = InspecPlugins::Compliance::API.determine_server_type(options["server"], options["insecure"])
 
-          case options['server_type']
+          case options["server_type"]
           when :automate2
             Login::Automate2Server.login(options)
           when :automate
@@ -21,7 +23,7 @@ module InspecPlugins
           when :compliance
             Login::ComplianceServer.login(options)
           else
-            raise CannotDetermineServerType, "Unable to determine if #{options['server']} is a Chef Automate or Chef Compliance server"
+            raise CannotDetermineServerType, "Unable to determine if #{options['server']} is a #{AUTOMATE_PRODUCT_NAME} or #{COMPLIANCE_PRODUCT_NAME} server"
           end
         end
 
@@ -29,8 +31,8 @@ module InspecPlugins
           def self.login(options)
             verify_thor_options(options)
 
-            options['url'] = options['server'] + '/api/v0'
-            token = options['dctoken'] || options['token']
+            options["url"] = options["server"] + "/api/v0"
+            token = options["dctoken"] || options["token"]
             store_access_token(options, token)
           end
 
@@ -38,16 +40,16 @@ module InspecPlugins
             config = InspecPlugins::Compliance::Configuration.new
             config.clean
 
-            config['automate'] = {}
-            config['automate']['ent'] = 'automate'
-            config['automate']['token_type'] = 'dctoken'
-            config['server'] = options['url']
-            config['user'] = options['user']
-            config['owner'] = options['user']
-            config['insecure'] = options['insecure'] || false
-            config['server_type'] = options['server_type'].to_s
-            config['token'] = token
-            config['version'] = '0'
+            config["automate"] = {}
+            config["automate"]["ent"] = "automate"
+            config["automate"]["token_type"] = "dctoken"
+            config["server"] = options["url"]
+            config["user"] = options["user"]
+            config["owner"] = options["user"]
+            config["insecure"] = options["insecure"] || false
+            config["server_type"] = options["server_type"].to_s
+            config["token"] = token
+            config["version"] = "0"
 
             config.store
             config
@@ -56,10 +58,10 @@ module InspecPlugins
           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 a user using `--user='USER'`") if o["user"].nil?
 
-            if o['token'].nil? && o['dctoken'].nil?
-              error_msg.push('Please specify a token using `--token=\'APITOKEN\'`')
+            if o["token"].nil? && o["dctoken"].nil?
+              error_msg.push("Please specify a token using `--token='APITOKEN'`")
             end
 
             raise ArgumentError, error_msg.join("\n") unless error_msg.empty?
@@ -70,31 +72,31 @@ module InspecPlugins
           def self.login(options)
             verify_thor_options(options)
 
-            options['url'] = options['server'] + '/compliance'
-            token = options['dctoken'] || options['token']
+            options["url"] = options["server"] + "/compliance"
+            token = options["dctoken"] || options["token"]
             store_access_token(options, token)
           end
 
           def self.store_access_token(options, token)
-            token_type = if options['token']
-                           'usertoken'
+            token_type = if options["token"]
+                           "usertoken"
                          else
-                           'dctoken'
+                           "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["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
             config
@@ -104,11 +106,11 @@ module InspecPlugins
           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?
+            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\'`')
+            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?
@@ -116,26 +118,28 @@ module InspecPlugins
         end
 
         module ComplianceServer
+          include Inspec::Dist
+
           def self.login(options)
             compliance_verify_thor_options(options)
 
-            options['url'] = options['server'] + '/api'
+            options["url"] = options["server"] + "/api"
 
-            if options['user'] && options['token']
-              compliance_store_access_token(options, options['token'])
-            elsif options['user'] && options['password']
+            if options["user"] && options["token"]
+              compliance_store_access_token(options, options["token"])
+            elsif options["user"] && options["password"]
               compliance_login_user_pass(options)
-            elsif options['refresh_token']
+            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'],
+              options["url"],
+              options["user"],
+              options["password"],
+              options["insecure"]
             )
 
             raise msg unless success
@@ -144,9 +148,9 @@ module InspecPlugins
 
           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'],
+              options["url"],
+              options["refresh_token"],
+              options["insecure"]
             )
 
             raise msg unless success
@@ -157,12 +161,12 @@ module InspecPlugins
             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["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
             config
@@ -173,14 +177,14 @@ module InspecPlugins
           def self.compliance_verify_thor_options(o)
             error_msg = []
 
-            error_msg.push('Please specify a server using `inspec compliance login https://SERVER`') if o['server'].nil?
+            error_msg.push("Please specify a server using `#{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\'`')
+            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`')
+            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?

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

@@ -1,16 +1,18 @@
-# encoding: utf-8
+require "inspec/dist"
 
-require_relative 'api'
+require_relative "api"
 
 module InspecPlugins
   module Compliance
     class CLI < Inspec.plugin(2, :cli_command)
-      subcommand_desc 'compliance SUBCOMMAND', 'Chef Compliance commands'
+      include Inspec::Dist
+
+      subcommand_desc "compliance SUBCOMMAND", "#{COMPLIANCE_PRODUCT_NAME} commands"
 
       # desc "login https://SERVER --insecure --user='USER' --ent='ENTERPRISE' --token='TOKEN'", 'Log in to a Chef Compliance/Chef Automate SERVER'
-      desc 'login', 'Log in to a Chef Compliance/Chef Automate SERVER'
+      desc "login", "Log in to a #{COMPLIANCE_PRODUCT_NAME}/#{AUTOMATE_PRODUCT_NAME} SERVER"
       long_desc <<-LONGDESC
-        `login` allows you to use InSpec with Chef Automate or a Chef Compliance Server
+        `login` allows you to use InSpec with #{AUTOMATE_PRODUCT_NAME} or a #{COMPLIANCE_PRODUCT_NAME} Server
 
         You need to a token for communication. More information about token retrieval
         is available at:
@@ -20,54 +22,54 @@ module InspecPlugins
       option :insecure, aliases: :k, type: :boolean,
         desc: 'Explicitly allows InSpec to perform "insecure" SSL connections and transfers'
       option :user, type: :string, required: false,
-        desc: 'Username'
+        desc: "Username"
       option :password, type: :string, required: false,
-        desc: 'Password (Chef Compliance Only)'
+        desc: "Password (#{COMPLIANCE_PRODUCT_NAME} Only)"
       option :token, type: :string, required: false,
-        desc: 'Access token'
+        desc: "Access token"
       option :refresh_token, type: :string, required: false,
-        desc: 'Chef Compliance refresh token (Chef Compliance Only)'
+        desc: "#{COMPLIANCE_PRODUCT_NAME} refresh token (#{COMPLIANCE_PRODUCT_NAME} Only)"
       option :dctoken, type: :string, required: false,
-        desc: 'Data Collector token (Chef Automate Only)'
+        desc: "Data Collector token (#{AUTOMATE_PRODUCT_NAME} Only)"
       option :ent, type: :string, required: false,
-        desc: 'Enterprise for Chef Automate reporting (Chef Automate Only)'
+        desc: "Enterprise for #{AUTOMATE_PRODUCT_NAME} reporting (#{AUTOMATE_PRODUCT_NAME} Only)"
       def login(server)
-        options['server'] = server
+        options["server"] = server
         InspecPlugins::Compliance::API.login(options)
         config = InspecPlugins::Compliance::Configuration.new
         puts "Stored configuration for Chef #{config['server_type'].capitalize}: #{config['server']}' with user: '#{config['user']}'"
       end
 
-      desc 'profiles', 'list all available profiles in Chef Compliance'
+      desc "profiles", "list all available profiles in #{COMPLIANCE_PRODUCT_NAME}"
       option :owner, type: :string, required: false,
-        desc: 'owner whose profiles to list'
+        desc: "owner whose profiles to list"
       def profiles
         config = InspecPlugins::Compliance::Configuration.new
         return if !loggedin(config)
 
         # set owner to config
-        config['owner'] = options['owner'] || config['user']
+        config["owner"] = options["owner"] || config["user"]
 
         msg, profiles = InspecPlugins::Compliance::API.profiles(config)
-        profiles.sort_by! { |hsh| hsh['title'] }
+        profiles.sort_by! { |hsh| hsh["title"] }
         if !profiles.empty?
           # iterate over profiles
-          headline('Available profiles:')
-          profiles.each { |profile|
-            owner = profile['owner_id'] || profile['owner']
+          headline("Available profiles:")
+          profiles.each do |profile|
+            owner = profile["owner_id"] || profile["owner"]
             li("#{profile['title']} v#{profile['version']} (#{mark_text(owner + '/' + profile['name'])})")
-          }
+          end
         else
-          puts msg if msg != 'success'
-          puts 'Could not find any profiles'
+          puts msg if msg != "success"
+          puts "Could not find any profiles"
           exit 1
         end
       rescue InspecPlugins::Compliance::ServerConfigurationMissing
-        STDERR.puts "\nServer configuration information is missing. Please login using `inspec compliance login`"
+        $stderr.puts "\nServer configuration information is missing. Please login using `#{EXEC_NAME} compliance login`"
         exit 1
       end
 
-      desc 'exec PROFILE', 'executes a Chef Compliance profile'
+      desc "exec PROFILE", "executes a #{COMPLIANCE_PRODUCT_NAME} profile"
       exec_options
       def exec(*tests)
         config = InspecPlugins::Compliance::Configuration.new
@@ -77,7 +79,7 @@ module InspecPlugins
         configure_logger(o)
 
         # iterate over tests and add compliance scheme
-        tests = tests.map { |t| 'compliance://' + InspecPlugins::Compliance::API.sanitize_profile_name(t) }
+        tests = tests.map { |t| "compliance://" + InspecPlugins::Compliance::API.sanitize_profile_name(t) }
 
         runner = Inspec::Runner.new(o)
         tests.each { |target| runner.add_target(target) }
@@ -88,9 +90,9 @@ module InspecPlugins
         exit 1
       end
 
-      desc 'download PROFILE', 'downloads a profile from Chef Compliance'
+      desc "download PROFILE", "downloads a profile from #{COMPLIANCE_PRODUCT_NAME}"
       option :name, type: :string,
-        desc: 'Name of the archive filename (file type will be added)'
+        desc: "Name of the archive filename (file type will be added)"
       def download(profile_name)
         o = options.dup
         configure_logger(o)
@@ -105,30 +107,30 @@ module InspecPlugins
           fetcher = InspecPlugins::Compliance::Fetcher.resolve(
             {
               compliance: profile_name,
-            },
+            }
           )
 
           # we provide a name, the fetcher adds the extension
-          _owner, id = profile_name.split('/')
+          _owner, id = profile_name.split("/")
           file_name = fetcher.fetch(o.name || id)
           puts "Profile stored to #{file_name}"
         else
-          puts "Profile #{profile_name} is not available in Chef Compliance."
+          puts "Profile #{profile_name} is not available in #{COMPLIANCE_PRODUCT_NAME}."
           exit 1
         end
       end
 
-      desc 'upload PATH', 'uploads a local profile to Chef Compliance'
+      desc "upload PATH", "uploads a local profile to #{COMPLIANCE_PRODUCT_NAME}"
       option :overwrite, type: :boolean, default: false,
-        desc: 'Overwrite existing profile on Server.'
+        desc: "Overwrite existing profile on Server."
       option :owner, type: :string, required: false,
-        desc: 'Owner that should own the profile'
+        desc: "Owner that should own the profile"
       def upload(path) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, PerceivedComplexity, Metrics/CyclomaticComplexity
         config = InspecPlugins::Compliance::Configuration.new
         return if !loggedin(config)
 
         # set owner to config
-        config['owner'] = options['owner'] || config['user']
+        config["owner"] = options["owner"] || config["user"]
 
         unless File.exist?(path)
           puts "Directory #{path} does not exist."
@@ -157,14 +159,14 @@ module InspecPlugins
 
         result = profile.check
         unless result[:summary][:valid]
-          error.call('Profile check failed. Please fix the profile before upload.')
+          error.call("Profile check failed. Please fix the profile before upload.")
         else
-          puts('Profile is valid')
+          puts("Profile is valid")
         end
 
         # determine user information
-        if (config['token'].nil? && config['refresh_token'].nil?) || config['user'].nil?
-          error.call('Please login via `inspec compliance login`')
+        if (config["token"].nil? && config["refresh_token"].nil?) || config["user"].nil?
+          error.call("Please login via `#{EXEC_NAME} compliance login`")
         end
 
         # read profile name from inspec.yml
@@ -175,8 +177,8 @@ module InspecPlugins
 
         # check that the profile is not uploaded already,
         # confirm upload to the user (overwrite with --force)
-        if InspecPlugins::Compliance::API.exist?(config, "#{config['owner']}/#{profile_name}##{profile_version}") && !options['overwrite']
-          error.call('Profile exists on the server, use --overwrite')
+        if InspecPlugins::Compliance::API.exist?(config, "#{config['owner']}/#{profile_name}##{profile_version}") && !options["overwrite"]
+          error.call("Profile exists on the server, use --overwrite")
         end
 
         # abort if we found an error
@@ -189,7 +191,7 @@ module InspecPlugins
         generated = false
         if File.directory?(path)
           generated = true
-          archive_path = Dir::Tmpname.create([profile_name, '.tar.gz']) {}
+          archive_path = Dir::Tmpname.create([profile_name, ".tar.gz"]) {}
           puts "Generate temporary profile archive at #{archive_path}"
           profile.archive({ output: archive_path, ignore_errors: false, overwrite: true })
         else
@@ -200,62 +202,62 @@ module InspecPlugins
         pname = ERB::Util.url_encode(profile_name)
 
         if InspecPlugins::Compliance::API.is_automate_server?(config) || InspecPlugins::Compliance::API.is_automate2_server?(config)
-          puts 'Uploading to Chef Automate'
+          puts "Uploading to #{AUTOMATE_PRODUCT_NAME}"
         else
-          puts 'Uploading to Chef Compliance'
+          puts "Uploading to #{COMPLIANCE_PRODUCT_NAME}"
         end
-        success, msg = InspecPlugins::Compliance::API.upload(config, config['owner'], pname, archive_path)
+        success, msg = InspecPlugins::Compliance::API.upload(config, config["owner"], pname, archive_path)
 
         # delete temp file if it was temporary generated
         File.delete(archive_path) if generated && File.exist?(archive_path)
 
         if success
-          puts 'Successfully uploaded profile'
+          puts "Successfully uploaded profile"
         else
-          puts 'Error during profile upload:'
+          puts "Error during profile upload:"
           puts msg
           exit 1
         end
       end
 
-      desc 'version', 'displays the version of the Chef Compliance server'
+      desc "version", "displays the version of the #{COMPLIANCE_PRODUCT_NAME} server"
       def version
         config = InspecPlugins::Compliance::Configuration.new
         info = InspecPlugins::Compliance::API.version(config)
-        if !info.nil? && info['version']
+        if !info.nil? && info["version"]
           puts "Name:    #{info['api']}"
           puts "Version: #{info['version']}"
         else
-          puts 'Could not determine server version.'
+          puts "Could not determine server version."
           exit 1
         end
       rescue InspecPlugins::Compliance::ServerConfigurationMissing
-        puts "\nServer configuration information is missing. Please login using `inspec compliance login`"
+        puts "\nServer configuration information is missing. Please login using `#{EXEC_NAME} compliance login`"
         exit 1
       end
 
-      desc 'logout', 'user logout from Chef Compliance'
+      desc "logout", "user logout from #{COMPLIANCE_PRODUCT_NAME}"
       def logout
         config = InspecPlugins::Compliance::Configuration.new
-        unless config.supported?(:oidc) || config['token'].nil? || config['server_type'] == 'automate'
+        unless config.supported?(:oidc) || config["token"].nil? || config["server_type"] == "automate"
           config = InspecPlugins::Compliance::Configuration.new
           url = "#{config['server']}/logout"
-          InspecPlugins::Compliance::HTTP.post(url, config['token'], config['insecure'], !config.supported?(:oidc))
+          InspecPlugins::Compliance::HTTP.post(url, config["token"], config["insecure"], !config.supported?(:oidc))
         end
         success = config.destroy
 
         if success
-          puts 'Successfully logged out'
+          puts "Successfully logged out"
         else
-          puts 'Could not log out'
+          puts "Could not log out"
         end
       end
 
       private
 
       def loggedin(config)
-        serverknown = !config['server'].nil?
-        puts 'You need to login first with `inspec compliance login`' if !serverknown
+        serverknown = !config["server"].nil?
+        puts "You need to login first with `#{EXEC_NAME} compliance login`" if !serverknown
         serverknown
       end
     end