Go to file
Gilles Cornu cb80286a4a ansible_local: put json extra-vars in double quotes
Without this change, the JSON string generated from the `extra_vars`
Ruby hash is passed without enclosing quotes and is then not parseable
by the ansible-playbook command when exectuted in a usual shell context.

In this changeset, the ansible (remote) unit test coverage is improved
to cover both usage of `extra_vars` (ansible_local unit tests are still
missing).

Additional Notes:

 - Double quotes are favored to single quotes in order to allow usage of
   any character for the variable values. For this reason additional
   escaping is appended to JSON-inner double quotes and backslashes.

 - This problem was not affecting the `ansible` remote provisioner
   (which is running the ansible-playbook command via the childprocess
   Ruby library). But with this change, the `verbose` output will also
   now be correct for a copy-paste reuse.

 - After this change, all the "--extra-vars" arguments (also a var
   file passed with the @-syntax or anything coming via the
   `raw_arguments` option) are "blindly" and systematically enclosed
   in double quoted and double-escaped.
   This is not optimal and can potentially break with peculiar values
   (e.g. a double quote character (") cannot be used in a json value
   when using `raw_arguments`). That said, I think that the current
   solution is a reasonable trade-off, since the official `extra_vars`
   option should now be able to cover a great majority of use cases.

Fix #6726
2016-03-05 17:24:28 +01:00
.github Move to .github 2016-02-17 15:18:58 -05:00
bin for newer versions of Bundler, store the runtime 2015-07-09 22:12:47 -06:00
contrib Document missing sudoers item 2015-11-27 09:49:38 +01:00
keys Use SSL and HTTPS links where appropriate 2016-01-25 13:14:54 -05:00
lib Merge pull request #6893 from mmickan/prerelease-version-fix 2016-02-03 09:57:25 -05:00
plugins ansible_local: put json extra-vars in double quotes 2016-03-05 17:24:28 +01:00
scripts update some scripts 2015-12-21 12:11:42 -08:00
tasks Use color 2015-07-09 17:24:29 -06:00
templates Merge pull request #6963 from mitchellh/sethvargo/str_ver 2016-02-02 09:48:19 -05:00
test ansible_local: put json extra-vars in double quotes 2016-03-05 17:24:28 +01:00
website Update docs 2016-03-04 11:45:20 -05:00
.gitignore Merge docs and www into a single static site 2016-01-19 14:35:05 -05:00
.travis.yml Use bundle exec 2015-07-09 17:20:02 -06:00
.vimrc .vimrc with vagrant tabstop settings 2013-10-22 08:24:58 +02:00
.yardopts YARD and some documentation 2010-09-22 09:43:30 -06:00
CHANGELOG.md Update CHANGELOG.md 2016-03-04 11:42:13 -06:00
Gemfile change Gemfile source to HTTPS 2014-10-23 15:25:40 -04:00
LICENSE Updated copyright to 2016 2016-01-01 01:29:10 +00:00
README.md Use SSL and HTTPS links where appropriate 2016-01-25 13:14:54 -05:00
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax 2014-05-22 12:35:12 -04:00
Vagrantfile Fix Vagrantfile 2015-07-08 10:12:31 -06:00
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler 2014-01-17 09:39:20 -08:00
vagrant.gemspec Merge pull request #6922 from mwrock/negotiate 2016-02-03 09:52:48 -05:00
version.txt up version for dev 2015-12-24 14:03:36 -08:00

README.md

Vagrant

Vagrant is a tool for building and distributing development environments.

Development environments managed by Vagrant can run on local virtualized platforms such as VirtualBox or VMware, in the cloud via AWS or OpenStack, or in containers such as with Docker or raw LXC.

Vagrant provides the framework and configuration format to create and manage complete portable development environments. These development environments can live on your computer or in the cloud, and are portable between Windows, Mac OS X, and Linux.

Quick Start

For the quick-start, we'll bring up a development machine on VirtualBox because it is free and works on all major platforms. Vagrant can, however, work with almost any system such as [OpenStack] (https://www.openstack.org/), [VMware] (https://www.vmware.com/), [Docker] (https://docs.docker.com/), etc.

First, make sure your development machine has VirtualBox installed. After this, download and install the appropriate Vagrant package for your OS.

To build your first virtual environment:

vagrant init hashicorp/precise32
vagrant up

Note: The above vagrant up command will also trigger Vagrant to download the precise32 box via the specified URL. Vagrant only does this if it detects that the box doesn't already exist on your system.

Getting Started Guide

To learn how to build a fully functional development environment, follow the getting started guide.

Installing the Gem from Git

If you want the bleeding edge version of Vagrant, we try to keep master pretty stable and you're welcome to give it a shot. The following is an example showing how to do this:

rake install

Ruby 2.0 is needed.

Contributing to Vagrant

To install Vagrant from source, please follow the guide in the Wiki.

You can run the test suite with:

bundle exec rake

This will run the unit test suite, which should come back all green! Then you're good to go!

If you want to run Vagrant without having to install the gem, you may use bundle exec, like so:

bundle exec vagrant help

NOTE: By default running Vagrant via bundle will disable plugins. This is necessary because Vagrant creates its own private Bundler context (it does not respect your Gemfile), because it uses Bundler to manage plugin dependencies.

Acceptance Tests

Vagrant also comes with an acceptance test suite that does black-box tests of various Vagrant components. Note that these tests are extremely slow because actual VMs are spun up and down. The full test suite can take hours. Instead, try to run focused component tests.

To run the acceptance test suite, first copy vagrant-spec.config.example.rb to vagrant-spec.config.rb and modify it to valid values. The places you should fill in are clearly marked.

Next, see the components that can be tested:

$ rake acceptance:components
cli
provider/virtualbox/basic
...

Then, run one of those components:

$ rake acceptance:run COMPONENTS="cli"
...