4fe08441be
* Warn on tests used as filters * Update docs, add aliases for tests that fit more gramatically with test syntax * Fix rst formatting * Add successful filter, alias of success * Remove renamed_deprecation, it was overkill * Make directory alias for is_dir * Update tests to use proper jinja test syntax * Update additional documentation, living outside of YAML files, to reflect proper jinja test syntax * Add conversion script, porting guide updates, and changelog updates * Update newly added uses of tests as filters * No underscore variable * Convert recent tests as filter changes to win_stat * Fix some changes related to rebasing a few integration tests * Make tests_as_filters_warning explicitly accept the name of the test, instead of inferring the name * Add test for tests_as_filters_warning * Update tests as filters in newly added/modified tests * Address recent changes to several integration tests * Address recent changes in cs_vpc |
7 years ago | |
|---|---|---|
| .. | ||
| aws_config | 7 years ago | |
| tests | 7 years ago | |
| README.md | 7 years ago | |
| ansible_profile | 7 years ago | |
| authors.sh | 9 years ago | |
| cherrypick.py | 7 years ago | |
| env-setup | 8 years ago | |
| env-setup.fish | 7 years ago | |
| fix_test_syntax.py | 7 years ago | |
| get_library.py | 7 years ago | |
| metadata-tool.py | 7 years ago | |
| report.py | 7 years ago | |
| return_skeleton_generator.py | 7 years ago | |
| test-module | 7 years ago | |
| update.sh | 10 years ago | |
| update_bundled.py | 8 years ago | |
| yamlcheck.py | 8 years ago | |
README.md
'Hacking' directory tools
Env-setup
The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python 2.6+. (You may not use python 3 at this time).
First, set up your environment to run from the checkout:
$ source ./hacking/env-setup
You will need some basic prerequisites installed. If you do not already have them and do not wish to install them from your operating system package manager, you can install them from pip
$ easy_install pip # if pip is not already available
$ pip install -r requirements.txt
From there, follow ansible instructions on docs.ansible.com as normal.
Test-module
'test-module' is a simple program that allows module developers (or testers) to run a module outside of the ansible program, locally, on the current machine.
Example:
$ ./hacking/test-module -m lib/ansible/modules/commands/command.py -a "echo hi"
This is a good way to insert a breakpoint into a module, for instance.
For more complex arguments such as the following yaml:
parent:
child:
- item: first
val: foo
- item: second
val: boo
Use:
$ ./hacking/test-module -m module \
-a '{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}'
return_skeleton_generator.py
return_skeleton_generator.py helps in generating the RETURNS section of a module. It takes JSON output of a module provided either as a file argument or via stdin.
Module-formatter
The module formatter is a script used to generate manpages and online module documentation. This is used by the system makefiles and rarely needs to be run directly.
fix_test_syntax.py
A script to assist in the conversion for tests using filter syntax to proper jinja test syntax. This script has been used to convert all of the Ansible integration tests to the correct format for the 2.5 release. There are a few limitations documented, and all changes made by this script should be evaluated for correctness before executing the modified playbooks.
Authors
'authors' is a simple script that generates a list of everyone who has contributed code to the ansible repository.