inspec-core 4.22.0 → 4.23.10

data/lib/inspec/version.rb

@@ -1,3 +1,3 @@
 module Inspec
-  VERSION = "4.22.0".freeze
+  VERSION = "4.23.10".freeze
 end

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

@@ -22,7 +22,7 @@ module InspecPlugins
       # return all compliance profiles available for the user
       # the user is either specified in the options hash or by default
       # the username of the account is used that is logged in
-      def self.profiles(config, profile_filter = nil) # rubocop:disable PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+      def self.profiles(config, profile_filter = nil) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
         owner = config["owner"] || config["user"]
 
         # Chef Compliance
@@ -81,13 +81,13 @@ module InspecPlugins
           mapped_profiles.select! do |p|
             (!ver || p["version"] == ver) && (!id || p["name"] == id)
           end
-          return msg, mapped_profiles
+          [msg, mapped_profiles]
         when "401"
           msg = "401 Unauthorized. Please check your token."
-          return msg, []
+          [msg, []]
         else
           msg = "An unexpected error occurred (HTTP #{response_code}): #{response.message}"
-          return msg, []
+          [msg, []]
         end
       end
 

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

@@ -126,7 +126,7 @@ module InspecPlugins
         desc: "Overwrite existing profile on Server."
       option :owner, type: :string, required: false,
         desc: "Owner that should own the profile"
-      def upload(path) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, PerceivedComplexity, Metrics/CyclomaticComplexity
+      def upload(path) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
         config = InspecPlugins::Compliance::Configuration.new
         return unless loggedin(config)
 

data/lib/plugins/inspec-init/templates/profiles/aws/README.md

@@ -26,7 +26,7 @@ Creating new profile at /Users/spaterson/my-profile
 aws_vpc_id: 'custom-vpc-id'
 ```
 
-The related control will simply be skipped if this is not provided.  See the [InSpec DSL documentation](https://www.inspec.io/docs/reference/dsl_inspec/) for more details on conditional execution using `only_if`.
+The related control will simply be skipped if this is not provided.  See the [InSpec DSL documentation](https://docs.chef.io/inspec/dsl_inspec/) for more details on conditional execution using `only_if`.
 
 ## Run the tests
 

data/lib/plugins/inspec-reporter-html2/README.md

@@ -24,7 +24,7 @@ Note the `2` in the reporter name. If you omit it and run `--reporter html` inst
 
 ## Configuring the Plugin
 
-The `html2` reporter requires no configuration to function. However, two options--`alternate_css_file` and `alternate_js_file`--are available for customization. The options are set in the JSON-formatted configuration file that Chef InSpec consumes. For details, see [our configuration file documentation](https://www.inspec.io/docs/reference/config/).
+The `html2` reporter requires no configuration to function. However, two options--`alternate_css_file` and `alternate_js_file`--are available for customization. The options are set in the JSON-formatted configuration file that Chef InSpec consumes. For details, see [our configuration file documentation](https://docs.chef.io/inspec/config/).
 
 For example:
 

data/lib/plugins/inspec-reporter-junit/README.md

@@ -0,0 +1,17 @@
+# junit and junit2 reporters
+
+This is the implementation of the junit and junit2 XML reporters.
+
+## Installation
+
+This plugin ships with Chef InSpec and requires no additional installation.
+
+## What These Plugins Do
+
+`junit` is the legacy Chef InSpec JUnit reporter, which is retained for backwards compatibility. It generates an XML report in Apache Ant JUnit format. The output format is considered nonstandard in several ways. New users are advised to use `junit2`.
+
+`junit2` is an updated reporter that provides JUnit output according to the schema published by [Windy Road](https://github.com/windyroad/JUnit-Schema).
+
+## Implementation Note
+
+This reporter uses the REXML XML generator at runtime, but uses Nokogiri, a more heavyweight XML library, for testing. This design keeps packaging requirements lightweight and free of compiled dependencies.

data/lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit.rb

@@ -0,0 +1,21 @@
+require_relative "inspec-reporter-junit/version"
+module InspecPlugins
+  module JUnitReporter
+    class Plugin < ::Inspec.plugin(2)
+      plugin_name :'inspec-reporter-junit'
+
+      # Legacy JUnit reporter, which generates subtly incorrect XML.
+      reporter :junit do
+        require_relative "inspec-reporter-junit/reporter"
+        InspecPlugins::JUnitReporter::ReporterV1
+      end
+
+      # v2 reporter, which generates valid JUnit XML.
+      reporter :junit2 do
+        require_relative "inspec-reporter-junit/reporter"
+        InspecPlugins::JUnitReporter::ReporterV2
+      end
+
+    end
+  end
+end

data/lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit/reporter.rb

@@ -0,0 +1,155 @@
+module InspecPlugins::JUnitReporter
+  class Reporter < Inspec.plugin(2, :reporter)
+    def self.run_data_schema_constraints
+      "~> 0.0"
+    end
+
+    def render
+      require "rexml/document"
+      xml_output = REXML::Document.new
+      xml_output.add(REXML::XMLDecl.new)
+
+      testsuites = REXML::Element.new("testsuites")
+      xml_output.add(testsuites)
+
+      run_data.profiles.each_with_index do |profile, idx|
+        testsuites.add(build_profile_xml(profile, idx))
+      end
+
+      formatter = REXML::Formatters::Pretty.new
+      formatter.compact = true
+      output(formatter.write(xml_output.xml_decl, ""))
+      output(formatter.write(xml_output.root, ""))
+    end
+
+    def count_profile_tests(profile)
+      profile.controls.reduce(0) do |acc, elem|
+        acc + elem.results.count
+      end
+    end
+
+    def count_profile_failed_tests(profile)
+      profile.controls.reduce(0) do |acc, elem|
+        acc + elem.results.reduce(0) do |fail_test_total, test_case|
+          test_case.status == "failed" ? fail_test_total + 1 : fail_test_total
+        end
+      end
+    end
+
+    def count_profile_skipped_tests(profile)
+      profile.controls.reduce(0) do |acc, elem|
+        acc + elem.results.reduce(0) do |skip_test_total, test_case|
+          test_case.status == "skipped" ? skip_test_total + 1 : skip_test_total
+        end
+      end
+    end
+
+    def count_profile_errored_tests(profile)
+      profile.controls.reduce(0) do |acc, elem|
+        acc + elem.results.reduce(0) do |err_test_total, test_case|
+          test_case.backtrace.nil? ? err_test_total : err_test_total + 1
+        end
+      end
+    end
+  end
+
+  # This is the "Legacy" JUnit reporter. It produces XML which is not
+  # correct according to the JUnit standard. It is retained for backwards
+  # compatibility.
+  class ReporterV1 < Reporter
+    def build_profile_xml(profile, _idx)
+      profile_xml = REXML::Element.new("testsuite")
+      profile_xml.add_attribute("name", profile.name)
+      profile_xml.add_attribute("tests", count_profile_tests(profile))
+      profile_xml.add_attribute("failed", count_profile_failed_tests(profile))
+      profile_xml.add_attribute("failures", count_profile_failed_tests(profile))
+
+      profile.controls.each do |control|
+        control.results.each do |result|
+          profile_xml.add(build_result_xml(profile.name, control, result))
+        end
+      end
+
+      profile_xml
+    end
+
+    def build_result_xml(profile_name, control, result)
+      result_xml = REXML::Element.new("testcase")
+      result_xml.add_attribute("name", result.code_desc)
+      result_xml.add_attribute("classname", control.title.nil? ? "#{profile_name}.Anonymous" : "#{profile_name}.#{control.id}")
+      result_xml.add_attribute("target", run_data.platform.target.nil? ? "" : run_data.platform.target.to_s)
+      result_xml.add_attribute("time", result.run_time)
+
+      if result.status == "failed"
+        failure_element = REXML::Element.new("failure")
+        failure_element.add_attribute("message", result[:message])
+        result_xml.add(failure_element)
+      elsif result.status == "skipped"
+        result_xml.add_element("skipped")
+      end
+
+      result_xml
+    end
+  end
+
+  # This is the "Corrected" JUnit reporter. It produces XML which is intended
+  # to be valid. It should be used whenever possible.
+  class ReporterV2 < Reporter
+    def build_profile_xml(profile, idx)
+      profile_xml = REXML::Element.new("testsuite")
+      profile_xml.add_attribute("name", profile.name)
+      profile_xml.add_attribute("tests", count_profile_tests(profile))
+      profile_xml.add_attribute("id", idx + 1)
+
+      # junit2 counts failures and errors separately
+      errors = count_profile_errored_tests(profile)
+      profile_xml.add_attribute("errors", errors)
+      profile_xml.add_attribute("failures", count_profile_failed_tests(profile) - errors)
+      profile_xml.add_attribute("skipped", count_profile_skipped_tests(profile))
+
+      profile_xml.add_attribute("hostname", run_data.platform.target.nil? ? "" : run_data.platform.target.to_s)
+      # Author of the schema specified 8601, then went on to add
+      # a regex that requires no TZ
+      profile_xml.add_attribute("timestamp", Time.now.iso8601.slice(0, 19))
+
+      # These are empty but are just here to satisfy the schema
+      profile_xml.add_attribute("package", "")
+      profile_xml.add(REXML::Element.new("properties"))
+
+      profile_time = 0.0
+      profile.controls.each do |control|
+        control.results.each do |result|
+          profile_time += result.run_time
+          profile_xml.add(build_result_xml(profile.name, control, result))
+        end
+      end
+      profile_xml.add_attribute("time", "%.6f" % profile_time)
+
+      profile_xml.add(REXML::Element.new("system-out"))
+      profile_xml.add(REXML::Element.new("system-err"))
+
+      profile_xml
+    end
+
+    def build_result_xml(profile_name, control, result)
+      result_xml = REXML::Element.new("testcase")
+      result_xml.add_attribute("name", result.code_desc)
+      result_xml.add_attribute("classname", control.title.nil? ? "#{profile_name}.Anonymous" : "#{profile_name}.#{control.id}")
+
+      # <Nokogiri::XML::SyntaxError: 20:0: ERROR: Element 'testcase', attribute 'time': '4.9e-05' is not a valid value of the atomic type 'xs:decimal'.
+      # So, we format it.
+      result_xml.add_attribute("time", "%.6f" % result.run_time)
+
+      if result.status == "failed"
+        failure_element = REXML::Element.new("failure")
+        failure_element.add_attribute("message", result.message)
+        failure_element.add_attribute("type", result.resource_title&.to_s || "")
+        result_xml.add(failure_element)
+      elsif result.status == "skipped"
+        result_xml.add_element("skipped")
+      end
+
+      result_xml
+    end
+  end
+end

data/lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit/version.rb

@@ -0,0 +1,5 @@
+module InspecPlugins
+  module JUnitReporter
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/plugins/shared/core_plugin_test_helper.rb

@@ -50,22 +50,6 @@ module CorePluginFunctionalHelper
   include CorePluginBaseHelper
   include FunctionalHelper
 
-  # TODO: so much duplication! Remove everything we can!
-  require "train"
-  TRAIN_CONNECTION = Train.create("local", command_runner: :generic).connection
-
-  # TODO: remove me! it's in test/functional/helper.rb
-  def run_inspec_process(command_line, opts = {})
-    prefix = ""
-    if opts.key?(:prefix)
-      prefix = opts[:prefix]
-    elsif opts.key?(:env)
-      prefix = assemble_env_prefix opts[:env]
-    end
-
-    TRAIN_CONNECTION.run_command("#{prefix} #{exec_inspec} #{command_line}")
-  end
-
   # This helper does some fancy footwork to make InSpec think a plugin
   # under development is temporarily installed.
   # @param String command_line Invocation, without the word 'inspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-core
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.23.10
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
@@ -33,7 +33,7 @@ dependencies:
         version: 0.2.13
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.2.13
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -68,16 +68,22 @@ dependencies:
   name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +229,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -230,6 +239,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tty-table
   requirement: !ruby/object:Gem::Requirement
@@ -314,20 +326,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: htmlentities
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -342,20 +340,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: term-ansicolor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: train-core
   requirement: !ruby/object:Gem::Requirement
@@ -383,7 +367,6 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - LICENSE
-- README.md
 - etc/deprecations.json
 - etc/plugin_filters.json
 - inspec-core.gemspec
@@ -483,7 +466,6 @@ files:
 - lib/inspec/reporters/cli.rb
 - lib/inspec/reporters/json.rb
 - lib/inspec/reporters/json_automate.rb
-- lib/inspec/reporters/junit.rb
 - lib/inspec/reporters/yaml.rb
 - lib/inspec/require_loader.rb
 - lib/inspec/resource.rb
@@ -601,6 +583,8 @@ files:
 - lib/inspec/resources/vbscript.rb
 - lib/inspec/resources/virtualization.rb
 - lib/inspec/resources/windows_feature.rb
+- lib/inspec/resources/windows_firewall.rb
+- lib/inspec/resources/windows_firewall_rule.rb
 - lib/inspec/resources/windows_hotfix.rb
 - lib/inspec/resources/windows_registry_key.rb
 - lib/inspec/resources/windows_task.rb
@@ -660,6 +644,7 @@ files:
 - lib/inspec/utils/object_traversal.rb
 - lib/inspec/utils/parser.rb
 - lib/inspec/utils/pkey_reader.rb
+- lib/inspec/utils/run_data_filters.rb
 - lib/inspec/utils/simpleconfig.rb
 - lib/inspec/utils/spdx.rb
 - lib/inspec/utils/spdx.txt
@@ -740,6 +725,10 @@ files:
 - lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min.rb
 - lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/reporter.rb
 - lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/version.rb
+- lib/plugins/inspec-reporter-junit/README.md
+- lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit.rb
+- lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit/reporter.rb
+- lib/plugins/inspec-reporter-junit/lib/inspec-reporter-junit/version.rb
 - lib/plugins/shared/core_plugin_test_helper.rb
 - lib/plugins/things-for-train-integration.rb
 - lib/source_readers/flat.rb