dip 6.0.0 → 7.1.1

data/lib/dip/cli/ssh.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 require_relative "./base"
 require_relative "../commands/ssh"
 
@@ -8,25 +8,28 @@ module Dip
   class CLI
     class SSH < Base
       desc "up", "Run ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      method_option :key, aliases: '-k', type: :string, default: "$HOME/.ssh/id_rsa",
-                          desc: 'Path to ssh key'
-      method_option :volume, aliases: '-v', type: :string, default: "$HOME",
-                             desc: 'Mounted docker volume'
-      method_option :interactive, aliases: '-t', type: :boolean, default: true,
-                                  desc: 'Run in interactive mode'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :key, aliases: "-k", type: :string, default: "$HOME/.ssh/id_rsa",
+                          desc: "Path to ssh key"
+      method_option :volume, aliases: "-v", type: :string, default: "$HOME",
+                             desc: "Mounted docker volume"
+      method_option :interactive, aliases: "-t", type: :boolean, default: true,
+                                  desc: "Run in interactive mode"
+      method_option :user, aliases: "-u", type: :string,
+                           desc: "UID for ssh-agent container"
       # Backward compatibility
-      method_option :nonteractive, aliases: '-T', type: :boolean,
-                                   desc: 'Run in noninteractive mode'
+      method_option :nonteractive, aliases: "-T", type: :boolean,
+                                   desc: "Run in noninteractive mode"
       def up
         if options[:help]
-          invoke :help, ['up']
+          invoke :help, ["up"]
         else
           Dip::Commands::SSH::Up.new(
             key: options.fetch(:key),
             volume: options.fetch(:volume),
-            interactive: options.nonteractive? ? false : options.interactive?
+            interactive: options.nonteractive? ? false : options.interactive?,
+            user: options.user
           ).execute
         end
       end
@@ -34,22 +37,22 @@ module Dip
       map add: :up
 
       desc "down", "Stop ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def down
         if options[:help]
-          invoke :help, ['down']
+          invoke :help, ["down"]
         else
           Dip::Commands::SSH::Down.new.execute
         end
       end
 
       desc "restart", "Stop and start ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def restart(*args)
         if options[:help]
-          invoke :help, ['restart']
+          invoke :help, ["restart"]
         else
           Dip::CLI::SSH.start(["down"] + args)
           sleep 1
@@ -58,11 +61,11 @@ module Dip
       end
 
       desc "status", "Show status of ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def status
         if options[:help]
-          invoke :help, ['status']
+          invoke :help, ["status"]
         else
           Dip::Commands::SSH::Status.new.execute
         end

data/lib/dip/command.rb

@@ -6,35 +6,46 @@ module Dip
   class Command
     extend Forwardable
 
-    def_delegators self, :shell, :subshell
-
-    class ExecRunner
-      def self.call(cmd, argv, env: {}, **options)
-        ::Process.exec(env, cmd, *argv, options)
+    def_delegators self, :exec_program, :exec_subprocess
+
+    class ProgramRunner
+      def self.call(cmdline, env: {}, **options)
+        if cmdline.is_a?(Array)
+          ::Kernel.exec(env, cmdline[0], *cmdline[1..-1], **options)
+        else
+          ::Kernel.exec(env, cmdline, **options)
+        end
       end
     end
 
-    class SubshellRunner
-      def self.call(cmd, argv, env: {}, panic: true, **options)
-        return if ::Kernel.system(env, cmd, *argv, options)
-        raise Dip::Error, "Command '#{([cmd] + argv).join(' ')}' executed with error." if panic
+    class SubprocessRunner
+      def self.call(cmdline, env: {}, panic: true, **options)
+        return if ::Kernel.system(env, cmdline, **options)
+        raise Dip::Error, "Command '#{cmdline}' executed with error." if panic
       end
     end
 
     class << self
-      def shell(cmd, argv = [], subshell: false, **options)
+      def exec_program(*args, **kwargs)
+        run(ProgramRunner, *args, **kwargs)
+      end
+
+      def exec_subprocess(*args, **kwargs)
+        run(SubprocessRunner, *args, **kwargs)
+      end
+
+      private
+
+      def run(runner, cmd, argv = [], shell: true, **options)
         cmd = Dip.env.interpolate(cmd)
+        argv = [argv] if argv.is_a?(String)
         argv = argv.map { |arg| Dip.env.interpolate(arg) }
+        cmdline = [cmd, *argv].compact
+        cmdline = cmdline.join(" ").strip if shell
 
-        puts [Dip.env.vars, cmd, argv].inspect if Dip.debug?
-
-        runner = subshell ? SubshellRunner : ExecRunner
-        runner.call(cmd, argv, env: Dip.env.vars, **options)
-      end
+        puts [Dip.env.vars, cmdline].inspect if Dip.debug?
 
-      def subshell(*args, **kwargs)
-        kwargs[:subshell] = true
-        shell(*args, **kwargs)
+        runner.call(cmdline, env: Dip.env.vars, **options)
       end
     end
   end

data/lib/dip/commands/compose.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require 'pathname'
+require "pathname"
 
-require_relative '../command'
-require_relative 'dns'
+require_relative "../command"
+require_relative "dns"
 
 module Dip
   module Commands
     class Compose < Dip::Command
       DOCKER_EMBEDDED_DNS = "127.0.0.11"
 
-      attr_reader :argv, :config
+      attr_reader :argv, :config, :shell
 
-      def initialize(*argv)
+      def initialize(*argv, shell: true)
         @argv = argv
+        @shell = shell
         @config = ::Dip.config.compose || {}
       end
 
@@ -22,7 +23,7 @@ module Dip
 
         compose_argv = Array(find_files) + Array(cli_options) + argv
 
-        shell("docker-compose", compose_argv)
+        exec_program("docker-compose", compose_argv, shell: shell)
       end
 
       private
@@ -49,7 +50,7 @@ module Dip
           next unless value.is_a?(String)
 
           value = ::Dip.env.interpolate(value)
-          ["--#{name.to_s.gsub('_', '-')}", value]
+          ["--#{name.to_s.tr("_", "-")}", value]
         end.compact
       end
 
@@ -58,9 +59,9 @@ module Dip
         net = Dip.env["FRONTEND_NETWORK"] || "frontend"
 
         IO.pipe do |r, w|
-          Dip::Commands::DNS::IP.
-            new(name: name, net: net).
-            execute(out: w, err: File::NULL, panic: false)
+          Dip::Commands::DNS::IP
+            .new(name: name, net: net)
+            .execute(out: w, err: File::NULL, panic: false)
 
           w.close_write
           ip = r.readlines[0].to_s.strip

data/lib/dip/commands/console.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
@@ -13,9 +13,9 @@ module Dip
         private
 
         def script
-          <<-SH.gsub(/^[ ]{12}/, '')
+          <<-SH.gsub(/^ {12}/, "")
             export DIP_SHELL=1
-            export DIP_EARLY_ENVS=#{ENV.keys.join(',')}
+            export DIP_EARLY_ENVS=#{ENV.keys.join(",")}
             export DIP_PROMPT_TEXT="ⅆ"
 
             function dip_clear() {
@@ -88,7 +88,7 @@ module Dip
         def execute
           if Dip.config.exist?
             add_aliases(*Dip.config.interaction.keys) if Dip.config.interaction
-            add_aliases("compose", "up", "stop", "down", "provision")
+            add_aliases("compose", "up", "stop", "down", "provision", "build")
           end
 
           clear_aliases
@@ -107,7 +107,7 @@ module Dip
 
         def clear_aliases
           out << "function dip_clear() { \n" \
-                  "#{aliases.any? ? aliases.map { |a| "  unset -f #{a}" }.join("\n") : 'true'} " \
+                  "#{aliases.any? ? aliases.map { |a| "  unset -f #{a}" }.join("\n") : "true"} " \
                   "\n}"
         end
       end

data/lib/dip/commands/dns.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "shellwords"
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
@@ -17,20 +17,20 @@ module Dip
         end
 
         def execute
-          subshell("docker", "network create #{@net}".shellsplit, panic: false, err: File::NULL)
-          subshell("docker", "run #{container_args} #{@image} --domain=#{@domain}".shellsplit)
+          exec_subprocess("docker", "network create #{@net}", panic: false, err: File::NULL)
+          exec_subprocess("docker", "run #{container_args} #{@image} --domain=#{@domain}")
         end
 
         private
 
         def container_args
-          result = %w(--detach)
+          result = %w[--detach]
           result << "--volume #{@socket}:/var/run/docker.sock:ro"
           result << "--restart always"
           result << "--publish #{@publish}"
           result << "--net #{@net}"
           result << "--name #{@name}"
-          result.join(' ')
+          result.join(" ")
         end
       end
 
@@ -40,8 +40,8 @@ module Dip
         end
 
         def execute
-          subshell("docker", "stop #{@name}".shellsplit, panic: false, out: File::NULL, err: File::NULL)
-          subshell("docker", "rm -v #{@name}".shellsplit, panic: false, out: File::NULL, err: File::NULL)
+          exec_subprocess("docker", "stop #{@name}", panic: false, out: File::NULL, err: File::NULL)
+          exec_subprocess("docker", "rm -v #{@name}", panic: false, out: File::NULL, err: File::NULL)
         end
       end
 
@@ -52,11 +52,11 @@ module Dip
         end
 
         def execute(**options)
-          subshell("docker",
-                   "inspect " \
-                   "--format '{{ .NetworkSettings.Networks.#{@net}.IPAddress }}' " \
-                   "#{@name}".shellsplit,
-                   **options)
+          exec_subprocess(
+            "docker",
+            "inspect --format '{{ .NetworkSettings.Networks.#{@net}.IPAddress }}' #{@name}",
+            **options
+          )
         end
       end
     end

data/lib/dip/commands/list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-require_relative '../interaction_tree'
+require_relative "../command"
+require_relative "../interaction_tree"
 
 module Dip
   module Commands
@@ -12,7 +12,7 @@ module Dip
         longest_name = tree.keys.map(&:size).max
 
         tree.each do |name, command|
-          puts "#{name.ljust(longest_name)}  ##{command[:description] ? ' ' + command[:description] : ''}"
+          puts "#{name.ljust(longest_name)}  ##{command[:description] ? " #{command[:description]}" : ""}"
         end
       end
     end

data/lib/dip/commands/nginx.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "shellwords"
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
@@ -18,22 +18,22 @@ module Dip
         end
 
         def execute
-          subshell("docker", "network create #{@net}".shellsplit, panic: false, err: File::NULL)
-          subshell("docker", "run #{container_args} #{@image}".shellsplit)
+          exec_subprocess("docker", "network create #{@net}", panic: false, err: File::NULL)
+          exec_subprocess("docker", "run #{container_args} #{@image}")
         end
 
         private
 
         def container_args
-          result = %w(--detach)
+          result = %w[--detach]
           result << "--volume #{@socket}:/tmp/docker.sock:ro"
           result << "--volume #{@certs}:/etc/nginx/certs" unless @certs.to_s.empty?
           result << "--restart always"
-          result << Array(@publish).map { |p| "--publish #{p}" }.join(' ')
+          result << Array(@publish).map { |p| "--publish #{p}" }.join(" ")
           result << "--net #{@net}"
           result << "--name #{@name}"
           result << "--label com.dnsdock.alias=#{@domain}"
-          result.join(' ')
+          result.join(" ")
         end
       end
 
@@ -43,8 +43,8 @@ module Dip
         end
 
         def execute
-          subshell("docker", "stop #{@name}".shellsplit, panic: false, out: File::NULL, err: File::NULL)
-          subshell("docker", "rm -v #{@name}".shellsplit, panic: false, out: File::NULL, err: File::NULL)
+          exec_subprocess("docker", "stop #{@name}", panic: false, out: File::NULL, err: File::NULL)
+          exec_subprocess("docker", "rm -v #{@name}", panic: false, out: File::NULL, err: File::NULL)
         end
       end
     end

data/lib/dip/commands/provision.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
     class Provision < Dip::Command
       def execute
         Dip.config.provision.each do |command|
-          subshell(command)
+          exec_subprocess(command)
         end
       end
     end

data/lib/dip/commands/run.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'shellwords'
-require_relative '../../../lib/dip/run_vars'
-require_relative '../command'
-require_relative '../interaction_tree'
-require_relative 'compose'
+require "shellwords"
+require_relative "../../../lib/dip/run_vars"
+require_relative "../command"
+require_relative "../interaction_tree"
+require_relative "compose"
 
 module Dip
   module Commands
@@ -12,21 +12,25 @@ module Dip
       def initialize(cmd, *argv, publish: nil)
         @publish = publish
 
-        @command, @argv = InteractionTree.
-                          new(Dip.config.interaction).
-                          find(cmd, *argv)&.
-                          values_at(:command, :argv)
+        @command, @argv = InteractionTree
+          .new(Dip.config.interaction)
+          .find(cmd, *argv)&.values_at(:command, :argv)
 
-        raise Dip::Error, "Command `#{[cmd, *argv].join(' ')}` not recognized!" unless command
+        raise Dip::Error, "Command `#{[cmd, *argv].join(" ")}` not recognized!" unless command
 
         Dip.env.merge(command[:environment])
       end
 
       def execute
-        Dip::Commands::Compose.new(
-          command[:compose][:method],
-          *compose_arguments
-        ).execute
+        if command[:service].nil?
+          exec_program(command[:command], get_args, shell: command[:shell])
+        else
+          Dip::Commands::Compose.new(
+            command[:compose][:method],
+            *compose_arguments,
+            shell: command[:shell]
+          ).execute
+        end
       end
 
       private
@@ -44,11 +48,15 @@ module Dip
 
         compose_argv << command.fetch(:service)
 
-        unless (cmd = command[:command].to_s).empty?
-          compose_argv.concat(cmd.shellsplit)
+        unless (cmd = command[:command]).empty?
+          if command[:shell]
+            compose_argv << cmd
+          else
+            compose_argv.concat(cmd.shellsplit)
+          end
         end
 
-        compose_argv.concat(argv.any? ? argv : command[:default_args])
+        compose_argv.concat(get_args)
 
         compose_argv
       end
@@ -57,7 +65,7 @@ module Dip
         run_vars = Dip::RunVars.env
         return [] unless run_vars
 
-        run_vars.map { |k, v| ["-e", "#{k}=#{v}"] }.flatten
+        run_vars.map { |k, v| ["-e", "#{k}=#{Shellwords.escape(v)}"] }.flatten
       end
 
       def published_ports
@@ -67,6 +75,20 @@ module Dip
           []
         end
       end
+
+      def get_args
+        if argv.any?
+          argv
+        elsif !(default_args = command[:default_args]).empty?
+          if command[:shell]
+            default_args.shellsplit
+          else
+            Array(default_args)
+          end
+        else
+          []
+        end
+      end
     end
   end
 end