firespring_dev_commands 1.4.3.pre.alpha.1 → 1.5.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb403fd1ae12470807a778fbb3314f74b80a5f7d7c8fe0cf1ac28bab1d56d837
-  data.tar.gz: ff65c1e27fe4f4d63f3d31f5817b552d5dd4c930b615fadb0403e178e30fa597
+  metadata.gz: ea3652c102b7a6ec3395c7b524db518655b574a6050d8f740f2c20daedf63aed
+  data.tar.gz: 162e4aa151f14b901b7fcfea1c2b8e3cb1b20ab3de2d9102d00a35b0754e5773
 SHA512:
-  metadata.gz: 864a3659c6164459f8623f55e9d995cf77c09d03da85fe23c1b6e9f45e7dde3fe0982891b6e662b0b3942695a12f98d4ba4abe71eb3131e3f9898fa5afa146bd
-  data.tar.gz: 323ed9adeba33220e791ef078c0e3c4390ed93cdc262b3c3aa18e9b103099bf2f57e727e1b1e412773f3c54cd734fda8b1304953b5bdc2bd1350ba4fdf7a58a4
+  metadata.gz: 724282fb3154de07595863a899f29b1ffeea0e5fda1d3d2aa5fb31fd3e17f57bfbc0e9baaf534c4a0e259b8b95b051ba05b6d7072d1cdd4bc544799f665e519a
+  data.tar.gz: b60bf002f396a052f0814838940dcb441d95c263a4001bdbdcd18878d0d1a8ee0b7f1a8b5b4026ce43664a92666ab93b23a27e0d9d765669f827171c377d4d3d

data/README.md

@@ -11,7 +11,7 @@ gem 'firespring_dev_commands', '~> 0.0.1'
   * This is not common
   * It is mostly used for testing local changes before the gem is released
 ```
-gem 'firespring_dev_commands', path: '/path/to/firespring/dev-commands-ruby'
+gem 'firespring_dev_commands', path: '/path/to/dev_commands'
 ```
 
 * Add the following to your Rakefile

data/lib/firespring_dev_commands/aws/account.rb

@@ -3,13 +3,13 @@ module Dev
     # Class containing useful methods for interacting with the Aws account
     class Account
       # Config object for setting top level Aws account config options
-      Config = Struct.new(:root, :children, :default, :registry, :ecr_registry_ids, :login_to_account_ecr_registry)
+      Config = Struct.new(:root, :children, :default, :registry, :default_login_role_name)
 
       # Instantiates a new top level config object if one hasn't already been created
       # Yields that config object to any given block
       # Returns the resulting config object
       def self.config
-        @config ||= Config.new
+        @config ||= Config.new(default_login_role_name: Dev::Aws::DEFAULT_LOGIN_ROLE_NAME)
         yield(@config) if block_given?
         @config
       end
@@ -22,7 +22,7 @@ module Dev
       # The name of the file containing the Aws settings
       CONFIG_FILE = "#{Dev::Aws::CONFIG_DIR}/config".freeze
 
-      attr_accessor :root, :children, :default, :registry, :ecr_registry_ids
+      attr_accessor :root, :children, :default, :registry
 
       # Instantiate an account object
       # Requires that root account and at least one child account have been configured
@@ -35,12 +35,7 @@ module Dev
         @root = self.class.config.root
         @children = self.class.config.children
         @default = self.class.config.default
-
-        # Create the ecr registry list based off several possible configuration values
-        @ecr_registry_ids = Array(self.class.config.ecr_registry_ids)
-        @ecr_registry_ids << self.class.config.registry
-        @ecr_registry_ids << Dev::Aws::Profile.new.current if self.class.config.login_to_account_ecr_registry
-        @ecr_registry_ids = @ecr_registry_ids.flatten.compact.reject(&:empty?).uniq
+        @registry = self.class.config.registry
       end
 
       # Returns all configured account information objects
@@ -78,8 +73,13 @@ module Dev
         region_default = defaultini['region'] || ENV['AWS_DEFAULT_REGION'] || Dev::Aws::DEFAULT_REGION
         defaultini['region'] = Dev::Common.new.ask('Default region name', region_default)
 
-        mfa_default = defaultini['mfa_serial'] || ENV['AWS_MFA_ARN'] || "arn:aws:iam::#{root}:mfa/#{ENV.fetch('USERNAME', nil)}"
-        defaultini['mfa_serial'] = Dev::Common.new.ask('Default mfa arn', mfa_default)
+        # NOTE: We had an old config for "mfa_serial" which included the entire arn. We deprecated that config since
+        #       it made it much more difficult to switch between different root accounts.
+        mfa_name_default = defaultini['mfa_serial']&.split(%r{mfa/})&.last || ENV['AWS_MFA_ARN']&.split(%r{mfa/})&.last || ENV.fetch('USERNAME', nil)
+        defaultini['mfa_serial_name'] = Dev::Common.new.ask('Default mfa name', mfa_name_default)
+        # TODO: Eventually, we should delete the mfa_serial entry from the config. Leaving it for now because some projects
+        #       may be using older versions of the dev_commands library
+        # defaultini.delete('mfa_serial')
 
         session_name_default = defaultini['role_session_name'] || "#{ENV.fetch('USERNAME', nil)}_cli"
         defaultini['role_session_name'] = Dev::Common.new.ask('Default session name', session_name_default)
@@ -116,8 +116,13 @@ module Dev
         region_default = profileini['region'] || defaultini['region'] || ENV['AWS_DEFAULT_REGION'] || Dev::Aws::DEFAULT_REGION
         profileini['region'] = Dev::Common.new.ask('Default region name', region_default)
 
-        role_default = profileini['role_arn'] || "arn:aws:iam::#{account}:role/ReadonlyAccessRole"
-        profileini['role_arn'] = Dev::Common.new.ask('Default role arn', role_default)
+        # NOTE: We had an old config for "role_arn" which included the entire arn. We deprecated that config since
+        #       it made it much more difficult to switch between different accounts.
+        role_name_default = profileini['role_name'] || profileini['role_arn']&.split(%r{role/})&.last || self.class.config.default_login_role_name
+        profileini['role_name'] = Dev::Common.new.ask('Default role name', role_name_default)
+        # TODO: Eventually, we should delete the role_arn entry from the config. Leaving it for now because some projects
+        #       may be using older versions of the dev_commands library
+        # profileini.delete('role_arn')
 
         cfgini.write
       end

data/lib/firespring_dev_commands/aws/credentials.rb

@@ -65,6 +65,8 @@ module Dev
         credini = IniFile.new(filename: "#{Dev::Aws::CONFIG_DIR}/credentials", default: 'default')
         defaultini = credini['default']
 
+        # TODO: Should we allow for multiple sets of base credentials? How do I use this for both FDP and SBF?
+
         access_key_default = defaultini['aws_access_key_id']
         defaultini['aws_access_key_id'] = Dev::Common.new.ask('AWS Access Key ID', access_key_default)
 

data/lib/firespring_dev_commands/aws/login.rb

@@ -8,7 +8,7 @@ module Dev
     class Login
       # Main interface for logging in to an AWS account
       # If an account is not specified the user is given an account selection menu
-      # If account registries have been configured, the user is also logged in to the docker registries
+      # If an account registry has been configured, the user is also logged in to the docker registry
       def login!(account = nil)
         # If more than one child account has been configured, have the user select the account they want to log in to
         account ||= Dev::Aws::Account.new.select
@@ -22,8 +22,8 @@ module Dev
         # Load credentials into the ENV for subprocesses
         Dev::Aws::Credentials.new.export!
 
-        # Login in to all configured docker registries
-        registry_logins!
+        # Login in to the docker registry if the user has configured one
+        registry_login! if Dev::Aws::Account.new.registry
       end
 
       # Authorize your local credentials
@@ -31,28 +31,32 @@ module Dev
       # Temporary credentials are written back to the credentials file
       def authorize!(account)
         # Make sure the account has been set up
-        cfgini = IniFile.new(filename: "#{Dev::Aws::CONFIG_DIR}/config", default: 'default')
-        unless cfgini.has_section?("profile #{account}")
-          Dev::Aws::Account.new.write!(account)
-          cfgini = IniFile.new(filename: "#{Dev::Aws::CONFIG_DIR}/config", default: 'default')
-        end
+        cfgini = setup_cfgini
 
         defaultini = cfgini['default']
         profileini = cfgini["profile #{account}"]
 
-        serial = profileini['mfa_serial'] || defaultini['mfa_serial']
-        role = profileini['role_arn'] || defaultini['role_arn']
+        region = profileini['region'] || defaultini['region'] || Dev::Aws::DEFAULT_REGION
+
+        serial = profileini['mfa_serial_name'] || defaultini['mfa_serial_name']
+        serial = "arn:aws:iam::#{Dev::Aws::Account.new.roo.id}:mfa/#{serial}" if serial
+        serial ||= profileini['mfa_serial'] || defaultini['mfa_serial']
+
+        role = profileini['role_name'] || defaultini['role_name']
+        role = "arn:aws:iam::#{account}:role/#{role}" if role
+        role ||= profileini['role_arn'] || defaultini['role_arn']
+
         session_name = profileini['role_session_name'] || defaultini['role_session_name']
         session_duration = profileini['session_duration'] || defaultini['session_duration']
 
         puts
-        puts "  Logging in to #{account} as #{role}".light_yellow
+        puts "  Logging in to #{account} in #{region} as #{role}".light_yellow
         puts
 
         code = ENV['AWS_TOKEN_CODE'] || Dev::Common.new.ask("Enter the MFA code for the #{ENV.fetch('USERNAME', '')} user serial #{serial}")
         raise 'MFA is required' unless code.to_s.strip
 
-        sts = ::Aws::STS::Client.new(profile: 'default')
+        sts = ::Aws::STS::Client.new(profile: 'default', region: region)
         creds = sts.assume_role(
           serial_number: serial,
           role_arn: role,
@@ -65,19 +69,21 @@ module Dev
         Dev::Aws::Credentials.new.write!(account, creds)
       end
 
-      # Authroizes the docker cli to pull/push images from the Aws container registry (e.g. if docker compose needs to pull an image)
-      # Authroizes the docker ruby library to pull/push images from the Aws container registry
-      def registry_logins!(registry_ids: Dev::Aws::Account.new.ecr_registry_ids, region: Dev::Aws::DEFAULT_REGION)
-        return if registry_ids.empty?
-
-        puts
-        registry_ids.each { |id| registry_login!(registry_id: id, region: region) }
-        puts
+      # Returns the config ini file
+      # Runs the setup for our current account if it's not already setup
+      def setup_cfgini
+        cfgini = IniFile.new(filename: "#{Dev::Aws::CONFIG_DIR}/config", default: 'default')
+        unless cfgini.has_section?("profile #{account}")
+          Dev::Aws::Account.new.write!(account)
+          cfgini = IniFile.new(filename: "#{Dev::Aws::CONFIG_DIR}/config", default: 'default')
+        end
+        cfgini
       end
 
       # Authroizes the docker cli to pull/push images from the Aws container registry (e.g. if docker compose needs to pull an image)
       # Authroizes the docker ruby library to pull/push images from the Aws container registry
-      def registry_login!(registry_id: Dev::Aws::Account.new.registries, region: Dev::Aws::DEFAULT_REGION)
+      def registry_login!(registry_id: Dev::Aws::Account.new.registry, region: nil)
+        region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
         raise 'registry_id is required' if registry_id.to_s.strip.empty?
         raise 'region is required' if region.to_s.strip.empty?
 
@@ -92,25 +98,27 @@ module Dev
       # Authroizes the docker cli to pull/push images from the Aws container registry
       # (e.g. if docker compose needs to pull an image)
       # @deprecated Please use {Dev::Aws::Login#registry_login!} instead
-      def docker_login!(registry_id: Dev::Aws::Account.new.registry, region: Dev::Aws::DEFAULT_REGION)
+      def docker_login!(registry_id: Dev::Aws::Account.new.registry, region: nil)
+        region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
         warn '[DEPRECATION] `Dev::Aws::Login#docker_login!` is deprecated. Please use `Dev::Aws::Login#registry_login!` instead.'
         docker_cli_login!(registry: "#{registry_id}.dkr.ecr.#{region}.amazonaws.com", region: region)
-        puts
       end
 
       # Authroizes the docker cli to pull/push images from the Aws container registry
       # (e.g. if docker compose needs to pull an image)
       private def docker_cli_login!(registry:, region:)
-        print("  Logging in to #{registry} in docker... ")
+        print('  Logging in to ECR in docker... ')
         login_cmd = "aws --profile=#{Dev::Aws::Profile.new.current} ecr --region=#{region} get-login-password"
         login_cmd << ' | '
         login_cmd << "docker login --password-stdin --username AWS #{registry}"
         Dev::Common.new.run_command([login_cmd])
+        puts
       end
 
       # Authroizes the docker ruby library to pull/push images from the Aws container registry
       # @deprecated Please use {Dev::Aws::Login#registry_login!} instead
-      def ecr_login!(registry_id: Dev::Aws::Account.new.registry, region: Dev::Aws::DEFAULT_REGION)
+      def ecr_login!(registry_id: Dev::Aws::Account.new.registry, region: nil)
+        region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
         warn '[DEPRECATION] `Dev::Aws::Login#ecr_login!` is deprecated. Please use `Dev::Aws::Login#registry_login!` instead.'
         docker_lib_login!(registry_id: registry_id, region: region)
       end

data/lib/firespring_dev_commands/aws/profile.rb

@@ -50,6 +50,15 @@ module Dev
         puts "    export AWS_SESSION_TOKEN=#{ENV.fetch('AWS_SESSION_TOKEN', nil)}"
         puts
       end
+
+      # Print the export commands for the current credentials
+      def export_info
+        Dev::Aws::Credentials.new.export!
+        puts "export AWS_DEFAULT_REGION=#{ENV.fetch('AWS_DEFAULT_REGION', nil)}"
+        puts "export AWS_ACCESS_KEY_ID=#{ENV.fetch('AWS_ACCESS_KEY_ID', nil)}"
+        puts "export AWS_SECRET_ACCESS_KEY=#{ENV.fetch('AWS_SECRET_ACCESS_KEY', nil)}"
+        puts "export AWS_SESSION_TOKEN=#{ENV.fetch('AWS_SESSION_TOKEN', nil)}"
+      end
     end
   end
 end

data/lib/firespring_dev_commands/aws.rb

@@ -4,7 +4,10 @@ module Dev
     # The config dir for the user's AWS settings
     CONFIG_DIR = "#{Dir.home}/.aws".freeze
 
-    # The default region used if none have been configured in the AWS settings
+    # The default region used if none has been configured in the AWS settings
     DEFAULT_REGION = 'us-east-1'.freeze
+
+    # The default role name used if none has been configured when logging in
+    DEFAULT_LOGIN_ROLE_NAME = 'ReadonlyAccessRole'.freeze
   end
 end

data/lib/firespring_dev_commands/templates/aws.rb

@@ -31,6 +31,20 @@ module Dev
             task profile: %w(init) do
               Dev::Aws::Profile.new.info
             end
+
+            namespace :profile do
+              desc 'Return the commands to export your AWS credentials into your environment'
+              task :export do
+                # Turn off all logging except for errors
+                LOG.level = Logger::ERROR
+
+                # Run the init
+                Rake::Task[:init].invoke
+
+                # Print the export info
+                Dev::Aws::Profile.new.export_info
+              end
+            end
           end
         end
       end

data/lib/firespring_dev_commands/templates/base_interface.rb

@@ -118,9 +118,9 @@ DEV_COMMANDS_TOP_LEVEL.instance_eval do
 
   # Define an empty _pre_down_hooks handler which can be overridden by the user
   task :_pre_down_hooks do
-    # The user may define custom _pre_logs_hooks tasks to add any pre-logs actions the logs process
-    # Define this process in the appropriate namespace to add them only to a specific logs
-    #   In that case it is recommended that you call the base _pre_logs_hooks as a dependency of that task
+    # The user may define custom _pre_down_hooks tasks to add any pre-down actions the down process
+    # Define this process in the appropriate namespace to add them only to a specific down
+    #   In that case it is recommended that you call the base _pre_down_hooks as a dependency of that task
   end
 
   # Define an empty _post_down_hooks handler which can be overridden by the user
@@ -130,6 +130,20 @@ DEV_COMMANDS_TOP_LEVEL.instance_eval do
     #   In that case it is recommended that you call the base _post_down_hooks as a dependency of that task
   end
 
+  # Define an empty _pre_stop_hooks handler which can be overridden by the user
+  task :_pre_stop_hooks do
+    # The user may define custom _pre_stop_hooks tasks to add any pre-stop actions the stop process
+    # Define this process in the appropriate namespace to add them only to a specific stop
+    #   In that case it is recommended that you call the base _pre_stop_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_stop_hooks handler which can be overridden by the user
+  task :_post_stop_hooks do
+    # The user may define custom _post_stop_hooks tasks to add any post-stop actions the stop process
+    # Define this process in the appropriate namespace to add them only to a specific stop
+    #   In that case it is recommended that you call the base _post_stop_hooks as a dependency of that task
+  end
+
   # Define an empty _pre_reload_hooks handler which can be overridden by the user
   task :_pre_reload_hooks do
     # The user may define custom _pre_reload_hooks tasks to add any pre-reload actions the reload process

data/lib/firespring_dev_commands/templates/docker/application.rb

@@ -108,7 +108,7 @@ module Dev
             namespace application do
               return if exclude.include?(:down)
 
-              desc "Stops the #{application} container"
+              desc "Shut down the #{application} container and remove associated resources"
               task down: %w(init_docker _pre_down_hooks) do
                 LOG.debug "In #{application} down"
 
@@ -125,6 +125,25 @@ module Dev
           end
         end
 
+        # Create the rake task which runs a docker compose stop for the application name
+        def create_stop_task!
+          application = @name
+          exclude = @exclude
+
+          DEV_COMMANDS_TOP_LEVEL.instance_eval do
+            namespace application do
+              return if exclude.include?(:stop)
+
+              desc "Stops the #{application} container"
+              task stop: %w(init_docker _pre_stop_hooks) do
+                LOG.debug "In #{application} stop"
+                Dev::Docker::Compose.new(services: [application]).stop
+                Rake::Task[:_post_stop_hooks].execute
+              end
+            end
+          end
+        end
+
         # Create the rake task which stops, cleans, and starts the application
         def create_reload_task!
           application = @name

data/lib/firespring_dev_commands/templates/docker/default.rb

@@ -76,6 +76,30 @@ module Dev
           end
         end
 
+        # Create the rake task which stops all running containers
+        def create_stop_task!
+          exclude = @exclude
+
+          DEV_COMMANDS_TOP_LEVEL.instance_eval do
+            return if exclude.include?(:stop)
+
+            desc 'Stops all running containers'
+            task stop: %w(init_docker _pre_stop_hooks) do
+              LOG.debug('In base stop')
+
+              containers = ::Docker::Container.all(filters: {status: %w(restarting running)}.to_json)
+              containers.each do |container|
+                next if container&.info&.dig('Names')&.any? { |name| name.start_with?('/windows_tcp') }
+
+                LOG.info "Stopping container #{container.id[0, 12]}"
+                container.stop(timeout: 120)
+              end
+
+              Rake::Task[:_post_stop_hooks].execute
+            end
+          end
+        end
+
         # Create the rake task which runs a docker compose down followed by an up
         def create_reload_task!
           exclude = @exclude

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '1.4.3.pre.alpha.1'.freeze
+    VERSION = '1.5.0.pre.alpha.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 1.4.3.pre.alpha.1
+  version: 1.5.0.pre.alpha.1
 platform: ruby
 authors:
 - Firespring