inspec-reporter-json-hdf 1.1.0.beta1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375c586fb5019a374276cbd7e78369e8297b75db012ade31ca84dbb607eae39c
-  data.tar.gz: 5b63861c6c0304e4800f1e98b81c5e4b66c85f3ba0c7fcfdc42732c4c21f322b
+  metadata.gz: 8da7e4c1184a9e40b656eae008bb8543953f15e5434f34573879b6954d78127d
+  data.tar.gz: cfefb74fbb00461b676e8a66813304c2e8bc91b032f0d7f91b68a59746788478
 SHA512:
-  metadata.gz: 37a2979dba233369c491e25404b21a5b1bcc8eae57c772f1125be4f4ac500fe43201334364b9f8f9b0501d1d590a13711e45c840635b8fe9ddba859e5d122675
-  data.tar.gz: 16b920add79bf353a0a4113f3af93cf701c449b5cdeabc35e0883e2ae14854c3c3eab83e0a0d82852b84a1742816061f53d3bb90df7a34c9b87ae25744e69910
+  metadata.gz: 98c3b8e63c00d6781611860254975a9df39b2e75e0974549d191bcf6ccf5eaceda8edc9bede018af9e7a76fa82d99940b82a00c1a582f15f4a3dbac43eafdc9c
+  data.tar.gz: ca7da3c2ff919a93b505ffa087edcd62b5f347a0296494bd41a7971e6004ed2708fb97976c239362962b8c47c8092f431db452766638070ed98fbed2d56e66ab

data/lib/inspec-reporter-json-hdf/reporter.rb

@@ -9,6 +9,8 @@ VALID_STATUSES = %w[passed failed].freeze
 
 DATE_FORMAT = '%Y-%m-%d'.freeze
 
+SUPPORTED_INCLUDE_TYPES = %w[csv xlsx].freeze
+
 module InspecPlugins::HdfReporter
   # Reporter Plugin Class
   class Reporter < Inspec.plugin(2, :reporter)
@@ -42,40 +44,24 @@ module InspecPlugins::HdfReporter
     private
 
     def apply_attestation(results, attestation)
-      if results.empty?
-        results = [{
-          "code_desc": 'Manually verified Status provided through attestation',
-          "run_time": 0.0,
-          "start_time": DateTime.now.to_s,
-          "status": attestation['status'],
-          "message": attestation_message(attestation)
-        }]
-      else
-        results.each do |result|
-          result[:message] = 'Automated test returned as passed.' if result[:status].eql?('passed')
-          result[:message] = result[:skip_message] if result[:status].eql?('skipped')
-
-          result[:status] = attestation['status']
-          result[:message] = result[:message] + attestation_message(attestation)
-
-          if result[:backtrace]
-            result[:message] = result[:message] + "\nbacktrace: #{result[:backtrace]}"
-            result[:backtrace] = nil
-          end
-        end
-      end
-      results
+      results << {
+        "code_desc": 'Manually verified Status provided through attestation',
+        "run_time": 0.0,
+        "start_time": DateTime.now.to_s,
+        "status": attestation['status'],
+        "message": attestation_message(attestation)
+      }
     end
 
     def attestation_message(attestation)
-      "
-       Attestation:
-       Status: #{attestation['status']}
-       Explanation: #{attestation['explanation']}
-       Updated: #{attestation['updated']}
-       Updated By: #{attestation['updated_by']}
-       Frequency: #{attestation['frequency']}
-       "
+      [
+       'Attestation:',
+       "Status: #{attestation['status']}",
+       "Explanation: #{attestation['explanation']}",
+       "Updated: #{attestation['updated']}",
+       "Updated By: #{attestation['updated_by']}",
+       "Frequency: #{attestation['frequency']}",
+       ].join("\n")
     end
 
     def attestation_expired?(date, frequency)
@@ -89,9 +75,9 @@ module InspecPlugins::HdfReporter
       when 'annually'
         parsed_date.next_year(1)
       when 'semiannually'
-        parsed_date.next_year(0.5)
+        parsed_date.next_month(6)
       when 'quarterly'
-        parsed_date.next_year(0.25)
+        parsed_date.next_month(3)
       when 'monthly'
         parsed_date.next_month(1)
       when 'every2weeks'
@@ -122,45 +108,46 @@ module InspecPlugins::HdfReporter
       status.is_a?(String) && VALID_STATUSES.include?(status.downcase)
     end
 
-    def collect_attestations
-      plugin_config = Inspec::Config.cached.fetch_plugin_config('inspec-reporter-json-hdf')
-      attestations = []
-      if plugin_config['include-attestations-file']
-        if File.exist?(plugin_config['include-attestations-file']['path'])
-          if plugin_config['include-attestations-file']['type'].eql?('csv')
-            sheet = Roo::Spreadsheet.open(plugin_config['include-attestations-file']['path'], extension: :csv).sheet(0)
-
-            attestations = sheet.parse(control_id: "Control_ID",
-                                       explanation: "Explanation",
-                                       frequency: "Frequency",
-                                       status: "Status",
-                                       updated: "Updated",
-                                       updated_by: "Updated_By",
-                                       clean:true
-                                       )
-          elsif plugin_config['include-attestations-file']['type'].eql?('xlsx')
-            sheet = Roo::Spreadsheet.open(plugin_config['include-attestations-file']['path'], extension: :xlsx).sheet(0)
-
-            attestations = sheet.parse(control_id: "Control_ID",
-                                       explanation: "Explanation",
-                                       frequency: "Frequency",
-                                       status: "Status",
-                                       updated: "Updated",
-                                       updated_by: "Updated_By",
-                                       clean:true
-                                       )
-            attestations.map do |h|
-              h[:updated] = h[:updated].to_s
-            end
-          else
-            puts 'Warning: Invalid `include-attestations-file` type provided. Supported types: csv, xlsx'
+    def parse_include_file(include_file)
+      if File.exist?(include_file['path'])
+        if SUPPORTED_INCLUDE_TYPES.include?(include_file['type'])
+          sheet = Roo::Spreadsheet.open(include_file['path'], extension: include_file['type'].to_sym ).sheet(0)
+          
+          attestations = sheet.parse(control_id: "Control_ID",
+                                     explanation: "Explanation",
+                                     frequency: "Frequency",
+                                     status: "Status",
+                                     updated: "Updated",
+                                     updated_by: "Updated_By",
+                                     clean:true
+                                     )
+          # Following is required to convert Datetime field returned by xlsx parser to string
+          attestations.map do |h|
+            h[:updated] = h[:updated].to_s
           end
         else
-          puts "Warning: Include Attestation File provided  '#{plugin_config['include-attestations-file']['path']}' not found."
+          puts "Warning: Invalid `include-attestations-file` type provided. Supported types: #{SUPPORTED_INCLUDE_TYPES.to_s}"
         end
+      else
+        puts "Warning: Include Attestation File provided  '#{include_file['path']}' not found."
       end
+      attestations || []
+    end
+
+    def collect_attestations
+      plugin_config = Inspec::Config.cached.fetch_plugin_config('inspec-reporter-json-hdf')
+      attestations = []
+
+      # Parse Attestations from include file.
+      attestations = parse_include_file(plugin_config['include-attestations-file']) if plugin_config['include-attestations-file']
+
       attestations.map!{ |x| x.transform_keys(&:to_s) }
-      attestations = attestations + (plugin_config['attestations'] || [])
+
+      # Merge inline Attestations from config file and `include file` with precedence to inline definitions.
+      attestations = (plugin_config['attestations'] || []) + attestations 
+      attestations.uniq! {|e| e['control_id'] }
+
+      # Remove Attestations records without status provided.
       attestations.reject! { |x| x['status'].eql?("") || x['status'].nil? }
 
       if attestations.empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-reporter-json-hdf
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta1
+  version: 1.1.1
 platform: ruby
 authors:
 - Rony Xavier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git-lite-version-bump
@@ -197,9 +197,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: