firespring_dev_commands 2.3.4 → 2.5.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4df81e3de5330b0b6265d91e6cd93ddd9091c0c3580d88bf4b9441ffe9bc54fd
-  data.tar.gz: 58c65ff1b82e00133b97ce1190f40a0b3a468102d01460af754d381c2832d2f5
+  metadata.gz: e146e8c9d9c3422dfd7641c6a09ca8c2cdfad6ed430d73aec5808de28ed5d880
+  data.tar.gz: 273923aae5ccce231fc77174ed89cbe0e4f5ad59b52219b04303f983e9966e1d
 SHA512:
-  metadata.gz: 6c9ab0653755eb182f3fdd9eb385fdbe3b4708e76d6e823f832ebcac1a9f4f60153f85b2200c5e51c61b540b4172e6fac1c098731dc64008cd3c490d1c368a11
-  data.tar.gz: fbf305d9f5dbb569edc662299d225527e8d4bffce26917100b1e4f7ef517dffae338ee206c54b2f77d3a0833e359f3aa172991af1c72e956913db952f685c348
+  metadata.gz: 67223e6ba12a10f798d7fee6b1cab844da41cd3dc65a449330e8c8bd0ef86180cc297889b7365b7b68f5ca8054919e9881693707ecfde02e539d0a7e22c6af51
+  data.tar.gz: ada0e13a3f2d8022687a2542503bad6bc847bf32fc17604116d17e06ed46ee7efa18aea35635c31a26c07f5ccdd6a3c5083235edaafd77684528bc487c17f3c7

data/README.md

@@ -28,7 +28,7 @@ Dev::Template::Docker::Node::Application.new('foo')
 ```
 * If you run `rake -T` now, you should have base rake commands and application rake commands for an app called `foo`
 
-* (optional) Add AWS login template commands
+* (optinoal) Add AWS login template commands
 ```
 # Configure AWS accounts and create tasks
 Dev::Aws::Account::configure do |c|

data/lib/firespring_dev_commands/audit/report.rb

@@ -3,12 +3,11 @@ module Dev
   class Audit
     # The class containing standardized information about an audit report
     class Report
-      attr_accessor :items, :min_severity, :error_on_unknown, :ignorelist, :filtered_items
+      attr_accessor :items, :min_severity, :ignorelist, :filtered_items
 
       def initialize(
         items,
         min_severity: ENV.fetch('MIN_SEVERITY', nil),
-        error_on_unknown: ENV.fetch('ERROR_ON_UNKNOWN', nil),
         ignorelist: ENV['IGNORELIST'].to_s.split(/\s*,\s*/)
       )
         # Items should be an array of Item objects
@@ -16,18 +15,12 @@ module Dev
         raise 'items must all be report items' unless @items.all?(Dev::Audit::Report::Item)
 
         @min_severity = min_severity || Level::HIGH
-        @error_on_unknown = error_on_unknown
         @ignorelist = Array(ignorelist).compact
       end
 
       # Get all severities greater than or equal to the minimum severity
       def desired_severities
-        max_severity = if error_on_unknown.to_s.strip == 'true'
-                         -1
-                       else
-                         -2
-                       end
-        LEVELS.slice(LEVELS.find_index(min_severity)..max_severity)
+        LEVELS.slice(LEVELS.find_index(min_severity)..-1)
       end
 
       # Run the filters against the report items and filter out any which should be excluded

data/lib/firespring_dev_commands/aws/account.rb

@@ -94,7 +94,7 @@ module Dev
         #       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', 'no_username_found')}_cli"
+        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)
 
         duration_default = defaultini['session_duration'] || 36_000

data/lib/firespring_dev_commands/aws/cloudformation.rb

@@ -21,10 +21,9 @@ module Dev
       # Finished status
       FINISHED = :finished
 
-      attr_accessor :client, :name, :template_filename, :parameters, :capabilities, :failure_behavior, :preserve_parameters_on_update, :state
+      attr_accessor :client, :name, :template_filename, :parameters, :capabilities, :failure_behavior, :state
 
-      def initialize(name, template_filename, parameters: Dev::Aws::Cloudformation::Parameters.new, capabilities: [], failure_behavior: 'ROLLBACK',
-                     preserve_parameters_on_update: false)
+      def initialize(name, template_filename, parameters: Dev::Aws::Cloudformation::Parameters.new, capabilities: [], failure_behavior: 'ROLLBACK')
         raise 'parameters must be an intsance of parameters' unless parameters.is_a?(Dev::Aws::Cloudformation::Parameters)
 
         @client = nil
@@ -33,7 +32,6 @@ module Dev
         @parameters = parameters
         @capabilities = capabilities
         @failure_behavior = failure_behavior
-        @preserve_parameters_on_update = preserve_parameters_on_update
         @state = NOT_STARTED
       end
 
@@ -83,16 +81,11 @@ module Dev
         # Call upload function to get the s3 url
         template_url = upload(template_filename)
 
-        update_parameters = if preserve_parameters_on_update
-                              parameters.preserve
-                            else
-                              parameters.default
-                            end
         # Update the cloudformation stack
         client.update_stack(
           stack_name: name,
           template_url:,
-          parameters: update_parameters,
+          parameters: parameters.preserve,
           capabilities:
         )
         @state = STARTED

data/lib/firespring_dev_commands/aws/login.rb

@@ -61,15 +61,15 @@ module Dev
         puts "  Logging in to #{account} in #{region} as #{role}".light_yellow
         puts
 
-        code = mfa_code(serial)
+        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', region:)
         creds = sts.assume_role(
-          serial_number: mfa_serial || serial,
+          serial_number: serial,
           role_arn: role,
           role_session_name: session_name,
-          token_code: code.to_s.strip,
+          token_code: code,
           duration_seconds: session_duration
         ).credentials
         puts
@@ -77,32 +77,6 @@ module Dev
         Dev::Aws::Credentials.new.write!(account, creds)
       end
 
-      # The custom local file where target information is stored.
-      CUSTOM_CONFIG_FILE = "#{Dir.home}/.bash_profile.d/config/.main".freeze
-
-      # Targets a custom ini config.
-      def custom_config_ini
-        IniFile.new(filename: CUSTOM_CONFIG_FILE, default: 'default')['default']
-      end
-
-      def mfa_serial
-        return unless !ENV.fetch('OP_LOGIN', nil).nil? && File.exist?(CUSTOM_CONFIG_FILE)
-
-        custom_config_ini['aws_1pass_mfa_serial']
-      end
-
-      # Handles the MFA code logic.
-      def mfa_code(serial)
-        # Note, OP_LOGIN likely not needed. Available as feature flag.
-        # Checks if OnePassword CLI is installed and the custom config file exist.
-        if !ENV.fetch('OP_LOGIN', nil).nil? && system('op --version', out: '/dev/null') && File.exist?(CUSTOM_CONFIG_FILE)
-          cmd = "op item get #{custom_config_ini['aws_uuid']} --otp"
-          `#{cmd}`
-        else
-          ENV['AWS_TOKEN_CODE'] || Dev::Common.new.ask("Enter the MFA code for the #{ENV.fetch('USERNAME', 'no_username_found')} user serial #{serial}")
-        end
-      end
-
       # Returns the config ini file
       # Runs the setup for our current account if it's not already setup
       def setup_cfgini(account)
@@ -114,8 +88,8 @@ module Dev
         cfgini
       end
 
-      # Authorizes the docker cli to pull/push images from the Aws container registry (e.g. if docker compose needs to pull an image)
-      # Authorizes the docker ruby library to pull/push images from the Aws container registry
+      # 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: nil, region: nil)
         registry_ids ||= Dev::Aws::Account.new.ecr_registry_ids
         region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
@@ -126,8 +100,8 @@ module Dev
         puts
       end
 
-      # Authorizes the docker cli to pull/push images from the Aws container registry (e.g. if docker compose needs to pull an image)
-      # Authorizes the docker ruby library to pull/push images from the Aws container registry
+      # 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: nil, region: nil)
         registry_id ||= Dev::Aws::Account.new.ecr_registry_ids.first
         region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
@@ -142,7 +116,7 @@ module Dev
         ENV['ECR_REGISTRY'] ||= registry
       end
 
-      # Authorizes the docker cli to pull/push images from the Aws container registry
+      # 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: nil, region: nil)
@@ -153,7 +127,7 @@ module Dev
         puts
       end
 
-      # Authorizes the docker cli to pull/push images from the Aws container registry
+      # 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... ")
@@ -163,7 +137,7 @@ module Dev
         Dev::Common.new.run_command([login_cmd])
       end
 
-      # Authorizes the docker ruby library to pull/push images from the Aws container registry
+      # 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: nil, region: nil)
         registry_id ||= Dev::Aws::Account.new.ecr_registry_ids.first
@@ -172,7 +146,7 @@ module Dev
         docker_lib_login!(registry_id:, region:)
       end
 
-      # Authorizes the docker ruby library to pull/push images from the Aws container registry
+      # Authroizes the docker ruby library to pull/push images from the Aws container registry
       private def docker_lib_login!(registry_id:, region:)
         # Grab your authentication token from AWS ECR
         ecr_client = ::Aws::ECR::Client.new(region:)

data/lib/firespring_dev_commands/common.rb

@@ -100,8 +100,8 @@ module Dev
     # Receive a string from the user on stdin unless non_interactive is set to true
     # If a default value was specified and no answer was given, return the default
     def gather_input(default: nil)
-      answer = $stdin.gets unless ENV['NON_INTERACTIVE'] == 'true'
-      answer = answer.to_s.strip
+      answer = $stdin.gets.to_s.strip unless ENV['NON_INTERACTIVE'] == 'true'
+      answer.to_s.strip
       return default if default && answer.empty?
 
       answer
@@ -187,25 +187,5 @@ module Dev
         return false
       end
     end
-
-    # Center the string and pad on either side with the given padding character
-    def center_pad(string = '', pad: '-', len: 80)
-      string = " #{string} " unless string.strip.empty?
-      center_dash = len / 2
-      string = string.to_s
-      center_str = string.length / 2
-      string.rjust(center_dash + center_str - 1, pad).ljust(len - 1, pad)
-    end
-
-    # Print the given filesize using the most appropriate units
-    def filesize(size)
-      return '0.0 B' if size.to_i.zero?
-
-      units = %w(B KB MB GB TB Pb EB)
-      exp = (Math.log(size) / Math.log(1024)).to_i
-      exp = 6 if exp > 6
-
-      format('%.1f %s', size.to_f / (1024**exp), units[exp])
-    end
   end
 end

data/lib/firespring_dev_commands/docker/compose.rb

@@ -233,8 +233,7 @@ module Dev
 
       # Merges two arrays removing nested structure and duplicate keys
       private def merge_options(*opts)
-        puts 'WARNING: merging options disabled' if @options.any? { |it| it.include?('--build-arg') }
-        @options = (@options + Array(opts)).flatten.uniq unless @options.any? { |it| it.include?('--build-arg') }
+        @options = (@options + Array(opts)).flatten.uniq
       end
 
       # Build the compose command with the given inputs

data/lib/firespring_dev_commands/docker/status.rb

@@ -33,26 +33,6 @@ module Dev
         EXITED,
         DEAD
       ].freeze
-
-      # TODO: Can we use 'curses' here and overwrite the correct line?
-      def response_callback(response)
-        response.split("\n").each do |line|
-          data = JSON.parse(line)
-          if data.include?('status')
-            if data['id']
-              LOG.info "#{data['id']}: #{data['status']}"
-            else
-              LOG.info (data['status']).to_s
-            end
-          elsif data.include?('errorDetail')
-            raise data['errorDetail']['message']
-          elsif data.include?('aux')
-            next
-          else
-            raise "Unrecognized message from docker: #{data}"
-          end
-        end
-      end
     end
   end
 end

data/lib/firespring_dev_commands/docker.rb

@@ -103,7 +103,7 @@ module Dev
       LOG.info "\nDeleted #{type.capitalize}"
       deleted_items = info["#{type}Deleted"] || []
       deleted_items.each { |it| LOG.info "  #{it}" }
-      LOG.info "Total reclaimed space: #{Dev::Common.new.filesize(info['SpaceReclaimed'])}"
+      LOG.info "Total reclaimed space: #{filesize(info['SpaceReclaimed'])}"
     end
 
     # Print the given filesize using the most appropriate units
@@ -117,44 +117,6 @@ module Dev
       format('%.1f %s', size.to_f / (1024**exp), units[exp])
     end
 
-    # Push the local version of the docker image to the defined remote repository
-    def push_image(image, name, tag = nil)
-      unless tag
-        if name.include?(':')
-          name, tag = name.split(':')
-        else
-          tag = 'latest'
-        end
-      end
-
-      puts "Pushing to #{name}:#{tag}"
-      image.push(::Docker.creds, repo_tag: "#{name}:#{tag}") { |response| Dev::Docker::Status.new.response_callback(response) }
-    end
-
-    # Push the remote version of the docker image from the defined remote repository
-    def pull_image(name, tag = nil)
-      unless tag
-        if name.include?(':')
-          name, tag = name.split(':')
-        else
-          tag = 'latest'
-        end
-      end
-
-      puts "\nPulling #{name}:#{tag}"
-      opts = {
-        fromImage: "#{name}:#{tag}",
-        platform: Dev::Platform.new.architecture
-      }
-      ::Docker::Image.create(**opts) { |response| Dev::Docker::Status.new.response_callback(response) }
-    end
-
-    # Remove the local version of the given docker image
-    def untag_image(image, name, tag)
-      puts "Untagging #{name}:#{tag}"
-      image.remove(name: "#{name}:#{tag}")
-    end
-
     # Remove docker images with the "force" option set to true
     # This will remove the images even if they are currently in use and cause unintended side effects.
     def force_remove_images(name_and_tag)
@@ -176,59 +138,27 @@ module Dev
       Docker::Compose.new.mapped_public_port(name, private_port)
     end
 
-    # Gets the default working dir of the container
-    def working_dir(container)
-      container.json['Config']['WorkingDir']
-    end
-
     # Copies the source path on your local machine to the destination path on the container
-    def copy_to_container(container, source, destination)
-      # Add the working dir of the container onto the destination (if it doesn't start a path separator)
-      destination = File.join(working_dir(container), destination) unless destination.start_with?(File::SEPARATOR)
-      LOG.info "Copying #{source} to #{destination}..."
-
-      # Need to determine the type of the destination (file or directory or nonexistant)
-      noexist_code = 22
-      file_code = 33
-      directory_code = 44
-      unknown_code = 55
-      filetype_cmd = [
-        'bash',
-        '-c',
-        "set -e; [ ! -e '#{destination}' ] && exit #{noexist_code}; [ -f '#{destination}' ] " \
-        "&& exit #{file_code}; [ -d '#{destination}' ] && exit #{directory_code}; exit #{unknown_code}"
-      ]
-      destination_filetype_code = container.exec(filetype_cmd).last
-
-      # If destination_filetype_code is a file - that means the user passed in a destination filename
-      # Unfortunately the archive_in command does not support that so we will strip it off and use it later (if needed)
-      source_filename = File.basename(source)
-      destination_filename = File.basename(source)
-      destination, _, destination_filename = destination.rpartition(File::SEPARATOR) if destination_filetype_code == file_code
-
-      container.archive_in(source, destination, overwrite: true)
-
-      if File.directory?(source)
-        # If the source was a directory, then the archive_in command leaves it as a tar on the system - so we need to unpack it
-        # TODO: Can we find a better solution for this? Seems pretty brittle
-        retcode = container.exec(['bash', '-c', "cd #{destination}; tar -xf #{destination_filename}; rm -f #{destination_filename}"]).last
-        raise 'Unable to unpack on container' unless retcode.zero?
-      elsif destination_filetype_code == file_code && source_filename != destination_filename
-        # If the destination was a file _and_ the filename is different than the source filename, then we need to rename it
-        retcode = container.exec(['bash', '-c', "cd #{destination}; mv #{source_filename} #{destination_filename}"]).last
-        raise "Unable to rename '#{source_filename}' to '#{destination_filename}' on container" unless retcode.zero?
-      end
+    def copy_to_container(container, source_path, dest_path)
+      LOG.info "Copying #{source_path} to #{dest_path}... "
+
+      container.archive_in(source_path, dest_path, overwrite: true)
+      return unless File.directory?(source_path)
+
+      dest_file = File.basename(source_path)
+      # TODO: Can we find a better solution for this? Seems pretty brittle
+      retcode = container.exec(['bash', '-c', "cd #{dest_path}; tar -xf #{dest_file}; rm -f #{dest_file}"])[-1]
+      raise 'Unable to unpack on container' unless retcode.zero?
     end
 
     # Copies the source path on the container to the destination path on your local machine
     # If required is set to true, the command will fail if the source path does not exist on the container
-    def copy_from_container(container, source, destination, required: true)
-      source = File.join(working_dir(container), source) unless source.start_with?(File::SEPARATOR)
-      LOG.info "Copying #{source} to #{destination}..."
+    def copy_from_container(container, source_path, dest_path, required: true)
+      LOG.info "Copying #{source_path} to #{dest_path}... "
 
       tar = StringIO.new
       begin
-        container.archive_out(source) do |chunk|
+        container.archive_out(source_path) do |chunk|
           tar.write(chunk)
         end
       rescue => e
@@ -237,7 +167,7 @@ module Dev
         puts 'Not Found'
       end
 
-      Dev::Tar.new(tar).unpack(source, destination)
+      Dev::Tar.new(tar).unpack(source_path, dest_path)
     end
 
     # rubocop:disable Metrics/ParameterLists
@@ -275,7 +205,7 @@ module Dev
         arch = "#{arch}/#{variant}" if variant
         id = image.info&.dig('id')&.split(':')&.last&.slice(0..11)
         created = timesince(Time.at(image.info&.dig('Created')))
-        size = Dev::Common.new.filesize(image.info&.dig('Size'))
+        size = filesize(image.info&.dig('Size'))
 
         repo_urls = image.info&.dig('RepoTags')
         repo_urls ||= ["#{image.info&.dig('RepoDigests')&.first&.split(':')&.first&.split('@')&.first}:<none>"]

data/lib/firespring_dev_commands/eol/aws.rb

@@ -72,23 +72,19 @@ module Dev
       # Queries and returns product versions for rds instance products
       def rds_instance_products
         aws_engines = %w(mysql postgresql)
-        aws_sqlserver_engines = %w(sqlserver-ee sqlserver-ex sqlserver-se sqlserver-web)
         client = ::Aws::RDS::Client.new
 
         [].tap do |ary|
           Dev::Aws.each_page(client, :describe_db_instances) do |response|
             response.db_instances.each do |instance|
               name = instance.db_instance_identifier
-              engine = instance.engine.gsub('aurora-', '')
+              engine = instance.engine.tr('aurora-', '')
               product = if aws_engines.include?(engine)
                           "amazon-rds-#{engine}"
-                        elsif aws_sqlserver_engines.include?(engine)
-                          'mssqlserver'
                         else
                           engine
                         end
               version = instance.engine_version.reverse.split('.')[-2..].join('.').reverse
-              version.chop! if version.end_with?('.00')
               ary << Dev::EndOfLife::ProductVersion.new(product, version, name)
             end
           end
@@ -98,23 +94,19 @@ module Dev
       # Queries and returns product versions for rds cluster products
       def rds_cluster_products
         aws_engines = %w(mysql postgresql)
-        aws_sqlserver_engines = %w(sqlserver-ee sqlserver-ex sqlserver-se sqlserver-web)
         client = ::Aws::RDS::Client.new
 
         [].tap do |ary|
           Dev::Aws.each_page(client, :describe_db_clusters) do |response|
             response.db_clusters.each do |cluster|
               name = cluster.db_cluster_identifier
-              engine = cluster.engine.gsub('aurora-', '')
+              engine = cluster.engine.tr('aurora-', '')
               product = if aws_engines.include?(engine)
                           "amazon-rds-#{engine}"
-                        elsif aws_sqlserver_engines.include?(engine)
-                          'mssqlserver'
                         else
                           engine
                         end
               version = cluster.engine_version.reverse.split('.')[-2..].join('.').reverse
-              version.chop! if version.end_with?('.00')
               ary << Dev::EndOfLife::ProductVersion.new(product, version, name)
             end
           end

data/lib/firespring_dev_commands/eol.rb

@@ -46,33 +46,13 @@ module Dev
       @products
     end
 
-    # Returns true if the given product is supported either in the endoflife api products or a manual product
-    def product?(product)
-      products.include?(product) || self.class.config.manual_dates.any? { |key, _| key.to_s.start_with?("#{product}_") }
-    end
-
-    # Prints all of the product version statuses
-    def status
-      if product_versions.empty?
-        puts '  no tracked products'
-        return
-      end
-
-      product_versions.sort_by(&:name).each(&:print_status)
-    end
-
-    # Returns true if any of the products are EOL
-    def eol?
-      product_versions.any?(&:eol)
-    end
-
     # Prints all of the product version statuses
     # Raises an error if any products are EOL
     def check
       puts
-      status
+      product_versions.sort_by(&:name).each(&:print_status)
       puts
-      raise 'found EOL versions' if eol?
+      raise 'found EOL versions' if product_versions.any?(&:eol)
     end
   end
 end