ansible/hacking
Toshio Kuratomi 3ee997b720 metadata and doc generator optimization and fixes
* Fix ansible-doc traceback when a plugin doesn't parse correctly
* Change extract_metadata ivocation to take either an ast or source
  code.  When given source code, it can find file offsets for the start
  and end of dict.  When given the ast, it is quicker as it doesn't have
  to reparse the source.  Requires changing the call to the function to
  use a keyword arg.
* Fix reading of metadata to find the last occurrence of
  ANSIBLE_METADATA instead of the first.
* Add some more unittests to get closer to complete coverage
2017-07-04 01:12:43 -07:00
..
aws_config aws integration tests - provide an IAM policy for running (#24725) 2017-05-19 14:37:39 -07:00
tests hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
ansible_profile start of 'profiling utils' 2017-05-31 14:00:12 -04:00
authors.sh
cherrypick.py hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
conf2yaml.py 1st part of ansible config, adds ansible-config to view/manage configs (#12797) 2017-06-14 11:08:34 -04:00
env-setup Speed up env-setup (#24133) 2017-05-01 09:54:50 -05:00
env-setup.fish Fish hacking setup fix (#18084) 2016-10-24 10:35:00 -07:00
get_library.py hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
metadata-tool.py metadata and doc generator optimization and fixes 2017-07-04 01:12:43 -07:00
README.md Cyptography pr 20566 rebase (#25560) 2017-06-27 06:00:15 -07:00
test-module Fix hacking/test-module to allow running modules with pdb (#23339) 2017-06-28 10:58:22 -07:00
update.sh
update_bundled.py Clean up shebangs for various files. 2016-11-02 17:00:27 -07:00
yamlcheck.py Clean up shebangs for various files. 2016-11-02 17:00:27 -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

'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/shell -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 -m module \
    -a "{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}"

Module-formatter

The module formatter is a script used to generate manpages and online module documentation. This is used by the system makefiles and rarely needs to be run directly.

Authors

'authors' is a simple script that generates a list of everyone who has contributed code to the ansible repository.