vcloud-edge_gateway 0.3.0 → 0.4.0

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+rvm:
+  - 1.9.3
+branches:
+  except:
+    - master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.4.0 (2014-05-12)
+
+Features:
+
+  - Allow config files to be rendered from [Mustache](http://mustache.github.io/)
+    templates so that common configs can be re-used across environments with
+    differences represented as variables.
+
 ## 0.3.0 (2014-05-01)
 
 Features:

data/README.md

@@ -25,6 +25,11 @@ To configure an Edge Gateway:
 
     $ vcloud-configure-edge input.yaml
 
+To use [mustache](http://mustache.github.io) templates so that rulesets can
+be re-used between environments:
+
+    $ vcloud-configure-edge --template-vars vars.yaml input.yaml.mustache
+
 ## Credentials
 
 vCloud Edge Gateway is based around [fog](http://fog.io/). To use it you'll need to give it
@@ -410,6 +415,16 @@ If you want to be sure you are pinning to 5.1, or use 5.5, you can set the API v
 
 `export DEBUG=true` - this will show you the stack trace when there is an exception instead of just the message.
 
+## Testing
+
+Run the default suite of tests (e.g. lint, unit, features):
+
+    bundle exec rake
+
+Run the integration tests (slower and requires a real environment):
+
+    bundle exec rake integration
+
 ### References
 
 * [vCloud Director Edge Gateway documentation](http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.admin.doc_51/GUID-ADE1DCAB-874F-45A9-9337-1E971DAC0F7D.html)

data/bin/vcloud-configure-edge

@@ -8,13 +8,19 @@ class App
   include Methadone::CLILogging
 
   main do |config_file|
-    Vcloud::EdgeGatewayServices.new.update(config_file)
+    if options['template-vars']
+      Vcloud::EdgeGatewayServices.new.update(config_file, options['template-vars'])
+    else
+      Vcloud::EdgeGatewayServices.new.update(config_file)
+    end
   end
 
-  arg :resource
+  arg :config_file
+  on('--template-vars FILE', 'Enable templating with variables from this file')
 
   description '
-  vcloud-edge_gateway allows you to configure an EdgeGateway with an input file
+  vcloud-edge_gateway allows you to configure an EdgeGateway with an input
+  file which may optionally be a Mustache template.
 
   See https://github.com/alphagov/vcloud-edge_gateway for more info'
 

data/examples/vcloud-configure-edge/template-nat-rules.yaml.mustache

@@ -0,0 +1,20 @@
+# Example of using templating to re-use the same ruleset for two different
+# environments which have very slightly different attributes. See the files:
+#
+# - template-vars-env1.yaml
+# - template-vars-env2.yaml
+#
+---
+gateway: "{{ gateway_name }}"
+nat_service:
+  enabled: true
+  nat_rules:
+  - :id: '65537'
+    :enabled: true
+    :rule_type: 'DNAT'
+    :network_id: '{{ network_id }}'
+    :original_ip: '{{ original_ip }}'
+    :original_port: '22'
+    :translated_ip: '10.20.30.40'
+    :translated_port: '22'
+    :protocol: 'tcp'

data/examples/vcloud-configure-edge/template-vars-env1.yaml

@@ -0,0 +1,4 @@
+---
+gateway_name: 'VSE Environment One'
+network_id: '4E4D3012-9049-4E94-9D40-C90B9B2BFECB'
+original_ip: '172.16.0.100'

data/examples/vcloud-configure-edge/template-vars-env2.yaml

@@ -0,0 +1,4 @@
+---
+gateway_name: 'VSE Environment Two'
+network_id: '222F3C67-27A1-4F71-AE4B-6F8281175741'
+original_ip: '172.16.0.200'

data/lib/vcloud/edge_gateway/version.rb

@@ -1,6 +1,6 @@
 module Vcloud
   module EdgeGateway
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end
 

data/lib/vcloud/edge_gateway_services.rb

@@ -7,8 +7,8 @@ module Vcloud
       @config_loader = Vcloud::Core::ConfigLoader.new
     end
 
-    def update(config_file = nil)
-      local_config = @config_loader.load_config(config_file, Vcloud::Schema::EDGE_GATEWAY_SERVICES)
+    def update(config_file = nil, vars_file = nil)
+      local_config = @config_loader.load_config(config_file, Vcloud::Schema::EDGE_GATEWAY_SERVICES, vars_file)
 
       edge_gateway = Core::EdgeGateway.get_by_name local_config[:gateway]
       remote_config = edge_gateway.vcloud_attributes[:Configuration][:EdgeGatewayServiceConfiguration]

data/spec/integration/edge_gateway/data/{firewall_config.yaml.erb → firewall_config.yaml.mustache}

@@ -1,5 +1,5 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 firewall_service:
   policy: drop
   log_default_action: true

data/spec/integration/edge_gateway/data/{firewall_config_updated_rule.yaml.erb → firewall_config_updated_rule.yaml.mustache}

@@ -1,5 +1,5 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 firewall_service:
   policy: drop
   log_default_action: true

data/spec/integration/edge_gateway/data/{firewall_rule_order_test.yaml.erb → firewall_rule_order_test.yaml.mustache}

@@ -1,5 +1,5 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 firewall_service:
   firewall_rules:
   - description: 'First Input Rule'

data/spec/integration/edge_gateway/data/{hairpin_nat_config.yaml.erb → hairpin_nat_config.yaml.mustache}

@@ -1,13 +1,13 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 nat_service:
   nat_rules:
   - enabled: true
     description: 'A DNAT rule'
-    network_id: <%= org_vdc_network_id %>
+    network_id: {{ org_vdc_network_id }}
     rule_type: 'DNAT'
     translated_ip: '10.10.1.2'
     translated_port: '3412'
-    original_ip: <%= original_ip %>
+    original_ip: {{ original_ip }}
     original_port: '3412'
     protocol: 'tcp'

data/spec/integration/edge_gateway/data/{load_balancer_config.yaml.erb → load_balancer_config.yaml.mustache}

@@ -1,5 +1,5 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 load_balancer_service:
   enabled: true
   pools:
@@ -16,8 +16,8 @@ load_balancer_service:
   virtual_servers:
   - name: 'integration-test-vs-1'
     description: 'A virtual server'
-    ip_address: <%= edge_gateway_ext_network_ip %>
-    network: <%= edge_gateway_ext_network_id %>
+    ip_address: {{ edge_gateway_ext_network_ip }}
+    network: {{ edge_gateway_ext_network_id }}
     pool: 'integration-test-pool-1'
     service_profiles:
       http:

data/spec/integration/edge_gateway/data/{load_balancer_empty.yaml.erb → load_balancer_empty.yaml.mustache}

@@ -1,4 +1,4 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 load_balancer_service:
   enabled: true

data/spec/integration/edge_gateway/data/{load_balancer_single_pool.yaml.erb → load_balancer_single_pool.yaml.mustache}

@@ -1,5 +1,5 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 load_balancer_service:
   enabled: true
   pools:

data/spec/integration/edge_gateway/data/{load_balancer_single_virtual_server_invalid_pool.yaml.erb → load_balancer_single_virtual_server_invalid_pool.yaml.mustache}

@@ -1,12 +1,12 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 load_balancer_service:
   enabled: true
   virtual_servers:
   - name: 'integration-test-vs-1'
     description: 'A virtual server'
-    ip_address: <%= edge_gateway_ext_network_ip %>
-    network: <%= edge_gateway_ext_network_id %>
+    ip_address: {{ edge_gateway_ext_network_ip }}
+    network: {{ edge_gateway_ext_network_id }}
     pool: 'unconfigured-test-pool-1'
     service_profiles:
       http:

data/spec/integration/edge_gateway/data/{load_balancer_single_virtual_server_missing_pool.yaml.erb → load_balancer_single_virtual_server_missing_pool.yaml.mustache}

@@ -1,12 +1,12 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 load_balancer_service:
   enabled: true
   virtual_servers:
   - name: 'integration-test-vs-1'
     description: 'A virtual server'
-    ip_address: <%= edge_gateway_ext_network_ip %>
-    network: <%= edge_gateway_ext_network_id %>
+    ip_address: {{ edge_gateway_ext_network_ip }}
+    network: {{ edge_gateway_ext_network_id }}
     service_profiles:
       http:
         port: 8080

data/spec/integration/edge_gateway/data/{nat_and_firewall_config.yaml.erb → nat_and_firewall_config.yaml.mustache}

@@ -1,19 +1,19 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 nat_service:
   nat_rules:
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'DNAT'
     translated_ip: '10.10.1.2-10.10.1.3'
     translated_port: '3412'
-    original_ip: <%= original_ip %>
+    original_ip: {{ original_ip }}
     original_port: '3412'
     protocol: 'tcp'
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'SNAT'
-    translated_ip: <%= original_ip %>
+    translated_ip: {{ original_ip }}
     original_ip: '10.10.1.2-10.10.1.3'
 firewall_service:
   policy: drop

data/spec/integration/edge_gateway/data/{nat_and_firewall_plus_load_balancer_config.yaml.erb → nat_and_firewall_plus_load_balancer_config.yaml.mustache}

@@ -1,19 +1,19 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 nat_service:
   nat_rules:
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'DNAT'
     translated_ip: '10.10.1.2-10.10.1.3'
     translated_port: '3412'
-    original_ip: <%= original_ip %>
+    original_ip: {{ original_ip }}
     original_port: '3412'
     protocol: 'tcp'
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'SNAT'
-    translated_ip: <%= original_ip %>
+    translated_ip: {{ original_ip }}
     original_ip: '10.10.1.2-10.10.1.3'
 firewall_service:
   policy: drop
@@ -46,8 +46,8 @@ load_balancer_service:
   virtual_servers:
   - name: 'integration-test-vs-1'
     description: 'A virtual server'
-    ip_address: <%= edge_gateway_ext_network_ip %>
-    network: <%= edge_gateway_ext_network_id %>
+    ip_address: {{ edge_gateway_ext_network_ip }}
+    network: {{ edge_gateway_ext_network_id }}
     pool: 'integration-test-pool-1'
     service_profiles:
       http:

data/spec/integration/edge_gateway/data/{nat_config.yaml.erb → nat_config.yaml.mustache}

@@ -1,17 +1,17 @@
 ---
-gateway: <%= edge_gateway_name %>
+gateway: {{ edge_gateway_name }}
 nat_service:
   nat_rules:
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'DNAT'
     translated_ip: '10.10.1.2-10.10.1.3'
     translated_port: '3412'
-    original_ip: <%= original_ip %>
+    original_ip: {{ original_ip }}
     original_port: '3412'
     protocol: 'tcp'
   - enabled: true
-    network_id: <%= network_id %>
+    network_id: {{ network_id }}
     rule_type: 'SNAT'
-    translated_ip: <%= original_ip %>
+    translated_ip: {{ original_ip }}
     original_ip: '10.10.1.2-10.10.1.3'

data/spec/integration/edge_gateway/edge_gateway_services_spec.rb

@@ -1,27 +1,11 @@
 require 'spec_helper'
+require 'tempfile'
 
 module Vcloud
   describe EdgeGatewayServices do
 
-    required_env = {
-      'VCLOUD_EDGE_GATEWAY' => 'to name of VSE',
-      'VCLOUD_PROVIDER_NETWORK_ID' => 'to ID of VSE external network',
-      'VCLOUD_PROVIDER_NETWORK_IP' => 'to an available IP on VSE external network',
-      'VCLOUD_NETWORK1_ID' => 'to the ID of a VSE internal network',
-      'VCLOUD_NETWORK1_NAME' => 'to the name of the VSE internal network',
-      'VCLOUD_NETWORK1_IP' => 'to an ID on the VSE internal network',
-    }
-
-    error = false
-    required_env.each do |var,message|
-      unless ENV[var]
-        puts "Must set #{var} #{message}" unless ENV[var]
-        error = true
-      end
-    end
-    Kernel.exit(2) if error
-
     before(:all) do
+      IntegrationHelper.verify_env_vars
       @edge_name = ENV['VCLOUD_EDGE_GATEWAY']
       @ext_net_id = ENV['VCLOUD_PROVIDER_NETWORK_ID']
       @ext_net_ip = ENV['VCLOUD_PROVIDER_NETWORK_IP']
@@ -36,14 +20,9 @@ module Vcloud
 
       before(:all) do
         reset_edge_gateway
-        @initial_config_file = generate_input_config_file(
-          'nat_and_firewall_config.yaml.erb',
-          edge_gateway_erb_input
-        )
-        @adding_load_balancer_config_file = generate_input_config_file(
-          'nat_and_firewall_plus_load_balancer_config.yaml.erb',
-          edge_gateway_erb_input
-        )
+        @vars_config_file = generate_vars_file(edge_gateway_vars_hash)
+        @initial_config_file = IntegrationHelper.fixture_file('nat_and_firewall_config.yaml.mustache')
+        @adding_load_balancer_config_file = IntegrationHelper.fixture_file('nat_and_firewall_plus_load_balancer_config.yaml.mustache')
         @edge_gateway = Vcloud::Core::EdgeGateway.get_by_name(@edge_name)
       end
 
@@ -60,7 +39,7 @@ module Vcloud
         it "should only create one edgeGateway update task when updating the configuration" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@initial_config_file)
+          EdgeGatewayServices.new.update(@initial_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(1)
         end
@@ -76,7 +55,7 @@ module Vcloud
         it "should not update the EdgeGateway again if the config hasn't changed" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@initial_config_file)
+          EdgeGatewayServices.new.update(@initial_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(0)
         end
@@ -84,7 +63,7 @@ module Vcloud
         it "should only create one additional edgeGateway update task when adding the LoadBalancer config" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@adding_load_balancer_config_file)
+          EdgeGatewayServices.new.update(@adding_load_balancer_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(1)
         end
@@ -92,7 +71,7 @@ module Vcloud
         it "should not update the EdgeGateway again if we reapply the 'adding load balancer' config" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@adding_load_balancer_config_file)
+          EdgeGatewayServices.new.update(@adding_load_balancer_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(0)
         end
@@ -105,7 +84,9 @@ module Vcloud
       end
 
       def remove_temp_config_files
-        FileUtils.rm(@files_to_delete)
+        @files_to_delete.each { |f|
+          f.unlink
+        }
       end
 
       def reset_edge_gateway
@@ -121,14 +102,16 @@ module Vcloud
                                           })
       end
 
-      def generate_input_config_file(data_file, erb_input)
-        config_erb = File.expand_path("data/#{data_file}", File.dirname(__FILE__))
-        output_file = ErbHelper.convert_erb_template_to_yaml(erb_input, config_erb)
-        @files_to_delete << output_file
-        output_file
+      def generate_vars_file(vars_hash)
+        file = Tempfile.new('vars_file')
+        file.write(vars_hash.to_yaml)
+        file.close
+        @files_to_delete << file
+
+        file.path
       end
 
-      def edge_gateway_erb_input
+      def edge_gateway_vars_hash
         {
           edge_gateway_name: @edge_name,
           network_id: @ext_net_id,

data/spec/integration/edge_gateway/firewall_service_spec.rb

@@ -1,27 +1,11 @@
 require 'spec_helper'
+require 'tempfile'
 
 module Vcloud
   describe EdgeGatewayServices do
 
-    required_env = {
-      'VCLOUD_EDGE_GATEWAY' => 'to name of VSE',
-      'VCLOUD_PROVIDER_NETWORK_ID' => 'to ID of VSE external network',
-      'VCLOUD_PROVIDER_NETWORK_IP' => 'to an available IP on VSE external network',
-      'VCLOUD_NETWORK1_ID' => 'to the ID of a VSE internal network',
-      'VCLOUD_NETWORK1_NAME' => 'to the name of the VSE internal network',
-      'VCLOUD_NETWORK1_IP' => 'to an ID on the VSE internal network',
-    }
-
-    error = false
-    required_env.each do |var,message|
-      unless ENV[var]
-        puts "Must set #{var} #{message}" unless ENV[var]
-        error = true
-      end
-    end
-    Kernel.exit(2) if error
-
     before(:all) do
+      IntegrationHelper.verify_env_vars
       @edge_name = ENV['VCLOUD_EDGE_GATEWAY']
       @ext_net_id = ENV['VCLOUD_PROVIDER_NETWORK_ID']
       @ext_net_ip = ENV['VCLOUD_PROVIDER_NETWORK_IP']
@@ -36,7 +20,8 @@ module Vcloud
 
       before(:all) do
         reset_edge_gateway
-        @initial_firewall_config_file = generate_input_config_file('firewall_config.yaml.erb', edge_gateway_erb_input)
+        @vars_config_file = generate_vars_file(edge_gateway_vars_hash)
+        @initial_firewall_config_file = IntegrationHelper.fixture_file('firewall_config.yaml.mustache')
         @edge_gateway = Vcloud::Core::EdgeGateway.get_by_name(@edge_name)
         @firewall_service = {}
       end
@@ -44,7 +29,11 @@ module Vcloud
       context "Check update is functional" do
 
         before(:all) do
-          local_config = Core::ConfigLoader.new.load_config(@initial_firewall_config_file, Vcloud::Schema::EDGE_GATEWAY_SERVICES)
+          local_config = Core::ConfigLoader.new.load_config(
+            @initial_firewall_config_file,
+            Vcloud::Schema::EDGE_GATEWAY_SERVICES,
+            @vars_config_file
+          )
           @local_vcloud_config  = EdgeGateway::ConfigurationGenerator::FirewallService.new.generate_fog_config(local_config[:firewall_service])
         end
 
@@ -55,7 +44,7 @@ module Vcloud
 
         it "should only need to make one call to Core::EdgeGateway.update_configuration" do
           expect_any_instance_of(Core::EdgeGateway).to receive(:update_configuration).exactly(1).times.and_call_original
-          EdgeGatewayServices.new.update(@initial_firewall_config_file)
+          EdgeGatewayServices.new.update(@initial_firewall_config_file, @vars_config_file)
         end
 
         it "should have configured at least one firewall rule" do
@@ -71,7 +60,7 @@ module Vcloud
 
         it "and then should not configure the firewall service if updated again with the same configuration (idempotency)" do
           expect(Vcloud::Core.logger).to receive(:info).with('EdgeGatewayServices.update: Configuration is already up to date. Skipping.')
-          EdgeGatewayServices.new.update(@initial_firewall_config_file)
+          EdgeGatewayServices.new.update(@initial_firewall_config_file, @vars_config_file)
         end
 
         it "ConfigurationDiffer should return empty if local and remote firewall configs match" do
@@ -82,9 +71,11 @@ module Vcloud
         end
 
         it "should highlight a difference if local firewall config has been updated" do
-          input_config_file = generate_input_config_file('firewall_config_updated_rule.yaml.erb', edge_gateway_erb_input)
-
-          local_config = Core::ConfigLoader.new.load_config(input_config_file, Vcloud::Schema::EDGE_GATEWAY_SERVICES)
+          local_config = Core::ConfigLoader.new.load_config(
+            IntegrationHelper.fixture_file('firewall_config_updated_rule.yaml.mustache'),
+            Vcloud::Schema::EDGE_GATEWAY_SERVICES,
+            @vars_config_file
+          )
           local_firewall_config = EdgeGateway::ConfigurationGenerator::FirewallService.new.generate_fog_config(local_config[:firewall_service])
 
           edge_gateway = Core::EdgeGateway.get_by_name local_config[:gateway]
@@ -141,8 +132,10 @@ module Vcloud
       context "Specific FirewallService update tests" do
 
         it "should have the same rule order as the input rule order" do
-          input_config_file = generate_input_config_file('firewall_rule_order_test.yaml.erb', edge_gateway_erb_input)
-          EdgeGatewayServices.new.update(input_config_file)
+          EdgeGatewayServices.new.update(
+            IntegrationHelper.fixture_file('firewall_rule_order_test.yaml.mustache'),
+            @vars_config_file
+          )
           remote_rules = @edge_gateway.vcloud_attributes[:Configuration][:EdgeGatewayServiceConfiguration][:FirewallService][:FirewallRule]
           remote_descriptions_list = remote_rules.map {|rule| rule[:Description]}
           expect(remote_descriptions_list).
@@ -157,10 +150,11 @@ module Vcloud
 
       end
 
-
       after(:all) do
         reset_edge_gateway unless ENV['VCLOUD_NO_RESET_VSE_AFTER']
-        FileUtils.rm(@files_to_delete)
+        @files_to_delete.each { |f|
+          f.unlink
+        }
       end
 
       def reset_edge_gateway
@@ -170,14 +164,16 @@ module Vcloud
         })
       end
 
-      def generate_input_config_file(data_file, erb_input)
-        config_erb = File.expand_path("data/#{data_file}", File.dirname(__FILE__))
-        output_file = ErbHelper.convert_erb_template_to_yaml(erb_input, config_erb)
-        @files_to_delete << output_file
-        output_file
+      def generate_vars_file(vars_hash)
+        file = Tempfile.new('vars_file')
+        file.write(vars_hash.to_yaml)
+        file.close
+        @files_to_delete << file
+
+        file.path
       end
 
-      def edge_gateway_erb_input
+      def edge_gateway_vars_hash
         {
           :edge_gateway_name => @edge_name,
           :edge_gateway_ext_network_id => @ext_net_id,

data/spec/integration/edge_gateway/load_balancer_service_spec.rb

@@ -1,27 +1,11 @@
 require 'spec_helper'
+require 'tempfile'
 
 module Vcloud
   describe EdgeGatewayServices do
 
-    required_env = {
-      'VCLOUD_EDGE_GATEWAY' => 'to name of VSE',
-      'VCLOUD_PROVIDER_NETWORK_ID' => 'to ID of VSE external network',
-      'VCLOUD_PROVIDER_NETWORK_IP' => 'to an available IP on VSE external network',
-      'VCLOUD_NETWORK1_ID' => 'to the ID of a VSE internal network',
-      'VCLOUD_NETWORK1_NAME' => 'to the name of the VSE internal network',
-      'VCLOUD_NETWORK1_IP' => 'to an ID on the VSE internal network',
-    }
-
-    error = false
-    required_env.each do |var,message|
-      unless ENV[var]
-        puts "Must set #{var} #{message}" unless ENV[var]
-        error = true
-      end
-    end
-    Kernel.exit(2) if error
-
     before(:all) do
+      IntegrationHelper.verify_env_vars
       @edge_name = ENV['VCLOUD_EDGE_GATEWAY']
       @ext_net_id = ENV['VCLOUD_PROVIDER_NETWORK_ID']
       @ext_net_ip = ENV['VCLOUD_PROVIDER_NETWORK_IP']
@@ -36,8 +20,8 @@ module Vcloud
 
       before(:all) do
         reset_edge_gateway
-        @initial_load_balancer_config_file =
-          generate_input_config_file('load_balancer_config.yaml.erb', edge_gateway_erb_input)
+        @vars_config_file = generate_vars_file(edge_gateway_vars_hash)
+        @initial_load_balancer_config_file = IntegrationHelper.fixture_file('load_balancer_config.yaml.mustache')
         @edge_gateway = Vcloud::Core::EdgeGateway.get_by_name(@edge_name)
       end
 
@@ -46,7 +30,8 @@ module Vcloud
         before(:all) do
           local_config = Core::ConfigLoader.new.load_config(
             @initial_load_balancer_config_file,
-            Vcloud::Schema::EDGE_GATEWAY_SERVICES
+            Vcloud::Schema::EDGE_GATEWAY_SERVICES,
+            @vars_config_file
           )
           @local_vcloud_config  = EdgeGateway::ConfigurationGenerator::LoadBalancerService.new(
             @edge_gateway.interfaces
@@ -63,7 +48,7 @@ module Vcloud
         it "should only make one EdgeGateway update task, to minimise EdgeGateway reload events" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@initial_load_balancer_config_file)
+          EdgeGatewayServices.new.update(@initial_load_balancer_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(1)
         end
@@ -105,7 +90,7 @@ module Vcloud
         it "should not then configure the LoadBalancerService if updated again with the same configuration" do
           expect(Vcloud::Core.logger).
             to receive(:info).with('EdgeGatewayServices.update: Configuration is already up to date. Skipping.')
-          EdgeGatewayServices.new.update(@initial_load_balancer_config_file)
+          EdgeGatewayServices.new.update(@initial_load_balancer_config_file, @vars_config_file)
         end
 
       end
@@ -113,11 +98,8 @@ module Vcloud
       context "Check specific LoadBalancerService update cases" do
 
         it "should be able to configure with no pools and virtual_servers" do
-          config_file = generate_input_config_file(
-            'load_balancer_empty.yaml.erb',
-            edge_gateway_erb_input
-          )
-          EdgeGatewayServices.new.update(config_file)
+          config_file = IntegrationHelper.fixture_file('load_balancer_empty.yaml.mustache')
+          EdgeGatewayServices.new.update(config_file, @vars_config_file)
           edge_config = @edge_gateway.vcloud_attributes[:Configuration]
           remote_vcloud_config = edge_config[:EdgeGatewayServiceConfiguration][:LoadBalancerService]
           expect(remote_vcloud_config[:Pool].size).to be == 0
@@ -125,31 +107,22 @@ module Vcloud
         end
 
         it "should be able to configure with a single Pool and no VirtualServers" do
-          config_file = generate_input_config_file(
-            'load_balancer_single_pool.yaml.erb',
-            edge_gateway_erb_input
-          )
-          EdgeGatewayServices.new.update(config_file)
+          config_file = IntegrationHelper.fixture_file('load_balancer_single_pool.yaml.mustache')
+          EdgeGatewayServices.new.update(config_file, @vars_config_file)
           edge_config = @edge_gateway.vcloud_attributes[:Configuration]
           remote_vcloud_config = edge_config[:EdgeGatewayServiceConfiguration][:LoadBalancerService]
           expect(remote_vcloud_config[:Pool].size).to be == 1
         end
 
         it "should raise an error when trying configure with a single VirtualServer, and no pool mentioned" do
-          config_file = generate_input_config_file(
-            'load_balancer_single_virtual_server_missing_pool.yaml.erb',
-            edge_gateway_erb_input
-          )
-          expect { EdgeGatewayServices.new.update(config_file) }.
+          config_file = IntegrationHelper.fixture_file('load_balancer_single_virtual_server_missing_pool.yaml.mustache')
+          expect { EdgeGatewayServices.new.update(config_file, @vars_config_file) }.
             to raise_error('Supplied configuration does not match supplied schema')
         end
 
         it "should raise an error when trying configure with a single VirtualServer, with an unconfigured pool" do
-          config_file = generate_input_config_file(
-            'load_balancer_single_virtual_server_invalid_pool.yaml.erb',
-            edge_gateway_erb_input
-          )
-          expect { EdgeGatewayServices.new.update(config_file) }.
+          config_file = IntegrationHelper.fixture_file('load_balancer_single_virtual_server_invalid_pool.yaml.mustache')
+          expect { EdgeGatewayServices.new.update(config_file, @vars_config_file) }.
             to raise_error(
               'Load balancer virtual server integration-test-vs-1 does not have a valid backing pool.'
             )
@@ -159,7 +132,9 @@ module Vcloud
 
       after(:all) do
         reset_edge_gateway unless ENV['VCLOUD_NO_RESET_VSE_AFTER']
-        FileUtils.rm(@files_to_delete)
+        @files_to_delete.each { |f|
+          f.unlink
+        }
       end
 
       def reset_edge_gateway
@@ -173,14 +148,16 @@ module Vcloud
         })
       end
 
-      def generate_input_config_file(data_file, erb_input)
-        config_erb = File.expand_path("data/#{data_file}", File.dirname(__FILE__))
-        output_file = ErbHelper.convert_erb_template_to_yaml(erb_input, config_erb)
-        @files_to_delete << output_file
-        output_file
+      def generate_vars_file(vars_hash)
+        file = Tempfile.new('vars_file')
+        file.write(vars_hash.to_yaml)
+        file.close
+        @files_to_delete << file
+
+        file.path
       end
 
-      def edge_gateway_erb_input
+      def edge_gateway_vars_hash
         {
           :edge_gateway_name => @edge_name,
           :edge_gateway_ext_network_id => @ext_net_id,

data/spec/integration/edge_gateway/nat_service_spec.rb

@@ -1,27 +1,11 @@
 require 'spec_helper'
+require 'tempfile'
 
 module Vcloud
   describe EdgeGatewayServices do
 
-    required_env = {
-      'VCLOUD_EDGE_GATEWAY' => 'to name of VSE',
-      'VCLOUD_PROVIDER_NETWORK_ID' => 'to ID of VSE external network',
-      'VCLOUD_PROVIDER_NETWORK_IP' => 'to an available IP on VSE external network',
-      'VCLOUD_NETWORK1_ID' => 'to the ID of a VSE internal network',
-      'VCLOUD_NETWORK1_NAME' => 'to the name of the VSE internal network',
-      'VCLOUD_NETWORK1_IP' => 'to an ID on the VSE internal network',
-    }
-
-    error = false
-    required_env.each do |var,message|
-      unless ENV[var]
-        puts "Must set #{var} #{message}" unless ENV[var]
-        error = true
-      end
-    end
-    Kernel.exit(2) if error
-
     before(:all) do
+      IntegrationHelper.verify_env_vars
       @edge_name = ENV['VCLOUD_EDGE_GATEWAY']
       @ext_net_id = ENV['VCLOUD_PROVIDER_NETWORK_ID']
       @ext_net_ip = ENV['VCLOUD_PROVIDER_NETWORK_IP']
@@ -36,13 +20,8 @@ module Vcloud
 
       before(:all) do
         reset_edge_gateway
-        @initial_nat_config_file = generate_input_config_file(
-          'nat_config.yaml.erb', {
-              edge_gateway_name: @edge_name,
-              network_id: @ext_net_id,
-              original_ip: @ext_net_ip,
-            }
-          )
+        @vars_config_file = generate_vars_file(edge_gateway_vars_hash)
+        @initial_nat_config_file = IntegrationHelper.fixture_file('nat_config.yaml.mustache')
         @edge_gateway = Vcloud::Core::EdgeGateway.get_by_name(@edge_name)
       end
 
@@ -50,7 +29,9 @@ module Vcloud
 
         before(:all) do
           local_config = Core::ConfigLoader.new.load_config(
-            @initial_nat_config_file, Vcloud::Schema::EDGE_GATEWAY_SERVICES
+            @initial_nat_config_file,
+            Vcloud::Schema::EDGE_GATEWAY_SERVICES,
+            @vars_config_file
           )
           @local_vcloud_config  = EdgeGateway::ConfigurationGenerator::NatService.new(
             local_config[:nat_service],
@@ -66,7 +47,7 @@ module Vcloud
         it "should only make one EdgeGateway update task, to minimise EdgeGateway reload events" do
           start_time = Time.now.getutc
           task_list_before_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
-          EdgeGatewayServices.new.update(@initial_nat_config_file)
+          EdgeGatewayServices.new.update(@initial_nat_config_file, @vars_config_file)
           task_list_after_update = get_all_edge_gateway_update_tasks_ordered_by_start_date_since_time(start_time)
           expect(task_list_after_update.size - task_list_before_update.size).to be(1)
         end
@@ -91,7 +72,7 @@ module Vcloud
 
         it "and then should not configure the firewall service if updated again with the same configuration (idempotency)" do
           expect(Vcloud::Core.logger).to receive(:info).with('EdgeGatewayServices.update: Configuration is already up to date. Skipping.')
-          EdgeGatewayServices.new.update(@initial_nat_config_file)
+          EdgeGatewayServices.new.update(@initial_nat_config_file, @vars_config_file)
         end
 
       end
@@ -131,13 +112,16 @@ module Vcloud
       context "ensure hairpin NAT rules are specifiable" do
 
         it "and then should configure hairpin NATting with orgVdcNetwork" do
-          input_config_file = generate_input_config_file('hairpin_nat_config.yaml.erb', {
+          vars_file = generate_vars_file({
             edge_gateway_name: @edge_name,
             org_vdc_network_id: @int_net_id,
             original_ip: @int_net_ip,
           })
 
-          EdgeGatewayServices.new.update(input_config_file)
+          EdgeGatewayServices.new.update(
+            IntegrationHelper.fixture_file('hairpin_nat_config.yaml.mustache'),
+            vars_file
+          )
 
           edge_gateway = Vcloud::Core::EdgeGateway.get_by_name(@edge_name)
           nat_service = edge_gateway.vcloud_attributes[:Configuration][:EdgeGatewayServiceConfiguration][:NatService]
@@ -157,13 +141,18 @@ module Vcloud
 
         it "should raise error if network provided in rule does not exist" do
           random_network_id = SecureRandom.uuid
-          input_config_file = generate_input_config_file('nat_config.yaml.erb', {
+          vars_file = generate_vars_file({
             edge_gateway_name: @edge_name,
             network_id: random_network_id,
             original_ip: @int_net_ip,
           })
-          expect{EdgeGatewayServices.new.update(input_config_file)}.
-            to raise_error("unable to find gateway network interface with id #{random_network_id}")
+
+          expect {
+            EdgeGatewayServices.new.update(
+              IntegrationHelper.fixture_file('nat_config.yaml.mustache'),
+              vars_file
+            )
+          }.to raise_error("unable to find gateway network interface with id #{random_network_id}")
         end
       end
 
@@ -173,7 +162,9 @@ module Vcloud
       end
 
       def remove_temp_config_files
-        FileUtils.rm(@files_to_delete)
+        @files_to_delete.each { |f|
+          f.unlink
+        }
       end
 
       def reset_edge_gateway
@@ -183,18 +174,20 @@ module Vcloud
         })
       end
 
-      def generate_input_config_file(data_file, erb_input)
-        config_erb = File.expand_path("data/#{data_file}", File.dirname(__FILE__))
-        output_file = ErbHelper.convert_erb_template_to_yaml(erb_input, config_erb)
-        @files_to_delete << output_file
-        output_file
+      def generate_vars_file(vars_hash)
+        file = Tempfile.new('vars_file')
+        file.write(vars_hash.to_yaml)
+        file.close
+        @files_to_delete << file
+
+        file.path
       end
 
-      def edge_gateway_erb_input
+      def edge_gateway_vars_hash
         {
           :edge_gateway_name => @edge_name,
-          :edge_gateway_ext_network_id => @ext_net_id,
-          :edge_gateway_ext_network_ip => @ext_net_ip,
+          :network_id => @ext_net_id,
+          :original_ip => @ext_net_ip,
         }
       end
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'simplecov'
-require 'erb_helper'
+require 'support/integration_helper'
 
 SimpleCov.profiles.define 'gem' do
   add_filter '/spec/'

data/spec/support/integration_helper.rb

@@ -0,0 +1,29 @@
+module IntegrationHelper
+  REQUIRED_ENV = {
+    'VCLOUD_EDGE_GATEWAY' => 'to name of VSE',
+    'VCLOUD_PROVIDER_NETWORK_ID' => 'to ID of VSE external network',
+    'VCLOUD_PROVIDER_NETWORK_IP' => 'to an available IP on VSE external network',
+    'VCLOUD_NETWORK1_ID' => 'to the ID of a VSE internal network',
+    'VCLOUD_NETWORK1_NAME' => 'to the name of the VSE internal network',
+    'VCLOUD_NETWORK1_IP' => 'to an ID on the VSE internal network',
+  }
+
+  def self.verify_env_vars
+    error = false
+    REQUIRED_ENV.each do |var,message|
+      unless ENV[var]
+        puts "Must set #{var} #{message}" unless ENV[var]
+        error = true
+      end
+    end
+    Kernel.exit(2) if error
+  end
+
+  def self.fixture_path
+    File.expand_path("../integration/edge_gateway/data", File.dirname(__FILE__))
+  end
+
+  def self.fixture_file(path)
+    File.join(self.fixture_path, path)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-edge_gateway
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -148,15 +148,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/vcloud-configure-edge
-- examples/firewall-rules.yaml
-- examples/loadbalancer-rules.yaml
-- examples/nat-rules.yaml
+- examples/vcloud-configure-edge/firewall-rules.yaml
+- examples/vcloud-configure-edge/loadbalancer-rules.yaml
+- examples/vcloud-configure-edge/nat-rules.yaml
+- examples/vcloud-configure-edge/template-nat-rules.yaml.mustache
+- examples/vcloud-configure-edge/template-vars-env1.yaml
+- examples/vcloud-configure-edge/template-vars-env2.yaml
 - jenkins.sh
 - jenkins_integration_tests.sh
 - lib/vcloud/edge_gateway.rb
@@ -175,25 +179,25 @@ files:
 - lib/vcloud/schema/firewall_service.rb
 - lib/vcloud/schema/load_balancer_service.rb
 - lib/vcloud/schema/nat_service.rb
-- spec/erb_helper.rb
-- spec/integration/edge_gateway/data/firewall_config.yaml.erb
-- spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.erb
-- spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.erb
-- spec/integration/edge_gateway/data/hairpin_nat_config.yaml.erb
+- spec/integration/edge_gateway/data/firewall_config.yaml.mustache
+- spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.mustache
+- spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.mustache
+- spec/integration/edge_gateway/data/hairpin_nat_config.yaml.mustache
 - spec/integration/edge_gateway/data/incorrect_firewall_config.yaml
-- spec/integration/edge_gateway/data/load_balancer_config.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_empty.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_pool.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_invalid_pool.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_missing_pool.yaml.erb
-- spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.erb
-- spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.erb
-- spec/integration/edge_gateway/data/nat_config.yaml.erb
+- spec/integration/edge_gateway/data/load_balancer_config.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_empty.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_pool.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_invalid_pool.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_missing_pool.yaml.mustache
+- spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.mustache
+- spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.mustache
+- spec/integration/edge_gateway/data/nat_config.yaml.mustache
 - spec/integration/edge_gateway/edge_gateway_services_spec.rb
 - spec/integration/edge_gateway/firewall_service_spec.rb
 - spec/integration/edge_gateway/load_balancer_service_spec.rb
 - spec/integration/edge_gateway/nat_service_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_helper.rb
 - spec/vcloud/data/basic_preamble_test.erb
 - spec/vcloud/data/basic_preamble_test.erb.OUT
 - spec/vcloud/data/working.json
@@ -240,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1568405041543007530
+      hash: 2640084330965865907
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -248,25 +252,25 @@ signing_key:
 specification_version: 3
 summary: Tool to configure a VMware vCloud Edge Gateway
 test_files:
-- spec/erb_helper.rb
-- spec/integration/edge_gateway/data/firewall_config.yaml.erb
-- spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.erb
-- spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.erb
-- spec/integration/edge_gateway/data/hairpin_nat_config.yaml.erb
+- spec/integration/edge_gateway/data/firewall_config.yaml.mustache
+- spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.mustache
+- spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.mustache
+- spec/integration/edge_gateway/data/hairpin_nat_config.yaml.mustache
 - spec/integration/edge_gateway/data/incorrect_firewall_config.yaml
-- spec/integration/edge_gateway/data/load_balancer_config.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_empty.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_pool.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_invalid_pool.yaml.erb
-- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_missing_pool.yaml.erb
-- spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.erb
-- spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.erb
-- spec/integration/edge_gateway/data/nat_config.yaml.erb
+- spec/integration/edge_gateway/data/load_balancer_config.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_empty.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_pool.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_invalid_pool.yaml.mustache
+- spec/integration/edge_gateway/data/load_balancer_single_virtual_server_missing_pool.yaml.mustache
+- spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.mustache
+- spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.mustache
+- spec/integration/edge_gateway/data/nat_config.yaml.mustache
 - spec/integration/edge_gateway/edge_gateway_services_spec.rb
 - spec/integration/edge_gateway/firewall_service_spec.rb
 - spec/integration/edge_gateway/load_balancer_service_spec.rb
 - spec/integration/edge_gateway/nat_service_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_helper.rb
 - spec/vcloud/data/basic_preamble_test.erb
 - spec/vcloud/data/basic_preamble_test.erb.OUT
 - spec/vcloud/data/working.json

data/spec/erb_helper.rb

@@ -1,11 +0,0 @@
-class ErbHelper
-  def self.convert_erb_template_to_yaml test_namespace, input_erb_config
-    input_erb_config = input_erb_config
-    e = ERB.new(File.open(input_erb_config).read)
-    output_yaml_config = File.join(File.dirname(input_erb_config), "output_#{Time.now.strftime('%s.%6N')}.yaml")
-    File.open(output_yaml_config, 'w') { |f|
-      f.write e.result(OpenStruct.new(test_namespace).instance_eval { binding })
-    }
-    output_yaml_config
-  end
-end