ansible/hacking
Matt Martz 8d1cf7f266
Vendor distutils.version (#74644)
* Vendor distutils.version

* Fix import order. ci_complete

* remove distutils warning filter

* Don't remove warnings filter from importer

* ci_complete

* Add pylint config for preventing distutils.version

* Add changelog fragment
2021-05-11 12:33:51 -05:00
..
azp Rename hacking/shippable to hacking/azp. 2021-05-05 17:21:14 -07:00
backport Add a script for adding backport references 2020-05-07 21:44:13 -05:00
build_library Vendor distutils.version (#74644) 2021-05-11 12:33:51 -05:00
tests [facts] Differentiate CentOS vs CentOS Stream (#73034) 2021-01-13 17:54:04 -05:00
ticket_stubs Reword the ticket stub for collections (#63917) 2019-10-24 12:39:08 -05:00
ansible-profile Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
build-ansible.py Update default containers to 3.4.0. (#74415) 2021-04-25 21:25:32 -07:00
deprecated_issue_template.md Fix deprecated issue creator (#55327) 2019-04-15 15:28:25 -05:00
env-setup hacking: replace use of "which" with "command -v" (#71278) 2020-08-18 11:31:28 -04:00
env-setup.fish Do not set ANSIBLE_LIBRARY in env-setup.fish (#63688) 2019-10-18 10:56:19 -04:00
fix_test_syntax.py More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00
get_library.py More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00
README.md Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
report.py More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00
return_skeleton_generator.py More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00
test-module Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
test-module.py More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00

'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.