firespring_dev_commands 2.1.21.pre.alpha.2 → 2.1.21.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e1ba4de217508ebdec8d17da4156baaab7bfb45154519d5b5aa930d8f8755b
-  data.tar.gz: 9b208c659543d76dc89b7b9e92d21991445056d9cae72bf7616bed2b5169d6b8
+  metadata.gz: d35a98b66dfe013f7552c2d5baf17b373ad71e3893945844a24768620755bf5f
+  data.tar.gz: faa627fca3af6b2c2ef417fd1442439b16d7acafa6a1a3dfa5da1fc01c26e327
 SHA512:
-  metadata.gz: a6c7ef9927e5b2cd60a0f21ebd50d6a2b0f96aa383c69d9b8196c2d4c4c11700350e231dcb34b5e1bf83f5953cc999ebbf6b7edcc8d0a9ee200275e936fda4cd
-  data.tar.gz: e97e145d2820c3ecd8143fafcf5a730edb39351fdfb2bf61b95344039e0ae54801c0029dccb6d1b313cd093aa195bcd775674145a23b2ba6a6838b77b3cf4297
+  metadata.gz: 434c1348564f615f90438f4682080aa70a659693a264e2b47ac17f94e935fb0dfbace4875df3c76dcd5ac76d2ce44cdc7ded70ec10882e5fa4927f01e9e4fb0c
+  data.tar.gz: a11c82d457d76e6eeca78217db40a62d7cc9c6eade77c2f07cb9c68ed89b4b1d274b6e7cad5e64abefa0c1814c23b29a03f2e4b0d837d9f9faece9b24ca5821b

data/lib/firespring_dev_commands/coverage/cobertura.rb

@@ -1,29 +1,44 @@
 module Dev
+  # Module containing different classes for interfacing with coverage files
   module Coverage
+    # Class for checking code coverage using cobertura
     class Cobertura
-      attr_reader :local_filename, :container_filename, :filename, :threshold
+      attr_reader :local_path, :container_path, :filename, :threshold, :local_path, :local_filename, :container_path, :container_filename
 
       def initialize(filename: 'cobertura.xml', threshold: nil, container_path: nil, local_path: nil)
         @filename = filename
+        @local_path = local_path
         @local_filename = File.join(local_path || '.', @filename)
+        @container_path = container_path
         @container_filename = File.join(container_path || '.', @filename)
         @threshold = threshold.to_f
+      end
 
+      # Remove any previous versions of the local file that will be output
+      # return the phpunit options needed to regenerate the cobertura xml file
+      def php_options
         # Remove any previous coverage info
         FileUtils.rm_f(local_filename, verbose: true)
-      end
 
-      def options
+        # Return the needed php commands to generate the cobertura report
         %W(--coverage-cobertura #{container_filename})
       end
 
-      def check
+      # Parse the cobertura file as a hash and check the total coverage against the desired threshold
+      def check(application: nil)
+        # If an application has been specified and the file does not exist locally, attempt to copy it back from the docker container
+        if application && !File.exist?(local_filename)
+          container = Dev::Docker::Compose.new.container_by_name(application)
+          workdir = Dev::Docker.new.default_working_dir(container)
+          Dev::Docker.new.copy_from_container(container, File.join(workdir, filename), local_filename, required: true)
+        end
+
+        # Load the file from disk and parse with ox
         report = Ox.load(File.read(local_filename), mode: :hash)
         attrs, = report[:coverage]
         cov_pct = attrs[:'line-rate'].to_f * 100
-        raise format('Line coverage %.2f%% is less than the threshold %.2f%%', cov_pct, threshold) if cov_pct < threshold
-
-        puts format('Line coverage %.2f%% is above the threshold %.2f%%', cov_pct, threshold)
+        puts format('Line coverage was %.2f%%. Configured threshold was %.2f%%', cov_pct, threshold)
+        raise 'Code coverage not met' if cov_pct < threshold
       end
     end
   end

data/lib/firespring_dev_commands/docker.rb

@@ -138,6 +138,11 @@ module Dev
       Docker::Compose.new.mapped_public_port(name, private_port)
     end
 
+    # Gets the default working dir of the container
+    def default_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)
       LOG.info "Copying #{source_path} to #{dest_path}... "

data/lib/firespring_dev_commands/php.rb

@@ -95,14 +95,14 @@ module Dev
     def test_command
       test = []
       test << './vendor/bin/phpunit'
-      test << coverage.options if coverage
+      test << coverage.php_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
-      coverage.check
+    def check_test_coverage(application:)
+      coverage.check(application:)
     end
 
     # Build the php fast test command

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

@@ -135,7 +135,7 @@ module Dev
                     options = []
                     options << '-T' if Dev::Common.new.running_codebuild?
                     Dev::Docker::Compose.new(services: application, options:).exec(*php.test_command)
-                    php.check_test_coverage
+                    php.check_test_coverage(application:)
                   end
                 end
               end

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.1.21.pre.alpha.2'.freeze
+    VERSION = '2.1.21.pre.alpha.4'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.21.pre.alpha.2
+  version: 2.1.21.pre.alpha.4
 platform: ruby
 authors:
 - Firespring