vcloud-edge_gateway 0.5.0 → 1.0.0

data/spec/vcloud/edge_gateway/cli_spec.rb

@@ -0,0 +1,221 @@
+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::EdgeGateway::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::EdgeGateway::Cli do
+  subject { CommandRun.new(args) }
+
+  describe "normal usage" do
+    let(:mock_configure) {
+      double(:configure, :update => {})
+    }
+
+    context "when given a single config file" do
+      let(:args) { %w{config.yaml} }
+
+      it "should pass single argument, call update without any args, and exit normally" do
+        expect(Vcloud::EdgeGateway::Configure).to receive(:new).
+          with('config.yaml').and_return(mock_configure)
+        expect(mock_configure).to receive(:update).with(no_args)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when given --template-vars and config file" do
+      let(:args) { %w{--template-vars vars.yaml config.yaml} }
+
+      it "should pass two arguments and exit normally" do
+        expect(Vcloud::EdgeGateway::Configure).to receive(:new).
+          with('config.yaml', 'vars.yaml').and_return(mock_configure)
+        expect(mock_configure).to receive(:update)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when given --dry-run and config file" do
+      let(:args) { %w{--dry-run config.yaml} }
+
+      it "should call update(true) and exit normally" do
+        expect(Vcloud::EdgeGateway::Configure).to receive(:new).
+          with('config.yaml').and_return(mock_configure)
+        expect(mock_configure).to receive(:update).with(true)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when asked to display version" do
+      let(:args) { %w{--version} }
+
+      it "should not call Configure" do
+        expect(Vcloud::EdgeGateway::Configure).not_to receive(:new)
+      end
+
+      it "should print version and exit normally" do
+        expect(subject.stdout).to eq(Vcloud::EdgeGateway::VERSION)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when asked to display help" do
+      let(:args) { %w{--help} }
+
+      it "should not call Configure" do
+        expect(Vcloud::EdgeGateway::Configure).not_to receive(:new)
+      end
+
+      it "should print usage and exit normally" do
+        expect(subject.stderr).to match(/\AUsage: \S+ \[options\] config_file\n/)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+  end
+
+  describe "diff output" do
+    shared_examples "diff with stdout contents" do |expected_stdout|
+      it "should output diff to stdout" do
+        expect(Vcloud::EdgeGateway::Configure).to receive(:new).
+          with('config.yaml').and_return(mock_configure)
+        expect(subject.stdout).to eq(expected_stdout.chomp)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when diff is empty" do
+      let(:mock_configure) {
+        double(:configure, :update => {})
+      }
+
+      context "when given config (colour doesn't matter)" do
+        let(:args) { %w{config.yaml} }
+
+        it_behaves_like "diff with stdout contents", ""
+      end
+    end
+
+    context "when diff contains two services with three types of changes" do
+      shared_examples "diff with colour output" do
+        include_examples "diff with stdout contents", <<-EOS.chomp
+\033[31m- FirewallService.IsEnabled: true\033[0m
+\033[32m+ FirewallService.LogDefaultAction: false\033[0m
+\033[31m- NatService.IsEnabled: true\033[0m
+\033[32m+ NatService.IsEnabled: false\033[0m
+        EOS
+      end
+
+      shared_examples "diff without colour output" do
+        include_examples "diff with stdout contents", <<-EOS.chomp
+- FirewallService.IsEnabled: true
++ FirewallService.LogDefaultAction: false
+- NatService.IsEnabled: true
++ NatService.IsEnabled: false
+        EOS
+      end
+
+      let(:mock_configure) {
+        double(:configure, :update => {
+          :FirewallService => [
+            ["-", "IsEnabled", "true"],
+            ["+", "LogDefaultAction", "false"],
+          ],
+          :NatService => [
+            ["~", "IsEnabled", "true", "false"],
+          ],
+        })
+      }
+
+      context "STDOUT is not redirected" do
+        before(:each) {
+          STDOUT.stub(:tty?).and_return(true)
+        }
+
+        context "when colour argument is not specified" do
+          let(:args) { %w{config.yaml} }
+
+          it_behaves_like "diff with colour output"
+        end
+
+        context "when given --no-colour" do
+          let(:args) { %w{--no-colour config.yaml} }
+
+          it_behaves_like "diff without colour output"
+        end
+      end
+
+      context "STDOUT is redirected" do
+        before(:each) {
+          STDOUT.stub(:tty?).and_return(false)
+        }
+
+        context "when colour argument is not specified" do
+          let(:args) { %w{config.yaml} }
+
+          it_behaves_like "diff without colour output"
+        end
+
+        context "when given --colour" do
+          let(:args) { %w{--colour config.yaml} }
+
+          it_behaves_like "diff with colour output"
+        end
+      end
+    end
+  end
+
+  describe "incorrect usage" do
+    shared_examples "print usage and exit abnormally" do |error|
+      it "should not call Configure" do
+        expect(Vcloud::EdgeGateway::Configure).not_to receive(:new)
+      end
+
+      it "should print error message and usage" do
+        expect(subject.stderr).to match(/\A\S+: #{error}\nUsage: \S+/)
+      end
+
+      it "should exit 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 a 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
+end

data/spec/vcloud/edge_gateway/configure_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Vcloud::EdgeGateway::Configure do
+  describe 'dry_run' do
+    let(:expected_log_message) {
+      /: Dry run\. Skipping\.$/
+    }
+    let(:mock_edgegateway) {
+      double(:edgegateway,
+        :interfaces => 'chocolate cake',
+        :vcloud_attributes => {
+          :Configuration => {
+            :EdgeGatewayServiceConfiguration => 'ice cream cone',
+          }
+        }
+      )
+    }
+
+    before(:each) {
+      Vcloud::Core::EdgeGateway.stub(:get_by_name).and_return(mock_edgegateway)
+
+      mock_configloader = double(:configloader,
+        :load_config => { :gateway => 'pickle' }
+      )
+      Vcloud::Core::ConfigLoader.stub(:new).and_return(mock_configloader)
+
+      mock_configuration = double(:configuration,
+        :update_required? => true,
+        :config => 'slice of swiss cheese',
+        :diff => ['slice of salami'],
+      )
+      Vcloud::EdgeGateway::EdgeGatewayConfiguration.stub(:new).and_return(mock_configuration)
+    }
+
+    context "when false (default)" do
+      let(:subject) {
+        Vcloud::EdgeGateway::Configure.new('lollipop.yaml').update
+      }
+
+      it "should call update_configuration" do
+        expect(mock_edgegateway).to receive(:update_configuration).with('slice of swiss cheese')
+        subject
+      end
+
+      it "should not log message about dry run" do
+        mock_edgegateway.stub(:update_configuration)
+        expect(Vcloud::Core.logger).not_to receive(:info).with(expected_log_message)
+        subject
+      end
+
+      it "should return diff" do
+        mock_edgegateway.stub(:update_configuration)
+        expect(subject).to eq(['slice of salami'])
+      end
+    end
+
+    context "when true" do
+      let(:subject) {
+        Vcloud::EdgeGateway::Configure.new('lollipop.yaml').update(true)
+      }
+
+      it "should not call update_configuration" do
+        Vcloud::Core.logger.stub(:info)
+        expect(mock_edgegateway).not_to receive(:update_configuration)
+        subject
+      end
+
+      it "should log message about dry run" do
+        mock_edgegateway.stub(:update_configuration)
+        expect(Vcloud::Core.logger).to receive(:info).with(expected_log_message)
+        subject
+      end
+
+      it "should return diff" do
+        Vcloud::Core.logger.stub(:info)
+        mock_edgegateway.stub(:update_configuration)
+        expect(subject).to eq(['slice of salami'])
+      end
+    end
+  end
+end

data/spec/vcloud/edge_gateway/edge_gateway_configuration_spec.rb

@@ -83,6 +83,14 @@ module Vcloud
           expect(proposed_load_balancer_config).to eq(expected_load_balancer_config)
         end
 
+        it "proposed diff contains changes for all services" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:FirewallService, :NatService, :LoadBalancerService])
+          expect(diff[:FirewallService]).to     have_at_least(1).items
+          expect(diff[:NatService]).to          have_at_least(1).items
+          expect(diff[:LoadBalancerService]).to have_at_least(1).items
+        end
+
       end
 
       context "firewall config has changed and nat has not, load_balancer absent" do
@@ -121,6 +129,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:LoadBalancerService)).to be(false)
         end
 
+        it "proposed diff contains changes for firewall service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:FirewallService])
+          expect(diff[:FirewallService]).to have_at_least(1).items
+        end
+
       end
 
       context "firewall config has changed and nat & load_balancer configs are absent" do
@@ -159,6 +173,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:LoadBalancerService)).to be(false)
         end
 
+        it "proposed diff contains changes for firewall service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:FirewallService])
+          expect(diff[:FirewallService]).to have_at_least(1).items
+        end
+
       end
 
       context "load_balancer config has changed and firewall & nat have not" do
@@ -199,6 +219,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:FirewallService)).to be(false)
         end
 
+        it "proposed diff contains changes for load balancer service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:LoadBalancerService])
+          expect(diff[:LoadBalancerService]).to have_at_least(1).items
+        end
+
       end
 
       context "load_balancer & firewall config have changed and nat has not" do
@@ -240,6 +266,13 @@ module Vcloud
           expect(proposed_firewall_config).to eq(expected_firewall_config)
         end
 
+        it "proposed diff contains changes for firewall and load balancer services" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:FirewallService, :LoadBalancerService])
+          expect(diff[:FirewallService]).to     have_at_least(1).items
+          expect(diff[:LoadBalancerService]).to have_at_least(1).items
+        end
+
       end
 
 
@@ -279,6 +312,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:FirewallService)).to be(false)
         end
 
+        it "proposed diff contains changes for load balancer service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:LoadBalancerService])
+          expect(diff[:LoadBalancerService]).to have_at_least(1).items
+        end
+
       end
 
       context "all configs are present but haven't changed" do
@@ -310,6 +349,10 @@ module Vcloud
           expect(@proposed_config.config.empty?).to be(true)
         end
 
+        it "proposed diff contains no changes" do
+          expect(@proposed_config.diff).to eq({})
+        end
+
       end
 
       context "firewall config has not changed and nat & load_balancer config is absent" do
@@ -339,6 +382,10 @@ module Vcloud
           expect(@proposed_config.config.empty?).to be(true)
         end
 
+        it "proposed diff contains no changes" do
+          expect(@proposed_config.diff).to eq({})
+        end
+
       end
 
       context "no service config is present" do
@@ -367,6 +414,10 @@ module Vcloud
           expect(@proposed_config.config.empty?).to be(true)
         end
 
+        it "proposed diff contains no changes" do
+          expect(@proposed_config.diff).to eq({})
+        end
+
       end
 
       context "when there is a missing remote LoadBalancerService, we can still update NatService" do
@@ -404,6 +455,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:FirewallService)).to be(false)
         end
 
+        it "proposed diff contains changes for nat service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:NatService])
+          expect(diff[:NatService]).to have_at_least(1).items
+        end
+
       end
 
       context "there is no remote FirewallService config, but we are trying to update it" do
@@ -441,6 +498,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:NatService)).to be(false)
         end
 
+        it "proposed diff contains changes for firewall service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:FirewallService])
+          expect(diff[:FirewallService]).to have_at_least(1).items
+        end
+
       end
 
       context "there is no remote NatService config, but we are trying to update it" do
@@ -478,6 +541,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:FirewallService)).to be(false)
         end
 
+        it "proposed diff contains changes for nat service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:NatService])
+          expect(diff[:NatService]).to have_at_least(1).items
+        end
+
       end
 
       context "there is no remote LoadBalancer config, but we are trying to update it" do
@@ -515,6 +584,12 @@ module Vcloud
           expect(@proposed_config.config.key?(:FirewallService)).to be(false)
         end
 
+        it "proposed diff contains changes for load balancer service" do
+          diff = @proposed_config.diff
+          expect(diff.keys).to eq([:LoadBalancerService])
+          expect(diff[:LoadBalancerService]).to have_at_least(1).items
+        end
+
       end
 
       def test_firewall_config

data/vcloud-edge_gateway.gemspec

@@ -24,10 +24,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'fog', '>= 1.21.0'
   s.add_runtime_dependency 'vcloud-core', '~> 0.2.0'
   s.add_runtime_dependency 'hashdiff'
+  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'
   s.add_development_dependency 'simplecov', '~> 0.8.2'
   s.add_development_dependency 'gem_publisher', '1.2.0'
+  s.add_development_dependency 'vcloud-tools-tester', '0.0.5'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-edge_gateway
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,17 +112,17 @@ dependencies:
   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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -139,22 +155,41 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: vcloud-tools-tester
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 description: Tool to configure a VMware vCloud Edge Gateway. Uses vcloud-core.
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
 executables:
 - vcloud-configure-edge
+- vcloud-edge-configure
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/vcloud-configure-edge
+- bin/vcloud-edge-configure
 - examples/vcloud-configure-edge/firewall-rules.yaml
 - examples/vcloud-configure-edge/loadbalancer-rules.yaml
 - examples/vcloud-configure-edge/nat-rules.yaml
@@ -164,6 +199,7 @@ files:
 - jenkins.sh
 - jenkins_integration_tests.sh
 - lib/vcloud/edge_gateway.rb
+- lib/vcloud/edge_gateway/cli.rb
 - lib/vcloud/edge_gateway/configuration_differ.rb
 - lib/vcloud/edge_gateway/configuration_generator/firewall_service.rb
 - lib/vcloud/edge_gateway/configuration_generator/id_ranges.rb
@@ -179,6 +215,11 @@ files:
 - lib/vcloud/edge_gateway/schema/load_balancer_service.rb
 - lib/vcloud/edge_gateway/schema/nat_service.rb
 - lib/vcloud/edge_gateway/version.rb
+- spec/integration/README.md
+- spec/integration/edge_gateway/configure_firewall_spec.rb
+- spec/integration/edge_gateway/configure_load_balancer_spec.rb
+- spec/integration/edge_gateway/configure_nat_spec.rb
+- spec/integration/edge_gateway/configure_services_spec.rb
 - spec/integration/edge_gateway/data/firewall_config.yaml.mustache
 - spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.mustache
 - spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.mustache
@@ -192,12 +233,10 @@ files:
 - spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.mustache
 - spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.mustache
 - spec/integration/edge_gateway/data/nat_config.yaml.mustache
-- spec/integration/edge_gateway/edge_gateway_services_spec.rb
-- spec/integration/edge_gateway/firewall_service_spec.rb
-- spec/integration/edge_gateway/load_balancer_service_spec.rb
-- spec/integration/edge_gateway/nat_service_spec.rb
+- spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
 - spec/support/integration_helper.rb
+- spec/vcloud/edge_gateway/cli_spec.rb
 - spec/vcloud/edge_gateway/configuration_differ_shared_examples.rb
 - spec/vcloud/edge_gateway/configuration_differ_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/data/load_balancer_http-input.yaml
@@ -212,6 +251,7 @@ files:
 - spec/vcloud/edge_gateway/configuration_generator/firewall_service_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/load_balancer_service_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/nat_service_spec.rb
+- spec/vcloud/edge_gateway/configure_spec.rb
 - spec/vcloud/edge_gateway/edge_gateway_configuration_spec.rb
 - spec/vcloud/edge_gateway/firewall_configuration_differ_spec.rb
 - spec/vcloud/edge_gateway/firewall_schema_validation_spec.rb
@@ -242,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1385962529695170701
+      hash: -2937222901484224799
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -250,6 +290,11 @@ signing_key:
 specification_version: 3
 summary: Tool to configure a VMware vCloud Edge Gateway
 test_files:
+- spec/integration/README.md
+- spec/integration/edge_gateway/configure_firewall_spec.rb
+- spec/integration/edge_gateway/configure_load_balancer_spec.rb
+- spec/integration/edge_gateway/configure_nat_spec.rb
+- spec/integration/edge_gateway/configure_services_spec.rb
 - spec/integration/edge_gateway/data/firewall_config.yaml.mustache
 - spec/integration/edge_gateway/data/firewall_config_updated_rule.yaml.mustache
 - spec/integration/edge_gateway/data/firewall_rule_order_test.yaml.mustache
@@ -263,12 +308,10 @@ test_files:
 - spec/integration/edge_gateway/data/nat_and_firewall_config.yaml.mustache
 - spec/integration/edge_gateway/data/nat_and_firewall_plus_load_balancer_config.yaml.mustache
 - spec/integration/edge_gateway/data/nat_config.yaml.mustache
-- spec/integration/edge_gateway/edge_gateway_services_spec.rb
-- spec/integration/edge_gateway/firewall_service_spec.rb
-- spec/integration/edge_gateway/load_balancer_service_spec.rb
-- spec/integration/edge_gateway/nat_service_spec.rb
+- spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
 - spec/support/integration_helper.rb
+- spec/vcloud/edge_gateway/cli_spec.rb
 - spec/vcloud/edge_gateway/configuration_differ_shared_examples.rb
 - spec/vcloud/edge_gateway/configuration_differ_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/data/load_balancer_http-input.yaml
@@ -283,6 +326,7 @@ test_files:
 - spec/vcloud/edge_gateway/configuration_generator/firewall_service_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/load_balancer_service_spec.rb
 - spec/vcloud/edge_gateway/configuration_generator/nat_service_spec.rb
+- spec/vcloud/edge_gateway/configure_spec.rb
 - spec/vcloud/edge_gateway/edge_gateway_configuration_spec.rb
 - spec/vcloud/edge_gateway/firewall_configuration_differ_spec.rb
 - spec/vcloud/edge_gateway/firewall_schema_validation_spec.rb