abide_dev_utils 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0491c8fbcaa0a69015c410a2aa7e61ac61e6b30caca6fb5b334d22fd77069c
-  data.tar.gz: 119c837a5ea897957e63744ec3f38a7567222d7dbb5b952302ec71cd70aafc24
+  metadata.gz: 4c9b2c93e57d8e1ac68f08bc2d2135185591e0588e2403984e5d9eef6a6ff4e2
+  data.tar.gz: cd9e1a9a6b5020fe00e4390afde8b7717e28b1fb99eca9f868ea91ac03534c57
 SHA512:
-  metadata.gz: 492066b562bee8dd3c3d3b465396a569d66a66200018bb74e606c8f3a78320853ecc71a8f30ee0c4f18194dbdc0d8679ff8c32fd38fbaf7936267eae1b35d5eb
-  data.tar.gz: 2766d7c84c887b573cd9cb23f5d2aa869a4f238e5208ab2377832827e88d44056d180226a31c93ee242ed954d6aaf65b0e075d282b65ba53ea475ae1adb8e45a
+  metadata.gz: 7f0035231a3870d55f1e84f140eb315eb0169e2492d69debd0f5d469705bb5ea4848a0f2b753d4e933f9ccf9b1f18c9a7127d0c26bc2483fbbf21da91eb3982f
+  data.tar.gz: 6eb452f64cbfd4c58d3c37c3808b655c316d1f54adad53f246c0c9b86712a254162a06c0b452a9f94946056d177ee560afef50680c9967de826e826e25b86cf6

data/.github/workflows/ci.yaml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - '2.7'
+          - '3.2'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+
+      - name: Print bundle environment
+        run: |
+          echo ::group::bundler environment
+          bundle env
+          echo ::endgroup::
+
+      - name: Set up SSH agent
+        uses: webfactory/ssh-agent@v0.9.0
+        with:
+          ssh-private-key: |
+            ${{ secrets.LINUX_FIXTURE_KEY }}
+            ${{ secrets.WINDOWS_FIXTURE_KEY }}
+
+      - name: Get fixtures
+        run: bundle exec rake 'sce:fixtures'
+
+      - name: Run RSpec
+        run: bundle exec rake spec

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.17.1)
+    abide_dev_utils (0.18.0)
       cmdparse (~> 3.0)
       facterdb (>= 1.21)
       google-cloud-storage (~> 1.34)
       hashdiff (~> 1.0)
       jira-ruby (~> 2.2)
+      metadata-json-lint (~> 4.0)
       nokogiri (~> 1.13)
       puppet (>= 7.0.0)
       puppet-strings (>= 2.7)
@@ -128,20 +129,26 @@ GEM
       atlassian-jwt
       multipart-post
       oauth (~> 0.5, >= 0.5.0)
+    json-schema (4.1.1)
+      addressable (>= 2.8)
     jwt (2.7.1)
     locale (2.1.3)
     memoist (0.16.2)
+    metadata-json-lint (4.0.0)
+      json-schema (>= 2.8, < 5.0)
+      semantic_puppet (~> 1.0)
+      spdx-licenses (~> 1.0)
     method_source (1.0.0)
     mini_mime (1.1.2)
     minitest (5.19.0)
     multi_json (1.15.0)
     multipart-post (2.3.0)
     nio4r (2.5.8)
-    nokogiri (1.15.2-arm64-darwin)
+    nokogiri (1.15.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-darwin)
+    nokogiri (1.15.6-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-linux)
+    nokogiri (1.15.6-x86_64-linux)
       racc (~> 1.4)
     oauth (0.6.2)
       snaky_hash (~> 2.0)
@@ -192,7 +199,7 @@ GEM
     puppet-strings (4.0.0)
       rgen (~> 0.9)
       yard (~> 0.9)
-    racc (1.6.2)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -254,6 +261,7 @@ GEM
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
+    spdx-licenses (1.3.0)
     thor (1.2.2)
     timers (4.3.3)
     traces (0.11.1)
@@ -264,7 +272,7 @@ GEM
     unicode-display_width (2.1.0)
     version_gem (1.1.2)
     webrick (1.8.1)
-    yard (0.9.34)
+    yard (0.9.36)
 
 PLATFORMS
   arm64-darwin-22

data/Rakefile

@@ -4,7 +4,8 @@ require 'rake'
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+spec_task = RSpec::Core::RakeTask.new(:spec)
+spec_task.pattern = 'spec/abide_dev_utils_spec.rb,spec/abide_dev_utils/**/*_spec.rb'
 
 require "rubocop/rake_task"
 
@@ -12,29 +13,30 @@ RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
 
-namespace 'cem' do
-  directory 'spec/fixtures'
+MODULES = %w[puppetlabs-cem_linux puppetlabs-sce_linux puppetlabs-cem_windows puppetlabs-sce_windows].freeze
 
-  directory 'spec/fixtures/puppetlabs-cem_linux' do
-    sh 'git clone git@github.com:puppetlabs/puppetlabs-cem_linux.git spec/fixtures/puppetlabs-cem_linux'
+def modules_with_repos
+  @modules_with_repos ||= MODULES.select do |mod|
+    system("git ls-remote git@github.com:puppetlabs/#{mod}.git HEAD")
   end
-  file 'spec/fixtures/puppetlabs-cem_linux' => ['spec/fixtures']
+end
 
-  directory 'spec/fixtures/puppetlabs-cem_windows' do
-    sh 'git clone git@github.com:puppetlabs/puppetlabs-cem_windows.git spec/fixtures/puppetlabs-cem_windows'
-  end
-  file 'spec/fixtures/puppetlabs-cem_windows' => ['spec/fixtures']
-
-  task :fixture, [:cem_mod] do |_, args|
-    case args.cem_mod
-    when /linux/
-      Rake::Task['spec/fixtures/puppetlabs-cem_linux'].invoke
-    when /windows/
-      Rake::Task['spec/fixtures/puppetlabs-cem_windows'].invoke
-    else
-      raise "Unknown CEM module #{args.cem_mod}"
+namespace 'sce' do
+  directory 'spec/fixtures'
+  MODULES.each do |mod|
+    directory "spec/fixtures/#{mod}" do
+      sh "git clone git@github.com:puppetlabs/#{mod}.git spec/fixtures/#{mod}"
     end
   end
 
-  multitask fixtures: %w[spec/fixtures/puppetlabs-cem_linux spec/fixtures/puppetlabs-cem_windows]
+  task :fixture, [:sce_mod] do |_, args|
+    mod_name = MODULES.find { |m| m.match?(/#{args.sce_mod}/) }
+    raise "No fixture found matching #{args.sce_mod}" unless mod_name
+
+    Rake::Task[mod_name].invoke
+  end
+
+  multitask fixtures: modules_with_repos.map { |m| "spec/fixtures/#{m}" } do
+    puts "All fixtures are ready"
+  end
 end

data/abide_dev_utils.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -42,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google-cloud-storage', '~> 1.34'
   spec.add_dependency 'hashdiff', '~> 1.0'
   spec.add_dependency 'facterdb', '>= 1.21'
+  spec.add_dependency 'metadata-json-lint', '~> 4.0'
 
   # Dev dependencies
   spec.add_development_dependency 'bundler'
@@ -57,7 +59,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.9'
   spec.add_development_dependency 'rubocop-i18n', '~> 3.0'
   spec.add_development_dependency 'fast_gettext', '>= 2.0'
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/abide_dev_utils/cli/abstract.rb

@@ -7,12 +7,29 @@ module Abide
     # @abstract
     class AbideCommand < CmdParse::Command
       include AbideDevUtils::Config
+
       def initialize(cmd_name, cmd_short, cmd_long, **opts)
-        super(cmd_name, **opts)
+        super(cmd_name, takes_commands: opts.fetch(:takes_commands, false))
+        @deprecated = opts.fetch(:deprecated, false)
+        if @deprecated
+          cmd_short = "[DEPRECATED] #{cmd_short}"
+          cmd_long = "[DEPRECATED] #{cmd_long}"
+        end
         short_desc(cmd_short)
         long_desc(cmd_long)
         add_command(CmdParse::HelpCommand.new, default: true) if opts[:takes_commands]
       end
+
+      def on_after_add
+        return unless super_command.respond_to?(:deprecated?) && super_command.deprecated?
+
+        short_desc("[DEPRECATED BY PARENT] #{@short_desc}")
+        long_desc("[DEPRECATED BY PARENT] #{@long_desc}")
+      end
+
+      def deprecated?
+        @deprecated
+      end
     end
   end
 end

data/lib/abide_dev_utils/cli/comply.rb

@@ -10,7 +10,7 @@ module Abide
       CMD_SHORT = 'Commands related to Puppet Comply'
       CMD_LONG = 'Namespace for commands related to Puppet Comply'
       def initialize
-        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true, deprecated: true)
         add_command(ComplyReportCommand.new)
         add_command(ComplyCompareReportCommand.new)
       end
@@ -106,7 +106,10 @@ module Abide
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
         argument_desc(REPORT_A: CMD_REPORT_A, REPORT_B: CMD_REPORT_B)
         options.on('-u', '--upload-new', 'If you want to upload the new scan report') { @data[:upload] = true }
-        options.on('-s [STORAGE]', '--remote-storage [STORAGE]', 'Remote storage to upload the report to. (Only supports "gcloud")') { |x| @data[:remote_storage] = x }
+        options.on('-s [STORAGE]', '--remote-storage [STORAGE]',
+                   'Remote storage to upload the report to. (Only supports "gcloud")') do |x|
+          @data[:remote_storage] = x
+        end
         options.on('-r [NAME]', '--name [NAME]', 'The name to upload the report as') { |x| @data[:report_name] = x }
       end
 

data/lib/abide_dev_utils/cli/jira.rb

@@ -163,6 +163,11 @@ module Abide
         long_desc(CMD_LONG)
         argument_desc(PATH1: 'An XCCDF file', PATH2: 'An XCCDF file', PROJECT: 'A Jira project')
         options.on('-d', '--dry-run', 'Print to console instead of saving objects') { |_| @data[:dry_run] = true }
+        options.on('-z', '--print-only', 'Prints a list of issues that would be created. Implies dry-run, and auto-approve, but less verbose than --dry-run.') do
+          @data[:print_only] = true
+          @data[:dry_run] = true
+          @data[:auto_approve] = true
+        end
         options.on('-y', '--yes', 'Automatically approve all yes / no prompts') { |_| @data[:auto_approve] = true }
         options.on('-e [EPIC]', '--epic [EPIC]', 'If given, tasks will be created and assigned to this epic. Takes form <PROJECT>-<NUM>') { |e| @data[:epic] = e }
         options.on('-p [PROFILE]', '--profile', 'Only diff rules belonging to the matching profile. Takes a string that is treated as RegExp') do |x|
@@ -188,8 +193,9 @@ module Abide
           path2,
           epic: @data[:epic],
           dry_run: @data[:dry_run],
+          print_only: @data[:print_only],
           auto_approve: @data[:auto_approve],
-          diff_opts: @data[:diff_opts],
+          diff_opts: @data[:diff_opts] || {},
         )
       end
     end

data/lib/abide_dev_utils/cli/{cem.rb → sce.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'abide_dev_utils/cem'
+require 'abide_dev_utils/sce'
 require 'abide_dev_utils/files'
 require 'abide_dev_utils/output'
 require 'abide_dev_utils/validate'
@@ -9,30 +9,30 @@ require 'abide_dev_utils/cli/abstract'
 
 module Abide
   module CLI
-    class CemCommand < AbideCommand
-      CMD_NAME = 'cem'
-      CMD_SHORT = 'Commands related to Puppet CEM'
-      CMD_LONG = 'Namespace for commands related to Puppet CEM'
+    class SceCommand < AbideCommand
+      CMD_NAME = 'sce'
+      CMD_SHORT = 'Commands related to Puppet SCE'
+      CMD_LONG = 'Namespace for commands related to Puppet SCE'
       def initialize
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
-        add_command(CemGenerate.new)
-        add_command(CemUpdateConfig.new)
-        add_command(CemValidate.new)
+        add_command(SceGenerate.new)
+        add_command(SceUpdateConfig.new)
+        add_command(SceValidate.new)
       end
     end
 
-    class CemGenerate < AbideCommand
+    class SceGenerate < AbideCommand
       CMD_NAME = 'generate'
       CMD_SHORT = 'Holds subcommands for generating objects / files'
       CMD_LONG = 'Holds subcommands for generating objects / files'
       def initialize
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
-        add_command(CemGenerateCoverageReport.new)
-        add_command(CemGenerateReference.new)
+        add_command(SceGenerateCoverageReport.new)
+        add_command(SceGenerateReference.new)
       end
     end
 
-    class CemGenerateCoverageReport < AbideCommand
+    class SceGenerateCoverageReport < AbideCommand
       CMD_NAME = 'coverage-report'
       CMD_SHORT = 'Generates control coverage report'
       CMD_LONG = <<-EOLC.chomp
@@ -52,12 +52,13 @@ module Abide
           @data[:profile] = x
         end
         options.on('-L [LEVEL]', '--level [LEVEL]', 'Specify the level to show coverage for') do |l|
-          @data[:profile] = l
+          @data[:level] = l
         end
         options.on('-I', '--ignore-benchmark-errors', 'Ignores errors while generating benchmark reports') do
           @data[:ignore_all] = true
         end
-        options.on('-X [XCCDF_DIR]', '--xccdf-dir [XCCDF_DIR]', 'If specified, the coverage report will be correlated with info from the benchmark XCCDF files') do |d|
+        options.on('-X [XCCDF_DIR]', '--xccdf-dir [XCCDF_DIR]',
+                   'If specified, the coverage report will be correlated with info from the benchmark XCCDF files') do |d|
           @data[:xccdf_dir] = d
         end
         options.on('-v', '--verbose', 'Will output the report to the console') { @data[:verbose] = true }
@@ -74,10 +75,10 @@ module Abide
           profile: @data[:profile],
           level: @data[:level],
           ignore_benchmark_errors: @data.fetch(:ignore_all, false),
-          xccdf_dir: @data[:xccdf_dir],
+          xccdf_dir: @data[:xccdf_dir]
         }
         AbideDevUtils::Output.simple('Generating coverage report...') unless quiet
-        coverage = AbideDevUtils::CEM::Generate::CoverageReport.generate(format_func: :to_h, opts: generate_opts)
+        coverage = AbideDevUtils::Sce::Generate::CoverageReport.generate(format_func: :to_h, opts: generate_opts)
         AbideDevUtils::Output.simple("Saving coverage report to #{file_name}...")
         case out_format
         when /yaml/i
@@ -92,7 +93,7 @@ module Abide
       end
     end
 
-    class CemGenerateReference < AbideCommand
+    class SceGenerateReference < AbideCommand
       CMD_NAME = 'reference'
       CMD_SHORT = 'Generates a reference doc for the module'
       CMD_LONG = 'Generates a reference doc for the module'
@@ -113,35 +114,37 @@ module Abide
         options.on('-s', '--strict', 'Fails if there are any errors') do
           @data[:strict] = true
         end
-        options.on('-p [PROFILE]', '--select-profile [PROFILE]', 'The list of profiles that the reference.md will use separated by commas') do |pr|
+        options.on('-p [PROFILE]', '--select-profile [PROFILE]',
+                   'The list of profiles that the reference.md will use separated by commas') do |pr|
           @data[:select_profile] = pr.split(',')
         end
-        options.on('-l [LEVEL]', '--select-level [LEVEL]', 'The list of level that the reference.md will use separated by commas') do |l|
+        options.on('-l [LEVEL]', '--select-level [LEVEL]',
+                   'The list of level that the reference.md will use separated by commas') do |l|
           @data[:select_level] = l.split(',')
         end
       end
 
       def execute
         AbideDevUtils::Validate.puppet_module_directory
-        AbideDevUtils::CEM::Generate::Reference.generate(@data)
+        AbideDevUtils::Sce::Generate::Reference.generate(@data)
       end
     end
 
-    class CemUpdateConfig < AbideCommand
+    class SceUpdateConfig < AbideCommand
       CMD_NAME = 'update-config'
-      CMD_SHORT = 'Updates the Puppet CEM config'
-      CMD_LONG = 'Updates the Puppet CEM config'
+      CMD_SHORT = 'Updates the Puppet SCE config'
+      CMD_LONG = 'Updates the Puppet SCE config'
       def initialize
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
-        add_command(CemUpdateConfigFromDiff.new)
+        add_command(SceUpdateConfigFromDiff.new)
       end
     end
 
-    class CemUpdateConfigFromDiff < AbideCommand
+    class SceUpdateConfigFromDiff < AbideCommand
       CMD_NAME = 'from-diff'
       CMD_SHORT = 'Update by diffing two XCCDF files'
       CMD_LONG = 'Update by diffing two XCCDF files'
-      CMD_CONFIG_FILE = 'Path to the Puppet CEM config file'
+      CMD_CONFIG_FILE = 'Path to the Puppet SCE config file'
       CMD_CURRENT_XCCDF = 'Path to the current XCCDF file'
       CMD_NEW_XCCDF = 'Path to the new XCCDF file'
       def initialize
@@ -167,29 +170,29 @@ module Abide
         ARGHELP
       end
 
-      def execute(config_file, cur_xccdf, new_xccdf)
+      def execute(_config_file, _cur_xccdf, _new_xccdf)
         warn 'This command is currently non-functional'
         # AbideDevUtils::Validate.file(config_file, extension: 'yaml')
         # AbideDevUtils::Validate.file(cur_xccdf, extension: 'xml')
         # config_hiera = AbideDevUtils::Files::Reader.read(config_file, safe: true)
         # diff = AbideDevUtils::XCCDF::Diff::BenchmarkDiff.new(cur_xccdf, new_xccdf).diff[:diff][:number_title]
-        # new_config_hiera, change_report = AbideDevUtils::CEM.update_legacy_config_from_diff(config_hiera, diff)
+        # new_config_hiera, change_report = AbideDevUtils::Sce.update_legacy_config_from_diff(config_hiera, diff)
         # AbideDevUtils::Output.yaml(new_config_hiera, console: @data[:verbose], file: @data[:out_file])
         # AbideDevUtils::Output.simple(change_report) unless @data[:quiet]
       end
     end
 
-    class CemValidate < AbideCommand
+    class SceValidate < AbideCommand
       CMD_NAME = 'validate'
-      CMD_SHORT = 'Validation commands for CEM modules'
-      CMD_LONG = 'Validation commands for CEM modules'
+      CMD_SHORT = 'Validation commands for SCE modules'
+      CMD_LONG = 'Validation commands for SCE modules'
       def initialize
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
-        add_command(CemValidatePuppetStrings.new)
+        add_command(SceValidatePuppetStrings.new)
       end
     end
 
-    class CemValidatePuppetStrings < AbideCommand
+    class SceValidatePuppetStrings < AbideCommand
       CMD_NAME = 'puppet-strings'
       CMD_SHORT = 'Validates the Puppet Strings documentation'
       CMD_LONG = 'Validates the Puppet Strings documentation'
@@ -215,7 +218,7 @@ module Abide
       def execute
         @data[:format] ||= 'text'
         AbideDevUtils::Validate.puppet_module_directory
-        output = AbideDevUtils::CEM::Validate::Strings.validate(**@data)
+        output = AbideDevUtils::Sce::Validate::Strings.validate(**@data)
         has_errors = false
         has_warnings = false
         output.each do |_, i|
@@ -227,7 +230,7 @@ module Abide
           output,
           console: !@data[:quiet],
           file: @data[:out_file],
-          stringify: true,
+          stringify: true
         )
         exit 1 if has_errors || (has_warnings && @data[:strict])
       end

data/lib/abide_dev_utils/cli/test.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'abide_dev_utils/cli/abstract'
+
 module Abide
   module CLI
-    class TestCommand < CmdParse::Command
+    class TestCommand < AbideCommand
       CMD_NAME = 'test'
       CMD_SHORT = 'Run test suites against a Puppet module'
       CMD_LONG = 'Run various test suites against a Puppet module. Requires PDK to be installed.'
@@ -10,16 +12,25 @@ module Abide
       CMD_LIT_BASE = 'bundle exec rake'
 
       def initialize
-        super(CMD_NAME, takes_commands: false)
-        short_desc(CMD_SHORT)
-        long_desc(CMD_LONG)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false, deprecated: true)
         argument_desc(SUITE: 'Test suite to run [all, validate, unit, limus]')
-        options.on('-p', '--puppet-version', 'Set Puppet version for unit tests. Takes SemVer string') { |p| @data[:puppet] = p }
+        options.on('-p', '--puppet-version', 'Set Puppet version for unit tests. Takes SemVer string') do |p|
+          @data[:puppet] = p
+        end
         options.on('-e', '--pe-version', 'Set PE version for unit tests. Takes SemVer String') { |e| @data[:pe] = e }
-        options.on('-n', '--no-teardown', 'Do not tear down Litmus machines after tests') { |_| @data[:no_teardown] = true }
-        options.on('-c [puppet[67]]', '--collection [puppet[67]]', 'Puppet collection to use with litmus tests') { |c| @data[:collection] = c }
-        options.on('-l [LIST]', '--provision-list [LIST]', 'Set the provision list for Litmus') { |l| @data[:provision_list] = l }
-        options.on('-M [PATH]', '--module-dir [PATH]', 'Set a different directory as the module dir (defaults to current dir)') { |m| @data[:module_dir] = m }
+        options.on('-n', '--no-teardown', 'Do not tear down Litmus machines after tests') do |_|
+          @data[:no_teardown] = true
+        end
+        options.on('-c [puppet[67]]', '--collection [puppet[67]]', 'Puppet collection to use with litmus tests') do |c|
+          @data[:collection] = c
+        end
+        options.on('-l [LIST]', '--provision-list [LIST]', 'Set the provision list for Litmus') do |l|
+          @data[:provision_list] = l
+        end
+        options.on('-M [PATH]', '--module-dir [PATH]',
+                   'Set a different directory as the module dir (defaults to current dir)') do |m|
+          @data[:module_dir] = m
+        end
         # Declare and setup commands
         @validate = ['validate', '--parallel']
         @unit = ['test', 'unit', '--parallel']

data/lib/abide_dev_utils/cli/xccdf.rb

@@ -23,7 +23,7 @@ module Abide
     class XccdfGenMapCommand < AbideCommand
       CMD_NAME = 'gen-map'
       CMD_SHORT = 'Generates mappings from XCCDF files'
-      CMD_LONG = 'Generates mappings for CEM modules from 1 or more XCCDF files as YAML'
+      CMD_LONG = 'Generates mappings for SCE modules from 1 or more XCCDF files as YAML'
       CMD_XCCDF_FILES_ARG = 'One or more paths to XCCDF files'
       def initialize
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
@@ -31,7 +31,8 @@ module Abide
         options.on('-b [TYPE]', '--benchmark-type [TYPE]', 'XCCDF Benchmark type CIS by default') do |b|
           @data[:type] = b
         end
-        options.on('-d [DIR]', '--files-output-directory [DIR]', 'Directory to save files data/mappings by default') do |d|
+        options.on('-d [DIR]', '--files-output-directory [DIR]',
+                   'Directory to save files data/mappings by default') do |d|
           @data[:dir] = d
         end
         options.on('-V', '--version-output-dir', 'If saving to a directory, version the output directory') do
@@ -104,13 +105,16 @@ module Abide
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
         argument_desc(FILE1: CMD_FILE1_ARG, FILE2: CMD_FILE2_ARG)
         options.on('-o [PATH]', '--out-file', 'Save the report as a yaml file') { |x| @data[:outfile] = x }
-        options.on('-p [PROFILE]', '--profile', 'Only diff rules belonging to the matching profile. Takes a string that is treated as RegExp') do |x|
+        options.on('-p [PROFILE]', '--profile',
+                   'Only diff rules belonging to the matching profile. Takes a string that is treated as RegExp') do |x|
           @data[:profile] = x
         end
-        options.on('-l [LEVEL]', '--level', 'Only diff rules belonging to the matching level. Takes a string that is treated as RegExp') do |x|
+        options.on('-l [LEVEL]', '--level',
+                   'Only diff rules belonging to the matching level. Takes a string that is treated as RegExp') do |x|
           @data[:level] = x
         end
-        options.on('-i [PROPS]', '--ignore-changed-properties', 'Ignore changes to specified properties. Takes a comma-separated list.') do |x|
+        options.on('-i [PROPS]', '--ignore-changed-properties',
+                   'Ignore changes to specified properties. Takes a comma-separated list.') do |x|
           @data[:ignore_changed_properties] = x.split(',')
         end
         options.on('-r', '--raw', 'Output the diff in raw format') { @data[:raw] = true }

data/lib/abide_dev_utils/cli.rb

@@ -2,7 +2,7 @@
 
 require 'cmdparse'
 require 'abide_dev_utils/version'
-require 'abide_dev_utils/cli/cem'
+require 'abide_dev_utils/cli/sce'
 require 'abide_dev_utils/constants'
 require 'abide_dev_utils/cli/comply'
 require 'abide_dev_utils/cli/puppet'
@@ -15,6 +15,7 @@ module Abide
     include AbideDevUtils::CliConstants
     ROOT_CMD_NAME = 'abide'
     ROOT_CMD_BANNER = 'Developer tools for Abide'
+    DEPRECATED_COMMANDS = %w[comply test].freeze
 
     def self.new_parser
       parser = CmdParse::CommandParser.new(handle_exceptions: true)
@@ -23,7 +24,7 @@ module Abide
       parser.main_options.banner = ROOT_CMD_BANNER
       parser.add_command(CmdParse::HelpCommand.new, default: true)
       parser.add_command(CmdParse::VersionCommand.new(add_switches: true))
-      parser.add_command(CemCommand.new)
+      parser.add_command(SceCommand.new)
       parser.add_command(ComplyCommand.new)
       parser.add_command(PuppetCommand.new)
       parser.add_command(XccdfCommand.new)
@@ -32,9 +33,9 @@ module Abide
       parser
     end
 
-    def self.execute
+    def self.execute(argv = ARGV)
       parser = new_parser
-      parser.parse
+      parser.parse(argv)
     end
   end
 end

data/lib/abide_dev_utils/comply.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+### THIS CODE IS CURRENTLY UNSUPPORTED ###
+
 require 'json'
 require 'yaml'
 require 'selenium-webdriver'
@@ -208,15 +210,13 @@ module AbideDevUtils
       end
 
       def page_source
-        File.open(File.join(file_dir, "comply_error_#{Time.now.to_i}.txt"), 'w') { |f| f.write(driver.page_source) }
+        File.write(File.join(file_dir, "comply_error_#{Time.now.to_i}.txt"), driver.page_source)
       rescue Errno::ENOENT
         save_default = prompt.yes_no(
           "Directory #{file_dir} does not exist. Save page source to current directory?"
         )
         if save_default
-          File.open(File.join(File.expand_path('.'), "comply_error_#{Time.now.to_i}.html"), 'w') do |f|
-            f.write(driver.page_source)
-          end
+          File.write(File.join(File.expand_path('.'), "comply_error_#{Time.now.to_i}.html"), driver.page_source)
         end
       end
 
@@ -352,9 +352,7 @@ module AbideDevUtils
             if status.nil? || status.include?(chk_objs[1].downcase)
               name_parts = chk_objs[0].match(/^([0-9.]+) (.+)$/)
               key = normalize_cis_rec_name(name_parts[2])
-              unless report['scan_results'].key?(chk_objs[1])
-                report['scan_results'][chk_objs[1]] = {}
-              end
+              report['scan_results'][chk_objs[1]] = {} unless report['scan_results'].key?(chk_objs[1])
               report['scan_results'][chk_objs[1]][key] = {
                 'name' => name_parts[2].chomp,
                 'number' => name_parts[1].chomp
@@ -481,7 +479,7 @@ module AbideDevUtils
       def diff(other)
         diff = {}
         DIFF_PROPERTIES.each do |prop|
-          diff[prop] = send("#{prop.to_s}_equal?".to_sym, other.send(prop)) ? {} : property_diff(prop, other)
+          diff[prop] = send("#{prop}_equal?".to_sym, other.send(prop)) ? {} : property_diff(prop, other)
         end
         diff
       end
@@ -490,7 +488,7 @@ module AbideDevUtils
 
       def create_equality_methods
         DIFF_PROPERTIES.each do |prop|
-          meth_name = "#{prop.to_s}_equal?"
+          meth_name = "#{prop}_equal?"
           self.class.define_method(meth_name) do |other|
             property_equal?(prop, other)
           end