icinga2/test/jenkins/README

Set of scripts to set up and test a virtual demo machine
========================================================

This directory contains a few scripts primarily used by build.icinga.org.

* bootstrap-vm.sh
  Ensures that all required software is installed and its configuration
  is applied to the VM. (Usually not of interest for the typical user.)

* run_tests.sh
  This is a wrapper script intended to be ran manually by a user. (Note
  that you need to start this project's vagrant box for this to work!)

* run_tests.py
  The actual test-runner. Accepts two options (-C|--config, -O|--output) and
  expects one or more filenames or -patterns that should be run on the VM.

* run_tests.conf
  The default configuration file for the test-runner. (Used when running
  the wrapper script or when no custom configuration file is passed to the
  test-runner.)

  Format:
  - commands: This section is mandatory and contains the commands to use.
  - settings: This section is mandatory and defines settings that are applied to
              all tests.
  - setups: This section is optional and contains setup routines that should
            be ran before (setup) and after (teardown) any matching test is
            executed. (Note that only one setup can be effective at a time.)

            Example:
            "^v[1-9]\.test$": {
                "setup": {
                    "copy": ["source >> target"], // Files that should be copied.
                                                  // Note that these files remain
                                                  // if not removed explicitly
                    "clean": ["target"], // Files to delete from the system
                    "exec": ["cmd1", "cmd2"] // Commands to execute on the system
                },
                "teardown": {
                    // The same kind of instructions as above can be added here
                }
            }