vcloud-edge_gateway 0.2.3 → 0.2.4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.4 (2014-05-01)
+
+  - Use pessimistic version dependency for vcloud-core
+
 ## 0.2.3 (2014-04-22)
 
 Bugfixes:

data/README.md

@@ -25,63 +25,43 @@ To configure an Edge Gateway:
 
     $ vcloud-configure-edge input.yaml
 
-### Credentials
+## Credentials
 
-vCloud Edge Gateway 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 Edge Gateway 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:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
-
-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:
-
-    test:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
-
-    test2:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.vendor.net'
-
-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:
+      test_credentials:
+        vcloud_director_host: 'host.api.example.com'
+        vcloud_director_username: 'username@org_name'
+        vcloud_director_password: ''
 
-    $ FOG_CREDENTIAL=test2 vcloud-configure-edge input.yaml
+2. Obtain a session token. First, curl the API:
 
-To understand more about `.fog` files, visit the 'Credentials' section here => http://fog.io/about/getting_started.html.
+        curl -D- -d '' \
+            -H 'Accept: application/*+xml;version=5.1' -u '<username>@<org_name>' \
+            https://<host.api.example.com>/api/sessions
 
-#### 2. Log on externally and supply your session token
+  This will prompt for your password.
 
-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.
+  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.
 
-A basic example of this would be the following:
+3. Specify your credentials and session token at the beginning of the command. For example:
 
-    curl
-       -D-
-       -d ''
-       -H 'Accept: application/*+xml;version=5.1' -u '<user>@<org>'
-       https://host.com/api/sessions
+        FOG_CREDENTIAL=test_credentials \
+            FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= \
+            vcloud-configure-edge input.yaml
 
-This will prompt for your password.
+  You may find it easier to export one or both of the values as environment variables.
 
-From the headers returned, select the header below
+  **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**.
 
-     x-vcloud-authorization: AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF=
-
-Use token as ENV var FOG_VCLOUD_TOKEN
-
-    $ FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= vcloud-configure-edge input.yaml
 
 ### Configure edge gateway services
 
@@ -414,6 +394,15 @@ cat edges.out | jq '
 
 You can find full configuration examples in the `examples` folder.
 
+## 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
 

data/Rakefile

@@ -10,14 +10,19 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = FileList['spec/vcloud/**/*_spec.rb']
 end
 
-task :default => [:spec]
+task :default => [:rubocop, :spec]
 
 RSpec::Core::RakeTask.new('integration') do |t|
   t.pattern = FileList['spec/integration/**/*_spec.rb']
 end
 
 require "gem_publisher"
-task :publish_gem do |t|
+task :publish_gem do
   gem = GemPublisher.publish_if_updated("vcloud-edge_gateway.gemspec", :rubygems)
   puts "Published #{gem}" if gem
 end
+
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--lint']
+end

data/bin/vcloud-configure-edge

@@ -1,12 +1,6 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'rubygems'
-  require 'methadone'
-  gem 'vcloud-edge_gateway'
-rescue LoadError
-end
-
+require 'methadone'
 require 'vcloud/edge_gateway'
 
 class App

data/jenkins.sh

@@ -3,9 +3,6 @@ set -e
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 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/edge_gateway/configuration_generator/load_balancer_service.rb

@@ -15,13 +15,13 @@ module Vcloud
               load_balancer_input_config[:enabled].to_s : 'true'
           vcloud_pools = []
           vcloud_virtual_servers = []
-          if pools = load_balancer_input_config[:pools]
-            pools.each do |pool_input_entry|
+          if load_balancer_input_config[:pools]
+            load_balancer_input_config[:pools].each do |pool_input_entry|
               vcloud_pools << generate_pool_entry(pool_input_entry)
             end
           end
-          if virtual_servers = load_balancer_input_config[:virtual_servers]
-            virtual_servers.each do |virtual_server_input_entry|
+          if load_balancer_input_config[:virtual_servers]
+            load_balancer_input_config[:virtual_servers].each do |virtual_server_input_entry|
               vcloud_virtual_servers << generate_virtual_server_entry(virtual_server_input_entry)
             end
           end
@@ -81,7 +81,7 @@ module Vcloud
             IsEnabled: 'false',
             Protocol: protocol.to_s.upcase,
             Port:     default_port(protocol),
-            Persistence: generate_virtual_server_persistence_section(protocol, nil)
+            Persistence: generate_virtual_server_persistence_section(nil)
           }
           if input_protocol_section
             vcloud_protocol_section[:IsEnabled] =
@@ -91,10 +91,7 @@ module Vcloud
               input_protocol_section.key?(:port) ?
                 input_protocol_section[:port].to_s : default_port(protocol)
             vcloud_protocol_section[:Persistence] =
-              generate_virtual_server_persistence_section(
-                protocol,
-                input_protocol_section[:persistence]
-              )
+              generate_virtual_server_persistence_section(input_protocol_section[:persistence])
           end
           vcloud_protocol_section
         end
@@ -104,7 +101,7 @@ module Vcloud
           default_port_for[protocol]
         end
 
-        def generate_virtual_server_persistence_section(protocol, input_persistence_section)
+        def generate_virtual_server_persistence_section(input_persistence_section)
           input_persistence_section = {} if input_persistence_section.nil?
           vcloud_persistence_section = { Method: '' }
           if input_persistence_section.key?(:method)
@@ -174,9 +171,9 @@ module Vcloud
             vcloud_pool_service_port[:Port] =
               input_pool_service_port.key?(:port) ?
                 input_pool_service_port[:port].to_s : default_port(mode)
-            if health_check = input_pool_service_port[:health_check]
+            if input_pool_service_port[:health_check]
               vcloud_pool_service_port[:HealthCheckPort] =
-                health_check.key?(:port) ? health_check[:port].to_s : ''
+                input_pool_service_port[:health_check].fetch(:port, '').to_s
               vcloud_pool_service_port[:HealthCheck] =
                 generate_pool_healthcheck(mode, input_pool_service_port[:health_check])
             end

data/lib/vcloud/edge_gateway/configuration_generator/nat_service.rb

@@ -33,11 +33,11 @@ module Vcloud
         end
 
         def populate_gateway_nat_rule(rule)
-          raise "Must supply a :network_id parameter" unless net_id = rule[:network_id]
+          raise "Must supply a :network_id parameter" unless rule[:network_id]
           edge_gw_interface = @edge_gateway_interfaces.find do |interface|
-            interface.network_id == net_id
+            interface.network_id == rule[:network_id]
           end
-          raise "unable to find gateway network interface with id #{net_id}" unless edge_gw_interface
+          raise "unable to find gateway network interface with id #{rule[:network_id]}" unless edge_gw_interface
           gateway_nat_rule = {}
           gateway_nat_rule[:Interface] = populate_nat_interface(edge_gw_interface)
           gateway_nat_rule[:OriginalIp] = rule[:original_ip]

data/lib/vcloud/edge_gateway/version.rb

@@ -1,6 +1,6 @@
 module Vcloud
   module EdgeGateway
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end
 

data/spec/vcloud/edge_gateway/configuration_differ_shared_examples.rb

@@ -126,7 +126,7 @@ module Vcloud
         differ = config_differ.new(local, remote)
         expect(differ.diff).to eq(output)
       end
-   end
+    end
 
   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-edge_gateway.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.2'
 
   s.add_runtime_dependency 'fog', '>= 1.21.0'
-  s.add_runtime_dependency 'vcloud-core', '>= 0.0.12'
+  s.add_runtime_dependency 'vcloud-core', '~> 0.0.12'
   s.add_runtime_dependency 'hashdiff'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'simplecov', '~> 0.8.2'
   s.add_development_dependency 'gem_publisher', '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-edge_gateway
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   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: fog
@@ -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
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +175,6 @@ files:
 - lib/vcloud/schema/firewall_service.rb
 - lib/vcloud/schema/load_balancer_service.rb
 - lib/vcloud/schema/nat_service.rb
-- scripts/generate_fog_conf_file.sh
 - spec/erb_helper.rb
 - spec/integration/edge_gateway/data/firewall_config.yaml.erb
 - spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.erb
@@ -202,6 +217,7 @@ files:
 - spec/vcloud/edge_gateway/load_balancer_schema_validation_spec.rb
 - spec/vcloud/edge_gateway/nat_configuration_differ_spec.rb
 - spec/vcloud/edge_gateway/nat_schema_validation_spec.rb
+- tools/fog_credentials.rb
 - vcloud-edge_gateway.gemspec
 homepage: http://github.com/alphagov/vcloud-edge_gateway
 licenses:
@@ -224,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -981764383968782471
+      hash: 346937587144257703
 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