cfn-flow 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b11eb9cc9a03afce395768b4e29f5b59764646f
-  data.tar.gz: 18fa02cf2b9834e8ab4c870d23ecb548dfd7a064
+  metadata.gz: badcc4a2c292d0183d5af25a50c9fd8837c9d22f
+  data.tar.gz: e176fe7a536d22fda562e993d30f656aa142fa7d
 SHA512:
-  metadata.gz: 81a7ce12e778b4b5beb6fd566143900ec6a9803b19f56a9b4b4700dd65d4128a792ec9f48be6a3741c329f24ad5a7c3023a2288c4a80014c836a86348910266a
-  data.tar.gz: 01491f61b53acc8ece495146a7e8b9864f96dd897ec7fc4465ce97910d773ba88fd04da9952abd9db7a1314eeb3630ae533276b465b0b67866354163166b9365
+  metadata.gz: 488423d2988b714671702d0c27386aacdca6b63c890172f390d9300f28cd5334e99aa8279685b2a0dd2dc74d72c45096a23ed3fce136c645dbf1f3f698e02726
+  data.tar.gz: 7728d38cb7d74beaad45675d7df8d983f3d99763a1708164fa80244eb00f33d715cbb3cac096c1f864339260a4346b7bf9490820139ffe9c088f96f66d2563f7

data/README.md

@@ -76,22 +76,25 @@ environment variables are overridden by command line arguments.
 
 ```
 # 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
+# Override with CFN_FLOW_BUCKET env var
 bucket: 'my-s3-bucket'
 
 # S3 path prefix. Default: none
-# Override with CFN_FLOW_TO
+# Override with CFN_FLOW_TO env var
 to: my/project/prefix
 
 # Local path in which to recursively search for templates. Default: .
-# Override with CFN_FLOW_FROM
+# Override with CFN_FLOW_FROM env var
 from: my/local/prefix
 
 # AWS Region
-# Override with AWS_REGION
+# Override with AWS_REGION env var
 region: us-east-1 # AWS region
 ```
 
@@ -122,7 +125,7 @@ resources](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-pro
    "Type" : "AWS::CloudFormation::Stack",
    "Properties" : {
       "TemplateURL" : {
-        "Fn::Join" : [ ":",r
+        "Fn::Join" : [ ":",
           [ "https://s3.amazonaws.com/my-bucket", {"Ref": "prefix"}, "my-template.json" ]
           ]
       }
@@ -130,4 +133,12 @@ resources](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-pro
 }
 ```
 
-While testing, set the `prefix` parameter to dev prefix like `dev/aaron`. When you're confident your changes work, release them with cfn-flow and change the `prefix` parameter to `release/1.0.0` for production.
+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/1.0.0` for production.
+
+#### Continuous integration
+
+#### Github commit status
+
+#### Minimal AWS credentials
+
+TODO: example IAM policy

data/Rakefile

@@ -1,18 +1,9 @@
 require "rubygems"
 require "bundler/setup"
+require "bundler/gem_tasks"
 require 'rake/testtask'
 
-namespace :test do
-  Rake::TestTask.new(:units) do |t|
-    t.pattern = "spec/*_spec.rb"
-  end
-
-  Rake::TestTask.new(:integration) do |t|
-    t.pattern = "spec/integration/*_spec.rb"
-  end
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
 end
-
-desc 'Run tests'
-task :test => %w[test:units test:integration]
-
 task :default => :test

data/bin/cfn-flow

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+
 require 'cfn-flow'
-CfnFlow.start
+CfnFlow::CLI.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/cfn-flow.rb

@@ -3,141 +3,7 @@ require 'aws-sdk'
 require 'multi_json'
 require 'yaml'
 
-class CfnFlow < Thor
-  class GitError < StandardError; end
-
-  require 'cfn-flow/template'
-  def self.shared_options
-
-    method_option :bucket,     type: :string, desc: 'S3 bucket for templates'
-    method_option :to,         type: :string, desc: 'S3 path prefix for templates'
-    method_option :from,       type: :string, desc: 'Local source directory for templates'
-    method_option 'dev-name',  type: :string, desc: 'Personal development prefix'
-    method_option :region,     type: :string, desc: 'AWS Region'
-
-    method_option :verbose, type: :boolean, desc: 'Verbose output', default: false
-  end
-
-  no_commands do
-    def load_config
-      defaults = { 'from' => '.' }
-      file_config = begin
-        YAML.load_file('./cfn-flow.yml')
-      rescue Errno::ENOENT
-        {}
-      end
-      env_config = {
-        'bucket'      => ENV['CFN_FLOW_BUCKET'],
-        'to'          => ENV['CFN_FLOW_TO'],
-        'from'        => ENV['CFN_FLOW_FROM'],
-        'dev-name'    => ENV['CFN_FLOW_DEV_NAME'],
-        'region'      => ENV['AWS_REGION']
-      }.delete_if {|_,v| v.nil?}
-
-      # Env vars override config file. Command args override env vars.
-      self.options = defaults.merge(file_config).merge(env_config).merge(options)
-
-      # Ensure region env var is set for AWS client
-      ENV['AWS_REGION'] = options['region']
-
-      # TODO: validate required options are present
-    end
-
-    shared_options
-    def load_templates
-      load_config
-      glob = File.join(options['from'], '**/*.{yml,json,template}')
-
-      @templates = Dir.glob(glob).map { |path|
-        CfnFlow::Template.new(from: path, bucket: options['bucket'], prefix: prefix)
-      }.select! {|t|
-        verbose "Checking file #{t.from}... "
-        if t.is_cfn_template?
-          verbose "loaded"
-          true
-        else
-          verbose "skipped."
-          false
-        end
-      }
-    end
-  end
-
-  desc :validate, 'Validates templates'
-  shared_options
-  def validate
-    load_templates
-    @templates.each do |t|
-      begin
-        verbose "Validating #{t.from}... "
-        t.validate!
-        verbose "valid."
-      rescue Aws::CloudFormation::Errors::ValidationError
-        say "Error validating #{t.from}. Message:"
-        say $!.message
-      end
-    end
-  end
-
-  desc :upload, 'Validate & upload templates to the CFN_DEV_FLOW_NAME prefix'
-  shared_options
-  method_option :release, type: :string, desc: 'Upload & tag release'
-  def upload
-    tag_release if options['release']
-
-    validate
-    @templates.each do |t|
-      verbose "Uploading #{t.from} to #{t.url}"
-      t.upload!
-    end
-
-    push_release if options['release']
-
-  end
-  default_task :upload
-
-  private
-  def verbose(msg)
-    say msg if options['verbose']
-  end
-
-  def prefix
-    # Add the release or dev name to the prefix
-    parts = []
-    parts << options['prefix'] unless options['prefix'].empty?
-    if options['release']
-      parts += [ 'release',  options['release'] ]
-    else
-      parts += [ 'dev', options['dev-name'] ]
-    end
-    File.join(*parts)
-  end
-
-  def tag_release
-    # Check git status
-    unless `git status -s`.empty?
-      git_error "Git working directory is not clean. Please commit or reset changes in order to release."
-    end
-    unless $?.success?
-      git_error "Error running `git status`"
-    end
-
-    say "Tagging release #{options['release']}"
-    `git tag -a -m #{options['release']}, #{options['release']}`
-    unless $?.success?
-      git_error "Error tagging release."
-    end
-  end
-
-  def push_tag
-    `git push origin #{options['release']}`
-    unless $?.success?
-      git_error "Error pushing tag to origin."
-    end
-  end
-
-  def git_error(message)
-    say message, :red
-    raise GitError.new(message)
-  end
-end
+module CfnFlow; end
+require 'cfn-flow/template'
+require 'cfn-flow/git'
+require 'cfn-flow/cli'

data/lib/cfn-flow/cli.rb

@@ -0,0 +1,105 @@
+class CfnFlow::CLI < Thor
+
+  def self.shared_options
+    method_option :bucket,     type: :string, desc: 'S3 bucket for templates'
+    method_option :to,         type: :string, desc: 'S3 path prefix for templates'
+    method_option :from,       type: :string, desc: 'Local source directory for templates'
+    method_option 'dev-name',  type: :string, desc: 'Personal development prefix'
+    method_option :region,     type: :string, desc: 'AWS Region'
+    method_option :verbose, type: :boolean, desc: 'Verbose output', default: false
+  end
+
+  no_commands do
+    def load_config
+      defaults = { 'from' => '.' }
+      file_config = begin
+                      YAML.load_file(ENV['CFN_FLOW_CONFIG'] || './cfn-flow.yml')
+                    rescue Errno::ENOENT
+                      {}
+                    end
+      env_config = {
+        'bucket'      => ENV['CFN_FLOW_BUCKET'],
+        'to'          => ENV['CFN_FLOW_TO'],
+        'from'        => ENV['CFN_FLOW_FROM'],
+        'dev-name'    => ENV['CFN_FLOW_DEV_NAME'],
+        'region'      => ENV['AWS_REGION']
+      }.delete_if {|_,v| v.nil?}
+
+      # Env vars override config file. Command args override env vars.
+      self.options = defaults.merge(file_config).merge(env_config).merge(options)
+
+      # Ensure region env var is set for AWS client
+      ENV['AWS_REGION'] = options['region']
+
+      # TODO: validate required options are present
+    end
+
+    shared_options
+    def load_templates
+      load_config
+      glob = File.join(options['from'], '**/*.{yml,json,template}')
+
+      puts Dir.glob(glob.inspect)
+      @templates = Dir.glob(glob).map { |path|
+        CfnFlow::Template.new(from: path, bucket: options['bucket'], prefix: prefix)
+      }.select {|t|
+        verbose "Checking file #{t.from}... "
+        if t.is_cfn_template?
+          verbose "loaded"
+          true
+        else
+          verbose "skipped."
+          false
+        end
+      }
+    end
+  end
+
+  desc :validate, 'Validates templates'
+  shared_options
+  def validate
+    load_templates
+    @templates.each do |t|
+      begin
+        verbose "Validating #{t.from}... "
+        t.validate!
+        verbose "valid."
+      rescue Aws::CloudFormation::Errors::ValidationError
+        say "Error validating #{t.from}. Message:"
+        say $!.message
+      end
+    end
+  end
+
+  desc :upload, 'Validate & upload templates to the CFN_FLOW_DEV_NAME prefix'
+  shared_options
+  method_option :release, type: :string, lazy_default: CfnFlow::Git.sha, desc: 'Upload release'
+  def upload
+    check_git_status if options['release']
+
+    validate
+    @templates.each do |t|
+      verbose "Uploading #{t.from} to #{t.url}"
+      t.upload!
+    end
+
+  end
+  default_task :upload
+
+  private
+  def verbose(msg)
+    say msg if options['verbose']
+  end
+
+  def prefix
+    # Add the release or dev name to the prefix
+    parts = []
+    parts << options['prefix'] unless options['prefix'].empty?
+    if options['release']
+      parts += [ 'release',  options['release'] ]
+    else
+      parts += [ 'dev', options['dev-name'] ]
+    end
+    File.join(*parts)
+  end
+end

data/lib/cfn-flow/git.rb

@@ -0,0 +1,24 @@
+# Git helper module
+class CfnFlow::Git
+  class << self
+
+    def sha
+      command = "git rev-parse --verify HEAD"
+      result = `#{command}`.chomp
+      unless $?.success?
+        raise Thor::Error.new("Error running `#{command}`")
+      end
+      result
+    end
+
+    def check_status
+      unless `git status -s`.empty?
+        raise Thor::Error.new("Git working directory is not clean. Please commit or reset changes in order to release.")
+      end
+      unless $?.success?
+        raise Thor::Error.new("Error running `git status`")
+      end
+    end
+
+  end
+end

data/lib/cfn-flow/template.rb

@@ -17,13 +17,15 @@ class CfnFlow::Template
     from_data.is_a?(Hash) && from_data.key?('Resources')
   end
 
+  # Returns a response object if valid, or raises an
+  # Aws::CloudFormation::Errors::ValidationError with an error message
   def validate!
     cfn.validate_template(template_body: to_json)
   end
 
   def key
-    # Replace leading './' in from, rename *.yml to *.json
-    File.join(prefix, from.sub(/\A\.\//, '').sub(/\.yml\Z/, '.json'))
+    # Replace leading './' in from
+    File.join(prefix, from.sub(/\A\.\//, ''))
   end
 
   def upload!

data/spec/cfn-flow_template_spec.rb

@@ -0,0 +1,56 @@
+require_relative 'spec_helper'
+
+describe 'CfnFlow::Template' do
+
+  let(:template) {
+    CfnFlow::Template.new(from: 'spec/data/sqs.template', prefix: 'p', bucket: 'b')
+  }
+
+  let(:yml_template) {
+    CfnFlow::Template.new(from: 'spec/data/sqs.yml', prefix: 'p', bucket: 'b')
+  }
+
+  let(:not_a_template) {
+    CfnFlow::Template.new(from: 'spec/data/cfn-flow.yml', prefix: 'p', bucket: 'b')
+  }
+
+  describe '#initialize' do
+    subject { CfnFlow::Template }
+
+    it('succeeds') do
+      subject.new(from: 'f', prefix: 'p', bucket: 'b').must_be_kind_of CfnFlow::Template
+    end
+
+    it('requires args') do
+      -> { subject.new }.must_raise(ArgumentError)
+    end
+  end
+
+  describe '#yaml?' do
+    it 'works' do
+      yml_template.yaml?.must_equal true
+      yml_template.json?.must_equal false
+      template.yaml?.must_equal false
+      template.json?.must_equal true
+    end
+  end
+
+  describe '#is_cfn_template?' do
+    it 'works' do
+      yml_template.is_cfn_template?.must_equal true
+      template.is_cfn_template?.must_equal true
+      not_a_template.is_cfn_template?.must_equal false
+    end
+  end
+
+  describe '#validate!' do
+    it 'can succeed' do
+      template.send(:cfn).stub_responses(:validate_template)
+      template.validate!
+    end
+    it 'can raise an error' do
+      template.send(:cfn).stub_responses(:validate_template, 'ValidationError')
+      -> { template.validate! }.must_raise Aws::CloudFormation::Errors::ValidationError
+    end
+  end
+end

data/spec/data/cfn-flow.yml

@@ -0,0 +1,6 @@
+---
+bucket: test-bucket
+prefix: test-prefix
+from: spec/data
+to: test-to
+region: us-east-1

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+
+begin
+  require 'pry'
+rescue LoadError
+  # NBD.
+end
+
+require "cfn-flow"
+
+Aws.config[:stub_responses] = true
+ENV['AWS_REGION'] = 'us-east-1'
+ENV['AWS_ACCESS_KEY_ID'] = 'test-key'
+ENV['AWS_SECRET_ACCESS_KEY'] = 'test-secret'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-flow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An opinionate worflow for AWS CloudFormation
+description: An opinionated worflow for AWS CloudFormation
 email: aaron@ktheory.com
 executables:
 - cfn-flow
@@ -104,11 +104,16 @@ files:
 - README.md
 - Rakefile
 - bin/cfn-flow
+- bin/rake
 - lib/cfn-flow.rb
+- lib/cfn-flow/cli.rb
+- lib/cfn-flow/git.rb
 - lib/cfn-flow/template.rb
-- lib/cfn-flow/version.rb
-- spec/sqs.template
-- spec/sqs.yml
+- spec/cfn-flow_template_spec.rb
+- spec/data/cfn-flow.yml
+- spec/data/sqs.template
+- spec/data/sqs.yml
+- spec/spec_helper.rb
 homepage: http://github.com/kickstarter/cfn-flow
 licenses:
 - MIT
@@ -135,5 +140,8 @@ signing_key:
 specification_version: 4
 summary: A CLI for CloudFormation templates
 test_files:
-- spec/sqs.template
-- spec/sqs.yml
+- spec/cfn-flow_template_spec.rb
+- spec/data/cfn-flow.yml
+- spec/data/sqs.template
+- spec/data/sqs.yml
+- spec/spec_helper.rb

data/lib/cfn-flow/version.rb

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