cf_deployer 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b15fbdcf8f040017be2e4f7fd2fca49e99327164
-  data.tar.gz: 6138254475f90d7983da1823754ace6134be9d85
+SHA256:
+  metadata.gz: e1556ed67ab725b4ff0aea77a7c5ded196cc314f1654dd7724d2fe3f501604ef
+  data.tar.gz: 5e343a49b896d720227e69dbe85c6702456dfc0a95ce8d83b5b7c5b3686d4183
 SHA512:
-  metadata.gz: 209ff6fd2211ae9b37ef0592aaec30066139ee37742cc36bdb45593ad0bc8f4476393ccc76be3d04204b9021bef07621b703bdd09b65b85580f18827ff5ceb9a
-  data.tar.gz: 9d3a7676274ac56d77ef0d545f1dc2441bf9a84ce07bf50cae1aec809df349ff8a5f23202bfdabedf8064d08383ac191d879606c9a80b3586e91792f2819f91b
+  metadata.gz: 4048ce2d730fe916f6b895950af91023be72e7bae0bfbfbcb536fd86e20f5c78801575cb681d212ca9df8749bc595dadd1fcec56abb67576b047e555c8e18c8c
+  data.tar.gz: 7ef7a7ed4210aa1c46d57a0a1add255d84b8f921b798aedb58381dc3420476f670d5dea115d000ffc32d72ef0f4a8477a0757ffa9d7021b87f2cf0539a8d6409

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ vars.GHA_ENTERPRISE_LABELS || 'cai-standard-x86-linux' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake

data/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ${{ vars.GHA_ENTERPRISE_LABELS || 'cai-standard-x86-linux' }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Verify tag matches gem version
+        run: |
+          version=$(ruby -r ./lib/cf_deployer/version -e 'puts CfDeployer::VERSION')
+          if [ "${GITHUB_REF_NAME}" != "v${version}" ]; then
+            echo "Tag ${GITHUB_REF_NAME} does not match CfDeployer::VERSION v${version}"
+            exit 1
+          fi
+
+      - name: Build gem
+        run: gem build cf_deployer.gemspec
+
+      - name: Push gem to RubyGems
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: gem push cf_deployer-*.gem

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format d
+--order defined

data/ChangeLog.md

@@ -63,3 +63,10 @@ version 1.6.0
   - Automatically rollback on failures for AutoScalingGroup based deployments (See: https://github.com/manheim/cf_deployer/issues/39)
   - Improve error message when no stack is exists on ASG-based switch (See: https://github.com/manheim/cf_deployer/issues/50)
   - Reduce AWS calls during healthy_instance_count (See: https://github.com/manheim/cf_deployer/issues/48)
+
+version 2.0.0
+  - Requires Ruby 3.3 or newer
+  - Replaced aws-sdk v1 with the modular AWS SDK v3 gems (aws-sdk-autoscaling, aws-sdk-cloudformation, aws-sdk-ec2, aws-sdk-elasticloadbalancing, aws-sdk-route53)
+  - Replaced log4r with the standard library Logger (log output format is unchanged)
+  - Removed the json runtime dependency (json ships with Ruby)
+  - Handle non-existent stacks gracefully

data/QUICKSTART.md

@@ -36,7 +36,7 @@ Note that you can use ERB and settings/inputs from the cf_deployer.yml file whil
 ==================
 ### Setting up your project to use CFDeployer
 
-* **CFDeployer is a Ruby gem so you'll need a working version of Ruby.**  CFDeployer should work with any 1.8.7 or 1.9.X Ruby interpreter.  CFDeployer uses the official AWS-published Ruby SDK under the covers which, in turn, uses Nokogiri.  We've heard that JRuby projects and Ruby 2.X projects have trouble getting Nokogiri installed so that might be an issue for your if you're using one of those Rubies.
+* **CFDeployer is a Ruby gem so you'll need a working version of Ruby.**  CFDeployer requires Ruby 3.3 or newer and uses the official AWS SDK for Ruby (v3) under the covers.
 
 * **The use of the [Bundler](http://bundler.io/) gem is strongly encouraged.**  Put "gem 'cf_deployer'" into your Gemfile.
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 namespace :spec do
-  RSPEC_OPTS = ["--format", "nested", "--format", "html", "--out", "spec_result.html", "--colour"]
+  RSPEC_OPTS = ["--format", "documentation", "--format", "html", "--out", "spec_result.html", "--colour"]
 
   RSpec::Core::RakeTask.new(:file) do |t|
     t.rspec_opts = RSPEC_OPTS

data/cf_deployer.gemspec

@@ -8,18 +8,24 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Support multiple components deployment using CloudFormation templates with multiple blue green strategies.}
   gem.homepage      = "http://github.com/manheim/cf_deployer"
   gem.license = 'MIT'
+  gem.required_ruby_version = '>= 3.3'
 
-  gem.add_runtime_dependency 'aws-sdk','1.44.0'
-  gem.add_runtime_dependency 'log4r'
-  gem.add_runtime_dependency 'thor'
-  gem.add_runtime_dependency 'rainbow'
+  gem.add_runtime_dependency 'aws-sdk-autoscaling', '~> 1.86'
+  gem.add_runtime_dependency 'aws-sdk-cloudformation', '~> 1.76'
+  gem.add_runtime_dependency 'aws-sdk-core', '~> 3.170'
+  gem.add_runtime_dependency 'aws-sdk-ec2', '~> 1.365'
+  gem.add_runtime_dependency 'aws-sdk-elasticloadbalancing', '~> 1.42'
+  gem.add_runtime_dependency 'aws-sdk-route53', '~> 1.71'
   gem.add_runtime_dependency 'diffy'
-  gem.add_development_dependency 'yard', '~> 0.8.7.6'
-  gem.add_development_dependency 'pry', '~> 0.10.1'
-  gem.add_development_dependency 'rspec', '2.14.1'
-  gem.add_development_dependency 'rake', '~> 10.3.0'
-  gem.add_development_dependency 'webmock', '~> 2.1.0'
-  gem.add_development_dependency 'vcr', '~> 2.9.3'
+  gem.add_runtime_dependency 'logger', '~> 1.6'
+  gem.add_runtime_dependency 'rainbow'
+  gem.add_runtime_dependency 'thor'
+  gem.add_development_dependency 'pry', '~> 0.13'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.13'
+  gem.add_development_dependency 'vcr', '~> 6.0'
+  gem.add_development_dependency 'webmock', '~> 3.11'
+  gem.add_development_dependency 'yard', '~> 0.9', '>= 0.9.44'
 
   gem.files         = `git ls-files`.split($\).reject {|f| f =~ /^samples\// }
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/fixtures/vcr_cassettes/aws_call_count/driver/auto_scaling_group/healthy_instance_count.yml

@@ -45,7 +45,7 @@ http_interactions:
         \     </member>\n    </AutoScalingGroups>\n  </DescribeAutoScalingGroupsResult>\n
         \ <ResponseMetadata>\n    <RequestId>12345</RequestId>\n
         \ </ResponseMetadata>\n</DescribeAutoScalingGroupsResponse>\n"
-    http_version: 
+    http_version:
   recorded_at: Tue, 27 Sep 2016 05:47:40 GMT
 - request:
     method: post
@@ -65,7 +65,7 @@ http_interactions:
         \     </member>\n    </AutoScalingInstances>\n  </DescribeAutoScalingInstancesResult>\n
         \ <ResponseMetadata>\n    <RequestId>12346</RequestId>\n
         \ </ResponseMetadata>\n</DescribeAutoScalingInstancesResponse>\n"
-    http_version: 
+    http_version:
   recorded_at: Tue, 27 Sep 2016 05:47:40 GMT
 - request:
     method: post

data/lib/cf_deployer/cli.rb

@@ -94,7 +94,7 @@ module CfDeployer
       def set_log_level
         if options[:'log-level'] == 'aws-debug'
           CfDeployer::Log.level = 'debug'
-          AWS.config :logger => Logger.new($stdout)
+          Aws.config.update(:logger => Logger.new($stdout))
         else
           CfDeployer::Log.level = options[:'log-level']
         end

data/lib/cf_deployer/config_loader.rb

@@ -3,7 +3,7 @@ module CfDeployer
 
     def self.erb_to_json filename, config
       json_file = File.join(config[:config_dir], "#{filename}.json")
-      raise ApplicationError.new("#{json_file} is missing") unless File.exists?(json_file)
+      raise ApplicationError.new("#{json_file} is missing") unless File.exist?(json_file)
       CfDeployer::Log.info "ERBing JSON for #{filename}"
       ERB.new(File.read(json_file)).result(binding)
     rescue RuntimeError,TypeError,NoMethodError => e
@@ -39,7 +39,7 @@ module CfDeployer
 
     def load_yaml(text)
       YAML.load text
-    rescue Psych::SyntaxError => e
+    rescue ::Psych::SyntaxError => e
       error_document text
       raise e
     rescue

data/lib/cf_deployer/config_validation.rb

@@ -79,7 +79,7 @@ module CfDeployer
       file_name = component[hook_name][:file]
       return unless file_name
       path = File.join(component[:config_dir], file_name)
-      @errors << "File '#{path}' does not exist, which is required by hook '#{hook_name}'" unless File.exists?(path)
+      @errors << "File '#{path}' does not exist, which is required by hook '#{hook_name}'" unless File.exist?(path)
     end
 
     def check_environments

data/lib/cf_deployer/driver/auto_scaling_group.rb

@@ -3,7 +3,7 @@ module CfDeployer
     class AutoScalingGroup
       extend Forwardable
 
-      def_delegators :aws_group, :auto_scaling_instances, :ec2_instances, :load_balancers, :desired_capacity
+      def_delegators :aws_group, :instances, :desired_capacity, :load_balancer_names
 
       attr_reader :group_name, :group
 
@@ -22,7 +22,7 @@ module CfDeployer
         Log.info "warming up auto scaling group #{group_name} to #{desired}"
 
         CfDeployer::Driver::DryRun.guard "Skipping ASG warmup" do
-          aws_group.set_desired_capacity desired
+          aws_group.set_desired_capacity({desired_capacity: desired})
           wait_for_desired_capacity
         end
       end
@@ -38,14 +38,14 @@ module CfDeployer
         Log.info "Cooling down #{group_name}"
         CfDeployer::Driver::DryRun.guard "Skipping ASG cooldown" do
           aws_group.update :min_size => 0, :max_size => 0
-          aws_group.set_desired_capacity 0
+          aws_group.set_desired_capacity({desired_capacity: 0})
         end
       end
 
       def instance_statuses
         instance_info = {}
-        ec2_instances.each do |instance|
-          instance_info[instance.id] = CfDeployer::Driver::Instance.new(instance).status
+        instances.each do |instance|
+          instance_info[instance.id] = CfDeployer::Driver::Instance.new(instance.id).status
         end
         instance_info
       end
@@ -59,38 +59,30 @@ module CfDeployer
       end
 
       def desired_capacity_reached?
+        aws_group.reload
         healthy_instance_count >= desired_capacity
       end
 
       def healthy_instance_ids
-        instances = auto_scaling_instances.select do |instance|
+        _instances = instances.select do |instance|
           'HEALTHY'.casecmp(instance.health_status) == 0
         end
-        instances.map(&:id)
+        _instances.map(&:id)
       end
 
       def in_service_instance_ids
-        elbs = load_balancers
-        return [] if elbs.empty?
-
-        ids = elbs.collect(&:instances)
-                  .collect(&:health)
-                  .to_a
-                  .collect { |elb_healths|
-                     elb_healths.select { |health| health[:state] == 'InService' }
-                                .map { |health| health[:instance].id }
-                  }
-
-        ids.inject(:&)
+        elb_names = load_balancer_names
+
+        return [] if elb_names.empty?
+
+        elb_driver.in_service_instance_ids elb_names
       end
 
       def healthy_instance_count
-        AWS.memoize do
-          instances = healthy_instance_ids
-          instances &= in_service_instance_ids unless load_balancers.empty?
-          Log.info "Healthy instance count: #{instances.count}"
-          instances.count
-        end
+        instances = healthy_instance_ids
+        instances &= in_service_instance_ids unless load_balancer_names.empty?
+        Log.info "Healthy instance count: #{instances.count}"
+        instances.count
       rescue => e
         Log.error "Unable to determine healthy instance count due to error: #{e.message}"
         -1
@@ -99,7 +91,11 @@ module CfDeployer
       private
 
       def aws_group
-        @my_group ||= AWS::AutoScaling.new.groups[group_name]
+        @my_group ||= Aws::AutoScaling::AutoScalingGroup.new(group_name)
+      end
+
+      def elb_driver
+        @elb_driver ||= Elb.new
       end
     end
   end

data/lib/cf_deployer/driver/cloud_formation_driver.rb

@@ -7,22 +7,22 @@ module CfDeployer
       end
 
       def stack_exists?
-        aws_stack.exists?
+        !aws_stack.nil?
       end
 
       def create_stack template, opts
         CfDeployer::Driver::DryRun.guard "Skipping create_stack" do
-          cloud_formation.stacks.create @stack_name, template, opts
+          cloud_formation.create_stack(opts.merge(stack_name: @stack_name, template_body: template))
         end
       end
 
       def update_stack template, opts
         begin
           CfDeployer::Driver::DryRun.guard "Skipping update_stack" do
-            aws_stack.update opts.merge(:template => template)
+            cloud_formation.update_stack(opts.merge(stack_name: @stack_name, template_body: template))
           end
 
-        rescue AWS::CloudFormation::Errors::ValidationError => e
+        rescue Aws::CloudFormation::Errors::ValidationError => e
           if e.message =~ /No updates are to be performed/
             Log.info e.message
             return false
@@ -35,29 +35,31 @@ module CfDeployer
       end
 
       def stack_status
-        aws_stack.status.downcase.to_sym
+        aws_stack&.stack_status&.downcase&.to_sym
       end
 
       def outputs
-        aws_stack.outputs.inject({}) do |memo, o|
-          memo[o.key] = o.value
+        existing_stack.outputs.inject({}) do |memo, o|
+          memo[o.output_key] = o.output_value
           memo
         end
       end
 
       def parameters
-        aws_stack.parameters
+        existing_stack.parameters.each_with_object({}) do |p, memo|
+          memo[p.parameter_key] = p.parameter_value
+        end
       end
 
       def query_output key
-        output = aws_stack.outputs.find { |o| o.key == key }
-        output && output.value
+        output = existing_stack.outputs.find { |o| o.output_key == key }
+        output && output.output_value
       end
 
       def delete_stack
         if stack_exists?
           CfDeployer::Driver::DryRun.guard "Skipping create_stack" do
-            aws_stack.delete
+            cloud_formation.delete_stack(stack_name: @stack_name)
           end
         else
           Log.info "Stack #{@stack_name} does not exist!"
@@ -66,28 +68,36 @@ module CfDeployer
 
       def resource_statuses
         resources = {}
-        aws_stack.resource_summaries.each do |rs|
-          resources[rs[:resource_type]] ||= {}
-          resources[rs[:resource_type]][rs[:physical_resource_id]] = rs[:resource_status]
+        cloud_formation.list_stack_resources(stack_name: @stack_name).each do |page|
+          page.stack_resource_summaries.each do |rs|
+            resources[rs[:resource_type]] ||= {}
+            resources[rs[:resource_type]][rs[:physical_resource_id]] = rs[:resource_status]
+          end
         end
         resources
       end
 
       def template
-        aws_stack.template
+        cloud_formation.get_template(stack_name: @stack_name).template_body
       end
 
       private
 
       def cloud_formation
-        AWS::CloudFormation.new
+        @cloud_formation ||= Aws::CloudFormation::Client.new
       end
 
       def aws_stack
-        cloud_formation.stacks[@stack_name]
+        cloud_formation.describe_stacks(stack_name: @stack_name).stacks.first
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        raise unless e.message =~ /does not exist/
+        nil
       end
 
-    end
+      def existing_stack
+        aws_stack || raise(Aws::CloudFormation::Errors::ValidationError.new(nil, "Stack with id #{@stack_name} does not exist"))
+      end
 
+    end
   end
 end

data/lib/cf_deployer/driver/elb_driver.rb

@@ -2,16 +2,23 @@ module CfDeployer
   module Driver
     class Elb
       def find_dns_and_zone_id elb_id
-        elb = elb_driver.load_balancers[elb_id]
-        { :canonical_hosted_zone_name_id => elb.canonical_hosted_zone_name_id, :dns_name => elb.dns_name }
+        elb = elb_driver.describe_load_balancers({:load_balancer_names => [elb_id]})&.load_balancer_descriptions&.first
+        { :canonical_hosted_zone_name_id => elb&.canonical_hosted_zone_name_id, :dns_name => elb&.dns_name }
+      end
+
+      def in_service_instance_ids elb_ids
+        elb_ids.collect do |elb_id|
+          elb_driver.describe_instance_health({:load_balancer_name => elb_id}).instance_states
+            .collect{|instance| instance.state == 'InService' ? instance.instance_id : nil }.compact
+        end.inject(:&)
       end
 
       private
 
       def elb_driver
-        AWS::ELB.new
+        @elb_driver ||= Aws::ElasticLoadBalancing::Client.new
       end
 
     end
   end
-end
+end

data/lib/cf_deployer/driver/instance.rb

@@ -14,15 +14,16 @@ module CfDeployer
 
       def status
         instance_info = { }
-        [:status, :public_ip_address, :private_ip_address, :image_id].each do |stat|
+        [:public_ip_address, :private_ip_address, :image_id].each do |stat|
           instance_info[stat] = aws_instance.send(stat)
         end
-        instance_info[:key_pair] = aws_instance.key_pair.name
+        instance_info[:status] = aws_instance.state.name.tr('-', '_').to_sym
+        instance_info[:key_pair] = aws_instance.key_name
         instance_info
       end
 
       def aws_instance
-        @instance_obj ||= AWS::EC2.new.instances[@id]
+        @instance_obj ||= Aws::EC2::Instance.new(@id)
       end
     end
   end

data/lib/cf_deployer/driver/route53_driver.rb

@@ -2,7 +2,7 @@ module CfDeployer
   module Driver
     class Route53
       def initialize(aws_route53 = nil)
-        @aws_route53 = aws_route53 || AWS::Route53.new
+        @aws_route53 = aws_route53 || Aws::Route53::Client.new
       end
 
       def find_alias_target(hosted_zone_name, target_host_name)
@@ -15,9 +15,8 @@ module CfDeployer
 
       def set_alias_target(hosted_zone_name, target_host_name, elb_hosted_zone_id, elb_dnsname)
         Log.info "set alias target --Hosted Zone: #{hosted_zone_name} --Host Name: #{target_host_name} --ELB DNS Name: #{elb_dnsname} --ELB Zone ID: #{elb_hosted_zone_id}"
-        hosted_zone_name = trailing_dot(hosted_zone_name)
         target_host_name = trailing_dot(target_host_name)
-        hosted_zone = @aws_route53.hosted_zones.find { |z| z.name == hosted_zone_name }
+        hosted_zone = get_hosted_zone(hosted_zone_name)
         raise ApplicationError.new('Target zone not found!') if hosted_zone.nil?
 
         change = {
@@ -34,7 +33,7 @@ module CfDeployer
         }
 
         batch = {
-          hosted_zone_id: hosted_zone.path,
+          hosted_zone_id: hosted_zone.id,
           change_batch: {
             changes: [change]
           }
@@ -49,10 +48,15 @@ module CfDeployer
         hosted_zone = get_hosted_zone(hosted_zone_name)
         return unless hosted_zone
         record_set = get_record_set(hosted_zone, target_host_name)
+        return unless record_set
         CfDeployer::Driver::DryRun.guard "Skipping Route53 DNS delete" do
-          record_set.delete if record_set
+          @aws_route53.change_resource_record_sets(
+            hosted_zone_id: hosted_zone.id,
+            change_batch: { changes: [{ action: 'DELETE', resource_record_set: record_set.to_h }] }
+          )
         end
       end
+
       private
 
       def change_resource_record_sets_with_retry(batch)
@@ -60,7 +64,7 @@ module CfDeployer
         while attempts < 20
           begin
             attempts = attempts + 1
-            @aws_route53.client.change_resource_record_sets(batch)
+            @aws_route53.change_resource_record_sets(batch)
             return
           rescue Exception => e
             Log.info "Failed to update alias target, trying again in 20 seconds."
@@ -72,11 +76,15 @@ module CfDeployer
       end
 
       def get_hosted_zone(zone_name)
-        @aws_route53.hosted_zones.find { |z| z.name == trailing_dot(zone_name.downcase) }
+        zone_name = trailing_dot(zone_name.downcase)
+        @aws_route53.list_hosted_zones_by_name(dns_name: zone_name).hosted_zones.find { |z| z.name == zone_name }
       end
-      
+
       def get_record_set(hosted_zone, target_host_name)
-       hosted_zone.resource_record_sets.find { |r| r.name == trailing_dot(target_host_name.downcase) }
+        record_name = trailing_dot(target_host_name.downcase)
+        @aws_route53.list_resource_record_sets(hosted_zone_id: hosted_zone.id, start_record_name: record_name)
+          .resource_record_sets
+          .find { |r| r.name == record_name }
       end
 
       def trailing_dot(text)

data/lib/cf_deployer/logger.rb

@@ -1,7 +1,8 @@
 module CfDeployer
   class Log
-    require 'log4r'
-    include Log4r
+    FORMATTER = proc do |severity, time, progname, message|
+      "#{time.strftime('%y-%m-%d %H:%M:%S')} [#{severity}] (#{progname}) #{message}\n"
+    end
 
     def self.debug(message)
       log.debug message
@@ -16,22 +17,20 @@ module CfDeployer
     end
 
     def self.log
-      return @log if @log
-      @log = Logger.new('cf_deployer')
-      outputter = Outputter.stdout
-      outputter.formatter = PatternFormatter.new(:pattern => "%d [%l] (%c) %M", :date_pattern => "%y-%m-%d %H:%M:%S")
-      @log.outputters = outputter
-      @log.level = Log4r::INFO
-      @log
+      @log ||= ::Logger.new($stdout, progname: 'cf_deployer', level: ::Logger::INFO, formatter: FORMATTER)
+    end
+
+    def self.log=(logger)
+      @log = logger
     end
 
     def self.level=(trace_level)
       trace_level ||= 'info'
       case trace_level.downcase
        when 'debug'
-         log.level = Log4r::DEBUG
+         log.level = ::Logger::DEBUG
        else
-         log.level = Log4r::INFO
+         log.level = ::Logger::INFO
       end
     end
   end