inspec 4.18.51 → 4.18.85

data/lib/inspec/dependencies/requirement.rb

@@ -1,135 +0,0 @@
-require "inspec/cached_fetcher"
-require "semverse"
-
-module Inspec
-  #
-  # Inspec::Requirement represents a given profile dependency, where
-  # appropriate we delegate to Inspec::Profile directly.
-  #
-  class Requirement
-    def self.from_metadata(dep, cache, opts)
-      raise "Cannot load empty dependency." if dep.nil? || dep.empty?
-
-      req_path = opts[:cwd]
-
-      if dep[:path]
-        req_path = File.expand_path(dep[:path], req_path)
-      end
-      config = {
-        cache: cache,
-        cwd: req_path,
-      }
-
-      new(dep[:name],
-          dep[:version],
-          config,
-          opts.merge(dep))
-    end
-
-    def self.from_lock_entry(entry, config, opts = {})
-      resolved_source = entry[:resolved_source]
-        .merge(backend: config[:backend])
-        .merge(opts)
-
-      req = new(entry[:name],
-                entry[:version_constraints],
-                config,
-                resolved_source)
-
-      locked_deps = []
-      Array(entry[:dependencies]).each do |dep_entry|
-        dep_config = config.dup
-        dep_config[:parent_profile] = entry[:name]
-        locked_deps << Inspec::Requirement.from_lock_entry(dep_entry, dep_config, opts)
-      end
-      req.lock_deps(locked_deps)
-      req
-    end
-
-    attr_reader :cwd, :opts, :version_constraints
-    def initialize(name, version_constraints, config, opts)
-      @name = name
-      @version_constraints = Array(version_constraints)
-      @cache = config[:cache]
-      @backend = opts[:backend]
-      @opts = opts
-      @cwd = config[:cwd]
-      @parent_profile = config[:parent_profile]
-    end
-
-    #
-    # A dependency can be renamed in inspec.yml/inspec.lock.  Prefer
-    # the name the user gave this dependency over the profile name.
-    #
-    def name
-      @name || profile.name
-    end
-
-    def source_version
-      profile.version
-    end
-
-    def source_satisfies_spec?
-      return true if version_constraints.empty?
-
-      # Semverse::Constraint.satisfy_all returns a list of versions that match all of the
-      # supplied constraints. Since we're only matching against a single version, the return
-      # of satisfy_all will be non-empty if the profile version we have satisfies the constraints.
-      constraints = @version_constraints.map { |x| Semverse::Constraint.new(x) }
-      !Semverse::Constraint.satisfy_all(constraints, Semverse::Version.new(profile.version)).empty?
-    end
-
-    def resolved_source
-      @resolved_source ||= fetcher.resolved_source
-    end
-
-    def to_hash
-      h = {
-        "name" => name,
-        "resolved_source" => resolved_source,
-        "version_constraints" => version_constraints,
-      }
-
-      unless dependencies.empty?
-        h["dependencies"] = dependencies.map(&:to_hash)
-      end
-
-      h
-    end
-
-    def lock_deps(dep_array)
-      @dependencies = dep_array
-    end
-
-    def fetcher
-      @fetcher ||= Inspec::CachedFetcher.new(opts, @cache)
-    end
-
-    # load dependencies of the dependency
-    def dependencies
-      @dependencies ||= profile.metadata.dependencies.map do |r|
-        Inspec::Requirement.from_metadata(r, @cache, cwd: @cwd, backend: @backend)
-      end
-    end
-
-    def to_s
-      name
-    end
-
-    # load the profile for the requirement
-    def profile
-      return @profile unless @profile.nil?
-
-      opts = @opts.dup
-      opts[:backend] = @backend
-      opts[:runner_conf] = Inspec::Config.cached
-      if !@dependencies.nil? && !@dependencies.empty?
-        opts[:dependencies] = Inspec::DependencySet.from_array(@dependencies, @cwd, @cache, @backend)
-      end
-      opts[:profile_name] = @name
-      opts[:parent_profile] = @parent_profile
-      @profile = Inspec::Profile.for_fetcher(fetcher, opts)
-      @profile
-    end
-  end
-end

data/lib/inspec/dependencies/resolver.rb

@@ -1,86 +0,0 @@
-require "inspec/log"
-require "inspec/errors"
-
-module Inspec
-  #
-  # Inspec::Resolver is a simple dependency resolver. Unlike Bundler
-  # or Berkshelf, it does not attempt to resolve each named dependency
-  # to a single version. Rather, it traverses down the dependency tree
-  # and:
-  #
-  # - Fetches the dependency from the source
-  # - Checks the presence of cycles, and
-  # - Checks that the specified dependency source satisfies the
-  #   specified version constraint
-  #
-  # The full dependency tree is then available for the loader, which
-  # will provide the isolation necessary to support multiple versions
-  # of the same profile being used at runtime.
-  #
-  # Currently the fetching happens somewhat lazily depending on the
-  # implementation of the fetcher being used.
-  #
-  class Resolver
-    # Here deps is an Array of Hashes
-    def self.resolve(dependencies, cache, working_dir, backend)
-      reqs = dependencies.map do |dep|
-        req = Inspec::Requirement.from_metadata(dep, cache, cwd: working_dir, backend: backend)
-        req || raise("Cannot initialize dependency: #{req}")
-      end
-      new.resolve(reqs)
-    end
-
-    def detect_duplicates(deps, top_level, path_string)
-      seen_items_local = []
-      deps.each do |dep|
-        if seen_items_local.include?(dep.name)
-          problem_cookbook = if top_level
-                               "the inspec.yml for this profile."
-                             else
-                               "the dependency information for #{path_string.split(" ").last}"
-                             end
-          raise Inspec::DuplicateDep, "The dependency #{dep.name} is listed twice in #{problem_cookbook}"
-        else
-          seen_items_local << dep.name
-        end
-      end
-    end
-
-    # Here deps is an Array of Inspec::Requirement
-    def resolve(deps, top_level = true, seen_items = {}, path_string = "") # rubocop:disable Metrics/AbcSize
-      graph = {}
-      if top_level
-        Inspec::Log.debug("Starting traversal of dependencies #{deps.map(&:to_s)}")
-      else
-        Inspec::Log.debug("Traversing dependency tree of transitive dependency #{deps.map(&:name)}")
-      end
-
-      detect_duplicates(deps, top_level, path_string)
-      deps.each do |dep|
-        new_seen_items = seen_items.dup
-        new_path_string = if path_string.empty?
-                            dep.name
-                          else
-                            path_string + " -> #{dep.name}"
-                          end
-
-        raise Inspec::CyclicDependencyError, "Dependency #{dep} would cause a dependency cycle (#{new_path_string})" if new_seen_items.key?(dep.resolved_source)
-
-        new_seen_items[dep.resolved_source] = true
-
-        unless dep.source_satisfies_spec?
-          raise Inspec::UnsatisfiedVersionSpecification, "The profile #{dep.name} from #{dep.resolved_source} has a version #{dep.source_version} which doesn't match #{dep.version_constraints}"
-        end
-
-        Inspec::Log.debug("Adding dependency #{dep.name} (#{dep.resolved_source})")
-        graph[dep.name] = dep
-        unless dep.dependencies.empty?
-          resolve(dep.dependencies, false, new_seen_items.dup, new_path_string)
-        end
-      end
-
-      Inspec::Log.debug("Dependency traversal complete.") if top_level
-      graph
-    end
-  end
-end

data/lib/inspec/describe_base.rb

@@ -1,53 +0,0 @@
-require "inspec/input_dsl_helpers"
-
-module Inspec
-  class DescribeBase
-
-    include Inspec::InputDslHelpers
-
-    def initialize(action)
-      @action = action
-      @checks = []
-    end
-
-    # Evaluate the given block and collect all checks. These will be registered
-    # with the callback function under the 'describe.one' name.
-    #
-    # @param [Proc] ruby block containing checks (e.g. via describe)
-    # @return [nil]
-    def one(&block)
-      return unless block_given?
-
-      instance_eval(&block)
-      @action.call("describe.one", @checks, nil)
-    end
-
-    def input(input_name, options = {})
-      input_with_profile_id(__profile_id, input_name, options)
-    end
-
-    def input_object(name)
-      Inspec::InputRegistry.find_or_register_input(name, __profile_id)
-    end
-
-    def method_missing(method_name, *arguments)
-      Inspec::DSL.method_missing_resource(inspec, method_name, *arguments)
-    end
-
-    def describe(*args, &block)
-      @checks.push(["describe", args, block])
-    end
-
-    private
-
-    # While this is marked private, it gets consumed during an instance_eval,
-    # so it is fully visible. The double underscore is there to discourage
-    # use - this is a private API.
-    def __profile_id
-      # Excavate the profile ID. The action is a Method calling __add_check on
-      # a Rule whose profile ID we want
-      @action.receiver.instance_variable_get(:@__profile_id)
-    end
-
-  end
-end

data/lib/inspec/dist.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Inspec
-  module Dist
-    # When referencing a product directly, like InSpec
-    PRODUCT_NAME = "Chef InSpec"
-
-    # The inspec executable
-    EXEC_NAME = "inspec"
-
-    # The name of the server product
-    SERVER_PRODUCT_NAME = "Chef Server"
-
-    # name of the automate product
-    AUTOMATE_PRODUCT_NAME = "Chef Automate"
-
-    # name of the compliance product
-    COMPLIANCE_PRODUCT_NAME = "Chef Compliance"
-  end
-end

data/lib/inspec/dsl.rb

@@ -1,115 +0,0 @@
-# copyright: 2015, Dominik Richter
-require "inspec/log"
-require "inspec/plugin/v2"
-
-module Inspec::DSL
-  attr_accessor :backend
-
-  def require_controls(id, &block)
-    opts = { profile_id: id, include_all: false, backend: @backend, conf: @conf, dependencies: @dependencies }
-    ::Inspec::DSL.load_spec_files_for_profile(self, opts, &block)
-  end
-
-  def include_controls(id, &block)
-    opts = { profile_id: id, include_all: true, backend: @backend, conf: @conf, dependencies: @dependencies }
-    ::Inspec::DSL.load_spec_files_for_profile(self, opts, &block)
-  end
-
-  alias require_rules require_controls
-  alias include_rules include_controls
-
-  def require_resource(options = {})
-    raise "You must specify a specific resource name when calling require_resource()" if options[:resource].nil?
-
-    from_profile = options[:profile] || profile_name
-    target_name = options[:as] || options[:resource]
-    res = resource_class(from_profile, options[:resource])
-    add_resource(target_name, res)
-  end
-
-  ##
-  # Try to load and instantiate a missing resource or raise LoadError
-  # if unable. Requiring the resource registers it and generates a
-  # method for it so you should only hit this once per missing
-  # resource.
-
-  def self.method_missing_resource(backend, id, *arguments)
-    return unless backend
-
-    begin
-      require "inspec/resources/#{id}"
-    rescue LoadError
-      require "resources/aws/#{id}"
-    end
-
-    klass = Inspec::Resource.registry[id.to_s]
-    klass.new(backend, id, *arguments)
-  end
-
-  # Support for Outer Profile DSL plugins
-  # This is called when an unknown method is encountered
-  # "bare" in a control file - outside of a control or describe block.
-  def method_missing(method_name, *arguments, &block)
-    # Check to see if there is a outer_profile_dsl plugin activator hook with the method name
-    registry = Inspec::Plugin::V2::Registry.instance
-    hook = registry.find_activators(plugin_type: :outer_profile_dsl, activator_name: method_name).first
-    if hook
-      # OK, load the hook if it hasn't been already.  We'll then know a module,
-      # which we can then inject into the context
-      hook.activate
-      # Inject the module's methods into the context
-      # implementation_class is the field name, but this is actually a module.
-      self.class.include(hook.implementation_class)
-      # Now that the module is loaded, it defined one or more methods
-      # (presumably the one we were looking for.)
-      # We still haven't called it, so do so now.
-      send(method_name, *arguments, &block)
-    else
-      begin
-        Inspec::DSL.method_missing_resource(backend, method_name, *arguments)
-      rescue LoadError
-        super
-      end
-    end
-  end
-
-  def self.load_spec_files_for_profile(bind_context, opts, &block)
-    dependencies = opts[:dependencies]
-    profile_id = opts[:profile_id]
-    dep_entry = dependencies.list[profile_id]
-
-    if dep_entry.nil?
-      raise <<~EOF
-        Cannot load '#{profile_id}' since it is not listed as a dependency of #{bind_context.profile_name}.
-
-        Dependencies available from this context are:
-            #{dependencies.list.keys.join("\n    ")}
-      EOF
-    end
-
-    # Do not load any controls if the profile is not supported
-    return unless dep_entry.profile.supports_platform?
-
-    context = dep_entry.profile.runner_context
-    # if we don't want all the rules, then just make 1 pass to get all rule_IDs
-    # that we want to keep from the original
-    filter_included_controls(context, dep_entry.profile, &block) unless opts[:include_all]
-    # interpret the block and skip/modify as required
-    context.load(block) if block_given?
-    bind_context.add_subcontext(context)
-  end
-
-  def self.filter_included_controls(context, profile, &block)
-    mock = Inspec::Backend.create(Inspec::Config.mock)
-    include_ctx = Inspec::ProfileContext.for_profile(profile, mock)
-    include_ctx.load(block) if block_given?
-    # remove all rules that were not registered
-    context.all_rules.each do |r|
-      id = Inspec::Rule.rule_id(r)
-      fid = Inspec::Rule.profile_id(r) + "/" + id
-      unless include_ctx.rules[id] || include_ctx.rules[fid]
-        context.remove_rule(fid)
-      end
-    end
-  end
-end

data/lib/inspec/dsl_shared.rb

@@ -1,32 +0,0 @@
-module Inspec
-  #
-  # Contains methods we would like in multiple DSL
-  #
-  module DSL
-    module RequireOverride
-      # Save the toplevel require method to load all ruby dependencies.
-      # It is used whenever the `require 'lib'` is not in libraries.
-      alias __ruby_require require
-
-      def require(path)
-        rbpath = path + ".rb"
-        return __ruby_require(path) unless @require_loader.exists?(rbpath)
-        return false if @require_loader.loaded?(rbpath)
-
-        # This is equivalent to calling `require 'lib'` with lib on disk.
-        # We cannot rely on libraries residing on disk however.
-        # TODO: Sandboxing.
-        content, path, line = @require_loader.load(rbpath)
-
-        # If we are in the realm of libraries and the LibraryEvalContext
-        # we should have access to the __inspec_binding, which is a Binding
-        # context that provides the correct plane to evaluate all required files to.
-        # It will ensure that embedded calls to `require` still call this
-        # method and get loaded from their correct paths.
-        return __inspec_binding.eval(content, path, line) if defined?(__inspec_binding)
-
-        eval(content, TOPLEVEL_BINDING, path, line) # rubocop:disable Security/Eval
-      end
-    end
-  end
-end

data/lib/inspec/env_printer.rb

@@ -1,156 +0,0 @@
-require "inspec/shell_detector"
-require "erb"
-require "shellwords"
-
-module Inspec
-  class EnvPrinter
-    attr_reader :shell
-
-    EVAL_COMMANDS = {
-      "bash" => 'eval \"$(inspec env bash)\"',
-      "fish" => "inspec env fish > ~/.config/fish/completions/inspec.fish",
-      "zsh" => 'eval \"$(inspec env zsh)\"',
-    }.freeze
-
-    def initialize(command_class, shell = nil)
-      if !shell
-        @detected = true
-        @shell = Inspec::ShellDetector.new.shell
-      else
-        @shell = shell
-      end
-      @command_class = command_class
-    end
-
-    def print_and_exit!
-      exit_no_shell unless have_shell?
-      exit_no_completion unless have_shell_completion?
-
-      print_completion_for_shell
-      print_detection_warning($stdout) if @detected
-      print_usage_guidance
-      exit 0
-    end
-
-    private
-
-    def print_completion_for_shell
-      erb = ERB.new(File.read(completion_template_path), nil, "-")
-      puts erb.result(TemplateContext.new(@command_class).get_bindings)
-    end
-
-    def have_shell?
-      !(@shell.nil? || @shell.empty?)
-    end
-
-    def have_shell_completion?
-      File.exist?(completion_template_path)
-    end
-
-    def completion_dir
-      File.join(File.dirname(__FILE__), "completions")
-    end
-
-    def completion_template_path
-      File.join(completion_dir, "#{@shell}.sh.erb")
-    end
-
-    def shells_with_completions
-      Dir.glob("#{completion_dir}/*.sh.erb").map { |f| File.basename(f, ".sh.erb") }
-    end
-
-    def print_usage_guidance
-      puts <<~EOF
-        # To use this, eval it in your shell
-        #
-        #    #{EVAL_COMMANDS[shell]}
-        #
-        #
-      EOF
-    end
-
-    def print_detection_warning(device)
-      device.puts <<~EOF
-        #
-        # The shell #{@shell} was auto-detected. If this is incorrect, please
-        # specify a shell explicitly by running:
-        #
-        #     inspec env SHELLNAME
-        #
-        # Currently supported shells are: #{shells_with_completions.join(", ")}
-        #
-      EOF
-    end
-
-    def exit_no_completion
-      $stderr.puts "# No completion script for #{@shell}!"
-      print_detection_warning($stderr) if @detected
-      exit 1
-    end
-
-    def exit_no_shell
-      if @detected
-        $stderr.puts "# Unable to automatically detect shell and no shell was provided."
-      end
-      $stderr.puts <<~EOF
-        #
-        # Please provide the name of your shell via the command line:
-        #
-        #    inspec env SHELLNAME
-        #
-        # Currently supported shells are: #{shells_with_completions.join(", ")}
-      EOF
-      exit 1
-    end
-
-    class TemplateContext
-      def initialize(command_class)
-        @command_class = command_class
-      end
-
-      def get_bindings # rubocop:disable Naming/AccessorMethodName
-        binding
-      end
-
-      #
-      # The following functions all assume that @command_class
-      # is something that provides a Thor-like API
-      #
-      def top_level_commands
-        commands_for_thor_class(@command_class)
-      end
-
-      def top_level_commands_with_descriptions
-        descript_lines_for_class(@command_class)
-      end
-
-      def subcommands_with_commands
-        ret = {}
-        @command_class.subcommand_classes.each do |k, v|
-          ret[k] = commands_for_thor_class(v)
-        end
-        ret
-      end
-
-      def subcommands_with_commands_and_descriptions
-        ret = {}
-        @command_class.subcommand_classes.each do |k, v|
-          ret[k] = descript_lines_for_class(v)
-        end
-        ret
-      end
-
-      def commands_for_thor_class(thor_class)
-        thor_class.all_commands.values.map { |c| c.usage.split.first }
-      end
-
-      def descript_lines_for_class(thor_class)
-        thor_class.all_commands.values.map { |c| descript_line_for_command(c) }
-      end
-
-      def descript_line_for_command(c)
-        "#{c.usage.split.first}:#{Shellwords.escape(c.description)}"
-      end
-    end
-  end
-end