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
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
7 years ago
..
aws_config aws integration tests - provide an IAM policy for running (#24725) 8 years ago
tests hacking/: PEP8 compliancy (#24683) 8 years ago
README.md Cyptography pr 20566 rebase (#25560) 7 years ago
ansible_profile start of 'profiling utils' 8 years ago
authors.sh removed merges from count 9 years ago
cherrypick.py hacking/: PEP8 compliancy (#24683) 8 years ago
conf2yaml.py 1st part of ansible config, adds ansible-config to view/manage configs (#12797) 8 years ago
env-setup Speed up env-setup (#24133) 8 years ago
env-setup.fish Fish hacking setup fix (#18084) 8 years ago
get_library.py hacking/: PEP8 compliancy (#24683) 8 years ago
metadata-tool.py metadata and doc generator optimization and fixes 7 years ago
test-module Fix hacking/test-module to allow running modules with pdb (#23339) 7 years ago
update.sh Move update.sh to hacking repository ,see #10081 10 years ago
update_bundled.py Clean up shebangs for various files. 8 years ago
yamlcheck.py Clean up shebangs for various files. 8 years 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 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.