THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Felix Fontein 4393940a41 Docs formatting: recursively preprocess suboptions (#61900) 4 days ago
..
aws_config Fixup aws_secret integration tests (#61241) 6 days ago
build_library Docs formatting: recursively preprocess suboptions (#61900) 4 days ago
tests Get minor version number for CentOS and Debian (#57814) 2 months ago
ticket_stubs Add collections ticket stub (#62001) 1 week ago
README.md Rename python files in hacking/ directory to have .py suffix 2 months ago
ansible-profile Rename python files in hacking/ directory to have .py suffix 2 months ago
build-ansible.py create-deprecated-issues script can now add to a specified project (#61901) 6 days ago
cgroup_perf_recap_graph.py Perf graphing (#46346) 8 months ago
deprecated_issue_template.md Fix deprecated issue creator (#55327) 5 months ago
env-setup Make ansible-test available in the bin directory. (#45876) 1 year ago
env-setup.fish Fix "no matches for wildcard" error in env-setup.fish script. (#58345) 2 months ago
fix_test_syntax.py Fix failure to adjust my name when doing copy pasta (#33322) 1 year ago
get_library.py Surround top-level function and class definitions with two blank lines. 1 year ago
metadata-tool.py Use https for links to ansible.com domains. 1 year ago
report.py Include version_added in report.py (#61857) 1 week ago
return_skeleton_generator.py Rename python files in hacking/ directory to have .py suffix 2 months ago
test-module Rename python files in hacking/ directory to have .py suffix 2 months ago
test-module.py Support relative imports in AnsiballZ. (#61196) 2 weeks 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.py

‘test-module.py’ 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.py -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.py -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.

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.