Add unit tests for XLSXTool and add system tests in CI (#130)

* Tracking *.pdf in git-lfs

* Add tests for XLSXTool and restructure files/includes for testing

* Remove redundant requires

* Add tests to the build step of CI to run inspec_tools as an installed gem

* Accept chef license agreement

Author: Bialogs

.gitattributes

@@ -1,2 +1,3 @@
 *.xls filter=lfs diff=lfs merge=lfs -text
 *.xlsx filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text

.github/workflows/build.yml

@@ -46,3 +46,14 @@ jobs:
         run: |
           inspec_tools --version
           inspec_tools --help
+          inspec_tools xlsx2inspec -m examples/xlsx2inspec/mapping.cis.yml -x examples/cis.xlsx -p xlsx2inspec_test
+          inspec_tools summary -j examples/sample_json/rhel-simp.json -o summary.json -c
+          inspec_tools csv2inspec -c examples/csv2inspec/stig.csv -m examples/csv2inspec/mapping.yml -o csv2inspec_test
+          inspec_tools xccdf2inspec -x examples/xccdf2inspec/xccdf.xml -a lib/data/attributes.yml -o xccdf2inspec_test
+          inspec_tools pdf2inspec -p examples/CIS_Ubuntu_Linux_16.04_LTS_Benchmark_v1.0.0.pdf -o pdf2inspec_test
+          inspec_tools inspec2csv -j examples/sample_json/rhel-simp.json -o inspec2csv_test.csv
+          inspec_tools inspec2ckl -j examples/sample_json/rhel-simp.json -o inspec2ckl_test.ckl
+          inspec_tools inspec2xccdf -j examples/sample_json/rhel-simp.json -a lib/data/attributes.yml -o inspec2xccdf_test.xml
+          inspec_tools compliance -j examples/sample_json/single_control_results.json -f examples/sample_yaml/threshold.yaml
+        env:
+          CHEF_LICENSE: "accept"

examples/CIS_Ubuntu_Linux_16.04_LTS_Benchmark_v1.0.0.pdf

@@ -13,5 +13,5 @@ module InspecTools
   autoload :Inspec, 'inspec_tools/inspec'
   autoload :Summary, 'inspec_tools/summary'
   autoload :Threshold, 'inspec_tools/threshold'
-  autoload :XLSXTool, 'inspec_tools/xlsx.rb'
+  autoload :XLSXTool, 'inspec_tools/xlsx_tool'
 end

lib/inspec_tools.rb

@@ -3,10 +3,6 @@
 
 require 'inspec-objects'
 require 'inspec'
-require_relative 'version'
-
-require_relative '../utilities/inspec_util'
-require_relative '../utilities/csv_util'
 require_relative './plugin_cli.rb'
 
 # This tells the ruby cli app to use the same argument parsing as the plugin

lib/inspec_tools/cli.rb

@@ -1,9 +1,6 @@
 require 'yaml'
 require 'json'
-
 require 'roo'
-require_relative 'version'
-
 require_relative '../utilities/inspec_util'
 require_relative '../utilities/csv_util'
 
@@ -17,7 +14,7 @@ module InspecTools
   autoload :Inspec, 'inspec_tools/inspec'
   autoload :Summary, 'inspec_tools/summary'
   autoload :Threshold, 'inspec_tools/threshold'
-  autoload :XLSXTool, 'inspec_tools/xlsx'
+  autoload :XLSXTool, 'inspec_tools/xlsx_tool'
 end
 
 # rubocop:disable Style/GuardClause

lib/inspec_tools/plugin_cli.rb

@@ -3,6 +3,7 @@
 require 'word_wrap'
 require 'yaml'
 require 'digest'
+require 'roo'
 
 require_relative '../utilities/inspec_util'
 
@@ -51,7 +52,7 @@ def get_cis_to_nist_control_mapping(spreadsheet)
         if row[3].is_a? Numeric
           cis_to_nist[row[3].to_s] = row[0]
         else
-          cis2Nist[row[2].to_s] = row[0] unless (row[2] == '') || row[2].to_i.nil?
+          cis_to_nist[row[2].to_s] = row[0] unless (row[2] == '') || row[2].to_i.nil?
         end
       end
       cis_to_nist
@@ -70,7 +71,7 @@ def insert_json_metadata
       @profile['attributes'] = []
       @profile['generator'] = {
         'name': 'inspec_tools',
-        'version': VERSION
+        'version': ::InspecTools::VERSION
       }
     end
 
@@ -122,10 +123,10 @@ def apply_cis_and_nist_controls(control, cis_tags)
 
       if cis_tags[:sub_section].nil? || cis_tags[:sub_section].blank?
         control['tags']['cis_controls'] << cis_tags[:section]
-        control['tags']['nist'] << get_nist_control_for_cis([cis_tags[:section]])
+        control['tags']['nist'] << get_nist_control_for_cis(cis_tags[:section])
       else
         control['tags']['cis_controls'] << "#{cis_tags[:section]}.#{cis_tags[:sub_section]}"
-        control['tags']['nist'] << get_nist_control_for_cis([cis_tags[:section], cis_tags[:sub_section]])
+        control['tags']['nist'] << get_nist_control_for_cis(cis_tags[:section], cis_tags[:sub_section])
       end
 
       control['tags']['nist'] << LATEST_NIST_REV unless control['tags']['nist'].nil?

lib/inspec_tools/xlsx.rb renamed to lib/inspec_tools/xlsx_tool.rb

@@ -0,0 +1,23 @@
+require_relative '../test_helper'
+require 'roo'
+require 'yaml'
+
+class XLSXToolTest < Minitest::Test
+  def setup
+    @xlsx = Roo::Spreadsheet.open('examples/cis.xlsx')
+    @mapping = YAML.load_file('examples/xlsx2inspec/mapping.cis.yml')
+  end
+
+  def test_that_xlsx_exists
+    refute_nil ::InspecTools::XLSXTool
+  end
+
+  def test_to_inspec
+    xlsx = InspecTools::XLSXTool.new(@xlsx, @mapping, 'test')
+    profile = xlsx.to_inspec('test')
+    assert_equal profile['name'], 'test'
+    assert_equal profile['generator'][:version], ::InspecTools::VERSION
+    assert_equal profile['controls'].first['tags']['nist'], ["IA-2 (1)", "Rev_4"]
+    assert_equal profile['controls'].first['tags']['cis_controls'], ["4.5", "Rev_7"]
+  end
+end

test/unit/inspec_tools/xlsx_tool_test.rb

@@ -1,6 +1,5 @@
 require 'simplecov'
 SimpleCov.start
 require 'minitest/autorun'
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-root = File.expand_path("../../", File.dirname(__FILE__))
-require "#{root}/lib/inspec_tools"
+$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+require 'inspec_tools'