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.

History

Pilou 5fc9f3d219 module_common: handle None value for templar (#36651 ) * module_common: set required parameter templar Fix the following error (related to `b455901`): $ ./hacking/test-module -m ./lib/ansible/modules/system/ping.py -I ansible_python_interpreter=/usr/bin/python Traceback (most recent call last): File "./hacking/test-module", line 268, in <module> main() File "./hacking/test-module", line 249, in main (modfile, modname, module_style) = boilerplate_module(options.module_path, options.module_args, interpreters, options.check, options.filename) File "./hacking/test-module", line 152, in boilerplate_module task_vars=task_vars File "ansible/lib/ansible/executor/module_common.py", line 910, in modify_module environment=environment) File "ansible/lib/ansible/executor/module_common.py", line 736, in _find_module_utils shebang, interpreter = _get_shebang(u'/usr/bin/python', task_vars, templar) File "ansible/lib/ansible/executor/module_common.py", line 452, in _get_shebang interpreter = templar.template(task_vars[interpreter_config].strip()) AttributeError: 'NoneType' object has no attribute 'template' * module_common.modify_module: templar is required (cherry picked from commit `7908f78fa6`)		7 years ago
..
aws_config	Add new aws_waf_condition module (#33110 )	7 years ago
tests	Facts distribution clear linux 31501 (#32453 )	7 years ago
README.md	Deprecate tests used as filters (#32361 )	7 years ago
ansible_profile	start of 'profiling utils'	8 years ago
authors.sh	removed merges from count	9 years ago
cherrypick.py	Python 2.6 `str.format()` compatibility fixes.	7 years ago
env-setup	Speed up env-setup (#24133 )	8 years ago
env-setup.fish	Improve fish environment setup (#26151 )	7 years ago
fix_test_syntax.py	Fix failure to adjust my name when doing copy pasta (#33322 )	7 years ago
get_library.py	hacking/: PEP8 compliancy (#24683 )	8 years ago
metadata-tool.py	Python 2.6 `str.format()` compatibility fixes.	7 years ago
report.py	Replace exit() with sys.exit()	7 years ago
return_skeleton_generator.py	Use JSON returns values to create RETURN docs	7 years ago
test-module	module_common: handle None value for templar (#36651 )	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/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 -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.

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.

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.

Authors

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