opsworks_ship 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a82c2264db6584c292d2c0060ecc0b46dc28ffd
-  data.tar.gz: 002965652242e5dadc6b36084192c21198a20d9d
+  metadata.gz: 203d4494b6a5ea1e8c6ed33a5ec2697532ad1616
+  data.tar.gz: 43e10d97b1a2c41d7dd2776fee6ab725038a8513
 SHA512:
-  metadata.gz: a57e958ca83ea4abbb5f9e4aad5e14c7f6c513cfbbad347ce4ed6d163a95ba31d8f32b71f51b46d67cbcc07d56f97e51c2f3094748344577b73351450f7118c0
-  data.tar.gz: 0733312598621d288bc3533844383d4a25cc2f0d88f6f82c253f6140f69adf46b2790afb341ce97d364a78b0525d7f08f878be4966a6f5c99d754e01fe833692
+  metadata.gz: 69627d390ec62e075dd85944b4af454928cc0b47e1eaaba8c52b66be8973832cd5142b0907584015a6df2a975657991fa184691d595b060942ee9b0e4010b543
+  data.tar.gz: 1096f646ca7a0d6aeb2c337e8e35b0fdd5624035b6a0df3b305828656a8bf50dc0f61540c7434a573bf1ddab2c71afdd7a535b1042dfea58630ca45ab90c30e4

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
     $ gem install opsworks_ship
     
+### Shipping app code
+
 Create a script (probably in `bin/deploy`) similar to the following:
 
         #!/usr/bin/env ruby
@@ -27,18 +29,34 @@ Create a script (probably in `bin/deploy`) similar to the following:
         gem 'opsworks_ship'
         require 'opsworks_ship/deploy'
         
-        initialize(stack_name, revision, app_type, app_layer_name_regex, hipchat_auth_token = nil, hipchat_room_id = nil)
+        OpsworksShip::Deploy.new(stack_name: ARGV[0], revision: ARGV[1], app_type: 'rails', app_layer_name_regex: 'rails|sidekiq', hipchat_auth_token: 'my_hipchat_auth_token', hipchat_room_id: 12345).deploy
+
+### Shipping and executing chef code
+
+Create a script (probably in `bin/chef`) similar to the following:
+
+        #!/usr/bin/env ruby
+        
+        require 'opsworks_ship/chef'
         
-        args = [ARGV[0], ARGV[1], 'rails', 'rails|sidekiq', 'abcde_this_is_a_token', 12345].compact
-        OpsworksShip::Deploy.new(*args).deploy
+        OpsworksShip::Chef.new(stack_name: ARGV[0], revision: ARGV[1], app_type: 'rails', app_layer_name_regex: 'rails|sidekiq', hipchat_auth_token: 'my_hipchat_auth_token', hipchat_room_id: 12345).deploy
+
 
 ## Usage examples
 
+### App code
+
 * `./bin/deploy help`
 * `./bin/deploy staging heads/master rails rails|sidekiq`
 * `./bin/deploy staging heads/master rails rails|sidekiq my_hipchat_token my_hipchat_room`
 * `./bin/deploy production heads/master java "Java App Server" my_hipchat_token my_hipchat_room`
 
+### Chef code
+
+* `./bin/chef help`
+* `./bin/chef staging heads/master rails rails|sidekiq`
+* `./bin/chef staging heads/my_test_branch rails rails|sidekiq`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -53,4 +71,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/NEWECX
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/opsworks_ship.rb

@@ -2,4 +2,5 @@ require "opsworks_ship/version"
 
 module OpsworksShip
   autoload :Deploy, 'opsworks_ship/deploy'
+  autoload :Chef, 'opsworks_ship/chef'
 end

data/lib/opsworks_ship/aws_data_helper.rb

@@ -0,0 +1,69 @@
+module AwsDataHelper
+
+  def layer_instance_ids(layer_ids)
+    layer_ids.map do |layer_id|
+      JSON.parse(`aws opsworks describe-instances --layer-id=#{layer_id}`)['Instances'].map{|i| i['InstanceId']}
+    end.flatten
+  end
+
+  def relevant_instance_ids(stack_id)
+    layer_instance_ids(relevant_app_layer_ids(stack_id))
+  end
+
+  def relevant_app_layer_ids(stack_id)
+    stack_layers(stack_id).select{|l| l['Name'] =~ /#{@app_layer_name_regex}/i}.map{|layer_data| layer_data['LayerId']}
+  end
+
+  def stack_layers(stack_id)
+    JSON.parse(`aws opsworks describe-layers --stack-id=#{stack_id}`)['Layers']
+  end
+
+  def opsworks_app_types
+    [
+        'aws-flow-ruby',
+        'java',
+        'rails',
+        'php',
+        'nodejs',
+        'static',
+        'other',
+    ]
+  end
+
+  def all_stack_names
+    @all_stack_names ||= stack_data.map{|s| s['Name']}.sort
+  end
+
+  def stack_data
+    @stack_data ||= begin
+      JSON.parse(`aws opsworks describe-stacks`)['Stacks']
+    end
+  end
+
+  def stack_id
+    stack = stack_data.select{|s| s['Name'].downcase == @stack_name.downcase}.first
+    if stack
+      stack['StackId']
+    else
+      raise "Stack not found.  Available opsworks stacks: #{all_stack_names}"
+    end
+  end
+
+  def app_id(stack_id)
+    JSON.parse(`aws opsworks describe-apps --stack-id=#{stack_id}`)['Apps'].select{|a| a['Type'] == @app_type}.first['AppId']
+  end
+
+  def describe_deployments(deployment_id)
+    cmd = "aws opsworks describe-deployments --deployment-ids #{deployment_id}"
+    JSON.parse(`#{cmd}`)
+  end
+
+  def per_server_status_descriptions(deployment_id)
+    JSON.parse(`aws opsworks describe-commands --deployment-id #{deployment_id}`)['Commands'].map{|deploy| "#{instance_name(deploy['InstanceId'])} - Status: #{deploy['Status']} - Log: #{deploy['LogUrl']}"}
+  end
+
+  def instance_name(instance_id)
+    JSON.parse(`aws opsworks describe-instances --instance-id #{instance_id}`)['Instances'].first['Hostname']
+  end
+
+end

data/lib/opsworks_ship/aws_deployment_helper.rb

@@ -0,0 +1,64 @@
+module AwsDeploymentHelper
+
+  def timestamped_puts(str)
+    puts "#{Time.now}  #{str}"
+  end
+
+  def deployed_by
+    git_user = `git config --global user.name`.chomp
+    git_email = `git config --global user.email`.chomp
+    "#{git_user} (#{git_email})"
+  end
+
+  def syntax
+    puts "Arguments: #{method(:initialize).parameters.map{|p| "#{p.last} (#{p.first})"}.join(' ')}"
+    puts "\n"
+    puts "Valid stacks: #{all_stack_names}}"
+  end
+
+  def monitor_deployment(deployment_id)
+    deployment_finished = false
+    status = ""
+    while !deployment_finished
+      response = describe_deployments(deployment_id)
+      response["Deployments"].each do |deployment|
+        next if deployment["DeploymentId"] != deployment_id
+        status = deployment["Status"]
+        timestamped_puts "Status: #{status}"
+        deployment_finished = true if deployment["Status"].downcase != "running"
+      end
+      sleep(15) unless deployment_finished
+    end
+    timestamped_puts "Deployment #{status}"
+    output_per_server_status_descriptions(deployment_id)
+    status
+  end
+
+  def start_deployment(command)
+    app_id = app_id(stack_id)
+
+    cmd = "aws opsworks create-deployment --app-id #{app_id} " +
+        "--stack-id #{stack_id} " +
+        "--command \"#{command}\" " +
+        "--instance-ids #{relevant_instance_ids(stack_id).join(' ')} " +
+        deploy_comment
+
+    timestamped_puts "Running command... #{command}"
+    timestamped_puts cmd
+
+    response = JSON.parse(`#{cmd}`)
+    response["DeploymentId"]
+  end
+
+  def deploy_comment
+    "--comment \"rev. #{@revision}, deployed by #{deployed_by}\" "
+  end
+
+  def output_per_server_status_descriptions(deployment_id)
+    per_server_status_descriptions(deployment_id).each do |description|
+      timestamped_puts description
+      puts ''
+    end
+  end
+
+end

data/lib/opsworks_ship/chef.rb

@@ -0,0 +1,72 @@
+require 'json'
+
+require "opsworks_ship/aws_data_helper"
+include AwsDataHelper
+
+require "opsworks_ship/aws_deployment_helper"
+include AwsDeploymentHelper
+
+require "opsworks_ship/hipchat_helper"
+include HipchatHelper
+
+module OpsworksShip
+  class Chef
+    def initialize(stack_name:, revision:, app_type:, app_layer_name_regex:, hipchat_auth_token: nil, hipchat_room_id: nil)
+      @stack_name = stack_name
+      raise "Invalid stack name, valid stacks are: #{all_stack_names}" unless all_stack_names.any?{|available_name| available_name == stack_name}
+
+      @revision = revision
+
+      @app_type = app_type
+      raise "Invalid app type #{@app_type}" unless opsworks_app_types.include?(@app_type)
+
+      @app_layer_name_regex = app_layer_name_regex
+
+      @hipchat_auth_token = hipchat_auth_token
+      @hipchat_room_id = hipchat_room_id
+      raise "Must supply both or neither hipchat params" if [@hipchat_auth_token, @hipchat_room_id].compact.size == 1
+    end
+
+    def deploy
+      start_time = Time.now
+
+      puts "\n-------------------------------------"
+      puts "Full chef run started"
+      puts "Revision: #{@revision}"
+      puts "Stack: #{@stack_name}"
+      puts "-------------------------------------\n\n"
+
+      set_revision_for_stack
+
+      [
+        'update_custom_cookbooks',
+        'update_dependencies',
+        'setup',
+        'configure',
+      ].each{|command| run_and_monitor(command)}
+
+      msg = "#{@app_type} -- Full chef run successful! Layers #{@app_layer_name_regex} now on #{@revision} deployed to #{@stack_name} by #{deployed_by}"
+      post_deployment_to_hipchat(msg)
+
+      run_time_seconds = Time.now.to_i - start_time.to_i
+      timestamped_puts "Deployment time #{run_time_seconds / 60}:%02i" % (run_time_seconds % 60)
+    end
+
+    def run_and_monitor(command)
+      deployment_id = start_deployment({ :Name => command }.to_json.gsub('"', "\\\""))
+      final_status = monitor_deployment(deployment_id)
+
+      unless final_status.downcase =~ /successful/
+        raise "Deployment failed, status: #{final_status}"
+      end
+    end
+
+    def set_revision_for_stack
+      timestamped_puts "Setting revision #{@revision}"
+      cmd = "aws opsworks update-stack --stack-id #{stack_id} --custom-cookbooks-source Revision=#{@revision}"
+      timestamped_puts "#{cmd}"
+      `#{cmd}`
+    end
+
+  end
+end

data/lib/opsworks_ship/deploy.rb

@@ -1,5 +1,14 @@
 require 'json'
 
+require "opsworks_ship/aws_data_helper"
+include AwsDataHelper
+
+require "opsworks_ship/aws_deployment_helper"
+include AwsDeploymentHelper
+
+require "opsworks_ship/hipchat_helper"
+include HipchatHelper
+
 module OpsworksShip
   class Deploy
     def initialize(stack_name:, revision:, app_type:, app_layer_name_regex:, hipchat_auth_token: nil, hipchat_room_id: nil)
@@ -18,12 +27,6 @@ module OpsworksShip
       raise "Must supply both or neither hipchat params" if [@hipchat_auth_token, @hipchat_room_id].compact.size == 1
     end
 
-    def syntax
-      puts "Arguments: #{method(:initialize).parameters.map{|p| "#{p.last} (#{p.first})"}.join(' ')}"
-      puts "\n"
-      puts "Valid stacks: #{all_stack_names}}"
-    end
-
     def deploy
       start_time = Time.now
 
@@ -35,7 +38,7 @@ module OpsworksShip
 
       set_revision_in_opsworks_app
 
-      deployment_id = start_deployment
+      deployment_id = start_deployment({ :Name => "deploy" }.to_json.gsub('"', "\\\""))
       final_status = monitor_deployment(deployment_id)
 
       if final_status.downcase =~ /successful/
@@ -49,25 +52,6 @@ module OpsworksShip
       timestamped_puts "Deployment time #{run_time_seconds / 60}:%02i" % (run_time_seconds % 60)
     end
 
-    def all_stack_names
-      @all_stack_names ||= stack_data.map{|s| s['Name']}.sort
-    end
-
-    def stack_data
-      @stack_data ||= begin
-        JSON.parse(`aws opsworks describe-stacks`)['Stacks']
-      end
-    end
-
-    def stack_id
-      stack = stack_data.select{|s| s['Name'].downcase == @stack_name.downcase}.first
-      if stack
-        stack['StackId']
-      else
-        raise "Stack not found.  Available opsworks stacks: #{all_stack_names}"
-      end
-    end
-
     def set_revision_in_opsworks_app
       timestamped_puts "Setting revision #{@revision}"
       cmd = "aws opsworks update-app --app-id #{app_id(stack_id)} --app-source Revision=#{@revision}"
@@ -75,118 +59,5 @@ module OpsworksShip
       `#{cmd}`
     end
 
-    def app_id(stack_id)
-      JSON.parse(`aws opsworks describe-apps --stack-id=#{stack_id}`)['Apps'].select{|a| a['Type'] == @app_type}.first['AppId']
-    end
-
-    def timestamped_puts(str)
-      puts "#{Time.now}  #{str}"
-    end
-
-    def deployed_by
-      git_user = `git config --global user.name`.chomp
-      git_email = `git config --global user.email`.chomp
-      "#{git_user} (#{git_email})"
-    end
-
-    def deploy_comment
-      "--comment \"rev. #{@revision}, deployed by #{deployed_by}\" "
-    end
-
-    def deploy_command
-      { :Name => "deploy" }.to_json.gsub('"', "\\\"")
-    end
-
-    def monitor_deployment(deployment_id)
-      deployment_finished = false
-      status = ""
-      while !deployment_finished
-        response = describe_deployments(deployment_id)
-        response["Deployments"].each do |deployment|
-          next if deployment["DeploymentId"] != deployment_id
-          status = deployment["Status"]
-          timestamped_puts "Status: #{status}"
-          deployment_finished = true if deployment["Status"].downcase != "running"
-        end
-        sleep(15) unless deployment_finished
-      end
-      timestamped_puts "Deployment #{status}"
-      status
-    end
-
-    def describe_deployments(deployment_id)
-      cmd = "aws opsworks describe-deployments --deployment-ids #{deployment_id}"
-      JSON.parse(`#{cmd}`)
-    end
-
-    def start_deployment
-      app_id = app_id(stack_id)
-
-      cmd = "aws opsworks create-deployment --app-id #{app_id} " +
-          "--stack-id #{stack_id} " +
-          "--command \"#{deploy_command}\" " +
-          "--instance-ids #{relevant_instance_ids(stack_id).join(' ')} " +
-          deploy_comment
-
-      timestamped_puts "Starting deployment..."
-      timestamped_puts cmd
-
-      response = JSON.parse(`#{cmd}`)
-      response["DeploymentId"]
-    end
-
-    def post_deployment_to_hipchat(msg)
-      room_id = (@hipchat_room_id || ENV['HIPCHAT_ROOM_ID']).to_i
-      auth_token = @hipchat_auth_token || ENV['HIPCHAT_AUTH_TOKEN']
-
-      return unless room_id > 0 && auth_token
-
-      post_data = {
-        :name => "Deployments",
-        :privacy => 'private',
-        :is_archived => false,
-        :is_guest_accessible => true,
-        :topic => 'curl',
-        :message => msg,
-        :color => 'green',
-        :owner => { :id => 5 }
-      }
-
-      url = "https://api.hipchat.com/v2/room/#{room_id}/notification"
-      cmd = "curl --header \"content-type: application/json\" --header \"Authorization: Bearer #{auth_token}\" -X POST -d \"#{post_data.to_json.gsub('"', '\\"')}\" #{url}"
-      puts cmd
-      `#{cmd}`
-    end
-
-    def layer_instance_ids(layer_ids)
-      layer_ids.map do |layer_id|
-        JSON.parse(`aws opsworks describe-instances --layer-id=#{layer_id}`)['Instances'].map{|i| i['InstanceId']}
-      end.flatten
-    end
-
-    def relevant_instance_ids(stack_id)
-      layer_instance_ids(relevant_app_layer_ids(stack_id))
-    end
-
-    def relevant_app_layer_ids(stack_id)
-      stack_layers(stack_id).select{|l| l['Name'] =~ /#{@app_layer_name_regex}/i}.map{|layer_data| layer_data['LayerId']}
-    end
-
-    def stack_layers(stack_id)
-      JSON.parse(`aws opsworks describe-layers --stack-id=#{stack_id}`)['Layers']
-    end
-
-    def opsworks_app_types
-      [
-        'aws-flow-ruby',
-        'java',
-        'rails',
-        'php',
-        'nodejs',
-        'static',
-        'other',
-      ]
-    end
-
   end
 end

data/lib/opsworks_ship/hipchat_helper.rb

@@ -0,0 +1,26 @@
+module HipchatHelper
+
+  def post_deployment_to_hipchat(msg)
+    room_id = (@hipchat_room_id || ENV['HIPCHAT_ROOM_ID']).to_i
+    auth_token = @hipchat_auth_token || ENV['HIPCHAT_AUTH_TOKEN']
+
+    return unless room_id > 0 && auth_token
+
+    post_data = {
+        :name => "Deployments",
+        :privacy => 'private',
+        :is_archived => false,
+        :is_guest_accessible => true,
+        :topic => 'curl',
+        :message => msg,
+        :color => 'green',
+        :owner => { :id => 5 }
+    }
+
+    url = "https://api.hipchat.com/v2/room/#{room_id}/notification"
+    cmd = "curl --header \"content-type: application/json\" --header \"Authorization: Bearer #{auth_token}\" -X POST -d \"#{post_data.to_json.gsub('"', '\\"')}\" #{url}"
+    puts cmd
+    `#{cmd}`
+  end
+
+end

data/lib/opsworks_ship/version.rb

@@ -1,3 +1,3 @@
 module OpsworksShip
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opsworks_ship
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Seth Ringling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,11 @@ files:
 - bin/console
 - bin/setup
 - lib/opsworks_ship.rb
+- lib/opsworks_ship/aws_data_helper.rb
+- lib/opsworks_ship/aws_deployment_helper.rb
+- lib/opsworks_ship/chef.rb
 - lib/opsworks_ship/deploy.rb
+- lib/opsworks_ship/hipchat_helper.rb
 - lib/opsworks_ship/version.rb
 - opsworks_ship.gemspec
 homepage: https://github.com/NEWECX/opsworks_ship