kitchen-oci 1.16.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf877ab3445b41c9cef61838cee55823f6377fec01a5941b5143707138a65983
-  data.tar.gz: 3ed5f384f3c6708b0c72fc4af7a574a7197074c1dbd703ff62116bf229fa0886
+  metadata.gz: 04441716ec20ae5cf111a087f07990af96826770804f92a67edaa7335622391a
+  data.tar.gz: 378640fe182082b49904fcef4671c7954bb794a51090c7e29a74ad25128addd0
 SHA512:
-  metadata.gz: 7a2564cb3b997cf6ea1173af0743359e6c6009728e02c260ba3f168479f09c60454bcf1047d4b7d118f7390e1606647ab4b87964c8cda4b285953d8bb1a2acd2
-  data.tar.gz: 11a6cc7ba6370468dca3615c7224a9878d0b69cc60882107e5896fd5ca29725693040673f544573d8bdd06ba6b8ed4ac996eb62ed5b81ccd35e2f47bbb965042
+  metadata.gz: 8cddfba0d04e8a8634656694b1158e9ea6e87eed48bb78b1f949d32aa2b2d0e58de38326c802da9ece1de1d5da209eab75c6b7d6e1e6f2c0e7224fa1dc81033a
+  data.tar.gz: 7ed171e81ff8ab9d2559df7b9a4bab80d5d7fee5440ac0816971def8b48e6d4e65eed1b098b2f95cd1d5658e702c8523e053d05998a2929cb41636b846f4d674

data/lib/kitchen/driver/oci/api.rb

@@ -22,12 +22,25 @@ module Kitchen
     class Oci
       # Api class that defines the various API classes used to interact with OCI
       class Api
-        attr_reader :oci_config, :config
         def initialize(oci_config, config)
           @oci_config = oci_config
           @config = config
         end
 
+        #
+        # The config used to authenticate to OCI
+        #
+        # @return [OCI::Config]
+        #
+        attr_reader :oci_config
+
+        #
+        # The config provided by the driver
+        #
+        # @return [Kitchen::LazyHash]
+        #
+        attr_reader :config
+
         def compute
           generic_api(OCI::Core::ComputeClient)
         end

data/lib/kitchen/driver/oci/blockstorage.rb

@@ -26,8 +26,6 @@ module Kitchen
         require_relative "models/iscsi"
         require_relative "models/paravirtual"
 
-        attr_accessor :config, :state, :oci, :api, :volume_state, :volume_attachment_state
-
         def initialize(config, state, oci, api, action = :create)
           super()
           @config = config
@@ -39,6 +37,46 @@ module Kitchen
           oci.compartment if action == :create
         end
 
+        #
+        # The config provided by the driver
+        #
+        # @return [Kitchen::LazyHash]
+        #
+        attr_accessor :config
+
+        #
+        # The definition of the state of the instance from the statefile
+        #
+        # @return [Hash]
+        #
+        attr_accessor :state
+
+        #
+        # The config object that contains properties of the authentication to OCI
+        #
+        # @return [Kitchen::Driver::Oci::Config]
+        #
+        attr_accessor :oci
+
+        #
+        # The API object that contains each of the authenticated clients for interfacing with OCI
+        #
+        # @return [Kitchen::Driver::Oci::Api]
+        #
+        attr_accessor :api
+
+        # The definition of the state of a volume
+        #
+        # @return [Hash]
+        #
+        attr_accessor :volume_state
+
+        # The definition of the state of a volume attachment
+        #
+        # @return [Hash]
+        #
+        attr_accessor :volume_attachment_state
+
         def create_volume(volume)
           info("Creating <#{volume[:name]}>...")
           result = api.blockstorage.create_volume(volume_details(volume))
@@ -71,16 +109,6 @@ module Kitchen
           info("Finished detaching <#{attachment_name(volume_attachment)}>.")
         end
 
-        def detatch_and_delete
-          state[:volume_attachments].each do |att|
-            detatch_volume(att)
-          end
-
-          state[:volumes].each do |vol|
-            delete_volume(vol)
-          end
-        end
-
         def final_state(response)
           case response
           when OCI::Core::Models::Volume

data/lib/kitchen/driver/oci/config.rb

@@ -24,15 +24,20 @@ module Kitchen
     class Oci
       # Config class that defines the oci config that will be used for the API calls
       class Config
-        attr_reader :config
-
         def initialize(driver_config)
           setup_driver_config(driver_config)
           @config = oci_config
         end
 
+        #
+        # The config used to authenticate to OCI
+        #
+        # @return [OCI::Config]
+        #
+        attr_reader :config
+
         def oci_config
-          # OCI::Config is missing this and we're definitely using compartment and security_token_file if specified in the config
+          # OCI::Config is missing this
           OCI::Config.class_eval { attr_accessor :security_token_file } if @driver_config[:use_token_auth]
           conf = config_loader(config_file_location: @driver_config[:oci_config_file], profile_name: @driver_config[:oci_profile_name])
           @driver_config[:oci_config].each do |key, value|

data/lib/kitchen/driver/oci/instance/common.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Author:: Justin Steele (<justin.steele@oracle.com>)
+#
+# Copyright (C) 2024, Stephen Pearson
+#
+# 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.
+
+module Kitchen
+  module Driver
+    class Oci
+      class Instance
+        # setter methods that populate launch details common to all instance models
+        module CommonLaunchDetails
+          def compartment_id
+            launch_details.compartment_id = oci.compartment
+          end
+
+          def availability_domain
+            launch_details.availability_domain = config[:availability_domain]
+          end
+
+          def defined_tags
+            launch_details.defined_tags = config[:defined_tags]
+          end
+
+          def shape
+            launch_details.shape = config[:shape]
+          end
+
+          def freeform_tags
+            launch_details.freeform_tags = process_freeform_tags
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/kitchen/driver/oci/instance/compute.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Author:: Justin Steele (<justin.steele@oracle.com>)
+#
+# Copyright (C) 2024, Stephen Pearson
+#
+# 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.
+
+module Kitchen
+  module Driver
+    class Oci
+      class Instance
+        # setter methods that populate the details of OCI::Core::Models::LaunchInstanceDetails
+        module ComputeLaunchDetails
+          def hostname_display_name
+            display_name = hostname
+            launch_details.display_name = display_name
+            launch_details.create_vnic_details = create_vnic_details(display_name)
+          end
+
+          def preemptible_instance_config
+            return unless config[:preemptible_instance]
+
+            launch_details.preemptible_instance_config = OCI::Core::Models::PreemptibleInstanceConfigDetails.new(
+              preemption_action:
+                OCI::Core::Models::TerminatePreemptionAction.new(
+                  type: "TERMINATE", preserve_boot_volume: true
+                )
+            )
+          end
+
+          def shape_config
+            return if config[:shape_config].empty?
+
+            launch_details.shape_config = OCI::Core::Models::LaunchInstanceShapeConfigDetails.new(
+              ocpus: config[:shape_config][:ocpus],
+              memory_in_gbs: config[:shape_config][:memory_in_gbs],
+              baseline_ocpu_utilization: config[:shape_config][:baseline_ocpu_utilization] || "BASELINE_1_1"
+            )
+          end
+
+          def agent_config
+            launch_details.agent_config = OCI::Core::Models::LaunchInstanceAgentConfigDetails.new(
+              are_all_plugins_disabled: config[:all_plugins_disabled],
+              is_management_disabled: config[:management_disabled],
+              is_monitoring_disabled: config[:monitoring_disabled]
+            )
+          end
+
+          def instance_source_details
+            launch_details.source_details = OCI::Core::Models::InstanceSourceViaImageDetails.new(
+              sourceType: "image",
+              imageId: image_id,
+              bootVolumeSizeInGBs: config[:boot_volume_size_in_gbs]
+            )
+          end
+
+          def instance_metadata
+            launch_details.metadata = metadata
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/oci/instance/database.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Author:: Justin Steele (<justin.steele@oracle.com>)
+#
+# Copyright (C) 2024, Stephen Pearson
+#
+# 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.
+
+module Kitchen
+  module Driver
+    class Oci
+      class Instance
+        # setter methods that populate the details of OCI::Database::Models::CreateDatabaseDetails
+        module DatabaseDetails
+          def character_set
+            database_details.character_set = config[:dbaas][:character_set] ||= "AL32UTF8"
+          end
+
+          def ncharacter_set
+            database_details.ncharacter_set = config[:dbaas][:ncharacter_set] ||= "AL16UTF16"
+          end
+
+          def db_workload
+            workload = config[:dbaas][:db_workload] ||= OCI::Database::Models::CreateDatabaseDetails::DB_WORKLOAD_OLTP
+            database_details.db_workload = workload
+          end
+
+          def admin_password
+            database_details.admin_password = config[:dbaas][:admin_password] ||= random_password(%w{# _ -})
+          end
+
+          def db_name
+            database_details.db_name = config[:dbaas][:db_name] ||= "dbaas1"
+          end
+
+          def pdb_name
+            database_details.pdb_name = config[:dbaas][:pdb_name]
+          end
+
+          def db_backup_config
+            database_details.db_backup_config = OCI::Database::Models::DbBackupConfig.new.tap do |l|
+              l.auto_backup_enabled = false
+            end
+            database_details
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/oci/instance/db_home.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Author:: Justin Steele (<justin.steele@oracle.com>)
+#
+# Copyright (C) 2024, Stephen Pearson
+#
+# 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.
+
+module Kitchen
+  module Driver
+    class Oci
+      class Instance
+        # setter methods that populate the details of OCI::Database::Models::CreateDbHomeDetails
+        module DbHomeDetails
+          def database
+            db_home_details.database = database_details
+          end
+
+          def db_version
+            raise "db_version cannot be nil!" if config[:dbaas][:db_version].nil?
+
+            db_home_details.db_version = config[:dbaas][:db_version]
+          end
+
+          def db_home_display_name
+            db_home_details.display_name = ["dbhome", random_number(10)].compact.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/oci/instance/dbaas.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Author:: Justin Steele (<justin.steele@oracle.com>)
+#
+# Copyright (C) 2024, Stephen Pearson
+#
+# 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_relative "../instance/database"
+require_relative "../instance/db_home"
+
+module Kitchen
+  module Driver
+    class Oci
+      class Instance
+        # setter methods that populate the details of OCI::Database::Models::LaunchDbSystemDetails
+        module DbaasLaunchDetails
+          include DatabaseDetails
+          include DbHomeDetails
+          #
+          # TODO: add support for the #domain property
+          #       add support for #database_software_image_id property
+          #
+          def db_home
+            launch_details.db_home = db_home_details
+          end
+
+          def subnet_id
+            launch_details.subnet_id = config[:subnet_id]
+          end
+
+          def nsg_ids
+            launch_details.nsg_ids = config[:nsg_ids]
+          end
+
+          def hostname
+            # The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-).
+            # The maximum length of the hostname is 16 characters
+            long_name = [hostname_prefix, long_hostname_suffix].compact.join("-")
+            trimmed_name = [hostname_prefix[0, 12], random_string(3)].compact.join("-")
+            launch_details.hostname = [long_name, trimmed_name].min { |l, t| l.size <=> t.size }
+          end
+
+          def display_name
+            # The user-friendly name for the DB system. The name does not have to be unique.
+            launch_details.display_name = [config[:hostname_prefix], random_string(4), random_number(2)].compact.join("-")
+          end
+
+          def node_count
+            launch_details.node_count = 1
+          end
+
+          def pubkey
+            result = []
+            result << File.readlines(config[:ssh_keypath]).first.chomp
+            launch_details.ssh_public_keys = result
+          end
+
+          def cpu_core_count
+            launch_details.cpu_core_count = config[:dbaas][:cpu_core_count] ||= 2
+          end
+
+          def license_model
+            license = config[:dbaas][:license_model] ||= OCI::Database::Models::DbSystem::LICENSE_MODEL_BRING_YOUR_OWN_LICENSE
+            launch_details.license_model = license
+          end
+
+          def initial_data_storage_size_in_gb
+            launch_details.initial_data_storage_size_in_gb = config[:dbaas][:initial_data_storage_size_in_gb] ||= 256
+          end
+
+          def database_edition
+            db_edition = config[:dbaas][:database_edition] ||= OCI::Database::Models::DbSystem::DATABASE_EDITION_ENTERPRISE_EDITION
+            launch_details.database_edition = db_edition
+          end
+
+          def cluster_name
+            prefix = config[:hostname_prefix].split("-")[0]
+            # 11 character limit for cluster_name in DBaaS
+            cn = if prefix.length >= 11
+                   prefix[0, 11]
+                 else
+                   [prefix, random_string(10 - prefix.length)].compact.join("-")
+                 end
+            launch_details.cluster_name = cn
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/kitchen/driver/oci/instance.rb

@@ -21,13 +21,14 @@ module Kitchen
   module Driver
     class Oci
       # generic class for instance models
-      class Instance < Oci
+      class Instance < Oci # rubocop:disable Metrics/ClassLength
         require_relative "api"
         require_relative "config"
         require_relative "models/compute"
         require_relative "models/dbaas"
+        require_relative "instance/common"
 
-        attr_accessor :config, :state, :oci, :api
+        include CommonLaunchDetails
 
         def initialize(config, state, oci, api, action)
           super()
@@ -37,25 +38,33 @@ module Kitchen
           @api = api
         end
 
-        def compartment_id
-          launch_details.compartment_id = oci.compartment
-        end
-
-        def availability_domain
-          launch_details.availability_domain = config[:availability_domain]
-        end
-
-        def defined_tags
-          launch_details.defined_tags = config[:defined_tags]
-        end
-
-        def shape
-          launch_details.shape = config[:shape]
-        end
-
-        def freeform_tags
-          launch_details.freeform_tags = process_freeform_tags
-        end
+        #
+        # The config provided by the driver
+        #
+        # @return [Kitchen::LazyHash]
+        #
+        attr_accessor :config
+
+        #
+        # The definition of the state of the instance from the statefile
+        #
+        # @return [Hash]
+        #
+        attr_accessor :state
+
+        #
+        # The config object that contains properties of the authentication to OCI
+        #
+        # @return [Kitchen::Driver::Oci::Config]
+        #
+        attr_accessor :oci
+
+        #
+        # The API object that contains each of the authenticated clients for interfacing with OCI
+        #
+        # @return [Kitchen::Driver::Oci::Api]
+        #
+        attr_accessor :api
 
         def final_state(state, instance_id)
           state.store(:server_id, instance_id)
@@ -65,6 +74,15 @@ module Kitchen
 
         private
 
+        def launch_instance_details
+          launch_methods = []
+          self.class.ancestors.reverse.select { |m| m.is_a?(Module) && m.name.start_with?("#{self.class.superclass}::") }.each do |klass|
+            launch_methods << klass.instance_methods(false)
+          end
+          launch_methods.flatten.each { |m| send(m) }
+          launch_details
+        end
+
         def public_ip_allowed?
           subnet = api.network.get_subnet(config[:subnet_id]).data
           !subnet.prohibit_public_ip_on_vnic

data/lib/kitchen/driver/oci/models/compute.rb

@@ -16,19 +16,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative "../instance/compute"
+
 module Kitchen
   module Driver
     class Oci
       module Models
         # Compute instance model
         class Compute < Instance # rubocop:disable Metrics/ClassLength
-          attr_accessor :launch_details
+          include ComputeLaunchDetails
 
-          def initialize(config, state, oci, api, action = :create)
+          def initialize(config, state, oci, api, action)
             super
             @launch_details = OCI::Core::Models::LaunchInstanceDetails.new
           end
 
+          #
+          # The details model that describes a compute instance
+          #
+          # @return [OCI::Core::Models::LaunchInstanceDetails]
+          #
+          attr_accessor :launch_details
+
           def launch
             process_windows_options
             response = api.compute.launch_instance(launch_instance_details)
@@ -44,57 +53,63 @@ module Kitchen
 
           private
 
-          def launch_instance_details # rubocop:disable Metrics/MethodLength
-            compartment_id
-            availability_domain
-            defined_tags
-            shape
-            freeform_tags
-            hostname_display_name
-            instance_source_details
-            instance_metadata
-            preemptible_instance_config
-            shape_config
-            launch_details
+          def image_id
+            return config[:image_id] if config[:image_id]
+
+            raise "must specify either image_id or image_name" unless config[:image_name]
+
+            image_id_by_name
           end
 
-          def hostname_display_name
-            display_name = hostname
-            launch_details.display_name = display_name
-            launch_details.create_vnic_details = create_vnic_details(display_name)
+          def image_id_by_name
+            image_name = config[:image_name].gsub(" ", "-")
+            image_list = images.select { |i| i.display_name.match?(/#{image_name}/) }
+            raise "unable to find image_id" if image_list.empty?
+
+            image_list = filter_image_list(image_list, image_name) if image_list.count > 1
+            raise "unable to find image_id" if image_list.empty?
+
+            latest_image_id(image_list)
           end
 
-          def hostname
-            [config[:hostname_prefix], random_string(6)].compact.join("-")
+          def filter_image_list(image_list, image_name)
+            image_list.select { |i| i.display_name.match?(/#{image_name}-[0-9]{4}\.[0-9]{2}\.[0-9]{2}/) }
           end
 
-          def preemptible_instance_config
-            return unless config[:preemptible_instance]
+          def latest_image_id(image_list)
+            image_list.sort_by! { |o| ((DateTime.parse(Time.now.utc.to_s) - o.time_created) * 24 * 60 * 60).to_i }.first.id
+          end
 
-            launch_details.preemptible_instance_config = OCI::Core::Models::PreemptibleInstanceConfigDetails.new(
-              preemption_action:
-                OCI::Core::Models::TerminatePreemptionAction.new(
-                  type: "TERMINATE", preserve_boot_volume: true
-                )
-            )
+          def images(image_list = [], page = nil)
+            current_images = api.compute.list_images(oci.compartment, page: page)
+            next_page = current_images.next_page
+            image_list << current_images.data
+            images(image_list, next_page) unless next_page.nil?
+            image_list.flatten
           end
 
-          def shape_config
-            return if config[:shape_config].empty?
+          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
 
-            launch_details.shape_config = OCI::Core::Models::LaunchInstanceShapeConfigDetails.new(
-              ocpus: config[:shape_config][:ocpus],
-              memory_in_gbs: config[:shape_config][:memory_in_gbs],
-              baseline_ocpu_utilization: config[:shape_config][:baseline_ocpu_utilization] || "BASELINE_1_1"
-            )
+          def vnics(instance_id)
+            vnic_attachments(instance_id).map { |att| api.network.get_vnic(att.vnic_id).data }
           end
 
-          def instance_source_details
-            launch_details.source_details = OCI::Core::Models::InstanceSourceViaImageDetails.new(
-              sourceType: "image",
-              imageId: config[:image_id],
-              bootVolumeSizeInGBs: config[:boot_volume_size_in_gbs]
-            )
+          def vnic_attachments(instance_id)
+            att = api.compute.list_vnic_attachments(oci.compartment, instance_id: instance_id).data
+            raise "Could not find any VNIC attachments" unless att.any?
+
+            att
+          end
+
+          def hostname
+            [config[:hostname_prefix], random_string(6)].compact.join("-")
           end
 
           def create_vnic_details(name)
@@ -111,10 +126,6 @@ module Kitchen
             File.readlines(config[:ssh_keypath]).first.chomp
           end
 
-          def instance_metadata
-            launch_details.metadata = metadata
-          end
-
           def metadata
             md = {}
             inject_powershell
@@ -124,26 +135,6 @@ module Kitchen
             md
           end
 
-          def vnics(instance_id)
-            vnic_attachments(instance_id).map { |att| api.network.get_vnic(att.vnic_id).data }
-          end
-
-          def vnic_attachments(instance_id)
-            att = api.compute.list_vnic_attachments(oci.compartment, instance_id: instance_id).data
-            raise "Could not find any VNIC attachments" unless att.any?
-
-            att
-          end
-
-          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 process_windows_options
             return unless windows_state?
 

data/lib/kitchen/driver/oci/models/dbaas.rb

@@ -16,21 +16,44 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative "../instance/dbaas"
+
 module Kitchen
   module Driver
     class Oci
       module Models
         # dbaas model
         class Dbaas < Instance # rubocop:disable Metrics/ClassLength
-          attr_accessor :launch_details, :database_details, :db_home_details
+          include DbaasLaunchDetails
 
-          def initialize(config, state, oci, api, action = :create)
+          def initialize(config, state, oci, api, action)
             super
             @launch_details = OCI::Database::Models::LaunchDbSystemDetails.new
             @database_details = OCI::Database::Models::CreateDatabaseDetails.new
             @db_home_details = OCI::Database::Models::CreateDbHomeDetails.new
           end
 
+          #
+          # The details model that describes the db system
+          #
+          # @return [OCI::Database::Models::LaunchDbSystemDetails]
+          #
+          attr_accessor :launch_details
+
+          #
+          # The details model that describes the database
+          #
+          # @return [OCI::Database::Models::CreateDatabaseDetails]
+          #
+          attr_accessor :database_details
+
+          #
+          # The details model that describes the database home
+          #
+          # @return [OCI::Database::Models::CreateDbHomeDetails]
+          #
+          attr_accessor :db_home_details
+
           def launch
             response = api.dbaas.launch_db_system(launch_instance_details)
             instance_id = response.data.id
@@ -48,106 +71,6 @@ module Kitchen
 
           private
 
-          def launch_instance_details # rubocop:disable Metrics/MethodLength
-            # TODO: add support for the #domain property
-            compartment_id
-            availability_domain
-            defined_tags
-            shape
-            freeform_tags
-            names
-            cpu_core_count
-            create_db_home_details
-            subnet_id
-            nsg_ids
-            pubkey
-            initial_data_storage_size_in_gb
-            node_count
-            license_model
-            launch_details
-          end
-
-          def create_db_home_details
-            db_version
-            db_home_display_name
-            database_edition
-            db_home_details.database = create_database_details
-            launch_details.db_home = db_home_details
-          end
-
-          def create_database_details
-            cluster_name
-            db_name
-            pdb_name
-            admin_password
-            character_set
-            db_workload
-            ncharacter_set
-            db_backup_config
-          end
-
-          def subnet_id
-            launch_details.subnet_id = config[:subnet_id]
-          end
-
-          def nsg_ids
-            launch_details.nsg_ids = config[:nsg_ids]
-          end
-
-          def names
-            hostname
-            display_name
-            launch_details
-          end
-
-          def hostname
-            # The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-).
-            # The maximum length of the hostname is 16 characters
-            long_name = [hostname_prefix, long_hostname_suffix].compact.join("-")
-            trimmed_name = [hostname_prefix[0, 12], random_string(3)].compact.join("-")
-            launch_details.hostname = [long_name, trimmed_name].min { |l, t| l.size <=> t.size }
-          end
-
-          def display_name
-            # The user-friendly name for the DB system. The name does not have to be unique.
-            launch_details.display_name = [config[:hostname_prefix], random_string(4), random_number(2)].compact.join("-")
-          end
-
-          def hostname_prefix
-            config[:hostname_prefix]
-          end
-
-          def node_count
-            launch_details.node_count = 1
-          end
-
-          def long_hostname_suffix
-            [random_string(25 - hostname_prefix.length), random_string(3)].compact.join("-")
-          end
-
-          def pubkey
-            result = []
-            result << File.readlines(config[:ssh_keypath]).first.chomp
-            launch_details.ssh_public_keys = result
-          end
-
-          def cpu_core_count
-            launch_details.cpu_core_count = config[:dbaas][:cpu_core_count] ||= 2
-          end
-
-          def license_model
-            license = config[:dbaas][:license_model] ||= OCI::Database::Models::DbSystem::LICENSE_MODEL_BRING_YOUR_OWN_LICENSE
-            launch_details.license_model = license
-          end
-
-          def initial_data_storage_size_in_gb
-            launch_details.initial_data_storage_size_in_gb = config[:dbaas][:initial_data_storage_size_in_gb] ||= 256
-          end
-
-          def dbaas_node(instance_id)
-            api.dbaas.list_db_nodes(oci.compartment, db_system_id: instance_id).data
-          end
-
           def instance_ip(instance_id)
             vnic = dbaas_node(instance_id).select(&:vnic_id).first.vnic_id
             if public_ip_allowed?
@@ -157,62 +80,16 @@ module Kitchen
             end
           end
 
-          def db_version
-            raise "db_version cannot be nil!" if config[:dbaas][:db_version].nil?
-
-            db_home_details.db_version = config[:dbaas][:db_version]
-          end
-
-          def db_home_display_name
-            db_home_details.display_name = ["dbhome", random_number(10)].compact.join
-          end
-
-          def character_set
-            database_details.character_set = config[:dbaas][:character_set] ||= "AL32UTF8"
-          end
-
-          def ncharacter_set
-            database_details.ncharacter_set = config[:dbaas][:ncharacter_set] ||= "AL16UTF16"
-          end
-
-          def db_workload
-            workload = config[:dbaas][:db_workload] ||= OCI::Database::Models::CreateDatabaseDetails::DB_WORKLOAD_OLTP
-            database_details.db_workload = workload
-          end
-
-          def admin_password
-            database_details.admin_password = config[:dbaas][:admin_password] ||= random_password(%w{# _ -})
-          end
-
-          def db_name
-            database_details.db_name = config[:dbaas][:db_name] ||= "dbaas1"
-          end
-
-          def pdb_name
-            database_details.pdb_name = config[:dbaas][:pdb_name] ||= "pdb001"
-          end
-
-          def db_backup_config
-            database_details.db_backup_config = OCI::Database::Models::DbBackupConfig.new.tap do |l|
-              l.auto_backup_enabled = false
-            end
-            database_details
+          def dbaas_node(instance_id)
+            api.dbaas.list_db_nodes(oci.compartment, db_system_id: instance_id).data
           end
 
-          def database_edition
-            db_edition = config[:dbaas][:database_edition] ||= OCI::Database::Models::DbSystem::DATABASE_EDITION_ENTERPRISE_EDITION
-            launch_details.database_edition = db_edition
+          def hostname_prefix
+            config[:hostname_prefix]
           end
 
-          def cluster_name
-            prefix = config[:hostname_prefix].split("-")[0]
-            # 11 character limit for cluster_name in DBaaS
-            cn = if prefix.length >= 11
-                   prefix[0, 11]
-                 else
-                   [prefix, random_string(10 - prefix.length)].compact.join("-")
-                 end
-            launch_details.cluster_name = cn
+          def long_hostname_suffix
+            [random_string(25 - hostname_prefix.length), random_string(3)].compact.join("-")
           end
         end
       end

data/lib/kitchen/driver/oci/models/iscsi.rb

@@ -23,13 +23,18 @@ module Kitchen
       module Models
         # iscsi volume attachment model
         class Iscsi < Blockstorage
-          attr_reader :attachment_type
-
           def initialize(config, state, oci, api)
             super
             @attachment_type = "iscsi"
           end
 
+          #
+          # The type of attachment being created
+          #
+          # @return [String]
+          #
+          attr_reader :attachment_type
+
           def attachment_details(volume_details, server_id)
             OCI::Core::Models::AttachIScsiVolumeDetails.new(
               display_name: "#{attachment_type}-#{volume_details.display_name}",

data/lib/kitchen/driver/oci/models/paravirtual.rb

@@ -23,13 +23,18 @@ module Kitchen
       module Models
         # paravirtual attachment model
         class Paravirtual < Blockstorage
-          attr_reader :attachment_type
-
           def initialize(config, state, oci, api)
             super
             @attachment_type = "paravirtual"
           end
 
+          #
+          # The type of attachment being created
+          #
+          # @return [String]
+          #
+          attr_reader :attachment_type
+
           def attachment_details(volume_details, server_id)
             OCI::Core::Models::AttachParavirtualizedVolumeDetails.new(
               display_name: "#{attachment_type}-#{volume_details.display_name}",

data/lib/kitchen/driver/oci/models.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 #
-# Author:: Stephen Pearson (<stephen.pearson@oracle.com>)
+# Author:: Justin Steele (<justin.steele@oracle.com>)
 #
-# Copyright (C) 2019, Stephen Pearson
+# Copyright (C) 2024, Stephen Pearson
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/kitchen/driver/oci.rb

@@ -37,6 +37,7 @@ module Kitchen
       require_relative "oci/models"
 
       plugin_version Kitchen::Driver::OCI_VERSION
+      kitchen_driver_api_version 1
 
       # required config items
       required_config :availability_domain
@@ -50,7 +51,8 @@ module Kitchen
       default_config :compartment_id, nil
       default_config :compartment_name, nil
       default_config :instance_type, "compute"
-      default_config :image_id
+      default_config :image_id, nil
+      default_config :image_name, nil
       default_config :hostname_prefix do |hnp|
         hnp.instance.name
       end
@@ -66,6 +68,9 @@ module Kitchen
       default_config :use_token_auth, false
       default_config :shape_config, {}
       default_config :nsg_ids, []
+      default_config :all_plugins_disabled, false
+      default_config :management_disabled, false
+      default_config :monitoring_disabled, false
 
       # compute only configs
       default_config :setup_winrm, false

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.16.2"
+    OCI_VERSION = "1.18.0"
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-oci
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.18.0
 platform: ruby
 authors:
 - Stephen Pearson
+- Justin Steele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oci
@@ -111,6 +112,7 @@ dependencies:
 description: A Test Kitchen Driver for Oracle OCI
 email:
 - stephen.pearson@oracle.com
+- justin.steele@oracle.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,6 +123,11 @@ files:
 - lib/kitchen/driver/oci/blockstorage.rb
 - lib/kitchen/driver/oci/config.rb
 - lib/kitchen/driver/oci/instance.rb
+- lib/kitchen/driver/oci/instance/common.rb
+- lib/kitchen/driver/oci/instance/compute.rb
+- lib/kitchen/driver/oci/instance/database.rb
+- lib/kitchen/driver/oci/instance/db_home.rb
+- lib/kitchen/driver/oci/instance/dbaas.rb
 - lib/kitchen/driver/oci/models.rb
 - lib/kitchen/driver/oci/models/compute.rb
 - lib/kitchen/driver/oci/models/dbaas.rb