ansible/hacking
Toshio Kuratomi 5392d8697d
Docs scripts cleanup (#59169)
* Fix dump_keywords to require attribute docs

* Change the documentation commands to make definition files positional

Since the definition files are mandatory, make them positional
parameters instead of options.
2019-07-17 12:01:07 -07:00
..
aws_config Fix EC2 test suite to work with testing policies (#44387) 2019-07-04 15:25:19 -04:00
build_library Docs scripts cleanup (#59169) 2019-07-17 12:01:07 -07:00
tests Get minor version number for CentOS and Debian (#57814) 2019-06-28 19:21:35 -04:00
ticket_stubs Add a ticket stub for guiding GitHub newcomers 2018-09-11 17:51:54 +02:00
ansible-profile Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
build-ansible.py Move common build code from _build_helpers (#55986) 2019-07-16 12:19:01 -07:00
cgroup_perf_recap_graph.py Perf graphing (#46346) 2019-01-08 13:29:22 -05:00
create_deprecated_issues.py Fix deprecated issue creator (#55327) 2019-04-15 15:28:25 -05:00
deprecated_issue_template.md Fix deprecated issue creator (#55327) 2019-04-15 15:28:25 -05:00
env-setup Make ansible-test available in the bin directory. (#45876) 2018-09-19 17:58:55 -07:00
env-setup.fish Fix "no matches for wildcard" error in env-setup.fish script. (#58345) 2019-06-27 18:15:11 -04:00
fix_test_syntax.py
get_library.py Surround top-level function and class definitions with two blank lines. 2018-07-31 12:06:56 -07:00
metadata-tool.py
README.md Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
report.py Don't require requests in hacking/report.py (#45350) 2018-09-07 11:51:41 -05:00
return_skeleton_generator.py Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -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 Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -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.