hashipack 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6c25005946f4906333f98699391a281e3b183b862149261dc904e8edc4ca1ea
+  data.tar.gz: a65eba6ce8350861b28269fab10be83951f03c568339dc303123caa809198260
+SHA512:
+  metadata.gz: d2cfe192adc690bcb79782dc9b6e1fb784cffaa3958017e578106fb30b31ebd6dbdeaa04123e74b4f3ad36bee5cb2b883f0ee5be23831138896212b71e5b7e04
+  data.tar.gz: 305121b087a7c79ff89e048c60451b7573608f84c2df6508ea12368a5022c075771b3b7e4b1dc8be638f6a00e78a41a282eba5a9cff27bf25872e854b2c0e2cb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hashipack.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    hashipack (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  hashipack!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,88 @@
+# Hashipack
+
+Hashipack is a Ruby client for Hashicorp's Packer.
+
+It allows building images and provides live status updates about the progress, as well as the resulting artifacts.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add hashipack
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install hashipack
+```
+
+And require it in your program:
+
+```ruby
+require 'hashipack'
+```
+
+## Usage
+
+Create a client:
+
+```ruby
+client = Hashipack::Client.new
+```
+
+Build an image by providing the template:
+
+```ruby
+template = File.read('myimage.pkr.hcl')
+result = client.build(template)
+```
+
+Subscribe to log messages and print them as they arrive:
+
+```ruby
+print_message = -> (message) { puts message }
+result = client.build(template, on_output: print_message)
+
+# This would print something like
+# ...
+# ==> myvm.hcloud.example: Shutting down server...
+# ==> myvm.hcloud.example: Creating snapshot ...
+# ==> myvm.hcloud.example: This can take some time
+# ...
+```
+
+In addition to the template, you can also provide a lambda that is called when the builder progresses. You
+need to define an estimated build duration in seconds so hashipack can calculate the progress.
+
+```ruby
+print_message = -> (message) { puts message }
+print_progress = -> (progress) { puts progress }
+result = client.build(template, on_output: print_message, on_progress: print_progress, estimated_duration: 300)
+```
+
+The result contains an array of artifacts that were generated during the build:
+
+```ruby
+print result
+# => [#<hashipack::Artifact @builder_id="hcloud.builder", @id="131872234", @string="A snapshot was created: 'packer-1697561712'">]
+```
+
+This usually includes the following fields:
+
+| Field | Value | Example |
+|---|---|---|
+| builder_id | The plugin name | `"hcloud.builder"` |
+| id | The platforms native artifact id  | `"131872234"`, which is the ID of the image on Hetzner Cloud |
+| string | The completion message by Packer | `"A snapshot was created: 'packer-1697561712'"` |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/code-fabrik/hashipack.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/hashipack/artifact.rb

@@ -0,0 +1,18 @@
+module Hashipack
+  class Artifact
+    attr_reader :builder_id, :id, :string, :files_count
+
+    def append_info(key, value)
+      case key.to_s
+      when 'builder-id'
+        @builder_id = value
+      when 'id'
+        @id = value
+      when 'string'
+        @string = value
+      when 'files_count'
+        @files_count = value
+      end
+    end
+  end
+end

data/lib/hashipack/client.rb

@@ -0,0 +1,43 @@
+require 'tempfile'
+
+module Hashipack
+  class Client
+    def build(content, on_output: lambda{}, on_progress: lambda{}, estimated_duration: 300)
+      template = Tempfile.new(["template", ".pkr.hcl"])
+      template.write(content)
+      template.close
+      command = "packer -machine-readable build #{template.path}"
+
+      initial_timestamp = 99999999999
+      last_timestamp = 0
+
+      artifacts = []
+
+      IO.popen(command).each do |line|
+
+        message = Message.parse(line)
+
+        if message.type == :ui
+          initial_timestamp = message.timestamp if message.timestamp < initial_timestamp
+
+          if message.timestamp > last_timestamp
+            last_timestamp = message.timestamp
+            running_duration = message.timestamp - initial_timestamp
+            progress = running_duration / estimated_duration.to_f
+            on_progress.call(progress)
+          end
+
+          on_output.call(message.text)
+
+        elsif message.type == :artifact
+
+          artifacts[message.number] ||= Artifact.new
+          artifacts[message.number].append_info(message.key, message.value)
+
+        end
+      end
+
+      return artifacts
+    end
+  end
+end

data/lib/hashipack/message.rb

@@ -0,0 +1,63 @@
+module Hashipack
+  class Message
+    def self.parse(line)
+      msg = Message.new(line)
+      if msg.ui?
+        return UiMessage.new(line)
+      elsif msg.artifact?
+        return ArtifactMessage.new(line)
+      else
+        puts "Ignoring unknown message type #{msg.type}"
+        return Message.new(line)
+      end
+    end
+
+    def initialize(line)
+      @parts = line.split(",")
+    end
+
+    def timestamp
+      @parts.first.to_i
+    end
+
+    def type
+      @parts[2]
+    end
+
+    def ui?
+      type == 'ui'
+    end
+
+    def artifact?
+      type == 'artifact'
+    end
+  end
+
+  class UiMessage < Message
+    def type
+      :ui
+    end
+
+    def text
+      @parts[4]
+    end
+  end
+
+  class ArtifactMessage < Message
+    def type
+      :artifact
+    end
+
+    def number
+      @parts[3].to_i
+    end
+
+    def key
+      @parts[4]
+    end
+
+    def value
+      @parts[5]
+    end
+  end
+end

data/lib/hashipack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hashipack
+  VERSION = "0.1.1"
+end

data/lib/hashipack.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "hashipack/version"
+
+require 'hashipack/client'
+require 'hashipack/message'
+require 'hashipack/artifact'

data/sig/hashipack.rbs

@@ -0,0 +1,4 @@
+module Hashipack
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: hashipack
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lukas_Skywalker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-17 00:00:00.000000000 Z
+dependencies: []
+description: None.
+email:
+- LukasSkywalker@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/hashipack.rb
+- lib/hashipack/artifact.rb
+- lib/hashipack/client.rb
+- lib/hashipack/message.rb
+- lib/hashipack/version.rb
+- sig/hashipack.rbs
+homepage: https://code-fabrik.ch
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://code-fabrik.ch
+  source_code_uri: https://github.com/code-fabrik/hashipack-ruby
+  changelog_uri: https://github.com/code-fabrik/hashipack-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Ruby client for Hashicorps Packer
+test_files: []