karo 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23fa58c07c32002dda91d507fe5ac2d3ae300dcc
-  data.tar.gz: 99938fdcbd9a153ad0c7e411c6f1a7edcb34d657
+  metadata.gz: 97b8833811a06035214ec406b17eca422d1bb1fb
+  data.tar.gz: e6114de86c07bd6bab12db6b2f4339e97c6b09f4
 SHA512:
-  metadata.gz: 2739297d2f764b01eba6dbc6bee96de9fc115a243bda13a1c0b9678e87e2e1dd157e53c6fc136bf542eeec6983cd917f309b4cbb9d91a91aa9e8bd37dbe7f6a4
-  data.tar.gz: 5818291c051d7df77d4b37c558ab40ff3fd8f1b468ab60e7151d19e50f2fb67bdd859d47349f21d6c665b121d67626d24a9497925d6197ba350d95045962f65e
+  metadata.gz: ed6f7dec23bf58f66b877ce3ea84e97a3c86d474a6a1a8854ea785da61247175c8874f6f36c96284ceb6a3d76e5c8a6d07265f346ad1dd6e906ceb93a65b1eb2
+  data.tar.gz: 7e0210d93ebc777cb9d21a9d6d14e7612fae4022fad53b778f27fb683c23556171be88d9780742df67ea49f7b1e5eff52dfb37626e6bb9cb5588598d61b8a259

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v2.0.0
+
+### Features
+
+- Added command 'server' to execute commands remotely
+- Added command 'client' to execute commands locally
+- Removed command 'command', supceded by 'server'
+
 ## v1.5.0
 
 ### Bug Fixes

data/lib/karo/assets.rb

@@ -10,6 +10,7 @@ module Karo
     class_option :config_file, type: :string, default: Config.default_file_name,
                   aliases: "-c", desc: "name of the file containing server configuration"
     class_option :environment, aliases: "-e", desc: "server environment", default: "production"
+    class_option :verbose, type: :boolean, lazy_default: true, aliases: "-v", desc: "verbose"
 
 	  desc "pull", "syncs assets from server shared/system/dragonfly/<environment> directory into local system/dragonfly/development directory"
 	  def pull
@@ -23,7 +24,9 @@ module Karo
 	    host = "deploy@#{configuration["host"]}"
 	    cmd  = "rsync -az --progress #{host}:#{path_server}/ #{path_local}/"
 
-      system "#{cmd}"
+      say cmd, :green if options[:verbose]
+
+      system cmd
 
       say "Assets sync complete", :green
 	  end
@@ -44,6 +47,11 @@ module Karo
       cmd_1  = "ssh #{host} 'mkdir -p #{path_server}'"
       cmd_2  = "rsync -az --progress #{path_local}/ #{host}:#{path_server}/"
 
+      if options[:verbose]
+        say cmd_1, :green
+        say cmd_2, :green
+      end
+
       if yes?("Are you sure?", :yellow)
         system "#{cmd_1}"
         system "#{cmd_2}"

data/lib/karo/cache.rb

@@ -13,10 +13,13 @@ module Karo
 	  def search(name="")
 	    configuration = Config.load_configuration(options)
 	    path = File.join(configuration["path"], "shared/cache")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
-	    cmd  = "find #{path} -type f -name \"*#{name}*\""
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+      cmd  = "find #{path} -type f -name \"*#{name}*\""
+
+      to_run = "#{ssh} '#{cmd}'"
 
-      system "#{ssh} '#{cmd}'"
+      say to_run, :green if options[:verbose]
+      system to_run
 	  end
 
 	  desc "remove", "removes any matching cache files from the shared/cache directory"
@@ -28,8 +31,11 @@ module Karo
       ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
       cmd  = "find #{path} -type f -name \"*#{name}*\" -delete"
 
+      to_run = "#{ssh} '#{cmd}'"
+
       if yes?("Are you sure?", :yellow)
-        system "#{ssh} '#{cmd}'"
+        say to_run, :green if options[:verbose]
+        system to_run
         say "Cache removed", :green
       else
         say "Cache not removed", :yellow

data/lib/karo/cli.rb

@@ -15,22 +15,7 @@ module Karo
     class_option :config_file, type: :string, default: Config.default_file_name,
                   aliases: "-c", desc: "name of the file containing server configuration"
     class_option :environment, aliases: "-e", desc: "server environment", default: "production"
-
-    desc "log", "displays server log for a given environment"
-    def log(name="")
-      configuration = Config.load_configuration(options)
-
-      path = File.join(configuration["path"], "shared/log/#{options["environment"]}.log")
-      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
-
-      if name.eql?("")
-        cmd = "tail -f #{path}"
-      else
-        cmd = "tail #{path} | grep -A 10 -B 10 #{name}"
-      end
-
-      system "#{ssh} '#{cmd}'"
-    end
+    class_option :verbose, type: :boolean, lazy_default: true, aliases: "-v", desc: "verbose"
 
     desc "cache [search, remove]", "find or clears a specific or all cache from shared/cache directory on the server"
     subcommand "cache", Cache
@@ -58,11 +43,59 @@ module Karo
       copy_file 'templates/karo.yml', config_file
     end
 
-    desc "command [COMMAND]", "run any command within a given server environment"
+    desc "client [COMMAND]", "run any command within a given client environment"
+    long_desc <<-LONGDESC
+    `karo client [command]` or `karo clt [command]` will run the [COMMAND] cliently.
+
+    e.g. Display list of files on the client machine
+
+    > $ karo client ls
+
+    CHANGELOG.md Gemfile.lock README.md
+
+    You can also store custom commands for a given environment in the configuration file
+
+    e.g. .karo.yml
+
+    production:
+
+    --host: example.com
+
+    --user: deploy
+
+    --path: /data/app_name
+
+    --commands:
+
+    ----client:
+
+    ------deploy: ey deploy -e production -r master
+
+    > $ karo clt deploy
+
+    > Loading application data from Engine Yard Cloud...
+
+    > Beginning deploy...
+    LONGDESC
+    def client(cmd)
+      configuration = Config.load_configuration(options)
+
+      if configuration["commands"] && configuration["commands"]["client"] && configuration["commands"]["client"][cmd]
+        cmd = configuration["commands"]["client"][cmd]
+      end
+
+      say cmd, :green if options[:verbose]
+
+      system cmd
+    end
+    map clt:   :client
+    map local: :client
+
+    desc "server [COMMAND]", "run any command within a given server environment"
     method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
                   type: :boolean, default: true
     long_desc <<-LONGDESC
-    `karo command [command]` or `karo cmd [command]`
+    `karo server [command]` or `karo srv [command]`
 
     will run the [COMMAND] passed on the server.
 
@@ -70,13 +103,13 @@ module Karo
 
     e.g. Display list of files on the staging server
 
-    > $ karo command ls -e staging --no-tty
+    > $ karo server ls -e staging --no-tty
 
     CHANGELOG.md Gemfile.lock README.md
 
     e.g. Run top command on the production server
 
-    > $ karo command top
+    > $ karo server top
 
     > top - 17:14:06 up 219 days, 11:30,  1 user,  load average: 0.28, 0.49, 0.47
 
@@ -94,11 +127,13 @@ module Karo
 
     --commands:
 
-    ----memory: watch vmstat -sSM
+    ----server:
 
-    ----top_5_memory: ps aux | sort -nk +4 | tail
+    ------memory: watch vmstat -sSM
 
-    > $ karo cmd memory
+    ------top_5_memory: ps aux | sort -nk +4 | tail
+
+    > $ karo srv memory
 
     > Every 2.0s: vmstat -sSM Tue Jul  2 17:18:16 2013
 
@@ -108,7 +143,7 @@ module Karo
 
     > 25224800  active memory
     LONGDESC
-    def command(cmd)
+    def server(cmd)
       configuration = Config.load_configuration(options)
 
       ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
@@ -116,26 +151,21 @@ module Karo
       # Forces pseudo-tty allocation
       ssh << " -t" if options[:tty]
 
-      if configuration["commands"] && configuration["commands"][cmd]
-        cmd = configuration["commands"][cmd]
+      if configuration["commands"] && configuration["commands"]["server"] && configuration["commands"]["server"][cmd]
+        cmd = configuration["commands"]["server"][cmd]
       end
 
-      system "#{ssh} '#{cmd}'"
-    end
-    map cmd: :command
+      to_run = "#{ssh} '#{cmd}'"
 
-    desc "on [COMMAND]", "run any command within a given server environment"
-    method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
-                  type: :boolean, default: true
-    def on(cmd)
-      say "Deprecated and will be removed in version 2.0", :yellow
-      say "Please use 'command' instead", :yellow
-      invoke :command
+      say to_run, :green if options[:verbose]
+      system to_run
     end
+    map srv:    :server
+    map remote: :server
 
     desc "top", "run top command on a given server environment"
     def top
-      invoke :command, ["top"]
+      invoke :server, ["top"]
     end
 
     desc "ssh", "open ssh console for a given server environment"
@@ -146,7 +176,7 @@ module Karo
       cmd  = "cd #{path}; export RAILS_ENV=#{options[:environment]}; \
               export RACK_ENV=#{options[:environment]}; $SHELL"
 
-      invoke :command, [cmd]
+      invoke :server, [cmd]
     end
 
     desc "console", "open rails console for a given server environment"
@@ -156,7 +186,22 @@ module Karo
       path = File.join(configuration["path"], "current")
       cmd  = "cd #{path} && bundle exec rails console #{options[:environment]}"
 
-      invoke :command, [cmd]
+      invoke :server, [cmd]
+    end
+
+    desc "log", "displays server log for a given environment"
+    def log(name="")
+      configuration = Config.load_configuration(options)
+
+      path = File.join(configuration["path"], "shared/log/#{options["environment"]}.log")
+
+      if name.eql?("")
+        cmd = "tail -f #{path}"
+      else
+        cmd = "tail #{path} | grep -A 10 -B 10 #{name}"
+      end
+
+      invoke :server, [cmd]
     end
 
     desc "version", "displays karo's current version"

data/lib/karo/db.rb

@@ -13,6 +13,7 @@ module Karo
     class_option :config_file, type: :string, default: Config.default_file_name,
                   aliases: "-c", desc: "name of the file containing server configuration"
     class_option :environment, aliases: "-e", desc: "server environment", default: "production"
+    class_option :verbose, type: :boolean, lazy_default: true, aliases: "-v", desc: "verbose"
 
     method_option :migrate, aliases: "-m", desc: "run migrations after sync", default: true
 	  desc "pull", "syncs MySQL database from server to localhost"
@@ -52,11 +53,19 @@ module Karo
       say "Loading #{options[:environment]} server database configuration", :green
 
       # Drop local database and re-create
-      system "mysql -v -h #{local_db_config["host"]} -u#{local_db_config["username"]} -p#{local_db_config["password"]} -e 'DROP DATABASE IF EXISTS `#{local_db_config["database"]}`; CREATE DATABASE IF NOT EXISTS `#{local_db_config["database"]}`;'"
+      to_run = "mysql -v -h #{local_db_config["host"]} -u#{local_db_config["username"]} -p#{local_db_config["password"]} -e 'DROP DATABASE IF EXISTS `#{local_db_config["database"]}`; CREATE DATABASE IF NOT EXISTS `#{local_db_config["database"]}`;'"
+
+      say to_run, :green if options[:verbose]
+
+      system to_run
 
       ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
 
-      system "#{ssh} \"mysqldump --opt -C -u#{server_db_config["username"]} -p#{server_db_config["password"]} #{server_db_config["database"]}\" | mysql -v -h #{local_db_config["host"]} -C -u#{local_db_config["username"]} -p#{local_db_config["password"]} #{local_db_config["database"]}"
+      to_run = "#{ssh} \"mysqldump --opt -C -u#{server_db_config["username"]} -p#{server_db_config["password"]} #{server_db_config["database"]}\" | mysql -v -h #{local_db_config["host"]} -C -u#{local_db_config["username"]} -p#{local_db_config["password"]} #{local_db_config["database"]}"
+
+      say to_run, :green if options[:verbose]
+
+      system to_run
 
       if options[:migrate]
         say "Running rake db:migrations", :green
@@ -72,13 +81,23 @@ module Karo
 	  end
 
     desc "console", "open rails dbconsole for a given server environment"
+    method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
+                  type: :boolean, default: true
     def console
       configuration = Config.load_configuration(options)
 
       path = File.join(configuration["path"], "current")
-      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+
+      # Forces pseudo-tty allocation
+      ssh << " -t" if options[:tty]
+
       cmd  = "cd #{path} && bundle exec rails dbconsole #{options[:environment]} -p"
-      system "#{ssh} '#{cmd}'"
+
+      to_run = "#{ssh} '#{cmd}'"
+
+      say to_run, :green if options[:verbose]
+      system to_run
     end
 
 	end

data/lib/karo/templates/karo.yml

@@ -3,11 +3,17 @@ production:
   user: deploy
   path: /data/app_name
   commands:
-    memory: watch vmstat -sSM
-    top_5_memory: ps aux | sort -nk +4 | tail
+    server:
+      memory: watch vmstat -sSM
+      top_5_memory: ps aux | sort -nk +4 | tail
+    client:
+      deploy: ey deploy -e production -r master
 staging:
   host: example.com
   user: deploy
   path: /data/app_name
   commands:
-    memory: vmstat -sSM
+    server:
+      memory: vmstat -sSM
+    client:
+      deploy: ey deploy -e staging -r staging

data/lib/karo/version.rb

@@ -1,3 +1,3 @@
 module Karo
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karo
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Rahul Trikha