e4edb2842a
* patched in changelog gen stuff from stable-2.5 * Makefile updates * release.py as single-source-of-truth * Remove obsolete ansible-core-sitemap.xml file. * Move ROADMAP.rst into README.rst. * dynamic rpm changelog, zap old deb/rpm changelogs * fix changelog in MANIFEST.in * Remove obsolete hacking/update.sh script. * Remove ref to deleted authors script. * Remove ref to removed module-formatter script. * Update headings to match script names. * MANIFEST.in cleanup * removed RELEASES.txt and versions.yml * removed obsolete release generation playbook/bits (not used since 2.5) * misc Makefile cleanup * speculative changes to DEB versioning * allow override of DEB_VERSION/DEB_RELEASE
62 lines
1.9 KiB
Markdown
62 lines
1.9 KiB
Markdown
'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:
|
|
|
|
```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.
|
|
|
|
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.
|