beaker-hcloud 1.0.0

data/README.md

@@ -0,0 +1,53 @@
+# beaker-hcloud
+
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-hcloud.svg)](https://github.com/voxpupuli/beaker-hcloud/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker-hcloud/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/beaker-hcloud/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/beaker-hcloud/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-hcloud/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-hcloud.svg)](https://rubygems.org/gems/beaker-hcloud)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-hcloud.svg)](https://rubygems.org/gems/beaker-hcloud)
+
+A [beaker](https://github.com/voxpupuli/beaker) extension for provision Hetzner Cloud instances.
+
+## Installation
+
+Include this gem alongside Beaker in your Gemfile or project.gemspec. E.g.
+
+```ruby
+# Gemfile
+gem 'beaker', '~> 5.0'
+gem 'beaker-hcloud'
+
+# project.gemspec
+s.add_runtime_dependency 'beaker', '~> 5.0'
+s.add_runtime_dependency 'beaker-hcloud'
+```
+
+## Authentication
+
+You need to create an API token using Hetzner's cloud console. Make
+sure to create the token in the correct project.
+
+`beaker-hcloud` expects the token to be in the `BEAKER_HCLOUD_TOKEN`
+environment variable.
+
+## Configuration
+
+Some options can be set to influence how and where server instances
+are being created:
+
+
+| configuration option | required | default | description |
+| -------------------- | -------- | ------- | ----------- |
+| `image`              | true     |         | The name of one of Hetzner's provided images, e.g. `ubuntu-20.04`, or a custom one, i.e. a snapshot in your account. |
+| `server_type`        | false    | `cx11`  | Hetzner cloud server type |
+| `location`           | false    | `nbg1`  | One of Hetzner's datacenter locations |
+
+# Cleanup
+
+In cases where the beaker process is killed before finishing, it may leave resources in Hetzner cloud. These will need to be manually deleted.
+
+Look for servers in your project named exactly as the ones in your beaker host configuration and SSH keys with names beginning with `Beaker-`.
+
+# Contributing
+
+Please refer to voxpupuli/beaker's [contributing](https://github.com/voxpupuli/beaker/blob/master/CONTRIBUTING.md) guide.

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+begin
+  require 'voxpupuli/rubocop/rake'
+rescue LoadError
+  # the voxpupuli-rubocop gem is optional
+end
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions]
+    config.user = 'voxpupuli'
+    config.project = 'beaker-hcloud'
+    config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
+  end
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task default: %i[spec]

data/beaker-hcloud.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'beaker-hcloud/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'beaker-hcloud'
+  s.version     = BeakerHcloud::VERSION
+  s.summary     = 'Hetzner Library for beaker acceptance testing framework'
+  s.description = 'Another gem that extends beaker'
+  s.authors     = ['Tim Meusel', 'Vox Pupuli']
+  s.email       = 'voxpupuli@groups.io'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/voxpupuli/beaker-hcloud'
+  s.license     = 'AGPL-3.0'
+
+  s.required_ruby_version = '>= 2.7'
+
+  # Testing dependencies
+  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  s.add_development_dependency 'rspec', '~> 3.12'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.0.0'
+
+  s.add_runtime_dependency 'bcrypt_pbkdf', '~> 1.0'
+  s.add_runtime_dependency 'beaker', '~> 5.4'
+  s.add_runtime_dependency 'ed25519', '~> 1.2'
+  s.add_runtime_dependency 'hcloud', '>= 1.0.3', '< 2.0.0'
+  s.add_runtime_dependency 'ssh_data', '~> 1.3'
+end

data/lib/beaker/hypervisor/hcloud.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'hcloud'
+require 'ed25519'
+require 'bcrypt_pbkdf'
+
+require_relative '../../beaker-hcloud/ssh_data_patches'
+
+module Beaker
+  # beaker extension to manage cloud instances from https://www.hetzner.com/cloud
+  class Hcloud < Beaker::Hypervisor
+    # @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.
+    # @param [Hash{Symbol=>String}] options Options to pass on to the hypervisor
+    def initialize(hosts, options) # rubocop:disable Lint/MissingSuper
+      @options = options
+      @logger = options[:logger] || Beaker::Logger.new
+      @hosts = hosts
+
+      raise 'You need to pass a token as BEAKER_HCLOUD_TOKEN environment variable' unless ENV['BEAKER_HCLOUD_TOKEN']
+
+      @client = ::Hcloud::Client.new(token: ENV.fetch('BEAKER_HCLOUD_TOKEN'))
+    end
+
+    def provision
+      @logger.notify 'Provisioning hcloud'
+      create_ssh_key
+      @hosts.each do |host|
+        create_server(host)
+      end
+      @logger.notify 'Done provisioning hcloud'
+    end
+
+    def cleanup
+      @logger.notify 'Cleaning up hcloud'
+      @hosts.each do |host|
+        @logger.debug("Deleting hcloud server #{host.name}")
+        @client.servers.find(host[:hcloud_id]).destroy
+      end
+      @logger.notify 'Deleting hcloud SSH key'
+      @client.ssh_keys.find(@options[:ssh][:hcloud_id]).destroy
+      File.unlink(@key_file.path)
+      @logger.notify 'Done cleaning up hcloud'
+    end
+
+    private
+
+    def ssh_key_name
+      safe_hostname = Socket.gethostname.tr('.', '-')
+      [
+        'Beaker',
+        ENV.fetch('USER', nil),
+        safe_hostname,
+        @options[:aws_keyname_modifier],
+        @options[:timestamp].strftime('%F_%H_%M_%S_%N'),
+      ].join('-')
+    end
+
+    def create_ssh_key
+      @logger.notify 'Generating SSH keypair'
+      ssh_key = SSHData::PrivateKey::ED25519.generate
+      @key_file = Tempfile.create(ssh_key_name)
+      File.write(@key_file.path, ssh_key.openssh(comment: ssh_key_name))
+      @logger.notify 'Creating hcloud SSH key'
+      hcloud_ssh_key = @client.ssh_keys.create(
+        name: ssh_key_name,
+        public_key: ssh_key.public_key.openssh(comment: ssh_key_name),
+      )
+      @options[:ssh][:hcloud_id] = hcloud_ssh_key.id
+      hcloud_ssh_key
+    end
+
+    def create_server(host)
+      @logger.notify "provisioning #{host.name}"
+      location = host[:location] || 'nbg1'
+      server_type = host[:server_type] || 'cx11'
+      action, server = @client.servers.create(
+        name: host.hostname,
+        location: location,
+        server_type: server_type,
+        image: host[:image],
+        ssh_keys: [ssh_key_name],
+      )
+      while action.status == 'running'
+        sleep 5
+        action = @client.actions.find(action.id)
+        server = @client.servers.find(server.id)
+      end
+      host[:ip] = server.public_net['ipv4']['ip']
+      host[:vmhostname] = server.public_net['ipv4']['dns_ptr']
+      host[:hcloud_id] = server.id
+      host.options[:ssh][:keys] = [@key_file.path]
+      server
+    end
+  end
+end

data/lib/beaker-hcloud/ssh_data_patches.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'ed25519'
+require 'ssh_data'
+
+# Patches for the 'ssh_data' gem to allow serialization of
+# ed25519 private keys in OpenSSH format.
+module BeakerHcloud
+  module SSHDataPatches
+    # Add encoding methods for OpenSSH's PEM-like format to
+    # store private keys.
+    module EncodingPatch
+      def encode_pem(data, type)
+        encoded_data = Base64.strict_encode64(data)
+                             .scan(/.{1,70}/m)
+                             .join("\n")
+                             .chomp
+        <<~PEM
+          -----BEGIN #{type}-----
+          #{encoded_data}
+          -----END #{type}-----
+        PEM
+      end
+
+      def encode_openssh_private_key(private_key, comment = '')
+        public_key = private_key.public_key
+        private_key_data = [
+          (SecureRandom.random_bytes(4) * 2),
+          public_key.rfc4253,
+          encode_string(private_key.ed25519_key.seed + public_key.ed25519_key.to_str),
+          encode_string(comment),
+        ].join
+        unpadded = private_key_data.bytesize % 8
+        private_key_data << Array(1..(8 - unpadded)).pack('c*') unless unpadded.zero?
+        [
+          ::SSHData::Encoding::OPENSSH_PRIVATE_KEY_MAGIC,
+          encode_string('none'),
+          encode_string('none'),
+          encode_string(''),
+          encode_uint32(1),
+          encode_string(public_key.rfc4253),
+          encode_string(private_key_data),
+        ].join
+      end
+    end
+
+    # Add method to emit OpenSSH-encoded string
+    module Ed25519PrivateKeyPatch
+      def openssh(comment: '')
+        encoded_key = ::SSHData::Encoding.encode_openssh_private_key(
+          self,
+          comment,
+        )
+        ::SSHData::Encoding.encode_pem(
+          encoded_key,
+          'OPENSSH PRIVATE KEY',
+        )
+      end
+    end
+  end
+end
+
+if defined?(SSHData)
+  SSHData::Encoding.extend BeakerHcloud::SSHDataPatches::EncodingPatch
+  SSHData::PrivateKey::ED25519.prepend BeakerHcloud::SSHDataPatches::Ed25519PrivateKeyPatch
+end

data/lib/beaker-hcloud/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BeakerHcloud
+  VERSION = '1.0.0'
+end

data/spec/beaker/hypervisor/hcloud_spec.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:disable RSpec/MultipleMemoizedHelpers, RSpec/VerifiedDoubles, RSpec/FilePath
+describe Beaker::Hcloud do
+  let(:logger_double) do
+    double(:logger).as_null_object
+  end
+  let(:options) do
+    opts = Beaker::Options::Presets.new
+    opts.presets
+        .merge(opts.env_vars)
+        .merge({
+                 logger: logger_double,
+                 timestamp: Time.now,
+               })
+  end
+  let(:host1_hash) do
+    {
+      hypervisor: 'hcloud',
+      image: 'ubuntu-20.04',
+    }
+  end
+  let(:host2_hash) do
+    {
+      hypervisor: 'hcloud',
+      image: 'custom image',
+      location: 'custom location',
+      server_type: 'custom type',
+    }
+  end
+  let(:hosts) do
+    [[1, host1_hash], [2, host2_hash]].map do |number, host_hash|
+      host_hash = Beaker::Options::OptionsHash.new.merge(host_hash)
+      Beaker::Host.create("Server #{number}", host_hash, options)
+    end
+  end
+  let(:server1) do
+    double(:server1,
+           id: 1,
+           public_net: {
+             'ipv4' => {
+               'ip' => '192.168.0.1',
+               'dns_ptr' => 'server1.example.com',
+             },
+           },
+           destroy: true)
+  end
+  let(:server2) do
+    double(:server2,
+           id: 2,
+           public_net: {
+             'ipv4' => {
+               'ip' => '192.168.0.2',
+               'dns_ptr' => 'server2.example.com',
+             },
+           },
+           destroy: true)
+  end
+  let(:action_double) do
+    double(:action, status: 'success')
+  end
+  let(:actions_double) do
+    double(:actions, find: action_double)
+  end
+  let(:servers_double) do
+    servers_double = double(:servers)
+    allow(servers_double).to receive(:create)
+      .and_return([action_double, server1], [action_double, server2])
+    allow(servers_double).to receive(:find)
+      .and_return(server1, server2)
+    servers_double
+  end
+  let(:key_double) do
+    double(:key, id: 23, destroy: true)
+  end
+  let(:ssh_keys_double) do
+    double(:ssh_keys, create: key_double, find: key_double)
+  end
+  let(:hcloud_client) do
+    double(:hcloud_client,
+           actions: actions_double,
+           servers: servers_double,
+           ssh_keys: ssh_keys_double)
+  end
+  let(:hcloud) do
+    described_class.new(hosts, options)
+  end
+
+  before do
+    ENV['BEAKER_HCLOUD_TOKEN'] = 'abc'
+    allow(Hcloud::Client).to receive(:new).and_return(hcloud_client)
+  end
+
+  describe '#provision', :aggregate_failures do
+    subject(:provision) { hcloud.provision }
+
+    before { provision }
+
+    after { hcloud.cleanup }
+
+    it 'uploads an ssh key using the hcloud client' do
+      expect(ssh_keys_double).to have_received(:create)
+    end
+
+    # rubocop:disable RSpec/ExampleLength
+    it 'creates one server for each host via the hcloud client' do
+      expect(servers_double).to have_received(:create)
+        .with(hash_including({
+                               name: 'Server 1',
+                               location: 'nbg1',
+                               server_type: 'cx11',
+                               image: 'ubuntu-20.04',
+                             }))
+      expect(servers_double).to have_received(:create)
+        .with(hash_including({
+                               name: 'Server 2',
+                               location: 'custom location',
+                               server_type: 'custom type',
+                               image: 'custom image',
+                             }))
+    end
+    # rubocop:enable RSpec/ExampleLength
+
+    it "saves ip and dns name to the host's settings" do
+      host1, host2 = hosts
+      expect(host1[:ip]).to eq '192.168.0.1'
+      expect(host1[:vmhostname]).to eq 'server1.example.com'
+      expect(host2[:ip]).to eq '192.168.0.2'
+      expect(host2[:vmhostname]).to eq 'server2.example.com'
+    end
+
+    it "saves hcloud's server id with the host's settings" do
+      host1, host2 = hosts
+      expect(host1[:hcloud_id]).to eq 1
+      expect(host2[:hcloud_id]).to eq 2
+    end
+
+    it "saves the path to the temporary ssh key with the host's options" do
+      host1, host2 = hosts
+      expect(host1[:ssh][:keys].size).to eq 1
+      expect(host2[:ssh][:keys].size).to eq 1
+    end
+  end
+
+  describe '#cleanup' do
+    subject(:cleanup) { hcloud.cleanup }
+
+    before do
+      hcloud.provision
+      cleanup
+    end
+
+    it 'destroys first server' do
+      expect(server1).to have_received(:destroy)
+    end
+
+    it 'destroys last server' do
+      expect(server2).to have_received(:destroy)
+    end
+
+    it 'destroys the temporary ssh key' do
+      expect(key_double).to have_received(:destroy)
+    end
+  end
+end
+# rubocop:enable RSpec/MultipleMemoizedHelpers, RSpec/VerifiedDoubles, RSpec/FilePath

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+end
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+
+require 'beaker'
+require 'beaker-hcloud/version'
+require 'beaker/hypervisor/hcloud'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: beaker-hcloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Meusel
+- Vox Pupuli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: beaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hcloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: ssh_data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Another gem that extends beaker
+email: voxpupuli@groups.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- beaker-hcloud.gemspec
+- lib/beaker-hcloud/ssh_data_patches.rb
+- lib/beaker-hcloud/version.rb
+- lib/beaker/hypervisor/hcloud.rb
+- spec/beaker/hypervisor/hcloud_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/voxpupuli/beaker-hcloud
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Hetzner Library for beaker acceptance testing framework
+test_files: []