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
Pascal Höhnel 7cd94dd452
Fix unsafe handling of variable PYTHON_BIN (#76767)
The previous state lead to errors, when cloning the repo to a path with spaces in it.
3 years ago
..
azp hacking - account for job names that contain separators (#75454) 3 years ago
backport Add a script for adding backport references 5 years ago
build_library Allow docs-build to use a local ansible-build-data checkout. 3 years ago
tests Update vendored copy of distro to 1.6.0 (#75732) 3 years ago
ticket_stubs Fix markdown links that were errantly formatted as rst (#75697) 3 years ago
README.md Rename python files in hacking/ directory to have .py suffix 5 years ago
ansible-profile Rename python files in hacking/ directory to have .py suffix 5 years ago
build-ansible.py Update default containers to 3.4.0. (#74415) 4 years ago
deprecated_issue_template.md Fix deprecated issue creator (#55327) 6 years ago
env-setup Fix unsafe handling of variable PYTHON_BIN (#76767) 3 years ago
env-setup.fish Modernize install (#76021) 3 years ago
fix_test_syntax.py More boilerplate fixes. (#70224) 4 years ago
get_library.py More boilerplate fixes. (#70224) 4 years ago
report.py More boilerplate fixes. (#70224) 4 years ago
return_skeleton_generator.py More boilerplate fixes. (#70224) 4 years ago
test-module Rename python files in hacking/ directory to have .py suffix 5 years ago
test-module.py Cleanup hacking scripts to prepare for pylint update. (#75474) 3 years ago
update-sanity-requirements.py ansible-test - Update import test and sanity requirements. (#76308) 3 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.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/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.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.

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.