kamaze-docker_image 0.0.5

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

@@ -0,0 +1,36 @@
+# 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'
+
+# Provides setup (used during initialization) and related methods.
+#
+# @todo remove this file, it SHOULD be useless
+module Kamaze::DockerImage::Concern::Docker
+  autoload(:Docker, 'docker')
+
+  protected
+
+  # Fetch containers
+  #
+  # @param [String] run_as
+  # @param [Array|nil] states
+  # @return [Array<Docker::Container>]
+  def fetch_containers(run_as, states = nil)
+    unless states.nil?
+      states = (states.is_a?(Array) ? states : [states]).map(&:to_s)
+      states = nil if states.empty?
+    end
+
+    Docker::Container.all(all: true).keep_if do |c|
+      states.to_a.empty? ? true : states.include?(c.info.fetch('State'))
+    end.keep_if do |c|
+      c.info.fetch('Names').include?("/#{run_as}")
+    end
+  end
+end

data/lib/kamaze/docker_image/concern/executable.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.
+
+require_relative '../concern'
+
+# PProvide method to retrieve path to docker executable.
+module Kamaze::DockerImage::Concern::Executable
+  autoload(:Cliver, 'cliver')
+
+  protected
+
+  # Get executable
+  #
+  # @raise [Cliver::Dependency::NotFound]
+  # @return [String]
+  def executable
+    Cliver.detect!(:docker).freeze
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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'
+
+# Provides ``readable_attrs`` method
+#
+# Readable attributes have an instance variable and an accessor,
+# boolean accessors are also supported.
+#
+# As a result, class including this module obtains a Hash representation.
+module Kamaze::DockerImage::Concern::ReadableAttrs
+  # Get readable attributes
+  #
+  # @return [Array<Symbol>]
+  def readable_attrs
+    instance_variables.clone.map do |attr|
+      k = attr.to_s.gsub(/^@/, '').to_sym
+
+      methods = ([k, "#{k}?".to_sym] & public_methods)
+
+      methods.empty? ? nil : k
+    end.compact.sort
+  end
+
+  def to_h
+    readable_attrs_values.to_h
+  end
+
+  protected
+
+  # Get readable attributes with values
+  #
+  # @return [Array<Array>]
+  def readable_attrs_values
+    readable_attrs.map do |k|
+      # booleanaccessor will override "real" accessor
+      ([k, "#{k}?".to_sym] & public_methods)
+        .map { |m| [k, self.public_send(m)] }
+        .first
+    end.compact
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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'
+
+# Provides setup (used during initialization) and related methods.
+module Kamaze::DockerImage::Concern::Setup
+  autoload :OpenStruct, 'ostruct'
+  autoload :Pathname, 'pathname'
+  autoload :YAML, 'yaml'
+  autoload :Config, "#{__dir__}/setup/config"
+
+  protected
+
+  # Setup
+  #
+  # @param [Array<Thread::Backtrace::Location>] locations
+  # @return [self]
+  def setup(locations, &block)
+    setup_defaults(locations).tap do
+      setup_block(&block)
+
+      @name = @name.to_s
+      @commands = Hash[@commands.map { |k, v| [k.to_sym, v] }]
+
+      to_h.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+  end
+
+  # rubocop:disable Metrics/MethodLength
+
+  # Setup atttributes with default values
+  #
+  # @param [Array<Thread::Backtrace::Location>] locations
+  # @return [self]
+  def setup_defaults(locations)
+    self.tap do
+      @name = nil
+      @version = 'latest'
+
+      @path = Pathname.new('.')
+      @verbose = $stdout.tty? && $stderr.tty?
+      @tasks_load = true
+      @tasks_ns = nil
+      @run_as = called_from(locations).dirname.basename.to_s
+      @docker_bin = 'docker'
+      @exec_command = 'bash -il'
+      @commands = default_commands
+      @ssh = {}
+    end
+  end
+
+  # rubocop:enable Metrics/MethodLength
+
+  # @yield [Config] config used to setup instance
+  # @return [Config]
+  def setup_block
+    Config.new(self.respond_to?(:to_h) ? to_h : {}).tap do |s|
+      yield(s) if block_given?
+
+      s.freeze
+      s.to_h.each { |k, v| setup_attr(k, v) }
+    end
+  end
+
+  # Get default commands
+  #
+  # @return [Hash]
+  def default_commands
+    content = Pathname.new(__dir__).join('..', 'commands.yml').read
+
+    YAML.safe_load(content, [Symbol])
+  end
+
+  private
+
+  # Set given attr with given value
+  #
+  # @param [String|Symbol] attr
+  # @param [Object] val
+  def setup_attr(attr, val)
+    __send__("#{attr}=", val)
+  rescue NoMethodError
+    nil
+  end
+
+  # @return [Pathname]
+  def called_from(locations = caller_locations)
+    location = locations.first.path
+
+    Pathname.new(location).realpath
+  end
+end

data/lib/kamaze/docker_image/concern/setup/config.rb

@@ -0,0 +1,35 @@
+# 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 '../setup'
+require 'ostruct'
+
+# Config data structure
+#
+# @see https://ruby-doc.org/stdlib-2.0.0/libdoc/ostruct/rdoc/OpenStruct.html
+class Kamaze::DockerImage::Concern::Setup::Config < OpenStruct
+  def respond_to_missing?(method, include_private = false)
+    super
+  end
+
+  # Introduces some strictness on ``OpenStruct#method_missing``
+  #
+  # @see https://apidock.com/ruby/OpenStruct/method_missing
+  # @return [Object]
+  def method_missing(method, *args)
+    if method[-1] != '='
+      unless self.to_h.include?(method.to_sym)
+        message = "undefined method `#{method}' for #{self}"
+
+        raise NoMethodError, message, caller(1)
+      end
+    end
+
+    super
+  end
+end

data/lib/kamaze/docker_image/loader.rb

@@ -0,0 +1,61 @@
+# 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'
+
+# Loader for tasks (using eval binding)
+class Kamaze::DockerImage::Loader
+  autoload :Pathname, 'pathname'
+  autoload :Context, "#{__dir__}/loader/context"
+
+  # @param [Kamaze::DockerImage] image
+  def initialize(image)
+    @image = image.clone.freeze
+  end
+
+  # Load tasks.
+  #
+  # @return [self]
+  def call
+    self.tap do
+      if loadable?
+        context.call do |b|
+          b.local_variable_set(:image, image)
+          b.eval(content)
+        end
+      end
+    end
+  end
+
+  # @return [Boolean]
+  def loadable?
+    context.dsl?
+  end
+
+  protected
+
+  # @return [Kamaze::DockerImage]
+  attr_reader :image
+
+  # @return [Pathname]
+  def file
+    Pathname.new(__dir__).join('loader', 'tasks.rb')
+  end
+
+  # Tasks file content (to eval)
+  #
+  # @return [String]
+  def content
+    file.read
+  end
+
+  # @return [Module<Context>]
+  def context
+    Context
+  end
+end

data/lib/kamaze/docker_image/loader/context.rb

@@ -0,0 +1,57 @@
+# 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 '../loader'
+
+# Provides empty binding.
+#
+# Sample of use:
+#
+# ```ruby
+# Context.call do |b|
+#   b.local_variable_set(:answer, 42)
+#   b.local_variable_set(:home, '127.0.0.1')
+#
+#   b.eval(content)
+# end
+# ```
+module Kamaze::DockerImage::Loader::Context
+  class << self
+    def call
+      yield(binding)
+    end
+
+    # Denote ``DSL`` is defined.
+    #
+    # @return [Boolean]
+    def dsl?
+      !!dsl
+    end
+
+    protected
+
+    # @return [Binding]
+    def binding
+      -> { super }.tap { load_dsl }.call
+    end
+
+    # @return [Rake::DSL, nil]
+    def dsl
+      Object.const_get('Rake::DSL')
+    rescue NameError
+      nil
+    end
+
+    # Apply ``Rake::DSL``
+    #
+    # @return [self]
+    def load_dsl
+      self.tap { self.extend(dsl) if dsl? }
+    end
+  end
+end

data/lib/kamaze/docker_image/loader/helper.rb

@@ -0,0 +1,99 @@
+# 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 '../loader'
+
+# Helper for tasks.
+#
+# Sample of use:
+#
+# ```ruby
+# helper = Kamaze::DockerImage::Loader::Helper.new(image)
+#
+# desc 'Run a command in a new container'
+#
+# task helper.appoint(:run), [:command] do |task, args|
+#   helper.call(task, args) { image.run(args[:command]) }
+# end
+# ````
+class Kamaze::DockerImage::Loader::Helper
+  # @param [Kamaze::DockerImage] image
+  def initialize(image)
+    @image = image
+  end
+
+  # Make task name using namespace (from image)
+  #
+  # @return [String]
+  def appoint(name)
+    namer.call(name)
+  end
+
+  # Execute related ``pre_`` and ``post_`` tasks
+  #
+  # @param [Rake::Task] task
+  # @param [Hash{Symbol => Object}] args
+  #
+  # Sample of use:
+  #
+  # ```ruby
+  # task 'docker:pre_start' do |task, args|
+  #   pp(task, args)
+  # end
+  #
+  # task 'docker:post_start' do |task, args|
+  #   pp(task, args)
+  # end
+  # ```
+  def wrap(task, args = [], &block)
+    on_pre(task, args)
+    block.call
+    on_post(task, args)
+  end
+
+  alias call wrap
+
+  protected
+
+  # @return [Kamaze::DockerImage]
+  attr_accessor :image
+
+  # @return [Proc]
+  def namer
+    lambda do |name|
+      "#{image.tasks_ns}:#{name}".gsub(/^:/, '')
+    end
+  end
+
+  # @param [Rake::Task] task
+  def on_pre(task, args)
+    task_call(on: :pre, from: task, args: args)
+  end
+
+  # @param [Rake::Task] task
+  def on_post(task, args)
+    task_call(on: :post, from: task, args: args)
+  end
+
+  # Call pre/post tasks.
+  #
+  # on: pre/post
+  # from: task as ``Rake::Task``
+  # args: Hash
+  def task_call(on:, from:, args:)
+    cname = from.name.gsub(/^#{image.tasks_ns}:/, '')
+    # @formatter:off
+    {
+      pre: namer.call("pre_#{cname}"),
+      post: namer.call("post_#{cname}"),
+    }.fetch(on).tap do |name|
+      Rake::Task[name].execute(**args.to_h) if Rake::Task.task_defined?(name)
+    end
+    # @formatter:on
+  end
+end