kitchen-oci 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 67186c3f838c60391e5ba351f8960732da3e519b4aec842cd367a741f2dc6814
-  data.tar.gz: 74d7b45854ce8149df8796400755334c63da66ca7df5d0d9e18a5ae77c5f144e
+SHA1:
+  metadata.gz: f381c61062ca55422131f8087c2da907305d5041
+  data.tar.gz: 2f55fc92fe1d2130ab7918948b97871f58af72c6
 SHA512:
-  metadata.gz: 6bb2eefae0f2d8f9aa4d43e5d656bbf1750497827fb917cba0131d22cdd10c43f38671aa11e273e700fad9394db69a53b9be6cf27fac37649bd0cd99b2262f44
-  data.tar.gz: da3dca1ce1924c6d79ea32016e24782711bc951ab347db044a2fcf9c4af3ea6339b4ff3ae1a425752de8f6b3149f6873c6425cafad443701975840292b241598
+  metadata.gz: f9fbf9676d4fa352232c552204f2bc826fb97a5b422f55759ba06a51b94cf1f9fee477a77f00a09e32a853fd4f0bf3ffa5bf3b3fccc3f72c283e732dce824969
+  data.tar.gz: b577428531a407ea618c42f568ba18647c17fe15cec6071190f29272b65057cac521cbde9c2bb24e12062611c9659f3e163f711052f5ba3bbc513667f7d68187

data/README.md

@@ -54,10 +54,16 @@ Note: The availability domain should be the full AD name including the tenancy s
 
 These settings are optional:
 
+   - use\_private\_ip, Whether to connect to the instance using a private IP, default is false (public ip)
    - oci\_config\_file, OCI configuration file, by default this is ~/.oci/config
    - oci\_profile\_name, OCI profile to use, default value is "DEFAULT"
    - ssh\_keypath, SSH public key, default is ~/.ssh/id\_rsa.pub
-   - post\_create\_script, run a script on compute_instance after deployment
+   - post\_create\_script, run a script on compute\_instance after deployment
+   - proxy\_url, Connect via the specified proxy URL
+
+The use\_private\_ip influences whether the public or private IP will be used by Kitchen to connect to the instance.  If it is set to false (the default) then it will connect to the public IP, otherwise it'll use the private IP.
+
+If the subnet\_id refers to a subnet configured to disallow public IPs on any attached VNICs, then the VNIC will be created without a public IP and the use\_private\_ip flag will assumed to be true irrespective of the config setting.  On subnets that do allow a public IP a public IP will be allocated to the VNIC, but the use\_private\_ip flag can still be used to override whether the private or public IP will be used.
 
 ```
 ---
@@ -101,6 +107,33 @@ suites:
     attributes:
 ```
 
+## Proxy support
+
+If running Kitchen on a private subnet with no public IPs permitted, it may be necessary to connect to the OCI API via a web proxy.  The proxy URL can either be specified on the command line:
+```
+# With authentication
+export http_proxy=http://<proxy_user>:<proxy_password>@<proxy_host>:<proxy_port>"
+# Without authentication
+export http_proxy=http://<proxy_host>:<proxy_port>"
+```
+.. or if preferred in the cookbook's .kitchen.yml file.
+```
+driver:
+  ...
+  proxy_url: "http://<proxy_user>:<proxy_password>@<proxy_host>:<proxy_port>"
+```
+
+The SSH transport can also be tunneled via the web proxy using the CONNECT http method, but note that this is not handled by the kitchen-oci gem.  Configuration is provided here for convenience only:
+
+```
+transport:
+  username: "<os_username>"
+  ssh_http_proxy: "<proxy_host>"
+  ssh_http_proxy_port: <proxy_port>
+  ssh_http_proxy_user: <proxy_user>
+  ssh_http_proxy_password: <proxy_password>
+```
+
 Created and maintained by Stephen Pearson (<stevieweavie@gmail.com>)
 
 ## License

data/kitchen-oci.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'oci', '2.1.0'
+  spec.add_dependency 'oci', '~> 2.1'
   spec.add_dependency 'test-kitchen'
 
   spec.add_development_dependency 'bundler'

data/lib/kitchen/driver/oci.rb

@@ -19,6 +19,7 @@
 
 require 'kitchen'
 require 'oci'
+require 'uri'
 
 module Kitchen
   module Driver
@@ -38,13 +39,14 @@ module Kitchen
       default_keypath = File.expand_path(File.join(%w[~ .ssh id_rsa.pub]))
       default_config :ssh_keypath, default_keypath
       default_config :post_create_script, nil
+      default_config :proxy_url, nil
 
       def create(state) # rubocop:disable Metrics/AbcSize
         return if state[:server_id]
 
-        instance_id = launch_instance(config)
+        instance_id = launch_instance
         state[:server_id] = instance_id
-        state[:hostname] = instance_ip(config, instance_id)
+        state[:hostname] = instance_ip(instance_id)
 
         instance.transport.connection(state).wait_until_ready
 
@@ -59,7 +61,7 @@ module Kitchen
         return unless state[:server_id]
 
         instance.transport.connection(state).close
-        comp_api(config).terminate_instance(state[:server_id])
+        comp_api.terminate_instance(state[:server_id])
 
         state.delete(:server_id)
         state.delete(:hostname)
@@ -67,7 +69,7 @@ module Kitchen
 
       private
 
-      def oci_config(config)
+      def oci_config
         params = [:load_config]
         opts = {}
         if config[:oci_config_file]
@@ -80,28 +82,56 @@ module Kitchen
         OCI::ConfigFileLoader.send(*params)
       end
 
-      def comp_api(config)
-        OCI::Core::ComputeClient.new(config: oci_config(config))
+      def proxy_config
+        if config[:proxy_url]
+          URI.parse(config[:proxy_url])
+        else
+          URI.parse('http://').find_proxy
+        end
+      end
+
+      def api_proxy
+        prx = proxy_config
+        return nil unless prx
+        if prx.user
+          OCI::ApiClientProxySettings.new(prx.host, prx.port, prx.user,
+                                          prx.password)
+        else
+          OCI::ApiClientProxySettings.new(prx.host, prx.port)
+        end
+      end
+
+      def generic_api(klass)
+        api_prx = api_proxy
+        if api_prx
+          klass.new(config: oci_config, proxy_settings: api_prx)
+        else
+          klass.new(config: oci_config)
+        end
       end
 
-      def net_api(config)
-        OCI::Core::VirtualNetworkClient.new(config: oci_config(config))
+      def comp_api
+        generic_api(OCI::Core::ComputeClient)
       end
 
-      def launch_instance(config)
-        request = compute_instance_request(config)
+      def net_api
+        generic_api(OCI::Core::VirtualNetworkClient)
+      end
 
-        response = comp_api(config).launch_instance(request)
+      def launch_instance
+        request = compute_instance_request
+
+        response = comp_api.launch_instance(request)
         instance_id = response.data.id
-        comp_api(config).get_instance(instance_id).wait_until(
+        comp_api.get_instance(instance_id).wait_until(
           :lifecycle_state,
           OCI::Core::Models::Instance::LIFECYCLE_STATE_RUNNING
         )
         instance_id
       end
 
-      def vnic_attachments(config, instance_id)
-        att = comp_api(config).list_vnic_attachments(
+      def vnic_attachments(instance_id)
+        att = comp_api.list_vnic_attachments(
           config[:compartment_id],
           instance_id: instance_id
         ).data
@@ -109,50 +139,54 @@ module Kitchen
         att
       end
 
-      def vnics(config, instance_id)
-        vnic_attachments(config, instance_id).map do |att|
-          net_api(config).get_vnic(att.vnic_id).data
+      def vnics(instance_id)
+        vnic_attachments(instance_id).map do |att|
+          net_api.get_vnic(att.vnic_id).data
         end
       end
 
-      def instance_ip(config, instance_id)
-        vnic = vnics(config, instance_id).select(&:is_primary).first
-        config[:use_private_ip] ? vnic.private_ip : vnic.public_ip
+      def instance_ip(instance_id)
+        vnic = vnics(instance_id).select(&:is_primary).first
+        if public_ip_allowed?
+          config[:use_private_ip] ? vnic.private_ip : vnic.public_ip
+        else
+          vnic.private_ip
+        end
       end
 
-      def pubkey(config)
+      def pubkey
         File.readlines(config[:ssh_keypath]).first.chomp
       end
 
-      def instance_source_details(config)
+      def instance_source_details
         OCI::Core::Models::InstanceSourceViaImageDetails.new(
           sourceType: 'image',
           imageId: config[:image_id]
         )
       end
 
-      def public_ip_allowed?(config)
-        subnet = net_api(config).get_subnet(config[:subnet_id]).data
+      def public_ip_allowed?
+        subnet = net_api.get_subnet(config[:subnet_id]).data
         !subnet.prohibit_public_ip_on_vnic
       end
 
-      def create_vnic_details(config)
+      def create_vnic_details
         OCI::Core::Models::CreateVnicDetails.new(
-          assign_public_ip: public_ip_allowed?(config),
+          assign_public_ip: public_ip_allowed?,
           display_name: 'primary_nic',
           subnetId: config[:subnet_id]
         )
       end
 
-      def compute_instance_request(config)
+      def compute_instance_request # rubocop:disable Metrics/AbcSize
         request = OCI::Core::Models::LaunchInstanceDetails.new
         request.availability_domain = config[:availability_domain]
         request.compartment_id = config[:compartment_id]
         request.display_name = random_hostname(instance.name)
-        request.source_details = instance_source_details(config)
+        request.source_details = instance_source_details
         request.shape = config[:shape]
-        request.create_vnic_details = create_vnic_details(config)
-        request.metadata = { 'ssh_authorized_keys' => pubkey(config) }
+        request.create_vnic_details = create_vnic_details
+        request.metadata = { 'ssh_authorized_keys' => pubkey }
         request
       end
 

data/lib/kitchen/driver/oci_version.rb

@@ -20,6 +20,6 @@
 module Kitchen
   module Driver
     # Version string for Oracle OCI Kitchen driver
-    OCI_VERSION = '1.2.0'
+    OCI_VERSION = '1.3.0'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-oci
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Stephen Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oci
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A Test Kitchen Driver for Oracle OCI