dockerun 0.3.5 → 0.4.0

data/lib/dockerun/dsl.rb

@@ -0,0 +1,291 @@
+
+require_relative 'config'
+require_relative 'dfile'
+require_relative 'docker_cli'
+
+require_relative 'cli/command_factory'
+
+module Dockerun
+  module DSL
+    include TR::CondUtils
+
+    def config(&block)
+      _config.instance_eval(&block) 
+    end
+
+    def set_dry_run_mode(bool = true, prompt = false)
+      _config.dry_run(bool, prompt)
+    end
+
+    # Main DSL for dockerfile related configurations
+    def from(base_image, &block)
+      _dfile.base_image = base_image
+      _dfile.instance_eval(&block) 
+    end
+
+    # Additional dockerfile configurations for example
+    # if user did not specify the image name, better generate 
+    # by system so that it can be traced for subsequent functions
+    # later such as delete image
+    def dockerfile_patch(&block)
+      _file.instance_eval(&block)
+    end
+
+    # Main DSL for docker cli
+    def up(&block)
+      _docker_cli.instance_eval(&block)
+    end
+
+    # Trigger point to start the ball rolling!
+    def go
+
+      # Link context with Dockerfile and docker cli
+      if not_empty?(_config.active_context)
+        self.listener do |ops, *val|
+          _config.active_context.call(ops, *val)
+        end
+
+        _dfile.listener do |ops, *val|
+          _config.active_context.call(ops, *val)
+        end
+
+        _docker_cli.listener do |ops, *val|
+          _config.active_context.call(ops, *val)
+        end
+      end
+
+      # give chance to context to verify the integrity of the
+      # workspace before proceed
+      trigger_listener(:dsl_before_go, self)
+
+      # check if image exist?
+      if not image_exist?
+        logger.debug "Image doesn't exist... proceed to build the image"
+        # if not exist, build the image giving the name
+        st, res = build_image
+        if st
+          trigger_listener(:dsl_image_built, self)
+          #puts " Image '#{image_name}' built successfully"
+        else
+          trigger_listener(:dsl_image_building_failed, self)
+          raise Error, " Image '#{image_name}' failed to be built. Error was : #{res.err_lines.join("\n")}"
+        end
+      else
+        logger.debug "Image exist... skipped image building..."
+      end
+
+      # check if container exist?
+      if container_exist?
+        trigger_listener(:dsl_before_start_container, self)
+        logger.debug "Container exist... Starting container..."
+        # container exist, start the container
+        start_container
+
+        trigger_listener(:dsl_before_attach_container, self)
+        logger.debug "Container started... attaching container..."
+        # attach to container
+        attach_container
+        trigger_listener(:dsl_after_attach_container, self)
+      else
+        trigger_listener(:dsl_before_run_container, self)
+        logger.debug "Container does not exist. Creating new container..."
+        # Container does not exist, run the container
+        run_container
+      end
+    
+    end
+
+
+    def image_name
+      if _dfile.is_image_name_given?
+        _dfile.image_name
+      else
+        _dfile.generated_image_name
+      end
+    end
+
+    def container_name
+      if _docker_cli.is_container_name_given?
+        _docker_cli.container_name
+      else
+        _docker_cli.generated_container_name
+      end
+    end
+
+
+    def listener(&block)
+      @listener = block
+    end
+
+
+    private
+    def _config
+      if @_config.nil?
+        @_config = Config.new
+      end
+      @_config
+    end
+
+    def _dfile
+      if @_dfile.nil?
+        @_dfile = Dfile.new(_config)
+      end
+      @_dfile
+    end
+
+    def _docker_cli
+      if @_docker_cli.nil?
+        @_docker_cli = DockerCli.new(_config, _dfile)
+      end
+      @_docker_cli
+    end
+
+    def docker_cf
+      if @_docker_cf.nil?
+        @_docker_cf = Dockerun::Cli::CommandFactory.new
+      end
+      @_docker_cf
+    end
+
+    def trigger_listener(evt, *args, &block)
+      if not @listener.nil?
+        @listener.call(evt, *args, &block)
+      end
+    end
+
+    # flag to bridge between script and eval mode
+    def mark_go_done
+      @_go_done = true
+    end
+    def is_go_done?
+      @_go_done.nil? ? false : @_go_done
+    end
+    # end flag
+
+    def image_exist?
+      fact = docker_cf.find_image(image_name)
+      if _config.is_dry_run?
+        dry_run_puts "Find Image : #{fact.to_s}"
+        dry_run_puts "Find Image : Returning false to allow image build"
+        false
+      else
+        res = docker_cf.find_image(image_name).run
+        res.success? and not_empty?(res.output_lines)
+      end
+    end
+
+    def build_image
+      dfile = _dfile.generate
+      dfileName = "Dockerfile-#{SecureRandom.hex(4)}"
+      File.open(dfileName,"w") do |f|
+        f.write dfile
+      end
+
+      fact = docker_cf.build_image(image_name, dockerfile: dfileName)
+      if _config.is_dry_run?
+        dry_run_puts "Build Image : #{fact.to_s}"
+        dry_run_puts "Build Image : Returning true to proceed to next phase."
+        dry_run_puts "Generated dockerfile '#{dfileName}' shall be remained in project directory."
+        [true, nil]
+      else
+        res = fact.run
+        if res.success?
+          FileUtils.rm(dFileName) if not _dfile.keep_dockerfile?
+          [true, res]
+        else
+          [false, res]
+        end
+      end
+    end
+
+
+    def container_exist?
+      if _docker_cli.keep_container?
+        fact = docker_cf.find_from_all_container(container_name)
+        if _config.is_dry_run?
+          dry_run_puts "Is container exist? : #{fact.to_s}"
+          dry_run_puts "Returning false to allow container build"
+          false
+        else
+          res = fact.run
+          res.success? and not_empty?(res.output_lines)
+        end
+      else
+        remove_container
+        false
+      end
+    end
+
+    def remove_container
+      fact = docker_cf.find_from_all_container(container_name)
+      res = fact.run
+      if res.success?
+        res.output_lines.each do |ci|
+          docker_cf.stop_container(ci).run
+          r = docker_cf.delete_container(ci).run
+          logger.debug "Delete container : #{r.success?} / #{r.success? ? r.output_lines.join("\n") : r.err_lines.join("\n")}"
+        end
+      else
+        logger.debug "Failed to find all container by name '#{container_name}'"
+      end
+    end
+
+    def start_container
+      fact = docker_cf.find_running_container(container_name)
+      fact2 = docker_cf.start_container(container_name)
+
+      if _config.is_dry_run?
+        dry_run_puts "Find running container : #{fact.to_s}"
+        dry_run_puts "Start container : #{fact2.to_s}"
+        [true, nil]
+      else
+        res = fact.run
+        if res.success? and not_empty?(res.output_lines)
+          # already running so ignore
+          [true, res]
+        else
+          res2 = fact2.run
+          [res2.success?, res2]
+        end
+      end
+    end
+
+    def attach_container
+      fact = docker_cf.attach_container(container_name)
+      if _config.is_dry_run?
+        dry_run_puts "Attach container : #{fact.to_s}"
+      else
+        fact.run 
+      end
+      #docker_cf.attach_container(container_name).run
+    end
+
+    def run_container
+
+      params = { interactive: _docker_cli.is_interactive?, tty: _docker_cli.is_interactive?, del: !_docker_cli.keep_container?, container_name: container_name, match_user: _config.set_current_user?, command: _docker_cli.command_to_be_run, mounts: _docker_cli.mounts }
+
+      params[:ports] = {} if params[:ports].nil?
+      params[:ports].merge!(_docker_cli.expose_ports) if _docker_cli.has_exposed_ports? 
+
+      params = _docker_cli.trigger_listener(:docker_cli_construct_command, params)
+
+      fact = docker_cf.create_container_from_image(image_name, params)
+      if _config.is_dry_run?
+        dry_run_puts "Run container : #{fact.to_s}"
+      else
+        fact.run 
+      end
+    end
+    
+
+    def dry_run_puts(msg)
+      puts "[DryRun] #{msg}" if _config.is_dry_run_prompt?
+    end
+
+
+    def logger
+      Dockerun.logger(:dockerun_dsl)
+    end
+
+  end
+end

data/lib/dockerun/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dockerun
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

data/lib/dockerun.rb

@@ -3,41 +3,48 @@
 require 'toolrack'
 require 'teLogger'
 
-require 'colorize'
-require 'tty/prompt'
+require 'tty/command'
+require 'tty/which'
 
 require_relative "dockerun/version"
+require_relative 'dockerun/dsl'
 
-require_relative 'dockerun/command/dockerun'
-require_relative 'dockerun/command/init'
-require_relative 'dockerun/command/run'
-require_relative 'dockerun/command/reset_image'
-require_relative 'dockerun/command/run_new_container'
-require_relative 'dockerun/command/remove_container'
-require_relative 'dockerun/command/run_new_image'
-require_relative 'dockerun/command/stop_container'
-
-require_relative 'dockerun/template/template_writer'
-require_relative 'dockerun/template/template_engine'
+require_relative 'dockerun/cli_engine'
 
 module Dockerun
+  include TR::CondUtils
+
   class Error < StandardError; end
   # Your code goes here...
 
-  def self.udebug(msg)
-    logger.tdebug(:dockerun, msg) if is_user_debug_on?
-  end
-
-  def self.logger
+  def self.logger(tag = nil, &block)
     if @_logger.nil?
-      @_logger = TeLogger::Tlogger.new
+      drLogout = ENV["DR_LOGOUT"]
+      if is_empty?(drLogout)
+        @_logger = TeLogger::Tlogger.new('dockerun.log',5, 5*1024*1024)
+      else
+        @_logger = TeLogger::Tlogger.new(drLogout, 5, 5*1024*1024)
+      end
     end
-    @_logger
-  end
 
-  def self.is_user_debug_on?
-    val = ENV["DOCKERUN_DEBUG"]
-    (not val.nil? and val == "true")
+    if block
+      if not_empty?(tag)
+        @_logger.with_tag(tag, &block)
+      else
+        @_logger.with_tag(@_logger.tag, &block)
+      end
+    else
+      if is_empty?(tag)
+        @_logger.tag = :dockerun
+        @_logger
+      else
+        # no block but tag is given? hmm
+        @_logger.tag = tag
+        @_logger
+      end
+    end
   end
 
+
+
 end

data/sig/dockerun.rbs

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

metadata

@@ -1,169 +1,158 @@
 --- !ruby/object:Gem::Specification
 name: dockerun
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
-- Ian
+- Chris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: toolrack
+  name: teLogger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: teLogger
+  name: toolrack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: tty-command
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: tty-option
+  name: tty-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: tty-which
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: docker-cli
+  name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: devops_assist
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: release-gem
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: ''
 email:
-- cameronian0@protonmail.com
+- chris@antrapol.com
 executables:
 - dockerun
 extensions: []
 extra_rdoc_files: []
 files:
-- ".release_history.yml"
 - ".rspec"
-- Dockerfile.dockerun
-- Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- dockerun.gemspec
+- Rakefile.bak
+- dockerspec.sample
+- dockerun.gemspec.bak
 - exe/dockerun
 - lib/dockerun.rb
-- lib/dockerun/bundler_helper.rb
-- lib/dockerun/cli_prompt.rb
-- lib/dockerun/command/dockerun.rb
-- lib/dockerun/command/init.rb
-- lib/dockerun/command/remove_container.rb
-- lib/dockerun/command/reset_image.rb
-- lib/dockerun/command/run.rb
-- lib/dockerun/command/run_new_container.rb
-- lib/dockerun/command/run_new_image.rb
-- lib/dockerun/command/stop_container.rb
+- lib/dockerun/cli/command.rb
+- lib/dockerun/cli/command_factory.rb
+- lib/dockerun/cli/command_result.rb
+- lib/dockerun/cli/delete_container.rb
+- lib/dockerun/cli/delete_image.rb
+- lib/dockerun/cli/run.rb
+- lib/dockerun/cli/user_info.rb
+- lib/dockerun/cli_engine.rb
 - lib/dockerun/config.rb
-- lib/dockerun/docker_command_factory_helper.rb
-- lib/dockerun/docker_container_helper.rb
-- lib/dockerun/docker_image_helper.rb
-- lib/dockerun/template/general_template_writer.rb
-- lib/dockerun/template/jruby_template_writer.rb
-- lib/dockerun/template/template_engine.rb
-- lib/dockerun/template/template_writer.rb
-- lib/dockerun/user_info.rb
+- lib/dockerun/context/rubygems.rb
+- lib/dockerun/dfile.rb
+- lib/dockerun/docker_cli.rb
+- lib/dockerun/dsl.rb
 - lib/dockerun/version.rb
-- template/Dockerfile_general.erb
-- template/setup_ruby_devenv.rb.erb
+- sig/dockerun.rbs
 homepage: ''
 licenses: []
 metadata: {}
@@ -175,14 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: ''

data/.release_history.yml

@@ -1,56 +0,0 @@
----
-dockerun:
-- :version: 0.1.0
-  :timestamp: 1670316183.6472232
-- :version: 0.1.1
-  :timestamp: 1670316312.4779773
-- :version: 0.1.2
-  :timestamp: 1670322141.4019918
-- :version: 0.1.3
-  :timestamp: 1670322571.6620317
-- :version: 0.1.4
-  :timestamp: 1670322830.4816852
-- :version: 0.1.5
-  :timestamp: 1670421296.0570104
-- :version: 0.1.6
-  :timestamp: 1670421483.0685005
-- :version: 0.1.7
-  :timestamp: 1670557200.7343419
-- :version: 0.1.8
-  :timestamp: 1670557489.8592377
-- :version: 0.1.9
-  :timestamp: 1670557778.5624037
-- :version: 0.1.10
-  :timestamp: 1670579289.0579133
-- :version: 0.1.11
-  :timestamp: 1670640649.1748028
-- :version: 0.1.12
-  :timestamp: 1670640902.591357
-- :version: 0.1.13
-  :timestamp: 1670649972.645625
-- :version: 0.1.14
-  :timestamp: 1670677180.3442845
-- :version: 0.1.15_mac
-  :timestamp: 1679552032.751968
-- :version: 0.1.15
-  :timestamp: 1679980468.4161575
-- :version: 0.1.16
-  :timestamp: 1680096788.8148112
-- :version: 0.1.17
-  :timestamp: 1680413747.3876462
-- :version: 0.1.18
-  :timestamp: 1680413850.243007
-- :version: 0.2.0
-  :timestamp: 1680589830.9123309
-- :version: 0.2.1
-  :timestamp: 1680590987.4122827
-- :version: 0.2.2
-  :timestamp: 1680591256.174102
-- :version: 0.3.0
-  :timestamp: 1680596019.8479326
-- :version: 0.3.1
-  :timestamp: 1680596515.6388657
-- :version: 0.3.3
-  :timestamp: 1680598096.8177018
-- :version: 0.3.4
-  :timestamp: 1680600334.3304904