vagrant-gpii-ci 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c18cb8461cb2c1d40fee507d112b8849d9e4dd55
-  data.tar.gz: 1084314c7f12dbf7e22b4e342196b747c15c10dc
+  metadata.gz: 5f4961a92e8881a6fbf78ca95adb2de0263288b3
+  data.tar.gz: 14235567b7194116ca55a46dc46cb43f6373432d
 SHA512:
-  metadata.gz: 540511175a240cb005ddb242262bfe20ca3bfe67075d0e3ff197932fca347425f8f8087073aa0c55a7dbefc2de7b71b94b28c614de93a5e5239f11bcf97ecbe2
-  data.tar.gz: c4ba518fb112510ed4e54bfcdcdcc2e8f6a4a7be99bb41e804fd8e29c168fcba09b58e7bfec7a21483090aa3f4313ad111d85ad558a3c07636cb1e1cdacfa5ba
+  metadata.gz: 94d6fd40f82dbda8c84d7e769ba6d02fba62ee6a3bb18e401499b076b925859ace03cd72992a6c78764f49b646c89889f311c39eacaf93a2ef83d29b5b49f92e
+  data.tar.gz: 56046a9a44230f405ca79893e8ca66d06ae7ed77d82bf323e574624d33af2c6cf6f1bef3388c8ccc989781d24b11fcfc8c094bb34ffe881c27440ab2c999a88a

data/README.md

@@ -1,12 +1,16 @@
 Vagrant-GPII-CI
 =============
 
-Vagrant-GPII-CI is a vagrant plugin that is used to simplify the configuration stored in a Vagrantfile. It uses virtual machine definitions to spin up complete
-enviroments where you can run tests or run your code.
+Scope
+-----
+
+Vagrant-GPII-CI is a vagrant plugin that is used to simplify the definition of a Vagrantfile. It uses virtual machine and scripts definitions to spin up complete enviroments where you can run your tests or applications.
 
 Installation
 ------------
 
+The installation is as simple as run this command in your user's shell:
+
 ```
 vagrant plugin install vagrant-gpii-ci
 ```
@@ -14,25 +18,54 @@ vagrant plugin install vagrant-gpii-ci
 Working with vms
 ----------------
 
-No Vagrantfile is required if a file [.gpii-ci.yml](gpii-ci.yml.template) is found in the root of the repository.
+No Vagrantfile is required if a file [.vagrant.yml](vagrant.yml.template) is found in the root of the repository.
 
 The name of the file can be override using the environment variable `VAGRANT_CI_FILE`.
 
 Commands:
 
- * `vagrant up [vm]` to spin up the defined in the .ci_env variable of the [.gpii-ci.yml](gpii-ci.yml.template) file. 
+ * `vagrant up [vm]` to spin up the vms defined in the .ci_env variable. 
  * `vagrant destroy [vm]` to stop and destroy the vm.
  * `vagrant reload [vm]` to stop and destroy the vm.
  * `vagrant halt [vm]` to shutdown the vm without destroy it.
- * `vagrant ci test [vm]` to run all the stages defined in the selected vm
-
+ * `vagrant ci test [vm]` to run all the stages defined in the .ci_stages variable, at the selected vm.
 
 Note:
 
  * The `vm` parameter is not necessary in environments with only one VM defined.
 
-Sample:
 
+Virtual Machines definition
+---------------------------
+
+The `.ci_env` variable must have a child variable called `vms` that lists the names of the virtual machines defined. Each name of a VM must have some additional options.
+
+The options available for a vm definition are:
+
+ * `3d` - Enable 3D support. _False_ by default.
+ * `autostart - Starts the vm when the command `up` is executed. _True_ by default.
+ * `box` - Defines the base box that the vm will use. `Required`
+ * `clone` - Use the [Vagrant clone feature](https://www.vagrantup.com/docs/virtualbox/configuration.html#linked-clones) to make the creation of the vm faster. _False_ by default.
+ * `cpu` - Defines the number of the virtual CPUs. `Required`
+ * `memory` - Defines the amount of RAM memory assigned to the VM. `Required`
+ * `sound` - Enables a dummy sound card in the VM. Disabled by default
+ * `gui` - Enable the GUI of the VM. _True_ by default.
+
+Samples
+=======
+
+```
+.ci_env:
+  vms:
+    windows10:
+      cpu: 2
+      memory: 2048
+      clone: true
+      autostart: true
+      box: inclusivedesign/windows10-eval
+```
+
+In the following example we use the [merge](http://yaml.org/type/merge.html) feature of YAML to simplify the virtual machines definitions.
 
 ```
 .ci_env:
@@ -58,15 +91,14 @@ Sample:
 Networking
 ----------
 
-All the VMs have access to Internet using the gateway of the host through a NAT interface.
+All the VMs have access to Internet using the gateway of the host through a NAT interface by default.
 
-In the case of multi VM environments, a additional NIC card is create in each VM with a private IP of a private network that all the VMs share. The IP range of this network is 192.168.50.0/24. The IP address are assigned to each VM starting by 10.
+In the case of multi VM environments, a additional NIC card is create in each VM with a private IP address of a private network where all the VMs are connected. The IP range of this network is 192.168.50.0/24. The IP addresses assigned to each VM start by 10 and is incremented by 1 in additional VMs.
 
 Mapped ports
 ---------------
 
-The port mapping is configured in the VMs definition. The `mapped_ports`
-variable is a list of ports that will be mapped from the VM to the host.
+The port mapping is configured in the VMs definition. The `mapped_ports` variable is a list of ports that will be mapped from the VM to the host.
 
 ```
 mapped_ports:
@@ -74,3 +106,72 @@ mapped_ports:
   - 8181
 ```
 
+Tags
+----
+
+The tags can be used to run specific stages in some VMs. A stage with a set of tags will be only executed in the VMs that have those tags listed. If a stage doesn't have tags defined it will be executed in all VMs.
+
+Sample
+=======
+
+```
+.ci_env:
+  default: &default
+    cpu: 2                 # number of cpus
+    memory: 2048           # amount of RAM memory
+    clone: true            # use the linked_clone Vagrant feature
+    autostart: false       # only start a VM when it's specfied in the command line
+  vms:
+    windows:               # name of the VM
+      <<: *default         # referece of the common part
+      tags:
+        - windows
+      box: inclusivedesign/windows
+    fedora:                # name of the VM
+      <<: *default         # referece of the common part
+      tags:
+        - linux
+      box: inclusivedesign/fedora
+
+.ci_stages:                # Stages to perform when 'ci test' command is invoked
+  - setup_win
+  - setup_linux
+  - test
+
+setup_win_job:
+  stage: setup_win         # name of the stage
+  tags:                    # This stage will be only executed on Windows VMs
+    - windows
+  script:
+    - |
+      choco upgrade firefox googlechrome -y
+      choco install -y nodejs python2 msbuild.extensionpack microsoft-build-tools
+      refreshenv
+    - |
+      npm config -g set msvs_version 2015
+      npm install -g testem node-gyp
+      refreshenv
+    - |
+      npm install
+      refreshenv
+    - testem ci -l firefox
+    - testem ci -l chrome
+
+setup_linux_job:
+  stage: setup_linux       # name of the stage
+  tags:                    # This stage will be only executed on linux VMs
+    - linux
+  script:
+    - sudo ansible-galaxy install -fr provisioning/requirements.yml
+    - |
+      sudo mkdir -p /var/tmp/vagrant/node_modules /vagrant/node_modules
+      sudo chown vagrant:vagrant -R /var/tmp/vagrant/node_modules /vagrant/node_modules
+      sudo mount -o bind /var/tmp/vagrant/node_modules /vagrant/node_modules
+
+test_job:
+  stage: test
+  script:
+    - npm run node-test
+    - npm run browser-test
+
+```

data/lib/vagrant-gpii-ci/action/build_vagrantfile.rb

@@ -14,7 +14,7 @@ module VagrantPlugins
 
           # The file .gpii-ci.yml can be override using this environment variable
           ci_file ||= ENV["VAGRANT_CI_FILE"] if ENV.key?("VAGRANT_CI_FILE")
-          ci_file ||= ".gpii-ci.yml"
+          ci_file ||= ".vagrant.yml"
 
           # Only if the ci_file is found the plugin will run
           if File.exist?(project_home(@env).join(ci_file)) 

data/lib/vagrant-gpii-ci/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GPIICi
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/{gpii-ci.yml.template → vagrant.yml.template}

@@ -23,7 +23,7 @@
       <<: *default           # referece of the common part
       box: inclusivedesign/windows7-eval-x64
 
-stages:                # Stages to perform when 'ci test' command is invoked
+.ci_stages:                # Stages to perform when 'ci test' command is invoked
   - setup              # name of the first stage to execute
   - test               # name of the second stage to execute
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-gpii-ci
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alfredo Matas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gpii-ci.yml.template
 - lib/vagrant-gpii-ci.rb
 - lib/vagrant-gpii-ci/action.rb
 - lib/vagrant-gpii-ci/action/build_vagrantfile.rb
@@ -91,6 +90,7 @@ files:
 - spec/spec_helper.rb
 - spec/vagrant/gpiici_spec.rb
 - vagrant-gpiici.gemspec
+- vagrant.yml.template
 homepage: http://github.com/amatas/vagrant-gpii-ci.git
 licenses:
 - MIT