cfn-events 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 621408083d1bba4edfe098f3f181776314710623
+  data.tar.gz: d9dcb6f239a057a245b8bd69dce57c31f9506a25
+SHA512:
+  metadata.gz: 64e98618f9850875f448b5a239b5034ce8a67042e57d8292008650271646fecf35c1ca55a5bda1fd4ba58375495f6fe8678d8c60042227f86b1612223f71d870
+  data.tar.gz: a6946e16c668f60fcb3811d4f49475d6c74944f1e700ddfd88c059e36de7bd3ba77fa61df72adb3804d3e59ccb55b6b66bbb9bd32b8f59bdc649eb484fc69d8f

data/bin/cfn-events

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'aws-sdk'
+require 'json'
+require 'time'
+
+require 'cfn-events'
+
+config = CfnEvents::Config.new
+
+opts_parser = OptionParser.new do |opts|
+  opts.banner = "
+  cfn-events [OPTIONS] STACK-NAME-OR-ID
+  "
+  opts.separator "Controlling which events to select:"
+  opts.on("-r", "--region=s", "CloudFormation region"){|r| config.client_options = { region: r } }
+  opts.on("-s", "--since=s", "Don't show any events earlier than this time"){|s| config.since = Time.parse(s).to_time }
+  opts.separator ""
+  opts.separator "Controlling the output format:"
+  opts.on("-j", "--json", "Output events as json"){ config.output_json = true }
+  opts.separator ""
+  opts.separator "Controlling when to stop:"
+  opts.on("-w", "--wait", "Stop once the stack reaches a stable state"){ config.wait = true }
+  opts.on("-f", "--forever", "Keep showing events (until killed)"){ config.forever = true }
+  opts.on("-p", "--poll-interval=n", "Poll interval, in seconds"){|t| config.poll_seconds = t.to_f }
+  opts.separator <<-EOF
+
+If neither --wait nor --forever are used, then cfn-events exits once any
+currently-available events have been displayed (and --poll-interval has no
+effect).
+
+If --wait is used, then cfn-events keeps reading events (respecting the given
+--poll-interval) until the stack reaches a non-"IN_PROGRESS" state.  The exit
+status depends on what state the stack ends up in.  If it's a FAILED state,
+the exit status is 2; if it's a ROLLBACK state; the exit status is 1;
+otherwise, the exit status is 0.
+
+If --forever is used, then cfn-events keeps reading events until killed, or
+an error occurs.
+
+  EOF
+end
+opts_parser.parse!
+
+unless ARGV.count == 1
+  $stderr.puts "Usage: cfn-events [OPTIONS] STACK-NAME-OR-ID"
+  $stderr.puts "See 'cfn-events --help' for more"
+  exit 2
+end
+config.stack_name_or_id = ARGV.first
+
+rc = CfnEvents::Runner.new(config).run
+exit rc
+
+# eof cfn-events

data/lib/cfn-events/client.rb

@@ -0,0 +1,25 @@
+module CfnEvents
+
+  class Client
+
+    def self.configure
+      Aws.config.merge! core_v2_options
+    end
+
+    def self.core_v2_options
+      {
+	http_proxy: get_proxy,
+	user_agent_suffix: "cfn-events #{VERSION}",
+	# http_wire_trace: true,
+      }
+    end
+
+    def self.get_proxy
+      e = ENV['https_proxy']
+      e = "https://#{e}" if e && !e.empty? && !e.start_with?('http')
+      return e
+    end
+
+  end
+  
+end

data/lib/cfn-events/config.rb

@@ -0,0 +1,32 @@
+module CfnEvents
+
+  class Config
+    # Stronger builder pattern would be nice
+    attr_accessor :client_options, :cfn_client,
+      :stack_name_or_id,
+      :output_json,
+      :since, :wait, :forever, :poll_seconds
+
+    def initialize
+      @client_options = {}
+      @since = nil
+      @output_json = false
+      @wait = false
+      @forever = false
+      @poll_seconds = 5
+    end
+
+    def build
+      if !@stack_name_or_id
+        raise "Missing stack_name_or_id"
+      end
+
+      if @wait and @forever
+        raise "wait and forever cannot be combined"
+      end
+
+      self
+    end
+  end
+
+end

data/lib/cfn-events/runner.rb

@@ -0,0 +1,104 @@
+module CfnEvents
+
+  class Runner
+
+    def initialize(config)
+      @config = config
+
+      @config.cfn_client ||= begin
+                               effective_options = CfnEvents::Client.core_v2_options.merge(config.client_options)
+                               Aws::CloudFormation::Client.new(effective_options)
+                             end
+    end
+
+    def core_v2_options
+      i
+    end
+
+    def resolve_stack(stack_name_or_id)
+      ans = @config.cfn_client.describe_stacks(stack_name: stack_name_or_id).data.stacks[0].stack_id
+      if ans != stack_name_or_id
+        $stderr.puts "Resolved #{stack_name_or_id} to #{ans}"
+      end
+      ans
+    end
+
+    def all_events
+      @config.cfn_client.describe_stack_events(stack_name: @stack_id).data.stack_events.reverse
+    end
+
+    def events_since_time(t)
+      # There may be a more efficient algorithm
+      all_events.select {|e| e.timestamp > t }
+    end
+
+    def events_since_id(id)
+      # There may be a more efficient algorithm
+      events = all_events
+      i = events.index {|e| e.event_id == id }
+      if i < 0
+        events
+      else
+        events[i+1..-1]
+      end
+    end
+
+    def show_events(events)
+      events.each do |e|
+        if @config.output_json
+          puts JSON.generate(e.to_h)
+        else
+          puts [
+            e.timestamp.utc.strftime('%Y-%m-%dT%H:%M:%SZ'),
+            e.resource_type,
+            e.resource_status,
+            e.logical_resource_id,
+            e.physical_resource_id,
+            e.resource_status_reason,
+          ].join " "
+        end
+      end
+    end
+
+    def steady_state?(e)
+      e.resource_type == "AWS::CloudFormation::Stack" and not e.resource_status.match(/IN_PROGRESS/)
+    end
+
+    # Calls $stdout.sync.  Returns 0/1/2, like the command line exit code.
+    def run
+      @stack_id = resolve_stack(@config.stack_name_or_id)
+
+      events = if @config.since
+                 events_since_time(@config.since)
+               else
+                 all_events
+               end
+
+      show_events(events)
+
+      return 0 unless @config.forever or @config.wait
+
+      # I'm assuming / pretending that by this point, events.empty? is never true
+      # FIXME! It's false.  If --since was used, and there have been no events since
+      # that time.  That's a bug. :-(
+
+      while @config.forever or not steady_state?(events.last)
+        $stdout.sync
+        sleep @config.poll_seconds
+
+        new_events = events_since_id(events.last.event_id)
+
+        unless new_events.empty?
+          show_events(new_events)
+          events = new_events
+        end
+      end
+
+      return 2 if events.last.resource_status.match /FAILED/
+      return 1 if events.last.resource_status.match /ROLLBACK/
+      return 0
+    end
+
+  end
+
+end

data/lib/cfn-events/version.rb

@@ -0,0 +1,3 @@
+module CfnEvents
+  VERSION = '0.1.0'
+end

data/lib/cfn-events.rb

@@ -0,0 +1,4 @@
+require_relative './cfn-events/client.rb'
+require_relative './cfn-events/config.rb'
+require_relative './cfn-events/runner.rb'
+require_relative './cfn-events/version.rb'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: cfn-events
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rachel Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "\n    cfn-events reads the events for an AWS CloudFormation stack.  It
+  can\n    be used to \"tail\" the log, and to wait until a stack update is resolved,\n
+  \   successfully or otherwise.\n\n    Defaults to eu-west-1, or whatever $AWS_REGION
+  is set to.\n    Respects $https_proxy.\n  "
+email: cfn-events-git@rve.org.uk
+executables:
+- cfn-events
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cfn-events
+- lib/cfn-events.rb
+- lib/cfn-events/client.rb
+- lib/cfn-events/config.rb
+- lib/cfn-events/runner.rb
+- lib/cfn-events/version.rb
+homepage: https://github.com/rvedotrc/cfn-events
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Watch AWS CloudFormation stack events and wait for completion
+test_files: []