dockerun 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a6fc97935e5777962a76188ad3a39923ce84b9363c494c7a59c37d6888baff
-  data.tar.gz: db4d15767b81528d7d0c208bb8d7924e5e11d84aed610e0ccf037cfb39f2c6b5
+  metadata.gz: 559986ed3ba91c19f9fa98cac1b46079e75a5306c4ca248e261c976eb57def34
+  data.tar.gz: 493efa6425fe0eabff6c3ac0f7980c897d7b1a5bf9df874b7b702c60e7a7ba65
 SHA512:
-  metadata.gz: 6166715ddc5e72fa1f319563ef03a3472ce561e2e72000c73336196a06a59a08b2e6c7fb37fb9567bb58a374dc72ea8f16c49816b4040dfb148c2b924c47393e
-  data.tar.gz: 01df6c0dfa95436c1439f6870bdba7cc942f600c44e75ff16b63682a10cd7cd081ff399b603f0cb163fc31ff95c90e4fd95139bc47babb6498eb08b6ffdb58a2
+  metadata.gz: 99ec2c396bd249a0f5554364a43e6275e77d27ce52586f237b3a1053a78e0c14aa8ea611b7de90cb9cc402bdd86c93aaec08db8fda53fdb8fd12c3af10fc95b2
+  data.tar.gz: ee2a130624310ce35d760684846b4f167e4eb2632190fe5874a2a68695b1d199716257f276ab98d73f62b399d18622c4bb7a77547da84b37bd02d9a76b1024d4

data/dockerspec.sample

@@ -35,6 +35,9 @@ config do
   # Docker image is not built and container is not created
   #dry_run
 
+  # generate the docker runscript so it can be run manually
+  # if required
+  gen_docker_runscript
 
 end
 
@@ -93,7 +96,7 @@ up do
   # Command to be run in docker
   #run_in_docker "/bin/bash"
 
-  # Map port of docker to host
+  # Map port of on host => on docker
   #port 3080 => 3000
 end
 

data/exe/dockerun

@@ -2,6 +2,8 @@
 
 require_relative '../lib/dockerun'
 
+require 'colorize'
+
 # Operations
 # 1. [i]nit - Copy sample spec into project dir
 # 2. [r]un - Run the spec (default without params)
@@ -10,5 +12,10 @@ require_relative '../lib/dockerun'
 # 5. reset - Delete container and image
 
 cli = Dockerun::CliEngine.new
-cli.parse_argv(ARGV)
+begin
+  cli.parse_argv(ARGV)
+rescue TR::ArgUtils::RequiredFieldEmpty => ex
+  STDERR.puts "\n Operation requires parameter. Error was : #{ex.message}".red
+  puts cli.parse_argv(["help"])
+end
 

data/lib/dockerun/cli/command.rb

@@ -17,12 +17,12 @@ module Dockerun
       attr_accessor :command_buffer
       def initialize(cmd, required_interaction = false)
         
-        cmdOut = ENV["DOCKERUN_COMMAND_OUT"]
-        if not_empty?(cmdOut)
-          @runner = TTY::Command.new(printer: cmdOut.to_sym)
-        else
-          @runner = TTY::Command.new(printer: :null)
-        end
+        #cmdOut = ENV["DOCKERUN_COMMAND_OUT"]
+        #if not_empty?(cmdOut)
+        #  @runner = TTY::Command.new(printer: cmdOut.to_sym)
+        #else
+        #  @runner = TTY::Command.new(printer: :null)
+        #end
 
         #@runner = TTY::Command.new
         @command_buffer = cmd
@@ -34,7 +34,7 @@ module Dockerun
         @required_interaction
       end
 
-      def run(&block)
+      def run(log_console = false, &block)
 
         if interactive_session?
           
@@ -88,7 +88,14 @@ module Dockerun
         else
           @outStream = []
           @errStream = []
-          result = @runner.run!(@command_buffer.join(" "))  do |out, err|
+
+          if(log_console)
+            runner = TTY::Command.new(printer: :pretty)
+          else
+            runner = TTY::Command.new(printer: :null)
+          end
+
+          result = runner.run!(@command_buffer.join(" "))  do |out, err|
             if block
               block.call(:outstream, out)
               block.call(:errstream, err)

data/lib/dockerun/cli/command_factory.rb

@@ -13,6 +13,7 @@ module Dockerun
 
         opts = {  } if opts.nil?
         cmd = []
+        cmd << "cd #{opts[:working_dir]} && " if not_empty?(opts[:working_dir])
         cmd << DockerCli.docker_exe
         cmd << "build"
         if not_empty?(name)
@@ -168,6 +169,7 @@ module Dockerun
         Command.new(cmd, (interactive ? true : false))
       end # run_container_from_image
 
+
       def start_container(container, opts = { })
 
         opts = {} if opts.nil?
@@ -181,6 +183,7 @@ module Dockerun
         Command.new(cmd)
       end
 
+
       def attach_container(container, opts = { })
 
         opts = {} if opts.nil?

data/lib/dockerun/cli/delete_container.rb

@@ -9,7 +9,12 @@ module Dockerun
 
     class DeleteContainer
 
-      def start
+      def initialize
+        @proxy = DSLProxy.new
+      end
+
+      def start(root)
+        @proxy.set_exec_root(root)
         begin
           pmt.puts " Dockerun version #{Dockerun::VERSION}".yellow
           pmt.puts " Operational : Delete Container"
@@ -19,23 +24,22 @@ module Dockerun
       end
 
       def delete_container
-        selSpec = CliEngine.select_spec
+        selSpec = CliEngine.select_spec(@proxy.exec_root)
         cont = File.read(selSpec)
-        proxy = DSLProxy.new
-        proxy.set_dry_run_mode
-        proxy.instance_eval(cont)
+        @proxy.set_dry_run_mode
+        @proxy.instance_eval(cont)
 
-        skip = pmt.no?(" Delete container named '#{proxy.container_name}'?")
+        skip = pmt.no?(" Delete container named '#{@proxy.container_name}'?")
         if not skip
-          cf.stop_container(proxy.container_name).run
-          res = cf.delete_container(proxy.container_name).run
+          cf.stop_container(@proxy.container_name).run
+          res = cf.delete_container(@proxy.container_name).run
           if res.success?
-            pmt.puts " Container '#{proxy.container_name}' deleted".green
+            pmt.puts " Container '#{@proxy.container_name}' deleted".green
           else
-            pmt.puts " Container '#{proxy.container_name}' deletion failed. Error was : #{res.err_lines.join("\n")}".red
+            pmt.puts " Container '#{@proxy.container_name}' deletion failed. Error was : #{res.err_lines.join("\n")}".red
           end
         else
-          pmt.puts " Container deletion of name '#{proxy.container_name}' aborted.".yellow
+          pmt.puts " Container deletion of name '#{@proxy.container_name}' aborted.".yellow
         end
       end
 

data/lib/dockerun/cli/delete_image.rb

@@ -10,7 +10,12 @@ module Dockerun
     class DeleteImage
       include TR::CondUtils
 
-      def start
+      def initialize
+        @proxy = DSLProxy.new
+      end
+
+      def start(root)
+        @proxy.set_exec_root(root)
         begin
           pmt.puts " Dockerun version #{Dockerun::VERSION}".yellow
           pmt.puts " Operational : Delete Image"
@@ -20,20 +25,19 @@ module Dockerun
       end
 
       def delete_image
-        selSpec = CliEngine.select_spec
+        selSpec = CliEngine.select_spec(@proxy.exec_root)
         cont = File.read(selSpec)
-        proxy = DSLProxy.new
-        proxy.set_dry_run_mode
-        proxy.instance_eval(cont)
+        @proxy.set_dry_run_mode
+        @proxy.instance_eval(cont)
 
-        res = cf.find_image(proxy.image_name).run
+        res = cf.find_image(@proxy.image_name).run
         if res.success?
           if not_empty?(res.output_lines)
 
-            skip = pmt.no?(" Delete image named '#{proxy.image_name}'?")
+            skip = pmt.no?(" Delete image named '#{@proxy.image_name}'?")
             if not skip
-              res = cf.find_container_names_by_image_name(proxy.image_name, all_containers: true).run
-              raise Error, "Failed to extract container name by image name '#{proxy.image_name}'" if not res.success?
+              res = cf.find_container_names_by_image_name(@proxy.image_name, all_containers: true).run
+              raise Error, "Failed to extract container name by image name '#{@proxy.image_name}'" if not res.success?
 
               if not_empty?(res.output_lines)
                 cont = []
@@ -41,45 +45,45 @@ module Dockerun
                 res.output_lines.each do |l|
                   cont << " #{cnt += 1}. #{l}"
                 end
-                skip = pmt.no?(" All the containers shall be deleted prior to image '#{proxy.image_name}' deletion. Proceed?\n#{cont.join("\n")}")
+                skip = pmt.no?(" All the containers shall be deleted prior to image '#{@proxy.image_name}' deletion. Proceed?\n#{cont.join("\n")}")
                 if not skip
                   res.output_lines.each do |ci|
                     cf.stop_container(ci).run
                     cf.delete_container(ci).run
                   end
 
-                  res = cf.delete_image(proxy.image_name).run
+                  res = cf.delete_image(@proxy.image_name).run
                   if res.success?
-                    pmt.puts " Image '#{proxy.image_name}' deleted".green
+                    pmt.puts " Image '#{@proxy.image_name}' deleted".green
                   else
-                    raise Error, " Image '#{proxy.image_name}' deletion failed. Error was : #{res.err_lines.join("\n")}"
+                    raise Error, " Image '#{@proxy.image_name}' deletion failed. Error was : #{res.err_lines.join("\n")}"
                   end
 
                 else
-                  pmt.puts " Delete of image '#{proxy.image_name}' aborted".yellow
+                  pmt.puts " Delete of image '#{@proxy.image_name}' aborted".yellow
                 end
 
               else
-                res = cf.delete_image(proxy.image_name).run
+                res = cf.delete_image(@proxy.image_name).run
                 if res.success?
-                  pmt.puts " Image '#{proxy.image_name}' deleted".green
+                  pmt.puts " Image '#{@proxy.image_name}' deleted".green
                 else
-                  raise Error, " Image '#{proxy.image_name}' deletion failed. Error was : #{res.err_lines.join("\n")}"
+                  raise Error, " Image '#{@proxy.image_name}' deletion failed. Error was : #{res.err_lines.join("\n")}"
                 end
 
               end
 
             else
-              pmt.puts " Delete of image '#{proxy.image_name}' aborted".yellow
+              pmt.puts " Delete of image '#{@proxy.image_name}' aborted".yellow
 
             end
 
           else
-            pmt.puts " Image '#{proxy.image_name}' does not exist".green
+            pmt.puts " Image '#{@proxy.image_name}' does not exist".green
           end
 
         else
-          pmt.puts " Failed to find image '#{proxy.image_name}'. Error was : #{res.err_lines.join("\n")}"
+          pmt.puts " Failed to find image '#{@proxy.image_name}'. Error was : #{res.err_lines.join("\n")}"
         end
       end
 

data/lib/dockerun/cli/run.rb

@@ -8,7 +8,8 @@ module Dockerun
       #include TR::ArgUtils
       include DSL
 
-      def start
+      def start(root)
+        set_exec_root(root)
         begin
           pmt.puts " Dockerun version #{Dockerun::VERSION}".yellow
           pmt.puts " Operational : Run Spec"
@@ -20,7 +21,7 @@ module Dockerun
 
       private
       def load_spec
-        selSpec = CliEngine.select_spec
+        selSpec = CliEngine.select_spec(exec_root)
         pmt.puts " Loading spec '#{selSpec}"
         cont = File.read(selSpec)
         self.instance_eval(cont)

data/lib/dockerun/cli_engine.rb

@@ -9,26 +9,26 @@ module Dockerun
     include TR::ArgUtils
 
     arg_spec do
-      opt "i", "Initialize sample dockerspec at current directory" do
-        init
+      opt "i", "Initialize sample dockerspec at given directory as next argument" do |v|
+        init(v)
       end
       opt_alias "i", "init"
 
-      opt "r", "Run the dockerspec" do 
-        run
+      opt "r", "Run the dockerspec at given directory as next argument" do |v|
+        run(v)
       end
       opt_alias "r","run"
 
-      opt "dc", "Delete container" do
-        delete_container
+      opt "dc", "Delete container at given directory as next argument" do |v|
+        delete_container(v)
       end
 
-      opt "di", "Delete image and its associated container(s)" do
-        delete_image
+      opt "di", "Delete image and its associated container(s) at given directory as next argument" do |v|
+        delete_image(v)
       end
 
-      opt 'clean', "Clean generated Dockerfile and temporary files" do
-        clean_env
+      opt 'clean', "Clean generated Dockerfile and temporary files at given directory as next argument" do |v|
+        clean_env(v)
       end
 
       opt 'help', "Command help" do
@@ -49,8 +49,11 @@ module Dockerun
       pmt.puts ""
     end
 
-    def self.select_spec
-      sel = Dir.entries(Dir.getwd).sort
+    def self.select_spec(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+
+      #sel = Dir.entries(Dir.getwd).sort
+      sel = Dir.entries(root).sort
       default = sel.select { |e| (e =~ /^dockerspec/) != nil }
       selSpec = pmt.select(" Please select the dockerspec to proceed : ", filter: true, default: default.first) do |m|
         sel.each do |s|
@@ -63,34 +66,49 @@ module Dockerun
     end
 
 
-    def init
+    def init(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+
+      root = File.expand_path(root)
       template = File.join(File.dirname(__FILE__),"..","..","dockerspec.sample")        
       if File.exist?(template)
-        FileUtils.cp template, File.join(Dir.getwd, "dockerspec.sample")
+        #FileUtils.cp template, File.join(Dir.getwd, "dockerspec.sample")
+        FileUtils.cp template, File.join(root, "dockerspec.sample")
       end
     end
 
-    def run
+    def run(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+
+      root = File.expand_path(root)
       r = Dockerun::Cli::Run.new
-      r.start
+      r.start(root)
     end
 
-    def delete_container
+    def delete_container(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+      root = File.expand_path(root)
       d = Dockerun::Cli::DeleteContainer.new
-      d.start
+      d.start(root)
     end
 
-    def delete_image
+    def delete_image(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+      root = File.expand_path(root)
       d = Dockerun::Cli::DeleteImage.new
-      d.start
+      d.start(root)
     end
 
-    def clean_env
-      Dir.glob("Dockerfile-*").each do |f|
+    def clean_env(root)
+      raise InsufficientParameter, "Given path cannot be empty or nil" if is_empty?(root)
+      root = File.expand_path(root)
+
+      Dir.glob(File.join(root,"Dockerfile-*")).each do |f|
         FileUtils.rm(f)
       end
-      FileUtils.rm("script_for_gem.sh") if File.exist?("script_for_gem.sh")
-      self.class.pmt.puts " Generated Dockerfile-* and script_for_gem.sh is deleted".green
+      pa = File.join(root,"script_for_gem.sh")
+      FileUtils.rm(pa) if File.exist?(pa)
+      self.class.pmt.puts " Generated Dockerfile-* and script_for_gem.sh is deleted at '#{root}'".green
     end
 
     def self.pmt

data/lib/dockerun/config.rb

@@ -52,6 +52,18 @@ module Dockerun
       @active_context
     end
 
+ 
+    def gen_docker_runscript(bool = true, overwrite = false)
+      @_gen_docker_runscript = bool 
+      @_overwrite_docker_runscript = overwrite
+    end
+    def is_gen_docker_runscript?
+      @_gen_docker_runscript.nil? ? false : @_gen_docker_runscript
+    end
+    def is_overwrite_docker_runscript?
+      @_overwrite_docker_runscript.nil? ? false : @_overwrite_docker_runscript
+    end
+   
 
     def dry_run(bool = true, prompt = true)
       @dry_run = bool 

data/lib/dockerun/dfile.rb

@@ -113,6 +113,7 @@ module Dockerun
       if not skip_update? or not skip_upgrade?
         st = []
         st << "#{pkgMgr} update" if not skip_update?
+        st << "#{pkgMgr} install -y apt-transport-https"
         st << "#{pkgMgr} -y upgrade" if not skip_upgrade?
         cont << "RUN #{st.join(" && ")}" if not_empty?(st)
         cont << ""

data/lib/dockerun/dsl.rb

@@ -9,6 +9,13 @@ module Dockerun
   module DSL
     include TR::CondUtils
 
+    def set_exec_root(root)
+      @_exec_root = root
+    end
+    def exec_root
+      @_exec_root
+    end
+
     def config(&block)
       _config.instance_eval(&block) 
     end
@@ -176,19 +183,30 @@ module Dockerun
 
     def build_image
       dfile = _dfile.generate
-      dfileName = "Dockerfile-#{SecureRandom.hex(4)}"
+      dfileName = File.join(exec_root,"Dockerfile-#{SecureRandom.hex(4)}")
       File.open(dfileName,"w") do |f|
         f.write dfile
       end
 
-      fact = docker_cf.build_image(image_name, dockerfile: dfileName)
+      fact = docker_cf.build_image(image_name, dockerfile: dfileName, working_dir: exec_root)
+
+      if _config.is_gen_docker_runscript?
+        out = File.join(exec_root,"1.build-image.sh")
+        if (not File.exist?(out)) or _config.is_overwrite_docker_runscript?
+          File.open(out, "w") do |f|
+            f.puts "#!/bin/sh"
+            f.puts fact.to_s
+          end
+        end
+      end
+
       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
+        res = fact.run(true)
         if res.success?
           FileUtils.rm(dFileName) if not _dfile.keep_dockerfile?
           [true, res]
@@ -234,6 +252,16 @@ module Dockerun
       fact = docker_cf.find_running_container(container_name)
       fact2 = docker_cf.start_container(container_name)
 
+      if _config.is_gen_docker_runscript?
+        out = File.join(exec_root,"3.start-container.sh")
+        if (not File.exist?(out)) or _config.is_overwrite_docker_runscript?
+          File.open(out, "w") do |f|
+            f.puts "#!/bin/sh"
+            f.puts fact.to_s
+          end
+        end
+      end
+
       if _config.is_dry_run?
         dry_run_puts "Find running container : #{fact.to_s}"
         dry_run_puts "Start container : #{fact2.to_s}"
@@ -252,12 +280,23 @@ module Dockerun
 
     def attach_container
       fact = docker_cf.attach_container(container_name)
+
+      if _config.is_gen_docker_runscript?
+        out = File.join(exec_root,"4.attach-container.sh")
+        if (not File.exist?(out)) or _config.is_overwrite_docker_runscript?
+          File.open(out, "w") do |f|
+            f.puts "#!/bin/sh"
+            f.puts fact.to_s
+          end
+        end
+      end
+      
       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
@@ -267,9 +306,21 @@ module Dockerun
       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)
+      rparams = _docker_cli.trigger_listener(:docker_cli_construct_command, params)
+      rparams = params if is_empty?(rparams)
+
+      fact = docker_cf.create_container_from_image(image_name, rparams)
+
+      if _config.is_gen_docker_runscript?
+        out = File.join(exec_root,"2.create-container.sh")
+        if (not File.exist?(out)) or _config.is_overwrite_docker_runscript?
+          File.open(out, "w") do |f|
+            f.puts "#!/bin/sh"
+            f.puts fact.to_s
+          end
+        end
+      end
 
-      fact = docker_cf.create_container_from_image(image_name, params)
       if _config.is_dry_run?
         dry_run_puts "Run container : #{fact.to_s}"
       else

data/lib/dockerun/version.rb

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

data/lib/dockerun.rb

@@ -15,6 +15,7 @@ module Dockerun
   include TR::CondUtils
 
   class Error < StandardError; end
+  class InsufficientParameter < StandardError; end
   # Your code goes here...
 
   def self.logger(tag = nil, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerun
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Chris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: teLogger