beaker-google 0.3.0 → 0.5.0

data/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+## [0.5.0](https://github.com/voxpupuli/beaker-google/tree/0.5.0) (2022-10-04)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/0.4.0...0.5.0)
+
+**Implemented enhancements:**
+
+- Also enable SSH on images from the windows-sql-cloud project [\#27](https://github.com/voxpupuli/beaker-google/pull/27) ([jaevans](https://github.com/jaevans))
+- Add the OpenSSH directory to the system path [\#25](https://github.com/voxpupuli/beaker-google/pull/25) ([jaevans](https://github.com/jaevans))
+- Enable windows support [\#23](https://github.com/voxpupuli/beaker-google/pull/23) ([jaevans](https://github.com/jaevans))
+
+## [0.4.0](https://github.com/voxpupuli/beaker-google/tree/0.4.0) (2022-09-16)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/0.3.0...0.4.0)
+
+**Merged pull requests:**
+
+- Update rake requirement from ~\> 10.1 to ~\> 13.0 [\#20](https://github.com/voxpupuli/beaker-google/pull/20) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Transfer to Vox Pupuli Prep [\#19](https://github.com/voxpupuli/beaker-google/pull/19) ([yachub](https://github.com/yachub))
+- Support updated google APIs [\#17](https://github.com/voxpupuli/beaker-google/pull/17) ([jaevans](https://github.com/jaevans))
+- Update fakefs requirement from ~\> 0.6 to ~\> 1.8 [\#16](https://github.com/voxpupuli/beaker-google/pull/16) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [0.3.0](https://github.com/voxpupuli/beaker-google/tree/0.3.0) (2022-09-08)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/0.2.1...0.3.0)
+
+**Merged pull requests:**
+
+- \(RE-14811\) Add RE as codeowners [\#18](https://github.com/voxpupuli/beaker-google/pull/18) ([yachub](https://github.com/yachub))
+- \(DIO-3133\) Scan repo with Snyk [\#13](https://github.com/voxpupuli/beaker-google/pull/13) ([suckatrash](https://github.com/suckatrash))
+- Add Dependabot to keep thins up to date [\#8](https://github.com/voxpupuli/beaker-google/pull/8) ([genebean](https://github.com/genebean))
+
+## [0.2.1](https://github.com/voxpupuli/beaker-google/tree/0.2.1) (2020-01-29)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/0.2.0...0.2.1)
+
+**Merged pull requests:**
+
+- \(MAINT\) update beaker testing version [\#7](https://github.com/voxpupuli/beaker-google/pull/7) ([kevpl](https://github.com/kevpl))
+- \(MAINT\) remove markdown requirement [\#6](https://github.com/voxpupuli/beaker-google/pull/6) ([kevpl](https://github.com/kevpl))
+- Update google-api-client dependency [\#5](https://github.com/voxpupuli/beaker-google/pull/5) ([cdenneen](https://github.com/cdenneen))
+
+## [0.2.0](https://github.com/voxpupuli/beaker-google/tree/0.2.0) (2018-09-17)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/0.1.0...0.2.0)
+
+**Merged pull requests:**
+
+- \(BKR-1509\) Hypervisor usage instructions for Beaker 4..0 [\#4](https://github.com/voxpupuli/beaker-google/pull/4) ([Dakta](https://github.com/Dakta))
+- \(MAINT\) Overall GCE Updates [\#3](https://github.com/voxpupuli/beaker-google/pull/3) ([trevor-vaughan](https://github.com/trevor-vaughan))
+
+## [0.1.0](https://github.com/voxpupuli/beaker-google/tree/0.1.0) (2017-07-19)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-google/compare/34ca3d6b58dd87455316e055214367215fdff71f...0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,27 +1,23 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+source ENV.fetch('GEM_SOURCE', 'https://rubygems.org')
 
 gemspec
 
-
-
 def location_for(place, fake_version = nil)
   if place =~ /^git:([^#]*)#(.*)/
-    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
-  elsif place =~ /^file:\/\/(.*)/
-    ['>= 0', { :path => File.expand_path($1), :require => false }]
+    [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 }]
+    [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')
+  gem 'beaker', *location_for(ENV.fetch('BEAKER_VERSION', '~> 4.0'))
 end
 
-
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
+group :release do
+  gem 'github_changelog_generator', require: false
 end

data/README.md

@@ -1,40 +1,69 @@
 # beaker-google
 
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-google.svg)](https://github.com/voxpupuli/beaker-google/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker-google/actions/workflows/ci.yml/badge.svg)](https://github.com/voxpupuli/beaker-google/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/beaker-google/branch/main/graph/badge.svg)](https://codecov.io/gh/voxpupuli/beaker-google)
+[![Release](https://github.com/voxpupuli/beaker-google/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-google/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-google.svg)](https://rubygems.org/gems/beaker-google)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-google.svg)](https://rubygems.org/gems/beaker-google)
+[![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
+
 Beaker library to use the Google hypervisor
 
 # How to use this wizardry
 
-This is a gem that allows you to use hosts with [google compute](google_compute_engine.md) hypervisor with [Beaker](https://github.com/puppetlabs/beaker).
-
-See the [documentation](docs/manual.md) for the full manual.
+This is a gem that allows you to use hosts with [Google Compute](https://cloud.google.com/compute) hypervisor with [Beaker](https://github.com/voxpupuli/beaker).
 
 Beaker will automatically load the appropriate hypervisors for any given hosts file, so as long as your project dependencies are satisfied there's nothing else to do. No need to `require` this library in your tests.
 
-## With Beaker 3.x
-This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec)
-for you, so you don't need to do anything special to use this gem's
-functionality with Beaker.
-
-This library is included as a dependency of Beaker 3.x versions, so there's nothing to do.
-
 ## With Beaker 4.x
 
 As of Beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g.
 
-~~~ruby
+```ruby
 # Gemfile
 gem 'beaker', '~>4.0'
-gem 'beaker-aws'
+gem 'beaker-google'
 # project.gemspec
 s.add_runtime_dependency 'beaker', '~>4.0'
-s.add_runtime_dependency 'beaker-aws'
-~~~
+s.add_runtime_dependency 'beaker-google'
+```
+
+## Authentication
+
+You must be authenticated to Google Compute Engine to be able to use `beaker-google`. Authentication is attempted in two different ways, and the first that succeeds is used.
+
+- Using the environment variable [`GOOGLE_APPLICATION_CREDENTIALS`](https://cloud.google.com/docs/authentication/production#passing_variable), which points to a file containing the credentials for a GCP service account, created by `gcloud iam service-accounts keys create` (or equivalent).
+- Using [Application Default Credentials](https://cloud.google.com/docs/authentication/production).
+
+## Configuration
+
+The behavior of this library can be configured using either the beaker host configuration file, or environment variables.
+
+| configuration option | required         | default                          | description                                                                                                                                                                                                                                                                                   |
+| -------------------- | ---------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| gce_project          | true             |                                  | The ID of the Google GCP project to host resources.                                                                                                                                                                                                                                           |
+| gce_zone             | true             |                                  | The zone to place compute instances in. The region is calculated from the zone name.                                                                                                                                                                                                          |
+| gce_network          | false            | Default                          | The name of the network to attach to instances. If the project uses the default network, this and `gce_subnetwork` can be left empty.                                                                                                                                                         |
+| gce_subnetwork       | false            | Default                          | The name of the subnetwork to attach to the instances network interface. If the Default network is not used, this must be supplied.                                                                                                                                                           |
+| gce_ssh_private_key  | false            | $HOME/.ssh/google_compute_engine | The file path of the private key to use to connect to instances. If using the key created by the gcloud tool, this can be left blank.                                                                                                                                                         |
+| gce_ssh_public_key   | false            | <gce_ssh_private_key>.pub        | The file path of the public key to upload to the instance. If left blank, attempt to use the file at `gce_ssh_private_key` with a `.pub` extension.                                                                                                                                           |
+| gce_machine_type     | false            | e2-standard-4                    | The machine type to use for the instance. If the `BEAKER_gce_machine_type` environment variable is set, it will be used for all hosts.                                                                                                                                                        |
+| volume_size          | false            | Source Image disk's size         | The size of the boot disk for the image. If unset, the disk will be the same size as the image's boot disk. Provided size must be equal to or larger than the image's disk size.                                                                                                              |
+| image                | true or `family` |                                  | The image to use for creating this instance. It can be either in the form `{project}/{image}` to use an image in a different project, or `{image}`, which will look for the image in `gce_project`.                                                                                           |
+| family               | true or `image`  |                                  | The image family to use for creating this instance. It can be either in the form `{project}/{family}` to use an image from a family in a different project, or `{family}`, which will look for the image family in `gce_project`. The latest non-deprecated image in the family will be used. |
+
+All the variables in the list can be set in the Beaker host configuration file, or the ones starting with `gce_` can be overridden by environment variables in the form `BEAKER_gce_...`. i.e. To override the `gce_machine_type` setting in the environment, set `BEAKER_gce_machine_type`.
+
+# Cleanup
+
+In cases where the beaker process is killed before finishing, it may leave resources in GCP. These resources will need to be manually deleted.
 
-In Beaker's next major version, the requirement for `beaker-google` will be
-pulled from that repo. When that happens, then the usage pattern will change.
-In order to use this then, you'll need to include `beaker-google` as a dependency
-right next to beaker itself.
+| Resource Type | Name Pattern        | Count                                       |
+| ------------- | ------------------- | ------------------------------------------- |
+| Firewall      | `beaker-<number>-*` | 1                                           |
+| Instance      | `beaker-*`          | One or more depending on test configuration |
 
 # Contributing
 
-Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
+Please refer to voxpupuli/beaker's [contributing](https://github.com/voxpupuli/beaker/blob/master/CONTRIBUTING.md) guide.

data/Rakefile

@@ -5,65 +5,61 @@ require 'rspec/core/rake_task'
 #   Documentation Tasks
 #
 ###########################################################
-DOCS_DAEMON = "yard server --reload --daemon --server thin"
+DOCS_DAEMON = 'yard server --reload --daemon --server thin'
 FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker'
 
-def running?( cmdline )
+def running?(cmdline)
   ps = `ps -ef`
-  found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ )
-  if found.length > 1
-    raise StandardError, "Found multiple YARD Servers. Don't know what to do."
-  end
+  found = ps.lines.grep(/#{Regexp.quote(cmdline)}/)
+  raise StandardError, "Found multiple YARD Servers. Don't know what to do." if found.length > 1
 
   yes = found.empty? ? false : true
-  return yes, found.first
+  [yes, found.first]
 end
 
-def pid_from( output )
+def pid_from(output)
   output.squeeze(' ').strip.split(' ')[1]
 end
 
 desc 'Start the documentation server in the foreground'
-task :docs => 'docs:clear' do
+task docs: 'docs:clear' do
   original_dir = Dir.pwd
-  Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+  Dir.chdir(__dir__)
   sh FOREGROUND_SERVER
-  Dir.chdir( original_dir )
+  Dir.chdir(original_dir)
 end
 
 namespace :docs do
-
   desc 'Clear the generated documentation cache'
   task :clear do
     original_dir = Dir.pwd
-    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+    Dir.chdir(__dir__)
     sh 'rm -rf docs'
-    Dir.chdir( original_dir )
+    Dir.chdir(original_dir)
   end
 
   desc 'Generate static documentation'
-  task :gen => 'docs:clear' do
+  task gen: 'docs:clear' do
     original_dir = Dir.pwd
-    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+    Dir.chdir(__dir__)
     output = `bundle exec yard doc`
     puts output
-    if output =~ /\[warn\]|\[error\]/
-      fail "Errors/Warnings during yard documentation generation"
-    end
-    Dir.chdir( original_dir )
+    raise 'Errors/Warnings during yard documentation generation' if output =~ /\[warn\]|\[error\]/
+
+    Dir.chdir(original_dir)
   end
 
   desc 'Run the documentation server in the background, alias `bg`'
-  task :background => 'docs:clear' do
-    yes, output = running?( DOCS_DAEMON )
+  task background: 'docs:clear' do
+    yes, output = running?(DOCS_DAEMON)
     if yes
-      puts "Not starting a new YARD Server..."
-      puts "Found one running with pid #{pid_from( output )}."
+      puts 'Not starting a new YARD Server...'
+      puts "Found one running with pid #{pid_from(output)}."
     else
       original_dir = Dir.pwd
-      Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+      Dir.chdir(__dir__)
       sh "bundle exec #{DOCS_DAEMON}"
-      Dir.chdir( original_dir )
+      Dir.chdir(original_dir)
     end
   end
 
@@ -71,37 +67,51 @@ namespace :docs do
 
   desc 'Check the status of the documentation server'
   task :status do
-    yes, output = running?( DOCS_DAEMON )
+    yes, output = running?(DOCS_DAEMON)
     if yes
-      pid = pid_from( output )
+      pid = pid_from(output)
       puts "Found a YARD Server running with pid #{pid}"
     else
-      puts "Could not find a running YARD Server."
+      puts 'Could not find a running YARD Server.'
     end
   end
 
-  desc "Stop a running YARD Server"
+  desc 'Stop a running YARD Server'
   task :stop do
-    yes, output = running?( DOCS_DAEMON )
+    yes, output = running?(DOCS_DAEMON)
     if yes
-      pid = pid_from( output )
+      pid = pid_from(output)
       puts "Found a YARD Server running with pid #{pid}"
       `kill #{pid}`
-      puts "Stopping..."
-      yes, output = running?( DOCS_DAEMON )
+      puts 'Stopping...'
+      yes, output = running?(DOCS_DAEMON)
       if yes
         `kill -9 #{pid}`
-        yes, output = running?( DOCS_DAEMON )
+        yes, output = running?(DOCS_DAEMON)
         if yes
-          puts "Could not Stop Server!"
+          puts 'Could not Stop Server!'
         else
-          puts "Server stopped."
+          puts 'Server stopped.'
         end
       else
-        puts "Server stopped."
+        puts 'Server stopped.'
       end
     else
-      puts "Could not find a running YARD Server"
+      puts 'Could not find a running YARD Server'
     end
   end
 end
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError
+else
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog}
+    config.user = 'voxpupuli'
+    config.project = 'beaker-google'
+    gem_version = Gem::Specification.load("#{config.project}.gemspec").version
+    config.future_release = gem_version
+  end
+end

data/beaker-google.gemspec

@@ -5,11 +5,11 @@ require 'beaker-google/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-google"
   s.version     = BeakerGoogle::VERSION
-  s.authors     = ["Rishi Javia, Kevin Imber, Tony Vu"]
-  s.email       = ["rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-google"
+  s.authors     = ["Puppet", "Voxpupuli"]
+  s.email       = ["voxpupuli@groups.io"]
+  s.homepage    = "https://github.com/voxpupuli/beaker-google"
   s.summary     = %q{Beaker DSL Extension Helpers!}
-  s.description = %q{For use for the Beaker acceptance testing tool}
+  s.description = %q{Google Compute Engine support for the Beaker acceptance testing tool.}
   s.license     = 'Apache2'
 
   s.files         = `git ls-files`.split("\n")
@@ -17,16 +17,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4')
+
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  # pin fakefs for Ruby < 2.3
-  if RUBY_VERSION < "2.3"
-    s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
-  else
-    s.add_development_dependency 'fakefs', '~> 0.6'
-  end
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'fakefs', '~> 1.8'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
@@ -36,7 +33,8 @@ Gem::Specification.new do |s|
 
   # Run time dependencies
   s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-  s.add_runtime_dependency 'google-api-client', '~> 0.8'
 
+  s.add_runtime_dependency 'google-apis-compute_v1', '~> 0.1'
+  s.add_runtime_dependency 'google-apis-oslogin_v1', '~> 0.1'
+  s.add_runtime_dependency 'googleauth', '~> 1.2'
 end
-

data/bin/beaker-google

@@ -4,7 +4,7 @@ require 'rubygems' unless defined?(Gem)
 require 'beaker-google'
 
 VERSION_STRING =
-"
+  "
                                  _ .--.
                                 ( `    )
         beaker-google         .-'      `--,
@@ -25,8 +25,6 @@ VERSION_STRING =
                      '=='
 "
 
-
-
 puts BeakerGoogle::VERSION
 
 exit 0