inspec 4.18.51 → 4.18.85

data/lib/inspec/utils/telemetry.rb

@@ -1,3 +0,0 @@
-require "inspec/utils/telemetry/collector"
-require "inspec/utils/telemetry/data_series"
-require "inspec/utils/telemetry/global_methods"

data/lib/inspec/utils/telemetry/collector.rb

@@ -1,81 +0,0 @@
-require "inspec/config"
-require "inspec/utils/telemetry/data_series"
-require "singleton"
-
-module Inspec::Telemetry
-  # A Singleton collection of data series objects.
-  class Collector
-    include Singleton
-
-    attr_reader :config
-
-    def initialize
-      @data_series = []
-      @telemetry_toggled_off = false
-      load_config
-    end
-
-    # Allow loading a configuration, useful when testing.
-    def load_config(config = Inspec::Config.cached)
-      @config = config
-    end
-
-    # Add a data series to the collection.
-    # @return [True]
-    def add_data_series(data_series)
-      @data_series << data_series
-    end
-
-    # The loaded configuration should have a option to configure
-    # telemetry, if not default to false.
-    # @return [True, False]
-    def telemetry_enabled?
-      if @telemetry_toggled_off
-        false
-      else
-        config_telemetry_options.fetch("enable_telemetry", false)
-      end
-    end
-
-    # A way to disable the telemetry system.
-    def disable_telemetry
-      @telemetry_toggled_off = true
-    end
-
-    # The entire data series collection.
-    # @return [Array]
-    def list_data_series
-      @data_series
-    end
-
-    # Finds the data series object with the specified name and returns it.
-    # If it does not exist then creates a new data series with that name
-    # and returns it.
-    # @return [Inspec::Telemetry::DataSeries]
-    def find_or_create_data_series(name)
-      ds = @data_series.select { |data_series| data_series.name.eql?(name) }
-      if ds.empty?
-        new_data_series = Inspec::Telemetry::DataSeries.new(name)
-        @data_series << new_data_series
-        new_data_series
-      else
-        ds.first
-      end
-    end
-
-    # Blanks the contents of the data series collection.
-    # Reset telemetry toggle
-    # @return [True]
-    def reset!
-      @data_series = []
-      @telemetry_toggled_off = false
-    end
-
-    private
-
-    # Minimize exposure of Inspec::Config interface
-    def config_telemetry_options
-      config.telemetry_options
-    end
-  end
-end

data/lib/inspec/utils/telemetry/data_series.rb

@@ -1,44 +0,0 @@
-require "json"
-
-module Inspec; end
-
-# A minimal Dataseries Object
-# Stores the name of the data series and an array of data.
-# Stored data should be a object that supports #to_s
-module Inspec::Telemetry
-  class DataSeries
-    def initialize(name)
-      @name = name
-      @enabled = true
-      @data ||= []
-    end
-
-    attr_reader :data, :name
-
-    # This needs to also be set by configuration.
-    def enabled?
-      @enabled
-    end
-
-    def disable
-      @enabled = false
-    end
-
-    def <<(appending_data)
-      data << appending_data
-    end
-
-    alias push <<
-
-    def to_h
-      {
-        name: @name,
-        data: @data,
-      }
-    end
-
-    def to_json
-      to_h.to_json
-    end
-  end
-end

data/lib/inspec/utils/telemetry/global_methods.rb

@@ -1,22 +0,0 @@
-require "inspec/utils/telemetry/collector"
-
-module Inspec
-  # A Global method to add a data series object to the Telemetry Collection.
-  # `data_series_name`s are unique, so `:dependency_group` will always return
-  # the same object.
-  # `data_point` is optional, you may also supply a block with several data points.
-  # All data points should allow #to_s
-  def self.record_telemetry_data(data_series_name, data_point = nil)
-    coll = Inspec::Telemetry::Collector.instance
-    return unless coll.telemetry_enabled?
-
-    ds = coll.find_or_create_data_series(data_series_name)
-    return unless ds.enabled?
-
-    if block_given?
-      ds << yield
-    else
-      ds << data_point
-    end
-  end
-end

data/lib/inspec/version.rb

@@ -1,3 +0,0 @@
-module Inspec
-  VERSION = "4.18.51".freeze
-end

data/lib/matchers/matchers.rb

@@ -1,341 +0,0 @@
-# copyright: 2015, Vulcano Security GmbH
-
-require "rspec/matchers"
-
-RSpec::Matchers.define :be_readable do
-  match do |file|
-    file.readable?(@by, @by_user)
-  end
-
-  chain :by do |by|
-    @by = by
-  end
-
-  chain :by_user do |by_user|
-    @by_user = by_user
-  end
-
-  description do
-    res = "be readable"
-    res += " by #{@by}" unless @by.nil?
-    res += " by user #{@by_user}" unless @by_user.nil?
-    res
-  end
-end
-
-RSpec::Matchers.define :be_writable do
-  match do |file|
-    file.writable?(@by, @by_user)
-  end
-
-  chain :by do |by|
-    @by = by
-  end
-
-  chain :by_user do |by_user|
-    @by_user = by_user
-  end
-
-  description do
-    res = "be writable"
-    res += " by #{@by}" unless @by.nil?
-    res += " by user #{@by_user}" unless @by_user.nil?
-    res
-  end
-end
-
-RSpec::Matchers.define :be_executable do
-  match do |file|
-    file.executable?(@by, @by_user)
-  end
-
-  chain :by do |by|
-    @by = by
-  end
-
-  chain :by_user do |by_user|
-    @by_user = by_user
-  end
-
-  description do
-    res = "be executable"
-    res += " by #{@by}" unless @by.nil?
-    res += " by user #{@by_user}" unless @by_user.nil?
-    res
-  end
-end
-
-RSpec::Matchers.define :contain_duplicates do
-  match do |arr|
-    dup = arr.select { |element| arr.count(element) > 1 }
-    !dup.uniq.empty?
-  end
-end
-
-# for packages
-RSpec::Matchers.define :be_installed do
-  match do |package|
-    package.installed? == true
-  end
-
-  failure_message do |package|
-    "expected that `#{package}` is installed"
-  end
-
-  chain :by do
-    raise "[UNSUPPORTED] Please use the new resources 'gem', 'npm' or 'pip'."
-  end
-end
-
-# for services
-RSpec::Matchers.define :be_enabled do
-  match do |service|
-    service.enabled? == true
-  end
-
-  chain :with_level do |_level|
-    raise "[UNSUPPORTED] with level is not supported"
-  end
-
-  failure_message do |service|
-    "expected that `#{service}` is enabled"
-  end
-end
-
-# service resource matcher for serverspec compatibility
-# Deprecated: You should not use this matcher anymore
-RSpec::Matchers.define :be_running do
-  match do |service|
-    service.running? == true
-  end
-
-  chain :under do |_under|
-    raise "[UNSUPPORTED] under is not supported"
-  end
-
-  failure_message do |service|
-    "expected that `#{service}` is running"
-  end
-end
-
-# matcher to check if host is reachable
-RSpec::Matchers.define :be_reachable do
-  match do |host|
-    host.reachable? == true
-  end
-
-  chain :with do |_attr|
-    raise "[UNSUPPORTED] `with` is not supported in combination with `be_reachable`"
-  end
-
-  failure_message do |host|
-    "expected that host #{host} is reachable"
-  end
-end
-
-# matcher to check if host is resolvable
-RSpec::Matchers.define :be_resolvable do
-  match do |host|
-    host.resolvable? == true
-  end
-
-  chain :by do |_type|
-    raise "[UNSUPPORTED] `by` is not supported in combination with `be_resolvable`. Please use the following syntax `host('example.com', port: 53, proto: 'udp')`."
-  end
-
-  failure_message do |host|
-    "expected that host #{host} is resolvable"
-  end
-end
-
-# matcher for iptables and ip6tables
-RSpec::Matchers.define :have_rule do |rule|
-  match do |tables|
-    tables.has_rule?(rule)
-  end
-
-  chain :with_table do |_table|
-    raise "[UNSUPPORTED] `with_table` is not supported in combination with `have_rule`. Please use the following syntax `iptables(table:'mangle', chain: 'input')`."
-  end
-
-  chain :with_chain do |_chain|
-    raise "[UNSUPPORTED] `with_table` is not supported in combination with `with_chain`. Please use the following syntax `iptables(table:'mangle', chain: 'input')`."
-  end
-end
-
-# `be_in` matcher
-# You can use it in the following cases:
-# - check if an item or array is included in a given array
-# eg:
-# describe nginx do
-#   its('user') { should be_in AUTHORIZED_USER_LIST }
-# end
-# describe nginx do
-#   its('module_list') { should be_in AUTHORIZED_MODULE_LIST }
-# end
-RSpec::Matchers.define :be_in do |list|
-  match do |item|
-    # Handle both single item and array
-    item.is_a?(Array) ? (item - list).empty? : list.include?(item)
-  end
-
-  match_when_negated do |item|
-    # Handle both single item and array
-    item.is_a?(Array) ? (item & list).empty? : !list.include?(item)
-  end
-
-  failure_message do |item|
-    if item.is_a?(Array)
-      "expected `#{item}` to be in the list: `#{list}` \nDiff:\n #{(item - list)}"
-    else
-      "expected `#{item}` to be in the list: `#{list}`"
-    end
-  end
-
-  failure_message_when_negated do |item|
-    if item.is_a?(Array)
-      "expected `#{item}` not to be in the list: `#{list}` \nComm:\n #{(item & list)}"
-    else
-      "expected `#{item}` not to be in the list: `#{list}`"
-    end
-  end
-end
-
-# This matcher implements a compare feature that cannot be covered by the default
-# `eq` matcher
-# You can use it in the following cases:
-# - compare strings case-insensitive
-# - you expect a number (strings will be converted if possible)
-#
-RSpec::Matchers.define :cmp do |first_expected| # rubocop:disable Metrics/BlockLength
-
-  def integer?(value)
-    !(value =~ /\A-?0+\Z|\A-?[1-9]\d*\Z/).nil?
-  end
-
-  def float?(value)
-    Float(value)
-    true
-  rescue ArgumentError, TypeError
-    false
-  end
-
-  def octal?(value)
-    return false unless value.is_a?(String)
-
-    !(value =~ /\A0+[0-7]+\Z/).nil?
-  end
-
-  def boolean?(value)
-    %w{true false}.include?(value.downcase)
-  end
-
-  def version?(value)
-    Gem::Version.new(value)
-    true
-  rescue ArgumentError => _ex
-    false
-  end
-
-  # expects that the values have been checked with boolean?
-  def to_boolean(value)
-    value.casecmp("true") == 0
-  end
-
-  def try_match(actual, op, expected) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
-    # if actual and expected are strings
-    if expected.is_a?(String) && actual.is_a?(String)
-      return actual.casecmp(expected) == 0 if op == :==
-      return Gem::Version.new(actual).send(op, Gem::Version.new(expected)) if
-        version?(expected) && version?(actual)
-    elsif expected.is_a?(Regexp) && (actual.is_a?(String) || actual.is_a?(Integer))
-      return !actual.to_s.match(expected).nil?
-    elsif expected.is_a?(String) && integer?(expected) && actual.is_a?(Integer)
-      return actual.send(op, expected.to_i)
-    elsif expected.is_a?(String) && boolean?(expected) && [true, false].include?(actual)
-      return actual.send(op, to_boolean(expected))
-    elsif expected.is_a?(Integer) && actual.is_a?(String) && integer?(actual)
-      return actual.to_i.send(op, expected)
-    elsif expected.is_a?(Float) && float?(actual)
-      return actual.to_f.send(op, expected)
-    elsif actual.is_a?(Symbol) && expected.is_a?(String)
-      return try_match(actual.to_s, op, expected)
-    elsif octal?(expected) && actual.is_a?(Integer)
-      return actual.send(op, expected.to_i(8))
-    end
-
-    # fallback to simple operation
-    actual.send(op, expected)
-  rescue NameError => _
-    false
-  rescue ArgumentError
-    false
-  end
-
-  match do |actual|
-    @operation ||= :==
-    @expected ||= first_expected
-    return actual === @expected if @operation == :=== # rubocop:disable Style/CaseEquality
-
-    actual = actual[0] if actual.is_a?(Array) && !@expected.is_a?(Array) && actual.length == 1
-    try_match(actual, @operation, @expected)
-  end
-
-  %i{== != < <= >= > === =~}.each do |op|
-    chain(op) do |x|
-      @operation = op
-      @expected = x
-    end
-  end
-
-  def format_expectation(negate)
-    return "expected: " + @expected.inspect if @operation == :== && !negate
-
-    negate_str = negate ? "not " : ""
-    "expected it #{negate_str}to be #{@operation} #{@expected.inspect}"
-  end
-
-  failure_message do |actual|
-    actual = ("0" + actual.to_s(8)) if octal?(@expected)
-    "\n" + format_expectation(false) + "\n     got: #{actual.inspect}\n\n(compared using `cmp` matcher)\n"
-  end
-
-  failure_message_when_negated do |actual|
-    actual = ("0" + actual.to_s(8)).inspect if octal?(@expected)
-    "\n" + format_expectation(true) + "\n     got: #{actual.inspect}\n\n(compared using `cmp` matcher)\n"
-  end
-
-  description do
-    "cmp #{@operation} #{@expected.inspect}"
-  end
-end
-
-# user resource matcher for serverspec compatibility
-# This matcher will be deprecated in future
-RSpec::Matchers.define :be_mounted do
-  match do |path|
-    if !@options.nil?
-      path.mounted?(@options, @identical)
-    else
-      path.mounted?
-    end
-  end
-
-  chain :with do |attr|
-    @options = attr
-    @identical = false
-  end
-
-  chain :only_with do |attr|
-    @options = attr
-    @identical = true
-  end
-
-  failure_message do |path|
-    if !@options.nil?
-      "\n#{path} is not mounted with the options\n     expected: #{@options}\n     got: #{path.mount_options}\n"
-    else
-      "\n#{path} is not mounted\n"
-    end
-  end
-end