vcloud-net_launcher 0.2.0 → 0.3.0

data/.gitignore

@@ -1 +1,3 @@
 /Gemfile.lock
+/coverage/
+spec/integration/vcloud_tools_testing_config.yaml

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,10 @@
+## 0.3.0 (2014-07-14)
+
+Features:
+
+  - `vcloud-net-launch --version` now only returns the version string
+      and no usage information.
+
 ## 0.2.0 (2014-05-14)
 
 Features:

data/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to vCloud Net Launcher
+
+We really welcome contributions.
+
+## A quick guide on how to contribute
+
+1. Clone the repo:
+
+        git clone git@github.com:gds-operations/vcloud-net_launcher.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-net_launcher/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-net_launcher/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/Gemfile

@@ -1,9 +1,9 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 
 if ENV['VCLOUD_CORE_DEV_MASTER']
-  gem 'vcloud-core', :git => 'git@github.com:alphagov/vcloud-core.git', :branch => 'master'
+  gem 'vcloud-core', :git => 'git@github.com:gds-operations/vcloud-core.git', :branch => 'master'
 elsif ENV['VCLOUD_CORE_DEV_LOCAL']
   gem 'vcloud-core', :path => '../vcloud-core'
 end

data/README.md

@@ -74,13 +74,12 @@ Limitations
 * Not currently reentrant - if the process errors part of the way through, the previously applied network config
 will need to be removed from the file before it is corrected and run again.
 
+* No support for deleting networks. If you need to reconfigure a network, delete it first using the vCloud Director
+GUI and re-run `vcloud-net-launch`.
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+We welcome contributions. Please see the [contributing guidelines](/CONTRIBUTING.md).
 
 ## Other settings
 
@@ -113,25 +112,4 @@ Run the integration tests (slower and requires a real environment):
     bundle exec rake integration
 
 You need access to a suitable vCloud Director organization to run the
-integration tests. It is not necessarily safe to run them against an existing
-environment, unless care is taken with the entities being tested.
-
-The easiest thing to do is create a local shell script called
-`vcloud_env.sh` and set the contents:
-
-    export FOG\_CREDENTIAL=test
-    export VCLOUD\_VDC\_NAME="Name of the VDC"
-    export VCLOUD\_CATALOG\_NAME="catalog-name"
-    export VCLOUD\_TEMPLATE\_NAME="name-of-template"
-    export VCLOUD\_NETWORK1\_NAME="name-of-primary-network"
-    export VCLOUD\_NETWORK2\_NAME="name-of-secondary-network"
-    export VCLOUD\_NETWORK1\_IP="ip-on-primary-network"
-    export VCLOUD\_NETWORK2\_IP="ip-on-secondary-network"
-    export VCLOUD\_TEST\_STORAGE\_PROFILE="storage-profile-name"
-    export VCLOUD\_EDGE\_GATEWAY="name-of-edge-gateway-in-vdc"
-
-Then run this before you run the integration tests.
-
-[example_yaml]: ../examples/vcloud-net-launch/
-[fog]: http://fog.io/
-
+integration tests. See the [integration tests README](/spec/integration/README.md) for further details.

data/Rakefile

@@ -1,8 +1,7 @@
-require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'gem_publisher'
 
-task :default => [:rubocop, :spec, :features]
+task :default => [:rubocop, :spec]
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   # Set a bogus Fog credential, otherwise it's possible for the unit
@@ -12,11 +11,6 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = FileList['spec/vcloud/**/*_spec.rb']
 end
 
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "--format pretty --no-source"
-  t.fork = false
-end
-
 RSpec::Core::RakeTask.new(:integration) do |t|
   t.pattern = FileList['spec/integration/**/*_spec.rb']
 end
@@ -27,6 +21,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/bin/vcloud-net-launch

@@ -1,44 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'bundler/setup'
-require 'optparse'
-require 'methadone'
-
 require 'vcloud/net_launcher'
 
-class App
-  include Methadone::Main
-  include Methadone::CLILogging
-  include Vcloud
-
-  main do |net_config_file|
-    NetLauncher::NetLaunch.new.run(net_config_file, options)
-  end
-
-  on("-m", "--mock", "Fog Mock mode enabled")
-
-  arg :net_config_file
-
-  examples_dir = File.absolute_path(
-    File.join(
-      File.dirname(__FILE__),
-      "..",
-      "examples",
-      File.basename(__FILE__),
-  ))
-
-  description "
-  vcloud-net-launch takes a configuration describing a vCloud network,
-  and tries to make it a reality.
-
-  See https://github.com/alphagov/vcloud-tools for more info
-
-  Example configuration files can be found in:
-    #{examples_dir}
-  "
-
-  version Vcloud::NetLauncher::VERSION
-
-  go!
-end
+Vcloud::NetLauncher::Cli.new(ARGV).run

data/jenkins.sh

@@ -1,9 +1,14 @@
 #!/bin/bash -x
 set -e
+
+git clean -ffdx
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
-# commented out for now as there are no unit tests
-# and rake aefault is currently integration test
-# bundle exec rake
+bundle exec rake
+
+# Obtain the integration test parameters
+git clone git@github.gds:gds/vcloud-tools-testing-config.git
+mv vcloud-tools-testing-config/vcloud_tools_testing_config.yaml spec/integration/
+rm -rf vcloud-tools-testing-config
 
 RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration
 

data/jenkins_integration_tests.sh

@@ -1,5 +1,12 @@
 #!/bin/bash -x
 set -e
+
+git clean -ffdx
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 
+# Obtain the integration test parameters
+git clone git@github.gds:gds/vcloud-tools-testing-config.git
+mv vcloud-tools-testing-config/vcloud_tools_testing_config.yaml spec/integration/
+rm -rf vcloud-tools-testing-config
+
 RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration

data/lib/vcloud/net_launcher.rb

@@ -11,5 +11,6 @@ require 'vcloud/net_launcher/version'
 require 'vcloud/fog'
 require 'vcloud/core'
 
+require 'vcloud/net_launcher/cli'
 require 'vcloud/net_launcher/net_launch'
-
+require 'vcloud/net_launcher/schema/net_launch'

data/lib/vcloud/net_launcher/cli.rb

@@ -0,0 +1,88 @@
+require 'optparse'
+
+module Vcloud
+  module NetLauncher
+    class Cli
+
+      def initialize(argv_array)
+        @usage_text = nil
+        @config_file = nil
+        @options = {
+          "mock" => false,
+        }
+
+        parse(argv_array)
+      end
+
+      def run
+        begin
+          Vcloud::NetLauncher::NetLaunch.new.run(@config_file, @options)
+        rescue => error_msg
+          $stderr.puts(error_msg)
+          exit 1
+        end
+      end
+
+      private
+
+      def parse(args)
+        opt_parser = OptionParser.new do |opts|
+          examples_dir = File.absolute_path(
+            File.join(
+              File.dirname(__FILE__),
+              "..",
+              "..",
+              "..",
+              "examples",
+              File.basename($0),
+            ))
+
+          opts.banner = <<-EOS
+Usage: #{$0} [options] config_file
+
+vcloud-net-launch takes a configuration describing a vCloud network,
+and tries to make it a reality.
+
+See https://github.com/gds-operations/vcloud-tools for more info
+
+Example configuration files can be found in:
+  #{examples_dir}
+          EOS
+
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-m", "--mock", "Fog Mock mode enabled") do
+            @options["mock"] = true
+          end
+
+          opts.on("-h", "--help", "Print usage and exit") do
+            $stderr.puts opts
+            exit
+          end
+
+          opts.on("--version", "Display version and exit") do
+            puts Vcloud::NetLauncher::VERSION
+            exit
+          end
+        end
+
+        @usage_text = opt_parser.to_s
+        begin
+          opt_parser.parse!(args)
+        rescue OptionParser::InvalidOption => e
+          exit_error_usage(e)
+        end
+
+        exit_error_usage("must supply config_file") unless args.size == 1
+        @config_file = args.first
+      end
+
+      def exit_error_usage(error)
+        $stderr.puts "#{$0}: #{error}"
+        $stderr.puts @usage_text
+        exit 2
+      end
+    end
+  end
+end

data/lib/vcloud/net_launcher/net_launch.rb

@@ -9,7 +9,7 @@ module Vcloud
       end
 
       def run(config_file = nil, options = {})
-        config = @config_loader.load_config(config_file)
+        config = @config_loader.load_config(config_file, Vcloud::NetLauncher::Schema::NET_LAUNCH)
 
         if options[:mock] || ENV['FOG_MOCK']
           ::Fog.mock!

data/lib/vcloud/net_launcher/schema/net_launch.rb

@@ -0,0 +1,81 @@
+module Vcloud
+  module NetLauncher
+    module Schema
+
+      NET_LAUNCH = {
+        type: 'hash',
+        internals: {
+          org_vdc_networks: {
+            type: 'array',
+            required: true,
+            each_element_is: {
+              type: 'hash',
+              internals: {
+                name: {
+                  type: 'string',
+                  required: true,
+                },
+                edge_gateway: {
+                  type: 'string',
+                  required: false,
+                },
+                vdc_name: {
+                  type: 'string',
+                  required: true,
+                },
+                fence_mode: {
+                  type: 'enum',
+                  required: false,
+                  acceptable_values: %w{ isolated natRouted },
+                },
+                is_inherited: {
+                  type: 'boolean',
+                  required: false,
+                },
+                is_enabled: {
+                  type: 'boolean',
+                  required: false,
+                },
+                gateway: {
+                  type: 'ip_address',
+                  required: false,
+                },
+                netmask: {
+                  type: 'ip_address',
+                  required: false,
+                },
+                dns1: {
+                  type: 'ip_address',
+                  required: false,
+                },
+                dns2: {
+                  type: 'ip_address',
+                  required: false,
+                },
+                ip_ranges: {
+                  type: 'array',
+                  required: false,
+                  each_element_is: {
+                    type: 'hash',
+                    required: true,
+                    internals: {
+                      start_address: {
+                        type: 'ip_address',
+                        required: true,
+                      },
+                      end_address: {
+                        type: 'ip_address',
+                        required: true,
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      }
+
+    end
+  end
+end

data/lib/vcloud/net_launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module NetLauncher
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/integration/README.md

@@ -0,0 +1,33 @@
+# Running vCloud Net Launcher Integration Tests
+
+## Prerequisites
+
+- Access to a suitable vCloud Director organisation.
+
+  **NB** It is not safe to run them against an environment that is in use
+  (e.g. production, preview) as many of the tests clear down all config at
+  the beginning and/or end to ensure the environment is as the tests expect.
+
+- A config file with the settings configured.
+
+  There is a [template file](spec/integration/vcloud_tools_testing_config.yaml.template) to
+  help with this. Copy the template file to `spec/integration/vcloud_tools_testing_config.yaml`
+  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/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.
+
+## Parameters
+
+````
+default: # This is the fog credential that refers to your testing environment, e.g. `test_credential`
+  vdc_1_name: # The name of a VDC
+  edge_gateway: # The name of the edge gateway
+````
+
+## To run the tests
+
+  `FOG_CREDENTIAL=test_credential bundle exec integration`

data/spec/integration/net_launcher/data/minimum_data_setup.yaml.erb

@@ -6,4 +6,4 @@ org_vdc_networks:
   fence_mode: <%= fence_mode %>
   netmask: <%= netmask %>
   gateway: <%= gateway %>
-  edge_gateway: <%= edgeGateway %>
+  edge_gateway: <%= edge_gateway %>

data/spec/integration/net_launcher/{vcloud_net_launcher_spec.rb → net_launch_spec.rb}

@@ -15,27 +15,26 @@ module Vcloud
           Vcloud::NetLauncher::NetLaunch.new.run(@minimum_data_yaml)
 
           @found_networks = find_network(test_data[:network_name])
-          @found_networks.length.should eq(1)
+          expect(@found_networks.length).to eq(1)
           provisioned_network = @found_networks[0]
-          provisioned_network[:gateway].should eq(test_data[:gateway])
-          provisioned_network[:netmask].should eq(test_data[:netmask])
-          provisioned_network[:isLinked].should eq('false')
+          expect(provisioned_network[:gateway]).to eq(test_data[:gateway])
+          expect(provisioned_network[:netmask]).to eq(test_data[:netmask])
+          expect(provisioned_network[:isLinked]).to eq('false')
         end
 
-        it 'should create an nat routed network' do
+        it 'should create a nat routed network' do
           test_data = default_test_data('natRouted')
-          test_data[:edgeGateway] =  ENV['VCLOUD_EDGE_GATEWAY']  #only needed for natRouted networks
           @minimum_data_yaml = generate_data_file(test_data)
 
           Vcloud::NetLauncher::NetLaunch.new.run(@minimum_data_yaml)
 
           @found_networks = find_network(test_data[:network_name])
 
-          @found_networks.length.should eq(1)
+          expect(@found_networks.length).to eq(1)
           provisioned_network = @found_networks[0]
-          provisioned_network[:gateway].should eq(test_data[:gateway])
-          provisioned_network[:netmask].should eq(test_data[:netmask])
-          provisioned_network[:isLinked].should eq('true')
+          expect(provisioned_network[:gateway]).to eq(test_data[:gateway])
+          expect(provisioned_network[:netmask]).to eq(test_data[:netmask])
+          expect(provisioned_network[:isLinked]).to eq('true')
         end
 
         after(:each) do
@@ -43,16 +42,21 @@ module Vcloud
             File.delete @minimum_data_yaml
             fog_interface = Vcloud::Fog::ServiceInterface.new
             provisioned_network_id = @found_networks[0][:href].split('/').last
-            fog_interface.delete_network(provisioned_network_id).should be(true)
+            expect(fog_interface.delete_network(provisioned_network_id)).to be(true)
           end
         end
 
       end
 
       def default_test_data(type)
+        config_file = File.join(File.dirname(__FILE__), "../vcloud_tools_testing_config.yaml")
+        required_user_params = %w{ vdc_1_name edge_gateway }
+
+        parameters = Vcloud::Tools::Tester::TestSetup.new(config_file, required_user_params).test_params
         {
           network_name: "vapp-vcloud-tools-tests-#{Time.now.strftime('%s')}",
-          vdc_name: ENV['VCLOUD_VDC_NAME'],
+          vdc_name: parameters.vdc_1_name,
+          edge_gateway: parameters.edge_gateway,
           fence_mode: type,
           netmask: '255.255.255.0',
           gateway: '192.0.2.1',

data/spec/integration/net_launcher/org_vdc_network_spec.rb

@@ -147,13 +147,14 @@ describe Vcloud::Core::OrgVdcNetwork do
   end
 
   def define_test_data
-    [ 'VCLOUD_VDC_NAME', 'VCLOUD_EDGE_GATEWAY' ].each do |n|
-      raise "Need #{n} set" unless ENV[n]
-    end
+    config_file = File.join(File.dirname(__FILE__), "../vcloud_tools_testing_config.yaml")
+    required_user_params = %w{ vdc_1_name edge_gateway }
+
+    parameters = Vcloud::Tools::Tester::TestSetup.new(config_file, required_user_params).test_params
     {
       :name => "orgVdcNetwork-vcloud-tools-tests #{Time.now.strftime('%s')}",
-      :vdc_name => ENV['VCLOUD_VDC_NAME'],
-      :edge_gateway_name => ENV['VCLOUD_EDGE_GATEWAY'],
+      :vdc_name => parameters.vdc_1_name,
+      :edge_gateway_name => parameters.edge_gateway,
     }
   end
 

data/spec/integration/vcloud_tools_testing_config.yaml.template

@@ -0,0 +1,3 @@
+default:
+  vdc_1_name:
+  edge_gateway:

data/spec/spec_helper.rb

@@ -1,3 +1,33 @@
+# 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 'erb_helper'
 require 'bundler/setup'
 require 'vcloud/net_launcher'
+require 'vcloud/tools/tester'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/vcloud/net_launcher/cli_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+class CommandRun
+  attr_accessor :stdout, :stderr, :exitstatus
+
+  def initialize(args)
+    out = StringIO.new
+    err = StringIO.new
+
+    $stdout = out
+    $stderr = err
+
+    begin
+      Vcloud::NetLauncher::Cli.new(args).run
+      @exitstatus = 0
+    rescue SystemExit => e
+      # Capture exit(n) value.
+      @exitstatus = e.status
+    end
+
+    @stdout = out.string.strip
+    @stderr = err.string.strip
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+describe Vcloud::NetLauncher::Cli do
+  subject { CommandRun.new(args) }
+
+  let(:mock_net_launch) {
+    double(:net_launch, :run => true)
+  }
+  let(:config_file) { 'config.yaml' }
+
+  describe "under normal usage" do
+    shared_examples "a good CLI command" do
+      it "passes the right CLI options and exits normally" do
+        expect(Vcloud::NetLauncher::NetLaunch).to receive(:new).
+          and_return(mock_net_launch)
+        expect(mock_net_launch).to receive(:run).
+          with(config_file, cli_options)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when given a single config file" do
+      let(:args) { [ config_file ] }
+      let(:cli_options) {
+        {
+          "mock" => false,
+        }
+      }
+
+      it_behaves_like "a good CLI command"
+    end
+
+    context "when asked to use mock mode" do
+      let(:args) { [ config_file, "--mock" ] }
+      let(:cli_options) {
+        {
+          "mock" => true,
+        }
+      }
+
+      it_behaves_like "a good CLI command"
+    end
+
+    context "when asked to display version" do
+      let(:args) { %w{--version} }
+
+      it "does not call NetLaunch" do
+        expect(Vcloud::NetLauncher::NetLaunch).not_to receive(:new)
+      end
+
+      it "prints version and exits normally" do
+        expect(subject.stdout).to eq(Vcloud::NetLauncher::VERSION)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when asked to display help" do
+      let(:args) { %w{--help} }
+
+      it "does not call NetLaunch" do
+        expect(Vcloud::NetLauncher::NetLaunch).not_to receive(:new)
+      end
+
+      it "prints usage and exits normally" do
+        expect(subject.stderr).to match(/\AUsage: \S+ \[options\] config_file\n/)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+  end
+
+  describe "incorrect usage" do
+    shared_examples "print usage and exit abnormally" do |error|
+      it "does not call NetLaunch" do
+        expect(Vcloud::NetLauncher::NetLaunch).not_to receive(:new)
+      end
+
+      it "prints error message and usage" do
+        expect(subject.stderr).to match(/\A\S+: #{error}\nUsage: \S+/)
+      end
+
+      it "exits abnormally for incorrect usage" do
+        expect(subject.exitstatus).to eq(2)
+      end
+    end
+
+    context "when run without any arguments" do
+      let(:args) { %w{} }
+
+      it_behaves_like "print usage and exit abnormally", "must supply config_file"
+    end
+
+    context "when given multiple config files" do
+      let(:args) { %w{one.yaml two.yaml} }
+
+      it_behaves_like "print usage and exit abnormally", "must supply config_file"
+    end
+
+    context "when given an unrecognised argument" do
+      let(:args) { %w{--this-is-garbage} }
+
+      it_behaves_like "print usage and exit abnormally", "invalid option: --this-is-garbage"
+    end
+  end
+
+  describe "error handling" do
+    context "when underlying code raises an exception" do
+      let(:args) { %w{test.yaml} }
+
+      it "should print error without backtrace and exit abnormally" do
+        expect(Vcloud::NetLauncher::NetLaunch).to receive(:new).
+          and_raise("something went horribly wrong")
+        expect(subject.stderr).to eq("something went horribly wrong")
+        expect(subject.exitstatus).to eq(1)
+      end
+    end
+
+    context "when passed an non-existent configuration file" do
+      let(:args) { %w{non-existent.yaml} }
+
+      it "raises a descriptive error" do
+        # Use a regex match as a workaround to https://bugs.ruby-lang.org/issues/9285
+        expect(subject.stderr).to match(/\ANo such file or directory/)
+        expect(subject.exitstatus).to eq(1)
+      end
+    end
+  end
+end

data/spec/vcloud/net_launcher/net_launch_schema_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Vcloud::NetLauncher do
+  context "NetLaunch schema validation" do
+    it "validates a legal schema" do
+      test_config = {
+        :org_vdc_networks => [
+          :name     =>  "Valid network",
+          :vdc_name =>  "Some vDC"
+        ]
+      }
+
+      validator = Vcloud::Core::ConfigValidator.validate(:base, test_config, Vcloud::NetLauncher::Schema::NET_LAUNCH)
+      expect(validator.valid?).to be_true
+      expect(validator.errors).to be_empty
+    end
+
+    it "does not validate an illegal schema" do
+      test_config = {
+        :no_networks_here => {
+          :name => "I am not valid"
+        }
+      }
+
+      validator = Vcloud::Core::ConfigValidator.validate(:base, test_config, Vcloud::NetLauncher::Schema::NET_LAUNCH)
+      expect(validator.valid?).to be_false
+      expect(validator.errors).to eq(["base: parameter 'no_networks_here' is invalid", "base: missing 'org_vdc_networks' parameter"])
+    end
+
+    it "allows multiple IP ranges" do
+      test_config = {
+        :org_vdc_networks => [
+          :name       =>  "Valid network",
+          :vdc_name   =>  "Some vDC",
+          :ip_ranges  =>  [
+            {
+              :start_address  =>  "192.168.1.2",
+              :end_address    =>  "192.168.1.3",
+            },
+            {
+              :start_address  =>  "192.168.1.4",
+              :end_address    =>  "192.168.1.5",
+            }
+          ]
+        ]
+      }
+
+      validator = Vcloud::Core::ConfigValidator.validate(:base, test_config, Vcloud::NetLauncher::Schema::NET_LAUNCH)
+      expect(validator.valid?).to be_true
+      expect(validator.errors).to be_empty
+    end
+
+    it "checks for an end address in an IP address range" do
+      test_config = {
+        :org_vdc_networks => [
+          :name       =>  "Valid network",
+          :vdc_name   =>  "Some vDC",
+          :ip_ranges  =>  [
+            {
+              :start_address  => "192.168.1.2",
+            }
+          ]
+        ]
+      }
+
+      validator = Vcloud::Core::ConfigValidator.validate(:base, test_config, Vcloud::NetLauncher::Schema::NET_LAUNCH)
+      expect(validator.valid?).to be_false
+      expect(validator.errors).to eq(["ip_ranges: missing 'end_address' parameter"])
+    end
+  end
+end

data/spec/vcloud/net_launcher/net_launch_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe Vcloud::NetLauncher::NetLaunch do
+  let(:cli_options) { {} }
+
   context "ConfigLoader returns three different networks" do
-    let!(:network1) {
+    let(:network1) {
       {
         :name         => 'Network 1',
         :vdc_name     => 'TestVDC',
@@ -12,7 +14,7 @@ describe Vcloud::NetLauncher::NetLaunch do
         :edge_gateway => 'TestVSE',
       }
     }
-    let!(:network2) {
+    let(:network2) {
       {
         :name         => 'Network 2',
         :vdc_name     => 'TestVDC',
@@ -22,7 +24,7 @@ describe Vcloud::NetLauncher::NetLaunch do
         :edge_gateway => 'TestVSE',
       }
     }
-    let!(:network3) {
+    let(:network3) {
       {
         :name         => 'Network 3',
         :vdc_name     => 'TestVDC',
@@ -46,7 +48,6 @@ describe Vcloud::NetLauncher::NetLaunch do
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network2)
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network3)
 
-      cli_options = {}
       subject.run('input_config_yaml', cli_options)
     end
 
@@ -56,7 +57,6 @@ describe Vcloud::NetLauncher::NetLaunch do
         and_raise(RuntimeError.new('Did not successfully create orgVdcNetwork'))
       expect(Vcloud::Core::OrgVdcNetwork).not_to receive(:provision).with(network3)
 
-      cli_options = {}
       expect {
         Vcloud::NetLauncher::NetLaunch.new.run('input_config_yaml', cli_options)
       }.to raise_error(RuntimeError, 'Did not successfully create orgVdcNetwork')
@@ -67,7 +67,6 @@ describe Vcloud::NetLauncher::NetLaunch do
         expect(Fog).to_not receive(:mock!)
         expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).exactly(3).times
 
-        cli_options = {}
         subject.run('input_config_yaml', cli_options)
       end
 
@@ -83,7 +82,7 @@ describe Vcloud::NetLauncher::NetLaunch do
   end
 
   context "ConfigLoader returns one network without :fence_mode set" do
-    let!(:network_without_fence_mode) {
+    let(:network_without_fence_mode) {
       {
         :name         => 'Network w/o fence_mode',
         :vdc_name     => 'TestVDC',
@@ -106,10 +105,9 @@ describe Vcloud::NetLauncher::NetLaunch do
         :fence_mode => 'isolated',
       })
 
-      network_without_fence_mode.should_not have_key(:fence_mode)
+      expect(network_without_fence_mode).not_to have_key(:fence_mode)
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network_with_fence_mode)
 
-      cli_options = {}
       subject.run('input_config_yaml', cli_options)
     end
   end

data/vcloud-net_launcher.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email       = ['anna.shipman@digital.cabinet-office.gov.uk']
   s.summary     = 'Tool to launch and configure vCloud networks'
   s.description = 'Tool to launch and configure vCloud networks. Uses vcloud-core.'
-  s.homepage    = 'http://github.com/alphagov/vcloud-net_launcher'
+  s.homepage    = 'http://github.com/gds-operations/vcloud-net_launcher'
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -20,15 +20,17 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 1.9.3'
 
-  s.add_runtime_dependency 'methadone'
-  s.add_runtime_dependency 'vcloud-core', '~> 0.3.0'
-  s.add_development_dependency 'aruba', '~> 0.5.3'
-  s.add_development_dependency 'cucumber', '~> 1.3.10'
+  s.add_runtime_dependency 'vcloud-core', '~> 0.6.0'
   s.add_development_dependency 'gem_publisher', '1.2.0'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 2.14.1'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop', '~> 0.23.0'
+  # Pin SimpleCov to < 0.8.x until this issue is resolved:
+  # https://github.com/colszowka/simplecov/issues/281
+  s.add_development_dependency 'simplecov', '~> 0.7.1'
+  s.add_development_dependency 'vcloud-tools-tester', '~> 0.1.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-net_launcher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,112 +9,112 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: methadone
+  name: vcloud-core
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: vcloud-core
+  name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
+        version: 1.2.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem_publisher
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,23 +122,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: vcloud-tools-tester
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 description: Tool to launch and configure vCloud networks. Uses vcloud-core.
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
@@ -150,30 +150,34 @@ files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/vcloud-net-launch
 - examples/vcloud-net-launch/example-config.yaml
-- features/step_definitions/vcloud-launch_steps.rb
-- features/support/env.rb
-- features/vcloud-net-launch.feature
 - jenkins.sh
 - jenkins_integration_tests.sh
 - lib/vcloud/net_launcher.rb
+- lib/vcloud/net_launcher/cli.rb
 - lib/vcloud/net_launcher/net_launch.rb
+- lib/vcloud/net_launcher/schema/net_launch.rb
 - lib/vcloud/net_launcher/version.rb
 - scripts/basic.erb
 - spec/erb_helper.rb
+- spec/integration/README.md
 - spec/integration/net_launcher/data/minimum_data_setup.yaml.erb
+- spec/integration/net_launcher/net_launch_spec.rb
 - spec/integration/net_launcher/org_vdc_network_spec.rb
-- spec/integration/net_launcher/vcloud_net_launcher_spec.rb
+- spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
+- spec/vcloud/net_launcher/cli_spec.rb
+- spec/vcloud/net_launcher/net_launch_schema_spec.rb
 - spec/vcloud/net_launcher/net_launch_spec.rb
 - tools/fog_credentials.rb
 - vcloud-net_launcher.gemspec
-homepage: http://github.com/alphagov/vcloud-net_launcher
+homepage: http://github.com/gds-operations/vcloud-net_launcher
 licenses:
 - MIT
 post_install_message: 
@@ -185,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3237069924497883805
+      hash: 3723490288944592179
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -202,12 +206,13 @@ signing_key:
 specification_version: 3
 summary: Tool to launch and configure vCloud networks
 test_files:
-- features/step_definitions/vcloud-launch_steps.rb
-- features/support/env.rb
-- features/vcloud-net-launch.feature
 - spec/erb_helper.rb
+- spec/integration/README.md
 - spec/integration/net_launcher/data/minimum_data_setup.yaml.erb
+- spec/integration/net_launcher/net_launch_spec.rb
 - spec/integration/net_launcher/org_vdc_network_spec.rb
-- spec/integration/net_launcher/vcloud_net_launcher_spec.rb
+- spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
+- spec/vcloud/net_launcher/cli_spec.rb
+- spec/vcloud/net_launcher/net_launch_schema_spec.rb
 - spec/vcloud/net_launcher/net_launch_spec.rb

data/features/step_definitions/vcloud-launch_steps.rb

@@ -1,3 +0,0 @@
-Then(/^the banner should document that this app takes (\d+) argument$/) do
-   pending # express the regexp above with the code you wish you had
-end

data/features/support/env.rb

@@ -1,16 +0,0 @@
-require 'aruba/cucumber'
-require 'methadone/cucumber'
-
-ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
-LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
-
-Before do
-  # Using "announce" causes massive warnings on 1.9.2
-  @puts = true
-  @original_rubylib = ENV['RUBYLIB']
-  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
-end
-
-After do
-  ENV['RUBYLIB'] = @original_rubylib
-end

data/features/vcloud-net-launch.feature

@@ -1,15 +0,0 @@
-Feature: "vcloud-net-launch" works as a useful command-line tool
-  In order to use "vcloud-net-launch" from the CLI
-  I want to have it behave like a typical Unix tool
-  So I don't get surpised
-
-  Scenario: Common arguments work
-    When I get help for "vcloud-net-launch"
-    Then the exit status should be 0
-    And the banner should be present
-    And the banner should document that this app takes options
-    And the following options should be documented:
-      |--version|
-      |--mock|
-    And the banner should document that this app's arguments are:
-      |net_config_file|