kitchen-oci 1.12.3 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a10f6ca7b7c04c9156e106fefce6077699d9fb82e377d3475fa1876b7d96b411
-  data.tar.gz: eff8e99b111c337b3d748f305d4fecd80952c59ac3220f144b034c14061db807
+  metadata.gz: a0cea9f46ffa83a8b4e5f7eed890889aa6265631e5cfbea839169f31e0dccaa7
+  data.tar.gz: 213c557476fce406d144335deba42318dd0a4fbb8820b4754b37acf1f4460bf0
 SHA512:
-  metadata.gz: 3fd050c58446fc60c4ac4e6e8e95b62503b00402d48b6b83d35f75b698cef3d84747cb3a5e0d7e8ca8f367cb157d99cc726c5a9a6317fbc9a2d3c704a0fcba3c
-  data.tar.gz: 201e5ae042165df1be1fdf11a3f70e2afe8df78907c396d8afbda53dea56a55a29bf2d76a52acfcc10d60d7b68097e968ccd28eadfa3c39936cb3db5e1bdfb14
+  metadata.gz: 23272af5f39d286faf4affcd9b1966d5b67a531fe300614a9fe982d443af8fcac016aa511b6f953f790c425a75b6582eb1dbc010c3ce9fa3195cacdfba2506f6
+  data.tar.gz: a8b5c341ee9762d0d246e192a443dbe98f13e28b24c58b7674d80484b792d348e8dfdb0644252246a823832987201b6a7aa966809b5a8d5b2d5744db6189d8e0

data/lib/kitchen/driver/oci.rb

@@ -51,6 +51,7 @@ module Kitchen
       default_config :proxy_url, nil
       default_config :user_data, nil
       default_config :freeform_tags, {}
+      default_config :defined_tags, {}
 
       # compute config items
       default_config :image_id
@@ -70,6 +71,9 @@ module Kitchen
       # dbaas config items
       default_config :dbaas, {}
 
+      # blockstorage config items
+      default_config :volumes, {}
+
       def create(state)
         return if state[:server_id]
 
@@ -82,6 +86,9 @@ module Kitchen
 
         instance.transport.connection(state).wait_until_ready
 
+        state[:volumes] = process_volumes_list(state)
+        state[:volume_attachments] = process_volume_attachments(state)
+
         return unless config[:post_create_script]
 
         info('Running post create script')
@@ -94,6 +101,18 @@ module Kitchen
 
         instance.transport.connection(state).close
 
+        if state[:volume_attachments]
+          state[:volume_attachments].each do |attachment|
+            volume_detach(attachment)
+          end
+        end
+
+        if state[:volumes]
+          state[:volumes].each do |vol|
+            volume_delete(vol[:id])
+          end
+        end
+
         if instance_type == 'compute'
           comp_api.terminate_instance(state[:server_id])
         elsif instance_type == 'dbaas'
@@ -231,6 +250,10 @@ module Kitchen
         generic_api(OCI::Identity::IdentityClient)
       end
 
+      def blockstorage_api
+        generic_api(OCI::Core::BlockstorageClient)
+      end
+
       ##################
       # Common methods #
       ##################
@@ -341,6 +364,7 @@ module Kitchen
           l.shape = config[:shape]
           l.create_vnic_details = create_vnic_details(hostname)
           l.freeform_tags = process_freeform_tags(config[:freeform_tags])
+          l.defined_tags = config[:defined_tags]
           l.preemptible_instance_config = preemptible_instance_config if config[:preemptible_instance]
           l.shape_config = shape_config unless config[:shape_config].empty?
         end
@@ -372,10 +396,13 @@ module Kitchen
       end
 
       def create_vnic_details(name)
+        nsg_ids = config[:nsg_ids] || []
+        raise 'nsg_ids cannot have more than 5 NSGs.' if nsg_ids.length > 5
         OCI::Core::Models::CreateVnicDetails.new(
           assign_public_ip: public_ip_allowed?,
           display_name: name,
           hostname_label: name,
+          nsg_ids: nsg_ids,
           subnetId: config[:subnet_id]
         )
       end
@@ -461,6 +488,107 @@ module Kitchen
         end
       end
 
+      ########################
+      # BlockStorage methods #
+      ########################
+      def process_volumes_list(state)
+        created_vol = []
+        config[:volumes].each do |vol_settings|
+          # convert to hash because otherwise it's an an OCI API Object and won't load
+          volume_attachment_type = vol_settings[:type].downcase || 'paravirtual'
+          unless %w[iscsi paravirtual].include?(volume_attachment_type)
+            info("invalid volume attachment type: #{volume_attachment_type}")
+            next
+          end
+          volume = volume_create(
+            config[:availability_domain],
+            vol_settings[:name],
+            vol_settings[:size_in_gbs],
+            vol_settings[:vpus_per_gb] || 10
+          ).to_hash
+          # convert to string otherwise it's a ruby datetime object and won't load
+          volume[:attachment_type] = volume_attachment_type
+          created_vol << volume
+        end
+        created_vol
+      end
+
+      def volume_create(availability_domain, display_name, size_in_gbs, vpus_per_gb)
+        info("Creating volume <#{display_name}>...")
+        result = blockstorage_api.create_volume(
+          OCI::Core::Models::CreateVolumeDetails.new(
+            compartment_id: compartment_id,
+            availability_domain: availability_domain,
+            display_name: display_name,
+            size_in_gbs: size_in_gbs,
+            vpus_per_gb: vpus_per_gb
+          )
+        )
+        get_volume_response = blockstorage_api.get_volume(result.data.id)
+                                              .wait_until(:lifecycle_state, OCI::Core::Models::Volume::LIFECYCLE_STATE_AVAILABLE)
+        info("Finished creating volume <#{display_name}>.")
+        state_data = {
+          :id => get_volume_response.data.id
+        }
+      end
+
+      def volume_delete(volume_id)
+        info("Deleting volume: <#{volume_id}>...")
+        blockstorage_api.delete_volume(volume_id)
+        blockstorage_api.get_volume(volume_id)
+                        .wait_until(:lifecycle_state, OCI::Core::Models::Volume::LIFECYCLE_STATE_TERMINATED)
+        info("Deleted volume: <#{volume_id}>")
+      end
+
+      def process_volume_attachments(state)
+        attachments = []
+        state[:volumes].each do |volume|
+          info("Attaching Volume: #{volume[:displayName]} - #{volume[:attachment_type]}")
+          details = volume_create_attachment_details(volume, state[:server_id])
+          attachment = volume_attach(details).to_hash
+          attachments << attachment
+          info("Attached Volume #{volume[:displayName]} - #{volume[:attachment_type]}")
+        end
+        attachments
+      end
+
+      def volume_create_attachment_details(volume, instance_id)
+        if volume[:attachment_type].eql?('iscsi')
+          OCI::Core::Models::AttachIScsiVolumeDetails.new(
+            display_name: 'iSCSIAttachment',
+            volume_id: volume[:id],
+            instance_id: instance_id
+          )
+        elsif volume[:attachment_type].eq?('paravirtual')
+          OCI::Core::Models::AttachParavirtualizedVolumeDetails.new(
+            display_name: 'paravirtAttachment',
+            volume_id: volume[:id],
+            instance_id: instance_id
+          )
+        end
+      end
+
+      def volume_attach(volume_attachment_details)
+        result = comp_api.attach_volume(volume_attachment_details)
+        get_volume_attachment_response =
+          comp_api.get_volume_attachment(result.data.id)
+                  .wait_until(:lifecycle_state, OCI::Core::Models::VolumeAttachment::LIFECYCLE_STATE_ATTACHED)
+        state_data = {
+          :id => get_volume_attachment_response.data.id,
+          :iqn_ipv4 => get_volume_attachment_response.data.ipv4,
+          :iqn => get_volume_attachment_response.data.iqn,
+          :port => get_volume_attachment_response.data.port,
+        }
+      end
+
+      def volume_detach(volume_attachment)
+        info("Detaching volume: #{volume_attachment[:id]}")
+        comp_api.detach_volume(volume_attachment[:id])
+        comp_api.get_volume_attachment(volume_attachment[:id])
+                .wait_until(:lifecycle_state, OCI::Core::Models::VolumeAttachment::LIFECYCLE_STATE_DETACHED)
+        info("Detached volume: #{volume_attachment[:id]}")
+      end
+
       #################
       # DBaaS methods #
       #################
@@ -500,6 +628,7 @@ module Kitchen
           l.license_model = license_model
           l.subnet_id = config[:subnet_id]
           l.freeform_tags = process_freeform_tags(config[:freeform_tags])
+          l.defined_tags = config[:defined_tags]
         end
       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.12.3'
+    OCI_VERSION = '1.14.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-oci
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.14.0
 platform: ruby
 authors:
 - Stephen Pearson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oci
@@ -115,17 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".cane"
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
-- NOTICE
-- README.md
-- Rakefile
-- kitchen-oci.gemspec
 - lib/kitchen/driver/oci.rb
 - lib/kitchen/driver/oci_version.rb
 - tpl/setup_winrm.ps1.erb
@@ -133,7 +123,7 @@ homepage: ''
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Oracle OCI
 test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-*.swp
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.kitchen
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rubocop.yml

@@ -1,5 +0,0 @@
-Layout/LineLength:
-    Max : 150
-
-Style/NumericLiterals:
-    Enabled : false

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-
-rvm:
-- 2.0.0
-- 1.9.3
-- 1.9.2
-- ruby-head
-
-matrix:
-  allow_failures:
-  - rvm: ruby-head

data/CHANGELOG.md

@@ -1,40 +0,0 @@
-
-## 1.12.1
-- Refactor `oci_config` method to account for `warning: Using the last argument as keyword parameters is deprecated` deprecation warning
-- Set dependency on oci gem to 2.15.0
-
-## 1.12.0
-- Added support for Flex and Preemptible instances
-- Set dependency on oci gem to 2.14.0
-- Further reduction of characters known to cause winrm password issues
-
-## 1.11.2
-- Set dependency on oci gem to 2.10.0
-
-## 1.11.1
-- Removed characters from password string known to break winrm
-
-## 1.11.0
-- Added support for user_data raw string
-
-## 1.10.1 Issue 22
-- Added safeguard for cluster_name length restriction in DBaaS.
-
-## 1.10.0 DBaaS support
-- Added support for DBaaS.
-  - instance_type is new optional parameter (compute or dbaas)
-
-## 1.9.0 Use instance principals
-- Added support for `use_instance_principals`
-
-## 1.8.0 Freeform tags
-- Added optional parameter `freeform_tags`
-
-## 1.6.0 WinRM password option
-- Added option to set winrm password, instead of randomly generating one
-
-## 1.5.0 Windows support
-
-- Added cloud-init support.
-- Added support for Windows targets.
-  - Can inject powershell script to set a random password and enable WinRM

data/Gemfile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-#   Copyright 2020 Stephen Pearson <stephen.pearson@oracle.com>
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-
-source 'https://rubygems.org'
-
-gemspec

data/NOTICE

@@ -1,96 +0,0 @@
-LICENSING INFORMATION
----------------------
-
-This code has dependencies upon oci-ruby-sdk and Chef Kitchen
-
-oci-ruby-sdk: https://github.com/oracle/oci-ruby-sdk (Universal Permissive License, or Apache License 2.0)
-chef-dk : https://github.com/chef/chef-dk (Apache License 2.0)
-
-LICENSES
---------
-
-Copyright (c) 2016, 2019, Oracle and/or its affiliates.  All rights reserved.
-
-This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0.  See below for license terms.  You may choose either license.
- ____________________________
-The Universal Permissive License (UPL), Version 1.0
-Copyright (c) 2016, 2019, Oracle and/or its affiliates.  All rights reserved.
-
-Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
-
-(a) the Software, and
-(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a "Larger Work" to which the Software is contributed by such licensors),
-
-without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
-
-This license is subject to the following condition:
-
-The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-The Apache Software License, Version 2.0
-Copyright (c) 2016, 2019, Oracle and/or its affiliates.  All rights reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License"); You may not use this product except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.  A copy of the license is also reproduced below.  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and  limitations under the License.
-
-Apache License
-
-Version 2.0, January 2004
-
-http://www.apache.org/licenses/
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-1. Definitions.
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-You must give any other recipients of the Work or Derivative Works a copy of this License; and
-You must cause any modified files to carry prominent notices stating that You changed the files; and
-You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
-If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
-
-You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
-END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-
-

data/README.md

@@ -1,367 +0,0 @@
-# Kitchen::OCI
-
-A Test Kitchen Driver for Oracle Cloud Infrastructure (OCI)
-
-## Prerequisites
-
-You need an ssh keypair defined for your current user.  By default the driver
-expects to find the public key in ~/.ssh/id\_rsa.pub, but this can be
-overridden in .kitchen.yml.
-
-You need to create suitable configuration for OCI in ~/.oci/config and this
-can be created using the CLI:
-```bash
-oci setup config
-```
-
-Ensure that you have a suitable compartment defined, an external subnet, and
-security rules that allow incoming SSH and outgoing HTTP to allow Kitchen to
-pull the Chef binaries.
-
-## Building the gem
-
-This step is only necessary if you wish to make local modifications.  The gem
-has already been published to rubygems.org.
-
-```bash
-rake build
-```
-
-## Installing the gem
-
-You must install the gem into whatever Ruby is used to run kitchen.  On a
-workstation this will likely be the ChefDK environment.  To switch to
-ChefDK if you haven't already:
-
-```bash
-eval "$(chef shell-init bash)"
-```
-
-You can install the gem from RubyGems.org with:
-
-```bash
-gem install kitchen-oci
-```
-
-To install a gem you built yourself:
-
-```bash
-gem install pkg/kitchen-oci-<VERSION>.gem
-```
-
-## Example .kitchen.yml
-
-Adjust below template as required.  The following configuration is mandatory for all instance types:
-
-   - `compartment_id` or `compartment_name`
-   - `availability_domain`
-   - `shape`
-   - `subnet_id`
-
-There is an additional configuration item that allows for toggling instance types.  If this item is not included, it defaults to `compute`.
-
-   - Permitted values of `instance_type`:
-      - compute
-      - dbaas
-
-Note: The availability domain should be the full AD name including the tenancy specific prefix.  For example: "AaBb:US-ASHBURN-AD-1".  Look in the OCI console to get your tenancy specific string.
-
-### Compute Instance Type
-
-The following configuration is mandatory:
-
-   - `image_id`
-
-These settings are optional:
-
-   - `boot_volume_size_in_gbs`, The size of the boot volume, in GB
-   - `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"
-   - `oci_config`, Hash of additional `OCI::Config` settings. Allows you to test without an oci config file (see below)
-   - `ssh_keypath`, SSH public key, default is ~/.ssh/id\_rsa.pub
-   - `post_create_script`, run a script on compute\_instance after deployment
-   - `proxy_url`, Connect via the specified proxy URL
-   - `user_data`, Add user data scripts
-   - `hostname_prefix`, Prefix for the generated hostnames (note that OCI doesn't like underscores)
-   - `freeform_tags`, Hash containing tag name(s) and values(s)
-   - `use_instance_principals`, Boolean flag indicated whether Instance Principals should be used as credentials (see below)
-   - `use_token_auth`, Boolean flag indicating if token authentication should be used (see below)
-   - `preemptible_instance`, Boolean flag to indicate if the compute instance should be preemptible, default is `false`.
-   - `shape_config`, Hash of shape config parameters required when using Flex shapes.
-     - `ocpus`, number of CPUs requested
-     - `memory_in_gbs`, the amount of memory requested
-     - `baseline_ocpu_utilization`, the minimum CPU utilization, default `BASELINE_1_1`
-
-Optional settings for WinRM support in Windows:
-
-   - `setup_winrm`, Inject Windows powershell to set password and enable WinRM, default false.
-   - `winrm_username`, Used to set the WinRM transport username, defaults to 'opc'.
-   - `winrm_password`, Set the winrm password.  By default a randomly generated password will be used, so don't set this unless you have to.  Beware that the password must meet the Windows password complexity requirements otherwise the bootstrapping procedure will fail silently and Kitchen will eventually time out.
-
-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.
-
-```yml
----
-  driver:
-    name: oci
-    # These are mandatory
-    compartment_name: "dev-00"
-    availability_domain: "XyAb:US-ASHBURN-AD-1"
-    image_id: "ocid1.image.oc1.phx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-    shape: "VM.Standard1.2"
-    subnet_id: "ocid1.subnet.oc1.phx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-
-    # These are optional
-    use_private_ip: false
-    oci_config_file: "~/.oci/config"
-    oci_profile_name: "DEFAULT"
-    ssh_keypath: "~/.ssh/id_rsa.pub"
-    post_create_script: >-
-```
-
-### DBaaS Instance Type
-
-The DBaaS instance type configuration should be written in a hash beginning with `dbaas`.
-
-The following configuration item is mandatory for the DBaaS `instance_type`:
-
-   - `db_version`, The specific version of the Oracle database software to be installed. Values can be at either the major version level (eg. 12.1.0.2) or at a PSU level (eg. 12.1.0.2.191015). If no PSU is provided, the latest available will be installed.
-
-The following is a list of optional items for the DBaaS `instance_type`:
-
-   - `cpu_core_count`, CPU core count for DBaaS nodes.  Default value is 2
-   - `database_edition`, The edition of the Oracle database software to be installed.  Default value is ENTERPRISE_EDITION
-   - `license_model`, The licensing model for the Oracle database software.  Default value is BRING_YOUR_OWN_LICENSE
-   - `db_name`, The name of the database to be provisioned.  Must be 8 characters or less, alphanumeric.  Default value is `dbaas1`.
-   - `pdb_name`, The name of the pdb to be provisioned.  Only valid if `db_version` is 12cR1 or higher.  Default value is nil (OCI will create a single pdb with the name `db_name`\_PDB1)
-   - `admin_password`, The SYS password of the database to be provisioned.  Password must be 9 to 30 characters and contain at least 2 uppercase, 2 lowercase, 2 special, and 2 numeric characters. The special characters must be `_`, `#`, or `-`.  Default value will be a randomly generated password
-   - `initial_data_storage_size_in_gb`, The desired amount of database storage in GB.  Default value is 256
-   - `character_set`, The characterset of the database.  Default value is AL32UTF8
-   - `ncharacter_set`, The national characterset of the database.  Default value is AL16UTF16
-   - `db_workload`, The desired workload configuration for the database.  Acceptable values are 'OLTP' and 'DSS'.  Default value is 'OLTP'
-
-Note: At this time, `node_count` is forced to be 1.  RAC provisioning is not supported.
-
-```yml
----
-  driver:
-    name: oci
-    instance_type: dbaas
-    ...
-    dbaas:
-      db_version: "12.1.0.2.191015"
-```
-
-## Instance Principals
-
-If you are launching Kitchen from a compute instance running in OCI then you might prefer to use Instance Principals to authenticate to the OCI APIs.  To set this up you can omit the `oci_config_file` and `oci_profile_name` settings and insert `use_instance_principals: true` into your .kitchen.yml instead.
-
-```yml
-platforms:
-  - name: ubuntu-18.04
-    driver:
-      ...
-      use_instance_principals: true
-      ...
-```
-
-__Important__: If you want to configure a proxy when using Instance Principals, ensure you define the `no_proxy` environment variable so that all link-local access bypasses the proxy.  For example:
-
-```sh
-export no_proxy=169.254.0.0/16
-```
-
-This will allow the OCI lib to retrieve the certificate, key and ca-chain from the metadata service.
-
-## Token Auth
-
-If you are launching Kitchen from system configured for token authentication (by running `oci session authenticate`), you need to set `use_token_auth: true`. This is in addition to the `oci_config_file` and `oci_profile_name` settings.
-
-```yml
-platforms:
-  - name: ubuntu-18.04
-    driver:
-      ...
-      oci_config_file: "~/.oci/config"
-      oci_profile_name: "DEFAULT"
-      use_token_auth: true
-      ...
-```
-
-## Use without OCI config file
-
-If you want to run without running `oci setup config` (such as on a build server) you can specify configuration settings that would be in the `~/.oci/config` file directly in the `kitchen.yml`
-
-For example, to use the [OCI CLI Environment Variables](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm) without a config you could have use kitchen's ERB to read environment variables.
-
-```yml
-platforms:
-  - name: ubuntu-18.04
-    driver:
-      ...
-      oci_config:
-        region: <%= ENV['OCI_CLI_REGION'] %>
-        user: <%= ENV['OCI_CLI_USER'] %>
-        fingerprint: <%= ENV['OCI_CLI_FINGERPRINT'] %>
-        authentication_type: <%= ENV['OCI_CLI_AUTH'] %>
-        key_file: <%= ENV['OCI_CLI_KEY_FILE'] %>
-        tenancy: <%= ENV['OCI_CLI_TENANCY'] %>
-      ...
-```
-
-
-## Support for user data scripts and cloud-init
-
-The driver has support for adding user data that can be executed as scripts by cloud-init.  These can either be specified inline or by referencing a file.  Examples:
-
-```yml
-  user_data:
-    - type: x-shellscript
-      inline: |
-        #!/bin/bash
-        touch /tmp/foo.txt
-      filename: init.sh
-    - type: x-shellscript
-      path: myscript.sh
-      filename: myscript.sh
-```
-
-The `filename` parameter must be specified for each entry, and determines the destination filename for the script.  If the user data is to be read from a file then the `path` parameter should be specified to indicate where the file is to be read from.
-
-The scripts will be encoded into a gzipped, base64 encoded multipart mime message and added as user data when launching the instance.
-
-Alternately, if you simply pass a string to the user_data, it will be base64 encoded and add as user data when launching the instance.
-
-```yml
-  user_data: |
-    login: user1
-    uid: 1000
-    gid: 1000
-```
-
-## 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:
-```bash
-# 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.
-```yml
-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:
-
-```yml
-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>
-```
-
-See also the section above on Instance Principals if you plan to use a proxy in conjunction with a proxy.  The proxy needs to be avoided when accessing the metadata address.
-
-## Preemptible Instances
-
-This will allow you to create a [preemptible instance](https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/preemptible.htm).  Preemptible instances behave the same as regular compute instances, but the capacity is reclaimed when it's needed elsewhere, and the instances are terminated. If your workloads are fault-tolerant and can withstand interruptions, then preemptible instances can reduce your costs.
-
-```yml
----
-driver:
-  name: oci
-  ...
-  preemptible_instance: true
-  ...
-```
-
-## Flex Shape Instances
-
-This will allow you to launch a flexible shape instance.  A flexible shape lets you customize the number of CPUs and memory available when launching or resizing the VM.  Note that there are smaller number of shapes available and the image ocid must also be compatible.  Please consult [OCI documentation](https://docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm#flexible) to ensure the proper combination of shape and image ocid.
-
-```yml
----
-driver:
-  name: oci
-  ...
-  shape_config:
-    ocpus: 2
-    memory_in_gbs: 8
-    baseline_ocpu_utilization: BASELINE_1_1
-  ...
-```
-
-## Windows Support
-
-When launching Oracle provided Windows images, it may be helpful to allow kitchen-oci to inject powershell to configure WinRM and to set a randomized password that does not need to be changed on first login.  If the `setup_winrm` parameter is set to true then the following steps will happen:
-
-  - A random password will be generated and stored into the Kitchen state
-  - A powershell script will be generated which sets the password for whatever username is defined in the transport section.
-  - The script, along with any other user data, will be added to the user data and passed to the new instance.
-  - The random password will be injected into the WinRM transport.
-
-Make sure that the transport name is set to `winrm` and that the os\_type in the driver is set to `windows`.  See the following example.
-
-Full example (.kitchen.yml):
-
-```yml
----
-driver:
-  name: oci
-
-provisioner:
-  name: chef_zero
-  always_update_cookbooks: true
-
-verifier:
-  name: inspec
-
-platforms:
-  - name: windows
-    os_type: windows
-    driver:
-      # These are mandatory
-      compartment_id: ocid1.compartment.oc1..aaaaaaaa...
-      availability_domain: UhTe:PHX-AD-1
-      image_id: ocid1.image.oc1.phx.aaaaaaaa...
-      shape: VM.Standard2.2
-      subnet_id: ocid1.subnet.oc1.phx.aaaaaaaa...
-
-      # These are optional
-      use_private_ip: false
-      oci_config_file: ~/.oci/config
-      oci_profile_name: DEFAULT
-      ssh_keypath: "/home/<user>/.ssh/id_rsa.pub"
-
-      # This optional, but for Windows only
-      setup_winrm: true
-      winrm_username: opc
-    transport:
-      name: winrm
-
-suites:
-  - name: default
-    run_list:
-      - recipe[my_cookbook::default]
-    verifier:
-      inspec_tests:
-        - test/smoke/default
-    attributes:
-```
-
-## Maintainer
-
-Created and maintained by Stephen Pearson (<stephen.pearson@oracle.com>)
-
-## License
-
-Apache 2.0

data/Rakefile

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-#   Copyright 2020 Stephen Pearson <stephen.pearson@oracle.com>
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-
-require 'bundler/gem_tasks'
-require 'cane/rake_task'
-require 'tailor/rake_task'
-
-desc 'Run cane to check quality metrics'
-Cane::RakeTask.new do |cane|
-  cane.canefile = './.cane'
-end
-
-Tailor::RakeTask.new
-
-desc 'Display LOC stats'
-task :stats do
-  puts '\n## Production Code Stats'
-  sh 'countloc -r lib'
-end
-
-desc 'Run all quality tasks'
-task quality: %i[cane tailor stats]
-
-task default: %i[quality]

data/kitchen-oci.gemspec

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-#   Copyright 2020 Stephen Pearson <stephen.pearson@oracle.com>
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kitchen/driver/oci_version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'kitchen-oci'
-  spec.version       = Kitchen::Driver::OCI_VERSION
-  spec.authors       = ['Stephen Pearson']
-  spec.email         = ['stephen.pearson@oracle.com']
-  spec.description   = 'A Test Kitchen Driver for Oracle OCI'
-  spec.summary       = spec.description
-  spec.homepage      = ''
-  spec.license       = 'Apache-2.0'
-
-  # rubocop:disable SpecialGlobalVars
-  spec.files         = `git ls-files`.split($/)
-  # rubocop:enable SpecialGlobalVars
-  spec.executables   = []
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'oci', '~> 2.18.0'
-  spec.add_dependency 'test-kitchen'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'cane'
-  spec.add_development_dependency 'countloc'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'tailor'
-end