You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/hacking
Matt Clay 72e038e823
Remove `docs` and `examples` directories (#81011)
* Remove docs dir

* Updates to reflect docs removal

* Fix integration test

* Remove examples dir

* Updates to reflect examples removal

* Remove build_library and build-ansible.py

* Remove refs to build_library and build-ansible.py

* Remove obsolete template

* Remove obsolete template reference

* Remove the now obsolete rstcheck sanity test
11 months ago
..
azp Add work-around for old AZP jobs (#80339) 1 year ago
backport Add a script for adding backport references 4 years ago
tests Revert "Add a custom policy for hackers using ansible-test (#68535)" (#81120) 12 months ago
ticket_stubs No core irc meeting (#80811) 1 year ago
README.md Remove Python 3.9 support for the controller (#80973) 11 months ago
ansible-profile Use ansible.module_utils.common.text.converters (#80704) 1 year ago
create-bulk-issues.py Extend bulk issue creator (#80423) 1 year ago
deprecated_issue_template.md Fix deprecated issue creator (#55327) 5 years ago
env-setup Make "~/.ansible" path configurable (#76114) 2 years ago
env-setup.fish Honor `--quiet` parameter properly in fish shell (#77180) 2 years ago
report.py More boilerplate fixes. (#70224) 4 years ago
return_skeleton_generator.py Add missing space after keywords. (#78480) 2 years ago
test-module Rename python files in hacking/ directory to have .py suffix 5 years ago
test-module.py Use ansible.module_utils.common.text.converters (#80704) 1 year ago
update-sanity-requirements.py Set the minimum setuptools to 45.2.0 (#80649) 1 year 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 >= 3.10.

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