inspec-core 4.23.4 → 4.24.26

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

@@ -5,15 +5,15 @@ module InspecPlugins::JUnitReporter
     end
 
     def render
-      require "rexml/document"
+      require "rexml/document" unless defined?(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 do |profile|
-        testsuites.add(build_profile_xml(profile))
+      run_data.profiles.each_with_index do |profile, idx|
+        testsuites.add(build_profile_xml(profile, idx))
       end
 
       formatter = REXML::Formatters::Pretty.new
@@ -22,7 +22,42 @@ module InspecPlugins::JUnitReporter
       output(formatter.write(xml_output.root, ""))
     end
 
-    def build_profile_xml(profile)
+    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))
@@ -55,19 +90,66 @@ module InspecPlugins::JUnitReporter
 
       result_xml
     end
+  end
 
-    def count_profile_tests(profile)
-      profile.controls.reduce(0) do |acc, elem|
-        acc + elem.results.count
+  # 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 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
+    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/shared/core_plugin_test_helper.rb

@@ -3,14 +3,14 @@ require "minitest/autorun"
 require "minitest/pride"
 
 # Data formats commonly used in testing
-require "json"
-require "ostruct"
+require "json" unless defined?(JSON)
+require "ostruct" unless defined?(OpenStruct)
 
 # Utilities often needed
-require "fileutils"
-require "tmpdir"
-require "pathname"
-require "forwardable"
+require "fileutils" unless defined?(FileUtils)
+require "tmpdir" unless defined?(Dir.mktmpdir)
+require "pathname" unless defined?(Pathname)
+require "forwardable" unless defined?(Forwardable)
 
 require "functional/helper"
 require "inspec/plugin/v2"
@@ -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.23.4
+  version: 4.24.26
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
@@ -64,26 +64,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  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
@@ -108,36 +88,36 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -170,16 +150,22 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mixlib-log
   requirement: !ruby/object:Gem::Requirement
@@ -229,6 +215,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -236,6 +225,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: tty-table
   requirement: !ruby/object:Gem::Requirement
@@ -268,16 +260,22 @@ dependencies:
   name: tomlrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -296,16 +294,22 @@ dependencies:
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: semverse
   requirement: !ruby/object:Gem::Requirement
@@ -737,9 +741,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="