dip 7.3.1 → 7.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60d7a15f7de7909f0e61a3e3f9ca8112cf2a94cf21bccfb813be9a209f83e2db
-  data.tar.gz: d9dd72eff516119adb097147dd566ae1688fed731153617e81d16ed8eb9c54a1
+  metadata.gz: be7ef96533ac533734f04b61b49864b8db104269813c5dd00d8192d968c0c1dd
+  data.tar.gz: 74d31efceda6300bd5f93023f5a108c3a9972d2b4416d0e4433e98f7ec76f61e
 SHA512:
-  metadata.gz: 5e7d3fb075dea8f3be052cbcc8bde8083fd9c967dbce8ab852aefc5ba21bc885f787794dbaf81b68bf5a5e282d7272b6a4495ab567df305e70845e1b5dd14d00
-  data.tar.gz: 07e3051d76cd9a7af8a51422024c6865feb2b2c7cf59f1865a1d162a133d513565c9a4214cfa8441291694ba85a9e8562bb98a95cd392839d5d69a7a90f70982
+  metadata.gz: aafe6a31332d687c065c29e34d3c8fdc69bdc6c0507aa4a4c1d3fc1c68d5ded516c4f52e2b7092b34cf585a3ceb9f69ad4a6b764a41863ea090323d5b0a5b2c2
+  data.tar.gz: 6d801682b927567b84f07a0f7df75535d35ac1f11a953f286cc9785a8d415d55d5940b72a68365d2cafaa13e02b9aafa01f6f58282a41e2c37546274553fbf74

data/README.md

@@ -30,14 +30,15 @@ Dip can be injected into the current shell (ZSH or Bash).
 eval "$(dip console)"
 ```
 
+**IMPORTANT**: Beware of possible collisions with local tools. One particular example is supporting both local and Docker frontend build tools, such as Yarn. If you want some developer to run `yarn` locally and other to use Docker for that, you should either avoid adding the `yarn` command to the `dip.yml` or avoid using the shell integration for hybrid development.
+
 After that we can type commands without `dip` prefix. For example:
 
 ```sh
 <run-command> *any-args
 compose *any-compose-arg
 up <service>
-build
-down
+ktl *any-kubectl-arg
 provision
 ```
 
@@ -79,10 +80,11 @@ Also, you can check out examples at the top.
 
 ```yml
 # Required minimum dip version
-version: '7.1'
+version: '7.5'
 
 environment:
   COMPOSE_EXT: development
+  STAGE: "staging"
 
 compose:
   files:
@@ -91,6 +93,9 @@ compose:
     - docker/docker-compose.$DIP_OS.yml
   project_name: bear
 
+kubectl:
+  namespace: rocket-$STAGE
+
 interaction:
   shell:
     description: Open the Bash shell in app's container
@@ -140,6 +145,22 @@ interaction:
     default_args: db_dev
     command: psql -h pg -U postgres
 
+  k:
+    description: Run commands in Kubernetes cluster
+    pod: svc/rocket-app:app-container
+    entrypoint: /env-entrypoint
+    subcommands:
+      bash:
+        description: Get a shell to the running container
+        command: /bin/bash
+      rails:
+        description: Run Rails commands
+        command: bundle exec rails
+      kafka-topics:
+        description: Manage Kafka topics
+        pod: svc/rocket-kafka
+        command: kafka-topics.sh --zookeeper zookeeper:2181
+
   setup_key:
     description: Copy key
     service: app
@@ -199,7 +220,13 @@ returned is `/app/sub-project-dir`.
 
 Run commands defined within the `interaction` section of dip.yml
 
-By default, a command will be executed using [`docker compose`](https://docs.docker.com/compose/install/) command. If you are still using `docker-compose` binary (i.e., prior to Compose V2 changes), a command would be run through it. You can disable using of Compose V2 by passing an environment variable `DIP_COMPOSE_V2=false dip run`.
+A command will be executed by specified runner. Dip has three types of them:
+
+- `docker-compose` runner — used when the `service` option is defined.
+- `kubectl` runner — used when the `pod` option is defined.
+- `local` runner — used when the previous ones are not defined.
+
+If you are still using `docker-compose` binary (i.e., prior to Compose V2 changes), a command would be run through it. You can disable using of Compose V2 by passing an environment variable `DIP_COMPOSE_V2=false dip run`.
 
 ```sh
 dip run rails c
@@ -252,7 +279,7 @@ Run commands each by each from `provision` section of dip.yml
 
 ### dip compose
 
-Run docker-compose commands that are configured according to the application's dip.yml :
+Run docker-compose commands that are configured according to the application's dip.yml:
 
 ```sh
 dip compose COMMAND [OPTIONS]
@@ -260,6 +287,16 @@ dip compose COMMAND [OPTIONS]
 dip compose up -d redis
 ```
 
+### dip ktl
+
+Run kubectl commands that are configured according to the application's dip.yml:
+
+```sh
+dip ktl COMMAND [OPTIONS]
+
+STAGE=some dip ktl get pods
+```
+
 ### dip ssh
 
 Runs ssh-agent container based on https://github.com/whilp/ssh-agent with your ~/.ssh/id_rsa.

data/lib/dip/cli.rb

@@ -32,7 +32,7 @@ module Dip
       end
     end
 
-    stop_on_unknown_option! :run
+    stop_on_unknown_option! :run, :ktl
 
     desc "version", "dip version"
     def version
@@ -69,11 +69,26 @@ module Dip
     end
 
     desc "down [OPTIONS]", "Run `docker-compose down` command"
+    method_option :help, aliases: "-h", type: :boolean, desc: "Display usage information"
+    method_option :all, aliases: "-A", type: :boolean, desc: "Shutdown all running docker-compose projects"
     def down(*argv)
-      compose("down", *argv)
+      if options[:help]
+        invoke :help, ["down"]
+      elsif options[:all]
+        require_relative "commands/down_all"
+        Dip::Commands::DownAll.new.execute
+      else
+        compose("down", *argv)
+      end
     end
 
-    desc "run [OPTIONS] CMD [ARGS]", "Run configured command in a docker-compose service. `run` prefix may be omitted"
+    desc "ktl CMD [OPTIONS]", "Run kubectl commands"
+    def ktl(*argv)
+      require_relative "commands/kubectl"
+      Dip::Commands::Kubectl.new(*argv).execute
+    end
+
+    desc "run [OPTIONS] CMD [ARGS]", "Run configured command (`run` prefix may be omitted)"
     method_option :publish, aliases: "-p", type: :string, repeatable: true,
       desc: "Publish a container's port(s) to the host"
     method_option :help, aliases: "-h", type: :boolean, desc: "Display usage information"
@@ -82,7 +97,11 @@ module Dip
         invoke :help, ["run"]
       else
         require_relative "commands/run"
-        Dip::Commands::Run.new(*argv, publish: options[:publish]).execute
+
+        Dip::Commands::Run.new(
+          *argv,
+          **options.to_h.transform_keys!(&:to_sym)
+        ).execute
       end
     end
 

data/lib/dip/commands/down_all.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+
+module Dip
+  module Commands
+    class DownAll < Dip::Command
+      def execute
+        exec_subprocess(
+          "docker rm --volumes $(docker stop $(docker ps --filter 'label=com.docker.compose.project' -q))"
+        )
+      end
+    end
+  end
+end

data/lib/dip/commands/kubectl.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+
+module Dip
+  module Commands
+    class Kubectl < Dip::Command
+      attr_reader :argv, :config
+
+      def initialize(*argv)
+        @argv = argv
+        @config = ::Dip.config.kubectl || {}
+      end
+
+      def execute
+        k_argv = cli_options + argv
+
+        exec_program("kubectl", k_argv)
+      end
+
+      private
+
+      def cli_options
+        %i[namespace].flat_map do |name|
+          next unless (value = config[name])
+          next unless value.is_a?(String)
+
+          value = ::Dip.env.interpolate(value).delete_suffix("-")
+          ["--#{name.to_s.tr("_", "-")}", value]
+        end.compact
+      end
+    end
+  end
+end

data/lib/dip/commands/run.rb

@@ -4,13 +4,17 @@ require "shellwords"
 require_relative "../../../lib/dip/run_vars"
 require_relative "../command"
 require_relative "../interaction_tree"
-require_relative "compose"
+require_relative "runners/local_runner"
+require_relative "runners/docker_compose_runner"
+require_relative "runners/kubectl_runner"
+
+require_relative "kubectl"
 
 module Dip
   module Commands
     class Run < Dip::Command
-      def initialize(cmd, *argv, publish: nil)
-        @publish = publish
+      def initialize(cmd, *argv, **options)
+        @options = options
 
         @command, @argv = InteractionTree
           .new(Dip.config.interaction)
@@ -22,75 +26,25 @@ module Dip
       end
 
       def 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
+        lookup_runner
+          .new(command, argv, **options)
+          .execute
       end
 
       private
 
-      attr_reader :command, :argv, :publish
-
-      def compose_arguments
-        compose_argv = command[:compose][:run_options].dup
-
-        if command[:compose][:method] == "run"
-          compose_argv.concat(run_vars)
-          compose_argv.concat(published_ports)
-          compose_argv << "--rm"
-        end
-
-        compose_argv << command.fetch(:service)
-
-        unless (cmd = command[:command]).empty?
-          if command[:shell]
-            compose_argv << cmd
-          else
-            compose_argv.concat(cmd.shellsplit)
-          end
-        end
-
-        compose_argv.concat(get_args)
-
-        compose_argv
-      end
-
-      def run_vars
-        run_vars = Dip::RunVars.env
-        return [] unless run_vars
-
-        run_vars.map { |k, v| ["-e", "#{k}=#{Shellwords.escape(v)}"] }.flatten
-      end
-
-      def published_ports
-        if publish.respond_to?(:each)
-          publish.map { |p| "--publish=#{p}" }
-        else
-          []
-        end
-      end
+      attr_reader :command, :argv, :options
 
-      def get_args
-        if argv.any?
-          if command[:shell]
-            [argv.shelljoin]
-          else
-            Array(argv)
-          end
-        elsif !(default_args = command[:default_args]).empty?
-          if command[:shell]
-            default_args.shellsplit
-          else
-            Array(default_args)
-          end
+      def lookup_runner
+        if (runner = command[:runner])
+          camelized_runner = runner.split("_").collect(&:capitalize).join
+          Runners.const_get("#{camelized_runner}Runner")
+        elsif command[:service]
+          Runners::DockerComposeRunner
+        elsif command[:pod]
+          Runners::KubectlRunner
         else
-          []
+          Runners::LocalRunner
         end
       end
     end

data/lib/dip/commands/runners/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Dip
+  module Commands
+    module Runners
+      class Base
+        def initialize(command, argv, **options)
+          @command = command
+          @argv = argv
+          @options = options
+        end
+
+        def execute
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :command, :argv, :options
+
+        def command_args
+          if argv.any?
+            if command[:shell]
+              [argv.shelljoin]
+            else
+              Array(argv)
+            end
+          elsif !(default_args = command[:default_args]).empty?
+            if command[:shell]
+              default_args.shellsplit
+            else
+              Array(default_args)
+            end
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dip/commands/runners/docker_compose_runner.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../compose"
+
+module Dip
+  module Commands
+    module Runners
+      class DockerComposeRunner < Base
+        def execute
+          Commands::Compose.new(
+            command[:compose][:method],
+            *compose_arguments,
+            shell: command[:shell]
+          ).execute
+        end
+
+        private
+
+        def compose_arguments
+          compose_argv = command[:compose][:run_options].dup
+
+          if command[:compose][:method] == "run"
+            compose_argv.concat(run_vars)
+            compose_argv.concat(published_ports)
+            compose_argv << "--rm"
+          end
+
+          compose_argv << command.fetch(:service)
+
+          unless (cmd = command[:command]).empty?
+            if command[:shell]
+              compose_argv << cmd
+            else
+              compose_argv.concat(cmd.shellsplit)
+            end
+          end
+
+          compose_argv.concat(command_args)
+
+          compose_argv
+        end
+
+        def run_vars
+          run_vars = Dip::RunVars.env
+          return [] unless run_vars
+
+          run_vars.map { |k, v| ["-e", "#{k}=#{Shellwords.escape(v)}"] }.flatten
+        end
+
+        def published_ports
+          publish = options[:publish]
+
+          if publish.respond_to?(:each)
+            publish.map { |p| "--publish=#{p}" }
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dip/commands/runners/kubectl_runner.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../kubectl"
+
+module Dip
+  module Commands
+    module Runners
+      class KubectlRunner < Base
+        def execute
+          Commands::Kubectl.new(*kubectl_arguments).execute
+        end
+
+        private
+
+        def kubectl_arguments
+          argv = ["exec", "--tty", "--stdin"]
+
+          pod, container = command.fetch(:pod).split(":")
+          argv.push("--container", container) unless container.nil?
+          argv.push(pod, "--")
+
+          unless (entrypoint = command[:entrypoint]).nil?
+            argv << entrypoint
+          end
+          argv << command.fetch(:command)
+          argv.concat(command_args)
+
+          argv
+        end
+      end
+    end
+  end
+end

data/lib/dip/commands/runners/local_runner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../command"
+
+module Dip
+  module Commands
+    module Runners
+      class LocalRunner < Base
+        def execute
+          Dip::Command.exec_program(
+            command[:command],
+            command_args,
+            shell: command[:shell]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dip/config.rb

@@ -16,6 +16,7 @@ module Dip
     CONFIG_DEFAULTS = {
       environment: {},
       compose: {},
+      kubectl: {},
       interation: {},
       provision: []
     }.freeze
@@ -94,7 +95,7 @@ module Dip
       config
     end
 
-    %i[environment compose interaction provision].each do |key|
+    %i[environment compose kubectl interaction provision].each do |key|
       define_method(key) do
         config[key] || (raise config_missing_error(key))
       end

data/lib/dip/interaction_tree.rb

@@ -58,7 +58,10 @@ module Dip
     def build_command(entry)
       {
         description: entry[:description],
+        runner: entry[:runner],
         service: entry[:service],
+        pod: entry[:pod],
+        entrypoint: entry[:entrypoint],
         command: entry[:command].to_s.strip,
         shell: entry.fetch(:shell, true),
         default_args: entry[:default_args].to_s.strip,

data/lib/dip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dip
-  VERSION = "7.3.1"
+  VERSION = "7.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 7.3.1
+  version: 7.5.0
 platform: ruby
 authors:
 - bibendi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-07 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -179,10 +179,16 @@ files:
 - lib/dip/commands/compose.rb
 - lib/dip/commands/console.rb
 - lib/dip/commands/dns.rb
+- lib/dip/commands/down_all.rb
+- lib/dip/commands/kubectl.rb
 - lib/dip/commands/list.rb
 - lib/dip/commands/nginx.rb
 - lib/dip/commands/provision.rb
 - lib/dip/commands/run.rb
+- lib/dip/commands/runners/base.rb
+- lib/dip/commands/runners/docker_compose_runner.rb
+- lib/dip/commands/runners/kubectl_runner.rb
+- lib/dip/commands/runners/local_runner.rb
 - lib/dip/commands/ssh.rb
 - lib/dip/config.rb
 - lib/dip/environment.rb