firespring_dev_commands 3.0.0.pre.alpha.1 → 3.0.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72bba6fb9e4d227bad3c551b1ac78eb42819178141353aefbf9a6186bd986175
-  data.tar.gz: d7f127460c9daedbe0bfe7e5902cc40196cd8e383a29c971ae0241ae76978f28
+  metadata.gz: 7ae0ecadec576f4f6c986fc7391faa03f1d148473f3c04f250c40edb120355df
+  data.tar.gz: ab84f1118a1c28c1667d0a825bbf57bfddf01d3a219e07715422e4e0ec50bf04
 SHA512:
-  metadata.gz: 10690a7a9e253d00f7ca60d36358893248cd111a07b28918564b1dd79e2f19dcf77ea5d980c905005d05c1f2ed8aba395c595c3af3426c76c431062405f3eb86
-  data.tar.gz: 369af054ddaaeaae52e347ec02a49b26edff5f2b9c1b88c39c4b7061c68ec64ad091d052b193828034bd2f3d6165550fc920f752524ccbe70c8dc828d71beec1
+  metadata.gz: 575c45ba8a86cad256f030eebe6a9ee7987fb0cd0bb8f413989efa92e237d7fc40e1030a325e965696b5c6da47cd55e91a941eecd5b8e2f4bd81bcafcaeaee3b
+  data.tar.gz: 3c07674f01809f4f8aaa2042691815c4795cffc298ff3ffffeabf293d00b4e61c64d5989a4d81ebcaa287258cf75002836eaa0d1c23ef22af445b7420dd786b7

data/lib/firespring_dev_commands/docker/artifact.rb

@@ -0,0 +1,12 @@
+module Dev
+  class Docker
+    class Artifact
+      attr_accessor :container_path, :local_path
+
+      def initialize(container_path:, local_path:)
+        @container_path = container_path
+        @local_path = local_path
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/docker/compose.rb

@@ -126,6 +126,11 @@ module Dev
         execute_command(build_command('stop'))
       end
 
+      # Pull in supported env settings and call restart
+      def restart
+        execute_command(build_command('restart'))
+      end
+
       # Call the compose exec method passing the given args after it
       def exec(*args)
         execute_command(build_command('exec', *args))

data/lib/firespring_dev_commands/docker.rb

@@ -162,7 +162,7 @@ module Dev
       rescue => e
         raise e if required
 
-        puts 'Not Found'
+        puts "#{source_path} Not Found"
       end
 
       Dev::Tar.new(tar).unpack(source_path, dest_path)

data/lib/firespring_dev_commands/templates/base_interface.rb

@@ -144,18 +144,18 @@ DEV_COMMANDS_TOP_LEVEL.instance_eval do
     #   In that case it is recommended that you call the base _post_stop_hooks as a dependency of that task
   end
 
-  # Define an empty _pre_reload_hooks handler which can be overridden by the user
-  task :_pre_reload_hooks do
-    # The user may define custom _pre_reload_hooks tasks to add any pre-reload actions the reload process
-    # Define this process in the appropriate namespace to add them only to a specific reload
-    #   In that case it is recommended that you call the base _pre_reload_hooks as a dependency of that task
-  end
-
-  # Define an empty _post_reload_hooks handler which can be overridden by the user
-  task :_post_reload_hooks do
-    # The user may define custom _post_reload_hooks tasks to add any post-reload actions the reload process
-    # Define this process in the appropriate namespace to add them only to a specific reload
-    #   In that case it is recommended that you call the base _post_reload_hooks as a dependency of that task
+  # Define an empty _pre_restart_hooks handler which can be overridden by the user
+  task :_pre_restart_hooks do
+    # The user may define custom _pre_restart_hooks tasks to add any pre-restart actions the restart process
+    # Define this process in the appropriate namespace to add them only to a specific restart
+    #   In that case it is recommended that you call the base _pre_restart_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_restart_hooks handler which can be overridden by the user
+  task :_post_restart_hooks do
+    # The user may define custom _post_restart_hooks tasks to add any post-restart actions the restart process
+    # Define this process in the appropriate namespace to add them only to a specific restart
+    #   In that case it is recommended that you call the base _post_restart_hooks as a dependency of that task
   end
 
   # Define an empty _pre_clean_hooks handler which can be overridden by the user

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

@@ -145,17 +145,17 @@ module Dev
         end
 
         # Create the rake task which stops, cleans, and starts the application
-        def create_reload_task!
+        def create_restart_task!
           application = @name
           exclude = @exclude
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
             namespace application do
-              return if exclude.include?(:reload)
+              return if exclude.include?(:restart)
 
               desc "Reloads the #{application} container"
-              task reload: %w(init_docker _pre_reload_hooks down up_no_deps) do
-                Rake::Task[:_post_reload_hooks].execute
+              task restart: %w(init_docker _pre_restart_hooks down up_no_deps) do
+                Rake::Task[:_post_restart_hooks].execute
               end
             end
           end

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

@@ -101,16 +101,18 @@ module Dev
           end
         end
 
-        # Create the rake task which runs a docker compose down followed by an up
-        def create_reload_task!
+        # Create the rake task which runs a docker compose restart
+        def create_restart_task!
           exclude = @exclude
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
-            return if exclude.include?(:reload)
+            return if exclude.include?(:restart)
 
             desc 'Runs a "down" followed by an "up"'
-            task reload: %w(_pre_reload_hooks down up) do
-              Rake::Task[:_post_reload_hooks].execute
+            task restart: %w(_pre_restart_hooks) do
+              LOG.debug('In base restart')
+              Dev::Docker::Compose.new.restart
+              Rake::Task[:_post_restart_hooks].execute
             end
           end
         end

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

@@ -17,6 +17,8 @@ module Dev
           # @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,
@@ -25,20 +27,28 @@ module Dev
             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) }
 
             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
@@ -54,9 +64,16 @@ module Dev
                   task lint: %w(init_docker up_no_deps) do
                     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
@@ -73,7 +90,9 @@ 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
@@ -81,6 +100,7 @@ module Dev
             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
@@ -100,13 +120,22 @@ module Dev
                   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
-                    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)
-                    node.check_test_coverage(application:)
+                    begin
+                      LOG.debug("Running all node tests in the #{application} codebase")
 
+                      # 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
@@ -117,6 +146,7 @@ module Dev
               end
             end
           end
+          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs the install command for the application packages
           def create_install_task!
@@ -162,7 +192,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(*node.audit_command)
                     Dev::Node::Audit.new(data).to_report.check
                   end

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

@@ -17,6 +17,9 @@ module Dev
           # @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,
@@ -24,11 +27,17 @@ module Dev
             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
@@ -77,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
@@ -97,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
@@ -107,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)
@@ -116,7 +135,9 @@ 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
@@ -124,6 +145,7 @@ module Dev
             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
@@ -143,13 +165,22 @@ module Dev
                   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(test_init_docker #{up_cmd}) do
-                    LOG.debug("Running all php tests in the #{application} codebase")
-
-                    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:)
+                    begin
+                      LOG.debug("Running all php tests in the #{application} codebase")
 
+                      # 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
@@ -160,6 +191,7 @@ module Dev
               end
             end
           end
+          # rubocop:enable Metrics/MethodLength
 
           # Create the rake tasks which runs the install command for the application packages
           def create_install_task!
@@ -205,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

@@ -17,6 +17,9 @@ module Dev
           # @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,
@@ -24,20 +27,28 @@ module Dev
             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) }
 
             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
@@ -53,9 +64,16 @@ module Dev
                   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
@@ -63,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)
@@ -72,7 +91,9 @@ 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
@@ -80,6 +101,7 @@ module Dev
             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
@@ -99,13 +121,21 @@ module Dev
                   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
-                    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)
-                    ruby.check_test_coverage(application:)
+                    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)
+                      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
@@ -116,6 +146,7 @@ module Dev
               end
             end
           end
+          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs the install command for the application packages
           def create_install_task!

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.alpha.1
+  version: 3.0.0.pre.alpha.3
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -338,6 +338,7 @@ files:
 - 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