vcloud-core 0.5.0 → 0.6.0

data/.travis.yml

@@ -2,5 +2,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.2
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,10 +1,19 @@
+## 0.6.0 (2014-07-14)
+
+API changes:
+
+  - The minimum required Ruby version is now 1.9.3.
+  - The interface to `Vcloud::Core::Vm#configure_guest_customization_section`
+    has changed and much of its logic has moved to the vCloud Launcher gem.
+    Thanks to @bazbremner for this contribution.
+
 ## 0.5.0 (2014-05-30)
 
 Features:
 
   - `vcloud-query --version` now only returns the version string and no
     usage information.
-  - Support 'pool' mode for VM IP address allocation.
+  - Support 'pool' mode for VM IP address allocation. Thanks @geriBatai.
 
 ## 0.4.0 (2014-05-23)
 

data/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to vCloud Core
+
+We really welcome contributions.
+
+## A quick guide on how to contribute
+
+1. Clone the repo:
+
+        git clone git@github.com:gds-operations/vcloud-core.git
+
+2. Run `bundle` to get the required dependecies
+
+3. Run the tests. Pull requests that add features must include unit tests,
+   so it is good to ensure you've got them passing to begin with.
+
+        bundle exec rake
+
+   If you have access to a live environment for testing, it would be great
+   if you could run the integration tests too - for more details on the
+   set-up for that, please see the [integration tests README]
+   (https://github.com/gds-operations/vcloud-core/blob/master/spec/integration/README.md)
+
+4. Add your functionality or bug fix and a test for your change. Only refactoring and
+   documentation changes do not require tests. If the functionality is at all complicated
+   then it is likely that more than one test will be required. If you would like help
+   with writing tests please do ask us.
+
+5. Make sure all the tests pass, including the integration tests if possible.
+
+6. Update the [CHANGELOG](https://github.com/gds-operations/vcloud-core/blob/master/CHANGELOG.md)
+   with a short description of what the change is. This may be a feature, a bugfix, or an
+   API change. If your change is documenation or refactoring, you do not need to add a line
+   to the CHANGELOG.
+
+7. Fork the repo, push to your fork, and submit a pull request.
+
+## How soon will we respond?
+
+We will comment on your pull request within two working days. However, we might not be able to review it immediately.
+
+We may come back to you with comments and suggestions, and if we would like you to make changes, we will close the pull request as well as adding details of the changes we'd like you to make.
+
+If you feel your pull request has been outstanding too long, please feel free to bump it by making a comment on it.
+
+## Guidelines for making a pull request
+
+    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
+    "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be
+    interpreted as described in RFC 2119.
+
+## In order for a pull request to be accepted, it MUST
+
+- Include at least one test (unless it is documentation or refactoring). If you have any questions about how to write tests, please ask us, we will be happy to help
+- Follow our [Git style guide](https://github.com/alphagov/styleguides/blob/master/git.md)
+- Include a clear summary in the pull request comments as to what the change is and why
+  you are making it
+- Be readable - we might ask you to change unclear variable names or obscure syntactic sugar
+- Have [good commit messages](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
+  that explain the change being made in that commit. Don't be afraid to write a lot in the
+  detail.
+
+## In order for a pull request to be accepted, it SHOULD
+
+- Include a line in the CHANGELOG unless it is a refactoring or documentation change
+- If it is code, follow our [Ruby style guide](https://github.com/alphagov/styleguides/blob/master/ruby.md)
+- If it is documentation, follow the [GDS content style guide](https://www.gov.uk/design-principles/style-guide/style-points)

data/README.md

@@ -1,8 +1,8 @@
-# VCloud Core
+# vCloud Core
 
-VCloud Core is a gem that supports automatated provisioning of VMWare vCloud Director. It uses Fog under the hood. Primarily developed to support [VCloud Walker](https://github.com/alphagov/vcloud-walker) and [VCloud Tools](https://github.com/alphagov/vcloud-tools).
+vCloud Core is a gem that supports automatated provisioning of VMWare vCloud Director. It uses Fog under the hood. Primarily developed to support [vCloud Walker](https://github.com/gds-operations/vcloud-walker) and [vCloud Tools](https://github.com/gds-operations/vcloud-tools).
 
-VCloud Core includes VCloud Query and a command-line wrapper for VCloud Query.
+vCloud Core includes vCloud Query and a command-line wrapper for vCloud Query.
 
 ## Installation
 
@@ -56,11 +56,11 @@ credentials that allow it to talk to a vCloud Director environment.
   password in the fog file. This is **not recommended**.
 
 
-## VCloud Query
+## vCloud Query
 
 ### Get results from the vCloud Query API
 
-VCloud Query is a light wrapper around the vCloud Query API.
+vCloud Query is a light wrapper around the vCloud Query API.
 
 Any, or all, records of a particular 'type' can be returned. These types map to 
 entities in the vCloud system itself, eg: 'vm', 'vApp', 'orgVdc', 'edgeGateway'.

data/Rakefile

@@ -22,6 +22,6 @@ task :publish_gem do
 end
 
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop) do |task|
+RuboCop::RakeTask.new(:rubocop) do |task|
   task.options = ['--lint']
 end

data/lib/vcloud/core/config_validator.rb

@@ -1,26 +1,26 @@
 require 'ipaddr'
 
-##
-# self::validate is entry point; this class method is called to
-# instantiate ConfigValidator. For example:
-#
-# Core::ConfigValidator.validate(key, data, schema)
-#
-# = Recursion in this class
-#
-#   Note that this class will recursively call itself in order to validate deep
-#   hash and array structures.
-#
-#   The +data+ variable is usually either an array or hash and so will pass
-#   through the ConfigValidator#validate_array and
-#   ConfigValidator#validate_hash methods respectively.
-#
-#   These methods then recursively instantiate this class by calling
-#   ConfigValidator::validate again (ConfigValidator#validate_hash calls this
-#   indirectly via the ConfigValidator#check_hash_parameter method).
-
 module Vcloud
   module Core
+    ##
+    # self::validate is entry point; this class method is called to
+    # instantiate ConfigValidator. For example:
+    #
+    # Core::ConfigValidator.validate(key, data, schema)
+    #
+    # = Recursion in this class
+    #
+    # Note that this class will recursively call itself in order to validate deep
+    # hash and array structures.
+    #
+    # The +data+ variable is usually either an array or hash and so will pass
+    # through the ConfigValidator#validate_array and
+    # ConfigValidator#validate_hash methods respectively.
+    #
+    # These methods then recursively instantiate this class by calling
+    # ConfigValidator::validate again (ConfigValidator#validate_hash calls this
+    # indirectly via the ConfigValidator#check_hash_parameter method).
+    #
     class ConfigValidator
 
       attr_reader :key, :data, :schema, :type, :errors, :warnings
@@ -252,7 +252,7 @@ module Vcloud
 
       def validate_string
         unless @data.is_a? String
-          errors << "#{key}: #{@data} is not a string"
+          @errors << "#{key}: #{@data} is not a string"
           return
         end
         return unless check_emptyness_ok

data/lib/vcloud/core/query_cli.rb

@@ -34,7 +34,7 @@ Query types map to vCloud entities, for example: vApp, vm, orgVdc, orgVdcNetwork
 
 Without a type argument, returns a list of available Entity Types to query.
 
-See https://github.com/alphagov/vcloud-tools/blob/master/README.md for more info.
+See https://github.com/gds-operations/vcloud-tools/blob/master/README.md for more info.
 
 Example use:
 

data/lib/vcloud/core/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Core
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/vcloud/core/vm.rb

@@ -102,36 +102,10 @@ module Vcloud
         Vcloud::Fog::ServiceInterface.new.put_network_connection_system_section_vapp(id, section)
       end
 
-      def configure_guest_customization_section(name, bootstrap_config, extra_disks)
-        if bootstrap_config.nil? or bootstrap_config[:script_path].nil?
-          interpolated_preamble = ''
-        else
-          preamble_vars = bootstrap_config[:vars] || {}
-          preamble_vars.merge!(:extra_disks => extra_disks)
-          interpolated_preamble = generate_preamble(
-              bootstrap_config[:script_path],
-              bootstrap_config[:script_post_processor],
-              preamble_vars,
-          )
-        end
-        Vcloud::Fog::ServiceInterface.new.put_guest_customization_section(id, name, interpolated_preamble)
-      end
-
-      def generate_preamble(script_path, script_post_processor, preamble_vars)
-        erb_vars = OpenStruct.new({
-          vapp_name: vapp_name,
-          vars: preamble_vars
-        })
-        erb_vars_binding_object = erb_vars.instance_eval { binding }
-        erb_output = interpolate_erb_file(script_path, erb_vars_binding_object)
-        if script_post_processor
-          post_process_erb_output(erb_output, script_post_processor) if script_post_processor
-        else
-          erb_output
-        end
+      def configure_guest_customization_section(preamble)
+        Vcloud::Fog::ServiceInterface.new.put_guest_customization_section(id, vapp_name, preamble)
       end
 
-
       def update_storage_profile storage_profile
         storage_profile_href = get_storage_profile_href_by_name(storage_profile, @vapp.name)
         Vcloud::Fog::ServiceInterface.new.put_vm(id, name, {
@@ -144,17 +118,6 @@ module Vcloud
 
       private
 
-      def interpolate_erb_file(erb_file, binding_object)
-        ERB.new(File.read(File.expand_path(erb_file)), nil, '>-').result(binding_object)
-      end
-
-      def post_process_erb_output(data_to_process, post_processor_script)
-        # Open3.capture2, as we just need to return STDOUT of the post_processor_script
-        Open3.capture2(
-          File.expand_path(post_processor_script),
-          stdin_data: data_to_process).first
-      end
-
       def virtual_hardware_section
         vcloud_attributes[:'ovf:VirtualHardwareSection'][:'ovf:Item']
       end

data/lib/vcloud/fog/service_interface.rb

@@ -9,7 +9,7 @@ module Vcloud
                      :get_execute_query, :get_vapp_metadata, :power_off_vapp, :shutdown_vapp, :session,
                      :post_instantiate_vapp_template, :put_memory, :put_cpu, :power_on_vapp, :put_vapp_metadata_value,
                      :put_vm, :get_edge_gateway, :get_network_complete, :delete_network, :post_create_org_vdc_network,
-                     :post_configure_edge_gateway_services, :get_vdc
+                     :post_configure_edge_gateway_services, :get_vdc, :post_undeploy_vapp
 
       #########################
       # FogFacade Inner class to represent a logic free facade over our interactions with Fog
@@ -19,12 +19,12 @@ module Vcloud
           @vcloud = ::Fog::Compute::VcloudDirector.new
         end
 
-        def get_vdc(name)
-          @vcloud.get_vdc(name).body
+        def get_vdc(id)
+          @vcloud.get_vdc(id).body
         end
 
-        def get_organization (name)
-          @vcloud.get_organization(name).body
+        def get_organization (id)
+          @vcloud.get_organization(id).body
         end
 
         def session
@@ -99,6 +99,11 @@ module Vcloud
           @vcloud.org_name
         end
 
+        def post_undeploy_vapp(vapp_id)
+          task = @vcloud.post_undeploy_vapp(vapp_id).body
+          @vcloud.process_task(task)
+        end
+
         def delete_vapp(vapp_id)
           task = @vcloud.delete_vapp(vapp_id).body
           @vcloud.process_task(task)

data/spec/integration/README.md

@@ -15,7 +15,7 @@
   and update with parameters suitable for your environment.
 
 - You need to include the set-up for your testing environment in your
-  [fog file](https://github.com/alphagov/vcloud-core#credentials).
+  [fog file](https://github.com/gds-operations/vcloud-core#credentials).
 
 - The tests use the [vCloud Tools Tester](http://rubygems.org/gems/vcloud-tools-tester) gem.
   You do not need to install this, `bundler` will do this for you.

data/spec/integration/core/edge_gateway_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+module Vcloud
+  module Core
+    describe EdgeGateway do
+
+      before(:all) do
+        config_file = File.join(File.dirname(__FILE__), "../vcloud_tools_testing_config.yaml")
+        required_user_params = [
+          "edge_gateway",
+          "edge_gateway_id",
+          "network_1",
+          "network_1_id",
+          "provider_network_id",
+        ]
+
+        @test_params = Vcloud::Tools::Tester::TestSetup.new(config_file, required_user_params).test_params
+      end
+
+      let(:edge_gateway) { EdgeGateway.get_by_name(@test_params.edge_gateway) }
+      let(:spurious_id)  { "12345678-1234-1234-1234-123456789012" }
+
+      context "when updating the edge gateway" do
+        before(:each) do
+          IntegrationHelper.reset_edge_gateway(edge_gateway)
+        end
+
+        it "updates as expected" do
+          configuration = {
+            :FirewallService =>
+            {
+              :IsEnabled        => "true",
+              :FirewallRule     => [],
+              :DefaultAction    => "drop",
+              :LogDefaultAction => "false",
+            },
+            :LoadBalancerService =>
+            {
+              :IsEnabled      => "true",
+              :Pool           => [],
+              :VirtualServer  => [],
+            },
+            :NatService =>
+            {
+              :IsEnabled  => "true",
+              :NatRule    => [],
+            },
+          }
+
+          edge_gateway.update_configuration(configuration)
+
+          actual_config = edge_gateway.vcloud_attributes[:Configuration][:EdgeGatewayServiceConfiguration]
+
+          expect(actual_config[:FirewallService]).to      eq(configuration[:FirewallService])
+          expect(actual_config[:LoadBalancerService]).to  eq(configuration[:LoadBalancerService])
+          expect(actual_config[:NatService]).to           eq(configuration[:NatService])
+        end
+      end
+
+      context "get vCloud attributes for given gateway interface ID" do
+        it "returns a provider network" do
+          network_interface = edge_gateway.vcloud_gateway_interface_by_id(@test_params.provider_network_id)
+          expect(network_interface[:Network]).not_to be_nil
+          expect(network_interface[:Network][:href]).to include(@test_params.provider_network_id)
+        end
+
+        it "returns an orgVdcNetwork" do
+          network_interface = edge_gateway.vcloud_gateway_interface_by_id(@test_params.network_1_id)
+          expect(network_interface[:Network]).not_to be_nil
+          expect(network_interface[:Network][:href]).to include(@test_params.network_1_id)
+        end
+
+        it "returns nil if network with given ID is not found" do
+          network_interface = edge_gateway.vcloud_gateway_interface_by_id(spurious_id)
+          expect(network_interface).to be_nil
+        end
+      end
+
+      context "when retrieving an edge gateway ID (singular) by name" do
+        it "returns the an edge gateway object for that name" do
+          # See `let` statement above which calls EdgeGateway::get_by_name
+          expect(edge_gateway).to    be_a(Vcloud::Core::EdgeGateway)
+          expect(edge_gateway.id).to eq(@test_params.edge_gateway_id)
+        end
+
+        it "raise an exception if edge gateway with given ID is not found" do
+          name = "this-would-never-exist"
+          expect { Vcloud::Core::EdgeGateway.get_by_name(name) }.to raise_error("edgeGateway #{name} not found")
+        end
+      end
+
+      context "when retrieving edge gateway IDs (plural) by name" do
+        it "returns the correct ID for that name" do
+          ids = Vcloud::Core::EdgeGateway.get_ids_by_name(@test_params.edge_gateway)
+          expect(ids.first).to eq(@test_params.edge_gateway_id)
+        end
+
+        it "returns an empty array if edge gateway with given ID is not found" do
+          name = "this-would-never-exist"
+          ids = Vcloud::Core::EdgeGateway.get_ids_by_name(name)
+          expect(ids).to eq([])
+        end
+      end
+
+      context "when retrieving vCloud attributes" do
+        it "returns the correct edge gateway for a given ID" do
+          vcloud_attributes = edge_gateway.vcloud_attributes
+          expect(vcloud_attributes[:href]).to include(@test_params.edge_gateway_id)
+        end
+
+        it "returns the correct href for a given edge gateway" do
+          href = edge_gateway.href
+          expect(href).to include(@test_params.edge_gateway_id)
+        end
+
+        it "returns the correct name for a given edge gateway" do
+          name = edge_gateway.name
+          expect(name).to eq(@test_params.edge_gateway)
+        end
+      end
+
+      context "when retrieving a gateway's interfaces" do
+        it "returns an array of interface objects" do
+          interfaces = edge_gateway.interfaces
+          network_1_interface = interfaces.detect { |i| i.name == @test_params.network_1 }
+
+          expect(interfaces.first).to         be_a(Vcloud::Core::EdgeGatewayInterface)
+          expect(network_1_interface.name).to eq(@test_params.network_1)
+        end
+      end
+    end
+  end
+end

data/spec/integration/core/query_runner_spec.rb

@@ -6,10 +6,16 @@ module Vcloud
 
       before(:all) do
         config_file = File.join(File.dirname(__FILE__), "../vcloud_tools_testing_config.yaml")
-        test_data = Vcloud::Tools::Tester::TestParameters.new(config_file)
-        @vapp_template_name = test_data.vapp_template
-        @vapp_template_catalog_name = test_data.catalog
-        @vdc_name = test_data.vdc_1_name
+        required_user_params = [
+          "catalog",
+          "vapp_template",
+          "vdc_1_name",
+        ]
+
+        test_params = Vcloud::Tools::Tester::TestSetup.new(config_file, required_user_params).test_params
+        @vapp_template_name = test_params.vapp_template
+        @vapp_template_catalog_name = test_params.catalog
+        @vdc_name = test_params.vdc_1_name
       end
 
       context "#available_query_types" do