vcloud-net_launcher 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 0.0.3 (2014-04-22)
+## 0.0.3 (2014-05-01)
+
+  - Use pessimistic version dependency for vcloud-core
+
+## 0.0.2 (2014-04-22)
 
   Bugfixes:
 

data/README.md

@@ -22,66 +22,42 @@ Or install it yourself as:
 The form to run the command is
     vcloud-net-launch networks.yaml
 
-### Credentials
+## Credentials
 
-vCloud Net Launcher is based around [fog]. To use it you'll need to give it credentials that allow it to talk to a VMware
-environment. Fog offers two ways to do this.
+vCloud Net Launcher is based around [fog](http://fog.io/). To use it you'll need to give it
+credentials that allow it to talk to a vCloud Director environment.
 
-#### 1. Create a `.fog` file containing your credentials
+1. Create a '.fog' file in your home directory.
 
-To use this method, you need a `.fog` file in your home directory.
+  For example:
 
-For example:
+      test_credentials:
+        vcloud_director_host: 'host.api.example.com'
+        vcloud_director_username: 'username@org_name'
+        vcloud_director_password: ''
 
-    test:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
+2. Obtain a session token. First, curl the API:
 
-Unfortunately current usage of fog requires the password in this file. Multiple sets of credentials can be specified in the fog file, using the following format:
+        curl -D- -d '' \
+            -H 'Accept: application/*+xml;version=5.1' -u '<username>@<org_name>' \
+            https://<host.api.example.com>/api/sessions
 
-    test:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
+  This will prompt for your password.
 
-    test2:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.vendor.net'
+  From the headers returned, the value of the `x-vcloud-authorization` header is your
+  session token, and this will be valid for 30 minutes idle - any activity will extend
+  its life by another 30 minutes.
 
-You can then pass the `FOG_CREDENTIAL` environment variable at the start of your command. The value of the `FOG_CREDENTIAL` environment variable is the name of the credential set in your fog file which you wish to use.  For instance:
+3. Specify your credentials and session token at the beginning of the command. For example:
 
-    FOG_CREDENTIAL=test2 vcloud-net-launch networks.yaml
+        FOG_CREDENTIAL=test_credentials \
+            FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= \
+            vcloud-net-launch
 
-To understand more about `.fog` files, visit the 'Credentials' section here => http://fog.io/about/getting_started.html.
-
-An example configuration file is located in [examples/vcloud-net-launch][example_yaml]
-
-#### 2. Log on externally and supply your session token
-
-You can choose to log on externally by interacting independently with the API and supplying your session token to the
-tool by setting the `FOG_VCLOUD_TOKEN` ENV variable. This option reduces the risk footprint by allowing the user to
-store their credentials in safe storage. The default token lifetime is '30 minutes idle' - any activity extends the life by another 30 mins.
-
-A basic example of this would be the following:
-
-    curl
-       -D-
-       -d ''
-       -H 'Accept: application/*+xml;version=5.1' -u '<user>@<org>'
-       https://host.com/api/sessions
-
-This will prompt for your password.
-
-From the headers returned, select the header below
-
-     x-vcloud-authorization: AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF=
-
-Use token as ENV var FOG_VCLOUD_TOKEN
-
-    FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= vcloud-net-launch networks.yaml
+  You may find it easier to export one or both of the values as environment variables.
 
+  **NB** It is also possible to sidestep the need for the session token by saving your
+  password in the fog file. This is **not recommended**.
 
 ##Supports
 
@@ -110,6 +86,16 @@ will need to be removed from the file before it is corrected and run again.
 
 vCloud Net Launcher uses vCloud Core. If you want to use the latest version of vCloud Core, or a local version, you can export some variables. See the Gemfile for details.
 
+## The vCloud API
+
+vCloud Tools currently use version 5.1 of the [vCloud API](http://pubs.vmware.com/vcd-51/index.jsp?topic=%2Fcom.vmware.vcloud.api.doc_51%2FGUID-F4BF9D5D-EF66-4D36-A6EB-2086703F6E37.html). Version 5.5 may work but is not currently supported. You should be able to access the 5.1 API in a 5.5 environment, and this *is* currently supported.
+
+The default version is defined in [Fog](https://github.com/fog/fog/blob/244a049918604eadbcebd3a8eaaf433424fe4617/lib/fog/vcloud_director/compute.rb#L32).
+
+If you want to be sure you are pinning to 5.1, or use 5.5, you can set the API version to use in your fog file, e.g.
+
+`vcloud_director_api_version: 5.1`
+
 ## Debugging
 
 `export EXCON_DEBUG=true` - this will print out the API requests and responses.
@@ -118,7 +104,14 @@ vCloud Net Launcher uses vCloud Core. If you want to use the latest version of v
 
 ## Testing
 
-Default target: `bundle exec rake` runs the integration tests.
+Default target: `bundle exec rake` runs the cucumber features tests.
+
+`bundle exec rake integration` runs the integration tests.
+
+`bundle exec rake features` runs the cucumber features tests.
+
+There are currently no unit tests here, though the bulk of the logic is
+tested in vcloud-core.
 
 You need access to a suitable vCloud Director organization to run the
 integration tests. It is not necessarily safe to run them against an existing

data/Rakefile

@@ -2,7 +2,7 @@ require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'gem_publisher'
 
-task :default => [:feature]
+task :default => [:features]
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   # Set a bogus Fog credential, otherwise it's possible for the unit
@@ -12,7 +12,7 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = FileList['spec/vcloud/**/*_spec.rb']
 end
 
-Cucumber::Rake::Task.new(:feature) do |t|
+Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "--format pretty --no-source"
   t.fork = false
 end

data/jenkins.sh

@@ -5,9 +5,6 @@ bundle install --path "${HOME}/bundles/${JOB_NAME}"
 # and rake aefault is currently integration test
 # bundle exec rake
 
-./scripts/generate_fog_conf_file.sh
-export FOG_RC=fog_integration_test.config
-bundle exec rake integration
-rm fog_integration_test.config
+RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration
 
 bundle exec rake publish_gem

data/jenkins_integration_tests.sh

@@ -2,7 +2,4 @@
 set -e
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 
-./scripts/generate_fog_conf_file.sh
-export FOG_RC=fog_integration_test.config
-bundle exec rake integration
-rm fog_integration_test.config
+RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration

data/lib/vcloud/net_launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module NetLauncher
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/tools/fog_credentials.rb

@@ -0,0 +1,17 @@
+# Initialiser for getting vCloud credentials into Fog from Jenkins build
+# parameters, without needing to write them to disk. To be used with:
+#
+#     RUBYOPT="-r ./tools/fog_credentials" bundle exec integration
+#
+# Replace with FOG_VCLOUD_TOKEN support when we have a tool:
+#
+#     https://www.pivotaltracker.com/story/show/68989754
+#
+require 'bundler/setup'
+require 'fog'
+
+Fog.credentials = {
+  :vcloud_director_host     => ENV['API_HOST'],
+  :vcloud_director_username => ENV['API_USERNAME'],
+  :vcloud_director_password => ENV['API_PASSWORD'],
+}

data/vcloud-net_launcher.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.2'
 
   s.add_runtime_dependency 'methadone'
-  s.add_runtime_dependency 'vcloud-core', '>= 0.0.12'
+  s.add_runtime_dependency 'vcloud-core', '~> 0.0.12'
   s.add_development_dependency 'aruba', '~> 0.5.3'
   s.add_development_dependency 'cucumber', '~> 1.3.10'
   s.add_development_dependency 'gem_publisher', '1.2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-net_launcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.12
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.12
 - !ruby/object:Gem::Dependency
@@ -149,13 +149,13 @@ files:
 - lib/vcloud/net_launcher/net_launch.rb
 - lib/vcloud/net_launcher/version.rb
 - scripts/basic.erb
-- scripts/generate_fog_conf_file.sh
 - spec/erb_helper.rb
 - spec/integration/net_launcher/data/minimum_data_setup.yaml.erb
 - spec/integration/net_launcher/org_vdc_network_spec.rb
 - spec/integration/net_launcher/vcloud_net_launcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/stub_fog_interface.rb
+- tools/fog_credentials.rb
 - vcloud-net_launcher.gemspec
 homepage: http://github.com/alphagov/vcloud-net_launcher
 licenses:
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2726991851897498986
+      hash: 2644140563289251804
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/scripts/generate_fog_conf_file.sh

@@ -1,6 +0,0 @@
-cat <<EOF >fog_integration_test.config
-default:
-    vcloud_director_username: '$API_USERNAME'
-    vcloud_director_password: '$API_PASSWORD'
-    vcloud_director_host: '$API_HOST'
-EOF