rat_deployer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9434ec7c84475197340d979cd8cd297eeed41802
-  data.tar.gz: 9168a21f79a69cb597c61b703b3ec1ede5d65026
+  metadata.gz: d8370c118d92b2f06d327225481cb3d592a11167
+  data.tar.gz: a03cf3b020a9d3e38d99c6f1fa3adf56aa078e0d
 SHA512:
-  metadata.gz: 8f62a6495fe7e3fa55c7a958c1bcaf5b39c2355cb1278236abdf51ee0bcd71e4306b572b5f5ef1ad20f1714dbdf448ed2273e11b9673610f843eaac4c737cbb3
-  data.tar.gz: 9b1870d24db2c922e4556d260f129363e3a5385a0f4ca8b7706a11b0b9cf18e14217d7a6f31ef0262f994347168141a342b2dfc032bf2c2b824499a017987d1f
+  metadata.gz: e6626360686e73f7d236290cd3e842748b6d4b64f41afba11f0d4c8fb0125d71b76a895be6156b42c52c8b04db37d3f3e147c1fe7ccdbad94cbe031f1df63963
+  data.tar.gz: 7a2f2e575bb63d46e7eb7a074fb14e43e4f13f909e2fb0015030d9329e56e10b99f06f7c776c39fdab1a1ead62e972916053a073f7f6dc3d07ba1f07da47ed08

data/lib/rat_deployer/cli.rb

@@ -1,68 +1,88 @@
 require 'thor'
 require 'fileutils'
+require 'active_support/core_ext/string/strip'
 
 require 'rat_deployer/command'
 require 'rat_deployer/notifier'
 
 module RatDeployer
+  # The main Thor subclass
   class Cli < Thor
     include RatDeployer::Command
 
-    desc "deploy", "deploys current environment"
+    desc 'deploy', 'deploys current environment'
     def deploy(*services)
       RatDeployer::Notifier.notify_deploy_start
-
-      if services.any?
-        services_str = services.join(' ')
-        compose("pull #{services_str}")
-        compose("up -d --no-deps --force-recreate #{services_str}")
-      else
-        compose('pull')
-        compose('up -d')
-      end
-
+      do_deploy(*services)
       RatDeployer::Notifier.notify_deploy_end
-    rescue Exception => e
-      RatDeployer::Notifier.notify <<-STR
-Failed deploy on #{ENV.fetch('RAT_ENV')}"
-Reason:
-  #{e.message}
+    rescue StandardError => e
+      RatDeployer::Notifier.notify <<-STR.strip_heredoc
+        Failed deploy on #{RatDeployer::Config.env}
+        Reason:
+          #{e.message}
       STR
       raise e
     end
 
-    desc "compose ARGS...", "runs docker-compose command with default flags"
+    desc 'compose ARGS...', 'runs docker-compose command with default flags'
     def compose(cmd, *cmd_flags, silent: false)
-      env          = RatDeployer::Config.env
-      project_name = RatDeployer::Config.all.fetch('project_name')
+      run(
+        [
+          'docker-compose',
+          compose_flags,
+          cmd,
+          cmd_flags
+        ].flatten.join(' '),
+        silent: silent
+      )
+        .fetch(:output)
+    end
 
-      flags = [
-        "-f config/default.yml",
-        "-f config/#{env}.yml",
-        "-p #{project_name}_#{env}"
-      ]
+    desc 'docker ARGS...', 'runs docker command with default flags'
+    def docker(cmd, *cmd_flags)
+      flags = []
 
       if RatDeployer::Config.remote
         flags.unshift(RatDeployer::Config.remote_machine_flags)
       end
 
-      cmd = run "docker-compose #{flags.join(' ')} #{cmd} #{cmd_flags.join(" ")}", silent: silent
+      cmd = run "docker #{flags.join(' ')} #{cmd} #{cmd_flags.join(' ')}"
       cmd.fetch(:output)
     end
 
-    desc "docker ARGS...", "runs docker command with default flags"
-    def docker(cmd, *cmd_flags)
+    private
+
+    def do_deploy(*services)
+      if services.any?
+        services_str = services.join(' ')
+        compose("pull #{services_str}")
+        compose("up -d --no-deps --force-recreate #{services_str}")
+      else
+        compose('pull')
+        compose('up -d')
+      end
+    end
+
+    def compose_flags
       env          = RatDeployer::Config.env
       project_name = RatDeployer::Config.all.fetch('project_name')
 
-      flags = []
+      config_files =
+        RatDeployer::Config.for_env['config_files'] || %W[
+          config/default.yml
+          config/#{env}.yml
+        ]
+
+      flags = [
+        config_files.map { |cf| "-f #{cf}" },
+        "-p #{project_name}_#{env}"
+      ]
 
       if RatDeployer::Config.remote
         flags.unshift(RatDeployer::Config.remote_machine_flags)
       end
 
-      cmd = run "docker #{flags.join(' ')} #{cmd} #{cmd_flags.join(" ")}"
-      cmd.fetch(:output)
+      flags
     end
   end
 end

data/lib/rat_deployer/command.rb

@@ -1,13 +1,16 @@
-require "colorize"
+require 'colorize'
 require 'highline/import'
 require 'rat_deployer/config'
+require 'English'
 
 module RatDeployer
+  # Rat::Deployer encapsulates all code related to running a shell command
+  # and displaying it's output.
   module Command
     def run(cmd, silent: false)
       if !silent && RatDeployer::Config.prompt_enabled?
-        msg = "||=> Running command ".colorize(:blue) + "`#{cmd.colorize(:white)}`"
-        puts msg
+        puts '||=> Running command '.colorize(:blue) +
+             "`#{cmd.colorize(:white)}`"
       end
 
       command = do_run(cmd, silent: silent)
@@ -16,18 +19,19 @@ module RatDeployer
     end
 
     def do_run(cmd, silent: false)
-      output, status = '', 1
+      output = ''
+      status = 1
 
-      IO.popen(cmd) do |io|
-        while line = io.gets do
+      IO.popen(ENV, cmd) do |io|
+        while line = io.gets # rubocop:disable Lint/AssignmentInCondition
           puts line unless silent
           output << line
         end
         io.close
-        status = $?.to_i
+        status = $CHILD_STATUS.to_i
       end
 
-      {output: output, status: status}
+      { output: output, status: status }
     end
 
     def put_heading(str)
@@ -45,22 +49,6 @@ module RatDeployer
       puts colorize_warning(str)
     end
 
-    def ask_for_confirmation
-      return unless RatDeployer::Config.prompt_enabled?
-      prompt = "Are you sure you want to continue?"
-
-      a = ''
-      s = '[y/n]'
-      d = 'y'
-
-      until %w[y n].include? a
-        a = ask(colorize_warning("#{prompt} #{s} ")) { |q| q.limit = 1; q.case = :downcase }
-        a = d if a.length == 0
-      end
-
-      exit 1 unless a == 'y'
-    end
-
     def colorize_warning(str)
       "\\\\ #{str}".colorize(:yellow)
     end

data/lib/rat_deployer/config.rb

@@ -2,36 +2,50 @@ require 'yaml'
 require 'deep_merge'
 
 module RatDeployer
+  # This module handles config fetching from env and config files
   module Config
     def self.all
       @all ||= YAML.load_file(File.expand_path('./rat_config.yml')) || {}
     end
+
     def self.for_env(e = env)
       environmental = all.fetch('environments', {})
       default_conf = environmental.fetch('default', {})
-      env_conf     = environmental.fetch(e)
+      env_conf     = environmental.fetch(e, {})
 
       default_conf.deep_merge(env_conf)
     end
 
-    def self.prompt_enabled?() ENV['RAT_PROMPT'] != "false" end
-    def self.machine() for_env.fetch("machine") end
-    def self.remote() ENV['RAT_REMOTE'] =~ /true|1|yes/ end
-    def self.env() ENV.fetch('RAT_ENV') end
-    def self.images() all.fetch('images', {}) end
+    def self.prompt_enabled?
+      ENV['RAT_PROMPT'] != 'false'
+    end
+
+    def self.remote
+      ENV['RAT_REMOTE'] =~ /true|1|yes/
+    end
+
+    def self.env
+      ENV['RAT_ENV'] || 'default'
+    end
+
+    def self.images
+      all.fetch('images', {})
+    end
 
     def self.remote_machine_flags
+      machine = for_env.fetch('machine')
+
       case machine
-      when Symbol, String
-        `docker-machine config #{machine}`.gsub(/\n/, ' ')
       when Hash
         [
-          "--tlsverify",
+          '--tlsverify',
           "-H='#{machine.fetch('host')}'",
           "--tlscacert='#{machine.fetch('ca_cert')}'",
           "--tlscert='#{machine.fetch('cert')}'",
-          "--tlskey='#{machine.fetch('key')}'",
+          "--tlskey='#{machine.fetch('key')}'"
         ].join(' ')
+      else
+        raise 'Bad configuration value for `machine`'
       end
     end
   end

data/lib/rat_deployer/notifier.rb

@@ -3,39 +3,38 @@ require 'active_support/core_ext/string'
 require 'slack-notifier'
 
 module RatDeployer
+  # RatDeployer::Notifier handles notifications to slack
   module Notifier
     def self.notify_deploy_start
       return unless webhook_url
-      notify_deploy "Starting deploy on #{ENV.fetch('RAT_ENV')}"
+      notify_deploy "Starting deploy on #{RatDeployer::Config.env}"
     end
 
     def self.notify_deploy_end
       return unless webhook_url
-      notify_deploy "Ended deploy on #{ENV.fetch('RAT_ENV')}"
+      notify_deploy "Ended deploy on #{RatDeployer::Config.env}"
     end
 
     def self.notify(msg)
       return unless webhook_url
       return unless webhook_url
-      self.slack_notifier.ping msg
+      slack_notifier.ping msg
     end
 
-    private
-
     def self.notify_deploy(title)
       return unless webhook_url
-      props = get_deploy_properties
+      props = deploy_properties
 
       slack_notifier.post(
         text: title,
         attachments: [{
           title:  'Deploy details',
-          fields: get_deploy_properties.map do |k,v|
+          fields: props.map do |k, v|
             {
               title: k.to_s.titleize,
               value: k == :images ? v.join(' · ') : v,
               short: k != :images
-           }
+            }
           end
         }]
       )
@@ -55,17 +54,18 @@ module RatDeployer
     end
 
     def self.webhook_url
-      @webhook_url ||= RatDeployer::Config.all["slack_webhook_url"]
+      @webhook_url ||= RatDeployer::Config.all['slack_webhook_url']
     end
 
-    def self.get_deploy_properties
+    def self.deploy_properties
       require 'socket'
 
-      docker_config = YAML.load(RatDeployer::Cli.new.compose('config', silent: true))
-      images = docker_config['services'].map { |s,c| c['image'] }.uniq.sort
+      compose_config = RatDeployer::Cli.new.compose('config', silent: true)
+      docker_config = YAML.safe_load(compose_config)
+      images = docker_config['services'].map { |_s, c| c['image'] }.uniq.sort
 
       {
-        env:        ENV.fetch('RAT_ENV'),
+        env:        RatDeployer::Config.env,
         user:       ENV.fetch('USER'),
         hostname:   Socket.gethostname,
         started_at: Time.now.to_s,

data/lib/rat_deployer/version.rb

@@ -1,3 +1,3 @@
 module RatDeployer
-  VERSION = "0.4.0"
+  VERSION = '0.5.0'.freeze
 end

data/lib/rat_deployer.rb

@@ -1,6 +1,14 @@
 require 'rat_deployer/version'
 require 'rat_deployer/config'
 
+# Rat is a deploy tool for docker users.
+# It implements a facade around 2 docker CLIs:
+#   - docker
+#   - docler-compose
+#
+# It is not very flexible and it is lightly tested.
+# I named it rat because it is a rather little and
+# ugly ball of code, but it does the job for now.
 module RatDeployer
   def self.print_rat
     return unless RatDeployer::Config.prompt_enabled?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rat_deployer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nicolas Oga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -122,6 +122,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
 description: A micro-framework to deploy dockerized apps
 email:
 - 2112.oga@gmail.com
@@ -158,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A micro-framework to deploy dockerized apps