inspec 4.3.2 → 4.6.3

data/lib/bundles/inspec-supermarket.rb

@@ -1,13 +1,9 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 module Supermarket
-  autoload :API, 'inspec-supermarket/api'
+  autoload :API, "inspec-supermarket/api"
 end
 
-require 'inspec-supermarket/cli'
-require 'inspec-supermarket/target'
+require "inspec-supermarket/cli"
+require "inspec-supermarket/target"

data/lib/bundles/inspec-supermarket/api.rb

@@ -1,26 +1,23 @@
-# encoding: utf-8
 # frozen_string_literal: true
-# author: Christoph Hartmann
-# author: Dominik Richter
 
-require 'net/http'
-require 'addressable/uri'
+require "net/http"
+require "addressable/uri"
 
 module Supermarket
   class API
-    SUPERMARKET_URL = 'https://supermarket.chef.io'
+    SUPERMARKET_URL = "https://supermarket.chef.io"
 
     # displays a list of profiles
     def self.profiles(supermarket_url = SUPERMARKET_URL)
       url = "#{supermarket_url}/api/v1/tools-search"
-      _success, data = get(url, { type: 'compliance_profile', items: 100 })
+      _success, data = get(url, { type: "compliance_profile", items: 100 })
       if !data.nil?
         profiles = JSON.parse(data)
-        profiles['items'].map { |x|
-          m = %r{^#{supermarket_url}/api/v1/tools/(?<slug>[\w-]+)(/)?$}.match(x['tool'])
-          x['slug'] = m[:slug]
+        profiles["items"].map do |x|
+          m = %r{^#{supermarket_url}/api/v1/tools/(?<slug>[\w-]+)(/)?$}.match(x["tool"])
+          x["slug"] = m[:slug]
           x
-        }
+        end
       else
         []
       end
@@ -54,7 +51,7 @@ module Supermarket
 
       # Tool name in Supermarket URL is downcased so we need to downcase
       tool = "#{supermarket_url}/api/v1/tools/#{tool_name.downcase}"
-      supermarket_tool['tool_owner'] == tool_owner && supermarket_tool['tool'] == tool
+      supermarket_tool["tool_owner"] == tool_owner && supermarket_tool["tool"] == tool
     end
 
     def self.find(profile, supermarket_url = SUPERMARKET_URL)
@@ -80,7 +77,7 @@ module Supermarket
 
     def self.send_request(uri, req)
       # send request
-      res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
         http.request(req)
       end
       [res.is_a?(Net::HTTPSuccess), res.body]

data/lib/bundles/inspec-supermarket/cli.rb

@@ -1,11 +1,8 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-require 'inspec/base_cli'
+require "inspec/base_cli"
 
 module Supermarket
   class SupermarketCLI < Inspec::BaseCLI
-    namespace 'supermarket'
+    namespace "supermarket"
 
     # TODO: find another solution, once https://github.com/erikhuda/thor/issues/261 is fixed
     def self.banner(command, _namespace = nil, _subcommand = false)
@@ -16,18 +13,18 @@ module Supermarket
       namespace
     end
 
-    desc 'profiles', 'list all available profiles in Chef Supermarket'
+    desc "profiles", "list all available profiles in Chef Supermarket"
     def profiles
       # display profiles in format user/profile
       supermarket_profiles = Supermarket::API.profiles
 
-      headline('Available profiles:')
-      supermarket_profiles.each { |p|
+      headline("Available profiles:")
+      supermarket_profiles.each do |p|
         li("#{p['tool_name']} #{mark_text(p['tool_owner'] + '/' + p['slug'])}")
-      }
+      end
     end
 
-    desc 'exec PROFILE', 'execute a Supermarket profile'
+    desc "exec PROFILE", "execute a Supermarket profile"
     exec_options
     def exec(*tests)
       o = config
@@ -35,7 +32,7 @@ module Supermarket
       configure_logger(o)
 
       # iterate over tests and add compliance scheme
-      tests = tests.map { |t| 'supermarket://' + t }
+      tests = tests.map { |t| "supermarket://" + t }
 
       runner = Inspec::Runner.new(o)
       tests.each { |target| runner.add_target(target) }
@@ -46,13 +43,13 @@ module Supermarket
       exit 1
     end
 
-    desc 'info PROFILE', 'display Supermarket profile details'
+    desc "info PROFILE", "display Supermarket profile details"
     def info(profile)
       # check that the profile is available
       supermarket_profiles = Supermarket::API.profiles
-      found = supermarket_profiles.select { |p|
+      found = supermarket_profiles.select do |p|
         profile == "#{p['tool_owner']}/#{p['slug']}"
-      }
+      end
 
       if found.empty?
         puts "#{mark_text(profile)} is not available on Supermarket"
@@ -70,5 +67,5 @@ module Supermarket
   end
 
   # register the subcommand to InSpec CLI registry
-  Inspec::Plugins::CLI.add_subcommand(SupermarketCLI, 'supermarket', 'supermarket SUBCOMMAND ...', 'Supermarket commands', {})
+  Inspec::Plugins::CLI.add_subcommand(SupermarketCLI, "supermarket", "supermarket SUBCOMMAND ...", "Supermarket commands", {})
 end

data/lib/bundles/inspec-supermarket/target.rb

@@ -1,19 +1,15 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'uri'
-require 'inspec/fetcher'
-require 'fetchers/url'
+require "uri"
+require "inspec/fetcher"
+require "fetchers/url"
 
 # InSpec Target Helper for Supermarket
 module Supermarket
   class Fetcher < Inspec.fetcher(1)
-    name 'supermarket'
+    name "supermarket"
     priority 500
 
     def self.resolve(target, opts = {})
-      supermarket_uri, supermarket_server = if target.is_a?(String) && URI(target).scheme == 'supermarket'
+      supermarket_uri, supermarket_server = if target.is_a?(String) && URI(target).scheme == "supermarket"
                                               [target, Supermarket::API::SUPERMARKET_URL]
                                             elsif target.respond_to?(:key?) && target.key?(:supermarket)
                                               supermarket_server = target[:supermarket_url] || Supermarket::API::SUPERMARKET_URL
@@ -22,13 +18,13 @@ module Supermarket
       return nil unless supermarket_uri
       return nil unless Supermarket::API.exist?(supermarket_uri, supermarket_server)
       tool_info = Supermarket::API.find(supermarket_uri, supermarket_server)
-      resolve_next(tool_info['tool_source_url'], opts)
+      resolve_next(tool_info["tool_source_url"], opts)
     rescue URI::Error
       nil
     end
 
     def to_s
-      'Chef Compliance Profile Loader'
+      "Chef Compliance Profile Loader"
     end
   end
 end

data/lib/fetchers/git.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
-require 'tmpdir'
-require 'fileutils'
-require 'mixlib/shellout'
-require 'inspec/log'
+require "tmpdir"
+require "fileutils"
+require "mixlib/shellout"
+require "inspec/log"
 
 module Fetchers
   #
@@ -25,12 +24,12 @@ module Fetchers
   # omnibus source for hints.
   #
   class Git < Inspec.fetcher(1)
-    name 'git'
+    name "git"
     priority 200
 
     def self.resolve(target, opts = {})
       if target.is_a?(String)
-        new(target, opts) if target.start_with?('git@') || target.end_with?('.git')
+        new(target, opts) if target.start_with?("git@") || target.end_with?(".git")
       elsif target.respond_to?(:has_key?) && target.key?(:git)
         new(target[:git], opts.merge(target))
       end
@@ -54,7 +53,7 @@ module Fetchers
         Dir.mktmpdir do |tmpdir|
           checkout(tmpdir)
           Inspec::Log.debug("Checkout of #{resolved_ref} successful. Moving checkout to #{dir}")
-          FileUtils.cp_r(tmpdir + '/.', @repo_directory)
+          FileUtils.cp_r(tmpdir + "/.", @repo_directory)
         end
       end
       @repo_directory
@@ -82,7 +81,7 @@ module Fetchers
                         elsif @tag
                           resolve_ref(@tag)
                         else
-                          resolve_ref('master')
+                          resolve_ref("master")
                         end
     end
 
@@ -130,7 +129,7 @@ module Fetchers
     end
 
     def cloned?
-      File.directory?(File.join(@repo_directory, '.git'))
+      File.directory?(File.join(@repo_directory, ".git"))
     end
 
     def clone(dir = @repo_directory)
@@ -149,7 +148,7 @@ module Fetchers
       cmd.error!
       cmd.status
     rescue Errno::ENOENT
-      raise 'To use git sources, you must have git installed.'
+      raise "To use git sources, you must have git installed."
     end
 
     def shellout(cmd, opts = {})
@@ -157,12 +156,12 @@ module Fetchers
       cmd = Mixlib::ShellOut.new(cmd, opts)
       cmd.run_command
       Inspec::Log.debug("External command: completed with exit status: #{cmd.exitstatus}")
-      Inspec::Log.debug('External command: STDOUT BEGIN')
+      Inspec::Log.debug("External command: STDOUT BEGIN")
       Inspec::Log.debug(cmd.stdout)
-      Inspec::Log.debug('External command: STDOUT END')
-      Inspec::Log.debug('External command: STDERR BEGIN')
+      Inspec::Log.debug("External command: STDOUT END")
+      Inspec::Log.debug("External command: STDERR BEGIN")
       Inspec::Log.debug(cmd.stderr)
-      Inspec::Log.debug('External command: STDERR END')
+      Inspec::Log.debug("External command: STDERR END")
       cmd
     end
   end

data/lib/fetchers/local.rb

@@ -1,12 +1,8 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'openssl'
+require "openssl"
 
 module Fetchers
   class Local < Inspec.fetcher(1)
-    name 'local'
+    name "local"
     priority 0
 
     def self.resolve(target)
@@ -31,11 +27,11 @@ module Fetchers
 
     def self.resolve_from_string(target)
       # Support "urls" in the form of file://
-      if target.start_with?('file://')
-        target = target.gsub(%r{^file://}, '')
+      if target.start_with?("file://")
+        target = target.gsub(%r{^file://}, "")
       else
         # support for windows paths
-        target = target.tr('\\', '/')
+        target = target.tr('\\', "/")
       end
 
       target if File.exist?(File.expand_path(target))
@@ -105,7 +101,7 @@ module Fetchers
     end
 
     def perform_shasum(target)
-      @archive_shasum ||= OpenSSL::Digest::SHA256.digest(File.read(target)).unpack('H*')[0]
+      @archive_shasum ||= OpenSSL::Digest::SHA256.digest(File.read(target)).unpack("H*")[0]
     end
 
     def resolved_source

data/lib/fetchers/mock.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
+require "inspec/fetcher"
 
 module Fetchers
   class Mock < Inspec.fetcher(1)
-    name 'mock'
+    name "mock"
     priority 0
 
     def self.resolve(target)
@@ -29,7 +27,7 @@ module Fetchers
     end
 
     def cache_key
-      ''
+      ""
     end
   end
 end

data/lib/fetchers/url.rb

@@ -1,22 +1,18 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'uri'
-require 'openssl'
-require 'tempfile'
-require 'open-uri'
+require "uri"
+require "openssl"
+require "tempfile"
+require "open-uri"
 
 module Fetchers
   class Url < Inspec.fetcher(1)
     MIME_TYPES = {
-      'application/x-zip-compressed' => '.zip',
-      'application/zip' => '.zip',
-      'application/x-gzip' => '.tar.gz',
-      'application/gzip' => '.tar.gz',
+      "application/x-zip-compressed" => ".zip",
+      "application/zip" => ".zip",
+      "application/x-gzip" => ".tar.gz",
+      "application/gzip" => ".tar.gz",
     }.freeze
 
-    name 'url'
+    name "url"
     priority 200
 
     def self.resolve(target, opts = {})
@@ -31,7 +27,7 @@ module Fetchers
 
     def self.resolve_from_string(target, opts, username = nil, password = nil)
       uri = URI.parse(target)
-      return nil if uri.nil? or uri.scheme.nil?
+      return nil if uri.nil? || uri.scheme.nil?
       return nil unless %{ http https }.include? uri.scheme
       target = transform(target)
       opts[:username] = username if username
@@ -66,11 +62,11 @@ module Fetchers
     # https://bitbucket.org/username/repo/commits/95ce1f83d5bbe9eec34c5973f6894617e8d6d8cc is transformed to
     # https://bitbucket.org/username/repo/get/95ce1f83d5bbe9eec34c5973f6894617e8d6d8cc.tar.gz
 
-    GITHUB_URL_REGEX = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w-]+)(\.git)?(/)?$}
-    GITHUB_URL_WITH_TREE_REGEX = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w-]+)/tree/(?<commit>[\w\.]+)(/)?$}
-    BITBUCKET_URL_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)(\.git)?(/)?$}
-    BITBUCKET_URL_BRANCH_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)/branch/(?<branch>[\w\.]+)(/)?$}
-    BITBUCKET_URL_COMMIT_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)/commits/(?<commit>[\w\.]+)(/)?$}
+    GITHUB_URL_REGEX = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w.-]+?)(\.git)?(/)?$}.freeze
+    GITHUB_URL_WITH_TREE_REGEX = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w.-]+)/tree/(?<commit>[\w\.]+)(/)?$}.freeze
+    BITBUCKET_URL_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)(\.git)?(/)?$}.freeze
+    BITBUCKET_URL_BRANCH_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)/branch/(?<branch>[\w\.]+)(/)?$}.freeze
+    BITBUCKET_URL_COMMIT_REGEX = %r{^https?://(www\.)?bitbucket\.org/(?<user>[\w-]+)/(?<repo>[\w-]+)/commits/(?<commit>[\w\.]+)(/)?$}.freeze
 
     def self.transform(target)
       transformed_target = if m = GITHUB_URL_REGEX.match(target) # rubocop:disable Lint/AssignmentInCondition
@@ -98,8 +94,8 @@ module Fetchers
     def initialize(url, opts)
       @target = url.to_s
       @target_uri = url.is_a?(URI) ? url : parse_uri(url)
-      @insecure = opts['insecure']
-      @token = opts['token']
+      @insecure = opts["insecure"]
+      @token = opts["token"]
       @config = opts
       @archive_path = nil
       @temp_archive_path = nil
@@ -130,23 +126,23 @@ module Fetchers
 
     def sha256
       file = @archive_path || temp_archive_path
-      OpenSSL::Digest::SHA256.digest(File.read(file)).unpack('H*')[0]
+      OpenSSL::Digest::SHA256.digest(File.read(file)).unpack("H*")[0]
     end
 
     def file_type_from_remote(remote)
-      content_type = remote.meta['content-type']
+      content_type = remote.meta["content-type"]
       file_type = MIME_TYPES[content_type]
 
       if file_type.nil?
         Inspec::Log.warn("Unrecognized content type: #{content_type}. Assuming tar.gz")
-        file_type = '.tar.gz'
+        file_type = ".tar.gz"
       end
 
       file_type
     end
 
     def temp_archive_path
-      @temp_archive_path ||= if @config['server_type'] == 'automate2'
+      @temp_archive_path ||= if @config["server_type"] == "automate2"
                                download_automate2_archive_to_temp
                              else
                                download_archive_to_temp
@@ -158,13 +154,13 @@ module Fetchers
 
       Inspec::Log.debug("Fetching URL: #{@target}")
       json = {
-        owner: @config['profile'][0],
-        name: @config['profile'][1],
-        version: @config['profile'][2],
+        owner: @config["profile"][0],
+        name: @config["profile"][1],
+        version: @config["profile"][2],
       }.to_json
 
       opts = http_opts
-      opts[:use_ssl] = @target_uri.scheme == 'https'
+      opts[:use_ssl] = @target_uri.scheme == "https"
 
       if @insecure
         opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE
@@ -177,12 +173,12 @@ module Fetchers
         req.add_field(key, value)
       end
       req.body = json
-      res = Net::HTTP.start(@target_uri.host, @target_uri.port, opts) { |http|
+      res = Net::HTTP.start(@target_uri.host, @target_uri.port, opts) do |http|
         http.request(req)
-      }
+      end
 
-      @archive_type = '.tar.gz'
-      archive = Tempfile.new(['inspec-dl-', @archive_type])
+      @archive_type = ".tar.gz"
+      archive = Tempfile.new(["inspec-dl-", @archive_type])
       archive.binmode
       archive.write(res.body)
       archive.rewind
@@ -197,7 +193,7 @@ module Fetchers
       Inspec::Log.debug("Fetching URL: #{@target}")
       remote = open_via_uri(@target)
       @archive_type = file_type_from_remote(remote) # side effect :(
-      archive = Tempfile.new(['inspec-dl-', @archive_type])
+      archive = Tempfile.new(["inspec-dl-", @archive_type])
       archive.binmode
       archive.write(remote.read)
       archive.rewind
@@ -211,7 +207,7 @@ module Fetchers
 
       if opts[:http_basic_authentication]
         # OpenURI does not support userinfo so we need to remove it
-        open(target.sub("#{@target_uri.userinfo}@", ''), opts)
+        open(target.sub("#{@target_uri.userinfo}@", ""), opts)
       else
         open(target, opts)
       end
@@ -231,16 +227,16 @@ module Fetchers
       opts = {}
       opts[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE if @insecure
 
-      if @config['server_type'] =~ /automate/
-        opts['chef-delivery-enterprise'] = @config['automate']['ent']
-        if @config['automate']['token_type'] == 'dctoken'
-          opts['x-data-collector-token'] = @config['token']
+      if @config["server_type"] =~ /automate/
+        opts["chef-delivery-enterprise"] = @config["automate"]["ent"]
+        if @config["automate"]["token_type"] == "dctoken"
+          opts["x-data-collector-token"] = @config["token"]
         else
-          opts['chef-delivery-user'] = @config['user']
-          opts['chef-delivery-token'] = @config['token']
+          opts["chef-delivery-user"] = @config["user"]
+          opts["chef-delivery-token"] = @config["token"]
         end
       elsif @token
-        opts['Authorization'] = "Bearer #{@token}"
+        opts["Authorization"] = "Bearer #{@token}"
       end
 
       username = @config[:username] || @target_uri.user
@@ -264,8 +260,10 @@ module Fetchers
           true
         end
       end
-      raise 'Unable to fetch profile - the following HTTP headers have no value: ' \
-        "#{keys_missing_values.join(', ')}" unless keys_missing_values.empty?
+      unless keys_missing_values.empty?
+        raise "Unable to fetch profile - the following HTTP headers have no value: " \
+          "#{keys_missing_values.join(', ')}"
+      end
     end
   end
 end