capistrano3-autoscaling-deploy 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5125a4f0cf87e61f76c8693fa8d434d9799ecbfd210abe6b6d5d4d297f9d0616
-  data.tar.gz: 4afd807fd174d4305a797caa38189a951df32cfe08aa33bf5f09dfc2b7300ae5
+  metadata.gz: cb77459b46142752dfd7581d1d48ff28070b6c7c7b53fa8ed73f4916d41c4667
+  data.tar.gz: 7229de6d7283a8936089bb91e1d980fda0fc030b32429cf20257f2a33c19f6b6
 SHA512:
-  metadata.gz: 2118d1de8dd0d3119f9799bb6e177c3790137ca24b368750ec1a8bb1d012ec86ad21b5f6876d3a73f2da2ab94fa6d2e98251b84c1b280c610e6db08b0e7a34b4
-  data.tar.gz: 5c8188565e47c2afd1045dac3f5993370c6a0beb49fc9544d16e558701436c482e2a29cb171ce3147f6002f72e6b0e04fc435222df8868b951c1d42be4c7a4a1
+  metadata.gz: 895e0b17df6ef8d4533253eac825511ea172dd18f288215e4399638efed547cdf04ff3d620cd6c648879d14f54e13bf2f09269a94ff8401d4bd7513c350e8fdc
+  data.tar.gz: d2d9fc5db891587176762daecc32cf4ad3cc6f9df86bfc0c700c8f6b318ba0a198f6067b7e7706f248aeaa1fc974a633b1a72d1ba67ab0e6f9e8b6113c231652

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.0.2
+
+No changes to how the plugin works.
+
+### Changed
+- The gem's changelog link on RubyGems now points to the `main` branch, which replaced `master`.
+
+### Development
+- Code style is checked with Standard Ruby in CI.
+- CodeQL and OpenSSF Scorecard scan the code and workflows, and GitHub Actions are pinned to commit SHAs.
+- Added a security policy (`SECURITY.md`).
+
 ## 2.0.1
 
 ### Fixed
@@ -36,4 +48,4 @@ First release since 1.6 (2017). See [Upgrading to 2.0](README.md#upgrading-to-20
 
 ## 1.6 and earlier
 
-See the [commit history](https://github.com/marcoschicote/capistrano3-autoscaling-deploy/commits/master).
+See the [commit history](https://github.com/marcoschicote/capistrano3-autoscaling-deploy/commits/main).

data/README.md

@@ -1,5 +1,6 @@
 [![Gem Version](https://img.shields.io/gem/v/capistrano3-autoscaling-deploy)](https://rubygems.org/gems/capistrano3-autoscaling-deploy)
 [![Test](https://github.com/marcoschicote/capistrano3-autoscaling-deploy/actions/workflows/test.yml/badge.svg)](https://github.com/marcoschicote/capistrano3-autoscaling-deploy/actions/workflows/test.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/marcoschicote/capistrano3-autoscaling-deploy/badge)](https://scorecard.dev/viewer/?uri=github.com/marcoschicote/capistrano3-autoscaling-deploy)
 
 # capistrano3-autoscaling-deploy
 
@@ -123,9 +124,11 @@ See [CHANGELOG.md](CHANGELOG.md) for all changes.
 
 Run the tests with `bundle exec rake test`. They use the AWS SDK's stubbed responses, so they don't need AWS credentials or network access.
 
+The code follows [Standard Ruby](https://github.com/standardrb/standard). Check it with `bundle exec rake standard`, or fix most offenses with `bundle exec standardrb --fix`. Running `bundle exec rake` does both the tests and the style check.
+
 ## Releasing
 
 Releases are published to RubyGems from GitHub Actions using [trusted publishing](https://guides.rubygems.org/trusted-publishing/), so no API key is stored anywhere.
 
-1. Update the version in `lib/capistrano/autoscaling_deploy/version.rb` and add a section to `CHANGELOG.md`, and merge them to `master`.
-2. In the repository's **Actions** tab, run the **Release** workflow on `master`. It runs the tests, builds the gem, pushes the `vX.Y.Z` tag and publishes the gem.
+1. Update the version in `lib/capistrano/autoscaling_deploy/version.rb` and add a section to `CHANGELOG.md`, and merge them to `main`.
+2. In the repository's **Actions** tab, run the **Release** workflow on `main`. It runs the tests, builds the gem, pushes the `vX.Y.Z` tag and publishes the gem.

data/lib/capistrano/autoscaling_deploy/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module AutoScalingDeploy
-    VERSION = '2.0.1'
+    VERSION = "2.0.2"
   end
 end

data/lib/capistrano/autoscaling_deploy.rb

@@ -1 +1 @@
-load File.expand_path('../tasks/autoscaling.rake', __FILE__)
+load File.expand_path("../tasks/autoscaling.rake", __FILE__)

data/lib/capistrano/helpers/aws_helper.rb

@@ -1,9 +1,9 @@
-require 'aws-sdk-autoscaling'
-require 'aws-sdk-ec2'
+require "aws-sdk-autoscaling"
+require "aws-sdk-ec2"
 
 module AwsHelper
-  IP_TYPES = %w(public_ip_address public_dns_name private_ip_address private_dns_name)
-  LIFECYCLE_STATES = %w(InService)
+  IP_TYPES = %w[public_ip_address public_dns_name private_ip_address private_dns_name]
+  LIFECYCLE_STATES = %w[InService]
 
   def get_instances(aws_region, aws_access_key_id, aws_secret_access_key, aws_autoscaling_group_name, aws_ip_type, aws_profile: nil, lifecycle_states: LIFECYCLE_STATES)
     client_options = aws_client_options(aws_region, aws_access_key_id, aws_secret_access_key, aws_profile)
@@ -14,12 +14,12 @@ module AwsHelper
   # credential chain is used: environment variables, shared config and
   # credentials files, SSO, and ECS or EC2 instance roles.
   def aws_client_options(aws_region, aws_access_key_id, aws_secret_access_key, aws_profile = nil)
-    options = { region: aws_region }
+    options = {region: aws_region}
 
     if aws_access_key_id && aws_secret_access_key
       options[:credentials] = Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
     elsif aws_access_key_id || aws_secret_access_key
-      raise ArgumentError, 'Set both :aws_access_key_id and :aws_secret_access_key, or neither to use the default AWS credential chain'
+      raise ArgumentError, "Set both :aws_access_key_id and :aws_secret_access_key, or neither to use the default AWS credential chain"
     elsif aws_profile
       options[:profile] = aws_profile
     end
@@ -42,8 +42,7 @@ module AwsHelper
     else
       instance_ids = instances.map(&:instance_id)
       ec2 = Aws::EC2::Client.new(client_options)
-      # info("Auto Scaling Group instances ids: #{instance_ids}")
-      aws_ip_type = 'public_dns_name' unless IP_TYPES.include? aws_ip_type
+      aws_ip_type = "public_dns_name" unless IP_TYPES.include? aws_ip_type
 
       ec2_instances = ec2.describe_instances(instance_ids: instance_ids).flat_map do |page|
         page.reservations.flat_map(&:instances)
@@ -57,8 +56,8 @@ module AwsHelper
       # e.g. public_dns_name is empty for instances in a private subnet
       blank_ids = instance_ids.zip(autoscaling_dns).select { |_, address| address.to_s.strip.empty? }.map(&:first)
       unless blank_ids.empty?
-        raise "Instances #{blank_ids.join(', ')} have no #{aws_ip_type}. " \
-              "Set :aws_ip_type to one of #{IP_TYPES.join(', ')} (private_ip_address for instances without public addresses)"
+        raise "Instances #{blank_ids.join(", ")} have no #{aws_ip_type}. " \
+              "Set :aws_ip_type to one of #{IP_TYPES.join(", ")} (private_ip_address for instances without public addresses)"
       end
     end
 
@@ -68,18 +67,13 @@ module AwsHelper
   def fetch_autoscaling_group_instances(client_options, autoscaling_group_name)
     as = Aws::AutoScaling::Client.new(client_options)
     as_groups = as.describe_auto_scaling_groups(
-        auto_scaling_group_names: [autoscaling_group_name],
-        max_records: 1,
+      auto_scaling_group_names: [autoscaling_group_name],
+      max_records: 1
     ).auto_scaling_groups
 
-    # info("Auto Scaling Groups: #{as_groups}")
-
     as_group = as_groups[0]
     raise "Auto Scaling group '#{autoscaling_group_name}' not found in #{client_options[:region]}" unless as_group
 
-    # info("Auto Scaling Group instances: #{as_group.instances}")
-
     as_group.instances
   end
-
 end

data/lib/capistrano/helpers/cap_helper.rb

@@ -4,15 +4,15 @@ module CapHelper
     roles.map { |role| role.is_a?(String) ? role.to_sym : role }
   end
 
+  # Roles for every instance but the first: no :db (for migrations) and
+  # no primary: true (for assets precompile)
   def sanitize_roles(roles)
-    # remove :db (for migrations), remove  :primary => :true (for assets precompile)
-    symbolize_roles(roles).inject([]){|acc, role|
-      if !role.is_a?(Hash)
-        acc << role if role != :db
-      else
-        acc << role.reject{|k,v| k == :primary}
+    symbolize_roles(roles).filter_map do |role|
+      if role.is_a?(Hash)
+        role.except(:primary)
+      elsif role != :db
+        role
       end
-      acc
-    }
+    end
   end
-end
+end

data/lib/capistrano/tasks/autoscaling.rake

@@ -1,19 +1,19 @@
-require 'capistrano/helpers/aws_helper'
-require 'capistrano/helpers/cap_helper'
+require "capistrano/helpers/aws_helper"
+require "capistrano/helpers/cap_helper"
 
 namespace :load do
   task :defaults do
     set :aws_autoscaling, true
-    set :aws_region, 'us-west-2'
-    set :aws_deploy_roles, %i{web app db}
-    set :aws_ip_type, 'public_dns_name'
+    set :aws_region, "us-west-2"
+    set :aws_deploy_roles, %i[web app db]
+    set :aws_ip_type, "public_dns_name"
     set :aws_lifecycle_states, AwsHelper::LIFECYCLE_STATES
   end
 end
 
 namespace :deploy do
   before :starting, :check_autoscaling_hooks do
-    invoke 'autoscaling_deploy:setup_instances' if fetch(:aws_autoscaling)
+    invoke "autoscaling_deploy:setup_instances" if fetch(:aws_autoscaling)
   end
 end
 
@@ -21,13 +21,13 @@ namespace :autoscaling_deploy do
   include AwsHelper
   include CapHelper
 
-  desc 'Add server from Auto Scaling Group.'
+  desc "Add server from Auto Scaling Group."
   task :setup_instances do
     ec2_instances = fetch_ec2_instances
     aws_deploy_roles = symbolize_roles(fetch(:aws_deploy_roles))
     aws_deploy_user = fetch(:aws_deploy_user)
 
-    ec2_instances.each_with_index {|instance, index|
+    ec2_instances.each_with_index { |instance, index|
       if index == 0
         server instance, user: aws_deploy_user, roles: aws_deploy_roles, primary: true
         puts("First Server: #{instance} - #{aws_deploy_roles}")
@@ -36,7 +36,6 @@ namespace :autoscaling_deploy do
         puts("Server: #{instance} - #{sanitize_roles(aws_deploy_roles)}")
       end
     }
-
   end
 
   def fetch_ec2_instances
@@ -51,11 +50,11 @@ namespace :autoscaling_deploy do
     instances = get_instances(region, key, secret, group_name, ip_type, aws_profile: profile, lifecycle_states: lifecycle_states)
 
     if instances.empty?
-      raise "No instances in Auto Scaling group '#{group_name}' with lifecycle state #{lifecycle_states.join(' or ')}"
+      raise "No instances in Auto Scaling group '#{group_name}' with lifecycle state #{lifecycle_states.join(" or ")}"
     end
 
-    puts("Found #{instances.count} servers (#{instances.join(',')}) for Auto Scaling Group: #{group_name} ")
+    puts("Found #{instances.count} servers (#{instances.join(",")}) for Auto Scaling Group: #{group_name} ")
 
     instances
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-autoscaling-deploy
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Marcos Chicote
@@ -93,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Capistrano 3 plugin that finds the in-service instances of an AWS Auto
   Scaling group and deploys to them.
 email:
@@ -115,7 +129,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/marcoschicote/capistrano3-autoscaling-deploy
-  changelog_uri: https://github.com/marcoschicote/capistrano3-autoscaling-deploy/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/marcoschicote/capistrano3-autoscaling-deploy/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/marcoschicote/capistrano3-autoscaling-deploy/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []