dctl_rb 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ae33aa0aa3f5d0dc263616ad547a5b41118e44fce672b40f411707e1534304
-  data.tar.gz: aa01e608aa311a94dd21fd105dd181a9ef05b684ef8acb3616c152972ee1450e
+  metadata.gz: cd25c95274d81568271c730fb7162171ee0e8a432ee451c2c9a8ea500ef4aba5
+  data.tar.gz: fc162add3502d9741b89eca1e67920da9a7775adfac89ab4b520e2b3422ef7c4
 SHA512:
-  metadata.gz: 0f2ba5b3e5f84856e83b1c6890218babb971b1d90e581af430ab7172d16c0f5360c94da7b8e20d2af46817ed9e0244b43ed0c530c58f35a50e84b958a74701d0
-  data.tar.gz: d1e0225c072033d0fb7aef0586dd0e7803bd4dc8a19eb51e498c38c73afe388931f019e1ae6514f8dcbf6338bb7c51d62744d90ebba566d2faefdde8b364bdc0
+  metadata.gz: 199f823503954b1ad893f930c202e6091fb0f5801cde315812826da5607adf38b29403c13ea212243786f6b92b9c08ece7aa925749f746889cfa95f09dc157c6
+  data.tar.gz: 155973810386b77f1a5e7654ccaf0a2dcb69153ee946611a7c4702f521320022ee814c0ccc7bec43dba837305e8494e42639dde3bcc2abc5ecb09529191f2bb9

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    dctl_rb (0.3.4)
+    dctl_rb (0.4.0)
       config (>= 1, < 2)
       rainbow (>= 2.2, < 3)
-      thor (>= 0.17.0)
+      thor (~> 0.17, >= 0.17.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -21,7 +21,10 @@ The default environment is `dev`, but you can override this with `--env prod` et
 * `dctl build`
 * `dctl push`
 * `dctl pull`
-
+* `dctl create`
+* `dctl rm`
+* `dctl restart`
+* `dctl ps`
 
 ### Targeting specific containers
 
@@ -36,17 +39,21 @@ Most commands also allow you to specify a specific image to target (defaulting t
 
 There are also some non-compose commands to make your life easier
 
-* `dctl connect app`
-  * Start a new shell in a running `app` container.
-* `dctl attach app`
-  * Attach your current TTY to that of the running `app` container.
+* `dctl connect [image]`
+  * Start a new shell in a running container.
+  * For instance, use `dctl connect app` to open a shell in your running `app` container.
+* `dctl attach [image]`
+  * Attach your current TTY to that of a running container.
   * This is useful if you've put a debugger or something similar and need to talk directly to a running container's current shell (docker-compose eats stdin/stdout/stderr so normally this isn't possible)
-* `dctl bash app`
-  * Spin up a new `app` image and drop you in a shell.
-* `dctl recreate app`
+* `dctl bash [image]`
+  * Spin up a new container using the given image and drop you in a shell.
+  * While `connect` (above) creates a shell in a container which is already running, `bash` creates an entirely new container (and also does not require your stack to already be up).
+* `dctl recreate [image]`
   * Stops, removes, builds, creates, and starts an image.
   * Useful if you've made a change to one container but don't want to restart your entire stack to have it reflected.
-  * Specify `--build false` (or `-b false`) if you don't want the image to be rebuilt.
+  * Options:
+    * `--build` (`-b`) (default `true`)
+      * Whether or not the image in question should be rebuilt before bringing it back up.
 * `dctl cleanup`
   * Useful for policing the large numbers of built-but-unused containers which tend to accumulate when using docker.
   * Removes local images without tags and which are not referenced by other images.

data/dctl_rb.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_dependency "thor", ">= 0.17.0"
+  spec.add_dependency "thor", "~> 0.17", ">= 0.17.0"
   spec.add_dependency "config", ">= 1", "< 2"
   spec.add_dependency "rainbow", ">= 2.2", "< 3"
 end

data/exe/dctl

@@ -12,18 +12,16 @@ module Dctl
 
     desc "build", "Build images. Pass image name to build a specific one; otherwise builds all"
     def build(*images)
-      load_config!
-      images = versions.keys if images.empty?
-      images = Array(images)
+      dctl   = Dctl::Main.new env: options[:env]
+      images = dctl.expand_images *images
       env    = options[:env]
 
       puts "Generating build script for #{images.join(", ")}"
       commands = []
 
       images.each do |image|
-        version    = versions[image]
-        tag        = "#{Settings.org}/#{Settings.project}-#{env}-#{image}:#{version}"
-        dockerfile = "docker/#{env}/#{image}/Dockerfile"
+        tag = dctl.image_tag(image)
+        dockerfile = dctl.image_dockerfile(image)
 
         commands << "#{sudo}docker #{docker_opts} build -f #{dockerfile} -t #{tag} ."
       end
@@ -33,20 +31,13 @@ module Dctl
 
     desc "push", "Upload locally built images to the remote store"
     def push(*images)
-      load_config!
-      images = versions.keys if images.empty?
-      images = Array(images)
-      env    = options[:env]
-
+      dctl   = Dctl::Main.new env: options[:env]
+      images = dctl.expand_images *images
       push_cmds = []
 
       images.each do |image|
-        version = versions[image]
-        tag_cmd = "#{sudo}docker tag #{Settings.org}/#{Settings.project}-#{env}-#{image}:#{version} #{Settings.org}/#{Settings.project}-#{env}-#{image}:latest"
-        puts tag_cmd
-        `#{tag_cmd}`
-
-        push_cmds << "#{sudo}docker push #{Settings.org}/#{Settings.project}-#{env}-#{image}:#{version}"
+        tag = dctl.image_tag(image)
+        push_cmds << "#{sudo}docker push #{tag}"
       end
 
       push_cmd = push_cmds.join " && "
@@ -55,16 +46,13 @@ module Dctl
 
     desc "pull", "Pull the latest remote images to your local machine"
     def pull(*images)
-      load_config!
-      images = versions.keys if images.empty?
-      images = Array(images)
-      env    = options[:env]
-
+      dctl   = Dctl::Main.new env: options[:env]
+      images = dctl.expand_images *images
       pull_cmds = []
 
       images.each do |image|
-        version = versions[image]
-        pull_cmds << "#{sudo}docker pull #{Settings.org}/#{Settings.project}-#{env}-#{image}:#{version}"
+        tag = dctl.image_tag(image)
+        pull_cmds << "#{sudo}docker pull #{tag}"
       end
 
       pull_cmd = pull_cmds.join " && "
@@ -73,51 +61,51 @@ module Dctl
 
     desc "up", "Start your dockerized app server"
     def up
-      load_config!
+      dctl = Dctl::Main.new env: options[:env]
 
       pidfile = "tmp/pids/server.pid"
       FileUtils.rm pidfile if File.exist? pidfile
 
       compose_opts = %w(--remove-orphans)
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} up #{compose_opts.join(" ")}", exec: true
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} up #{compose_opts.join(" ")}", exec: true
     end
 
     desc "down", "Stop one or many containers"
-    def down(*args)
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} down #{args.join(" ")}", exec: true
+    def down(*images)
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} down #{images.join(" ")}", exec: true
     end
 
     desc "rm", "Remove one or many containers"
     option :force, type: :boolean, default: false, aliases: %w(f)
-    def rm(*args)
-      load_config!
+    def rm(*images)
+      dctl = Dctl::Main.new env: options[:env]
       opts = " --force" if options[:force]
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} rm#{opts} #{args.join(" ")}", exec: true
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} rm#{opts} #{images.join(" ")}", exec: true
     end
 
     desc "start", "Start one or many containers"
-    def start(*args)
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} start #{args.join(" ")}", exec: true
+    def start(*images)
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} start #{images.join(" ")}", exec: true
     end
 
     desc "stop", "Stop one or many containers"
-    def stop(*args)
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} stop #{args.join(" ")}", exec: true
+    def stop(*images)
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} stop #{images.join(" ")}", exec: true
     end
 
     desc "restart", "Restart one or many containers"
-    def restart(*args)
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} restart #{args.join(" ")}", exec: true
+    def restart(*images)
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} restart #{images.join(" ")}", exec: true
     end
 
     desc "create", "Create one or many containers"
-    def create(*args)
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} create #{args.join(" ")}", exec: true
+    def create(*images)
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} create #{images.join(" ")}", exec: true
     end
 
     desc "recreate", "Stop, remove, build, create, and start a container"
@@ -133,18 +121,18 @@ module Dctl
 
     desc "ps", "List running containers for this environment"
     def ps
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} ps", exec: true
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} ps", exec: true
     end
 
     desc "initdb", "Setup initial postgres database"
     def initdb
-      load_config!
+      dctl = Dctl::Main.new env: options[:env]
       env = options[: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
 
-      cmd = "#{sudo}docker-compose -f #{compose_file_path} run --rm psql /bin/bash -c /etc/initdb.sh"
+      cmd = "#{sudo}docker-compose -f #{dtcl.compose_file_path} run --rm psql /bin/bash -c /etc/initdb.sh"
 
       stream_output cmd, exec: true
     end
@@ -163,25 +151,23 @@ module Dctl
 
     desc "bash CONTAINER", "Create a new instance of the given image with a bash prompt"
     def bash(container = "app")
-      load_config!
-      cmd = "#{sudo}docker-compose -f #{compose_file_path} run --rm #{container} /bin/bash"
+      dctl = Dctl::Main.new env: options[:env]
+      cmd = "#{sudo}docker-compose -f #{dctl.compose_file_path} run --rm #{container} /bin/bash"
 
       stream_output cmd, exec: true
     end
 
     desc "connect CONTAINER", "Connect to a running container."
     def connect(image = "app")
-      load_config!
-      stream_output "#{sudo}docker-compose -f #{compose_file_path} exec #{image} /bin/bash", exec: true
+      dctl = Dctl::Main.new env: options[:env]
+      stream_output "#{sudo}docker-compose -f #{dctl.compose_file_path} exec #{image} /bin/bash", exec: true
     end
 
     desc "attach CONTAINER", "Connect to a running container."
     option :env, type: :string, default: "dev"
     def attach(image = "app")
-      load_config!
-      env     = options[:env]
-      version = versions[image]
-      image   = "#{Settings.org}/#{Settings.project}-#{env}-#{image}:#{version}"
+      dctl = Dctl::Main.new env: options[:env]
+      tag = dctl.image_tag(image)
 
       cmd = "#{sudo}docker ps --filter ancestor=#{image} -aq | head -n1"
       puts cmd
@@ -216,39 +202,6 @@ module Dctl
         `uname`.chomp == "Darwin" ? "" : "sudo " # use sudo on linux hosts
       end
 
-      def config_path
-        path = File.expand_path ".dctl.yaml", Dir.pwd
-
-        unless File.exist? path
-          error = "Could not find config file at #{path}"
-          puts Rainbow(error).red
-          exit 1
-        end
-
-        path
-      end
-
-      def check_settings!
-        required_keys = %w(
-          org
-          project
-        )
-
-        required_keys.each do |key|
-          unless Settings.send key
-            error = "Config is missing required key '#{key}'. Please add it " \
-              "to #{config_path} and try again."
-            error += "\n\nFor more info, see https://github.com/jutonz/dctl#required-keys"
-            puts Rainbow(error).red
-            exit 1
-          end
-        end
-      end
-
-      def load_config!
-        Config.load_and_set_settings(config_path)
-        check_settings!
-      end
 
       def docker_opts
         return "" unless ENV["JENKINS"]
@@ -260,33 +213,6 @@ module Dctl
 
         opts
       end
-
-      def versions(env: options[:env])
-        @versions ||= begin
-          compose_file = compose_file_path env: env
-          parsed = YAML.load_file compose_file
-          images = parsed["services"].keys
-          version_map = {}
-
-          images.each do |image|
-            version_map[image] = parsed["services"][image]["image"].split(":").last
-          end
-
-          version_map
-        end
-      end
-
-      def compose_file_path(env: options[:env])
-        path = File.expand_path "docker/#{env}/docker-compose.yml"
-
-        unless File.exist? path
-          err = "There is no docker compose file for env #{env} (I expected to find it at #{path})"
-          puts Rainbow(err).red
-          exit 1
-        end
-
-        path
-      end
     end
   end
 end

data/lib/dctl/version.rb

@@ -1,3 +1,3 @@
 module Dctl
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/lib/dctl.rb

@@ -1,5 +1,118 @@
+require "rainbow"
 require "dctl/version"
+require "config"
 
 module Dctl
-  # Your code goes here...
+  class Main
+    attr_reader :env, :settings
+
+    def initialize(env: "dev")
+      @env = env
+      load_config!
+    end
+
+    ##
+    # Generate the full tag for the given image, concatenating the org,
+    # project, env, image name, and version.
+    #
+    # @example
+    #   image_tag("app") # => jutonz/dctl-dev-app:1
+    def image_tag(image)
+      org       = settings.org
+      project   = settings.project
+      version   = versions[image]
+
+      "#{org}/#{project}-#{env}-#{image}:#{version}"
+    end
+
+    ##
+    # Returns the path to the given image's data directory (which includes at
+    # minimum the Dockerfile, plus any other relevant files the user may have
+    # placed there).
+    def image_dir(image)
+      relative = File.join "docker", env, image
+      File.expand_path relative, Dir.pwd
+    end
+
+    def image_dockerfile(image)
+      File.expand_path "Dockerfile", image_dir(image)
+    end
+
+    def expand_images(*images)
+      images = versions.keys if images.empty?
+      images = Array(images)
+    end
+
+    ##
+    # Returns the path to the .dctl.yml file for the current project
+    def config_path
+      path = File.expand_path ".dctl.yml", Dir.pwd
+
+      unless File.exist? path
+        error = "Could not find config file at #{path}"
+        puts Rainbow(error).red
+        exit 1
+      end
+
+      path
+    end
+
+    def versions
+      @versions ||= begin
+        images = parsed_compose_file["services"].keys
+        version_map = {}
+
+        images.each do |image|
+          version_map[image] = parsed_compose_file["services"][image]["image"].split(":").last
+        end
+
+        version_map
+      end
+    end
+
+    def parsed_compose_file
+      @parsed_compose_file ||= YAML.load_file compose_file_path
+    end
+
+    ##
+    # Ensure the current project's .dctl.yml contains all the requisite keys.
+    def check_settings!
+      required_keys = %w(
+        org
+        project
+      )
+
+      required_keys.each do |key|
+        unless Settings.send key
+          error = "Config is missing required key '#{key}'. Please add it " \
+            "to #{config_path} and try again."
+          error += "\n\nFor more info, see https://github.com/jutonz/dctl_rb#required-keys"
+          puts Rainbow(error).red
+          exit 1
+        end
+      end
+    end
+
+    ##
+    # 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)
+      check_settings!
+
+      @settings = Settings
+    end
+
+    def compose_file_path
+      path = File.expand_path "docker/#{env}/docker-compose.yml"
+
+      unless File.exist? path
+        err = "There is no docker compose file for env #{env} (I expected to find it at #{path})"
+        puts Rainbow(err).red
+        exit 1
+      end
+
+      path
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dctl_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Toniazzo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,9 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -63,6 +66,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -114,6 +120,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"