inspec 4.3.2 → 4.6.3

data/lib/plugins/inspec-habitat/templates/habitat/hooks/run.erb

@@ -10,13 +10,13 @@ PROFILE_PATH="{{pkg.path}}/{{pkg.name}}-{{pkg.version}}.tar.gz"
 
 while true; do
   echo "Executing ${PROFILE_IDENT}"
-  exec inspec exec ${PROFILE_PATH} --json-config ${CONFIG} 2>&1 | tee ${LOG_FILE}
+  exec <%= Inspec::Dist::EXEC_NAME %> exec ${PROFILE_PATH} --json-config ${CONFIG} 2>&1 | tee ${LOG_FILE}
 
   exit_code=$?
   if [ $exit_code -eq 1 ]; then
-    echo "InSpec run failed."
+    echo "<%= Inspec::Dist::PRODUCT_NAME %> run failed."
   else
-    echo "InSpec run completed successfully."
+    echo "<%= Inspec::Dist::PRODUCT_NAME %> run completed successfully."
     if [ $exit_code -eq 0 ]; then
       echo "No controls failed or were skipped."
     elif [ $exit_code -eq 100 ]; then

data/lib/plugins/inspec-habitat/templates/habitat/plan.sh.erb

@@ -18,7 +18,7 @@ do_before() {
     return 1
   fi
 
-  # Execute an 'inspec compliance login' if a profile needs to be fetched from
+  # Execute an '<%= Inspec::Dist::EXEC_NAME %> compliance login' if a profile needs to be fetched from
   # the Automate server
   if [ "$(grep "compliance: " "$PLAN_CONTEXT/../inspec.yml")" ]; then
     _do_compliance_login;
@@ -29,10 +29,10 @@ do_setup_environment() {
   set_buildtime_env PROFILE_CACHE_DIR "$HAB_CACHE_SRC_PATH/$pkg_dirname"
   set_buildtime_env ARCHIVE_NAME "$pkg_name-$pkg_version.tar.gz"
 
-  # InSpec loads `pry` which tries to expand `~`. This fails if HOME isn't set.
+  # <%= Inspec::Dist::PRODUCT_NAME %> loads `pry` which tries to expand `~`. This fails if HOME isn't set.
   set_runtime_env HOME "$pkg_svc_var_path"
 
-  # InSpec will create a `.inspec` directory in the user's home directory.
+  # <%= Inspec::Dist::PRODUCT_NAME %> will create a `.inspec` directory in the user's home directory.
   # This overrides that to write to a place within the running service's path.
   # NOTE: Setting HOME does the same currently. This is here to be explicit.
   set_runtime_env INSPEC_CONFIG_DIR  "$pkg_svc_var_path"
@@ -52,9 +52,9 @@ do_unpack() {
 }
 
 do_build() {
-  inspec archive "$PROFILE_CACHE_DIR" \
-                 --overwrite \
-                 -o "$PROFILE_CACHE_DIR/$ARCHIVE_NAME"
+  <%= Inspec::Dist::EXEC_NAME %> archive "$PROFILE_CACHE_DIR" \
+                                         --overwrite \
+                                         -o "$PROFILE_CACHE_DIR/$ARCHIVE_NAME"
 }
 
 do_install() {
@@ -63,7 +63,7 @@ do_install() {
 
 _do_compliance_login() {
   if [ -z $COMPLIANCE_CREDS ]; then
-    message="ERROR: Please perform an 'inspec compliance login' and set"
+    message="ERROR: Please perform an '<%= Inspec::Dist::EXEC_NAME %> compliance login' and set"
     message="$message \$HAB_STUDIO_SECRET_COMPLIANCE_CREDS to the contents of"
     message="$message '~/.inspec/compliance/config.json'"
     build_line "$message"
@@ -78,8 +78,8 @@ _do_compliance_login() {
                     sed 's/"//g'
                    )
   insecure=$(echo $COMPLIANCE_CREDS | jq .insecure)
-  inspec compliance login --insecure $insecure \
-                          --user $user \
-                          --token $token \
-                          $automate_server
+  <%= Inspec::Dist::EXEC_NAME %> compliance login --insecure $insecure \
+                                                  --user $user \
+                                                  --token $token \
+                                                  $automate_server
 }

data/lib/plugins/inspec-habitat/test/cookbooks/inspec_habitat_fixture/Berksfile

@@ -1,2 +1,2 @@
-source 'https://supermarket.chef.io'
+source "https://supermarket.chef.io"
 metadata

data/lib/plugins/inspec-habitat/test/cookbooks/inspec_habitat_fixture/metadata.rb

@@ -1,9 +1,9 @@
-name 'inspec_habitat_fixture'
-maintainer 'The Authors'
-maintainer_email 'you@example.com'
-license 'All Rights Reserved'
-description 'Used for testing the inspec-habitat plugin'
-version '0.1.0'
-chef_version '>= 13.0'
+name "inspec_habitat_fixture"
+maintainer "The Authors"
+maintainer_email "you@example.com"
+license "All Rights Reserved"
+description "Used for testing the inspec-habitat plugin"
+version "0.1.0"
+chef_version ">= 13.0"
 
-depends 'habitat'
+depends "habitat"

data/lib/plugins/inspec-habitat/test/cookbooks/inspec_habitat_fixture/recipes/default.rb

@@ -4,37 +4,37 @@
 #
 # Copyright:: 2019, The Authors, All Rights Reserved.
 
-package %w(ruby ruby-dev gcc g++ make expect)
+package %w{ruby ruby-dev gcc g++ make expect}
 
-base_dir = '/home/vagrant'
+base_dir = "/home/vagrant"
 
 cookbook_file "#{base_dir}/inspec-local.gem" do
-  source 'inspec-local.gem'
+  source "inspec-local.gem"
   action :create
 end
 
-gem_package 'inspec' do
+gem_package "inspec" do
   source "#{base_dir}/inspec-local.gem"
   subscribes :install, "cookbook_file[#{base_dir}/inspec-local.gem]", :immediately
 end
 
 cookbook_file "#{base_dir}/hab_setup.exp" do
-  source 'hab_setup.exp'
-  mode '0755'
+  source "hab_setup.exp"
+  mode "0755"
   action :create
 end
 
-hab_install 'install habitat'
-hab_sup 'setup hab supervisor'
+hab_install "install habitat"
+hab_sup "setup hab supervisor"
 
-execute 'setup hab cli' do
+execute "setup hab cli" do
   command "#{base_dir}/hab_setup.exp"
   live_stream true
-  not_if { ::File.exist?('/hab/etc/cli.toml') }
-  not_if { ::File.exist?('~/.hab/etc/cli.toml') }
+  not_if { ::File.exist?("/hab/etc/cli.toml") }
+  not_if { ::File.exist?("~/.hab/etc/cli.toml") }
 end
 
-execute 'create inspec profile for testing' do
+execute "create inspec profile for testing" do
   command "inspec init profile #{base_dir}/hab_test_profile"
   live_stream true
   creates "#{base_dir}/hab_test_profile"
@@ -42,20 +42,20 @@ end
 
 directory "#{base_dir}/output"
 
-execute 'create hart file from profile' do
+execute "create hart file from profile" do
   command "inspec habitat profile create #{base_dir}/hab_test_profile --output_dir '#{base_dir}/output'"
   live_stream true
   not_if "find #{base_dir}/output | grep vagrant-inspec-profile-hab_test_profile-0.1.0-.*.hart"
 end
 
-execute 'install vagrant/inspec-profile-hab_test_profile' do
+execute "install vagrant/inspec-profile-hab_test_profile" do
   command "hab pkg install #{base_dir}/output/*.hart"
   live_stream true
-  not_if 'hab pkg list --origin vagrant | grep inspec-profile'
+  not_if "hab pkg list --origin vagrant | grep inspec-profile"
 end
 
-execute 'load vagrant/inspec-profile-hab_test_profile into supervisor' do
-  command 'hab svc load vagrant/inspec-profile-hab_test_profile'
+execute "load vagrant/inspec-profile-hab_test_profile into supervisor" do
+  command "hab svc load vagrant/inspec-profile-hab_test_profile"
   live_stream true
   not_if 'sudo hab svc status | grep "vagrant/inspec-profile-hab_test_profile"'
 end

data/lib/plugins/inspec-habitat/test/functional/inspec_habitat_test.rb

@@ -1,13 +1,14 @@
-require_relative '../../../shared/core_plugin_test_helper.rb'
-require 'fileutils'
+require_relative "../../../shared/core_plugin_test_helper.rb"
+require "fileutils"
 
-class ProfileCli < MiniTest::Test
+class ProfileCli < Minitest::Test
   include CorePluginFunctionalHelper
 
   def setup
+    skip_windows!
     @tmpdir = Dir.mktmpdir
-    @habitat_profile = File.join(@tmpdir, 'habitat-profile')
-    run_inspec_process('init profile ' + @habitat_profile)
+    @habitat_profile = File.join(@tmpdir, "habitat-profile")
+    run_inspec_process("init profile " + @habitat_profile)
   end
 
   def teardown
@@ -15,14 +16,14 @@ class ProfileCli < MiniTest::Test
   end
 
   def test_setup_subcommand
-    result = run_inspec_process('habitat profile setup ' + @habitat_profile + ' --log-level debug')
+    result = run_inspec_process("habitat profile setup " + @habitat_profile + " --log-level debug")
 
     # Command runs without error
     assert_empty result.stderr
     assert_equal 0, result.exit_status
 
     # Command creates only expected files
-    base_dir = File.join(@tmpdir, 'habitat-profile', 'habitat')
+    base_dir = File.join(@tmpdir, "habitat-profile", "habitat")
     files = %w{
       default.toml
       plan.sh
@@ -31,7 +32,7 @@ class ProfileCli < MiniTest::Test
       hooks
       hooks/run
     }
-    actual_files = Dir.glob(File.join(base_dir, '**/*'))
+    actual_files = Dir.glob(File.join(base_dir, "**/*"))
     expected_files = files.map { |x| File.join(base_dir, x) }
     assert_equal actual_files.sort, expected_files.sort
   end

data/lib/plugins/inspec-habitat/test/integration/default/inspec_habitat/controls/inspec_habitat.rb

@@ -1,11 +1,11 @@
-control 'inspec-habitat-create' do
-  title 'Create command'
+control "inspec-habitat-create" do
+  title "Create command"
 
-  output_hart_dir = '/home/vagrant/output'
+  output_hart_dir = "/home/vagrant/output"
   find_hart_output = command("find #{output_hart_dir} -name '*.hart'").stdout
   hart_files = find_hart_output.split("\n")
 
-  hab_profile_path = '/home/vagrant/hab_test_profile'
+  hab_profile_path = "/home/vagrant/hab_test_profile"
   find_profile_files_command = "find #{hab_profile_path} -type f -printf '%f\n'"
   profile_files = command(find_profile_files_command).stdout.split("\n").sort
   expected_files = %w{
@@ -15,25 +15,25 @@ control 'inspec-habitat-create' do
     inspec.yml
   }
 
-  describe '`inspec habitat profile create`' do
-    it 'should create exactly 1 hart file' do
+  describe "`inspec habitat profile create`" do
+    it "should create exactly 1 hart file" do
       expect(hart_files.length).to eq(1)
     end
-    it 'does not add any extra files to a default generated profile' do
+    it "does not add any extra files to a default generated profile" do
       expect(profile_files).to eq(expected_files)
     end
   end
 end
 
-control 'inspec-habitat-service' do
-  title 'inspec-profile-hab_test_profile service'
-  describe 'The running service' do
-    it 'should create a log file' do
-      log = '/hab/svc/inspec-profile-hab_test_profile/logs/inspec_log.txt'
+control "inspec-habitat-service" do
+  title "inspec-profile-hab_test_profile service"
+  describe "The running service" do
+    it "should create a log file" do
+      log = "/hab/svc/inspec-profile-hab_test_profile/logs/inspec_log.txt"
       expect(file(log).exist?).to be(true)
     end
-    it 'should create a JSON file for the last run' do
-      log = '/hab/svc/inspec-profile-hab_test_profile/logs/inspec_last_run.json'
+    it "should create a JSON file for the last run" do
+      log = "/hab/svc/inspec-profile-hab_test_profile/logs/inspec_last_run.json"
       JSON.parse(file(log).content)
     end
   end

data/lib/plugins/inspec-habitat/test/support/example_profile/controls/example.rb

@@ -1,7 +1,7 @@
-control 'example' do
+control "example" do
   impact 0.7
-  title 'Example control'
-  describe 'example' do
-    it { should cmp 'example' }
+  title "Example control"
+  describe "example" do
+    it { should cmp "example" }
   end
 end

data/lib/plugins/inspec-habitat/test/unit/profile_test.rb

@@ -1,37 +1,38 @@
-require 'mixlib/log'
-require 'fileutils'
-require 'minitest/autorun'
-require_relative '../../lib/inspec-habitat/profile.rb'
+require "mixlib/log"
+require "fileutils"
+require "minitest/autorun"
+require "inspec/backend"
+require_relative "../../lib/inspec-habitat/profile.rb"
 
-class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
+class InspecPlugins::Habitat::ProfileTest < Minitest::Test
   def setup
     @tmpdir = Dir.mktmpdir
 
-    @output_dir = File.join(@tmpdir, 'output')
+    @output_dir = File.join(@tmpdir, "output")
     FileUtils.mkdir(@output_dir)
 
-    @fake_hart_file = FileUtils.touch(File.join(@tmpdir, 'fake-hart.hart'))[0]
+    @fake_hart_file = FileUtils.touch(File.join(@tmpdir, "fake-hart.hart"))[0]
 
     # Path from `__FILE__` needed to support running tests in `inspec/inspec`
     @test_profile_path = File.join(
       File.expand_path(File.dirname(__FILE__)),
-      '../',
-      'support',
-      'example_profile'
+      "../",
+      "support",
+      "example_profile"
     )
     @test_profile = Inspec::Profile.for_target(
       @test_profile_path,
-      backend: Inspec::Backend.create(Inspec::Config.mock),
+      backend: Inspec::Backend.create(Inspec::Config.mock)
     )
 
     @hab_profile = InspecPlugins::Habitat::Profile.new(
       @test_profile_path,
-      { output_dir: @output_dir },
+      { output_dir: @output_dir }
     )
 
     @mock_hab_config = {
-      'auth_token' => 'FAKETOKEN',
-      'origin' => 'fake_origin',
+      "auth_token" => "FAKETOKEN",
+      "origin" => "fake_origin",
     }
 
     Inspec::Log.level(:fatal)
@@ -45,9 +46,9 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
     profile = InspecPlugins::Habitat::Profile.new(
       @test_profile_path,
       {
-        output_dir: '/not/a/real/path',
-        log_level: 'fatal',
-      },
+        output_dir: "/not/a/real/path",
+        log_level: "fatal",
+      }
     )
 
     assert_raises(SystemExit) { profile.create }
@@ -55,7 +56,7 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_create
-    file_count = Dir.glob(File.join(@test_profile_path, '**/*')).count
+    file_count = Dir.glob(File.join(@test_profile_path, "**/*")).count
 
     @hab_profile.stub :read_habitat_config, @mock_hab_config do
       @hab_profile.stub :verify_habitat_setup, nil do
@@ -66,21 +67,21 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
     end
 
     # It should not modify target profile
-    new_file_count = Dir.glob(File.join(@test_profile_path, '**/*')).count
+    new_file_count = Dir.glob(File.join(@test_profile_path, "**/*")).count
     assert_equal new_file_count, file_count
 
     # It should create 1 Habitat artifact
-    output_files = Dir.glob(File.join(@output_dir, '**/*'))
+    output_files = Dir.glob(File.join(@output_dir, "**/*"))
     assert_equal 1, output_files.count
-    assert_equal 'fake-hart.hart', File.basename(output_files.first)
+    assert_equal "fake-hart.hart", File.basename(output_files.first)
   end
 
   def test_create_rasies_if_habitat_is_not_installed
-    cmd = MiniTest::Mock.new
+    cmd = Minitest::Mock.new
     cmd.expect(:error?, true)
     cmd.expect(:run_command, nil)
 
-    Mixlib::ShellOut.stub :new, cmd, 'hab --version' do
+    Mixlib::ShellOut.stub :new, cmd, "hab --version" do
       assert_raises(SystemExit) { @hab_profile.create }
       # TODO: Figure out how to capture and validate `Inspec::Log.error`
     end
@@ -107,8 +108,8 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_create_working_dir
-    Dir.stub :mktmpdir, '/tmp/fakedir' do
-      assert_equal '/tmp/fakedir', @hab_profile.send(:create_working_dir)
+    Dir.stub :mktmpdir, "/tmp/fakedir" do
+      assert_equal "/tmp/fakedir", @hab_profile.send(:create_working_dir)
     end
   end
 
@@ -132,7 +133,7 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
                                            @test_profile_path,
                                            @tmpdir)
 
-    dst = File.join(@tmpdir, 'working_dir')
+    dst = File.join(@tmpdir, "working_dir")
     FileUtils.mkdir_p(dst)
     @hab_profile.send(:copy_profile_to_working_dir, duplicated_profile, dst)
 
@@ -142,7 +143,7 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
       example.rb
     }
 
-    actual_files = Dir.glob(File.join(dst, '**/*')).map do |path|
+    actual_files = Dir.glob(File.join(dst, "**/*")).map do |path|
       next unless File.file?(path)
       File.basename(path)
     end.compact
@@ -151,24 +152,24 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_verify_profile_raises_if_profile_is_not_valid
-    bad_profile_path = File.join(@tmpdir, 'bad_profile')
+    bad_profile_path = File.join(@tmpdir, "bad_profile")
     FileUtils.mkdir_p(File.join(bad_profile_path))
-    FileUtils.touch(File.join(bad_profile_path, 'inspec.yml'))
+    FileUtils.touch(File.join(bad_profile_path, "inspec.yml"))
     bad_profile = Inspec::Profile.for_target(
       bad_profile_path,
-      backend: Inspec::Backend.create(Inspec::Config.mock),
+      backend: Inspec::Backend.create(Inspec::Config.mock)
     )
     assert_raises(SystemExit) { @hab_profile.send(:verify_profile, bad_profile) }
     # TODO: Figure out how to capture and validate `Inspec::Log.error`
   end
 
   def test_vendor_profile_dependencies_does_not_vendor_if_already_vendored
-    mock_lock_file = MiniTest::Mock.new
+    mock_lock_file = Minitest::Mock.new
     mock_lock_file.expect(:exist?, true)
-    mock_cache_path = MiniTest::Mock.new
+    mock_cache_path = Minitest::Mock.new
     mock_cache_path.expect(:exist?, true)
 
-    mock = MiniTest::Mock.new
+    mock = Minitest::Mock.new
     mock.expect(:lockfile, mock_lock_file)
     mock.expect(:cache_path, mock_cache_path)
 
@@ -180,10 +181,10 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_vendor_profile_dependencies
-    mock_lock_file = MiniTest::Mock.new
+    mock_lock_file = Minitest::Mock.new
     mock_lock_file.expect(:exist?, false)
 
-    mock = MiniTest::Mock.new
+    mock = Minitest::Mock.new
     mock.expect(:lockfile, mock_lock_file)
     mock.expect(:vendor!, nil)
     mock.expect(:make_readable, nil)
@@ -197,10 +198,10 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_verify_habitat_setup_raises_if_hab_version_errors
-    mock = MiniTest::Mock.new
+    mock = Minitest::Mock.new
     mock.expect(:run_command, nil)
     mock.expect(:error?, true)
-    mock.expect(:stderr, 'This would be an error message')
+    mock.expect(:stderr, "This would be an error message")
 
     Mixlib::ShellOut.stub(:new, mock) do
       assert_raises(SystemExit) { @hab_profile.send(:verify_habitat_setup, {}) }
@@ -210,7 +211,7 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   end
 
   def test_verify_habitat_setup_raises_if_not_habitat_origin
-    mock = MiniTest::Mock.new
+    mock = Minitest::Mock.new
     mock.expect(:run_command, nil)
     mock.expect(:error?, false)
 
@@ -226,11 +227,11 @@ class InspecPlugins::Habitat::ProfileTest < MiniTest::Unit::TestCase
   # end
 
   def test_upload_hart_raises_if_hab_pkg_upload_fails
-    mock = MiniTest::Mock.new
+    mock = Minitest::Mock.new
     mock.expect(:run_command, nil)
     mock.expect(:error?, true)
-    mock.expect(:stdout, 'This would contain output from `hab`')
-    mock.expect(:stderr, 'This would be an error message')
+    mock.expect(:stdout, "This would contain output from `hab`")
+    mock.expect(:stderr, "This would be an error message")
 
     Mixlib::ShellOut.stub(:new, mock) do
       assert_raises(SystemExit) { @hab_profile.send(:upload_hart, @fake_hart_file, {}) }