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

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

@@ -1,5 +1,4 @@
 require_relative '../../base_interface'
-require 'securerandom'
 
 module Dev
   module Template
@@ -8,14 +7,37 @@ module Dev
       module Php
         # Class for default rake tasks associated with a php project
         class Application < Dev::Template::ApplicationInterface
-          attr_reader :php, :siloed_tests
+          attr_reader :php, :start_container_dependencies_on_test, :test_isolation
 
-          # Allow for custom container path for the application
-          def initialize(application, container_path: nil, local_path: nil, siloed_tests: nil, exclude: [])
-            @php = Dev::Php.new(container_path:, local_path:)
-            # TODO: Better name
-            # TODO: Should this apply to all or just tests?
-            @siloed_tests = siloed_tests
+          # Create the templated rake tasks for the php 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: []
+          )
+            @php = Dev::Php.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) }
 
             super(application, exclude:)
           end
@@ -64,11 +86,13 @@ module Dev
             end
           end
 
+          # rubocop:disable Metrics/MethodLength
           # Create the rake task which runs linting for the application name
           def create_lint_task!
             application = @name
             php = @php
             exclude = @exclude
+            lint_artifacts = @lint_artifacts
             return if exclude.include?(:lint)
 
             DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -84,9 +108,16 @@ module Dev
                   task lint: %w(init_docker up_no_deps) do
                     LOG.debug("Check for php 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(*php.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
@@ -94,6 +125,7 @@ module Dev
                     task fix: %w(init_docker up_no_deps) do
                       LOG.debug("Check and fix all php linting errors in the #{application} codebase")
 
+                      # Run the lint fix command
                       options = []
                       options << '-T' if Dev::Common.new.running_codebuild?
                       Dev::Docker::Compose.new(services: application, options:).exec(*php.lint_fix_command)
@@ -103,13 +135,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
             php = @php
-            siloed_tests = @siloed_tests
             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
@@ -119,24 +155,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 :php do
                   desc "Run all php tests against the #{application}'s codebase" \
                        "\n\t(optional) use OPTS=... to pass additional options to the command"
-                  task test: %w(init_docker up) do
-                    LOG.debug("Running all php tests in the #{application} codebase")
-
-                    project_name = nil
-                    project_name = SecureRandom.hex if siloed_tests
+                  task test: %W(test_init_docker #{up_cmd}) do
+                    begin
+                      LOG.debug("Running all php tests in the #{application} codebase")
 
-                    options = []
-                    options << '-T' if Dev::Common.new.running_codebuild?
-                    Dev::Docker::Compose.new(project_name:, services: application, options:).exec(*php.test_command)
-                    # TODO: Add clean if we are siloed
+                      # Run the test command
+                      options = []
+                      options << '-T' if Dev::Common.new.running_codebuild?
+                      Dev::Docker::Compose.new(services: application, options:).exec(*php.test_command)
+                      php.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 tasks which runs the install command for the application packages
           def create_install_task!
@@ -182,7 +237,7 @@ module Dev
                     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(*php.audit_command)
                     Dev::Php::Audit.new(data).to_report.check
                   end

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

@@ -7,19 +7,48 @@ module Dev
       module Ruby
         # Class for default rake tasks associated with a ruby project
         class Application < Dev::Template::ApplicationInterface
-          attr_reader :ruby
+          attr_reader :ruby, :start_container_dependencies_on_test, :test_isolation
+
+          # Create the templated rake tasks for the ruby 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: []
+          )
+            @ruby = Dev::Ruby.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: [])
-            @ruby = Dev::Ruby.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
             ruby = @ruby
             exclude = @exclude
+            lint_artifacts = @lint_artifacts
             return if exclude.include?(:lint)
 
             DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -30,13 +59,21 @@ module Dev
                 end
 
                 namespace :ruby do
-                  desc "Run the ruby linting software against the #{application}'s codebase"
+                  desc "Run the ruby 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 ruby 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(*ruby.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
@@ -44,6 +81,7 @@ module Dev
                     task fix: %w(init_docker up_no_deps) do
                       LOG.debug("Check and fix all ruby linting errors in the #{application} codebase")
 
+                      # Run the lint fix command
                       options = []
                       options << '-T' if Dev::Common.new.running_codebuild?
                       Dev::Docker::Compose.new(services: application, options:).exec(*ruby.lint_fix_command)
@@ -53,12 +91,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
             ruby = @ruby
             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 +111,42 @@ 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 :ruby do
-                  desc "Run all ruby tests against the #{application}'s codebase"
-                  task test: %w(init_docker up_no_deps) do
-                    LOG.debug("Running all ruby tests in the #{application} codebase")
+                  desc "Run all ruby 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 ruby tests in the #{application} codebase")
 
-                    options = []
-                    options << '-T' if Dev::Common.new.running_codebuild?
-                    Dev::Docker::Compose.new(services: application, options:).exec(*ruby.test_command)
+                      options = []
+                      options << '-T' if Dev::Common.new.running_codebuild?
+                      Dev::Docker::Compose.new(services: application, options:).exec(*ruby.test_command)
+                      ruby.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,7 +186,8 @@ module Dev
                 namespace :ruby do
                   desc 'Run Bundle 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?

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 = '2.5.0.pre.alpha.3'.freeze
+    VERSION = '3.0.0.pre.alpha.2'.freeze
   end
 end

data/lib/firespring_dev_commands.rb

@@ -11,7 +11,7 @@ DEV_COMMANDS_TOP_LEVEL = self
 
 # Load all gems referenced in the Gemfile
 require 'bundler'
-Bundler.require
+Bundler.require(:default)
 
 # Add libdir to the default ruby path
 libdir = File.realpath(File.dirname(__FILE__))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.5.0.pre.alpha.3
+  version: 3.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,154 +16,154 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.1
+        version: 7.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.1
+        version: 7.1.2
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.83.0
+        version: 1.97.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.83.0
+        version: 1.97.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-codepipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.67.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.67.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.61.0
+        version: 1.68.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.61.0
+        version: 1.68.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-elasticache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.88.0
+        version: 1.95.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.88.0
+        version: 1.95.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-lambda
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.101.0
+        version: 1.113.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.101.0
+        version: 1.113.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-opensearchservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.33.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.33.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-rds
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.183.0
+        version: 1.208.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.183.0
+        version: 1.208.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.127.0
+        version: 1.141.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.127.0
+        version: 1.141.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ssm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.154.0
+        version: 1.162.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.154.0
+        version: 1.162.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -249,61 +249,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: libxml-ruby
+  name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 2.14.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 2.14.17
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 description: Ruby library for creating/maintaining your development environment
 email: opensource@firespring.com
 executables: []
@@ -327,10 +327,18 @@ files:
 - lib/firespring_dev_commands/aws/parameter.rb
 - lib/firespring_dev_commands/aws/profile.rb
 - lib/firespring_dev_commands/aws/s3.rb
+- lib/firespring_dev_commands/bloom_growth.rb
+- lib/firespring_dev_commands/bloom_growth/rock.rb
+- lib/firespring_dev_commands/bloom_growth/seat.rb
+- lib/firespring_dev_commands/bloom_growth/user.rb
 - lib/firespring_dev_commands/boolean.rb
 - lib/firespring_dev_commands/common.rb
+- lib/firespring_dev_commands/coverage/base.rb
+- lib/firespring_dev_commands/coverage/cobertura.rb
+- lib/firespring_dev_commands/coverage/none.rb
 - lib/firespring_dev_commands/daterange.rb
 - lib/firespring_dev_commands/docker.rb
+- lib/firespring_dev_commands/docker/artifact.rb
 - lib/firespring_dev_commands/docker/compose.rb
 - lib/firespring_dev_commands/docker/status.rb
 - lib/firespring_dev_commands/dotenv.rb