inspec/test/functional/command_test.rb

# encoding: utf-8
# author: Dominik Richter
# author: Christoph Hartmann

require 'helper'
require 'minitest/hell'
class Minitest::Test
  parallelize_me!
end

describe 'Inspec::InspecCLI' do
  let(:repo_path) { File.expand_path(File.join( __FILE__, '..', '..', '..')) }
  let(:exec_inspec) { File.join(repo_path, 'bin', 'inspec') }
  let(:profile_path) { File.join(repo_path, 'test', 'unit', 'mock', 'profiles') }
  let(:examples_path) { File.join(repo_path, 'examples') }
  let(:dst) {
    # create a temporary path, but we only want an auto-clean helper
    # so remove the file and give back the path
    res = Tempfile.new('inspec-shred')
    FileUtils.rm(res.path)
    TMP_CACHE[res.path] = res
  }

  def inspec(commandline)
    CMD.run_command("#{exec_inspec} #{commandline}")
  end

  describe 'detect' do
    it 'runs well on all nodes' do
      out = inspec('detect')
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
      j = JSON.load(out.stdout)
      j.keys.must_include 'name'
      j.keys.must_include 'family'
      j.keys.must_include 'arch'
      j.keys.must_include 'release'
    end
  end

  describe 'version' do
    it 'provides the version number on stdout' do
      out = inspec('version')
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
      out.stdout.must_equal Inspec::VERSION+"\n"
    end
  end

  describe 'example profile' do
    let(:path) { File.join(examples_path, 'profile') }

    it 'check is successful' do
      out = inspec('check ' + path)
      out.stdout.must_match /Valid.*true/
      out.exit_status.must_equal 0
    end

    it 'archive is successful' do
      out = inspec('archive ' + path + ' --overwrite')
      out.exit_status.must_equal 0
      out.stdout.must_match /Generate archive [^ ]*profile.tar.gz/
      out.stdout.must_include 'Finished archive generation.'
    end

    it 'archives to output file' do
      out = inspec('archive ' + path + ' --output ' + dst.path)
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+dst.path
      out.stdout.must_include 'Finished archive generation.'
      out.exit_status.must_equal 0
      File.exist?(dst.path).must_equal true
    end

    it 'auto-archives when no --output is given' do
      auto_dst = File.join(repo_path, 'profile.tar.gz')
      out = inspec('archive ' + path + ' --overwrite')
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+auto_dst
      out.stdout.must_include 'Finished archive generation.'
      out.exit_status.must_equal 0
      File.exist?(auto_dst).must_equal true
    end

    it 'archive on invalid archive' do
      out = inspec('archive /proc --output ' + dst.path)
      # out.stdout.must_equal '' => we have partial stdout output right now
      out.stderr.must_include "Don't understand inspec profile in \"/proc\""
      out.exit_status.must_equal 1
      File.exist?(dst.path).must_equal false
    end

    it 'archive wont overwrite existing files' do
      x = rand.to_s
      File.write(dst.path, x)
      out = inspec('archive ' + path + ' --output ' + dst.path)
      out.stderr.must_equal '' # uh...
      out.stdout.must_include "Archive #{dst.path} exists already. Use --overwrite."
      out.exit_status.must_equal 1
      File.read(dst.path).must_equal x
    end

    it 'archive will overwrite files if necessary' do
      x = rand.to_s
      File.write(dst.path, x)
      out = inspec('archive ' + path + ' --output ' + dst.path + ' --overwrite')
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+dst.path
      out.exit_status.must_equal 0
      File.read(dst.path).wont_equal x
    end

    it 'creates valid tar.gz archives' do
      out = inspec('archive ' + path + ' --output ' + dst.path + ' --tar')
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+dst.path
      out.exit_status.must_equal 0
      t = Zlib::GzipReader.open(dst.path)
      Gem::Package::TarReader.new(t).entries.map(&:header).map(&:name).must_include 'inspec.yml'
    end

    it 'creates valid zip archives' do
      out = inspec('archive ' + path + ' --output ' + dst.path + ' --zip')
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+dst.path
      out.exit_status.must_equal 0
      Zip::File.new(dst.path).entries.map(&:name).must_include 'inspec.yml'
    end

    it 'read the profile json' do
      out = inspec('json ' + path)
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
      s = out.stdout
      hm = JSON.load(s)
      hm['name'].must_equal 'profile'
      hm['rules'].length.must_equal 2 # TODO: flatten out or search deeper!
    end

    it 'writes json to file' do
      out = inspec('json ' + path + ' --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['rules'].length.must_equal 2 # TODO: flatten out or search deeper!
    end

    it 'can execute the profile' do
      out = inspec('exec ' + path)
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
      out.stdout.must_match /^Pending: /
      out.stdout.must_include '3 examples, 0 failures, 1 pending'
    end
  end

  describe 'example inheritance profile' do
    let(:path) { File.join(examples_path, 'inheritance') }

    [
      'archive %s --overwrite',
      'check %s',
      'json %s',
    ].each do |cmd|
      it cmd[/^\w/] + ' fails without --profiles-path' do
        out = inspec(format(cmd, path))
        out.stderr.must_include 'You must supply a --profiles-path to inherit'
        # out.stdout.must_equal '' => we still get partial output
        out.exit_status.must_equal 1
      end
    end

    it 'check succeeds with --profiles-path' do
      out = inspec('check ' + path + ' --profiles-path ' + examples_path)
      out.stderr.must_equal ''
      out.stdout.must_match /Valid.*true/
      out.exit_status.must_equal 0
    end

    it 'archive is successful with --profiles-path' do
      out = inspec('archive ' + path + ' --output ' + dst.path + ' --profiles-path ' + examples_path)
      out.stderr.must_equal ''
      out.stdout.must_include 'Generate archive '+dst.path
      out.stdout.must_include 'Finished archive generation.'
      out.exit_status.must_equal 0
      File.exist?(dst.path).must_equal true
    end

    it 'read the profile json with --profiles-path' do
      out = inspec('json ' + path + ' --profiles-path '+examples_path)
      out.stderr.must_equal ''
      out.exit_status.must_equal 0
      s = out.stdout
      hm = JSON.load(s)
      hm['name'].must_equal 'inheritance'
      hm['rules'].length.must_equal 1 # TODO: flatten out or search deeper!
    end
  end
end