inspec/test/functional/inspec_json_profile_test.rb

# author: Dominik Richter
# author: Christoph Hartmann

require 'functional/helper'
require 'mixlib/shellout'

describe 'inspec json' do
  include FunctionalHelper

  it 'read the profile json' do
    out = inspec('json ' + example_profile)
    out.stderr.must_equal ''
    out.exit_status.must_equal 0
    s = out.stdout
    JSON.load(s).must_be_kind_of Hash
  end

  describe 'json profile data' do
    let(:json) { JSON.load(inspec('json ' + example_profile).stdout) }

    it 'has a generator name' do
      json['generator']['name'].must_equal 'inspec'
    end

    it 'has a generator inspec version' do
      json['generator']['version'].must_equal Inspec::VERSION
    end

    it 'has a name' do
      json['name'].must_equal 'profile'
    end

    it 'has a title' do
      json['title'].must_equal 'InSpec Example Profile'
    end

    it 'has a summary' do
      json['summary'].must_equal 'Demonstrates the use of InSpec Compliance Profile'
    end

    it 'has a version' do
      json['version'].must_equal '1.0.0'
    end

    it 'has a maintainer' do
      json['maintainer'].must_equal 'Chef Software, Inc.'
    end

    it 'has a copyright' do
      json['copyright'].must_equal 'Chef Software, Inc.'
    end

    it 'has controls' do
      json['controls'].length.must_equal 4
    end

    describe 'a control' do
      let(:control) { json['controls'].find { |x| x['id'] == 'tmp-1.0' } }

      it 'has a title' do
        control['title'].must_equal 'Create /tmp directory'
      end

      it 'has a description' do
        control['desc'].must_equal 'An optional description...'
      end

      it 'has an impact' do
        control['impact'].must_equal 0.7
      end

      it 'has a ref' do
        control['refs'].must_equal([{'ref' => 'Document A-12', 'url' => 'http://...'}])
      end

      it 'has a source location' do
        loc = File.join(example_profile, '/controls/example.rb')
        control['source_location']['ref'].must_equal loc
        control['source_location']['line'].must_equal 6
      end

      it 'has a the source code' do
        control['code'].must_match(/\Acontrol \"tmp-1.0\" do.*end\n\Z/m)
      end
    end
  end

  describe 'filter with --controls' do
    let(:out) { inspec('json ' + example_profile + ' --controls tmp-1.0') }

    it 'still succeeds' do
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
    end

    it 'only has one control included' do
      json = JSON.load(out.stdout)
      json['controls'].length.must_equal 1
      json['controls'][0]['id'].must_equal 'tmp-1.0'
      json['groups'].length.must_equal 1
      json['groups'][0]['id'].must_equal 'controls/example.rb'
    end
  end

  it 'writes json to file' do
    out = inspec('json ' + example_profile + ' --output ' + dst.path)
    out.stderr.must_equal ''
    out.exit_status.must_equal 0
    hm = JSON.load(File.read(dst.path))
    hm['name'].must_equal 'profile'
    hm['controls'].length.must_equal 4
  end

  describe 'json test for pax header archives' do
    let(:profile_tgz) { File.join(Dir.mktmpdir, "pax-profile-test.tar.gz") }

    it 'successfully reads a pax-formatted tar file' do
      # TODO: this needs updated to also support windows taring
      return if is_windows?
      files = Dir.glob("#{example_profile}/**/*").delete_if { |x| !File.file?(x) }
      relatives = files.map { |e| Pathname.new(e).relative_path_from(Pathname.new(example_profile)).to_s }

      cmd = Mixlib::ShellOut.new("tar --format=pax -czf #{profile_tgz} #{relatives.join(' ')}", cwd: example_profile)
      cmd.run_command
      cmd.error!

      out = inspec("json #{profile_tgz}")
      out.exit_status.must_equal 0
    end
  end

  describe 'inspec json with a inheritance profile' do
    let(:profile) { File.join(profile_path, 'export-json', 'empty-wrapper') }

    it 'can export a profile that uses inheritance' do
      out = inspec('json ' + profile)
      out.stderr.must_be_empty
      out.exit_status.must_equal 0

      # This will throw an exception if it is garbled
      json = JSON.load(out.stdout)
      # and here we verify (very passingly!) that is a structure we expect
      json.must_be_kind_of Hash

      json['controls'].each do |control|
        control['code'].empty?.must_equal false
      end
    end
  end

  describe 'inspec json does not write logs to STDOUT' do
    it 'can execute a profile with warn calls and parse STDOUT as valid JSON' do
      out = inspec('json ' + File.join(profile_path, 'warn_logs'))
      out.exit_status.must_equal 0
      JSON.load(out.stdout)
    end
  end

  describe 'inspec json with a profile containing only_if' do
    it 'ignores the `only_if`' do
      out = inspec('json ' + File.join(profile_path, 'only-if-os-nope'))
      out.exit_status.must_equal 0
    end
  end
end