dctl_rb 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f9cb75fb8f24b8b22b9f1e226f45da72fef196b334150046acaa8822fd2162a
-  data.tar.gz: 0a44b4bf225e0840c4bff65bccbd1fcd8eb4e0beb640541672d42cf7375d8381
+  metadata.gz: 891e4ebdd5366c0525f1e5d50fddf2fb5351594a1b284580e782b1ab5865d7a1
+  data.tar.gz: 6555744900318c5e7b881c34e0ec09702f3980ffa81865ec1801e713293474f2
 SHA512:
-  metadata.gz: 48751f5d3c40ee9c6b4b6fc304cc9dc31f34f42b8d6270650ff9f00c7512beb3f1145e9c9fa40726b3f1ff4183bf79464b3b82836eee900c49e91970cf412652
-  data.tar.gz: ec7073f18dacaa43c6f9593347368cc4e67f0a32920cca8b9915128657dc0eda1205bb156c0628b975018f84553d972838aa993cb920e4ab300b88173702d255
+  metadata.gz: 38501937b88ebeb904280fed31f5abbf58856212a538e8695d13c503c528d77a933aeaa10cb5edd7704413ee26d8165997e777afc28d7c7eeaca3eaf411b94cb
+  data.tar.gz: c0f7f9419517cea03fe5a4d9357c176952b8580869d826dccd5335901e563048debd2d51494065b577d46d8e014b6dfaf014bcb64b64aa3daa315b0392b3103a

data/.travis.yml

@@ -1,8 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-- 2.4.0
-before_install: gem install bundler -v 1.16.0
+- 2.4
+- 2.5
+before_install:
+- gem install bundler -v 1.16.0
+- bundle config mirror.https://rubygems.org https://gems.jutonz.com
 deploy:
   provider: rubygems
   api_key:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dctl_rb (0.12.0)
+    dctl_rb (0.13.0)
       config (>= 1, < 2)
       rainbow (>= 2.2, < 3)
       rake (~> 12)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -43,14 +43,14 @@ GEM
       dry-equalizer (~> 0.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
-    dry-validation (0.12.1)
+    dry-validation (0.12.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
       dry-core (~> 0.2, >= 0.2.1)
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
       dry-types (~> 0.13.1)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rainbow (2.2.2)

data/README.md

@@ -127,7 +127,20 @@ docker
   * `project` (required)
 
 ### Optional keys
-  * none yet
+  * `custom_commands`
+    * This is basically a set of aliases you can add if you happen to be running the same commands again and again
+    
+    For instance, if initially creating your database requires two commands, you can add an alias to make it just one:
+    ```yaml
+    custom_commands:
+      migrate:
+      - dctl run --rm psql initdb
+      - dctl run --rm app mix ecto.setup
+    ```
+    
+    Now you can just run `dctl migrate` and it will run the commands in the order you specified.
+    
+    This just shells out, so you can also add any stuff you'd normally do in bash.
 
 ## Development
 

data/exe/dctl

@@ -21,7 +21,6 @@ module Dctl
     class_option :host, type: :string
 
     desc "build", "Build images. Pass image name to build a specific one; otherwise builds all"
-    option :pull, type: :boolean, desc: "Pull before building (same as docker build --pull)"
     option :cache_from, type: :string
     option :cache_from_self, type: :boolean, desc: "Uses the tag being built " \
       "as the cache source. Useful for rebuilding images where the cache is " \
@@ -48,7 +47,6 @@ module Dctl
         dockerfile = dctl.image_dockerfile(image)
 
         build_opts = %W(-f=#{dockerfile} -t=#{tag})
-        build_opts << "--pull=true" if options[:pull]
         build_opts << "--cache-from=#{tag}" if options[:cache_from_self]
         build_opts << extra_args
         if options[:cache_from]
@@ -61,7 +59,7 @@ module Dctl
           build_opts << "--cache-from=#{options[:cache_from]}"
         end
 
-        commands << "#{sudo}docker #{docker_opts} build #{build_opts.join(" ")} ."
+        commands << docker_command("build", *build_opts, ".")
       end
 
       stream_output commands.join(" && "), exec: true
@@ -75,7 +73,7 @@ module Dctl
 
       images.each do |image|
         tag = dctl.image_tag(image)
-        push_cmds << "#{sudo}docker #{docker_opts} push #{tag}"
+        push_cmds << docker_command("push", tag)
       end
 
       push_cmd = push_cmds.join " && "
@@ -87,17 +85,17 @@ module Dctl
     def pull(*images)
       dctl   = Dctl::Main.new env: dctl_env
       images = dctl.expand_images *images
-      pull_cmds = []
+      pull_commands = []
 
       images.each do |image|
         opts = {}
         opts[:version] = options[:version] if options[:version]
         tag = dctl.image_tag(image, opts)
-        pull_cmds << "#{sudo}docker #{docker_opts} pull #{tag}"
+        pull_commands << docker_command("pull", tag)
       end
 
-      pull_cmd = pull_cmds.join " && "
-      stream_output pull_cmd, exec: true
+      pull_command = pull_commands.join " && "
+      stream_output pull_command, exec: true
     end
 
     desc "up", "Start your dockerized app server"
@@ -108,13 +106,13 @@ module Dctl
       FileUtils.rm pidfile if File.exist? pidfile
 
       compose_opts = %w(--remove-orphans)
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} up #{compose_opts.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} up #{compose_opts.join(" ")}", exec: true
     end
 
     desc "down", "Stop one or many containers"
     def down(*images)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} down #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} down #{images.join(" ")}", exec: true
     end
 
     desc "rm", "Remove one or many containers"
@@ -122,44 +120,44 @@ module Dctl
     def rm(*images)
       dctl = Dctl::Main.new env: dctl_env
       opts = " --force" if options[:force]
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} rm#{opts} #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} rm#{opts} #{images.join(" ")}", exec: true
     end
 
     desc "start", "Start one or many containers"
     def start(*images)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} start #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} start #{images.join(" ")}", exec: true
     end
 
     desc "stop", "Stop one or many containers"
     def stop(*images)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} stop #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} stop #{images.join(" ")}", exec: true
     end
 
     desc "restart", "Restart one or many containers"
     def restart(*images)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} restart #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} restart #{images.join(" ")}", exec: true
     end
 
     desc "create", "Bring an image up without starting it"
     def create(*images)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} up --no-start #{images.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} up --no-start #{images.join(" ")}", exec: true
     end
 
     desc "run [IMAGE] [COMMAND]", "Run a command on the given image"
     def runcmd(image, *commands)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} run #{image} #{commands.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} run #{image} #{commands.join(" ")}", exec: true
     end
 
     desc "exec [IMAGE] [COMMAND]", "Execute a command on the given _running_ image"
     map exec: :_exec # avoid overwriting Kernel#exec
     def _exec(image, *commands)
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} exec #{image} #{commands.join(" ")}", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} exec #{image} #{commands.join(" ")}", exec: true
     end
 
     desc "recreate", "Stop, remove, build, create, and start a container"
@@ -176,13 +174,13 @@ module Dctl
     desc "ps", "List running containers for this environment"
     def ps
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} ps", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} ps", exec: true
     end
 
-    desc "release IMAGE", "Increase the version number for the given image"
-    def release(image)
+    desc "bump IMAGE", "Increase the version number for the given image"
+    def bump(image)
       dctl = Dctl::Main.new env: dctl_env
-      dctl.release(image)
+      dctl.bump(image)
     end
 
     desc "initdb", "Setup initial postgres database"
@@ -190,9 +188,9 @@ module Dctl
       dctl = Dctl::Main.new env: dctl_env
       env = dctl_env
       local_data_dir = File.expand_path "../tmp/psql-#{env}", __FILE__
-      `#{sudo}rm -r #{local_data_dir}` if File.exists? local_data_dir # todo prompt
+      `#{sudo} rm -r #{local_data_dir}` if File.exists? local_data_dir # todo prompt
 
-      cmd = "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} run --rm psql /bin/bash -c /etc/initdb.sh"
+      cmd = "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} run --rm psql /bin/bash -c /etc/initdb.sh"
 
       stream_output cmd, exec: true
     end
@@ -201,7 +199,7 @@ module Dctl
     option :keep, type: :numeric, default: -1, desc: "How many old images to keep around, e.g. \"3\" will keep the current version plus the three next most recent. Use -1 to keep all."
     def cleanup
       to_remove = []
-      to_remove += `#{sudo}docker images --filter dangling=true -q`.split("\n")
+      to_remove += `#{docker_command("images", "--filter dangling=true", "-q")}`.split("\n")
 
       if options[:keep] != -1
         keep_last = options[:keep]
@@ -211,8 +209,14 @@ module Dctl
           keep_after_tag = current_version - keep_last
 
           next if keep_after_tag < 0
-
-          cmd = "#{sudo}docker #{docker_opts} images #{dctl.image_tag(image, version: nil)} --filter before=#{dctl.image_tag(image, version: keep_after_tag)} -q"
+          cmd = docker_command()
+
+          cmd = docker_command(
+            "images",
+            dctl.image_tag(image, version: nil),
+            "--filter before=#{dctl.image_tag(image, version: keep_after_tag)}",
+            "-q"
+          )
           puts Rainbow(cmd).fg CMD_COLOR
           stdout, stderr, status = Open3.capture3(cmd)
           if status.success?
@@ -221,9 +225,13 @@ module Dctl
             # Specified before filter did not exist on current machine. Loop
             # through all old images to manually reconstruct.
             Array(0..keep_after_tag).each do |version|
-              cmd = "#{sudo}docker images #{dctl.image_tag(image, version: version)} -q"
-              puts Rainbow(cmd).fg CMD_COLOR
-              image_id = `#{cmd}`.strip
+              command = docker_command(
+                "images",
+                dctl.image_tag(image, version: version),
+                "-q"
+              )
+              puts Rainbow(command).fg CMD_COLOR
+              image_id = `#{command}`.strip
               to_remove << image_id unless image_id.empty?
             end
           end
@@ -235,13 +243,13 @@ module Dctl
         exit 0
       end
 
-      stream_output "#{sudo}docker rmi -f #{to_remove.join(" ")}", exec: true
+      stream_output "#{sudo} docker rmi -f #{to_remove.join(" ")}", exec: true
     end
 
     desc "bash CONTAINER", "Create a new instance of the given image with a bash prompt"
     def bash(container = "app")
       dctl = Dctl::Main.new env: dctl_env
-      cmd = "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} run --rm #{container} /bin/bash"
+      cmd = "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} run --rm #{container} /bin/bash"
 
       stream_output cmd, exec: true
     end
@@ -249,7 +257,7 @@ module Dctl
     desc "connect CONTAINER", "Connect to a running container."
     def connect(image = "app")
       dctl = Dctl::Main.new env: dctl_env
-      stream_output "#{sudo}docker-compose #{docker_opts} -f #{dctl.compose_file_path} exec #{image} /bin/bash", exec: true
+      stream_output "#{sudo} docker-compose #{docker_opts} -f #{dctl.compose_file_path} exec #{image} /bin/bash", exec: true
     end
 
     desc "attach CONTAINER", "Connect to a running container."
@@ -258,7 +266,7 @@ module Dctl
       dctl = Dctl::Main.new env: dctl_env
       tag = dctl.image_tag(image)
 
-      cmd = "#{sudo}docker #{docker_opts} ps --filter ancestor=#{image} -aq | head -n1"
+      cmd = "#{sudo} docker #{docker_opts} ps --filter ancestor=#{image} -aq | head -n1"
       puts cmd
       container = `#{cmd}`.chomp
 
@@ -267,7 +275,7 @@ module Dctl
         exit 1
       end
 
-      stream_output "#{sudo}docker attach #{container}", exec: true
+      stream_output "#{sudo} docker attach #{container}", exec: true
     end
 
     desc "version", "Print version"
@@ -298,7 +306,7 @@ module Dctl
 
       def sudo
         return "" if !ENV["DCTL_NOSUDO"].nil?
-        `uname`.chomp == "Darwin" ? "" : "sudo " # use sudo on linux hosts
+        `uname`.chomp == "Darwin" ? "" : "sudo" # use sudo on linux hosts
       end
 
       # Support both --env and DCTL_ENV, but prefer --env if both are present
@@ -306,6 +314,14 @@ module Dctl
         options[:env] || ENV["DCTL_ENV"] || "dev"
       end
 
+      def docker_command(*args)
+        build_command(sudo, "docker", docker_opts, *args)
+      end
+
+      def build_command(*args)
+        args.reject(&:nil?).reject(&:empty?).join(" ")
+      end
+
       # Allow passsing additional docker args without us having to implement
       # each one manually, e.g. `dctl build app -- --pull`
       def extract_extra_args(images)
@@ -326,10 +342,12 @@ module Dctl
         host ||= !ENV["DOCKER_HOST"].nil? ? ENV["DOCKER_HOST"] : nil
         opts << "--host #{host}" if host
 
-        opts.join " "
+        opts.join(" ")
       end
     end
   end
 end
 
+dctl = Dctl::Main.new
+dctl.define_custom_commands(Dctl::Cli)
 Dctl::Cli.start ARGV

data/lib/dctl/main.rb

@@ -2,9 +2,9 @@ module Dctl
   class Main
     attr_reader :env, :settings
 
-    def initialize(env: "dev")
+    def initialize(env: "dev", config: nil)
       @env = env
-      load_config!
+      load_config!(config)
     end
 
     ##
@@ -51,7 +51,7 @@ module Dctl
       images
     end
 
-    def release(image)
+    def bump(image)
       check_image(image)
 
       parsed  = parsed_compose_file
@@ -149,6 +149,18 @@ module Dctl
       @parsed_compose_file ||= YAML.load_file compose_file_path
     end
 
+    ##
+    # If there are user defined commands in .dctl.yml, dynamically add them to
+    # the passed thor CLI so they may be executed.
+    def define_custom_commands(klass)
+      Array(settings.custom_commands).each do |command, args|
+        klass.send(:desc, command, "[Custom Command] #{command}")
+        klass.send(:define_method, command, -> do
+          Array(args).each { |a| stream_output(a) }
+        end)
+      end
+    end
+
     ##
     # Ensure the current project's .dctl.yml contains all the requisite keys.
     def check_settings!
@@ -171,8 +183,8 @@ module Dctl
     ##
     # Load the current project's config file, complaining if it does not exist
     # or is malformed.
-    def load_config!
-      Config.load_and_set_settings(config_path)
+    def load_config!(custom_config_path = nil)
+      Config.load_and_set_settings(custom_config_path || config_path)
       check_settings!
 
       @settings = Settings

data/lib/dctl/version.rb

@@ -1,3 +1,3 @@
 module Dctl
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dctl_rb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Justin Toniazzo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler