ansible/test/integration
Toshio Kuratomi 1efe782b46 Refactor parsing of CLI args so that we can modify them in the base class
Implement tag and skip_tag handling in the CLI() class.  Change tag and
skip_tag command line options to be accepted multiple times on the CLI
and add them together rather than overwrite.

* Make it configurable whether to merge or overwrite multiple --tags arguments
* Make the base CLI class an abstractbaseclass so we can implement
  functionality in parse() but still make subclasses implement it.
* Deprecate the overwrite feature of --tags with a message that the
  default will change in 2.4 and go away in 2.5.

* Add documentation for merge_multiple_cli_flags
* Fix galaxy search so its tags argument does not conflict with generic tags
* Unit tests and more integration tests for tags
2016-10-06 10:46:58 -04:00
..
group_vars
host_vars breaks testing in non virtual envs, since env var can be used in those 2015-11-12 09:40:43 -08:00
library Add GPL3 header to helloworld.go 2016-05-12 12:25:09 -05:00
lookup_paths corrected on delete also 2015-08-13 09:58:30 -04:00
roles bugfixes to JSON junk filter, added unit/integration tests to exercise (#17834) 2016-10-02 08:03:42 -07:00
test_blocks Mark tasks expected to fail with EXPECTED FAILURE. 2016-05-31 11:29:04 -07:00
vars Add unicode characters to the data that we're testing that ansible-vault can decrypt 2015-08-25 15:14:43 -07:00
all.yml
amazon.yml Switch tests from sudo to become. (#17694) 2016-09-21 13:58:35 -07:00
azure.yml add azure integration tests 2015-05-04 23:45:03 -04:00
bad_parsing.yml
check_mode.yml Rework the shell quoting of remote checksumming 2015-03-02 15:42:18 -08:00
cleanup_azure.py add azure integration tests 2015-05-04 23:45:03 -04:00
cleanup_ec2.py Support print() function in test/ 2015-08-27 22:15:57 +03:00
cleanup_gce.py Support print() function in test/ 2015-08-27 22:15:57 +03:00
cleanup_rax.py Fix assert statement syntax 2015-08-27 22:15:57 +03:00
cloudflare.yml Add integration tests for the cloudflare_dns module 2016-03-25 21:22:29 +01:00
cloudstack.yml cloudstack: new integration tests test_cs_resourcelimit 2016-03-15 21:41:08 +01:00
consul.yml Initial commit of Ansible support for the Consul clustering framework (http://consul.io). 2015-01-24 01:09:03 +00:00
consul_inventory.yml Initial commit of Ansible support for the Consul clustering framework (http://consul.io). 2015-01-24 01:09:03 +00:00
consul_running.py Support print() function in test/ 2015-08-27 22:15:57 +03:00
credentials.template Changes to enable make gce to run. Added sys import so libcloud error is displayed; renamed credentials keys in template file so they work properly with gce_credentials.py. (#16607) 2016-09-16 10:02:18 -04:00
destructive.yml Disable privileged mode on Shippable. (#17844) 2016-09-30 22:06:28 -07:00
download_binary_modules.yml Add binary module tests to Windows CI. (#16914) 2016-08-02 10:42:07 -07:00
exoscale.yml exo_dns: new module utils and integration tests for exoscale DNS (#17230) 2016-08-30 21:48:28 +02:00
galaxy_playbook.yml
galaxy_playbook_git.yml [hotfix] add missed playbook file 2016-01-21 14:08:26 +02:00
galaxy_roles.yml Add tests for #10620 2015-11-18 20:47:54 +10:00
galaxy_rolesfile Add tests for #10620 2015-11-18 20:47:54 +10:00
gce.yml Integration Playbook for Google Cloud DNS module. (#17698) 2016-09-22 14:40:57 -04:00
gce_credentials.py Integration Playbook for Google Cloud DNS module. (#17698) 2016-09-22 14:40:57 -04:00
good_parsing.yml
integration_config.yml Fixes for WinRM/PowerShell support in v2. 2015-07-31 14:38:31 -04:00
inventory Add binary module tests to Windows CI. (#16914) 2016-08-02 10:42:07 -07:00
inventory.group_by
inventory.handlers
inventory.hosts_field Remove _load_hosts() from Play initialization as it's no longer needed and it breaks using extra_vars defining a list for hosts (#17699) 2016-09-21 17:25:54 -07:00
inventory.local re-integrate test_test_infra output checking 2016-03-18 10:14:22 -07:00
inventory.remote.template Add support for OS X CI on Shippable. (#17160) 2016-08-23 10:49:46 -07:00
inventory.winrm.template Add binary module tests to Windows CI. (#16914) 2016-08-02 10:42:07 -07:00
jenkins.yml jenkins_job: add integration tests (#17499) 2016-09-13 16:03:58 +02:00
lookup.ini Add documentation for the ini lookup plugin. 2015-08-05 11:09:40 +02:00
lookup.properties New lookup plugin : ini. Can handle ini file and java properties file. 2015-05-27 21:51:20 +02:00
Makefile Refactor parsing of CLI args so that we can modify them in the base class 2016-10-06 10:46:58 -04:00
no_log_local.yml removed redundant tests, adjusted makefile expected count 2015-10-02 22:37:19 -04:00
non_destructive.yml mv test_git to 'destructive' integration tests (#17526) 2016-09-29 13:46:34 -04:00
rackspace.yml Add tests for rax_scaling_group 2015-06-18 13:08:35 -05:00
README.md Remove run_tests.sh and update docs. (#17719) 2016-09-22 23:51:53 -07:00
setup_gce.py Support print() function in test/ 2015-08-27 22:15:57 +03:00
test_async.yml Increase async time limit on tests to 10 seconds. (#16921) 2016-08-02 13:30:26 -07:00
test_binary_modules.yml Add binary module tests to Windows CI. (#16914) 2016-08-02 10:42:07 -07:00
test_connection.inventory Add FreeBSD to Shippable CI. (#16883) 2016-08-01 13:46:37 -07:00
test_connection.yml raw now returns changed: true (#17112) 2016-08-16 20:39:23 -07:00
test_connection_winrm.yml raw now returns changed: true (#17112) 2016-08-16 20:39:23 -07:00
test_delegate_to.yml Fix remote_checksum with delegate_to and add tests for several ways that delegate_to works 2014-12-08 12:44:44 -08:00
test_environment.yml Fix YAML source and check it on Shippable (#15678) 2016-06-04 10:58:17 -07:00
test_filters.yml Fixing some small bugs related to integration tests (v2) 2015-06-01 16:42:10 -05:00
test_force_handlers.yml Lots of fixes for integration test bugs 2015-07-10 01:53:59 -04:00
test_gathering_facts.yml Make the fact gathering give a little more information on failure 2016-03-15 12:32:27 -07:00
test_group_by.yml Lots of fixes for integration test bugs 2015-07-10 01:53:59 -04:00
test_handlers.yml tests: checks that handlers work with loops 2015-07-20 14:41:03 +02:00
test_hash.yml fix default/main.yml to defaults/main.yml 2016-07-02 21:16:33 +09:00
test_hosts_field.json Remove _load_hosts() from Play initialization as it's no longer needed and it breaks using extra_vars defining a list for hosts (#17699) 2016-09-21 17:25:54 -07:00
test_hosts_field.yml Remove _load_hosts() from Play initialization as it's no longer needed and it breaks using extra_vars defining a list for hosts (#17699) 2016-09-21 17:25:54 -07:00
test_include_vars.yml Include vars updated to work with directories (#17207) 2016-08-30 14:34:31 -07:00
test_includes.yml Use loop_control.loop_var directly 2016-07-01 07:03:42 +05:30
test_includes2.yml added empty include test 2015-07-14 12:06:31 -04:00
test_includes3.yml Use loop_control.loop_var directly 2016-07-01 07:03:42 +05:30
test_includes4.yml Use loop_control.loop_var directly 2016-07-01 07:03:42 +05:30
test_lookup_properties.yml Add documentation for the ini lookup plugin. 2015-08-05 11:09:40 +02:00
test_setup.yml
test_tags.yml Refactor parsing of CLI args so that we can modify them in the base class 2016-10-06 10:46:58 -04:00
test_templating_settings.yml Proper git commit of the new integration test 2015-02-26 14:53:51 -08:00
test_test_infra.yml Mark tasks expected to fail with EXPECTED FAILURE. 2016-05-31 11:29:04 -07:00
test_var_precedence.yml reformated test, changed big assert to with_items 2015-12-01 21:11:12 -08:00
test_vault.yml Implement vault encrypted yaml variables. (#16274) 2016-08-23 20:03:11 -04:00
test_vault_embedded.yml Implement vault encrypted yaml variables. (#16274) 2016-08-23 20:03:11 -04:00
test_win_group1.yml Add Windows integration tests to Shippable. (#16803) 2016-07-28 21:03:14 -07:00
test_win_group2.yml add very basic tests of win_package, based on existing win_msi tests. (#17383) 2016-09-06 07:09:32 +01:00
test_win_group3.yml win_shell/win_command changes + tests (#17557) 2016-09-15 11:25:56 -07:00
unicode-test-script Fix problems with non-ascii values passed as part of the command to connection plugins 2016-01-04 20:35:25 -08:00
unicode.yml Fixes to the controller text model (#17527) 2016-09-12 12:57:41 -07:00
vars_file.yml Use default on undefined vars in tests. (#17601) 2016-09-15 16:07:55 -07:00
vault-password
vault-secret.txt feature/copy-vault-dataloader: Add method get_real_file(file_path) to dataloader 2016-04-14 14:12:48 -04:00

Integration tests

The ansible integration system.

Tests for playbooks, by playbooks.

Some tests may require credentials. Credentials may be specified with credentials.yml.

Tests should be run as root.

Quick Start

To get started quickly using Docker containers for testing, see Tests in Docker containers.

Configuration

Making your own version of integration_config.yml can allow for setting some tunable parameters to help run the tests better in your environment. Some tests (e.g. cloud) will only run when access credentials are provided. For more information about supported credentials, refer to credentials.template.

Prerequisites

The tests will assume things like hg, svn, and git are installed and in path.

(Complete list pending)

Non-destructive Tests

These tests will modify files in subdirectories, but will not do things that install or remove packages or things outside of those test subdirectories. They will also not reconfigure or bounce system services.

Run as follows:

make non_destructive

You can select specific tests with the --tags parameter.

TEST_FLAGS="--tags test_vars_blending" make

Destructive Tests

These tests are allowed to install and remove some trivial packages. You will likely want to devote these to a virtual environment. They won't reformat your filesystem, however :)

make destructive

Cloud Tests

Cloud tests exercise capabilities of cloud modules (e.g. ec2_key). These are not 'tests run in the cloud' so much as tests that leverage the cloud modules and are organized by cloud provider.

In order to run cloud tests, you must provide access credentials in a file named credentials.yml. A sample credentials file named credentials.template is available for syntax help.

Provide cloud credentials: cp credentials.template credentials.yml ${EDITOR:-vi} credentials.yml

Run the tests: make cloud

WARNING running cloud integration tests will create and destroy cloud resources. Running these tests may result in additional fees associated with your cloud account. Care is taken to ensure that created resources are removed. However, it is advisable to inspect your AWS console to ensure no unexpected resources are running.

Windows Tests

These tests exercise the winrm connection plugin and Windows modules. You'll need to define an inventory with a remote Windows 2008 or 2012 Server to use for testing, and enable PowerShell Remoting to continue.

Running these tests may result in changes to your Windows host, so don't run them against a production/critical Windows environment.

Enable PowerShell Remoting (run on the Windows host via Remote Desktop): Enable-PSRemoting -Force

Define Windows inventory: cp inventory.winrm.template inventory.winrm ${EDITOR:-vi} inventory.winrm

Run the tests: make test_winrm

Tests in Docker containers

If you have a Linux system with Docker installed, running integration tests using the same Docker containers used by the Ansible continuous integration (CI) system is recommended.

Using Docker Engine to run Docker on a non-Linux host is not recommended. Some tests, such as those that manage services or use local SSH connections are known to fail in such an environment. For best results, install Docker on a full Linux distribution such as Ubuntu, running on real hardware or in a virtual machine.

Running Integration Tests

To run all integration test targets with the default settings in a Centos 7 container, run make integration from the repository root.

You can also run specific tests or select a different Linux distribution. For example, to run the test test_ping from the non_destructive target on a Ubuntu 14.04 container:

  • go to the repository root
  • and execute make integration IMAGE=ansible/ansible:ubuntu1404 TARGET=non_destructive TEST_FLAGS='--tags test_ping'

Container Images

Use the prefix ansible/ansible: with the image names below.

Running make integration will automatically download the container image you have specified, if it is not already available. However, you will be responsible for keeping the container images up-to-date using docker pull.

Python 2

Most container images are for testing with Python 2:

  • centos6
  • centos7
  • fedora-rawhide
  • fedora23
  • opensuseleap
  • ubuntu1204 (requires PRIVILEGED=true)
  • ubuntu1404 (requires PRIVILEGED=true)
  • ubuntu1604

Python 3

To test with Python 3 you must set PYTHON3=1 and use the following images:

  • ubuntu1604py3

Additional Options

There are additional environment variables that can be used. A few of the more useful ones:

  • KEEP_CONTAINERS=onfailure - Containers will be preserved if tests fail.
  • KEEP_CONTAINERS=1 - Containers will always be preserved.
  • SHARE_SOURCE=1 - Changes to source from the host or container will be shared between host and container. CAUTION: Files created by the container will be owned by root on the host.