cfn-flow 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e00390b3fd3c7698003efd85d99fc576e885ba3
-  data.tar.gz: 881bb3936515feb3db9801637767c13db1b2ab9e
+  metadata.gz: 96e7a912fc803e4d51267f48e138ae273455d424
+  data.tar.gz: 0827e20cf4a86e42063c55648d50531522bdc769
 SHA512:
-  metadata.gz: 511ada328d1a675b712cb20ad14d94e01a1940fedfb5da0e196609d9dfd2845a155c09932115c1858a13c831684d1f03d316106d2bdb87ccc28f8b0c906c6eed
-  data.tar.gz: b3e5baf4a020bc72e6ada19e6e16ae758a678e3c3aded9973ced8bd6bc84b71d3ee576035cd9f35ee8d1c3bdfea1da4a44dd91f65f53b09d450a62ef5c2d43a3
+  metadata.gz: e20d070594f969140f946c1f2cc37ae777bbc795ef846a375d9e064c5078912810d8200018bca251ad0a73bbd6c9437f453fe71915c3875a12a15526ef6ac9b6
+  data.tar.gz: f0eb7fb958048dc13915255067efdb45e7d06941a50e291a0949aa90f6627f616bc0bc8b3de31ed0236224def48651a974130b68917e58cc992260af74bebdaf

data/README.md

@@ -1,17 +1,21 @@
 # cfn-flow
-An opinionated command-line workflow for developing [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates and deploying stacks.
+`cfn-flow` is an command-line tool for developing [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates and deploying stacks.
 
-Track template changes in git and publish versioned releases to AWS S3.
-
-Deploy stacks using a standard, reliable process with extensible
-configuration in git.
+It provides a *simple*, *standard*, and *flexible* process for using CloudFormation, ideal for DevOps-style organizations.
 
 #### Opinions
 
-1. *Optimize for onboarding.* The workflow should be simple to learn & understand.
-2. *Optimize for happiness.* The workflow should be easy and enjoyable to use.
-3. *Auditable changes.* Know who changed what when. Leverage git change history.
-4. *Immutable releases.* The code in a release never changes.
+`cfn-flow` introduces a consist, convenient workflow that encourages good template organization
+and deploy practices.
+
+1. *Optimize for happiness.* The workflow should be easy and enjoyable to use.
+2. *Optimize for onboarding.* The workflow should be simple to learn & understand.
+3. *Auditable changes.* Know who changed what when. Leverage git history.
+4. *Immutable releases.* The code in a release never changes. To make a change,
+   launch a new stack.
+
+The features & implementation of `cfn-flow` itself must also be simple. This follows the Unix philosophy of "[worse is
+better](http://www.jwz.org/doc/worse-is-better.html)". `cfn-flow` values a simple design and implementation, and being composable with other workflows over handling every edge case out of the box.
 
 ## Installation
 
@@ -24,8 +28,8 @@ The `git` command is also needed.
 
 ## Usage
 
-Poke around:
 ```
+# Get help
 cfn-flow help
 
 cfn-flow help COMMAND
@@ -33,11 +37,74 @@ cfn-flow help COMMAND
 cfn-flow help deploy
 ```
 
-Launching a CloudFormation stack:
+Launch a CloudFormation stack:
 ```
 cfn-flow deploy production
 ```
 
+## How it works
+
+`cfn-flow` works from a directory containing a `cfn-flow.yml` config file, and a CloudFormation template.
+Presumably your app code is in the same directory, but it doesn't have to be.
+
+There are two key concepts for `cfn-flow`: **services** and **environments**.
+
+#### Services
+
+A service is a name for your project and comprises a set of resources that
+change together. Each service has it's own `cfn-flow.yml` config file. A service
+can be instantiated as several distinct environments.
+
+For example, a `WebApp` service could have a CloudFormation template that
+creates an ELB, LaunchConfig, and AutoScalingGroup resources.
+
+All the resources in a service change together. Deploying the `WebApp`
+service to an environment will create a new ELB, LaunchConfig, and AutoScalingGroup.
+
+Resources that *do not* change across deploys are not part of the service (from
+`cfn-flow`'s perspective).
+Say all `WebApp` EC2 servers connect to a long-running RDS database. That
+database is not part of the cfn-flow service because it should re-used across
+deploys. The database is a *backing resource* the service uses; not part
+of the service itself.
+
+#### Environments
+
+An environment is an particular instantiation of a service. For example, you
+could deploy your `WebApp` service to both a `development` and `production` environment.
+
+`cfn-flow` is designed to support arbitrary environments like git supports
+arbitrary branches.
+
+Then `CFN_FLOW_ENVIRONMENT` environment variable can be used in
+`cfn-flow.yml` to use the environment in your template parameters.
+
+#### Deploying
+
+Deployments consist of launching a *new stack* in a particular environment, then
+shutting down the old stack. For example:
+
+```
+cfn-flow deploy ENVIRONMENT --cleanup
+```
+
+This follows the [red/black](http://techblog.netflix.com/2013/08/deploying-netflix-api.html)
+or [blue/green](http://martinfowler.com/bliki/BlueGreenDeployment.html)
+deployment pattern.
+
+After verifying the new stack is working correctly, the deployer is expected to
+delete the old stack.
+
+To roll back a bad deploy, simply delete the *new* stack, while the *old*
+stack is running.
+
+Although CloudFormation supports updating existing stacks, `cfn-flow` prefers
+launching immutable stacks. Stack updates are more difficult to test than new stacks; and there's less chance of a deployment error disrupting or breaking important resources.
+
+#### AWS credentials
+
+Set your AWS credentials so they can be found by the AWS SDK for Ruby ([details here](http://docs.aws.amazon.com/AWSSdkDocsRuby/latest/DeveloperGuide/set-up-creds.html)), e.g. using the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
+
 ## Configuration
 
 `cfn-flow` looks for `./cfn-flow.yml` for stack and template configuration.
@@ -55,6 +122,7 @@ stack:
   # Stack name uses embedded ruby to support dynamic values
   stack_name: MyService-<%= Time.now.to_i %>
   # Required: *either* template_url or template_body
+  # NB: template_body is a local path to the template
   template_body: path/to/template.json
   # Alternatively:
   # template_url: https://MyS3Bucket.s3.amazonaws.com/MyPrefix/release/abc123/template.json
@@ -81,8 +149,16 @@ templates:
   bucket: MyS3Bucket
   s3_prefix: 'My/S3/Prefix'
 
+##
+# Stacks
+#
+# These are the arguments passed when launching a new stack.
+# It's nearly identical to the create_stack args in the ruby sdk, except
+# parameters and tags are hashes. See http://amzn.to/1M0nBuq
+
 stack:
   stack_name: MyService-<%= Time.now.to_i %>
+    # NB: template_body is a local path to the template
     template_body: path/to/template.yml
     template_url: http://...
     parameters:
@@ -97,6 +173,8 @@ stack:
     stack_policy_body: "StackPolicyBody",
     stack_policy_url: "StackPolicyURL",
     tags:
+      # Whatever you want.
+      # Note that `cfn-flow` automatically adds two tags: `CfnFlowService` and `CfnFlowEnvironment`
       TagKey: TagValue
       # Who launched this stack
       Deployer: <%= ENV['USER'] %>
@@ -104,121 +182,145 @@ stack:
       BillingType: <%= ENV['CFN_FLOW_ENVIRONMENT'] == 'production' ?  'production' : 'development' %>
 ```
 
-#### Dev mode (default)
+### UX improvements:
 
-Dev mode allows you to quickly test template changes.
-`cfn-flow` validates all templates and uploads them to your personal prefix, overwriting existing templates.
+`cfn-flow` includes a few developer-friendly features:
 
-Dev mode does not verify that your local changes are
-committed to git (as opposed to release mode).
+#### YAML > JSON
 
-You should use dev mode for testing & verifying changes in non-production stacks.
+`cfn-flow` lets you write templates in either JSON or
+[YAML](http://www.yaml.org). YAML is a superset of JSON that allows a terser,
+less cluttered syntax, inline comments, and code re-use with anchors (like
+variables). YAML templates are transparently converted to JSON when uploaded to
+S3 for use in CloudFormation stacks.
 
-```
-# Set a personal name to prefix your templates.
-export CFN_FLOW_DEV_NAME=aaron
+Note that you can use JSON snippets inside YAML templates. JSON is always valid
+YAML.
+
+#### Embedded ruby in `cfn-flow.yml`
 
-# Validate and upload all CloudFormation templates in your working directory to
-s3://my-bucket/dev/aaron/*
-# NB that this overwrites existing templates in your CFN_FLOW_DEV_NAME
-namespace.
+To allow dynamic/programatic attributes, use
+[ERB](https://en.wikipedia.org/wiki/ERuby) in `cfn-flow.yml`. For example:
 
-cfn-flow
+```yaml
+stack:
+  name: my-stack-<%= Time.now.to_i %>
+  ...
+  parameters:
+    git_sha: <%= `git rev-parse --verify HEAD`.chomp %>
 ```
 
-You can launch or update test stacks using your dev template path to quickly test your
-template changes.
+## Usage
+
+### Working with stacks
+
+`cfn-flow` automatically sets two tags on any stack it launches:
+
+Name | Example value
+--- | ---
+CfnFlowService | `myapp`
+CfnFlowEnvironment | `production`
 
-#### Release mode
+These tags let `cfn-flow` associate stacks back to services & environments.
 
-Release mode publishes your templates to a versioned S3 path, and pushes a git
-tag of the version.
+#### `cfn-flow deploy ENVIRONMENT`
+
+Launches a stack in ENVIRONMENT. E.g. `cfn-flow deploy production`
+
+Add the `--cleanup` option to be prompted to shut down other stacks in the environment.
+
+#### `cfn-flow list ENVIRONMENT`
+
+Show running stacks for ENVIRONMENT.
 
 ```
-# uploads templates to `s3://my-bucket/release/<git sha>/*`
-tag
-cfn-flow --release
+$ cfn-flow list production
+
+myapp-production-aaa (CREATE_COMPLETE)
+myapp-production-bbb (CREATE_FAILED)
 ```
 
-Release mode ensures there are no uncommitted changes in your git working
-directory.
+#### `cfn-flow delete STACK`
 
-Inspecting the differences between releases is possible using `git log` and `git
-diff`.
+Deletes a stack.
 
-## Configuration
+```
+$ cfn-flow delete myapp-production-aaa
+```
 
-You can configure cfn-flow defaults by creating a `cfn-flow.yml` file in same
-directory you run `cfn-flow` (presumably the root of your project).
+#### `cfn-flow show STACK`
 
-Settings in the configuration file are overridden by environment variables. And
-environment variables are overridden by command line arguments.
+Show the status of STACK.
 
-```
-# cfn-flow.yml in the root of your project
-# You can specify an alternative path by setting the CFN_FLOW_CONFIG environment
-# variable.
-#
-# All options in this config can be overridden with command line arguments
----
-# S3 bucket where templates are uploaded. No default.
-# Override with CFN_FLOW_BUCKET env var
-bucket: 'my-s3-bucket'
+#### `cfn-flow events STACK`
+
+List events for STACK
 
-# S3 path prefix. Default: none
-# Override with CFN_FLOW_TO env var
-to: my/project/prefix
+Use the `--tail` option to poll for new events until the stack status is no
+longer `*_IN_PROGRESS`
 
-# Local path in which to recursively search for templates. Default: .
-# Override with CFN_FLOW_FROM env var
-from: my/local/prefix
+### Common workflows
+
+#### Deploying to production
 
-# AWS Region
-# Override with AWS_REGION env var
-region: us-east-1 # AWS region
 ```
+# Launch a new stack for the current git commit
+$ cfn-flow deploy production
+Launching stack myapp-production-abc123
+# ... wait for it to be ready
 
-#### AWS credentials
+# See the other stacks
+$ cfn-deploy list production
 
-AWS credentials can only be set using the
-`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables; or by
-using an EC2 instance's IAM role.
+myapp-production-abc123 CREATE_COMPLETE
+myapp-production-xyz987 CREATE_COMPLETE
 
+# Shut down the old stack
+$ cfn-flow delete myapp-production-xyz987
+```
 
-## Sweet Features
+### Launching a development environment
 
-#### YAML > JSON
+Launch a new stack for `myenv` environment
 
-`cfn-flow` lets you write templates in either JSON or
-[YAML](http://www.yaml.org). YAML is a superset of JSON that allows a terser,
-less cluttered syntax, inline comments, and code re-use with variables. YAML
-templates are transparently converted to JSON when uploaded to S3 for use in
-CloudFormation stacks.
+```
+cfn-flow deploy myenv
+```
 
-#### Use versions in nested stack template URLs
+### Working with templates
 
-`cfn-flow` works great with [nested stack
-resources](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html). Use [Fn::Join](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-join.html) to construct the `TemplateURL` from a parameter:
+#### `cfn-flow validate`
 
 ```
-{
-   "Type" : "AWS::CloudFormation::Stack",
-   "Properties" : {
-      "TemplateURL" : {
-        "Fn::Join" : [ ":",
-          [ "https://s3.amazonaws.com/my-bucket", {"Ref": "prefix"}, "my-template.json" ]
-          ]
-      }
-   }
-}
+# Runs validate-template on all templates.
+# returns an error on any failure.
+# does not persist to S3
+
+$ cfn-flow validate path/to/template.yml
 ```
 
-While testing, set the `prefix` parameter to a dev prefix like `dev/aaron`. When you're confident your changes work, release them with cfn-flow and change the `prefix` parameter to `release/<git sha>` for production.
+#### `cfn-flow publish`
+
+Publish templates to S3 with immutable release names, or overwrite "dev names"
+for quicker testing. *This is only needed if you want to use nested stack resources.*
 
-#### Continuous integration
+```
+$ cfn-flow publish path/to/template.yml
+# validates & uploads templates to dev path
+# Env var CFN_FLOW_DEV_NAME=aaron
+# E.g. https://mybucket.s3.amazonaws.com/myprefix/dev/aaron/mytemplate.yml
+
+$ cfn-flow upload --release
+# validates & uploads templates for current git sha
+# E.g. https://mybucket.s3.amazonaws.com/myprefix/deadbeef/mytemplate.yml
+
+$ cfn-flow upload --release=v1.0.0
+# Upload templates for an arbitrary release name
+# E.g. https://mybucket.s3.amazonaws.com/myprefix/v1.0.0/mytemplate.yml
+```
 
-#### Github commit status
+## License
 
-#### Minimal AWS credentials
+Copyright Kickstarter, Inc.
 
-TODO: example IAM policy
+Released under an [MIT License](http://opensource.org/licenses/MIT).

data/lib/cfn-flow.rb

@@ -1,139 +1 @@
-require 'thor'
-require 'aws-sdk'
-require 'multi_json'
-require 'yaml'
-require 'erb'
-
-module CfnFlow
-  class << self
-
-    ##
-    # Configuration
-    def config_path
-      ENV['CFN_FLOW_CONFIG_PATH'] || 'cfn-flow.yml'
-    end
-
-    def load_config
-      @config = YAML.load(
-        ERB.new( File.read(config_path) ).result(binding)
-      )
-      # TODO: Validate config?
-    end
-
-    def config_loaded?
-      @config.is_a? Hash
-    end
-
-    def config
-      load_config unless config_loaded?
-      @config
-    end
-
-    def service
-      unless config.key?('service')
-        raise Thor::Error.new("No service name in #{config_path}. Add 'service: my_app_name'.")
-      end
-      config['service']
-    end
-
-    def stack_params(environment)
-      unless config['stack'].is_a? Hash
-        raise Thor::Error.new("No stack defined in #{config_path}. Add 'stack: ...'.")
-      end
-
-      # Dup & symbolize keys
-      params = config['stack'].map{|k,v| [k.to_sym, v]}.to_h
-
-      # Expand params
-      if params[:parameters].is_a? Hash
-        expanded_params = params[:parameters].map do |key,value|
-          { parameter_key: key, parameter_value: value }
-        end
-        params[:parameters] = expanded_params
-      end
-
-      # Expand tags
-      if params[:tags].is_a? Hash
-        tags = params[:tags].map do |key, value|
-          {key: key, value: value}
-        end
-
-        params[:tags] = tags
-      end
-
-      # Append CfnFlow tags
-      params[:tags] ||= []
-      params[:tags] << { key: 'CfnFlowService', value: service }
-      params[:tags] << { key: 'CfnFlowEnvironment', value: environment }
-
-      # Expand template body
-      if params[:template_body].is_a? String
-        begin
-          body = CfnFlow::Template.new(params[:template_body]).to_json
-          params[:template_body] = body
-        rescue CfnFlow::Template::Error
-          # Do nothing
-        end
-      end
-
-      params
-    end
-
-    def template_s3_bucket
-      unless config['templates'].is_a?(Hash) &&  config['templates']['s3_bucket']
-        raise Thor::Error.new("No s3_bucket defined for templates in #{config_path}. Add 'templates: { s3_bucket: ... }'.")
-      end
-
-      config['templates']['s3_bucket']
-    end
-
-    def template_s3_prefix
-      unless config['templates'].is_a?(Hash)
-        raise Thor::Error.new("No templates defined in #{config_path}. Add 'templates: ... '.")
-      end
-
-      # Ok for this to be ''
-      config['templates']['s3_prefix']
-    end
-
-    ##
-    # Aws Clients
-    def cfn_client
-      @cfn_client ||= Aws::CloudFormation::Client.new(region: config[:region] || ENV['AWS_REGION'])
-    end
-
-    def cfn_resource
-      # NB: increase default retry limit to avoid throttling errors iterating over stacks.
-      # See https://github.com/aws/aws-sdk-ruby/issues/705
-      @cfn_resource ||= Aws::CloudFormation::Resource.new(
-        region: config[:region] || ENV['AWS_REGION'],
-        retry_limit: 10
-      )
-    end
-
-    # Clear aws sdk clients & config (for tests)
-    def clear!
-      @config = @cfn_client = @cfn_resource = nil
-    end
-
-    # Exit with status code = 1 when raising a Thor::Error
-    # Override thor default
-    def exit_on_failure?
-      if instance_variable_defined?(:@exit_on_failure)
-       @exit_on_failure
-      else
-        true
-      end
-    end
-
-    def exit_on_failure=(value)
-      @exit_on_failure = value
-    end
-  end
-end
-
-require 'cfn-flow/template'
-require 'cfn-flow/git'
-require 'cfn-flow/event_presenter'
-require 'cfn-flow/cli'
-require 'cfn-flow/version'
+require 'cfn_flow'

data/lib/cfn_flow.rb

@@ -0,0 +1,138 @@
+require 'thor'
+require 'aws-sdk'
+require 'multi_json'
+require 'yaml'
+require 'erb'
+
+module CfnFlow
+  class << self
+
+    ##
+    # Configuration
+    def config_path
+      ENV['CFN_FLOW_CONFIG_PATH'] || 'cfn-flow.yml'
+    end
+
+    def load_config
+      @config = YAML.load(
+        ERB.new( File.read(config_path) ).result(binding)
+      )
+    end
+
+    def config_loaded?
+      @config.is_a? Hash
+    end
+
+    def config
+      load_config unless config_loaded?
+      @config
+    end
+
+    def service
+      unless config.key?('service')
+        raise Thor::Error.new("No service name in #{config_path}. Add 'service: my_app_name'.")
+      end
+      config['service']
+    end
+
+    def stack_params(environment)
+      unless config['stack'].is_a? Hash
+        raise Thor::Error.new("No stack defined in #{config_path}. Add 'stack: ...'.")
+      end
+
+      # Dup & symbolize keys
+      params = config['stack'].map{|k,v| [k.to_sym, v]}.to_h
+
+      # Expand params
+      if params[:parameters].is_a? Hash
+        expanded_params = params[:parameters].map do |key,value|
+          { parameter_key: key, parameter_value: value }
+        end
+        params[:parameters] = expanded_params
+      end
+
+      # Expand tags
+      if params[:tags].is_a? Hash
+        tags = params[:tags].map do |key, value|
+          {key: key, value: value}
+        end
+
+        params[:tags] = tags
+      end
+
+      # Append CfnFlow tags
+      params[:tags] ||= []
+      params[:tags] << { key: 'CfnFlowService', value: service }
+      params[:tags] << { key: 'CfnFlowEnvironment', value: environment }
+
+      # Expand template body
+      if params[:template_body].is_a? String
+        begin
+          body = CfnFlow::Template.new(params[:template_body]).to_json
+          params[:template_body] = body
+        rescue CfnFlow::Template::Error
+          # Do nothing
+        end
+      end
+
+      params
+    end
+
+    def template_s3_bucket
+      unless config['templates'].is_a?(Hash) &&  config['templates']['s3_bucket']
+        raise Thor::Error.new("No s3_bucket defined for templates in #{config_path}. Add 'templates: { s3_bucket: ... }'.")
+      end
+
+      config['templates']['s3_bucket']
+    end
+
+    def template_s3_prefix
+      unless config['templates'].is_a?(Hash)
+        raise Thor::Error.new("No templates defined in #{config_path}. Add 'templates: ... '.")
+      end
+
+      # Ok for this to be ''
+      config['templates']['s3_prefix']
+    end
+
+    ##
+    # Aws Clients
+    def cfn_client
+      @cfn_client ||= Aws::CloudFormation::Client.new(region: config['region'] || ENV['AWS_REGION'])
+    end
+
+    def cfn_resource
+      # NB: increase default retry limit to avoid throttling errors iterating over stacks.
+      # See https://github.com/aws/aws-sdk-ruby/issues/705
+      @cfn_resource ||= Aws::CloudFormation::Resource.new(
+        region: config['region'] || ENV['AWS_REGION'],
+        retry_limit: 10
+      )
+    end
+
+    # Clear aws sdk clients & config (for tests)
+    def clear!
+      @config = @cfn_client = @cfn_resource = nil
+    end
+
+    # Exit with status code = 1 when raising a Thor::Error
+    # Override thor default
+    def exit_on_failure?
+      if instance_variable_defined?(:@exit_on_failure)
+       @exit_on_failure
+      else
+        true
+      end
+    end
+
+    def exit_on_failure=(value)
+      @exit_on_failure = value
+    end
+  end
+end
+
+require 'cfn_flow/template'
+require 'cfn_flow/git'
+require 'cfn_flow/event_presenter'
+require 'cfn_flow/cli'
+require 'cfn_flow/version'

data/lib/{cfn-flow → cfn_flow}/cli.rb

@@ -28,7 +28,7 @@ module CfnFlow
 
     desc 'publish TEMPLATE [...]', 'Validate & upload templates'
     method_option 'dev-name', type: :string, desc: 'Personal development prefix'
-    method_option :release,   type: :string, desc: 'Upload release', lazy_default: CfnFlow::Git.sha
+    method_option :release,   type: :string, desc: 'Upload release', lazy_default: true
     method_option :verbose,   type: :boolean, desc: 'Verbose output', default: false
     def publish(*templates)
       if templates.empty?
@@ -36,8 +36,6 @@ module CfnFlow
       end
 
       validate(*templates)
-      # TODO: check git is clean before releasing
-      #CfnFlow::Git.check_status if options['release']
 
       release = publish_release
       templates.each do |path|
@@ -95,12 +93,12 @@ module CfnFlow
 
       return if stacks.empty?
 
-      table_header = options['no-header'] ? [] : [['NAME',  'ENVIRONMENT', 'STATUS']]
+      table_header = options['no-header'] ? [] : [['NAME',  'ENVIRONMENT', 'STATUS', 'CREATED']]
       table_data = stacks.map do |s|
         env_tag = s.tags.detect {|tag| tag.key == 'CfnFlowEnvironment'}
         env = env_tag ? env_tag.value : 'NONE'
 
-        [ s.name, env, s.stack_status ]
+        [ s.name, env, s.stack_status, s.creation_time ]
       end
 
       print_table(table_header + table_data)
@@ -143,6 +141,14 @@ module CfnFlow
       end
     end
 
+    ##
+    # Version command
+    desc "version", "Prints the version information"
+    def version
+      say CfnFlow::VERSION
+    end
+    map %w(-v --version) => :version
+
     private
     def find_stack_in_service(name)
       stack = CfnFlow.cfn_resource.stack(name).load
@@ -164,7 +170,8 @@ module CfnFlow
     def publish_release
       # Add the release or dev name to the prefix
       if options[:release]
-        'release/' + options[:release]
+        release = options[:release] == true ? CfnFlow::Git.sha : options[:release]
+        'release/' + release
       elsif options['dev-name']
         'dev/' + options['dev-name']
       elsif ENV['CFN_FLOW_DEV_NAME']

data/lib/cfn_flow/version.rb

@@ -0,0 +1,3 @@
+module CfnFlow
+  VERSION = '0.8.0'
+end

data/spec/{cfn-flow → cfn_flow}/cli_spec.rb

@@ -68,10 +68,18 @@ describe 'CfnFlow::CLI' do
       out.must_match("dev/#{name}")
     end
 
-    it 'can take a release argument' do
-      release = 'v2.0'
-      out, _ = capture_io { cli.start [:publish, template, '--release', release] }
-      out.must_match CfnFlow::Template.new(template).url("release/#{release}")
+    describe 'with --release' do
+      it 'defaults to git sha' do
+        sha = CfnFlow::Git.sha
+        out, _ = capture_io { cli.start [:publish, template, '--release'] }
+        out.must_match CfnFlow::Template.new(template).url("release/#{sha}")
+      end
+
+      it 'can take a value' do
+        release = 'v2.0'
+        out, _ = capture_io { cli.start [:publish, template, '--release', release] }
+        out.must_match CfnFlow::Template.new(template).url("release/#{release}")
+      end
     end
 
     it 'can fail with malformed templates' do
@@ -182,13 +190,13 @@ describe 'CfnFlow::CLI' do
       end
       it 'should print the stack' do
         out, err = capture_io { cli.start [:list] }
-        out.must_match(/mystack\s+production\s+CREATE_COMPLETE/)
+        out.must_match(/mystack\s+production\s+CREATE_COMPLETE\s+#{memo_now.utc}/)
         err.must_equal ''
       end
 
       it 'should print the header' do
         out, _ = capture_io { cli.start [:list] }
-        out.must_match(/NAME\s+ENVIRONMENT\s+STATUS/)
+        out.must_match(/NAME\s+ENVIRONMENT\s+STATUS\s+CREATED/)
       end
 
       it 'should print stacks when passed an environment' do
@@ -213,7 +221,7 @@ describe 'CfnFlow::CLI' do
               stacks: [
                 { stack_name: "mystack",
                   stack_status: 'CREATE_COMPLETE',
-                  creation_time: Time.now,
+                  creation_time: memo_now,
                   tags: [
                     {key: 'CfnFlowService', value: 'none-such-service'},
                     {key: 'CfnFlowEnvironment', value: 'production'}
@@ -380,4 +388,22 @@ describe 'CfnFlow::CLI' do
     end
   end
 
+  describe '#version' do
+    let(:version) { CfnFlow::VERSION + "\n" }
+    it 'prints the version' do
+      out, _ = capture_io { cli.start [:version] }
+      out.must_equal version
+    end
+
+    it 'handles -v argument' do
+      out, _ = capture_io { cli.start ['-v'] }
+      out.must_equal version
+    end
+
+    it 'handles --version argument' do
+      out, _ = capture_io { cli.start ['--version'] }
+      out.must_equal version
+    end
+
+  end
 end

data/spec/{cfn-flow_spec.rb → cfn_flow_spec.rb}

@@ -135,7 +135,7 @@ describe 'CfnFlow' do
 
       it 'can be overridden with config' do
         ENV['AWS_REGION'] = 'env-region'
-        subject.instance_variable_set(:@config, {region: 'config-region' })
+        subject.instance_variable_set(:@config, {'region' => 'config-region' })
         subject.cfn_client.config.region.must_equal 'config-region'
       end
     end
@@ -159,7 +159,7 @@ describe 'CfnFlow' do
 
       it 'can be overridden with config' do
         ENV['AWS_REGION'] = 'env-region'
-        subject.instance_variable_set(:@config, {region: 'config-region' })
+        subject.instance_variable_set(:@config, {'region' => 'config-region' })
         subject.cfn_client.config.region.must_equal 'config-region'
       end
     end

data/spec/data/cfn-flow.yml

@@ -1,6 +1,5 @@
 ---
 service: cfn-flow-specs
-region: us-east-1
 templates:
   s3_bucket: test-bucket
   s3_prefix: test-prefix

data/spec/helper.rb

@@ -38,11 +38,15 @@ class Minitest::Spec
     Aws.config.delete(:cloudformation)
   end
 
+  def memo_now
+    @now = Time.now
+  end
+
   def stub_stack_data(attrs = {})
     {
       stack_name: "mystack",
       stack_status: 'CREATE_COMPLETE',
-      creation_time: Time.now,
+      creation_time: memo_now,
       tags: [
         {key: 'CfnFlowService', value: CfnFlow.service},
         {key: 'CfnFlowEnvironment', value: 'production'}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-flow
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -92,15 +92,16 @@ files:
 - bin/cfn-flow
 - bin/rake
 - lib/cfn-flow.rb
-- lib/cfn-flow/cli.rb
-- lib/cfn-flow/event_presenter.rb
-- lib/cfn-flow/git.rb
-- lib/cfn-flow/template.rb
-- lib/cfn-flow/version.rb
-- spec/cfn-flow/cli_spec.rb
-- spec/cfn-flow/event_presenter_spec.rb
-- spec/cfn-flow/template_spec.rb
-- spec/cfn-flow_spec.rb
+- lib/cfn_flow.rb
+- lib/cfn_flow/cli.rb
+- lib/cfn_flow/event_presenter.rb
+- lib/cfn_flow/git.rb
+- lib/cfn_flow/template.rb
+- lib/cfn_flow/version.rb
+- spec/cfn_flow/cli_spec.rb
+- spec/cfn_flow/event_presenter_spec.rb
+- spec/cfn_flow/template_spec.rb
+- spec/cfn_flow_spec.rb
 - spec/data/cfn-flow.yml
 - spec/data/invalid.json
 - spec/data/invalid.yml
@@ -133,10 +134,10 @@ signing_key:
 specification_version: 4
 summary: A CLI for CloudFormation templates
 test_files:
-- spec/cfn-flow/cli_spec.rb
-- spec/cfn-flow/event_presenter_spec.rb
-- spec/cfn-flow/template_spec.rb
-- spec/cfn-flow_spec.rb
+- spec/cfn_flow/cli_spec.rb
+- spec/cfn_flow/event_presenter_spec.rb
+- spec/cfn_flow/template_spec.rb
+- spec/cfn_flow_spec.rb
 - spec/data/cfn-flow.yml
 - spec/data/invalid.json
 - spec/data/invalid.yml

data/lib/cfn-flow/version.rb

@@ -1,3 +0,0 @@
-module CfnFlow
-  VERSION = '0.7.0'
-end