kitchen verify

In order to execute our test, we use the command kitchen verify:

$ kitchen verify default-ubuntu-2004
-----> Starting Test Kitchen (v2.5.2)
-----> Setting up <default-ubuntu-2004>...
       Finished setting up <default-ubuntu-2004> (0m0.00s).
-----> Verifying <default-ubuntu-2004>...
       Loaded tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"}

Profile: tests from {:path=>"/Users/tsmith/git_cookbook/test/integration/default"} (tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"})
Version: (not specified)
Target:  ssh://vagrant@127.0.0.1:2222

  System Package git
     ✔  is expected to be installed

Test Summary: 1 successful, 0 failures, 0 skipped
       Finished verifying <default-ubuntu-2004> (0m0.54s).
-----> Test Kitchen is finished. (0m2.76s)

A few things of note from the output above:

Verifying <default-ubuntu-2004> output corresponds to the start of the Verify Action
System Package git is expected to be installed is output from the Chef InSpec test

Pro Tip

If using a Bash-like shell, echo $? is will print the exit code of the last run shell command. This would show that the kitchen verify command exited cleanly with 0.

Let’s check the status of our instance again:

$ kitchen list
Instance             Driver   Provisioner  Verifier  Transport  Last Action  Last Error
default-ubuntu-2004  Vagrant  ChefZero     Inspec    Ssh        Verified     <None>

So what would a failing test look like? Let’s see. Open test/integration/default/default_test.rb and edit the test so that we’re testing that git is not installed:

describe package('git') do
  it { should_not be_installed }
end

And re-run the verify subcommand:

$ kitchen verify default-ubuntu-2004
-----> Starting Test Kitchen (v2.5.2)
-----> Verifying <default-ubuntu-2004>...
       Loaded tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"}

Profile: tests from {:path=>"/Users/tsmith/git_cookbook/test/integration/default"} (tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"})
Version: (not specified)
Target:  ssh://vagrant@127.0.0.1:2222

  System Package git
     ×  is expected not to be installed
     expected System Package git not to be installed

Test Summary: 0 successful, 1 failure, 0 skipped
>>>>>> ------Exception-------
>>>>>> Class: Kitchen::ActionFailed
>>>>>> Message: 1 actions failed.
>>>>>>     Verify failed on instance <default-ubuntu-2004>.  Please see .kitchen/logs/default-ubuntu-2004.log for more details
>>>>>> ----------------------
>>>>>> Please see .kitchen/logs/kitchen.log for more details
>>>>>> Also try running `kitchen diagnose --all` for configuration

Unsurprisingly, we get the message × is expected not to be installed and Test Kitchen throws an exception.

Let’s revert our forced failure:

describe package('git') do
  it { should be_installed }
end

Then verify our revert:

$ kitchen verify default-ubuntu-2004
-----> Starting Test Kitchen (v2.5.2)
-----> Verifying <default-ubuntu-2004>...
       Loaded tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"}

Profile: tests from {:path=>"/Users/tsmith/git_cookbook/test/integration/default"} (tests from {:path=>".Users.tsmith.git_cookbook.test.integration.default"})
Version: (not specified)
Target:  ssh://vagrant@127.0.0.1:2222

  System Package git
     ✔  is expected to be installed

Test Summary: 1 successful, 0 failures, 0 skipped
       Finished verifying <default-ubuntu-2004> (0m0.54s).
-----> Test Kitchen is finished. (0m2.40s)

One of the advantages of kitchen-inspec is that the Chef InSpec tests are executed from the host over the transport (SSH or WinRM) to the instance. No tests need to be uploaded to the instance itself.