kumo_keisei 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66099568edba510ba762b74a4ad4399eec9946a0
-  data.tar.gz: 2c7eb0d24a55a913b4aeca57a1a911eab0e6aa51
+  metadata.gz: ee8cf3ca725828906b7a8c98b2ddd15957964443
+  data.tar.gz: b5a1bcbb5b5f0093f86aec78378a2a08c4c86a31
 SHA512:
-  metadata.gz: 287b8d01d89b2fdc805f8a2d169056ee0265e9ece9ad58ea08c9c27c914dca57c73690d37adbcd28a2c1350c2f1b46dd6c360898f59e702c76ca2d1a9101a13a
-  data.tar.gz: 0599d8839161ff6d12fd3cd0a79421e4e93b2be1e2bae554977b6fe02eec5b58e090bc13e9d494f050ad9ba5968352985e49f50fee5b514e3054ff4284bb9fe8
+  metadata.gz: e81b694610cf7626e3ab8ad2bbd39a6e6f273b007200c89057b7ff4405b8812c8e9c44afe81af74bec88a84b9603b036df37ec816d82edebcff8e9047e54b6b9
+  data.tar.gz: 2a6e0142a23dc0520a193379163db5f8c72963e2dcda1d687105705d30e0353bec25f4f4c5a34cbd3a2a254a9b308faa352fd0afd85b0b829fbc800597e52328

data/README.md

@@ -24,12 +24,12 @@ Or install it yourself as:
 
 ### Basic Usage
 
-The basic usage will give you a CloudFormation stack named `{application}-{type}-{environment}`. The default type is `nodes`
+The basic usage will give you a CloudFormation stack named `{application}-{environment}`. The default type is `nodes`
 
 ```ruby
 application_name = "myapp"
 environment_name = "production"
-my_stack = KumoKeisei::Stack.new(stack_name, environment_name)
+my_stack = KumoKeisei::Stack.new(application_name, environment_name)
 
 stack_config = {
   config_path: File.join('/app', 'env', 'config'),
@@ -39,15 +39,13 @@ stack_config = {
 my_stack.apply! stack_config
 ```
 
-### Changing the stack type
+### Stack Naming
+
+We are using APPNAME-ENVNAME (e.g `redbubble-staging`) as our naming convention. There are some legacy stacks in AWS which have the old naming convention which is APPNAME-TYPE-ENVNAME (e.g `redbubble-nodes-staging`). If you want to ensure that you keep your existing stack (so you don't accidently build an extra stack):
+
+0. Login into the AWS console and find out what your stack is named.
+0. Update your app name (see Basic Usage above) in the apply-env script to match your existing stack name's app name part (which is everything before the environment name, e.g `redbubble-nodes` in `redbubble-nodes-staging`)
 
-Specify the `type` in an options object passed to the `KumoKeisei::Stack` constructor. For example the following will give you a `myapp-vpc-production` stack e.g:
-```ruby
-vpc_stack_options = {
-  type: 'vpc'
-}
-vpc_stack = KumoKeisei::Stack.new('myapp', 'production', vpc_stack_options)
-```
 
 ### Timeouts
 

data/VERSION

@@ -1 +1 @@
-3.2.1
+4.0.0

data/lib/kumo_keisei/get_stack_output.rb

@@ -0,0 +1,13 @@
+module KumoKeisei
+  class GetStackOutput
+    def initialize(aws_stack)
+      @aws_stack = aws_stack
+    end
+
+    def output(name)
+      return nil if @aws_stack.nil?
+      outputs_hash = @aws_stack.outputs.reduce({}) { |acc, o| acc.merge(o.output_key.to_s => o.output_value) }
+      outputs_hash[name]
+    end
+  end
+end

data/lib/kumo_keisei/stack.rb

@@ -28,14 +28,21 @@ module KumoKeisei
       self.new(app_name, environment_name).exists?
     end
 
-    def initialize(app_name, environment_name, options = { confirmation_timeout: 30, waiter_delay: 20, waiter_attempts: 90 })
-      type = options.fetch(:type, 'nodes')
+    def initialize(app_name, environment_name, options = { confirmation_timeout: 30, waiter_delay: 20, waiter_attempts: 90, prompt_user: true })
       @env_name = environment_name
       @app_name = app_name
-      @stack_name = "#{app_name}-#{type}-#{ environment_name }"
+      @stack_name = "#{app_name}-#{ environment_name }"
       @confirmation_timeout = options[:confirmation_timeout]
       @waiter_delay = options[:waiter_delay]
       @waiter_attempts = options[:waiter_attempts]
+      prompt_user if options[:prompt_user]
+    end
+
+    def prompt_user
+      puts "WARNING: You are about to lookup/create/update/delete #{@stack_name}."
+      puts "We have recently changed the way we name stacks in aws, if #{@stack_name} looks correct, hit 'Y', otherwise hit anything else and read more at 'https://github.com/redbubble/kumo_keisei_gem'"
+      continue = $stdin.gets.chomp.downcase
+      exit 1 if continue != 'y'
     end
 
     def apply!(stack_config)
@@ -62,12 +69,8 @@ module KumoKeisei
       ensure_deleted!
     end
 
-    def outputs(output)
-      stack = get_stack
-      return nil if stack.nil?
-      outputs_hash = stack.outputs.reduce({}) { |acc, o| acc.merge(o.output_key.to_s => o.output_value) }
-
-      outputs_hash[output]
+    def outputs(name)
+      return GetStackOutput.new(get_stack).output(name)
     end
 
     def logical_resource(resource_name)

data/lib/kumo_keisei.rb

@@ -2,3 +2,4 @@ require_relative "kumo_keisei/cloud_formation_stack"
 require_relative "kumo_keisei/stack"
 require_relative "kumo_keisei/environment_config"
 require_relative "kumo_keisei/errors"
+require_relative "kumo_keisei/get_stack_output"

data/spec/lib/kumo_keisei/get_stack_output_spec.rb

@@ -0,0 +1,33 @@
+describe KumoKeisei::GetStackOutput do
+  describe "#output" do
+    let(:aws_stack) { double(:stack, outputs: [output])}
+    let(:name) { "Key" }
+    subject { described_class.new(aws_stack).output(name) }
+
+    context 'when the stack exists' do
+      let(:value) { "Value" }
+      let(:output_key) { name }
+      let(:output) { double(:output, output_key: output_key, output_value: value) }
+
+      it "returns the outputs given by CloudFormation" do
+        expect(subject).to eq(value)
+      end
+
+      context "Output key doesn't exist" do
+        let(:output_key) { "something else" }
+
+        it "returns the outputs given by CloudFormation" do
+          expect(subject).to be_nil
+        end
+      end
+    end
+
+    context 'when the stack does not exist' do
+      let(:aws_stack) { nil }
+
+      it 'returns nil' do
+        expect(subject).to be_nil
+      end
+    end
+  end
+end

data/spec/lib/kumo_keisei/stack_spec.rb

@@ -9,13 +9,14 @@ describe KumoKeisei::Stack do
 
   let(:app_name) { "my-stack" }
   let(:environment_name) { 'non-production' }
-  let(:stack_name) { "#{app_name}-nodes-#{environment_name}" }
+  let(:stack_name) { "#{app_name}-#{environment_name}" }
   let(:stack_template_name) { "#{app_name}-#{environment_name}" }
   let(:stack_cfntemplate_filename) { "#{stack_template_name}.json" }
   let(:stack_cfnparams_filename) { "#{stack_template_name}.yml.erb" }
   let(:cloudformation) { instance_double(Aws::CloudFormation::Client) }
   let(:happy_stack_status) { "CREATE_COMPLETE" }
-  let(:cf_stack) { stack_result_list_with_status(happy_stack_status, stack_name) }
+  let(:named_cf_stack) { double(stack_status: happy_stack_status, stack_name: stack_name, stack_id: nil) }
+  let(:cf_stack) { double(stacks: [named_cf_stack]) }
   let(:parameter_builder) { instance_double(KumoKeisei::ParameterBuilder, params: {}) }
   let(:stack_template_body) { double(:stack_template_body) }
   let(:cf_stack_update_params) do
@@ -30,7 +31,7 @@ describe KumoKeisei::Stack do
     cf_stack_update_params.merge(on_failure: "DELETE")
   end
   let(:confirmation_timeout) { 30 }
-  subject(:instance) { KumoKeisei::Stack.new(app_name, environment_name) }
+  subject(:instance) { KumoKeisei::Stack.new(app_name, environment_name, confirmation_timeout: 30, waiter_delay: 20, waiter_attempts: 90, prompt_user: false ) }
   let(:stack_config) {
     {
       config_path: 'config-path',
@@ -40,8 +41,6 @@ describe KumoKeisei::Stack do
     }
   }
 
-  context "unit tests" do
-
   before do
     allow(KumoKeisei::ConsoleJockey).to receive(:flash_message)
     allow(KumoKeisei::ConsoleJockey).to receive(:write_line).and_return(nil)
@@ -51,7 +50,6 @@ describe KumoKeisei::Stack do
     allow(KumoKeisei::ParameterBuilder).to receive(:new).and_return(parameter_builder)
     allow(File).to receive(:read).with(stack_cfntemplate_filename).and_return(stack_template_body)
     allow(KumoKeisei::EnvironmentConfig).to receive(:new).with(stack_config.merge(params_template_file_path: "/#{stack_cfnparams_filename}")).and_return(double(:environment_config, cf_params: {}))
-    # allow(File).to receive(:absolute_path).and_return("#{app_name}.yml.erb")
     Dir.chdir('/')
   end
 
@@ -234,22 +232,15 @@ describe KumoKeisei::Stack do
     end
 
     describe "#outputs" do
-      context 'when the stack exists' do
-        let(:output) { double(:output, output_key: "Key", output_value: "Value") }
-        let(:stack) { double(:stack, stack_name: stack_name, outputs: [output])}
-        let(:stack_result) { double(:stack_result, stacks: [stack]) }
-
-        it "returns the outputs given by CloudFormation" do
-          allow(cloudformation).to receive(:describe_stacks).and_return(stack_result)
-          expect(subject.outputs("Key")).to eq("Value")
-        end
-      end
+      let(:name) { "Key" }
+      subject { instance.outputs(name) }
 
-      context 'when the stack does not exist' do
-        it 'returns nil' do
-          allow(subject).to receive(:get_stack).and_return(nil)
-          expect(subject.outputs('Key')).to be_nil
-        end
+      let(:get_stack_output) { double(:get_stack_output) }
+
+      it "delegates output retrieval to GetStackOutput" do
+        expect(KumoKeisei::GetStackOutput).to receive(:new).with(named_cf_stack).and_return(get_stack_output)
+        expect(get_stack_output).to receive(:output).with(name).and_return('Value')
+        expect(subject).to eq("Value")
       end
     end
 
@@ -271,17 +262,6 @@ describe KumoKeisei::Stack do
     end
   end
 
-  describe "#type" do
-    it "presumes stacks are of type node if the type is not set" do
-      expect(subject.stack_name).to eq("#{app_name}-nodes-#{environment_name}")
-    end
-
-    it "embeds the type into the name of the stack if set" do
-      subject = KumoKeisei::Stack.new(app_name, environment_name, { type: "vpc" } )
-      expect(subject.stack_name).to eq("#{app_name}-vpc-#{environment_name}")
-    end
-  end
-
   describe "#config" do
     context "when passed a config_path and params_template_file_path" do
       it "will return the results of the nested KumoKeisei::EnvironmentConfig.config" do
@@ -310,12 +290,11 @@ describe KumoKeisei::Stack do
         }
       }
       it "will raise an error" do
-        expect { described_class.new(app_name, environment_name).config(stack_config)}.to raise_error(KumoKeisei::Stack::UsageError)
+        expect { described_class.new(app_name, environment_name, prompt_user: false).config(stack_config)}.to raise_error(KumoKeisei::Stack::UsageError)
       end
     end
 
   end
-end
 
   describe "#params_template_path" do
     context "when looking for the parameter template file" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kumo_keisei
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Redbubble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -104,6 +104,7 @@ files:
 - lib/kumo_keisei/environment_config.rb
 - lib/kumo_keisei/errors.rb
 - lib/kumo_keisei/file_loader.rb
+- lib/kumo_keisei/get_stack_output.rb
 - lib/kumo_keisei/parameter_builder.rb
 - lib/kumo_keisei/stack.rb
 - script/build.sh
@@ -113,6 +114,7 @@ files:
 - spec/lib/kumo_keisei/console_jockey_spec.rb
 - spec/lib/kumo_keisei/environment_config_spec.rb
 - spec/lib/kumo_keisei/file_loader_spec.rb
+- spec/lib/kumo_keisei/get_stack_output_spec.rb
 - spec/lib/kumo_keisei/parameter_builder_spec.rb
 - spec/lib/kumo_keisei/stack_spec.rb
 - spec/spec_helper.rb
@@ -145,6 +147,7 @@ test_files:
 - spec/lib/kumo_keisei/console_jockey_spec.rb
 - spec/lib/kumo_keisei/environment_config_spec.rb
 - spec/lib/kumo_keisei/file_loader_spec.rb
+- spec/lib/kumo_keisei/get_stack_output_spec.rb
 - spec/lib/kumo_keisei/parameter_builder_spec.rb
 - spec/lib/kumo_keisei/stack_spec.rb
 - spec/spec_helper.rb