opsicle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWY2NTQzM2MwYjY3NDE2OGEzOGE4NTk2NDQzZjVkMjhjOGVlOThiZQ==
+    ZjkzMDgwYWI5OTI4NDQ5Mzc5MmRmZjg1ZTc3YWU3MTgxZWMxNTlmNA==
   data.tar.gz: !binary |-
-    MjEyZmMwMDZmODBlYTkxOGY1NzcxZWRhNGM4NWZmMzJiYzNmMDEwNA==
+    YmNkNWQxZWFiOTg4MDgyMzU3NjA1ZDk4NTVhYzlhY2IzY2M5YzIwYg==
 SHA512:
   metadata.gz: !binary |-
-    MTNiYTM1NDY4MTIwYmE2OTA2ZGViOGM1YzMwZWQyZDY1NTQyM2ZhZmE1NjVh
-    Mjg5NTg3YzZmYmU3NDcxY2Q5NWE2N2MyYWE0YzkwN2I2YzVkZGVmNmMwMzk3
-    NWU3ZTdiMTBiMzI3Zjc2ZGUwMTBkYzRjYzMzZTNjYThjNTdlNTY=
+    NjgzMjk2ODIwMzRhOTk5ZjY5NmY2MWU1ZmEzYTEyMTZiMjJkYmE4Y2ZhYmJl
+    YThjNDNkYzUxMTI4NzlkZDI0MWQ4YWQ5MGJjMThjYjVkNTc1ZDM0YTFmMDBk
+    MTU5NDc0MWM4M2M4MWEzYWUwNTYzMzZkNzRhNzQwMTk3NzY4OWU=
   data.tar.gz: !binary |-
-    NzQyMTc1ZDI3NjMwNGRiMWQ4NjhlNzVjMjE0MjI4MzU4OWZiNTFiNmZmYWNm
-    OGZkOTYzYWJiMWQ3NWVkMDY3MTVmYWUzODRiYWJjNzM3YjM3ZDk3Mzc4MmY4
-    NjhjNjQ3OWY5ZTQ0NDE2N2FhYjE1OWYyNjg3YzQ4ZjUyMGEwN2E=
+    NDJhYjQ3Y2IwZDBlYzRjY2I2MWZkNTRhNWRhZjVlNTNlOGY1ZDkzODE2Zjlh
+    ZTViNDdmNGYyYmY3ODc0MzdjYzU2ODg2YjQzYTJjNjgxNGRmMDE4YTA4OTIz
+    MmU5YTc1MTgxOTQ2MmJjMThlNzQ1ZmNkMzAzNjM3YWIxMjZkZTQ=

data/.gitignore

@@ -1,8 +1,11 @@
+# ignore .opsicle since this will never be hosted on OpsWorks
+.opsicle*
 *.gem
 *.rbc
 .bundle
 .config
 coverage
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg

data/.travis.yml

@@ -3,5 +3,10 @@ rvm:
   - 2.0
   - 2.1
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
 script: bundle exec rspec
+matrix:
+  include:
+    - rvm: jruby-19mode # JRuby in 1.9 mode
+      env: JRUBY_OPTS="--1.9 -Xcext.enabled=true"
+  allow_failures:
+    - rvm: jruby-19mode

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in opsicle.gemspec
 gemspec
+
+gem 'curses' if RUBY_VERSION >= '2.1' || RUBY_PLATFORM == 'java'
+

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.markdown

@@ -4,28 +4,31 @@ A gem bringing the glory of OpsWorks to your command line.
 [![Gem Version](https://badge.fury.io/rb/opsicle.png)](http://badge.fury.io/rb/opsicle)
 [![Build Status](https://travis-ci.org/sportngin/opsicle.png?branch=master)](https://travis-ci.org/sportngin/opsicle)
 
-##Deployment Commands
+## Installation
+Add this line to your project's Gemfile:  
 
-```bash
-# Run a basic deploy for the current app
-opsicle deploy staging
-
-# Run the deploy for production
-opsicle deploy production
-
-# SSH to a server instance in the given environment stack (ex: staging)
-opsicle ssh staging
-
-# Run other opsworks commands
-opsicle update_custom_cookbooks staging
+**For Ruby >=2.1.0**  
+```ruby
+gem 'opsicle'
+gem 'curses'
+```
 
-# Trigger the setup event
-opsicle setup staging
+**For Ruby <2.1.0, 1.9.3**  
+```ruby
+gem 'opsicle'
 ```
 
-Opsicle accepts a `--verbose` flag to show additional information as commands are run.
+(Alternatively, `gem 'opsicle'; gem 'curses' unless RUBY_VERSION < "2.1.0"`)
 
-##Set up an Application to use opsicle
+**Why the extra `curses` gem for Ruby 2.1.0+?**  
+Opsicle uses [curses](http://en.wikipedia.org/wiki/Curses_(programming_library)).
+Ruby's library to interface with curses was [removed from stdlib in Ruby 2.1.0](https://bugs.ruby-lang.org/issues/8584).
+[The new curses gem](https://github.com/ruby/curses) is not backwards compatible, so in an effort to keep this gem
+friendly with all current Ruby versions we don't list it as a dependency in Opsicle's gemspec - doing so would cause
+errors for Ruby 1.9.3 users.
+Ruby >=2.1.0 will likely be enforced sometime in 2014; [certainly by February 2015](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/).
+
+### Set up an Application to use opsicle
 
 ```yaml
 # your_app_root/.opsicle
@@ -49,4 +52,28 @@ production:
   aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
 ```
 
+## Using Opsicle
+
+Run `opsicle help` for a full list of commands and their uses.  
+Some common commands:
+
+```bash
+
+# Run a basic deploy for the current app
+opsicle deploy staging
+
+# Run the deploy for production
+opsicle deploy production
 
+# SSH to a server instance in the given environment stack
+opsicle ssh staging
+
+# Set your user SSH key (PUBLIC KEY) for OpsWorks
+opsicle ssh-key staging <key-file>
+
+# Launch the Opsicle Stack Monitor for the given environment stack
+opsicle monitor staging
+
+```
+
+Opsicle accepts a `--verbose` flag to show additional information as commands are run.

data/bin/opsicle

@@ -16,7 +16,8 @@ default_command :help
 
 command :deploy do |c|
   c.syntax = "opsicle deploy <environment>"
-  c.description = "Deploy your current app to the given OpsWorks stack"
+  c.description = "Deploy your current app to the given environment stack"
+  c.option "--browser", "Open OpsWorks deployments screen instead of Opsicle Stack Monitor"
   c.action do |args, options|
     raise ArgumentError, "Environment is required" unless args.first
     Opsicle::Deploy.new(args.first).execute(options.__hash__)
@@ -25,7 +26,7 @@ end
 
 command :list do |c|
   c.syntax = "opsicle list <environment>"
-  c.description = "List all apps in the given environment"
+  c.description = "List all apps in the given environment stack"
   c.action do |args, options|
     raise ArgumentError, "Environment is required" unless args.first
     Opsicle::List.new(args.first).execute(options.__hash__)
@@ -34,9 +35,41 @@ end
 
 command :ssh do |c|
   c.syntax = "opsicle ssh <environment>"
-  c.description = "SSH access to instances in the given Opsworks stack"
+  c.description = "SSH access to instances in the given environment stack"
   c.action do |args, options|
     raise ArgumentError, "Environment is required" unless args.first
     Opsicle::SSH.new(args.first).execute(options.__hash__)
   end
 end
+
+command 'ssh-key' do |c|
+  c.syntax = "opsicle ssh-key <environment> <key-file>"
+  c.description = "Set your user SSH key (PUBLIC KEY) for OpsWorks"
+  c.action do |args, options|
+    raise ArgumentError, "Environment is required" unless args.first
+    raise ArgumentError, "ssh public key-file is required" unless args[1]
+    Opsicle::SSHKey.new(*args).execute(options.__hash__)
+  end
+end
+
+command 'monitor' do |c|
+  c.syntax = "opsicle monitor <environment>"
+  c.description = "Launch the Opsicle Stack Monitor for the given environment stack"
+  c.action do |args, options|
+    raise ArgumentError, "Environment is required" unless args.first
+
+    @monitor = Opsicle::Monitor::App.new(args.first, options.__hash__)
+
+    begin
+      @monitor.start
+    rescue => e
+      say "<%= color('Uh oh, an error occurred while starting the Opsicle Stack Monitor.', RED) %>"
+      say "<%= color('Use --trace to view stack trace.', RED) %>"
+
+      if options.trace
+        raise
+      end
+    end
+  end
+end
+alias_command :'top', :'monitor'

data/lib/opsicle.rb

@@ -5,7 +5,6 @@ Signal.trap("INT") do
 end
 
 require "opsicle/version"
-require "opsicle/deploy"
-require "opsicle/list"
-require "opsicle/ssh"
+require "opsicle/commands"
+require "opsicle/monitor"
 

data/lib/opsicle/commands.rb

@@ -0,0 +1,6 @@
+require 'opsicle/client'
+
+require "opsicle/commands/deploy"
+require "opsicle/commands/list"
+require "opsicle/commands/ssh"
+require "opsicle/commands/ssh_key"

data/lib/opsicle/commands/deploy.rb

@@ -0,0 +1,39 @@
+module Opsicle
+  class Deploy
+    attr_reader :client
+
+    def initialize(environment)
+      @environment = environment
+      @client = Client.new(environment)
+    end
+
+    def execute(options={})
+      response = client.run_command('deploy')
+
+      if options[:browser]
+        open_deploy(response[:deployment_id])
+      else
+        @monitor = Opsicle::Monitor::App.new(@environment, options)
+
+        begin
+          @monitor.start
+        rescue => e
+          say "<%= color('Uh oh, an error occurred while starting the Opsicle Stack Monitor.', RED) %>"
+          say "<%= color('Use --trace to view stack trace.', RED) %>"
+
+          if options.trace
+            raise
+          end
+        end
+      end
+    end
+
+    def open_deploy(deployment_id)
+      if deployment_id
+        exec "open 'https://console.aws.amazon.com/opsworks/home?#/stack/#{client.config.opsworks_config[:stack_id]}/deployments'"
+      else
+        puts 'deploy failed'
+      end
+    end
+  end
+end

data/lib/opsicle/{list.rb → commands/list.rb}

@@ -1,6 +1,4 @@
-require 'aws-sdk'
 require 'terminal-table'
-require_relative 'client'
 
 module Opsicle
   class List

data/lib/opsicle/{ssh.rb → commands/ssh.rb}

@@ -1,6 +1,3 @@
-require 'aws-sdk'
-require_relative 'client'
-
 module Opsicle
   class SSH
     attr_reader :client

data/lib/opsicle/commands/ssh_key.rb

@@ -0,0 +1,40 @@
+module Opsicle
+  class SSHKey
+
+    def initialize(environment, keyfile)
+      @client = Client.new(environment)
+      @keyfile = keyfile
+    end
+
+    def execute(options={})
+      validate!
+      update
+      say "ssh-key updated successfully"
+    end
+
+    def validate!
+      raise KeyFileNotFound, "No key file could be found" unless File.exists?(@keyfile)
+      raise InvalidKeyFile, "Key file is invalid" unless valid_key_file?
+      raise InvalidKeyFile, "Key file is a private key" unless public_key?
+    end
+
+    def valid_key_file?
+      system("ssh-keygen -l -f #{@keyfile} > /dev/null")
+    end
+
+    def public_key?
+      !key.match(/PRIVATE KEY/)
+    end
+
+    def key
+      @key ||= File.read(@keyfile)
+    end
+
+    def update
+      @client.api_call(:update_my_user_profile, {ssh_public_key: key})
+    end
+
+  end
+  KeyFileNotFound = Class.new(StandardError)
+  InvalidKeyFile = Class.new(StandardError)
+end

data/lib/opsicle/config.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'aws-sdk'
 
 module Opsicle
   class Config

data/lib/opsicle/deployment.rb

@@ -0,0 +1,59 @@
+module Opsicle
+  class Deployment
+
+    def initialize(deployment_id, client)
+      @deployment_id = deployment_id
+      @client = client
+    end
+
+    def deployment_id
+      deployment[:deployment_id]
+    end
+
+    def stack_id
+      deployment[:stack_id]
+    end
+
+    def app_id
+      deployment[:app_id]
+    end
+
+    def created_at
+      deployment[:created_at]
+    end
+
+    def completed_at
+      deployment(reload: true)[:completed_at]
+    end
+
+    def duration
+      deployment(reload: true)[:duration]
+    end
+
+    def command
+      deployment[:command]
+    end
+
+    def status
+      deployment(reload: true)[:status]
+    end
+
+    def instance_ids
+      deployment[:instance_ids]
+    end
+
+    %w(running successful failed).each do |status_name|
+      define_method("#{status_name}?") { status == status_name }
+    end
+
+    def deployment(options={})
+      # Only call the API again if you need to
+      @deployment = nil if options[:reload]
+      @deployment ||= @client.api_call('describe_deployments',
+                                       :deployment_ids => [@deployment_id]
+                                      )[:deployments].first
+    end
+    private :deployment
+
+  end
+end

data/lib/opsicle/deployments.rb

@@ -0,0 +1,22 @@
+module Opsicle
+  class Deployments
+
+    def initialize(client)
+      @client = client
+    end
+
+    def data
+      deployments(reload: true)
+    end
+
+    def deployments(options={})
+      # Only call the API again if you need to
+      @deployments = nil if options[:reload]
+      @deployments ||= @client.api_call('describe_deployments',
+                                       :stack_id => @client.config.opsworks_config[:stack_id]
+                                      )[:deployments]
+    end
+    private :deployments
+
+  end
+end

data/lib/opsicle/monitor.rb

@@ -0,0 +1,12 @@
+require "opsicle/monitor/app"
+require "opsicle/monitor/panel"
+require "opsicle/monitor/subpanel"
+require "opsicle/monitor/screen"
+require "opsicle/monitor/translatable"
+
+require "opsicle/monitor/panels/header"
+require "opsicle/monitor/panels/deployments"
+require "opsicle/monitor/panels/help"
+
+require "opsicle/monitor/spy/dataspyable"
+require "opsicle/monitor/spy/deployments"

data/lib/opsicle/monitor/app.rb

@@ -0,0 +1,147 @@
+# Credit where credit is due:
+# The Monitor module's architecture and many of its classes are heavily based on
+# the work of tiredpixel's sidekiq-spy gem: https://github.com/tiredpixel/sidekiq-spy
+# His help in working with the Ruby curses library has been invaluable - thanks tiredpixel!
+
+require 'opsicle/client'
+
+module Opsicle
+  module Monitor
+    class App
+      API_POLLING_INTERVAL = 10
+      SCREEN_REFRESH_INTERVAL = 5
+
+      attr_reader :running
+      attr_reader :restarting
+
+      class << self
+        attr_accessor :client
+      end
+
+      def initialize(environment, options)
+        @running    = false
+        @restarting = false
+        @threads    = {}
+
+        # Make client with correct configuration available to monitor spies
+        App.client = Client.new(environment)
+      end
+
+      def start
+        begin
+          @running = true
+
+          setup
+
+          @threads[:command] ||= Thread.new do
+            command_loop # listen for commands
+          end
+
+          @threads[:refresh_screen] ||= Thread.new do
+            refresh_screen_loop # refresh frequently
+          end
+
+          @threads[:refresh_data] ||= Thread.new do
+            refresh_data_loop # refresh not so frequently
+          end
+
+          @threads.each { |tname, t| t.join }
+        ensure
+          cleanup
+        end
+      end
+
+      def stop
+        @running = false
+        @screen.close
+        @screen = nil # Ruby curses lib doesn't have closed?(), so we set to nil, just in case
+
+        exit 0
+      end
+
+      def restart
+        @restarting = true
+      end
+
+      def do_command(key)
+        command = { q: :stop,
+                    h: [:set_screen, :help],
+                    b: :open_opsworks_browser,
+                    d: [:set_screen, :deployments] }[key.to_sym]
+        command ||= :invalid_input
+
+        send *command unless command == :invalid_input
+
+        wakey_wakey # wake threads for immediate response
+      end
+
+      private
+
+      def set_screen(screen)
+        @screen.panel_main = screen
+      end
+
+      def setup
+        @screen = Monitor::Screen.new
+      end
+
+      def cleanup
+        @screen.close if @screen
+      end
+
+      def wakey_wakey
+        @threads.each { |tname, t| t.run if t.status == 'sleep' }
+      end
+
+      def command_loop
+        while @running do
+          next unless @screen # #refresh_loop might be reattaching screen
+
+          key = @screen.next_key
+
+          next unless key # keep listening if timeout
+
+          do_command(key)
+        end
+      end
+
+      def refresh_screen_loop
+        while @running do
+          next unless @screen # HACK: only certain test scenarios?
+
+          if @restarting || @screen.missized? # signal(s) or whilst still resizing
+            panel_main = @screen.panel_main
+
+            cleanup
+
+            setup
+
+            @screen.panel_main = panel_main
+
+            @restarting = false
+          end
+
+          @screen.refresh
+
+          sleep SCREEN_REFRESH_INTERVAL # go to sleep; could be rudely awoken on quit
+        end
+      end
+
+      # This loop is specifically separate from the screen loop
+      # because we don't want to spam OpWorks with API calls every second.
+      def refresh_data_loop
+        while @running do
+          next unless @screen # HACK: only certain test scenarios?
+
+          @screen.refresh_spies
+
+          sleep API_POLLING_INTERVAL
+        end
+      end
+
+      def open_opsworks_browser
+        %x(open 'https://console.aws.amazon.com/opsworks/home?#/stack/#{App.client.config.opsworks_config[:stack_id]}')
+      end
+    end
+  end
+end