inspec 3.9.0 → 3.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b066773c22941ad572488baafaaa8ec31833d1038b42a1e63765a6979a1db5
-  data.tar.gz: 53347dff1a894fc23be96443fc116dd1af24fc20755bf5c78368b4382ea179cc
+  metadata.gz: 6acb1580248137e250e50e82452ca06ffbb270db5f166c206050ae8d2ce0f046
+  data.tar.gz: e6c0db990f81559518f2f39b1d9a3bafb4455ff6fa25f478c94488d1c5e3b620
 SHA512:
-  metadata.gz: 2f912c8ca1629fe56bf85915f7830766a7486ab6f8d142aa8b9b8faad7ccdef661ca2a9b44e6613bc650de4e500b128d09e39792852093f460021f821391e530
-  data.tar.gz: 3b0dcf1c8d59f78ff892aa447229a44bcb567c3a08f9702ad072a4e680b7f81929399ecb83aa16f3dc8533b8c2ce566580742589c70b23d46e33a178a73ce39c
+  metadata.gz: d379f6e0f71d1c79ced4577c381d75e0e3005c52652dc59e68486ddc20dad952067d9960187088db6713e23e81d5c226b7b1da43ff81835f6d22f23925db42b2
+  data.tar.gz: 0bdefe99c446850501e474c8391fe370266038440e866b3f6d96ddea41b8e07af9668b206452d019af678f0a7ef8e9aefe71f28536990d7755dba66b55c86709

data/lib/inspec.rb

@@ -20,6 +20,7 @@ require 'inspec/input_registry'
 require 'inspec/rspec_extensions'
 require 'inspec/globals'
 require 'inspec/impact'
+require 'inspec/utils/telemetry'
 
 require 'inspec/plugin/v2'
 require 'inspec/plugin/v1'

data/lib/inspec/base_cli.rb

@@ -107,8 +107,10 @@ module Inspec
       option :reporter, type: :array,
         banner: 'one two:/output/file/path',
         desc: 'Enable one or more output reporters: cli, documentation, html, progress, json, json-min, json-rspec, junit, yaml'
-      option :attrs, type: :array,
+      option :input_file, type: :array,
         desc: 'Load one or more input files, a YAML file with values for the profile to use'
+      option :attrs, type: :array,
+        desc: 'Legacy name for --input-file - deprecated.'
       option :create_lockfile, type: :boolean,
         desc: 'Write out a lockfile based on this execution (unless one already exists)'
       option :backend_cache, type: :boolean,

data/lib/inspec/objects/input.rb

@@ -23,8 +23,8 @@ module Inspec
 
         # output warn message if we are in a exec call
         Inspec::Log.warn(
-          "Attribute '#{@name}' does not have a value. "\
-          "Use --attrs to provide a value for '#{@name}' or specify a  "\
+          "Input '#{@name}' does not have a value. "\
+          "Use --input-file to provide a value for '#{@name}' or specify a  "\
           "value with `attribute('#{@name}', value: 'somevalue', ...)`.",
         ) if Inspec::BaseCLI.inspec_cli_command == :exec
       end

data/lib/inspec/runner.rb

@@ -151,10 +151,14 @@ module Inspec
 
     # determine all inputs before the execution, fetch data from secrets backend
     def load_inputs(options)
-      # TODO: - rename :attributes and :attrs - these are both user-visible
+      # TODO: - rename :attributes - it is user-visible
       options[:attributes] ||= {}
 
-      secrets_targets = options[:attrs]
+      if options.key?(:attrs)
+        Inspec.deprecate(:rename_attributes_to_inputs, 'Use --input-file on the command line instead of --attrs.')
+        options[:input_file] = options.delete(:attrs)
+      end
+      secrets_targets = options[:input_file]
       return options[:attributes] if secrets_targets.nil?
 
       secrets_targets.each do |target|

data/lib/inspec/utils/telemetry.rb

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

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

@@ -0,0 +1,60 @@
+require 'inspec/utils/telemetry/data_series'
+require 'singleton'
+
+module Inspec::Telemetry
+  # A Singleton collection of data series objects.
+  class Collector
+    include Singleton
+
+    def initialize
+      @data_series = []
+      @enabled = true
+    end
+
+    # Add a data series to the collection.
+    # @return [True]
+    def add_data_series(data_series)
+      @data_series << data_series
+    end
+
+    # Is the Telemetry system enabled or disabled?
+    # Always true until we add configuration parsing.
+    # @return [True, False]
+    def telemetry_enabled?
+      @enabled
+    end
+
+    # A way to disable the telemetry system.
+    # @return [True]
+    def disable_telemetry
+      @enabled = false
+    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.
+    # @return [True]
+    def reset
+      @data_series = []
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'json'
+
+# 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

@@ -0,0 +1,21 @@
+require 'inspec/utils/telemetry'
+
+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

@@ -4,5 +4,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '3.9.0'
+  VERSION = '3.9.3'
 end

data/lib/resources/crontab.rb

@@ -41,6 +41,7 @@ module Inspec::Resources
         @user = opts.fetch(:user, nil)
         @path = opts.fetch(:path, nil)
         raise Inspec::Exceptions::ResourceFailed, 'A user or path must be supplied.' if @user.nil? && @path.nil?
+        raise Inspec::Exceptions::ResourceFailed, 'Either user or path must be supplied, not both!' if !@user.nil? && !@path.nil?
       else
         @user = opts
         @path = nil
@@ -49,7 +50,12 @@ module Inspec::Resources
     end
 
     def read_crontab
-      ct = is_system_crontab? ? inspec.file(@path).content : inspec.command(crontab_cmd).stdout
+      if is_system_crontab?
+        raise Inspec::Exceptions::ResourceFailed, "Supplied crontab path '#{@path}' must exist!" if !inspec.file(@path).exist?
+        ct = inspec.file(@path).content
+      else
+        ct = inspec.command(crontab_cmd).stdout
+      end
       ct.lines.map { |l| parse_crontab_line(l) }.compact
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.9.3
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train
@@ -493,6 +493,10 @@ files:
 - lib/inspec/shell_detector.rb
 - lib/inspec/source_reader.rb
 - lib/inspec/ui.rb
+- lib/inspec/utils/telemetry.rb
+- lib/inspec/utils/telemetry/collector.rb
+- lib/inspec/utils/telemetry/data_series.rb
+- lib/inspec/utils/telemetry/global_methods.rb
 - lib/inspec/version.rb
 - lib/matchers/matchers.rb
 - lib/plugins/README.md