vcloud-core 0.15.0 → 0.16.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.16.0 (2014-12-03)
+
+Features:
+
+  - New `vlcoud-logout` command line utility to revoke session tokens.
+  - New `Vcloud::Core::Fog.logout` method to revoke session tokens.
+
 ## 0.15.0 (2014-11-26)
 
 Features:

data/bin/vcloud-logout

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'vcloud/core'
+
+Vcloud::Core::LogoutCli.new(ARGV).run

data/jenkins_tests.sh

@@ -32,6 +32,7 @@ rm -rf vcloud-tools-testing-config
 # Never log token to STDOUT.
 set +x
 eval $(printenv API_PASSWORD | bundle exec vcloud-login)
+trap "bundle exec vcloud-logout" EXIT
 
 bundle exec rake
 bundle exec rake integration

data/lib/vcloud/core.rb

@@ -13,6 +13,7 @@ require 'vcloud/core/vdc'
 require 'vcloud/core/edge_gateway'
 require 'vcloud/core/edge_gateway_interface'
 require 'vcloud/core/login_cli'
+require 'vcloud/core/logout_cli'
 require 'vcloud/core/vm'
 require 'vcloud/core/vapp'
 require 'vcloud/core/vapp_template'

data/lib/vcloud/core/fog.rb

@@ -10,6 +10,21 @@ module Vcloud
       TOKEN_ENV_VAR_NAME = 'FOG_VCLOUD_TOKEN'
       FOG_CREDS_PASS_NAME = :vcloud_director_password
 
+      # Logout an existing vCloud session, rendering the token unusable.
+      # Requires a FOG_VCLOUD_TOKEN environment variable to be set.
+      #
+      # @return [Boolean] return true or raise an exception
+      def self.logout
+        unless ENV[TOKEN_ENV_VAR_NAME]
+          raise "#{TOKEN_ENV_VAR_NAME} environment variable is not set"
+        end
+
+        fsi = Vcloud::Core::Fog::ServiceInterface.new
+        fsi.logout
+
+        return true
+      end
+
       # Run any checks needed against the Fog credentials
       # currently only used to disallow plaintext passwords
       # in .fog files.

data/lib/vcloud/core/fog/service_interface.rb

@@ -18,7 +18,8 @@ module Vcloud
                        :put_vm, :get_edge_gateway, :get_network_complete, :delete_network, :post_create_org_vdc_network,
                        :post_configure_edge_gateway_services, :get_vdc, :post_undeploy_vapp,
                        :post_create_disk, :get_disk, :delete_disk, :post_attach_disk,
-                       :get_vms_disk_attached_to, :post_detach_disk, :put_product_sections
+                       :get_vms_disk_attached_to, :post_detach_disk, :put_product_sections,
+                       :logout
 
         #########################
         # FogFacade Inner class to represent a logic free facade over our interactions with Fog
@@ -40,6 +41,10 @@ module Vcloud
             @vcloud.get_current_session.body
           end
 
+          def logout
+            @vcloud.delete_logout
+          end
+
           def get_vapps_in_lease_from_query(options)
             @vcloud.get_vapps_in_lease_from_query(options).body
           end

data/lib/vcloud/core/logout_cli.rb

@@ -0,0 +1,72 @@
+require 'optparse'
+
+module Vcloud
+  module Core
+    class LogoutCli
+
+      # Create a new instance of the CLI, parsing the arguments supplied
+      #
+      # @param argv_array [Array] The Array of ARGV arguments
+      # @return [Vcloud::Core::LogoutCLI]
+      def initialize(argv_array)
+        @usage_text = nil
+
+        parse(argv_array)
+      end
+
+      # Logout an existing vCloud session.
+      #
+      # @return [void]
+      def run
+        begin
+          Vcloud::Core::Fog.logout
+        rescue => e
+          $stderr.puts("#{e.class}: #{e.message}")
+          exit 1
+        end
+      end
+
+      private
+
+      def parse(args)
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: #{$0} [options]
+
+Utility for logging out of a vCloud session and preventing future use of the
+session token. A `FOG_VCLOUD_TOKEN` environment variable, as provided by
+`vcloud-login`, must be present.
+
+          EOS
+
+          opts.on("-h", "--help", "Print usage and exit") do
+            $stderr.puts opts
+            exit
+          end
+
+          opts.on("--version", "Display version and exit") do
+            puts Vcloud::Core::VERSION
+            exit
+          end
+        end
+
+        @usage_text = opt_parser.to_s
+        begin
+          opt_parser.parse!(args)
+        rescue OptionParser::InvalidOption => e
+          exit_error_usage(e)
+        end
+
+        if args.size > 0
+          exit_error_usage("too many arguments")
+        end
+      end
+
+      def exit_error_usage(error)
+        $stderr.puts "#{$0}: #{error}"
+        $stderr.puts @usage_text
+        exit 2
+      end
+    end
+  end
+end

data/lib/vcloud/core/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Core
-    VERSION = '0.15.0'
+    VERSION = '0.16.0'
   end
 end

data/spec/integration/core/fog/login_spec.rb

@@ -42,10 +42,17 @@ describe Vcloud::Core::Fog::Login do
       let(:envvar_password) { 'API_PASSWORD' }
 
       before(:each) do
+        @temp_token = nil
         @real_password = ENV[envvar_password]
         stub_const('ENV', {})
       end
 
+      after(:each) do
+        stub_const('ENV', { envvar_token => @temp_token })
+        fsi = Vcloud::Core::Fog::ServiceInterface.new
+        fsi.logout
+      end
+
       context "environment variable VCLOUD_FOG_TOKEN not set" do
         it "should login and return a token" do
           unless @real_password
@@ -53,8 +60,8 @@ describe Vcloud::Core::Fog::Login do
           end
 
           expect(ENV).not_to have_key(envvar_token)
-          token = subject.token(@real_password)
-          expect(token.size).to eq(token_length)
+          @temp_token = subject.token(@real_password)
+          expect(@temp_token.size).to eq(token_length)
         end
       end
 
@@ -67,9 +74,9 @@ describe Vcloud::Core::Fog::Login do
           end
 
           ENV[envvar_token] = old_token
-          new_token = subject.token(@real_password)
-          expect(new_token).to_not eq(old_token)
-          expect(new_token.size).to eq(token_length)
+          @temp_token = subject.token(@real_password)
+          expect(@temp_token).to_not eq(old_token)
+          expect(@temp_token.size).to eq(token_length)
         end
       end
     end

data/spec/integration/core/fog_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Vcloud::Core::Fog do
+  describe "#logout" do
+    let(:subject) { Vcloud::Core::Fog.logout }
+
+    let(:envvar_token) { 'FOG_VCLOUD_TOKEN' }
+    let(:envvar_password) { 'API_PASSWORD' }
+
+    context "with a valid token" do
+      before(:each) do
+        @real_password = ENV[envvar_password]
+        unless @real_password
+          pending "Password not available from environment variable #{envvar_password}"
+        end
+
+        stub_const('ENV', {})
+        temp_token = Vcloud::Core::Fog::Login.token(@real_password)
+        ENV[envvar_token] = temp_token
+      end
+
+      it "should invalidate a previously working session" do
+        fsi = Vcloud::Core::Fog::ServiceInterface.new
+        expect(fsi.session).to include(:user, :org)
+
+        expect(subject).to eq(true)
+        # logout appears to sometimes be slightly asynchronous and doesn't
+        # provide a task that we can monitor the progress of.
+        sleep(1)
+
+        fsi = Vcloud::Core::Fog::ServiceInterface.new
+        expect{ fsi.session }.to raise_error(
+          Fog::Compute::VcloudDirector::Forbidden, "Access is forbidden"
+        )
+      end
+    end
+
+    context "with an invalid token" do
+      before(:each) do
+        stub_const('ENV', { envvar_token => 'invalid' })
+      end
+
+      it "should raise an exception from Fog" do
+        expect{ subject }.to raise_error(
+          Fog::Compute::VcloudDirector::Forbidden, "Access is forbidden"
+        )
+      end
+    end
+  end
+end

data/spec/vcloud/core/fog_spec.rb

@@ -1,6 +1,24 @@
 require 'spec_helper'
 
 describe Vcloud::Core::Fog do
+  describe "logout" do
+    let(:subject) { Vcloud::Core::Fog::logout }
+    let(:envvar_token) { 'FOG_VCLOUD_TOKEN' }
+
+    context "token environment variable not set" do
+      before(:each) do
+        stub_const('ENV', {})
+      end
+
+      it "should raise an error" do
+        expect(Vcloud::Core::Fog::ServiceInterface).not_to receive(:new)
+        expect { subject }.to raise_error(
+          RuntimeError, "FOG_VCLOUD_TOKEN environment variable is not set"
+        )
+      end
+    end
+  end
+
   describe "fog_credentials_pass" do
     let(:subject) { Vcloud::Core::Fog::fog_credentials_pass }
 

data/spec/vcloud/core/logout_cli_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+class LogoutCommandRun
+  attr_accessor :stdout, :stderr, :exitstatus
+
+  def initialize(args)
+    out = StringIO.new
+    err = StringIO.new
+
+    $stdout = out
+    $stderr = err
+
+    begin
+      Vcloud::Core::LogoutCli.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::Core::LogoutCli do
+  subject { LogoutCommandRun.new(args) }
+
+  describe "normal usage" do
+    context "when given no arguments" do
+      let(:args) { %w{} }
+
+      it "should " do
+        expect(Vcloud::Core::Fog).to receive(:logout).and_return({})
+        expect(subject.stderr).to eq("")
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when asked to display version" do
+      let(:args) { %w{--version} }
+
+      it "should not call Logout" do
+        expect(Vcloud::Core::Fog).not_to receive(:logout)
+      end
+
+      it "should print version and exit normally" do
+        expect(subject.stdout).to eq(Vcloud::Core::VERSION)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+
+    context "when asked to display help" do
+      let(:args) { %w{--help} }
+
+      it "should not call Logout" do
+        expect(Vcloud::Core::Fog).not_to receive(:logout)
+      end
+
+      it "should print usage and exit normally" do
+        expect(subject.stderr).to match(/\AUsage: \S+ \[options\]\n/)
+        expect(subject.exitstatus).to eq(0)
+      end
+    end
+  end
+
+  describe "incorrect usage" do
+    shared_examples "print usage and exit abnormally" do |error|
+      it "should not call Logout" do
+        expect(Vcloud::Core::Fog).not_to receive(:logout)
+      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 given more than one argument" do
+      let(:args) { %w{an_extra_arg} }
+
+      it_behaves_like "print usage and exit abnormally", "too many arguments"
+    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{} }
+      let(:exception) { RuntimeError.new('something went horribly wrong') }
+
+      it "should print error without backtrace and exit abnormally" do
+        expect(Vcloud::Core::Fog).to receive(:logout).and_raise(exception)
+        expect(subject.stderr).to eq("RuntimeError: something went horribly wrong")
+        expect(subject.exitstatus).to eq(1)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-core
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &17329660 !ruby/object:Gem::Requirement
+  requirement: &13600400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.25.0
   type: :runtime
   prerelease: false
-  version_requirements: *17329660
+  version_requirements: *13600400
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &17329280 !ruby/object:Gem::Requirement
+  requirement: &13195100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17329280
+  version_requirements: *13195100
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &17328820 !ruby/object:Gem::Requirement
+  requirement: &13191240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17328820
+  version_requirements: *13191240
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &17328320 !ruby/object:Gem::Requirement
+  requirement: &13189080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *17328320
+  version_requirements: *13189080
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &17327900 !ruby/object:Gem::Requirement
+  requirement: &13314900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17327900
+  version_requirements: *13314900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &17327440 !ruby/object:Gem::Requirement
+  requirement: &13311520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17327440
+  version_requirements: *13311520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17326940 !ruby/object:Gem::Requirement
+  requirement: &13266620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *17326940
+  version_requirements: *13266620
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: &17326440 !ruby/object:Gem::Requirement
+  requirement: &13658140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.23.0
   type: :development
   prerelease: false
-  version_requirements: *17326440
+  version_requirements: *13658140
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &17325980 !ruby/object:Gem::Requirement
+  requirement: &13655200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *17325980
+  version_requirements: *13655200
 - !ruby/object:Gem::Dependency
   name: vcloud-tools-tester
-  requirement: &17325520 !ruby/object:Gem::Requirement
+  requirement: &13653640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,13 +120,14 @@ dependencies:
         version: 0.2.0
   type: :development
   prerelease: false
-  version_requirements: *17325520
+  version_requirements: *13653640
 description: Core tools for interacting with VMware vCloud Director. Includes VCloud
   Query, a light wrapper round the vCloud Query API.
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
 executables:
 - vcloud-login
+- vcloud-logout
 - vcloud-query
 extensions: []
 extra_rdoc_files: []
@@ -140,6 +141,7 @@ files:
 - README.md
 - Rakefile
 - bin/vcloud-login
+- bin/vcloud-logout
 - bin/vcloud-query
 - jenkins.sh
 - jenkins_tests.sh
@@ -158,6 +160,7 @@ files:
 - lib/vcloud/core/fog/service_interface.rb
 - lib/vcloud/core/independent_disk.rb
 - lib/vcloud/core/login_cli.rb
+- lib/vcloud/core/logout_cli.rb
 - lib/vcloud/core/metadata_helper.rb
 - lib/vcloud/core/org_vdc_network.rb
 - lib/vcloud/core/query.rb
@@ -171,6 +174,7 @@ files:
 - spec/integration/README.md
 - spec/integration/core/edge_gateway_spec.rb
 - spec/integration/core/fog/login_spec.rb
+- spec/integration/core/fog_spec.rb
 - spec/integration/core/independent_disk_spec.rb
 - spec/integration/core/query_runner_spec.rb
 - spec/integration/core/vapp_spec.rb
@@ -198,6 +202,7 @@ files:
 - spec/vcloud/core/fog_spec.rb
 - spec/vcloud/core/independent_disk_spec.rb
 - spec/vcloud/core/login_cli_spec.rb
+- spec/vcloud/core/logout_cli_spec.rb
 - spec/vcloud/core/metadata_helper_spec.rb
 - spec/vcloud/core/org_vdc_network_spec.rb
 - spec/vcloud/core/query_cli_spec.rb
@@ -229,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 760204335874509684
+      hash: -1936108381695817520
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -240,6 +245,7 @@ test_files:
 - spec/integration/README.md
 - spec/integration/core/edge_gateway_spec.rb
 - spec/integration/core/fog/login_spec.rb
+- spec/integration/core/fog_spec.rb
 - spec/integration/core/independent_disk_spec.rb
 - spec/integration/core/query_runner_spec.rb
 - spec/integration/core/vapp_spec.rb
@@ -267,6 +273,7 @@ test_files:
 - spec/vcloud/core/fog_spec.rb
 - spec/vcloud/core/independent_disk_spec.rb
 - spec/vcloud/core/login_cli_spec.rb
+- spec/vcloud/core/logout_cli_spec.rb
 - spec/vcloud/core/metadata_helper_spec.rb
 - spec/vcloud/core/org_vdc_network_spec.rb
 - spec/vcloud/core/query_cli_spec.rb