Adding Vagrantfile for local developer testing
This Vagrantfile attempts to replicate the gate check testing to the extent possible to allow developers to run all tests locally in a Vagrant environment prior to submitting changes for review. Contributor documentation updated to demonstrate usage of the Vagrantfile. Change-Id: I5f28e0cafc358b868d633acc0628a93b5cd0ab48
This commit is contained in:
parent
b5b767a5aa
commit
518e63de26
|
@ -60,3 +60,6 @@ releasenotes/build
|
||||||
|
|
||||||
# Test temp files
|
# Test temp files
|
||||||
tests/plugins
|
tests/plugins
|
||||||
|
|
||||||
|
# Vagrant testing artifacts
|
||||||
|
.vagrant
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
galera_client
|
OpenStack-Ansible Galera Client
|
||||||
########
|
###############################
|
||||||
:tags: openstack, cloud, ansible
|
:tags: openstack, cloud, ansible
|
||||||
:category: \*nix
|
:category: \*nix
|
||||||
|
|
||||||
contributor guidelines
|
Contributor Guidelines
|
||||||
^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Filing Bugs
|
Filing Bugs
|
||||||
|
@ -12,40 +12,69 @@ Filing Bugs
|
||||||
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible"
|
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible"
|
||||||
|
|
||||||
|
|
||||||
When submitting a bug, or working on a bug, please ensure the following criteria are met:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
|
* The description clearly states or describes the original problem or root
|
||||||
|
cause of the problem.
|
||||||
* Include historical information on how the problem was identified.
|
* Include historical information on how the problem was identified.
|
||||||
* Any relevant logs are included.
|
* Any relevant logs are included.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* The provided information should be totally self-contained. External
|
||||||
|
access to web services/sites should not be needed.
|
||||||
* Steps to reproduce the problem if possible.
|
* Steps to reproduce the problem if possible.
|
||||||
|
|
||||||
|
|
||||||
Submitting Code
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
following the workflow documented at:
|
||||||
|
"http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
||||||
|
|
||||||
Pull requests submitted through GitHub will be ignored and closed without regard.
|
Pull requests submitted through GitHub will be ignored and closed without
|
||||||
|
regard.
|
||||||
|
|
||||||
|
If you wish to test your changes locally prior to submitting them for review
|
||||||
|
you can use the ``Vagrantfile`` included in the root of this repository. It
|
||||||
|
aims to replicate the gate check testing that will be done by OpenStack CI
|
||||||
|
once your review has been submitted.
|
||||||
|
|
||||||
|
To run tests:
|
||||||
|
|
||||||
|
.. code-block:: shell-session
|
||||||
|
|
||||||
|
# vagrant up
|
||||||
|
|
||||||
|
The Vagrant box will run all tests and report status in the output. If you
|
||||||
|
need to iterate through a fix/test cycle, tests can be re-run in a running
|
||||||
|
Vagrant box with:
|
||||||
|
|
||||||
|
.. code-block:: shell-session
|
||||||
|
|
||||||
|
# vagrant provision
|
||||||
|
|
||||||
|
|
||||||
Extra
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete.
|
If it's a bug that needs fixing in a branch in addition to Master, add a
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
Importance:
|
||||||
Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures.
|
Should only be touched if it is a Blocker/Gating issue. If it is, please
|
||||||
|
set to High, and only use Critical if you have found a bug that can take
|
||||||
|
down whole infrastructures.
|
||||||
|
|
||||||
|
|
||||||
Style guide
|
Style guide
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format.
|
When creating tasks and other roles for use in Ansible please create then
|
||||||
|
using the YAML dictionary format.
|
||||||
|
|
||||||
Example YAML dictionary format:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
@ -69,17 +98,22 @@ Example **NOT** in YAML dictionary format:
|
||||||
- some-other-tag
|
- some-other-tag
|
||||||
|
|
||||||
|
|
||||||
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module.
|
Usage of the ">" and "|" operators should be limited to Ansible conditionals
|
||||||
|
and command modules such as the ansible ``shell`` module.
|
||||||
|
|
||||||
|
|
||||||
Issues
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
|
* The description clearly states or describes the original problem or root
|
||||||
|
cause of the problem.
|
||||||
* Include historical information on how the problem was identified.
|
* Include historical information on how the problem was identified.
|
||||||
* Any relevant logs are included.
|
* Any relevant logs are included.
|
||||||
* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
* If the issue is a bug that needs fixing in a branch other than Master,
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
||||||
|
* The provided information should be totally self-contained. External
|
||||||
|
access to web services/sites should not be needed.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
||||||
* Steps to reproduce the problem if possible.
|
* Steps to reproduce the problem if possible.
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
Vagrant.configure(2) do |config|
|
||||||
|
config.vm.box = "ubuntu/trusty64"
|
||||||
|
config.vm.provision "shell", inline: <<-SHELL
|
||||||
|
sudo su -
|
||||||
|
cd /vagrant
|
||||||
|
apt-get update
|
||||||
|
./run_tests.sh
|
||||||
|
SHELL
|
||||||
|
end
|
Loading…
Reference in New Issue