firespring_dev_commands 2.5.0.pre.alpha.3 → 3.0.0.pre.alpha.2

data/lib/firespring_dev_commands/node.rb

@@ -8,11 +8,12 @@ module Dev
     DEFAULT_PACKAGE_FILE = 'package.json'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:container_path, :local_path, :package_file) do
+    Config = Struct.new(:container_path, :local_path, :package_file, :coverage) 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
 
@@ -30,12 +31,14 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :container_path, :local_path, :package_file
+    attr_accessor :container_path, :local_path, :package_file, :coverage
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil)
+    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage: 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
@@ -75,7 +78,7 @@ module Dev
     # Build the node lint command
     def lint_command
       lint = base_command
-      lint << 'run' << 'lint'
+      lint << 'run' << 'lint' << '--'
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
@@ -83,7 +86,7 @@ module Dev
     # Build the node lint fix command
     def lint_fix_command
       lint_fix = base_command
-      lint_fix << 'run' << 'lint-fix'
+      lint_fix << 'run' << 'lint-fix' << '--'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
     end
@@ -91,17 +94,15 @@ module Dev
     # Build the node test command
     def test_command
       test = base_command
-      test << 'run' << 'test'
+      test << 'run' << 'test' << '--'
+      test.concat(coverage.node_options) if coverage
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end
 
-    # Build the node test (with coverage) command
-    def test_coverage_command
-      test = base_command
-      test << 'run' << 'test:coverage'
-      test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
-      test
+    # Run the check to ensure code coverage meets the desired threshold
+    def check_test_coverage(application:)
+      coverage.check(application:)
     end
   end
 end

data/lib/firespring_dev_commands/php.rb

@@ -8,11 +8,12 @@ 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) do
+    Config = Struct.new(:container_path, :local_path, :package_file, :coverage) 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
 
@@ -30,12 +31,14 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :container_path, :local_path, :package_file
+    attr_accessor :container_path, :local_path, :package_file, :coverage
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil)
+    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage: 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
@@ -73,7 +76,7 @@ module Dev
     # Build the php lint command
     def lint_command
       lint = base_command
-      lint << 'run' << 'lint'
+      lint << 'run' << 'lint' << '--'
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
@@ -81,7 +84,7 @@ module Dev
     # Build the php lint fix command
     def lint_fix_command
       lint_fix = base_command
-      lint_fix << 'run' << 'lint-fix'
+      lint_fix << 'run' << 'lint-fix' << '--'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
     end
@@ -89,14 +92,15 @@ module Dev
     # Build the php test command
     def test_command
       test = base_command
-      test << 'run' << 'test'
+      test << 'run' << 'test' << '--'
+      test.concat(coverage.php_options) if coverage
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end
 
-    # Build the php test (with coverage) command
-    def test_coverage_command
-      raise 'not implemented'
+    # Run the check to ensure code coverage meets the desired threshold
+    def check_test_coverage(application:)
+      coverage.check(application:)
     end
   end
 end

data/lib/firespring_dev_commands/platform.rb

@@ -8,7 +8,7 @@ module Dev
       # Normalize the ruby platform to return a docker platform architecture format
       def determine_compute_architecture
         case RUBY_PLATFORM
-        when /x86_64|amd64/
+        when /x86_64|amd64|x64-mingw/
           'linux/amd64' # 64-bit Intel/AMD architecture
         when /arm|aarch64/
           'linux/arm64' # ARM architecture

data/lib/firespring_dev_commands/ruby.rb

@@ -8,11 +8,12 @@ module Dev
     DEFAULT_PACKAGE_FILE = 'Gemfile'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:container_path, :local_path, :package_file, :min_version, :max_version) do
+    Config = Struct.new(:container_path, :local_path, :package_file, :min_version, :max_version, :coverage) do
       def initialize
         self.container_path = DEFAULT_PATH
         self.local_path = DEV_COMMANDS_ROOT_DIR
         self.package_file = DEFAULT_PACKAGE_FILE
+        self.coverage = nil
         self.min_version = nil
         self.max_version = nil
       end
@@ -37,12 +38,15 @@ module Dev
       end
     end
 
-    attr_accessor :container_path, :local_path, :package_file
+    attr_accessor :container_path, :local_path, :package_file, :coverage
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil)
+    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage: 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)
+
       check_version
     end
 
@@ -90,24 +94,32 @@ module Dev
 
     # Build the bundle lint command
     def lint_command
-      lint = ['rubocop']
+      lint = base_command
+      lint << 'exec' << 'rake' << 'lint'
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
 
     # Build the bundle lint fix command
     def lint_fix_command
-      lint_fix = ['rubocop']
-      lint_fix << '-A'
+      lint_fix = base_command
+      lint_fix << 'exec' << 'rake' << 'lint:fix'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
     end
 
     # Build the bundle test command
     def test_command
-      test = ['rspec']
+      test = base_command
+      test << 'exec' << 'rake' << 'test'
+      test.concat(coverage.ruby_options) if coverage
       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
   end
 end

data/lib/firespring_dev_commands/target_process/query.rb

@@ -2,12 +2,13 @@ module Dev
   class TargetProcess
     # Class for writing target process query statements
     class Query
-      attr_accessor :where, :incl, :take
+      attr_accessor :where, :incl, :take, :empty
 
       def initialize
         @where = []
         @incl = []
         @take = 250
+        @empty = false
       end
 
       # Add a new query clause
@@ -33,6 +34,11 @@ 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|
@@ -50,22 +56,38 @@ 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)
-        self << "(Team.Id in ('#{team_ids.join("', '")}'))" unless team_ids.nil? || team_ids.empty?
+        if team_ids.nil? || team_ids.empty?
+          @empty = true
+          return
+        end
+        self << "(Team.Id in ('#{team_ids.join("', '")}'))"
       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)
-        self << "(EntityState.Name in ('#{states.join("', '")}'))" unless states.nil? || states.empty?
+        if states.nil? || states.empty?
+          @empty = true
+          return
+        end
+        self << "(EntityState.Name in ('#{states.join("', '")}'))"
       end
 
       # Add a filter that looks for stories whose state is set to final
@@ -114,7 +136,11 @@ module Dev
 
       # Add a filter that looks for assignable ids which are included in the given array
       def filter_by_entity_ids(entity_ids)
-        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))" unless entity_ids.nil? || entity_ids.empty?
+        if entity_ids.nil? || entity_ids.empty?
+          @empty = true
+          return
+        end
+        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))"
       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 jira config options
+    # Config object for setting top level target process config options
     Config = Struct.new(:username, :password, :url, :http_debug) do
       def initialize
         Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
@@ -117,6 +117,8 @@ 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

@@ -49,7 +49,6 @@ module Dev
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
       # Create the rake task for the aws credentials setup and login method
       def create_login_task!
         # Have to set a local variable to be accessible inside of the instance_eval block
@@ -92,7 +91,6 @@ module Dev
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Create the rake task for the eol method
       def create_eol_task!

data/lib/firespring_dev_commands/templates/base_interface.rb

@@ -47,14 +47,14 @@ end
 # Create the base init command
 DEV_COMMANDS_TOP_LEVEL.instance_eval do
   task :init do
-    LOG.debug 'In base init'
+    # Placeholder for general initialization tasks
   end
 end
 
 # Create the base init_docker command
 DEV_COMMANDS_TOP_LEVEL.instance_eval do
   task init_docker: %w(init) do
-    LOG.debug 'In base init docker'
+    # Placeholder for general docker initialization tasks
   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 _pre_sh_hooks) do
+              task sh: %W(init_docker #{application}:up_no_deps _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) do
+              task reload: %w(init_docker _pre_reload_hooks down up_no_deps) do
                 Rake::Task[:_post_reload_hooks].execute
               end
             end

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

@@ -7,19 +7,48 @@ module Dev
       module Node
         # Class for default rake tasks associated with a node project
         class Application < Dev::Template::ApplicationInterface
-          attr_reader :node
+          attr_reader :node, :start_container_dependencies_on_test, :test_isolation
+
+          # Create the templated rake tasks for the node application
+          #
+          # @param application [String] The name of the application
+          # @param container_path [String] The path to the application inside of the container
+          # @param local_path [String] The path to the application on your local system
+          # @param start_container_dependencies_on_test [Boolean] Whether or not to start up container dependencies when running tests
+          # @param test_isolation [Boolean] Whether or not to start tests in an isolated project and clean up after tests are run
+          # @param coverage [Dev::Coverage::Base] The coverage class which is an instance of Base to be used to evaluate coverage
+          # @param lint_artifacts [Dev::Docker::Artifact] An array of lint artifacts to copy back from the container
+          # @param test_artifacts [Dev::Docker::Artifact] An array of test artifacts to copy back from the container
+          # @param exclude [Array<Symbol>] An array of default template tasks to exclude
+          def initialize(
+            application,
+            container_path: nil,
+            local_path: nil,
+            start_container_dependencies_on_test: false,
+            test_isolation: false,
+            coverage: nil,
+            lint_artifacts: nil,
+            test_artifacts: nil,
+            exclude: []
+          )
+            @node = Dev::Node.new(container_path:, local_path:, coverage:)
+            @start_container_dependencies_on_test = start_container_dependencies_on_test
+            @test_isolation = test_isolation
+            @lint_artifacts = lint_artifacts
+            @test_artifacts = test_artifacts
+            raise 'lint artifact must be instance of Dev::Docker::Artifact' if lint_artifacts&.any? { |it| !it.is_a?(Dev::Docker::Artifact) }
+            raise 'test artifact must be instance of Dev::Docker::Artifact' if test_artifacts&.any? { |it| !it.is_a?(Dev::Docker::Artifact) }
 
-          # Allow for custom container path for the application
-          def initialize(application, container_path: nil, local_path: nil, exclude: [])
-            @node = Dev::Node.new(container_path:, local_path:)
             super(application, exclude:)
           end
 
+          # rubocop:disable Metrics/MethodLength
           # Create the rake task which runs linting for the application name
           def create_lint_task!
             application = @name
             node = @node
             exclude = @exclude
+            lint_artifacts = @lint_artifacts
             return if exclude.include?(:lint)
 
             DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -30,19 +59,27 @@ module Dev
                 end
 
                 namespace :node do
-                  desc "Run the node linting software against the #{application}'s codebase"
+                  desc "Run the node linting software against the #{application}'s codebase" \
+                       "\n\t(optional) use OPTS=... to pass additional options to the command"
                   task lint: %w(init_docker up_no_deps) do
-                    LOG.debug('Check for node linting errors')
+                    LOG.debug("Check for node linting errors in the #{application} codebase")
 
+                    # Run the lint command
                     options = []
                     options << '-T' if Dev::Common.new.running_codebuild?
                     Dev::Docker::Compose.new(services: application, options:).exec(*node.lint_command)
+                  ensure
+                    # Copy any defined artifacts back
+                    container = Dev::Docker::Compose.new.container_by_name(application)
+                    lint_artifacts&.each do |artifact|
+                      Dev::Docker.new.copy_from_container(container, artifact.container_path, artifact.local_path)
+                    end
                   end
 
                   namespace :lint do
                     desc "Run the linting software against the #{application}'s codebase and apply all available fixes"
                     task fix: %w(init_docker up_no_deps) do
-                      LOG.debug('Check and fix linting errors')
+                      LOG.debug("Check and fix all node linting errors in the #{application} codebase")
 
                       options = []
                       options << '-T' if Dev::Common.new.running_codebuild?
@@ -53,12 +90,17 @@ module Dev
               end
             end
           end
+          # rubocop:enable Metrics/MethodLength
 
+          # rubocop:disable Metrics/MethodLength
           # Create the rake task which runs all tests for the application name
           def create_test_task!
             application = @name
             node = @node
             exclude = @exclude
+            test_isolation = @test_isolation
+            up_cmd = @start_container_dependencies_on_test ? :up : :up_no_deps
+            test_artifacts = @test_artifacts
             return if exclude.include?(:test)
 
             DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -68,19 +110,43 @@ module Dev
                   # This is just a placeholder to execute the dependencies
                 end
 
+                task test_init_docker: %w(init_docker) do
+                  Dev::Docker::Compose.configure do |c|
+                    c.project_name = SecureRandom.hex if test_isolation
+                  end
+                end
+
                 namespace :node do
-                  desc "Run all node tests against the #{application}'s codebase"
-                  task test: %w(init_docker up) do
-                    LOG.debug("Running all node tests in the #{application} codebase")
+                  desc "Run all node tests against the #{application}'s codebase" \
+                       "\n\t(optional) use OPTS=... to pass additional options to the command"
+                  task test: %W(test_init_docker #{up_cmd}) do
+                    begin
+                      LOG.debug("Running all node tests in the #{application} codebase")
 
-                    options = []
-                    options << '-T' if Dev::Common.new.running_codebuild?
-                    Dev::Docker::Compose.new(services: application, options:).exec(*node.test_command)
+                      # Run the test command
+                      options = []
+                      options << '-T' if Dev::Common.new.running_codebuild?
+                      Dev::Docker::Compose.new(services: application, options:).exec(*node.test_command)
+                      node.check_test_coverage(application:)
+                    ensure
+                      # Copy any defined artifacts back
+                      container = Dev::Docker::Compose.new.container_by_name(application)
+                      test_artifacts&.each do |artifact|
+                        Dev::Docker.new.copy_from_container(container, artifact.container_path, artifact.local_path)
+                      end
+                    end
+                  ensure
+                    # Clean up resources if we are on an isolated project name
+                    if test_isolation
+                      Dev::Docker::Compose.new.down
+                      Dev::Docker.new.prune_project_volumes(project_name: Dev::Docker::Compose.config.project_name)
+                    end
                   end
                 end
               end
             end
           end
+          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs the install command for the application packages
           def create_install_task!
@@ -120,12 +186,13 @@ module Dev
                 namespace :node do
                   desc 'Run NPM Audit on the target application' \
                        "\n\tuse MIN_SEVERITY=(info low moderate high critical) to fetch only severity type selected and above (default=high)." \
-                       "\n\tuse IGNORELIST=(comma delimited list of ids) removes the entry from the list."
+                       "\n\tuse IGNORELIST=(comma delimited list of ids) removes the entry from the list." \
+                       "\n\t(optional) use OPTS=... to pass additional options to the command"
                   task audit: %w(init_docker up_no_deps) do
                     opts = []
                     opts << '-T' if Dev::Common.new.running_codebuild?
 
-                    # Retrieve results of the scan.
+                    # Run the audit command and retrieve the results
                     data = Dev::Docker::Compose.new(services: application, options: opts, capture: true).exec(*node.audit_command)
                     Dev::Node::Audit.new(data).to_report.check
                   end