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
Vincent Bernat 4afc228108
hacking: replace use of "which" with "command -v" (#71278)
"command -v" is the POSIX compliant way to get the path to a command.
It returns the path to the command if it exists and exits with a
non-zero status when it does not, without any output. "which" is not
POSIX and it can have various different effects. With Zsh, it says
"python not found" on stdout.

See:
 - https://pubs.opengroup.org/onlinepubs/009695399/utilities/command.html

Signed-off-by: Vincent Bernat <vincent@bernat.ch>
4 years ago
..
backport Add a script for adding backport references 5 years ago
build_library Updates to docs build for new antsibull CLI 4 years ago
shippable Update hacking/shippable docs. 4 years ago
tests distribution: Add support for DragonFly (#70748) 4 years ago
ticket_stubs Reword the ticket stub for collections (#63917) 5 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 Collections docs generation (#59761) 4 years ago
deprecated_issue_template.md Fix deprecated issue creator (#55327) 6 years ago
env-setup hacking: replace use of "which" with "command -v" (#71278) 4 years ago
env-setup.fish Do not set ANSIBLE_LIBRARY in env-setup.fish (#63688) 5 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 More boilerplate fixes. (#70224) 4 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.