firespring_dev_commands 2.1.27 → 2.5.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586c30b994bb9c2b77fffdbd191ee5a6c03e29c27ab3166c07f820699e5f802a
-  data.tar.gz: 02db88f1ad6f64e43ea579878a625d695ff5b400b51da40658c9159c671c2a0c
+  metadata.gz: e146e8c9d9c3422dfd7641c6a09ca8c2cdfad6ed430d73aec5808de28ed5d880
+  data.tar.gz: 273923aae5ccce231fc77174ed89cbe0e4f5ad59b52219b04303f983e9966e1d
 SHA512:
-  metadata.gz: 802810c4490135ac15e4b742721a460cf23d011fe45de74a42a24bfdb6f1f5a7f197c40d3cb314fd7d29794bd06bc9870eadd24be09c44ccfdff9ef4588a6118
-  data.tar.gz: 0473a3020b1bf9f2963ac829161574bac1aed7c84abe9b7bf69a2f11d26e460d8735d07ef95ddb578f0807dff0aa567c7e4800751231ad69457be4225f18544f
+  metadata.gz: 67223e6ba12a10f798d7fee6b1cab844da41cd3dc65a449330e8c8bd0ef86180cc297889b7365b7b68f5ca8054919e9881693707ecfde02e539d0a7e22c6af51
+  data.tar.gz: ada0e13a3f2d8022687a2542503bad6bc847bf32fc17604116d17e06ed46ee7efa18aea35635c31a26c07f5ccdd6a3c5083235edaafd77684528bc487c17f3c7

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/common.rb

@@ -187,14 +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
   end
 end

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

@@ -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,14 +138,8 @@ 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_path, dest_path)
-      dest_path = File.join(working_dir(container), dest_path) unless dest_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       container.archive_in(source_path, dest_path, overwrite: true)
@@ -198,7 +154,6 @@ module Dev
     # 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_path, dest_path, required: true)
-      source_path = File.join(working_dir(container), source_path) unless source_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       tar = StringIO.new

data/lib/firespring_dev_commands/eol.rb

@@ -46,23 +46,13 @@ module Dev
       @products
     end
 
-    # Prints all of the product version statuses
-    def status
-      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

data/lib/firespring_dev_commands/git.rb

@@ -113,10 +113,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         @success &= status(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -165,10 +165,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         reset(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
     end
@@ -191,9 +191,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= checkout(branch, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -284,9 +285,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= merge(branch, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -332,9 +334,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= pull(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -370,9 +373,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= push(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -435,10 +439,11 @@ module Dev
     end
 
     # Center the string and pad on either side with the given padding character
-    # @deprecated Please use {Dev::Common#center_pad} instead
     def center_pad(string = '', pad: '-', len: 80)
-      warn '[DEPRECATION] `Dev::Git#center_pad` is deprecated. Please use `Dev::Common#center_pad` instead.'
-      Dev::Common.new.center_pad(string, pad:, len:)
+      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
 
     # Exclude the command from the message and print all error lines

data/lib/firespring_dev_commands/node.rb

@@ -96,7 +96,7 @@ module Dev
       test
     end
 
-    # Build the node test command
+    # Build the node test (with coverage) command
     def test_coverage_command
       test = base_command
       test << 'run' << 'test:coverage'

data/lib/firespring_dev_commands/php.rb

@@ -8,12 +8,11 @@ module Dev
     DEFAULT_PACKAGE_FILE = 'composer.json'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:container_path, :local_path, :package_file, :coverage) do
+    Config = Struct.new(:container_path, :local_path, :package_file) do
       def initialize
         self.container_path = DEFAULT_PATH
         self.local_path = DEV_COMMANDS_ROOT_DIR
         self.package_file = DEFAULT_PACKAGE_FILE
-        self.coverage = nil
       end
     end
 
@@ -31,14 +30,12 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :container_path, :local_path, :package_file, :coverage
+    attr_accessor :container_path, :local_path, :package_file
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage: nil)
+    def initialize(container_path: nil, local_path: nil, package_file: nil)
       @container_path = container_path || self.class.config.container_path
       @local_path = local_path || self.class.config.local_path
       @package_file = package_file || self.class.config.package_file
-      @coverage = coverage || Dev::Coverage::None.new
-      raise 'coverage must be an instance of the base class' unless @coverage.is_a?(Dev::Coverage::Base)
     end
 
     # The base npm command that is the starting point for all subsequent commands
@@ -61,12 +58,9 @@ module Dev
     end
 
     # Build the command to fix any security vulnerabilities that were found
-    # def audit_fix_command
-    #  audit_fix = base_command
-    #  audit_fix << 'audit' << 'fix'
-    #  audit_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
-    #  audit_fix
-    # end
+    def audit_fix_command
+      raise 'not implemented'
+    end
 
     # Build the php install command
     def install_command
@@ -79,7 +73,7 @@ module Dev
     # Build the php lint command
     def lint_command
       lint = base_command
-      lint << 'lint'
+      lint << 'run' << 'lint'
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
@@ -87,7 +81,7 @@ module Dev
     # Build the php lint fix command
     def lint_fix_command
       lint_fix = base_command
-      lint_fix << 'lint-fix'
+      lint_fix << 'run' << 'lint-fix'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
     end
@@ -95,24 +89,14 @@ module Dev
     # Build the php test command
     def test_command
       test = []
-      test << './vendor/bin/phpunit'
-      test.concat(coverage.php_options) if coverage
+      lint_fix << 'run' << 'test'
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end
 
-    # Run the check to ensure code coverage meets the desired threshold
-    def check_test_coverage(application:)
-      coverage.check(application:)
-    end
-
-    # Build the php fast test command
-    def test_fast_command(processes = 4)
-      test = []
-      test << './vendor/bin/paratest'
-      test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
-      test << "-p#{processes}" << '--runner=WrapperRunner'
-      test
+    # Build the php test (with coverage) command
+    def test_coverage_command
+      raise 'not implemented'
     end
   end
 end

data/lib/firespring_dev_commands/platform.rb

@@ -1,46 +1,39 @@
 module Dev
-  # Class which returns information about the current platform
-  class Platform
-    # Constant containing all supported architectures
-    ALLOWED_ARCHITECTURES = %w(linux/arm64 linux/amd64).freeze
-
-    # If an architecture was specified in the ENV, use that. Otherwise auto-deted based of the OS reported architecture
-    def architecture
-      arch = env_architecture || os_architecture
-      raise "Invalid DOCKER_ARCHITECTURE: #{arch} (allowed are #{ALLOWED_ARCHITECTURES.join(', ')})" unless ALLOWED_ARCHITECTURES.include?(arch)
-
-      arch
-    end
-
-    # Check to see if a docker architecture has been specified in the ENV
-    # If it has, verify the format and the value
-    private def env_architecture
-      arch = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
-      return nil if arch.empty?
+  class Common
+    # Class which returns information about the current platform
+    class Platform
+      # Constant containing all supported architectures
+      ALLOWED_ARCHITECTURES = %w(arm64 amd64).freeze
 
-      "linux/#{arch}" unless arch.start_with?('linux/')
-      arch
-    end
+      # Normalize the ruby platform to return a docker platform architecture format
+      def determine_compute_architecture
+        case RUBY_PLATFORM
+        when /x86_64|amd64/
+          'linux/amd64' # 64-bit Intel/AMD architecture
+        when /arm|aarch64/
+          'linux/arm64' # ARM architecture
+        else
+          raise 'Unknown or unsupported architecture'
+        end
+      end
 
-    # Returns a valid docker architecture based off the RUBY_PLATFORM
-    private def os_architecture
-      return 'linux/amd64' if RUBY_PLATFORM.match?(/x86_64|amd64|x64-mingw/)
-      return 'linux/arm64' if RUBY_PLATFORM.match?(/arm|aarch64/)
+      # Determine the platform architecture
+      # If one was specified in the DOCKER_ARCHITECTURE variable, use it
+      # Otherwise, use the RUBY_PLATFORM built-in to auto-detect and architecture
+      def architecture
+        docker_architecture = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
+        if docker_architecture.empty?
+          determine_compute_architecture
+        else
+          raise "Missing 'linux/' prefix in DOCKER_ARCHITECTURE: #{docker_architecture}" unless docker_architecture.start_with?('linux/')
 
-      raise 'Unknown or unsupported architecture'
-    end
-  end
-end
+          architecture_name = docker_architecture.split('/')[1]
+          unless ALLOWED_ARCHITECTURES.include?(architecture_name)
+            raise "Invalid DOCKER_ARCHITECTURE: #{architecture_name}. Allowed architectures are #{ALLOWED_ARCHITECTURES.join(', ')}"
+          end
 
-module Dev
-  class Common
-    # Class which returns information about the current platform
-    class Platform < Platform
-      # Initializer for the deprecated class
-      # @deprecated Please use {Dev::Platform#new} instead
-      def initialize
-        warn '[DEPRECATION] `Dev::Common::Platform#new` is deprecated.  Please use `Dev::Platform#new` instead.'
-        super
+          docker_architecture
+        end
       end
     end
   end

data/lib/firespring_dev_commands/ruby.rb

@@ -90,16 +90,14 @@ module Dev
 
     # Build the bundle lint command
     def lint_command
-      lint = base_command
-      lint << 'exec' << 'rubocop'
+      lint = ['rubocop']
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
 
     # Build the bundle lint fix command
     def lint_fix_command
-      lint_fix = base_command
-      lint_fix << 'exec' << 'rubocop'
+      lint_fix = ['rubocop']
       lint_fix << '-A'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
@@ -107,8 +105,7 @@ module Dev
 
     # Build the bundle test command
     def test_command
-      test = base_command
-      test << 'exec' << 'rspec'
+      test = ['rspec']
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end

data/lib/firespring_dev_commands/target_process/query.rb

@@ -2,13 +2,12 @@ module Dev
   class TargetProcess
     # Class for writing target process query statements
     class Query
-      attr_accessor :where, :incl, :take, :empty
+      attr_accessor :where, :incl, :take
 
       def initialize
         @where = []
         @incl = []
         @take = 250
-        @empty = false
       end
 
       # Add a new query clause
@@ -34,11 +33,6 @@ module Dev
         end
       end
 
-      # Check if any of the "in" statements were empty. If so then we don't want to actually run the query
-      def empty?
-        @empty == true
-      end
-
       # Generate the string representation for this query
       def generate
         {}.tap do |clause|
@@ -56,38 +50,22 @@ module Dev
       # TODO: Do these need moved to their associated entities?
       # Add a filter that looks for stories whose id is contained in the list of ids given
       def filter_by_user_story_ids(user_story_ids)
-        if user_story_ids.nil? || user_story_ids.empty?
-          @empty = true
-          return
-        end
         self << "(Id in ('#{user_story_ids.join("', '")}'))"
       end
 
       # Add a filter that looks for stories whose team id is contained in the list of ids given
       def filter_by_team_ids(team_ids)
-        if team_ids.nil? || team_ids.empty?
-          @empty = true
-          return
-        end
-        self << "(Team.Id in ('#{team_ids.join("', '")}'))"
+        self << "(Team.Id in ('#{team_ids.join("', '")}'))" unless team_ids.nil? || team_ids.empty?
       end
 
       # Add a filter that looks for stories whose project id is contained in the list of ids given
       def filter_by_project(projects)
-        if projects.nil? || projects.empty?
-          @empty = true
-          return
-        end
         self << "(Project.Name in ('#{projects.join("', '")}'))"
       end
 
       # Add a filter that looks for stories whose state is contained in the list of states given
       def filter_by_states(states)
-        if states.nil? || states.empty?
-          @empty = true
-          return
-        end
-        self << "(EntityState.Name in ('#{states.join("', '")}'))"
+        self << "(EntityState.Name in ('#{states.join("', '")}'))" unless states.nil? || states.empty?
       end
 
       # Add a filter that looks for stories whose state is set to final
@@ -136,11 +114,7 @@ module Dev
 
       # Add a filter that looks for assignable ids which are included in the given array
       def filter_by_entity_ids(entity_ids)
-        if entity_ids.nil? || entity_ids.empty?
-          @empty = true
-          return
-        end
-        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))"
+        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))" unless entity_ids.nil? || entity_ids.empty?
       end
 
       # Add a filter that looks for a custom deploy date between the given dates`

data/lib/firespring_dev_commands/target_process.rb

@@ -15,7 +15,7 @@ module Dev
     # The text of the url variable key
     TP_URL = 'TP_URL'.freeze
 
-    # Config object for setting top level target process config options
+    # Config object for setting top level jira config options
     Config = Struct.new(:username, :password, :url, :http_debug) do
       def initialize
         Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
@@ -117,8 +117,6 @@ module Dev
     # Call the given block (if present) with each piece of data
     # Return all pieces of data
     def get(path, query, &)
-      return [] if query.empty?
-
       query_string = query.generate
       url = "/api/v1/#{path}"
       url << "?#{URI.encode_www_form(query_string)}" unless query_string.empty?

data/lib/firespring_dev_commands/templates/aws.rb

@@ -101,22 +101,14 @@ module Dev
 
         DEV_COMMANDS_TOP_LEVEL.instance_eval do
           return if exclude.include?(:eol)
-          return if ENV.fetch('CHECK_AWS', nil).to_s.strip == 'false'
 
-          task eol: [:'eol:aws'] do
-            # This is just a placeholder to execute the dependencies
-          end
+          desc 'Compares the current date to the EOL date for supported resources'
+          task eol: %w(init ensure_aws_credentials) do
+            account_id = Dev::Aws::Profile.new.current
+            account_name = Dev::Aws::Account.new.name_by_account(account_id)
+            LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
 
-          namespace :eol do
-            desc 'Compares the current date to the EOL date for supported aws resources'
-            task aws: %w(init ensure_aws_credentials) do
-              account_id = Dev::Aws::Profile.new.current
-              account_name = Dev::Aws::Account.new.name_by_account(account_id)
-              LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
-              puts
-              Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).status
-              puts
-            end
+            Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).check
           end
         end
       end

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

@@ -72,7 +72,7 @@ module Dev
               return if exclude.include?(:sh)
 
               desc "Open a shell into a running #{application} container"
-              task sh: %W(init_docker #{application}:up_no_deps _pre_sh_hooks) do
+              task sh: %W(init_docker #{application}:up _pre_sh_hooks) do
                 Dev::Docker::Compose.new(services: [application]).sh
                 Rake::Task[:_post_sh_hooks].execute
               end
@@ -154,7 +154,7 @@ module Dev
               return if exclude.include?(:reload)
 
               desc "Reloads the #{application} container"
-              task reload: %w(init_docker _pre_reload_hooks down up_no_deps) do
+              task reload: %w(init_docker _pre_reload_hooks down up) do
                 Rake::Task[:_post_reload_hooks].execute
               end
             end