vcloud-net_launcher 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.0 (2014-07-25)
+
+  - Remove the command line option to enable fog mocking.
+  - Add documentation for public API methods.
+
 ## 0.3.0 (2014-07-14)
 
 Features:

data/lib/vcloud/net_launcher/cli.rb

@@ -4,19 +4,24 @@ module Vcloud
   module NetLauncher
     class Cli
 
+      # Initiates parsing of the command-line arguments.
+      #
+      # @param  argv_array [Array] Command-line arguments
+      # @return [void]
       def initialize(argv_array)
         @usage_text = nil
         @config_file = nil
-        @options = {
-          "mock" => false,
-        }
 
         parse(argv_array)
       end
 
+      # Runs +Vcloud::NetLauncher::NetLaunch#run+ to create networks defined
+      # in +@config_file+, catching any exceptions to prevent printing a backtrace.
+      #
+      # @return [void]
       def run
         begin
-          Vcloud::NetLauncher::NetLaunch.new.run(@config_file, @options)
+          Vcloud::NetLauncher::NetLaunch.new.run(@config_file)
         rescue => error_msg
           $stderr.puts(error_msg)
           exit 1
@@ -52,10 +57,6 @@ Example configuration files can be found in:
           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

data/lib/vcloud/net_launcher/net_launch.rb

@@ -4,17 +4,20 @@ module Vcloud
   module NetLauncher
     class NetLaunch
 
+      # Initializes instance variables.
+      #
+      # @return [void]
       def initialize
         @config_loader = Vcloud::Core::ConfigLoader.new
       end
 
-      def run(config_file = nil, options = {})
+      # Parses a configuration file and provisions the networks it defines.
+      #
+      # @param  config_file [String]  Path to a YAML or JSON-formatted configuration file
+      # @return [void]
+      def run(config_file = nil)
         config = @config_loader.load_config(config_file, Vcloud::NetLauncher::Schema::NET_LAUNCH)
 
-        if options[:mock] || ENV['FOG_MOCK']
-          ::Fog.mock!
-        end
-
         config[:org_vdc_networks].each do |net_config|
           net_config[:fence_mode] ||= 'isolated'
           Vcloud::Core.logger.info("Provisioning orgVdcNetwork #{net_config[:name]}.")

data/lib/vcloud/net_launcher/version.rb

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

data/spec/spec_helper.rb

@@ -31,3 +31,11 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
+
+# To enable Fog Mock mode use FOG_CREDENTIAL=fog_mock and FOG_MOCK=true
+# If you do not have configuration for fog_mock in your vcloud_tools_testing_config.yaml,
+# the test data is defined here: https://github.com/fog/fog/blob/master/lib/fog/vcloud_director/compute.rb#L483-L733
+#
+if ENV['FOG_MOCK']
+  Fog.mock!
+end

data/spec/vcloud/net_launcher/cli_spec.rb

@@ -40,29 +40,13 @@ describe Vcloud::NetLauncher::Cli 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)
+          with(config_file)
         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

data/spec/vcloud/net_launcher/net_launch_spec.rb

@@ -48,7 +48,7 @@ describe Vcloud::NetLauncher::NetLaunch do
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network2)
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network3)
 
-      subject.run('input_config_yaml', cli_options)
+      subject.run('input_config_yaml')
     end
 
     it "should abort on errors from Vcloud::Core" do
@@ -58,27 +58,10 @@ describe Vcloud::NetLauncher::NetLaunch do
       expect(Vcloud::Core::OrgVdcNetwork).not_to receive(:provision).with(network3)
 
       expect {
-        Vcloud::NetLauncher::NetLaunch.new.run('input_config_yaml', cli_options)
+        Vcloud::NetLauncher::NetLaunch.new.run('input_config_yaml')
       }.to raise_error(RuntimeError, 'Did not successfully create orgVdcNetwork')
     end
 
-    describe "fog mocking" do
-      it "should not mock fog by default" do
-        expect(Fog).to_not receive(:mock!)
-        expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).exactly(3).times
-
-        subject.run('input_config_yaml', cli_options)
-      end
-
-      it "should mock fog when passed option" do
-        expect(Fog).to receive(:mock!)
-        expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).exactly(3).times
-
-        cli_options = { :mock => true }
-        subject.run('input_config_yaml', cli_options)
-      end
-    end
-
   end
 
   context "ConfigLoader returns one network without :fence_mode set" do
@@ -108,7 +91,7 @@ describe Vcloud::NetLauncher::NetLaunch do
       expect(network_without_fence_mode).not_to have_key(:fence_mode)
       expect(Vcloud::Core::OrgVdcNetwork).to receive(:provision).with(network_with_fence_mode)
 
-      subject.run('input_config_yaml', cli_options)
+      subject.run('input_config_yaml')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-net_launcher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcloud-core
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3723490288944592179
+      hash: 792051475262227984
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23