beaker-gke 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 354a9675ddc9882d82b854124c3f7d60f03f80ca
-  data.tar.gz: df0e876ba3d48d7c1e4a7d842fe3051f66f3b5da
+SHA256:
+  metadata.gz: 7088a7e3170a2710eab2fdd6fd718e24da57daec4a59233bd8c9c2213dec2c79
+  data.tar.gz: 190e006996fd60900469009ea5a6d6b68efbdd2410b2c0731e684b4be4774052
 SHA512:
-  metadata.gz: e10f5291bf417d5cdf7d5f1985dcd8b88cc3f14ad84ebcf59aedfef960f50d55b67163b7038e10ba89f250f1c0899646682c3c6aff29c6796fb396cdce29c8c7
-  data.tar.gz: 08c721c8d35df672c0795bd12b5861c72611a2db9f93edfcfb229a0ac0ec91a108aa85a70b1c323d412c0da507388631d108f10c4358c7cec92b8fc03d90cefb
+  metadata.gz: 73a0b108eb1bb49deffd6f7041a04d881366b2a5d2739202c761d1246f83d2bfa8d9530c0d173d68fa53f03036d3399e6021846225322fb87f152352789e680b
+  data.tar.gz: 2cbd244cd17946c6bf5047ec9db0db67b156b477b645cfd31b5e0907bb0a84a940f8aa93b3ec5b880d8e28662709352dc79f03f7b48cfa28dff1296fd5b7287c

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.gitignore

@@ -0,0 +1,20 @@
+# bundler
+.bundle
+Gemfile.local
+Gemfile.lock
+
+# JetBrains IDEA
+*.iml
+.idea/
+
+# rbenv file
+.ruby-version
+.ruby-gemset
+
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+---
+require:
+  - rubocop-rspec
+  - rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/beaker-gke.rb'
+
+Security/Eval:
+  Exclude:
+    - 'Gemfile'
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+bundler_args: --jobs 4 --retry 2 --without packaging documentation
+before_install:
+  - gem update --system && gem install bundler --no-document
+script:
+  - "bundle exec rake $CHECK"
+notifications:
+  email: false
+
+matrix:
+  include:
+    - rvm: 2.5
+      env: "CHECK=rubocop"
+
+    - rvm: 2.5
+      env: "CHECK=test:spec:run"

data/CODEOWNERS

@@ -1 +1,2 @@
-* @puppetlabs/night-s-watch
+*  @puppetlabs/release-engineering
+

data/Gemfile

@@ -1,3 +1,29 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+# frozen_string_literal: true
 
-gemspec
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+def location_for(place, fake_version = nil)
+  if place =~ /^git:([^#]*)#(.*)/
+    [fake_version, { git: Regexp.last_match(1), branch: Regexp.last_match(2), require: false }].compact
+  elsif place =~ %r{^file://(.*)}
+    ['>= 0', { path: File.expand_path(Regexp.last_match(1)), require: false }]
+  else
+    [place, { require: false }]
+  end
+end
+
+# We don't put beaker in as a test dependency because we
+# don't want to create a transitive dependency
+group :acceptance_testing do
+  gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 4.0')
+end
+
+eval(File.read("#{__FILE__}.local"), binding) if File.exist? "#{__FILE__}.local"

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+namespace :test do
+  namespace :spec do
+    desc 'Run spec tests'
+    RSpec::Core::RakeTask.new(:run) do |t|
+      t.rspec_opts = ['--color']
+      t.pattern = 'spec/'
+    end
+  end
+end
+
+desc 'run static analysis with rubocop'
+task(:rubocop) do
+  require 'rubocop'
+  cli = RuboCop::CLI.new
+  exit_code = cli.run(%w[--display-cop-names --format simple])
+  raise 'RuboCop detected offenses' if exit_code != 0
+end
+
+# namespace-named default tasks.
+# these are the default tasks invoked when only the namespace is referenced.
+# they're needed because `task :default` in those blocks doesn't work as expected.
+task 'test:spec' => 'test:spec:run'
+task 'test:acceptance' => 'test:acceptance:quick'
+
+# global defaults
+task test: 'test:spec'
+task default: :test

data/beaker-gke.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 require 'beaker-gke/version'
 
@@ -19,7 +19,18 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |file| File.basename(file) }
   s.require_paths = ['lib']
 
+  # Required ruby version
+  s.required_ruby_version = '~> 2.5'
+
+  # Testing dependencies
+  s.add_development_dependency 'climate_control'
+  s.add_development_dependency 'fakefs', '~> 1.2', '<= 1.2.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'simplecov'
+
   # Run time dependencies
   s.add_runtime_dependency 'googleauth', '~> 0.9'
-  s.add_runtime_dependency 'kubeclient', '~> 4.4.0'
+  s.add_runtime_dependency 'kubeclient', '>= 4.4', '< 4.10'
 end

data/lib/beaker/hypervisor/gke.rb

@@ -44,7 +44,7 @@ module Beaker
         rescue StandardError => e
           raise "Timeout: #{e.message}" unless retries <= MAX_RETRIES
 
-          @logger.info("Retrying , could not get podIP for #{hostname}")
+          @logger.info("Retrying, could not get podIP for #{hostname}")
 
           retries += 1
           sleep(2**retries)

data/lib/beaker-gke/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BeakerGke
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/gke/hypervisor/gke_spec.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'beaker/hypervisor/gke'
+
+describe Beaker::Gke do
+  let(:hosts) { make_hosts }
+
+  let(:options) { { logger: logger } }
+
+  let(:logger) do
+    logger = instance_double('logger')
+    allow(logger).to receive(:debug)
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:warn)
+    allow(logger).to receive(:error)
+    allow(logger).to receive(:notify)
+    logger
+  end
+
+  let(:config) { instance_double('config') }
+
+  let(:context) do
+    instance_double('context',
+                    api_endpoint: 'v1',
+                    ssl_options: {
+                      verify_ssl: 1,
+                      cert_store: true
+                    },
+                    auth_options: {
+                      bearer_token: 'TOKEN_STRING'
+                    })
+  end
+
+  let(:gke) { ::Beaker::Gke.new(hosts, options) }
+
+  def pass_through_initialization
+    allow(ENV).to receive(:fetch).with('KUBECONFIG').and_return('default_value')
+    allow(ENV).to receive(:fetch).with('GOOGLE_APPLICATION_CREDENTIALS').and_return('default_value')
+    allow(config).to receive(:context).and_return(context)
+    allow(Kubeclient::Config).to receive(:read).with(ENV['KUBECONFIG']).and_return(config)
+  end
+
+  before do
+    FakeFS.deactivate!
+  end
+
+  describe ' #initialize' do
+    let(:env_error_message) { 'OS environment variable KUBECONFIG and GOOGLE_APPLICATION_CREDENTIALS must be set' }
+
+    it 'raises error when KUBECONFIG and GOOGLE_APPLICATION_CREDENTIALS ENV variables are not set' do
+      expect { gke }.to raise_error(ArgumentError, env_error_message)
+    end
+
+    it 'raises error when only GOOGLE_APPLICATION_CREDENTIALS ENV variable is set' do
+      with_modified_env GOOGLE_APPLICATION_CREDENTIALS: 'default_value' do
+        expect { gke }.to raise_error(ArgumentError, env_error_message)
+      end
+    end
+
+    it 'raises error when only KUBECONFIG ENV variable is set' do
+      with_modified_env KUBECONFIG: 'default_value' do
+        expect { gke }.to raise_error(ArgumentError, env_error_message)
+      end
+    end
+
+    context 'when both KUBECONFIG and GOOGLE_APPLICATION_CREDENTIALS ENV are set' do
+      before do
+        pass_through_initialization
+      end
+
+      it 'sets the hosts data member accordingly' do
+        expect(gke.instance_variable_get(:@hosts)).to equal(hosts)
+      end
+
+      it 'sets the options data member accordingly' do
+        expect(gke.instance_variable_get(:@options)).to equal(options)
+      end
+
+      it 'sets the logger data member accordingly' do
+        expect(gke.instance_variable_get(:@logger)).to equal(logger)
+      end
+
+      it 'succeeds and does not raise any errors' do
+        expect { gke }.not_to raise_error
+      end
+    end
+  end
+
+  describe ' #provision' do
+    let(:pod) { instance_double('pod') }
+
+    let(:status) { instance_double('status', podIP: '10.236.246.250') }
+    let(:empty_ip_status) { instance_double('status', podIP: nil) }
+
+    def pass_through_pod_and_service_creation
+      allow(gke).to receive(:create_pod).and_return(nil)
+      allow(gke).to receive(:read_file).with('pod.yaml').and_return('pod.yaml content')
+
+      allow(gke).to receive(:create_srv).and_return(nil)
+      allow(gke).to receive(:read_file).with('service.yaml').and_return('service.yaml content')
+    end
+
+    before do
+      pass_through_initialization
+      pass_through_pod_and_service_creation
+      allow(gke).to receive(:sleep).and_return(true)
+    end
+
+    context 'when no hosts given' do
+      let(:no_hosts_gke) { ::Beaker::Gke.new([], options) }
+
+      it 'returns nil' do
+        expect(no_hosts_gke.provision).to eq(nil)
+      end
+
+      it 'logs no info' do
+        no_hosts_gke.provision
+        expect(logger).not_to have_received(:info)
+      end
+
+      it 'does not raise any error' do
+        expect { no_hosts_gke.provision }.not_to raise_error
+      end
+    end
+
+    it 'raises StandardError and logs podIP retrieval attempts' do # rubocop:disable RSpec/MultipleExpectations
+      allow(gke).to receive(:get_pod).and_return(pod)
+      allow(pod).to receive(:status).and_return(empty_ip_status)
+
+      expect { gke.provision }.to raise_error(StandardError)
+      expect(logger).to have_received(:info).with(/Retrying, could not get podIP for/).at_least(:once)
+    end
+
+    it 'succeeds' do
+      allow(gke).to receive(:get_pod).and_return(pod)
+      allow(pod).to receive(:status).and_return(status)
+
+      expect(gke.provision).to eq(nil)
+    end
+  end
+
+  describe ' #cleanup' do
+    before do
+      pass_through_initialization
+    end
+
+    context 'when no hosts given' do
+      let(:no_hosts_gke) { ::Beaker::Gke.new([], options) }
+
+      it 'does not raise any error' do
+        expect { no_hosts_gke.cleanup }.not_to raise_error
+      end
+
+      it 'logs no info' do
+        no_hosts_gke.cleanup
+        expect(logger).not_to have_received(:info)
+      end
+    end
+
+    context 'when succeeds' do
+      before do
+        allow(gke).to receive(:delete_pod).and_return(nil)
+        allow(gke).to receive(:delete_service).and_return(nil)
+      end
+
+      it 'does not raise any error' do
+        expect { gke.cleanup }.not_to raise_error
+      end
+
+      it 'logs deleted pods' do
+        gke.cleanup
+        expect(logger).to have_received(:info).with(/Deleting POD with ID:/).exactly(hosts.size).times
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'beaker'
+require 'simplecov'
+require 'climate_control'
+require 'fakefs/spec_helpers'
+
+Dir.glob(Dir.pwd + '/lib/beaker/hypervisor/*.rb').sort { |file| require file }
+
+# setup & require beaker's spec_helper.rb
+beaker_gem_spec = Gem::Specification.find_by_name('beaker')
+beaker_gem_dir = beaker_gem_spec.gem_dir
+beaker_spec_path = File.join(beaker_gem_dir, 'spec')
+$LOAD_PATH << beaker_spec_path
+require File.join(beaker_spec_path, 'spec_helper.rb')
+
+RSpec.configure do |config|
+  config.include TestFileHelpers
+  config.include HostHelpers
+end
+
+def with_modified_env(options, &block)
+  ClimateControl.modify(options, &block)
+end

metadata

@@ -1,15 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: beaker-gke
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Night's Watch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: simplecov
+  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: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -28,16 +118,22 @@ dependencies:
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.10'
 description: Add GKE support to Beaker acceptance testing tool
 email:
 - team-nw@puppet.com
@@ -46,11 +142,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubcop.yaml"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CODEOWNERS
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - beaker-gke.gemspec
 - bin/beaker-gke
 - config/pod.yaml
@@ -59,6 +160,8 @@ files:
 - lib/beaker-gke.rb
 - lib/beaker-gke/version.rb
 - lib/beaker/hypervisor/gke.rb
+- spec/gke/hypervisor/gke_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/puppetlabs/beaker-gke
 licenses:
 - Apache-2.0
@@ -69,17 +172,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Beaker hypervisor for GKE!

data/.rubcop.yaml

@@ -1,14 +0,0 @@
----
-require:
-  - rubocop-rspec
-  - rubocop-performance
-AllCops:
-  TargetRubyVersion: 2.4
-Documentation:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: 20
-Style/Documentation:
-  Enabled: false
-Metrics/LineLength:
-  Max: 120