Test-kitchen 1.23.0 Released!


#1

Ohai!

We're pleased to bring you the latest test-kitchen release, 1.23.0, which includes a fancy new feature brought to us by @coderanger. In short, life cycle hooks are ways to run arbitrary local/remote commands before/after kitchen phases. Read on for more details.

Life Cycle Hooks

The life cycle hooks system allows running commands before or after any phase
of Test Kitchen (create, converge, verify, or destroy). Commands can be
run either locally on your workstation (the default) or remotely on the test instance.

These hooks are configured under a new lifecycle: section in kitchen.yml:

lifecycle:
  pre_create: echo before
  post_create:
  - echo after
  - local: echo also after
  - remote: echo after but in the instance

You can also configure hooks on a single platform or suite:

platforms:
- name: ubuntu-18.04
  lifecycle:
    pre_converge:
    - remote: apt update

suites:
- name: default
  lifecycle:
    post_verify:
    - my_coverage_formatter

Local commands automatically get some environment variables with information
about which instance the hook is evaluating against:

  • KITCHEN_INSTANCE_NAME - The full name of the instance
  • KITCHEN_SUITE_NAME - The name of the suite of the instance
  • KITCHEN_PLATFORM_NAME - The name of the platform of the instance
  • KITCHEN_INSTANCE_HOSTNAME - The hostname of the instance as reported by the driver plugin

You can also pass additional configuration for local commands:

lifecycle:
  pre_converge:
  - local: ./setup.sh
    environment:
      API_KEY: asdf1234
    timeout: 60

Remote commands are normally not allowed during pre_create or post_destroy
hooks as there is generally no instance running at that point, but with pre_destroy
hooks you may want to use the skippable flag so as to not fail during kitchen test:

lifecycle:
  pre_destroy:
  - remote: myapp --unregister-license
    skippable: true