kumo_dockercloud 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9506aa4ff5a6e5dc9775ba9cf36dc4ad5959bc4
-  data.tar.gz: 8848e236285eb1043ec39d20930b6f807573e369
+  metadata.gz: d871a5f98e09f8794d61c9b79c7742afe3b48f3b
+  data.tar.gz: 5d88756a089dc80cba87a897e0d82f2018710c9b
 SHA512:
-  metadata.gz: 46f6600d38e3a32f976664d4ddd52e1d494e4b3c2323830f4c689f7c399dbdfa7b1bb16109f62823d106cf864d3c91d4d64b534b23ee8971e82112bd494a302c
-  data.tar.gz: 02b6be74db826142d5018825b7cacb97529d940ffe026bf1e4f002aef8083f9d24c619bda9e1ab10eeb529693183cf2f9d545543bf21321725c6554edd47ed1b
+  metadata.gz: 5ba411d51395fc01b3c240c40dbe4058d977408abcfb6a263323922fd8950459b5509839d69f255745667cb97e64fc1ac51ca33a916c309928007ee50941b363
+  data.tar.gz: bcd443b5004db702ecf96eca9f18ff1c746f7c79b79e019fdffec6bb4641f21c9e30feaa4f3e85180bf67aab47d76d73079caa088d4cb5fb4d944f9553a36349

data/README.md

@@ -47,3 +47,11 @@ Changes to the gem can be manually tested end to end in a project that uses the
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Changelog
+
+This section records potentially breaking changes to the API or User Experience.
+
+### Version 3.0.0
+
+Destroying a stack now requires user confirmation at the console before the action will be carried out.

data/lib/kumo_dockercloud.rb

@@ -4,3 +4,4 @@ require 'kumo_dockercloud/stack'
 require 'kumo_dockercloud/service'
 require 'kumo_dockercloud/service_checker'
 require 'kumo_dockercloud/errors'
+require 'kumo_dockercloud/console_jockey'

data/lib/kumo_dockercloud/console_jockey.rb

@@ -0,0 +1,36 @@
+require 'timeout'
+
+module KumoDockerCloud
+  class ConsoleJockey
+
+    def self.flash_message(message)
+      puts "\n"
+      puts "###################=============================------------"
+      puts message
+      puts "------------=============================###################"
+      puts "\n"
+
+      $stdout.flush
+    end
+
+    def self.write_line(message)
+      puts message
+
+      $stdout.flush
+    end
+
+    def self.get_confirmation(timeout=30)
+      begin
+        status = Timeout::timeout(timeout) {
+          STDIN.gets.chomp
+        }
+      rescue
+        status = false
+      end
+
+      proceed = status == "yes"
+      proceed ? puts('Proceeding.') : puts('Aborted!')
+      proceed
+    end
+  end
+end

data/lib/kumo_dockercloud/environment.rb

@@ -3,10 +3,11 @@ require 'erb'
 require 'tempfile'
 require 'forwardable'
 
+require_relative 'console_jockey'
 require_relative 'docker_cloud_api'
-require_relative 'state_validator'
 require_relative 'environment_config'
 require_relative 'stack_file'
+require_relative 'state_validator'
 
 #TODO refactor this to use the new checker inside Service
 module KumoDockerCloud
@@ -19,6 +20,7 @@ module KumoDockerCloud
       @env_vars = params.fetch(:env_vars, {})
       @stack_template_path = params.fetch(:stack_template_path)
       @timeout = params.fetch(:timeout, 120)
+      @confirmation_timeout = params.fetch(:confirmation_timeout, 30)
 
       app_name = params.fetch(:app_name)
       @config = EnvironmentConfig.new(app_name: app_name, env_name: @env_name, config_path: params.fetch(:config_path))
@@ -39,6 +41,8 @@ module KumoDockerCloud
     end
 
     def destroy
+      ConsoleJockey.flash_message "Warning! You are about to delete the Docker Cloud Stack #{stack_name}, enter 'yes' to continue."
+      return unless ConsoleJockey.get_confirmation(@confirmation_timeout)
       run_command("docker-cloud stack terminate --sync #{stack_name}")
     end
 

data/lib/kumo_dockercloud/version.rb

@@ -1,3 +1,3 @@
 module KumoDockerCloud
-  VERSION = '2.2.0'
+  VERSION = '3.0.0'
 end

data/spec/kumo_dockercloud/console_jockey_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe KumoDockerCloud::ConsoleJockey do
+  describe "#get_confirmation" do
+    let(:timeout) { 0.5 }
+    subject { described_class }
+
+    context 'no timeout' do
+
+      it 'returns true if user enters yes' do
+        allow(STDIN).to receive(:gets) { 'yes'}
+        expect(subject.get_confirmation(timeout)).to be true
+      end
+
+      it 'returns false if user enters anything other than yes' do
+        allow(STDIN).to receive(:gets) { 'aoisdjofa'}
+        expect(subject.get_confirmation).to be false
+      end
+    end
+
+    context 'timeout' do
+      it 'returns false if there is a timeout' do
+        expect(subject.get_confirmation(timeout)).to be false
+      end
+    end
+
+  end
+end

data/spec/kumo_dockercloud/environment_spec.rb

@@ -15,10 +15,11 @@ describe KumoDockerCloud::Environment do
       }
     }
   }
-
+  let(:full_stack_name) { "#{app_name}-test" }
+  let(:confirmation_timeout) { 0.5 }
   let(:stack_template_path) { File.join(__dir__, '../fixtures/stack.yml.erb') }
 
-  let(:params) { {name: 'test', env_vars: env_vars, app_name: app_name, config_path: 'a path', stack_template_path: stack_template_path} }
+  let(:params) { {name: 'test', env_vars: env_vars, app_name: app_name, config_path: 'a path', stack_template_path: stack_template_path, confirmation_timeout: confirmation_timeout} }
 
   subject(:env) { described_class.new(params) }
 
@@ -29,9 +30,6 @@ describe KumoDockerCloud::Environment do
 
   describe "#apply" do
     subject { env.apply }
-
-    let(:full_stack_name) { "#{app_name}-test" }
-
     before do
       allow(config).to receive(:image_tag).and_return('latest')
       allow(env).to receive(:evaluate_command).and_return app_name
@@ -60,7 +58,6 @@ describe KumoDockerCloud::Environment do
     end
 
     describe "waiting for running" do
-
       let(:state_validator) { double(KumoDockerCloud::StateValidator, wait_for_state: nil) }
 
       before do
@@ -89,4 +86,29 @@ describe KumoDockerCloud::Environment do
       subject
     end
   end
+
+
+  describe "#destroy" do
+    subject { env.destroy }
+    before do
+      allow(KumoDockerCloud::ConsoleJockey).to receive(:flash_message).with("Warning! You are about to delete the Docker Cloud Stack #{full_stack_name}, enter 'yes' to continue.")
+    end
+
+    it "notifies the user of what it is about to delete" do
+      expect(KumoDockerCloud::ConsoleJockey).to receive(:flash_message).with("Warning! You are about to delete the Docker Cloud Stack #{full_stack_name}, enter 'yes' to continue.")
+      subject
+    end
+
+    it "does delete the stack if the user confirms" do
+      expect(KumoDockerCloud::ConsoleJockey).to receive(:get_confirmation).with(confirmation_timeout).and_return(true)
+      expect(env).to receive(:run_command).with("docker-cloud stack terminate --sync #{full_stack_name}")
+      subject
+    end
+
+    it "does not delete the stack if the the user refuses confirmation" do
+      expect(KumoDockerCloud::ConsoleJockey).to receive(:get_confirmation).with(confirmation_timeout).and_return(false)
+      subject
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kumo_dockercloud
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Redbubble
@@ -128,6 +128,7 @@ files:
 - Rakefile
 - kumo_dockercloud.gemspec
 - lib/kumo_dockercloud.rb
+- lib/kumo_dockercloud/console_jockey.rb
 - lib/kumo_dockercloud/deployment.rb
 - lib/kumo_dockercloud/docker_cloud_api.rb
 - lib/kumo_dockercloud/environment.rb
@@ -147,6 +148,7 @@ files:
 - spec/fixtures/config/test_secrets.yml
 - spec/fixtures/stack.yml.erb
 - spec/kumo_docker_cloud_spec.rb
+- spec/kumo_dockercloud/console_jockey_spec.rb
 - spec/kumo_dockercloud/docker_cloud_api_spec.rb
 - spec/kumo_dockercloud/environment_config_spec.rb
 - spec/kumo_dockercloud/environment_spec.rb
@@ -186,6 +188,7 @@ test_files:
 - spec/fixtures/config/test_secrets.yml
 - spec/fixtures/stack.yml.erb
 - spec/kumo_docker_cloud_spec.rb
+- spec/kumo_dockercloud/console_jockey_spec.rb
 - spec/kumo_dockercloud/docker_cloud_api_spec.rb
 - spec/kumo_dockercloud/environment_config_spec.rb
 - spec/kumo_dockercloud/environment_spec.rb