inspec/test/functional/inspec_check_test.rb

require "functional/helper"
require "tmpdir"

describe "inspec check" do
  include FunctionalHelper

  parallelize_me!

  describe "inspec check with json formatter" do
    it "can check a profile and produce valid JSON" do
      out = inspec("check " + example_profile + " --format json")

      JSON.parse(out.stdout)
      assert_exit_code 0, out
    end
  end

  describe "inspec check with special characters in path" do
    it "can check a profile with special characters in its path" do
      out = inspec("check " + File.join(profile_path, "{{special-path}}"))

      assert_exit_code 0, out
    end
  end

  describe "inspec check with skipping/failing a resource in FilterTable" do
    it "can check a profile containing resource exceptions" do
      out = inspec("check " + File.join(profile_path, "profile-with-resource-exceptions"))

      assert_exit_code 0, out
    end
  end

  describe "inspec check with a profile containing only_if" do
    it "ignores the `only_if`" do
      out = inspec("check " + File.join(profile_path, "only-if-os-nope"))

      assert_exit_code 0, out
    end
  end

  describe "inspec check with a aws profile" do
    it "ignore train connection error" do
      out = inspec("check " + File.join(examples_path, "profile-aws"))
      assert_exit_code 3, out
    end
  end

  describe "inspec check with a azure profile" do
    it "ignore train connection error" do
      out = inspec("check " + File.join(examples_path, "profile-azure"))

      assert_exit_code 3, out
    end
  end

  describe "inspec check with alternate cache dir" do
    it "writes to the alternate cache dir" do
      Dir.mktmpdir do |tmpdir|
        cache_dir = File.join(tmpdir, "inspec_check_test_cache")
        _(File.exist?(cache_dir)).must_equal false
        good_profile_path = File.join(repo_path, "test/fixtures/profiles/complete-profile")
        out = inspec("check #{good_profile_path} --vendor-cache #{cache_dir}")

        _(File.exist?(cache_dir)).must_equal true
        assert_exit_code 0, out
      end
    end
  end

  describe "inspec check for lockfile and dependencies" do
    it "can check a profile where a lock file is not required" do
      out = inspec("check " + File.join(profile_path, "profile-lock-notrequired"))

      assert_exit_code 0, out
    end

    it "can check a profile where a lock file is required" do
      out = inspec("check " + File.join(profile_path, "profile-lock-required"))

      _(out.stdout).must_include "profile needs to be vendored with `inspec vendor`."
      assert_exit_code 1, out
    end

    it "can check a profile where lock file and inspec.yml are in synnc" do
      out = inspec("check " + File.join(profile_path, "profile-lock-insync"))

      assert_exit_code 0, out
    end

    it "can check a profile where lock file and inspec.yml are in not synnc" do
      out = inspec("check " + File.join(profile_path, "profile-lock-outofsync"))

      _(out.stdout).must_include "inspec.yml and inspec.lock are out-of-sync. Please re-vendor with `inspec vendor`."
      _(out.stdout).must_include "Cannot find linux-baseline in lockfile. Please re-vendor with `inspec vendor`."
      assert_exit_code 1, out
    end
  end

  describe "inspec check with invalid `include_controls` reference" do
    it "raises an error matching /Cannot load 'invalid_name'/" do
      invalid_profile = File.join(profile_path, "invalid-include-controls")
      out = inspec("check " + invalid_profile)

      _(out.stderr).must_match(/Cannot load 'no_such_profile'/)
      _(out.stderr).must_match(/not listed as a dependency/)
      assert_exit_code 1, out
    end
  end

  describe "inspec check with unsatisfied runtime version constraint" do
    it "should enforce runtime version constraint" do
      out = inspec("check #{profile_path}/unsupported_inspec")
      _(out.stdout).must_include "The current inspec version #{Inspec::VERSION}"
      _(out.stdout).must_include ">= 99.0.0"
      assert_exit_code 1, out
    end
  end

  describe "inspec check also check for cookstyle offenses" do
    it "finds no offenses in a complete profile when --with-cookstyle option is provided" do
      skip if windows? # see #5723
      out = inspec("check #{profile_path}/complete-profile --with-cookstyle")
      _(out.stdout).must_match(/No errors, warnings, or offenses/)
      assert_exit_code 0, out
    end

    it "fails and returns offenses in a profile when --with-cookstyle option is provided" do
      skip if windows? # see #5723
      out = inspec("check #{profile_path}/inputs/metadata-basic --with-cookstyle")
      _(out.stdout).must_match(/1 offenses/)
      assert_exit_code 1, out
    end
  end
end