vcloud-tools-tester 0.0.6 → 0.1.0

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+/coverage/

data/.travis.yml

@@ -2,8 +2,7 @@
 language: ruby
 rvm:
   - 1.9.3
-branches:
-  except:
-    - master
+  - 2.0.0
+  - 2.1.2
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.1.0 (2014-06-23)
+
+Features:
+
+  - Test parameters should now be accessed by calling:
+
+    ```ruby
+    test_params = Vcloud::Tools::Tester::TestSetup.new(config_file, expected_user_params).test_params
+    ```
+  - Vcloud::Tools::Tester::TestSetup now creates network fixtures if not already
+    present in the environment and sets the network ID parameters by quering the API.
+  - Now possible to specify which user-defined parameters should be defined in the
+    YAML-formatted configuration file; passed as an array to TestSetup#initialize.
+
 ## 0.0.6 (2014-05-28)
 
 Features:

data/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to vCloud Tools Tester
+
+We really welcome contributions.
+
+## A quick guide on how to contribute
+
+1. Clone the repo:
+
+        git clone git@github.com:gds-operations/vcloud-tools-tester.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
+
+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.
+
+6. Update the [CHANGELOG](https://github.com/gds-operations/vcloud-tools-tester/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,6 +1,6 @@
 # vCloud Tools Tester
 
-The integration tests for [vCloud Tools](https://github.com/alphagov/vcloud-tools) require a lot of parameters that are specific to your environment, and not ones you want to make public. 
+The integration tests for [vCloud Tools](https://github.com/gds-operations/vcloud-tools) require a lot of parameters that are specific to your environment, and not ones you want to make public. 
 
 vCloud tools Tester makes it easy to run the vCloud Tools integration tests using a config file.
 

data/Rakefile

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

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

@@ -0,0 +1,154 @@
+module Vcloud
+  module Tools
+    module Tester
+      class FixtureParameters
+        attr_reader :fixture_params
+
+        def initialize(user_params)
+          @vcloud_api = Vcloud::Fog::ModelInterface.new
+          @user_params = user_params
+          ensure_vcloud_fixtures
+          extract_fixture_params
+        end
+
+        private
+
+        def ensure_vcloud_fixtures
+          generate_fixtures_config
+          correct_networks = ensure_networks_correct(@expected_fixtures_config[:networks])
+          @fixtures = correct_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"
+                  }
+                ],
+              },
+            },
+          }
+        end
+
+        def ensure_networks_correct(expected_network_config)
+          existing_networks = @vcloud_api.current_organization.networks.all(false)
+
+          correct_networks = []
+
+          expected_network_config.each_value do |expected_config|
+            # find an existing network matching the expected configuration
+            found_network = existing_networks.detect { |n| n.name == expected_config[:name] }
+
+            unless found_network
+              new_network = Vcloud::Core::OrgVdcNetwork.provision(expected_config)
+              correct_networks << new_network
+              next
+            end
+
+            unless network_matches_expected?(found_network, expected_config)
+              raise "Network '#{expected_config[:name]}' already exists but is not configured as expected.
+                You should delete this network before re-running the tests; it will be re-created by the tests."
+            end
+
+            correct_networks << found_network
+          end
+
+          correct_networks
+        end
+
+        def extract_fixture_params
+          raise "No fixtures present" if @fixtures.empty?
+
+          @fixture_params = {}
+          expected_networks = @expected_fixtures_config[:networks]
+
+          @fixtures.each do |fixture|
+            case fixture
+            when ::Fog::Compute::VcloudDirector::Network
+              expected_networks.each do |network_ref, expected_network_config|
+                if expected_network_config[:name] == fixture.name
+                  @fixture_params["#{network_ref}_id"] = fixture.id
+                end
+              end
+            end
+          end
+        end
+
+        def network_matches_expected?(found_network, expected_network_config)
+            network_config_matches_expected?(found_network, expected_network_config) &&
+              network_available_to_correct_vdc?(found_network, expected_network_config)
+        end
+
+        def network_config_matches_expected?(found_network, expected_network_config)
+            found_network_config = found_network.instance_variable_get(:@attributes)
+
+            expected_network_config = expected_network_config.reject do |key|
+              %w{edge_gateway vdc_name}.include?(key.to_s)
+            end
+
+            found_network_config = found_network_config.reject do |key|
+              %w{id edge_gateway href}.include?(key.to_s)
+            end
+
+            # sort hashes ready for comparison
+            found_network_config = Hash[found_network_config.sort]
+            expected_network_config = Hash[expected_network_config.sort]
+
+            found_network_config == expected_network_config
+        end
+
+        def network_available_to_correct_vdc?(found_network, expected_network_config)
+          vdcs = @vcloud_api.current_organization.vdcs.all(false)
+
+          vdcs.each do |vdc|
+            next unless vdc.name == expected_network_config[:vdc_name]
+
+            matching_network = vdc.available_networks.detect { |n| n[:href].split('/').last == found_network.id }
+
+            return true if matching_network
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -4,102 +4,29 @@ module Vcloud
   module Tools
     module Tester
       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?
 
-        def initialize(config_file)
-          load_config(config_file)
-        end
-
-        def load_config(config_file)
-          unless File.exist?(config_file)
-            raise ArgumentError.new("Missing required file: #{config_file}")
-          end
-          organization = ENV.fetch('FOG_CREDENTIAL') do
-            raise "Must set FOG_CREDENTIAL envvar"
-          end
-          all_config = YAML::load(File.open(config_file))
-          @input_config = all_config.fetch(organization) do
-            raise "Invalid FOG_CREDENTIAL value '#{organization}'"
-          end
-        end
-
-        def vdc_1_name
-          @input_config["vdc_1_name"]
-        end
-
-        def vdc_2_name
-          @input_config["vdc_2_name"]
-        end
+          @user_params = user_params
+          @fixture_params = fixture_params
 
-        def catalog
-          @input_config["catalog"]
+          define_attr_readers
         end
 
-        def vapp_template
-          @input_config["vapp_template"]
-        end
-
-        def network_1
-          @input_config["network_1"]
-        end
-
-        def network_1_id
-          @input_config["network_1_id"]
-        end
+        private
 
-        def network_1_ip
-          @input_config["network_1_ip"]
-        end
-
-        def network_2
-          @input_config["network_2"]
-        end
-
-        def network_2_id
-          @input_config["network_2_id"]
-        end
+        def define_attr_readers
+          test_params = @user_params.merge(@fixture_params)
 
-        def network_2_ip
-          @input_config["network_2_ip"]
-        end
-
-        def storage_profile
-          @input_config["storage_profile"]
-        end
-
-        def default_storage_profile_name
-          @input_config["default_storage_profile_name"]
-        end
-
-        def default_storage_profile_href
-          @input_config["default_storage_profile_href"]
-        end
-
-        def vdc_1_storage_profile_href
-          @input_config["vdc_1_storage_profile_href"]
-        end
-
-        def vdc_2_storage_profile_href
-          @input_config["vdc_2_storage_profile_href"]
-        end
-
-        def edge_gateway
-          @input_config["edge_gateway"]
-        end
-
-        def edge_gateway_id
-          @input_config["edge_gateway_id"]
-        end
-
-        def provider_network
-          @input_config["provider_network"]
-        end
-
-        def provider_network_id
-          @input_config["provider_network_id"]
+          # Use +send+ because +define_method+ is private
+          test_params.each_key do |param|
+            self.class.send(:define_method, param) { test_params[param] }
+          end
         end
 
-        def provider_network_ip
-          @input_config["provider_network_ip"]
+        def method_missing (method_name)
+          raise "Method TestParameters##{method_name} not defined"
         end
       end
     end

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

@@ -0,0 +1,18 @@
+require 'yaml'
+
+module Vcloud
+  module Tools
+    module Tester
+      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
+
+          @test_params = Vcloud::Tools::Tester::TestParameters.new(user_params, fixture_params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module Vcloud
+  module Tools
+    module Tester
+      class UserParameters
+        attr_reader :user_params
+
+        def initialize(config_file, expected_user_params)
+          @config_file = config_file
+          @expected_user_params = expected_user_params || []
+
+          parse_config
+        end
+
+        private
+
+        def parse_config
+          unless File.exist?(@config_file)
+            raise ArgumentError.new("Missing required file: #{@config_file}")
+          end
+
+          organization = ENV.fetch('FOG_CREDENTIAL') do
+            raise "Must set FOG_CREDENTIAL environment variable"
+          end
+
+          all_config = YAML::load_file(@config_file)
+
+          @user_params = all_config.fetch(organization) do
+            raise "Invalid FOG_CREDENTIAL environment variable value '#{organization}'"
+          end
+
+          defined_keys = @user_params.keys
+          missing_params = @expected_user_params - defined_keys
+          if missing_params.any?
+            raise "Required parameters not defined in #{@config_file}: " + missing_params.join(", ")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Vcloud
   module Tools
     module Tester
-      VERSION = "0.0.6"
+      VERSION = "0.1.0"
     end
   end
 end

data/lib/vcloud/tools/tester.rb

@@ -1,2 +1,8 @@
+require "vcloud/core"
+require "vcloud/fog"
+
 require "vcloud/tools/tester/version"
+require "vcloud/tools/tester/fixture_parameters"
 require "vcloud/tools/tester/test_parameters"
+require "vcloud/tools/tester/test_setup"
+require "vcloud/tools/tester/user_parameters"

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# SimpleCov must run _first_ according to its README
+if ENV['COVERAGE']
+  require 'simplecov'
+
+  # monkey-patch to prevent SimpleCov from reporting coverage percentage
+  class SimpleCov::Formatter::HTMLFormatter
+    def output_message(_message)
+      nil
+    end
+  end
+
+  SimpleCov.adapters.define 'gem' do
+    add_filter '/spec/'
+    add_filter '/features/'
+    add_filter '/vendor/'
+
+    add_group 'Libraries', '/lib/'
+  end
+
+  SimpleCov.minimum_coverage(100)
+  SimpleCov.start 'gem'
+end
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

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

@@ -0,0 +1,161 @@
+require 'spec_helper'
+require 'vcloud/tools/tester'
+
+describe Vcloud::Tools::Tester::FixtureParameters do
+  subject { Vcloud::Tools::Tester::FixtureParameters.new(user_params) }
+
+  before(:each) do
+    stub_const("Fog::Compute::VcloudDirector::Network", Object)
+    Vcloud::Fog::ModelInterface.stub_chain(:new, :current_organization, :networks, :all).and_return(mock_found_interfaces)
+    Vcloud::Fog::ModelInterface.stub_chain(:new, :current_organization, :vdcs, :all).and_return(mock_found_vdcs)
+  end
+
+  let(:edge_gateway_name) { "Test edge gateway" }
+  let(:vdc_1_name) { "Foo vDC" }
+  let(:vdc_2_name) { "Bar vDC" }
+  let(:network_1_name) { "Test network 1" }
+  let(:network_2_name) { "Test network 2" }
+  let(:network_1_id) { "12345678-1234-1234-1234-000000111111" }
+  let(:network_2_id) { "12345678-1234-1234-1234-000000222222" }
+  let(:network_1_href) { "https://example.com/admin/network/" + network_1_id }
+  let(:network_2_href) { "https://example.com/admin/network/" + network_2_id }
+
+  let(:user_params) do
+    {
+      "edge_gateway" =>  edge_gateway_name,
+      "vdc_1_name"   =>  vdc_1_name,
+      "vdc_2_name"   =>  vdc_2_name,
+      "network_1"    =>  network_1_name,
+      "network_2"    =>  network_2_name,
+    }
+  end
+
+  let(:mock_found_vdcs) do
+    [
+      mock_vdc_1,
+      mock_vdc_2
+    ]
+  end
+
+  let(:mock_vdc_1) do
+      double(:vdc, :name => vdc_1_name, :available_networks => [ { :href => network_1_href } ])
+  end
+
+  let(:mock_vdc_2) do
+      double(:vdc, :name => vdc_2_name, :available_networks => [ { :href => network_2_href } ])
+  end
+
+  let(:mock_found_interfaces) do
+    [
+      mock_fixture_network_1,
+      mock_fixture_network_2,
+    ]
+  end
+
+  let(:mock_fixture_network_1) do
+    double(:network, :id => network_1_id, :name => network_1_name)
+  end
+
+  let(:mock_fixture_network_2) do
+    double(:network, :id => network_2_id, :name => network_2_name)
+  end
+
+  let(:mock_fixture_uuids) { [ network_1_id, network_2_id ] }
+
+  let(:network_config_1) do
+    {
+     :id => network_1_id,
+     :href => "https://example.com/admin/network/" + network_1_id,
+     :edge_gateway => edge_gateway_name,
+     :name => network_1_name,
+     :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
+
+  let(:network_config_2) do
+    {
+     :id => network_2_id,
+     :href => "https://example.com/admin/network/" + network_2_id,
+     :edge_gateway => edge_gateway_name,
+     :name => network_2_name,
+     :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
+
+  context "correct fixture networks exist" do
+    before(:each) do
+      expect(mock_fixture_network_1).to receive(:instance_variable_get).with(:@attributes).and_return(network_config_1)
+      expect(mock_fixture_network_2).to receive(:instance_variable_get).with(:@attributes).and_return(network_config_2)
+    end
+
+    it "doesn't provision new networks" do
+      expect(Vcloud::Core::OrgVdcNetwork).not_to receive(:provision)
+      subject
+    end
+
+    it "returns the correct fixture parameters" do
+      expect(subject.fixture_params.values).to eq(mock_fixture_uuids)
+    end
+  end
+
+  describe "correct fixture networks exist but aren't available to the appropriate vDCs" do
+    let(:mock_found_vdcs) do
+      [
+        double(:vdc, :name => vdc_1_name, :available_networks => [ { :href => "https://example.com/admin/network/garbage" } ]),
+        mock_vdc_2
+      ]
+    end
+
+    it "raises an error" do
+      expect(mock_fixture_network_1).to receive(:instance_variable_get).with(:@attributes).and_return(network_config_1)
+      expect{ subject }.to raise_error(/already exists but is not configured as expected/)
+    end
+  end
+
+  context "fixture networks don't yet exist" do
+    let(:mock_found_interfaces) do
+      [
+        double(:network, :id => "55555555-1234-1234-1234-000000111111", :name => "rubbish"),
+        double(:network, :id => "55555555-1234-1234-1234-000000222222", :name => "trash"),
+      ]
+    end
+
+    it "tries to create them and returns the appropriate fixture parameters" do
+      expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).and_return(mock_fixture_network_1)
+      expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).and_return(mock_fixture_network_2)
+      expect(subject.fixture_params.values).to eq(mock_fixture_uuids)
+    end
+  end
+end

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

@@ -1,106 +1,58 @@
+require 'spec_helper'
 require 'vcloud/tools/tester'
 
-module Vcloud::Tools::Tester
+describe Vcloud::Tools::Tester::TestParameters do
+  before(:all) do
+    @data_dir = File.join(File.dirname(__FILE__), "/data")
+  end
 
-  describe TestParameters do
+  subject(:parameters) do
+    Vcloud::Tools::Tester::TestParameters.new(user_params, fixture_params)
+  end
 
-    before(:all) do
-      @data_dir = File.join(File.dirname(__FILE__), "/data")
+  let(:config_file) { "#{@data_dir}/test_launcher_config.yaml" }
+  let(:vdc_1_name) { "launcher-vdc-1-name" }
+  let(:network_1_id) { "12345678-1234-1234-1234-000000111111" }
+  let(:user_params) {
+    {
+      :vdc_1_name =>  vdc_1_name,
+    }
+  }
+  let(:fixture_params) {
+    {
+      :network_1_id => network_1_id,
+    }
+  }
+
+  context "parameters required for integration tests" do
+    it "gives a useful error when the parameter is not set" do
+      expect{parameters.doesnotexist}.to raise_error("Method TestParameters#doesnotexist not defined")
     end
 
-    context "loading config file" do
-
-      it "loads input yaml when intialized" do
-        stub_const('ENV', {'FOG_CREDENTIAL' => 'test-organisation'})
-        parameters = TestParameters.new("#{@data_dir}/test_config.yaml")
-        test_vdc = parameters.vdc_1_name
-        expect(test_vdc).to eq("test-vdc-name")
-      end
-
-      it "loads a different organization's yaml when env var changes" do
-        stub_const('ENV', {'FOG_CREDENTIAL' => 'other-organisation'})
-        parameters = TestParameters.new("#{@data_dir}/test_config.yaml")
-        test_vdc = parameters.vdc_1_name
-        expect(test_vdc).to eq("other-vdc-name")
-      end
-
-      it "input yaml file can be changed" do
-        stub_const('ENV', {'FOG_CREDENTIAL' => 'minimal-organisation'})
-        parameters = TestParameters.new("#{@data_dir}/test_minimal_config.yaml")
-        test_vdc = parameters.vdc_1_name
-        expect(test_vdc).to eq("minimal-vdc-name")
-      end
-
-      it "gives a useful error when FOG_CREDENTIAL is unset" do
-        stub_const('ENV', {})
-        expect {
-          TestParameters.new("#{@data_dir}/test_minimal_config.yaml")
-        }.to raise_error(RuntimeError, /Must set FOG_CREDENTIAL envvar/)
-      end
+    it "returns the correct value for the user-defined parameters" do
+      test_vdc_1_name = parameters.vdc_1_name
+      expect(test_vdc_1_name).to eq(vdc_1_name)
+    end
 
-      it "gives a useful error when the FOG_CREDENTIAL is missing from the config" do
-        stub_const('ENV', {'FOG_CREDENTIAL' => 'bogus-fog-credential'})
-        expect {
-          TestParameters.new("#{@data_dir}/test_config.yaml")
-        }.to raise_error(RuntimeError, /Invalid FOG_CREDENTIAL value/)
-      end
+    it "returns the correct value for the fixture parameters" do
+      test_network_1_id = parameters.network_1_id
+      expect(test_network_1_id).to eq(network_1_id)
+    end
+  end
 
-      it "gives a useful error when there is no config file" do
-        stub_const('ENV', {'FOG_CREDENTIAL' => 'minimal-organisation'})
-        expect {
-          TestParameters.new("#{@data_dir}/non_existent_testing_config.yaml")
-        }.to raise_error(ArgumentError, /Missing required file/)
+  context "sanity checks" do
+    context "no user-defined parameters passed in" do
+      let(:user_params) {{}}
+      it "raises an error if it receives no user-defined parameters" do
+        expect{ parameters }.to raise_error("No user parameters received")
       end
-
     end
 
-    context "parameters required for integration tests" do
-
-      it "contains all the parameters required for the vCloud Launcher tests" do
-        ENV['FOG_CREDENTIAL'] = "launcher-testing-organisation"
-        parameters = TestParameters.new("#{@data_dir}/test_launcher_config.yaml")
-
-        test_vdc_1_name = parameters.vdc_1_name
-        expect(test_vdc_1_name).to eq("launcher-vdc-1-name")
-
-        test_vdc_2_name = parameters.vdc_2_name
-        expect(test_vdc_2_name).to eq("launcher-vdc-2-name")
-
-        test_catalog = parameters.catalog
-        expect(test_catalog).to eq("launcher-catalog")
-
-        test_vapp_template = parameters.vapp_template
-        expect(test_vapp_template).to eq("launcher-vapp-template")
-
-        test_network_1 = parameters.network_1
-        expect(test_network_1).to eq("launcher-network-1")
-
-        test_network_1_ip = parameters.network_1_ip
-        expect(test_network_1_ip).to eq("launcher-network-1-ip")
-
-        test_network_2 = parameters.network_2
-        expect(test_network_2).to eq("launcher-network-2")
-
-        test_network_2_ip = parameters.network_2_ip
-        expect(test_network_2_ip).to eq("launcher-network-2-ip")
-
-        test_storage_profile = parameters.storage_profile
-        expect(test_storage_profile).to eq("launcher-storage-profile")
-
-        test_default_storage_profile_name = parameters.default_storage_profile_name
-        expect(test_default_storage_profile_name).to eq("launcher-default-sp-name")
-
-        test_default_storage_profile_href = parameters.default_storage_profile_href
-        expect(test_default_storage_profile_href).to eq("launcher-default-sp-href")
-
-        test_vdc_1_storage_profile_href = parameters.vdc_1_storage_profile_href
-        expect(test_vdc_1_storage_profile_href).to eq("launcher-vdc-1-sp-href")
-
-        test_vdc_2_storage_profile_href = parameters.vdc_2_storage_profile_href
-        expect(test_vdc_2_storage_profile_href).to eq("launcher-vdc-2-sp-href")
+    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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'vcloud/tools/tester'
+
+describe Vcloud::Tools::Tester::TestSetup do
+  before(:each) do
+    Vcloud::Tools::Tester::UserParameters.stub(:new).and_return(mock_user_parameters)
+    Vcloud::Tools::Tester::FixtureParameters.stub(:new).and_return(mock_fixture_parameters)
+    Vcloud::Tools::Tester::TestParameters.stub(:new).and_return(mock_test_parameters)
+  end
+
+  let(:example_filename) { "example_filename.yaml" }
+  let(:expected_user_params) { [] }
+
+  let(:mock_user_parameters) do
+    double(:user_parameters, :user_params => {})
+  end
+
+  let(:mock_fixture_parameters) do
+    double(:fixture_parameters, :fixture_params => {})
+  end
+
+  let(:mock_test_parameters) do
+    double(:test_parameters, :test_params => {})
+  end
+
+  subject do
+    Vcloud::Tools::Tester::TestSetup.new(example_filename, expected_user_params)
+  end
+
+  it "responds with test parameters" do
+    expect(subject).to respond_to(:test_params)
+  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::TestParameters).to receive(:new).with({}, {})
+
+    subject.test_params
+  end
+end

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

@@ -0,0 +1,75 @@
+require 'spec_helper'
+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
+  end
+
+  before(:each) do
+    stub_const('ENV', {'FOG_CREDENTIAL' => 'test-organisation'})
+  end
+
+  let(:data_dir) do
+    File.join(File.dirname(__FILE__), "/data")
+  end
+
+  let(:config_file) do
+    "#{data_dir}/test_config.yaml"
+  end
+
+  let(:expected_user_params) {[]}
+  context "loading standard config file" do
+    it "loads input yaml when intialized" do
+      test_vdc = parameters["vdc_1_name"]
+      expect(test_vdc).to eq("test-vdc-name")
+    end
+
+    it "loads a different organization's parameters when FOG_CREDENTIAL changes" do
+      stub_const('ENV', {'FOG_CREDENTIAL' => 'other-organisation'})
+      test_vdc = parameters["vdc_1_name"]
+      expect(test_vdc).to eq("other-vdc-name")
+    end
+
+    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/)
+    end
+  end
+
+  context "when an expected user-defined parameter is missing from the config file" do
+    let(:expected_user_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")
+    end
+  end
+
+  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
+    end
+
+    it "input yaml file can be changed" do
+      stub_const('ENV', {'FOG_CREDENTIAL' => 'minimal-organisation'})
+      test_vdc = parameters["vdc_1_name"]
+      expect(test_vdc).to eq("minimal-vdc-name")
+    end
+
+    it "gives a useful error when FOG_CREDENTIAL is unset" do
+      stub_const('ENV', {})
+      expect { parameters }.to raise_error(RuntimeError, /Must set FOG_CREDENTIAL environment variable/)
+    end
+  end
+
+  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
+    end
+
+    it "gives a useful error when there is no config file" do
+      stub_const('ENV', {'FOG_CREDENTIAL' => 'minimal-organisation'})
+      expect { parameters }.to raise_error(ArgumentError, /Missing required file/)
+    end
+  end
+end

data/vcloud-tools-tester.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["anna.shipman@digital.cabinet-office.gov.uk"]
   spec.description   = %q{Tool to facilitate testing of vCloud Tools}
   spec.summary       = %q{vCloud Tools integration tests require secret parameters. This helps you manage them.}
+  spec.homepage      = "https://github.com/gds-operations/vcloud-tools-tester"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -17,8 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'rubocop'
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_development_dependency 'gem_publisher', '1.2.0'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'rubocop', '~> 0.23.0'
+  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+
+  spec.add_runtime_dependency 'vcloud-core', '~> 0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-tools-tester
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: gem_publisher
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,54 @@ 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.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+- !ruby/object:Gem::Dependency
+  name: vcloud-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: Tool to facilitate testing of vCloud Tools
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
@@ -85,20 +133,28 @@ files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - jenkins.sh
 - lib/vcloud/tools/tester.rb
+- lib/vcloud/tools/tester/fixture_parameters.rb
 - lib/vcloud/tools/tester/test_parameters.rb
+- lib/vcloud/tools/tester/test_setup.rb
+- lib/vcloud/tools/tester/user_parameters.rb
 - lib/vcloud/tools/tester/version.rb
+- spec/spec_helper.rb
 - spec/vcloud/tools/tester/data/test_config.yaml
 - spec/vcloud/tools/tester/data/test_launcher_config.yaml
 - spec/vcloud/tools/tester/data/test_minimal_config.yaml
+- spec/vcloud/tools/tester/fixture_parameters_spec.rb
 - spec/vcloud/tools/tester/test_parameters_spec.rb
+- spec/vcloud/tools/tester/test_setup_spec.rb
+- spec/vcloud/tools/tester/user_parameters_spec.rb
 - vcloud-tools-tester.gemspec
-homepage: 
+homepage: https://github.com/gds-operations/vcloud-tools-tester
 licenses:
 - MIT
 post_install_message: 
@@ -110,10 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3857862846260560705
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3857862846260560705
+      hash: -2901022177601151726
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -131,7 +184,11 @@ specification_version: 3
 summary: vCloud Tools integration tests require secret parameters. This helps you
   manage them.
 test_files:
+- spec/spec_helper.rb
 - spec/vcloud/tools/tester/data/test_config.yaml
 - spec/vcloud/tools/tester/data/test_launcher_config.yaml
 - spec/vcloud/tools/tester/data/test_minimal_config.yaml
+- spec/vcloud/tools/tester/fixture_parameters_spec.rb
 - spec/vcloud/tools/tester/test_parameters_spec.rb
+- spec/vcloud/tools/tester/test_setup_spec.rb
+- spec/vcloud/tools/tester/user_parameters_spec.rb