qb 0.3.25 → 0.4.0

data/lib/qb/docker/image.rb

@@ -0,0 +1,207 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require 'qb/data'
+
+require_relative './image/name'
+require_relative './image/tag'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# @todo document Docker::Image class.
+module  QB
+module  Docker
+class   Image < QB::Data::Immutable
+  
+  include NRSER::Log::Mixin
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  
+  
+  def self.with_name name, &block
+    block.call \
+      case name
+      when QB::Docker::Image::Name
+        name
+      when String
+        QB::Docker::Image::Name.from_s name
+      when Hash
+        QB::Docker::Image::Name.from_data name
+      else
+        raise NRSER::TypeError.new \
+          "Not sure what to do with ", name,
+          name: name
+      end
+  end
+  
+  
+  def self.names **opts
+    QB::Docker::CLI.image_names **opts
+  end
+  
+  
+  def self.run_cmd cmd, stream: true, raise_on_fail: false
+    if stream
+      if raise_on_fail
+        cmd.stream!
+      else
+        cmd.stream
+      end
+    else
+      cmd.capture.tap { |result|
+        if raise_on_fail && result.error?
+          raise QB::Docker::CLI::Error.from_result result
+        end
+      }
+    end
+  end
+  
+  
+  def self.run_cmd! cmd, stream: true
+    run_cmd cmd, stream: stream, raise_on_fail: true
+  end
+  
+  
+  def self.build! name:,
+                  path:,
+                  push: false,
+                  tags: [],
+                  _cmd_stream: true,
+                  **build_opts
+    
+    cmd = QB::Docker::CLI.build_cmd path, tag: name.to_s, **build_opts
+    
+    logger.info "building...",
+      name: name.to_s,
+      path: path,
+      push: push,
+      _cmd_stream: _cmd_stream,
+      cmd: cmd.prepare
+    
+    result = run_cmd! cmd, stream: _cmd_stream
+    
+    tags.each do |tag_arg|
+      cmd = QB::Docker::CLI.tag_cmd name, tag_arg
+      tag = cmd.args[1]
+      logger.debug "Tagging #{ name } as #{ tag }",
+        tag_arg: tag_arg
+      
+      result = run_cmd cmd, stream: _cmd_stream
+      
+      if result.ok?
+        logger.info "Tagged #{ name } as #{ tag }.",
+          cmd: cmd.last_prepared_cmd
+      else
+        logger.error "Failed to tag #{ name } as #{ tag }",
+          tag_arg: tag_arg,
+          cmd: cmd.last_prepared_cmd
+      end
+    end
+    
+    QB::Docker::CLI.push( name ) if push
+    
+    result
+  end
+  
+  
+  def self.ensure_present! name:,
+      pull: nil,
+      build: nil,
+      force: false,
+      push: false
+    
+    name = QB::Docker::Image::Name.from name
+    
+    if  pull.nil? &&
+        name.tag &&
+        name.tag.version.is_a?( QB::Package::Version::Leveled )
+      pull = !name.tag.version.dev?
+    end
+    
+    logger.info "Ensuring image is present...",
+      name: name.to_s,
+      pull: pull,
+      push: push,
+      force: force
+    
+    if force
+      logger.info "Forcing build...",
+        name: name.to_s
+        
+      build! name: name, **build
+      
+      QB::Docker::CLI.push?( name: name ) if push
+      
+      return
+    end
+    
+    if name.exists?
+      logger.info "Image exists", name: name.to_s
+      return
+    end
+    
+    logger.info "Name does NOT exist",
+      name: name.to_s
+      
+    if pull
+      logger.info "Attempting to pull...",
+        name: name.to_s
+      
+      return if QB::Docker::CLI.pull?( name )
+    end
+      
+    
+    logger.info "Resorting to building...",
+      name: name.to_s,
+      path: build[:path]
+    
+    build! name: name, **build
+    
+    QB::Docker::CLI.push( name: name ) if push
+    
+  end # .ensure_present!
+  
+  
+  # Properties
+  # ======================================================================
+  
+  prop :id, type: t.non_empty_str
+  
+  # prop :repo, type: QB::Docker::Repo
+  # 
+  # prop :tag, type: QB::Docker::Image::Tag
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  
+end; end; end # class QB::Docker::Image

data/lib/qb/docker/image/name.rb

@@ -0,0 +1,309 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require_relative './tag'
+
+
+# Refinements
+# ========================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# Image name.
+#  
+# Input format will be one of:
+#  
+# 1.  name[:tag]
+# 2.  repository/name[:tag]
+# 3.  registry_server:port/name[:tag]
+#   
+module  QB
+module  Docker
+class   Image < QB::Data::Immutable
+class   Name  < QB::Data::Immutable
+  
+  # Mixins
+  # ========================================================================
+  
+  extend ::MethodDecorators
+  
+  include NRSER::Log::Mixin
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  # Load from a {String}.
+  # 
+  # @param [String] string
+  # @return [self]
+  # 
+  def self.from_s string
+    strings = {}
+    segments = string.split '/'
+    
+    if segments[-1].include? ':'
+      rest, _, tag = segments[-1].rpartition ':'
+      strings[:tag] = tag
+      segments[-1] = rest
+    else
+      rest = string
+    end
+    
+    case segments.length
+    when 0
+      # Pass - construction will error
+    when 1
+      # Just a name
+      strings[:name] = segments[0]
+    else
+      if segments[0].include? ':'
+        # segments = [s_0, s_1, ... s_n]
+        #   =>  repository = s_0
+        #       segments = [s_1, s_2, ... s_n]
+        # 
+        # like
+        # 
+        # segments = ['docker.beiarea.com:8888', 'beiarea', 'wall']
+        #   =>  registry_server = 'docker.beiarea.com'
+        #       port            = '8888'
+        #       segments        = ['beiarea', 'wall']
+        # 
+        registry_server, _, port = segments.shift.rpartition ':'
+        strings[:registry_server] = registry_server
+        strings[:port] = port
+      end
+      
+      if segments.length > 1
+        # segments = [s_0, s_1, ... s_m]
+        #   =>  repository  = s_0
+        #       segments    = [s_1, s_2, ... s_m]
+        # 
+        # like
+        # 
+        # segments = ['beiarea', 'wall']
+        #   =>  repository  = 'beiarea'
+        #       segments    = ['wall']
+        # 
+        repository = segments.shift
+        strings[:repository] = repository
+      end
+      
+      # I think Docker image names *can* have more than just a repo and name
+      # segment, though it's poorly supported from what I recall... though
+      # we will handle it by just re-joining whatever's left into the name.
+      # 
+      # segments = [s_0, s_1, ... s_p]
+      #   =>  name = "s_0/s_1/.../s_p"
+      # 
+      # like
+      # 
+      # segments = ['wall']
+      #   =>  name = 'wall'
+      # 
+      # or
+      # 
+      # segments = ['www_rails', 'web']
+      #   =>  name = 'www_rails/web'
+      # 
+      strings[:name] = segments.join '/'
+    end
+    
+    logger.debug "strings", strings
+    
+    # Now turn them into value using their prop types
+    values = strings.transform_values_with_keys { |name, string|
+      prop = metadata[name]
+      
+      if prop.type.respond_to? :from_s
+        prop.type.from_s string
+      else
+        string
+      end
+    }
+    
+    logger.debug "values", values
+    
+    # And construct!
+    new source: string, **values
+  end # .from_s
+  
+  
+  # Get an instance from a source.
+  # 
+  # @param [self | String | Hash] source
+  # @return [self]
+  # 
+  def self.from source
+    t.match source,
+      self,     source,
+      t.str,    method( :from_s ),
+      t.hash_,  method( :from_data )
+  end # .from
+  
+  
+  # Queries
+  # --------------------------------------------------------------------------
+  
+  # @see QB::Docker::CLI.image_named?
+  # 
+  def self.exists? name
+    QB::Docker::CLI.image_named? name
+  end # .exists?
+  
+  
+  # @see QB::Docker::CLI.image_names
+  # 
+  +QB::Util::Decorators::NoPropsInKwds
+  def self.list *args, **opts
+    QB::Docker::CLI.image_names *args, **opts
+  end # .list
+  
+  singleton_class.send :alias_method, :all, :list
+  
+  
+  # Props
+  # ======================================================================
+  
+  # @!attribute [r] source
+  #   Source string this name was loaded from, if any.
+  #   
+  #   @return [String?]
+  #   
+  prop  :source,
+        type: t.non_empty_str?
+  
+  
+  # @!attribute [r] name
+  #   For lack of a better name, the part of the name that's not anything
+  #   else. It's also the only required part.
+  #   
+  #   @return [String]
+  #     Can't be empty.
+  # 
+  prop  :name,
+        type: t.non_empty_str
+  
+  
+  # @!attribute [r] repository
+  #   The repository name, if any.
+  #   
+  #   @return [String?]
+  #     String is non-empty.
+  prop  :repository,
+        type: t.non_empty_str?
+  
+  
+  # @!attribute [r] registry_server
+  #   Registry server, if any.
+  #   
+  #   @return [String?]
+  #     String is non-empty.
+  prop  :registry_server,
+        type: t.non_empty_str?
+  
+  
+  # @!attribute [r] port
+  #   Registry server port, if any.
+  #   
+  #   @return [Integer?]
+  #     In range [1, 2**16 - 1]
+  prop  :port,
+        type: t.port?
+  
+  
+  prop  :tag,
+        type: t.maybe( QB::Docker::Image::Tag )
+  
+  
+  prop  :string,
+        type: t.non_empty_str,
+        source: :to_s
+  
+  
+  invariant t.attrs( registry_server: t.nil, port: t.nil ) |
+            t.attrs( registry_server: ~t.nil, port: ~t.nil )
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  # Does the name exist in the local daemon?
+  # 
+  # @see QB::Docker::CLI.image_named?
+  # 
+  # @return [Boolean]
+  # 
+  def exists?
+    QB::Docker::CLI.image_named? self
+  end # #exist?
+  
+  alias_method :exist?, :exists?
+  
+  
+  # @todo Document dirty? method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def dirty?
+    !!tag.try( :dirty? )
+  end # #dirty?
+  
+  
+  def host
+    "#{ registry_server }:#{ port }" if registry_server && port
+  end
+  
+  
+  def formatted
+    [
+      host,
+      repository,
+      name,
+    ].compact.join( '/' ).thru { |without_tag|
+      if tag
+        "#{ without_tag }:#{ tag }"
+      else
+        without_tag
+      end
+    }
+  end
+  
+  
+  def to_s
+    formatted
+  end
+  
+  
+  def inspect
+    "#<#{ self.class.safe_name } #{ to_s }>"
+  end
+  
+  
+  def pretty_print q
+    q.text inspect
+  end
+  
+  
+end; end; end; end # class QB::Docker::Image::Name