stackup 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 281a4cc419891f70b5a8251d52c080a678e21d2a76a57a0e715b478987c5d967
-  data.tar.gz: e1848f7cccad92a7a6883f3947daa68e70d1b72ad00bfa72727f0def2590ee89
+  metadata.gz: cb7a5ebe9211d108f0289506fc5e917f58f7499823206dc22228f31b36992bcc
+  data.tar.gz: ba7d5a374e7a694fd52a1e7831d77b8dc1187d8dc3d1864dc19fbd6d00f76a3d
 SHA512:
-  metadata.gz: 59cd63007ce56b284e7176c82f354174bb78dec2fba84443e2b1a28465df5ed68cd0bc1ccd2474dab7572c61ebb85d9de328e12216395d0e68c8101863b0110a
-  data.tar.gz: 3acf8d1d83307ef2851001558c7880c4d43692f740254531369713e4cb7d38f3595398195cfd8f67460b10c1bd94cd7dca08a833fdf51371ef0a1c914addcffc
+  metadata.gz: 957ccabd6908e09039974ccd4204bcbbb0efb709fd46730a1d7da4559dffb98092845ce10bfc5a7325a3d4d38bf3c380a76fb3bc032de44714e0c6b5e0cc3dea
+  data.tar.gz: e94af1775282fbddfe2cfd9a895f557c55a09d79ca9d89738ef9be8219b0a448d74b178d553dd32738cffcab68b067fbcef7078b69fa0d08807124ed2fdae706

data/CHANGES.md

@@ -1,5 +1,25 @@
 # CHANGES
 
+## 1.8.0 (2022-08-23)
+
+* Feature: Add support for ruby 3.1
+* Dev: Upgrade dev setup and base docker image to ruby 3.1
+* Dev: Replace docker-compose dev setup with normal docker
+* Dev: Add helpers to easily test all supported ruby versions locally
+
+## 1.7.2 (2021-12-24)
+
+* Upgrade dev setup and base docker image to ruby 3.0
+
+## 1.7.1 (2021-08-31)
+
+* Dependency upgrades. Uplift of release process.
+* M1/arm64 support for docker image releases.
+
+## 1.7.0 (2020-11-25)
+
+* Feature: --no-fail-on-empty-change-set
+
 ## 1.6.0 (2020-11-19)
 
 * Feature: Support --service-role-arn on "change-set create"

data/README.md

@@ -1,7 +1,7 @@
 # stackup
 
 [![Gem Version](https://badge.fury.io/rb/stackup.png)](http://badge.fury.io/rb/stackup)
-[![Build Status](https://travis-ci.org/realestate-com-au/stackup.svg?branch=master)](https://travis-ci.org/realestate-com-au/stackup)
+[![Build Status](https://travis-ci.com/realestate-com-au/stackup.svg?branch=main)](https://travis-ci.com/realestate-com-au/stackup)
 
 Stackup provides a CLI and a simplified Ruby API for dealing with
 AWS CloudFormation stacks.
@@ -70,7 +70,7 @@ This will:
   * monitor events until the stack update is complete
 
 Requests will retry 3 times by default. After this limit is exceeded, `ERROR: Rate exceeded` failures will be logged.
-You can increase the limit using the `--retry-limit` option, or by setting the `$AWS_RETRY_LIMIT` environment variable.
+You can increase the limit using the `--retry-limit` option, or by setting the `$AWS_API_RETRY_LIMIT` environment variable.
 
 For more details on usage, see
 
@@ -191,7 +191,7 @@ Where a template URL references an object in S3, `stackup` leverages [CloudForma
 Non-S3 URLs are also supported, though in that case `stackup` must fetch the content itself:
 
     $ stackup mystack up \
-      -t https://raw.githubusercontent.com/realestate-com-au/stackup/master/examples/template.yml
+      -t https://raw.githubusercontent.com/realestate-com-au/stackup/main/examples/template.yml
 
 ### Stack deletion
 
@@ -218,6 +218,8 @@ The change-set name defaults to "pending", but can be overridden using `--name`.
 
 The `change-set create` subcommand, like the `up` command, supports `--service-role-arn` to specify a service role.
 
+It is impossible to create a change set with no changes. By default, stackup will only return successfully if a change set was actually created, and will otherwise fail. If the `--no-fail-on-empty-change-set` option is provided, stackup will return successfully if a change set was created _or_ if no change set was created because no changes were needed.
+
 ## Programmatic usage
 
 Get a handle to a `Stack` object as follows:
@@ -307,19 +309,18 @@ This policy grants the principal all actions required by `stackup up` for any cl
 ### Running tests
 
 `auto/test` will run the tests in a Docker container.
+`auto/lint` will run the linter in a Docker container.
 
 ### Releasing
 
-Releasing is done manually, not by CI. The release process will push tags to GitHub, push the gem to rubygems and push the docker image to DockerHub.
+Releasing is done mostly by CI. The automated process will push tags to GitHub, push the docker images to DockerHub. It won't yet push the gem to `rubygems.org`, but we're working ok it..
 
 Prerequisites:
 
-* You must be logged into docker hub via `docker login`. Your user must have permission to push to `realestate/stackup`
-* You must have a rubygems account with permission to push to the `stackup` gem. (`auto/release` will ask for your username and password)
-* You must have cloned this repo via HTTPS and have a github account with permission to push. (`auto/release` will ask for your username and a GitHub personal access token)
-
-To release:
+* You must have a rubygems account with permission to push to the `stackup` gem. (`auto/release-gem` will ask for your username and password)
+* You have bumped the version number in `lib/stackup/version.rb`.
+* You have checked the `CHANGES.md` file to make sure it is reasonable and has the changes for this new version.
 
-```
-auto/release
-```
+To release the rubygem.
+1. `auto/release-gem`
+2. On REA's internal CI tool of choice, find the build for `stackup-ci` and trigger a new build from `HEAD`. This will always grab the latest code from here and release the rest of the parts.

data/bin/stackup

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH << File.expand_path("../lib", __dir__)
 

data/lib/stackup/change_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "stackup/error_handling"
 
 module Stackup
@@ -51,19 +53,9 @@ module Stackup
     # @raise [Stackup::NoSuchStack] if the stack doesn't exist
     #
     def create(options = {})
-      options = options.dup
-      options[:stack_name] = stack.name
-      options[:change_set_name] = name
-      options[:change_set_type] = stack.exists? ? "UPDATE" : "CREATE"
-      force = options.delete(:force)
-      options[:template_body] = MultiJson.dump(options.delete(:template)) if options[:template]
-      # optionally override template_body with the original template to preserve formatting (& comments in YAML)
-      template_orig = options.delete(:template_orig)
-      options[:template_body] = template_orig if options.delete(:preserve)
-      options[:parameters] = Parameters.new(options[:parameters]).to_a if options[:parameters]
-      options[:tags] = normalize_tags(options[:tags]) if options[:tags]
-      options[:capabilities] ||= ["CAPABILITY_NAMED_IAM"]
-      delete if force
+      options = validate_options(options)
+      delete if options.delete(:force)
+      allow_empty_change_set = options.delete(:allow_empty_change_set)
       handling_cf_errors do
         cf_client.create_change_set(options)
         loop do
@@ -73,6 +65,10 @@ module Stackup
           when /COMPLETE/
             return current.status
           when "FAILED"
+            if allow_empty_change_set && (current.status_reason == "The submitted information didn't contain changes. Submit different information to create a change set.")
+              return current.status_reason
+            end
+
             logger.error(current.status_reason)
             raise StackUpdateError, "change-set creation failed" if status == "FAILED"
           end
@@ -145,6 +141,21 @@ module Stackup
       stack.send(:wait_poll_interval)
     end
 
+    def validate_options(original)
+      options = original.dup
+      options[:stack_name] = stack.name
+      options[:change_set_name] = name
+      options[:change_set_type] = stack.exists? ? "UPDATE" : "CREATE"
+      options[:template_body] = MultiJson.dump(options.delete(:template)) if options[:template]
+      # optionally override template_body with the original template to preserve formatting (& comments in YAML)
+      template_orig = options.delete(:template_orig)
+      options[:template_body] = template_orig if options.delete(:preserve)
+      options[:parameters] = Parameters.new(options[:parameters]).to_a if options[:parameters]
+      options[:tags] = normalize_tags(options[:tags]) if options[:tags]
+      options[:capabilities] ||= ["CAPABILITY_NAMED_IAM"]
+      options
+    end
+
   end
 
 end

data/lib/stackup/differ.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "diffy"
 require "stackup/utils"
 require "yaml"

data/lib/stackup/error_handling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "stackup/errors"
 
 module Stackup

data/lib/stackup/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stackup
 
   # Base Stackup Exception class

data/lib/stackup/main_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "clamp"
 require "console_logger"
 require "multi_json"
@@ -203,9 +205,7 @@ module Stackup
              :multivalued => true, :default => ["CAPABILITY_NAMED_IAM"]
 
       def execute
-        unless template_source || use_previous_template?
-          signal_usage_error "Specify either --template or --use-previous-template"
-        end
+        signal_usage_error "Specify either --template or --use-previous-template" unless template_source || use_previous_template?
         options = {}
         if template_source
           if template_source.s3?
@@ -248,8 +248,6 @@ module Stackup
         end
       end
 
-      private
-
       def pad(s, width)
         (s || "").ljust(width)
       end
@@ -280,6 +278,9 @@ module Stackup
         option ["--force"], :flag,
                "replace existing change-set of the same name"
 
+        option ["--no-fail-on-empty-change-set"], :flag, "don't fail on empty change-set",
+               :attribute_name => :allow_empty_change_set
+
         include HasParameters
 
         option "--tags", "FILE", "stack tags file",
@@ -296,9 +297,7 @@ module Stackup
                :multivalued => true, :default => ["CAPABILITY_NAMED_IAM"]
 
         def execute
-          unless template_source || use_previous_template?
-            signal_usage_error "Specify either --template or --use-previous-template"
-          end
+          signal_usage_error "Specify either --template or --use-previous-template" unless template_source || use_previous_template?
           options = {}
           if template_source
             if template_source.s3?
@@ -314,6 +313,7 @@ module Stackup
           options[:role_arn] = service_role_arn if service_role_arn
           options[:use_previous_template] = use_previous_template?
           options[:force] = force?
+          options[:allow_empty_change_set] = allow_empty_change_set?
           options[:capabilities] = capability_list
           options[:preserve] = preserve_template_formatting?
           report_change do
@@ -359,8 +359,6 @@ module Stackup
 
       end
 
-      private
-
       def change_set
         stack.change_set(change_set_name)
       end
@@ -402,8 +400,6 @@ module Stackup
         puts differ.diff(current, planned, context_lines)
       end
 
-      private
-
       def differ
         Stackup::Differ.new(diff_format, &method(:format_data))
       end
@@ -464,8 +460,6 @@ module Stackup
         end
       end
 
-      private
-
       def display_event(e)
         if data?
           display_data(event_data(e))

data/lib/stackup/parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stackup
 
   # Parameters to a CloudFormation template.
@@ -17,12 +19,12 @@ module Stackup
       def hashify(parameters)
         {}.tap do |result|
           parameters.each do |p|
-            begin
-              p_struct = ParameterStruct.new(p)
-              result[p_struct.key] = p_struct.value
-            rescue ArgumentError
-              raise ArgumentError, "invalid parameter record: #{p.inspect}"
-            end
+
+            p_struct = ParameterStruct.new(p)
+            result[p_struct.key] = p_struct.value
+          rescue ArgumentError
+            raise ArgumentError, "invalid parameter record: #{p.inspect}"
+
           end
         end
       end

data/lib/stackup/rake_tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/tasklib"
 require "tempfile"
 require "yaml"
@@ -39,8 +41,7 @@ module Stackup
     def define
       namespace(name) do
 
-        data_options = []
-        data_options << DataOption.for("--template", template)
+        data_options = [DataOption.for("--template", template)]
         data_options << DataOption.for("--parameters", parameters) if parameters
         data_options << DataOption.for("--tags", tags) if tags
 

data/lib/stackup/service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "aws-sdk-cloudformation"
 require "stackup/stack"
 

data/lib/stackup/source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open-uri"
 require "stackup/stack"
 

data/lib/stackup/stack_watcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "aws-sdk-cloudformation"
 
 module Stackup
@@ -14,10 +16,9 @@ module Stackup
 
     attr_accessor :stack
 
-    # rubocop:disable Lint/HandleExceptions
-
     # Yield all events since the last call
     #
+    # rubocop:disable Lint/SuppressedException
     def each_new_event
       new_events = []
       stack.events.each do |event|
@@ -40,8 +41,7 @@ module Stackup
       nil
     rescue Aws::CloudFormation::Errors::ValidationError
     end
-
-    # rubocop:enable Lint/HandleExceptions
+    # rubocop:enable Lint/SuppressedException
 
     private
 

data/lib/stackup/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stackup
 
   # Generates diffs of data.

data/lib/stackup/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Stackup
 
-  VERSION = "1.6.0".freeze
+  VERSION = "1.8.0"
 
 end

data/lib/stackup/yaml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Stackup
@@ -22,7 +24,8 @@ module Stackup
       #   `!Foo blah` as a shortcut for `{ "Fn::Foo" => blah }`
       #
       def load(yaml, filename = nil)
-        tree = ::YAML.parse(yaml, filename)
+        legacy_yaml = Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
+        tree = legacy_yaml ? ::YAML.parse(yaml, filename) : ::YAML.parse(yaml, :filename => filename)
         return tree unless tree
 
         CloudFormationToRuby.create.accept(tree)

data/lib/stackup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 require "stackup/service"
 require "stackup/stack"

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "byebug"
 require "console_logger"
 

data/spec/stackup/main_command_spec.rb

@@ -1,23 +1,61 @@
+# frozen_string_literal: true
+
 require "stackup/main_command"
 
 describe Stackup::MainCommand do
-  context "change-set create --service-role-arn"
+
+  let(:mock_change_set) { double }
+
+  before(:example) do
+    mock_stackup = double
+    mock_stack = double
+    allow_any_instance_of(Stackup::MainCommand).to receive(:Stackup).and_return(mock_stackup)
+    allow(mock_stackup).to receive(:stack).and_return(mock_stack)
+    allow(mock_stack).to receive(:change_set).and_return(mock_change_set)
+  end
+
+  context "change-set create --service-role-arn" do
     it "invokes stack.change_set.create with role arn passed through" do
-      mock_stackup = double()
-      mock_stack = double()
-      mock_change_set = double()
-      allow_any_instance_of(Stackup::MainCommand).to receive(:Stackup).and_return(mock_stackup)
-      allow(mock_stackup).to receive(:stack).and_return(mock_stack)
-      allow(mock_stack).to receive(:change_set).and_return(mock_change_set)
+      expected_args = {
+        :role_arn => "arn:aws:iam::000000000000:role/example"
+      }
+      expect(mock_change_set).to receive(:create).with(hash_including(expected_args))
+
+      Stackup::MainCommand.run("stackup", [
+                                 "STACK-NAME", "change-set", "create",
+                                 "--template", "examples/template.yml",
+                                 "--service-role-arn", "arn:aws:iam::000000000000:role/example"
+                               ])
+    end
+  end
 
+  context "change-set create" do
+    it "invokes stack.change_set.create with allow_empty_change_set nil" do
       expected_args = {
-        role_arn: "arn:aws:iam::000000000000:role/example"
+        :allow_empty_change_set => nil
       }
       expect(mock_change_set).to receive(:create).with(hash_including(expected_args))
 
       Stackup::MainCommand.run("stackup", [
-        "STACK-NAME", "change-set", "create",
-        "--template", "examples/template.yml",
-        "--service-role-arn", "arn:aws:iam::000000000000:role/example"])
+                                 "STACK-NAME", "change-set", "create",
+                                 "--template", "examples/template.yml"
+                               ])
     end
+  end
+
+  context "change-set create --no-fail-on-empty-change-set" do
+    it "invokes stack.change_set.create with allow_empty_change_set true" do
+      expected_args = {
+        :allow_empty_change_set => true
+      }
+      expect(mock_change_set).to receive(:create).with(hash_including(expected_args))
+
+      Stackup::MainCommand.run("stackup", [
+                                 "STACK-NAME", "change-set", "create",
+                                 "--template", "examples/template.yml",
+                                 "--no-fail-on-empty-change-set"
+                               ])
+    end
+  end
+
 end

data/spec/stackup/parameters_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "stackup/parameters"

data/spec/stackup/rake_tasks_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 require "stackup/rake_tasks"
 

data/spec/stackup/source_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "multi_json"

data/spec/stackup/stack_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "stackup/stack"
@@ -429,6 +431,38 @@ describe Stackup::Stack do
 
       end
 
+      context "when allow_empty_change_set is nil and there are no changes" do
+        it "raises an exception" do
+          cf_client.stub_responses(:describe_change_set, [{
+                                     :status => "FAILED",
+                                     :status_reason => "The submitted information didn't contain changes. Submit different information to create a change set."
+                                   }])
+          expect { create_change_set }.to raise_error(Stackup::StackUpdateError)
+        end
+      end
+
+      context "when allow_empty_change_set is true and there are no changes" do
+        it "does not raise an exception" do
+          cf_client.stub_responses(:describe_change_set, [{
+                                     :status => "FAILED",
+                                     :status_reason => "The submitted information didn't contain changes. Submit different information to create a change set."
+                                   }])
+          options[:allow_empty_change_set] = true
+          expect { create_change_set }.not_to raise_error
+        end
+      end
+
+      context "when allow_empty_change_set is true and there is some other failure" do
+        it "raises an exception" do
+          cf_client.stub_responses(:describe_change_set, [{
+                                     :status => "FAILED",
+                                     :status_reason => "some other failure message"
+                                   }])
+          options[:allow_empty_change_set] = true
+          expect { create_change_set }.to raise_error(Stackup::StackUpdateError)
+        end
+      end
+
     end
 
     describe "#change_set#execute" do

data/spec/stackup/stack_watcher_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "aws-sdk-cloudformation"

data/spec/stackup/utils_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "stackup/utils"

data/spec/stackup/yaml_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 require "stackup/yaml"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
-- Mike Williams
-- Arvind Kunday
+- Danial Pearce
+- Ahmed Shash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -83,8 +83,8 @@ dependencies:
         version: '0'
 description: 
 email:
-- mike.williams@rea-group.com
-- arvind.kunday@rea-group.com
+- danial.pearce@rea-group.com
+- ahmed.shash@rea-group.com
 executables:
 - stackup
 extensions: []
@@ -128,16 +128,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Manage CloudFormation stacks