c0866c56b9
Due to the fact how dispatching works the 'authorization' property handler was not always invoked through Properties.gen_xml(), leading to a bug and an invalid test case: project-with-auth-properties.(yaml/xml) This change pushes the logic for determining if the object is a folder/multi-branch project from Properties.gen_xml() to the authorization() function itself. For that to work the authorization() function needed access to the top-level job object, which is now conditionally passed to each dispatched function as a keyword argument, if the function takes 'job_data' argument. Note that taking this argument is completely optional so no changes were required in other handlers. In the future the same approach could be taken to eliminate the hacks for 'uno-choice' in Parameters.gen_xml(). Additionally ModuleRegistry.dispatch() now merges the top-level job object with any template data before deep-formatting, so that job-level properties are now available in Jinja templates. A very nice use case is in project-with-auth-j2-yaml.yaml test case. Change-Id: I9a49de74055cd9acfdc87dbad1fc454548643e8f
README
Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML or JSON format and uses them to configure Jenkins. You can keep your job descriptions in human readable text format in a version control system to make changes and auditing easier. It also has a flexible template system, so creating many similarly configured jobs is easy.
To install:
$ pip install --user jenkins-job-builderOnline documentation:
Developers
Bug report:
Repository:
Cloning:
git clone https://opendev.org/jjb/jenkins-job-builder.gitInstall pre-commit from https://pre-commit.com/#intro in order to run some minimal testing on your commits.
A virtual environment is recommended for development. For example, Jenkins Job Builder may be installed from the top level directory:
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r test-requirements.txt -e .Patches are submitted via Gerrit at:
Please do not submit GitHub pull requests, they will be automatically closed.
Mailing list:
IRC:
#openstack-jjbon Freenode
More details on how you can contribute is available on our wiki at:
Writing a patch
We ask that all code submissions be pep8 and pyflakes clean. The easiest
way to do that is to run tox before submitting
code for review in Gerrit. It will run pep8 and
pyflakes in the same manner as the automated test suite
that will run on proposed patchsets.
When creating new YAML components, please observe the following style conventions:
- All YAML identifiers (including component names and arguments) should be lower-case and multiple word identifiers should use hyphens. E.g., "build-trigger".
- The Python functions that implement components should have the same name as the YAML keyword, but should use underscores instead of hyphens. E.g., "build_trigger".
This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation.
Unit Tests
Unit tests have been included and are in the tests
folder. Many unit tests samples are included as examples in our
documentation to ensure that examples are kept current with existing
behaviour. To run the unit tests, execute the command:
tox -e py34,py27- Note: View
tox.inito run tests on other versions of Python, generating the documentation and additionally for any special notes on running the test to validate documentation external URLs from behind proxies.
Installing without setup.py
For YAML support, you will need libyaml installed.
Mac OS X:
$ brew install libyamlThen install the required python packages using pip:
$ sudo pip install PyYAML python-jenkins