vcloud-tools-tester 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.3.0 (2014-10-06)
+
+Features:
+
+  - Fixture creation (specifically networks at present) is now optional, based on
+    whether the 'network_1' or 'network_2' keys are required. Prevents unneccessary
+    pre-requisites for integration tests that do not require these fixtures, and should
+    be automatically enabled.
+
 ## 0.2.0 (2014-08-11)
 
 API changes:

data/lib/vcloud/tools/tester/fixture_parameters.rb

@@ -4,9 +4,10 @@ module Vcloud
       class FixtureParameters
         attr_reader :fixture_params
 
-        def initialize(user_params)
+        def initialize(user_params, expected_params)
           @vcloud_api = Vcloud::Core::ApiInterface.new
           @user_params = user_params
+          @expected_params = expected_params
           ensure_vcloud_fixtures
           extract_fixture_params
         end
@@ -14,58 +15,20 @@ module Vcloud
         private
 
         def ensure_vcloud_fixtures
-          generate_fixtures_config
-          correct_networks = ensure_networks_correct(@expected_fixtures_config[:networks])
-          @fixtures = correct_networks
+          @fixtures = ensure_networks_correct(generate_fixtures_config[:networks])
         end
 
         def generate_fixtures_config
-          @expected_fixtures_config = {
-            :networks => {
-              :network_1 => {
-                :edge_gateway => @user_params["edge_gateway"],
-                :vdc_name     => @user_params["vdc_1_name"],
-                :name         => @user_params["network_1"],
-                :type         => 'application/vnd.vmware.vcloud.orgVdcNetwork+xml',
-                :description  => '',
-                :is_inherited => 'false',
-                :is_shared    => 'true',
-                :fence_mode   => 'natRouted',
-                :gateway      => '192.168.1.1',
-                :netmask      => '255.255.255.0',
-                :dns1         => nil,
-                :dns2         => nil,
-                :dns_suffix   => nil,
-                :ip_ranges    => [
-                  {
-                    :start_address  => "192.168.1.2",
-                    :end_address    => "192.168.1.254"
-                  }
-                ],
-              },
-              :network_2 => {
-                :edge_gateway => @user_params["edge_gateway"],
-                :vdc_name     => @user_params["vdc_2_name"],
-                :name         => @user_params["network_2"],
-                :type         => 'application/vnd.vmware.vcloud.orgVdcNetwork+xml',
-                :description  => '',
-                :is_inherited => 'false',
-                :is_shared    => 'true',
-                :fence_mode   => 'isolated',
-                :gateway      => '10.0.0.1',
-                :netmask      => '255.255.0.0',
-                :dns1         => nil,
-                :dns2         => nil,
-                :dns_suffix   => nil,
-                :ip_ranges    => [
-                  {
-                    :start_address  => "10.0.0.2",
-                    :end_address    => "10.0.255.254"
-                  }
-                ],
-              },
-            },
+          expected_fixtures_config = {
+            :networks => {},
           }
+          if @expected_params.include?("network_1")
+            expected_fixtures_config[:networks][:network_1] = expected_network_1_config
+          end
+          if @expected_params.include?("network_2")
+            expected_fixtures_config[:networks][:network_2] = expected_network_2_config
+          end
+          expected_fixtures_config
         end
 
         def ensure_networks_correct(expected_network_config)
@@ -95,14 +58,13 @@ module Vcloud
         end
 
         def extract_fixture_params
-          raise "No fixtures present" if @fixtures.empty?
 
           @fixture_params = {}
 
           @fixtures.each do |fixture|
             case fixture
             when ::Fog::Compute::VcloudDirector::Network, Vcloud::Core::OrgVdcNetwork
-              @expected_fixtures_config[:networks].each do |network_ref, expected_network_config|
+              generate_fixtures_config[:networks].each do |network_ref, expected_network_config|
                 if expected_network_config[:name] == fixture.name
                   @fixture_params["#{network_ref}_id"] = fixture.id
                 end
@@ -147,6 +109,55 @@ module Vcloud
 
           false
         end
+
+        def expected_network_1_config
+          {
+            :edge_gateway => @user_params["edge_gateway"],
+            :vdc_name     => @user_params["vdc_1_name"],
+            :name         => @user_params["network_1"],
+            :type         => 'application/vnd.vmware.vcloud.orgVdcNetwork+xml',
+            :description  => '',
+            :is_inherited => 'false',
+            :is_shared    => 'true',
+            :fence_mode   => 'natRouted',
+            :gateway      => '192.168.1.1',
+            :netmask      => '255.255.255.0',
+            :dns1         => nil,
+            :dns2         => nil,
+            :dns_suffix   => nil,
+            :ip_ranges    => [
+              {
+                :start_address  => "192.168.1.2",
+                :end_address    => "192.168.1.254"
+              }
+            ],
+          }
+        end
+
+        def expected_network_2_config
+          {
+            :edge_gateway => @user_params["edge_gateway"],
+            :vdc_name     => @user_params["vdc_2_name"],
+            :name         => @user_params["network_2"],
+            :type         => 'application/vnd.vmware.vcloud.orgVdcNetwork+xml',
+            :description  => '',
+            :is_inherited => 'false',
+            :is_shared    => 'true',
+            :fence_mode   => 'isolated',
+            :gateway      => '10.0.0.1',
+            :netmask      => '255.255.0.0',
+            :dns1         => nil,
+            :dns2         => nil,
+            :dns_suffix   => nil,
+            :ip_ranges    => [
+              {
+                :start_address  => "10.0.0.2",
+                :end_address    => "10.0.255.254"
+              }
+            ],
+          }
+        end
+
       end
     end
   end

data/lib/vcloud/tools/tester/test_parameters.rb

@@ -6,7 +6,6 @@ module Vcloud
       class TestParameters
         def initialize(user_params, fixture_params)
           raise "No user parameters received" if user_params.empty?
-          raise "No fixture parameters received" if fixture_params.empty?
 
           @user_params = user_params
           @fixture_params = fixture_params

data/lib/vcloud/tools/tester/test_setup.rb

@@ -6,9 +6,9 @@ module Vcloud
       class TestSetup
         attr_reader :test_params
 
-        def initialize(config_file, expected_user_params)
-          user_params = Vcloud::Tools::Tester::UserParameters.new(config_file, expected_user_params).user_params
-          fixture_params = Vcloud::Tools::Tester::FixtureParameters.new(user_params).fixture_params
+        def initialize(config_file, expected_params)
+          user_params = Vcloud::Tools::Tester::UserParameters.new(config_file, expected_params).user_params
+          fixture_params = Vcloud::Tools::Tester::FixtureParameters.new(user_params, expected_params).fixture_params
 
           @test_params = Vcloud::Tools::Tester::TestParameters.new(user_params, fixture_params)
         end

data/lib/vcloud/tools/tester/user_parameters.rb

@@ -6,9 +6,9 @@ module Vcloud
       class UserParameters
         attr_reader :user_params
 
-        def initialize(config_file, expected_user_params)
+        def initialize(config_file, expected_params)
           @config_file = config_file
-          @expected_user_params = expected_user_params || []
+          @expected_params = expected_params || []
 
           parse_config
         end
@@ -27,11 +27,11 @@ module Vcloud
           all_config = YAML::load_file(@config_file)
 
           @user_params = all_config.fetch(organization) do
-            raise "Invalid FOG_CREDENTIAL environment variable value '#{organization}'"
+            raise "No matching organisation was found in #{@config_file} for FOG_CREDENTIAL value '#{organization}'"
           end
 
           defined_keys = @user_params.keys
-          missing_params = @expected_user_params - defined_keys
+          missing_params = @expected_params - defined_keys
           if missing_params.any?
             raise "Required parameters not defined in #{@config_file}: " + missing_params.join(", ")
           end

data/lib/vcloud/tools/tester/version.rb

@@ -1,7 +1,7 @@
 module Vcloud
   module Tools
     module Tester
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/spec/vcloud/tools/tester/fixture_parameters_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'vcloud/tools/tester'
 
 describe Vcloud::Tools::Tester::FixtureParameters do
-  subject { Vcloud::Tools::Tester::FixtureParameters.new(user_params) }
+  subject { Vcloud::Tools::Tester::FixtureParameters.new(user_params, expected_params) }
 
   before(:each) do
     stub_const("Fog::Compute::VcloudDirector::Network", Object)
@@ -30,6 +30,16 @@ describe Vcloud::Tools::Tester::FixtureParameters do
     }
   end
 
+  let(:expected_params) do
+    [
+      "edge_gateway",
+      "vdc_1_name",
+      "vdc_2_name",
+      "network_1",
+      "network_2",
+    ]
+  end
+
   let(:mock_found_vdcs) do
     [
       mock_vdc_1,
@@ -158,4 +168,23 @@ describe Vcloud::Tools::Tester::FixtureParameters do
       expect(subject.fixture_params.values).to eq(mock_fixture_uuids)
     end
   end
+
+  context "when none of the network fixtures are needed" do
+
+    let(:networkless_expected_params) {
+      [
+        "edge_gateway",
+        "vdc_1_name",
+        "vdc_2_name",
+      ]
+    }
+
+    subject { Vcloud::Tools::Tester::FixtureParameters.new(user_params, networkless_expected_params) }
+
+    it "returns an empty fixture_params hash" do
+      expect(subject.fixture_params).to eq({})
+    end
+
+  end
+
 end

data/spec/vcloud/tools/tester/test_parameters_spec.rb

@@ -47,12 +47,5 @@ describe Vcloud::Tools::Tester::TestParameters do
         expect{ parameters }.to raise_error("No user parameters received")
       end
     end
-
-    context "no fixture parameters passed in" do
-      let(:fixture_params) {{}}
-      it "raises an error if it receives no fixture parameters" do
-        expect{ parameters }.to raise_error("No fixture parameters received")
-      end
-    end
   end
 end

data/spec/vcloud/tools/tester/test_setup_spec.rb

@@ -9,7 +9,7 @@ describe Vcloud::Tools::Tester::TestSetup do
   end
 
   let(:example_filename) { "example_filename.yaml" }
-  let(:expected_user_params) { [] }
+  let(:expected_params) { [] }
 
   let(:mock_user_parameters) do
     double(:user_parameters, :user_params => {})
@@ -24,7 +24,7 @@ describe Vcloud::Tools::Tester::TestSetup do
   end
 
   subject do
-    Vcloud::Tools::Tester::TestSetup.new(example_filename, expected_user_params)
+    Vcloud::Tools::Tester::TestSetup.new(example_filename, expected_params)
   end
 
   it "responds with test parameters" do
@@ -32,8 +32,8 @@ describe Vcloud::Tools::Tester::TestSetup do
   end
 
   it "calls the appropriate methods" do
-    expect(Vcloud::Tools::Tester::UserParameters).to receive(:new).with(example_filename, expected_user_params)
-    expect(Vcloud::Tools::Tester::FixtureParameters).to receive(:new).with({})
+    expect(Vcloud::Tools::Tester::UserParameters).to receive(:new).with(example_filename, expected_params)
+    expect(Vcloud::Tools::Tester::FixtureParameters).to receive(:new).with({}, expected_params)
     expect(Vcloud::Tools::Tester::TestParameters).to receive(:new).with({}, {})
 
     subject.test_params

data/spec/vcloud/tools/tester/user_parameters_spec.rb

@@ -3,7 +3,7 @@ require 'vcloud/tools/tester'
 
 describe Vcloud::Tools::Tester::UserParameters do
   subject(:parameters) do
-    Vcloud::Tools::Tester::UserParameters.new(config_file, expected_user_params).user_params
+    Vcloud::Tools::Tester::UserParameters.new(config_file, expected_params).user_params
   end
 
   before(:each) do
@@ -18,7 +18,7 @@ describe Vcloud::Tools::Tester::UserParameters do
     "#{data_dir}/test_config.yaml"
   end
 
-  let(:expected_user_params) {[]}
+  let(:expected_params) {[]}
   context "loading standard config file" do
     it "loads input yaml when intialized" do
       test_vdc = parameters["vdc_1_name"]
@@ -33,12 +33,12 @@ describe Vcloud::Tools::Tester::UserParameters do
 
     it "gives a useful error when the FOG_CREDENTIAL is missing from the config" do
       stub_const('ENV', {'FOG_CREDENTIAL' => 'bogus-fog-credential'})
-      expect { parameters }.to raise_error(RuntimeError, /Invalid FOG_CREDENTIAL environment variable value/)
+      expect { parameters }.to raise_error(RuntimeError, /No matching organisation was found in/)
     end
   end
 
   context "when an expected user-defined parameter is missing from the config file" do
-    let(:expected_user_params) { [ "vdc_1_name", "bar" ] }
+    let(:expected_params) { [ "vdc_1_name", "bar" ] }
 
     it "raises an error if an expected user-defined parameter is not present" do
       expect{ parameters }.to raise_error(RuntimeError, "Required parameters not defined in #{config_file}: bar")
@@ -47,7 +47,7 @@ describe Vcloud::Tools::Tester::UserParameters do
 
   context "loading minimal config file" do
     subject(:parameters) do
-      Vcloud::Tools::Tester::UserParameters.new("#{data_dir}/test_minimal_config.yaml", expected_user_params).user_params
+      Vcloud::Tools::Tester::UserParameters.new("#{data_dir}/test_minimal_config.yaml", expected_params).user_params
     end
 
     it "input yaml file can be changed" do
@@ -64,7 +64,7 @@ describe Vcloud::Tools::Tester::UserParameters do
 
   context "loading non-existent config file" do
     subject(:parameters) do
-      Vcloud::Tools::Tester::UserParameters.new("#{data_dir}/nonexistent_config_file.yaml", expected_user_params).user_params
+      Vcloud::Tools::Tester::UserParameters.new("#{data_dir}/nonexistent_config_file.yaml", expected_params).user_params
     end
 
     it "gives a useful error when there is no config file" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-tools-tester
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,27 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7024540 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
+  version_requirements: *7024540
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7023740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *7023740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7023000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *7023000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7021480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -69,15 +54,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
+  version_requirements: *7021480
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7018860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,15 +65,10 @@ dependencies:
         version: 0.23.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.23.0
+  version_requirements: *7018860
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7046520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,15 +76,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.1
+  version_requirements: *7046520
 - !ruby/object:Gem::Dependency
   name: vcloud-core
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &7044820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -117,12 +87,7 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+  version_requirements: *7044820
 description: Tool to facilitate testing of vCloud Tools
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
@@ -175,10 +140,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3686057879377265780
+      hash: 2091558975490885511
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: vCloud Tools integration tests require secret parameters. This helps you