kitchen-oci 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28a500ab2c3ac91b3fc827a78bfcb8c50cf1f1a2
+  data.tar.gz: 97a476e7eeb9d8fb1c9fcc43ddbe9471b88915f3
+SHA512:
+  metadata.gz: 6cbb83bc027ff4d4f66f5a48184749b7bdd08342a2a42adc3ca6e87f084501f7c1101011aa76310630eaee53c4fb7c0d2a2021bb8ec669dcac8e0483c2334278
+  data.tar.gz: dfc1c9221d4d5f93af40d28805472c420cdadd81cfd6c6fb8412ec06edb067f6e34f65f1309c6f099bb7cfe72bd0451bc293e93ea2f90de9f28108138fefff90

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 / Unreleased
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Stephen Pearson (<stevieweavie@gmail.com>)
+
+Copyright (C) 2017, 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.

data/README.md

@@ -0,0 +1,89 @@
+# Kitchen::OCI
+
+A Test Kitchen Driver for Oracle Bare Metal Cloud
+
+WARNING: This is alpha quality.  Use at your own risk!
+
+## 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 but this
+can be created using the CLI:
+```
+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
+
+Ensure you have the ChefDK installed.
+
+```
+eval "$(chef shell-init bash)"
+rake build
+gem install pkg/kitchen-oci-<VERSION>.gem
+```
+
+## Example .kitchen.yml
+
+Adjust below template as required.  The following configuration is mandatory:
+
+   - compartment\_id
+   - availability\_domain
+   - image\_id
+   - shape
+   - subnet\_id
+
+These settings are optional:
+
+   - oci\_config\_file, by default this is ~/.oci/config
+   - oci\_profile\_name, default value is "DEFAULT"
+   - ssh\_keypath, default is ~/.ssh/id\_rsa.pub
+   - post\_create\_script, does not run a script by default
+
+```
+---
+driver:
+  name: oci
+
+provisioner:
+  name: chef_zero
+  always_update_cookbooks: true
+
+verifier:
+  name: inspec
+
+platforms:
+  - name: ubuntu-16.04
+    driver:
+      availability_domain: "ad1"
+      compartment_id: "ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      image_id: "ocid1.image.oc1.phx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      shape: "VM.Standard1.2"
+      subnet_id: "ocid1.subnet.oc1.phx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      post_create_script: >-
+        touch /tmp/example.txt;
+    transport:
+      username: "opc"
+
+suites:
+  - name: default
+    run_list:
+      - recipe[my_cookbook::default]
+    verifier:
+      inspec_tests:
+        - test/smoke/default
+    attributes:
+```
+
+Created and maintained by [Stephen Pearson][author] (<stevieweavie@gmail.com>)
+
+## License
+
+Apache 2.0

data/Rakefile

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$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         = ['stevieweavie@gmail.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.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'
+end

data/lib/kitchen/driver/oci.rb

@@ -0,0 +1,146 @@
+#
+# Author:: Stephen Pearson (<stevieweavie@gmail.com>)
+#
+# Copyright (C) 2017, 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 'kitchen'
+require 'oci'
+
+module Kitchen
+  module Driver
+    # Oracle OCI driver for Kitchen.
+    #
+    # @author Stephen Pearson <stevieweavie@gmail.com>
+    class Oci < Kitchen::Driver::Base
+      required_config :compartment_id
+      required_config :availability_domain
+      required_config :image_id
+      required_config :shape
+      required_config :subnet_id
+
+      default_config :oci_config_file, nil
+      default_config :oci_profile_name, nil
+      default_keypath = File.expand_path(File.join(%w[~ .ssh id_rsa.pub]))
+      default_config :ssh_keypath, default_keypath
+      default_config :post_create_script, nil
+
+      def create(state) # rubocop:disable Metrics/AbcSize
+        return if state[:server_id]
+
+        instance_id = launch_instance(config)
+        state[:server_id] = instance_id
+        state[:hostname] = public_ip(config, instance_id)
+
+        instance.transport.connection(state).wait_until_ready
+
+        return unless config[:post_create_script]
+
+        info('Running post create script')
+        script = config[:post_create_script]
+        instance.transport.connection(state).execute(script)
+      end
+
+      def destroy(state)
+        return unless state[:server_id]
+
+        instance.transport.connection(state).close
+        comp_api(config).terminate_instance(state[:server_id])
+
+        state.delete(:server_id)
+        state.delete(:hostname)
+      end
+
+      private
+
+      def oci_config(config)
+        params = [:load_config]
+        opts = {}
+        if config[:oci_config_file]
+          opts[:config_file_location] = config[:oci_config_file]
+        end
+        if config[:oci_profile_name]
+          opts[:profile_name] = config[:oci_profile_name]
+        end
+        params << opts
+        OCI::ConfigFileLoader.send(*params)
+      end
+
+      def comp_api(config)
+        OCI::Core::ComputeClient.new(config: oci_config(config))
+      end
+
+      def net_api(config)
+        OCI::Core::VirtualNetworkClient.new(config: oci_config(config))
+      end
+
+      def launch_instance(config)
+        request = compute_instance_request(config)
+
+        response = comp_api(config).launch_instance(request)
+        instance_id = response.data.id
+        comp_api(config).get_instance(instance_id).wait_until(
+          :lifecycle_state,
+          OCI::Core::Models::Instance::LIFECYCLE_STATE_RUNNING
+        )
+        instance_id
+      end
+
+      def public_ip(config, instance_id)
+        vnics = comp_api(config).list_vnic_attachments(
+          config[:compartment_id],
+          instance_id: instance_id
+        )
+        vnic_id = vnics.data.first.vnic_id
+        net_api(config).get_vnic(vnic_id).data.public_ip
+      end
+
+      def pubkey(config)
+        File.readlines(config[:ssh_keypath]).first.chomp
+      end
+
+      def instance_source_details(config)
+        OCI::Core::Models::InstanceSourceViaImageDetails.new(
+          source_type: 'image',
+          imageId: config[:image_id]
+        )
+      end
+
+      def create_vnic_details(config)
+        OCI::Core::Models::CreateVnicDetails.new(
+          assign_public_ip: true,
+          display_name: 'primary_nic',
+          subnetId: config[:subnet_id]
+        )
+      end
+
+      def compute_instance_request(config)
+        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.shape = config[:shape]
+        request.create_vnic_details = create_vnic_details(config)
+        request.metadata = { 'ssh_authorized_keys' => pubkey(config) }
+        request
+      end
+
+      def random_hostname(prefix)
+        randstr = Array.new(6) { ('a'..'z').to_a.sample }.join
+        "#{prefix}-#{randstr}"
+      end
+    end
+  end
+end

data/lib/kitchen/driver/oci_version.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Stephen Pearson (<stevieweavie@gmail.com>)
+#
+# Copyright (C) 2017, 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
+    # Version string for Oracle OCI Kitchen driver
+    OCI_VERSION = '1.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-oci
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stephen Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: countloc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Test Kitchen Driver for Oracle OCI
+email:
+- stevieweavie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-oci.gemspec
+- lib/kitchen/driver/oci.rb
+- lib/kitchen/driver/oci_version.rb
+homepage: ''
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen Driver for Oracle OCI
+test_files: []