kamaze-docker_image 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fad5772cb626cf0f9a7be4b64b3c5f32dd14daff83f8eccc6345e22d5120b8aa
+  data.tar.gz: ae5b2cfd9b17dba7827f5e7d88763c6bee9e24dc55b6f567661fb147b0e1f89d
+SHA512:
+  metadata.gz: 073c70b2161a1d37569e3fe44ff94447a8219f31bae85518d97e59a9c098569c9d75739c3d3c427c6cf506d51a1125cb5e3230669071e874a565955be0e87893
+  data.tar.gz: 7f2c5d696672fdb98f8d696ebb5185ed1b0df1bd695b99277bfc27922635b3da522ec29aeefdde1d7798f0c49828220f63cf70bd73e2af7166f9ab668a1232b4

data/.rubocop.yml

@@ -0,0 +1,6 @@
+---
+inherit_gem:
+  kamaze-project:
+    - .rubocop.yml
+AllCops:
+  NewCops: disable

data/.yardopts

@@ -0,0 +1,16 @@
+# vim: ft=sh
+
+lib/**/*.rb                                   \
+    --no-progress                             \
+    --markup-provider 'redcarpet'             \
+    --markup 'markdown'                       \
+    --charset 'utf-8'                         \
+    --protected --private --embed-mixins      \
+    --tag type:'type' --hide-tag 'type'       \
+    --readme README.md                        \
+    --exclude '_flymake\\.rb$'                \
+    --exclude '/\\.#'
+
+# Local Variables:
+# mode: sh
+# End:

data/lib/kamaze-docker_image.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+$LOAD_PATH.unshift(__dir__)
+
+lock = Dir.chdir("#{__dir__}/..") do
+  [['gems.rb', 'gems.locked'], ['Gemfile', 'Gemfile.lock']]
+    .map { |m| Dir.glob(m).size >= 2 }
+    .include?(true)
+end
+
+if lock
+  require 'rubygems'
+  require 'bundler/setup'
+
+  if Gem::Specification.find_all_by_name('kamaze-project').any?
+    require 'kamaze/project/core_ext/pp'
+  end
+end

data/lib/kamaze/docker_image.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+# rubocop:disable Style/Documentation
+
+module Kamaze
+end
+
+# rubocop:enable Style/Documentation
+
+# Describe a docker image
+class Kamaze::DockerImage
+  # Get commands
+  #
+  # Commands as run by runner
+  #
+  # @see Kamaze::DockerImage::Runner#command
+  # @see Kamaze::DockerImage::Concern::Setup#default_commands
+  #
+  # @return [Hash]
+  attr_reader :commands
+
+  # Get image name
+  #
+  # @return [String]
+  attr_reader :name
+
+  # Get version
+  #
+  # @return [String]
+  attr_reader :version
+
+  # Get namespace used for tasks
+  #
+  # @return [String|Symbol|nil]
+  attr_reader :tasks_ns
+
+  # Get name used to run container
+  #
+  # @return [String]
+  attr_reader :run_as
+
+  # Config related to ssh.
+  #
+  # @return [Hash|nil]
+  attr_reader :ssh
+
+  # Executable path or name for ``docker``
+  #
+  # @return [String]
+  attr_reader :docker_bin
+
+  attr_reader :tasks_load
+
+  # Get default command for ``exec``
+  #
+  # @see Runner#exec
+  #
+  # @return [String]
+  attr_reader :exec_command
+
+  autoload(:Pathname, 'pathname')
+  autoload(:Open3, 'open3')
+  autoload(:JSON, 'json')
+
+  {
+    Concern: 'concern',
+    Command: 'command',
+    Runner: 'runner',
+    SSH: 'ssh',
+    Loader: 'loader',
+    VERSION: 'version',
+  }.each { |k, v| autoload(k, "#{__dir__}/docker_image/#{v}") }
+
+  include Concern::Executable
+  include Concern::Setup
+  include Concern::ReadableAttrs
+
+  def initialize(&block)
+    setup(caller_locations, &block)
+
+    @runner = Runner.new(self)
+    @ssh = SSH.new(self).freeze
+    tasks_load! if tasks_load?
+  end
+
+  # Get image id (through docker command).
+  #
+  # @return [String, nil]
+  def id
+    # docker image list --format "{{json .ID}}" image_name:image_version
+    [
+      self.to_h[:docker_bin] || executable
+    ].concat(['image', 'list', '--format', '{{json .ID}}', self.to_s]).yield_self do |command|
+      Open3.capture3(*command).tap do |stdout, _, status|
+        return nil unless status.success?
+
+        return stdout.lines.empty? ? nil : JSON.parse(stdout.lines.first)
+      end
+    end
+  end
+
+  # Denote image is started.
+  #
+  # @return [Boolean]
+  def started?
+    runner.started?
+  end
+
+  # Denote image is running?.
+  #
+  # @return [Boolean]
+  def running?
+    runner.running?
+  end
+
+  # Get name of available commands.
+  #
+  # @return [Array<Symbol>]
+  def available_commands
+    commands.clone.reject { |_k, args| args.nil? }.to_h.keys.sort
+  end
+
+  # Get tag
+  #
+  # tag has the following format: ``#{name}:#{version}``
+  #
+  # @return [String]
+  def tag
+    "#{name}:#{version}"
+  end
+
+  alias to_s tag
+
+  # @return [Hash]
+  def to_h
+    readable_attrs_values
+      .to_h.tap { |h| h.merge!(tag: tag) }
+      .sort.to_h
+  end
+
+  # @return [Boolean]
+  def verbose?
+    !!@verbose
+  end
+
+  # @return [Boolean]
+  def tasks_load?
+    !!self.tasks_load
+  end
+
+  # @return [Pathname]
+  def path
+    Pathname.new(@path)
+  end
+
+  # @see Runner#actions
+  def method_missing(method, *args, &block)
+    respond_to_missing?(method) ? runner.public_send(method, *args, &block) : super
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    # rubocop:disable Style/RedundantParentheses
+    (runner&.actions).to_a.include?(method.to_sym) || super(method, include_private)
+    # rubocop:enable Style/RedundantParentheses
+  end
+
+  protected
+
+  # @type [String]
+  attr_writer :name
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String]
+  attr_writer :path
+
+  # @see Concern::Setup#setup_defaults
+  # @type [Boolean]
+  attr_writer :verbose
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String]
+  attr_writer :version
+
+  # @type [String|nil]
+  attr_writer :tasks_ns
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String]
+  attr_writer :tasks_load
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String]
+  attr_writer :run_as
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String]
+  attr_writer :exec_command
+
+  # @type [Hash]
+  attr_writer :ssh
+
+  # @see Concern::Setup#setup_defaults
+  # @type [Hash]
+  attr_writer :commands
+
+  # @see Concern::Setup#setup_defaults
+  # @type [String|Symbol]
+  attr_writer :docker_bin
+
+  # @return [Runner]
+  attr_reader :runner
+
+  # Load tasks
+  def tasks_load!
+    self.tap { Loader.new(self).call }
+  end
+end

data/lib/kamaze/docker_image/command.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../docker_image'
+
+# Describe a command
+#
+# Command is able to run itself.
+class Kamaze::DockerImage::Command
+  autoload :Shellwords, 'shellwords'
+
+  # @return [Hash]
+  attr_reader :config
+
+  # @param [Array<String>] command
+  # @param [Hash] config
+  # @param [String|nil] extra
+  def initialize(command, config = {}, extra = nil)
+    command.clone.to_a.tap do |c|
+      extras = Shellwords.split(extra.to_s).compact
+      @parts = c.push(*extras).freeze
+    end
+
+    config.clone.to_h.tap do |c|
+      @config = c.freeze
+    end
+  end
+
+  # @return [Array<String>]
+  def to_a
+    parts.clone
+  end
+
+  # @return [String]
+  def to_s
+    Shellwords.join(self.to_a)
+  end
+
+  def run(&block)
+    sh(*self.to_a, &block)
+  end
+
+  alias call run
+
+  # @return [Boolean]
+  def execute
+    system(*self.to_a)
+  end
+
+  protected
+
+  # @return [Array<String>]
+  attr_reader :parts
+
+  # Get utils.
+  #
+  # return [Class]
+  def utils
+    if Gem::Specification.find_all_by_name('rake')
+      require 'rake'
+      require 'rake/file_utils'
+    end
+
+    Class.new { include FileUtils }.new
+  end
+
+  # @see https://github.com/ruby/rake/blob/124a03bf4c0db41cd80a41394a9e7c6426e44784/lib/rake/file_utils.rb#L43
+  def sh(*cmd, &block)
+    options = cmd.last.is_a?(Hash) ? cmd.pop : {}
+    options[:verbose] = config[:verbose] unless options.key?(:verbose)
+
+    utils.sh(*cmd.map(&:to_s).push(options), &block)
+  end
+end

data/lib/kamaze/docker_image/concern.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../docker_image'
+
+# rubocop:disable Style/Documentation
+
+module Kamaze::DockerImage::Concern
+  {
+    Containers: 'containers',
+    Setup: 'setup',
+    Executable: 'executable',
+    ReadableAttrs: 'readable_attrs',
+  }.each { |k, v| autoload(k, "#{__dir__}/concern/#{v}") }
+end
+
+# rubocop:enable Style/Documentation

data/lib/kamaze/docker_image/concern/containers.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../concern'
+
+# Provide containers method.
+module Kamaze::DockerImage::Concern::Containers
+  include Kamaze::DockerImage::Concern::Executable
+
+  autoload(:Open3, 'open3')
+  autoload(:JSON, 'json')
+
+  protected
+
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
+  # List containers.
+  #
+  # Containers are indexed by name.
+  #
+  # @return [Hash{String => Hash}]
+  def containers(all: true)
+    [(config[:docker_bin] || executable).to_s].map(&:freeze).freeze.yield_self do |cmd|
+      cmd.dup.concat(['ps', (all ? '-a' : nil), '--format', '{{json .}}']).yield_self do |command|
+        [].tap do |items|
+          Open3.capture3(*command.compact).yield_self do |stdout, _, status|
+            stdout.lines.each { |line| items.push(JSON.parse(line)) } if status.success?
+          end
+        end
+      end.map { |h| containers_maker.call(h) }.map { |h| [h.info['Name'].gsub(%r{^/*}, '').to_s, h] }.to_h
+    end
+  end
+
+  # Add some methods on retrieved info.
+  #
+  # @api private
+  #
+  # @return [Proc}
+  def containers_maker
+    # @type [Hash{String => Object}] given_data
+    lambda do |given_data|
+      command = [(config[:docker_bin] || executable).to_s]
+                .map(&:freeze)
+                .concat(['inspect', '--format', '{{json .}}', given_data.fetch('ID')])
+
+      given_data.dup.tap do |result|
+        result.singleton_class.tap do |klass|
+          :inspection.tap do |method_name|
+            klass.__send__(:define_method, method_name) do
+              -> { Struct.new(:stdout, :stderr, :status).new(*Open3.capture3(*command.compact)) }
+            end
+            klass.__send__(:protected, method_name)
+          end
+
+          klass.__send__(:define_method, :info) do
+            inspection.call.yield_self do |v|
+              (v.status.success? ? JSON.parse(v.stdout) : nil).to_h
+            end
+          end
+
+          klass.__send__(:define_method, :running?) do
+            self.info['State'].to_h['Status'] == 'running'
+          end
+        end
+      end.freeze
+    end
+  end
+
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+end