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
Brian Coca 74842adc07 1st part of ansible config, adds ansible-config to view/manage configs (#12797)
* Start of ansible config project

moved configuration definitions to external yaml file vs hardcoded
 * updated constants to be a data strcutures that are looped over and also return origin of setting
changed to manager/data scheme for base classes
new cli ansible-config to view/manage ansible configuration settings
 * prints green for default/unchanged and yellow for those that have been overriden
 * added list action to show all configurable settings and their associated ini and env var names
 * allows specifying config file to see what result would look like
 * TBD update, edit and view options

removed test for functions that have been removed

env_Vars are now list of dicts
allows for version_added and deprecation in future
added a couple of descriptions for future doc autogeneration
ensure test does not fail if delete_me exists
normalized 'path expansion'
added yaml config to setup packaging
removed unused imports
better encoding handling

updated as per feedback

* pep8
8 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 Switch tests to pytest and ansible-test. 8 years ago
ansible_profile start of 'profiling utils' 8 years ago
authors.sh removed merges from count 10 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 Fix spelling mistakes (comments only) (#25564) 8 years ago
test-module Allows for testing binary modules (#24857) 8 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 pyyaml jinja2 nose pytest passlib pycrypto

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.