firespring_dev_commands 2.1.21.pre.alpha.7 → 2.1.21.pre.alpha.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8854ab66747e26c22780c4e6756df86dac09bc5a8029fae51f1382d29d18c27f
-  data.tar.gz: ca3ddd354a8faddb180d827891886ce78483accb7e7f1e2e5b5b9d6bcc9d36f7
+  metadata.gz: 4189e443ce57ccf4e992178ad2dd0de137017a8d78f6d63a4e4f7b55f76fe61b
+  data.tar.gz: ab87b579efff5fe40edfad306c6088504b176b61f4d0997e8ab8804f65a61177
 SHA512:
-  metadata.gz: 4aace4ef89ab6ec98008184ffb58d71febc920bcc85195a3fe2fa645a4109f8523348cdfae5e281a731d6ce6ddac3769a101800ee7b6e63ad31f4efcfa2f84c4
-  data.tar.gz: c700fd928018dc384757fddeae412eb4990323b94b47a16026736738d43e4a8ff12202b15014ebd0b92d30f5705dcffeab439a78e61ea711e0074ecff22d6cec
+  metadata.gz: 329dc4520ff98700950aef5c5b67920e8f8b520d6f8eba693150526e7144c962b55c31924e0d956b108fe8914777d4d21daf14c20393bb3f61902c19dd92a315
+  data.tar.gz: 873fcd5623d4e007cd2018285656caa029fdbf9dc34714b64df4223a10cb118b95919bbc428176ee7d68b29da6aea130163881a5480cd0fe2db7a033795af8ae

data/lib/firespring_dev_commands/coverage/base.rb

@@ -0,0 +1,13 @@
+module Dev
+  module Coverage
+    class Base
+      def php_options
+        raise 'not implemented'
+      end
+
+      def check(*)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/coverage/cobertura.rb

@@ -2,14 +2,21 @@ 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
+    class Cobertura < Base
+      attr_reader :local_filename, :container_filename, :filename, :threshold, :exclude
+
+      def initialize(filename: File.join('coverage', 'cobertura.xml'), threshold: nil, container_path: nil, local_path: nil, exclude: nil)
+        super()
 
-      def initialize(filename: File.join('coverage', 'cobertura.xml'), threshold: nil, container_path: nil, local_path: nil)
         @filename = filename
         @local_filename = File.join(local_path || '.', @filename)
         @container_filename = File.join(container_path || '.', @filename)
         @threshold = threshold
+        @exclude = (exclude || []).map do |it|
+          next it if it.is_a?(Regex)
+
+          Regex.new(it)
+        end
       end
 
       # Remove any previous versions of the local file that will be output
@@ -22,7 +29,7 @@ module Dev
         %W(--coverage-cobertura #{container_filename})
       end
 
-      # Parse the cobertura file as a hash and check the total coverage against the desired threshold
+      # Parse the cobertura file and check the lines missed 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)
@@ -30,26 +37,49 @@ module Dev
           Dev::Docker.new.copy_from_container(container, container_filename, local_filename, required: true)
         end
 
-        # Load the file from disk and parse with ox
-        report = Ox.load(File.read(local_filename), mode: :hash)
-        _, _, files = report[:coverage]
-
-        covered = missed = 0
-        files.dig(:packages, :package)&.each do |_attrs, packages|
-          _, _, lines = *packages&.dig(:classes, :class)
-          lines&.dig(:lines, :line)&.each do |it|
-            it = it&.first if it.is_a?(Array)
-            if it&.dig(:hits).to_i.positive?
-              covered += 1
-            else
-              missed += 1
-            end
-          end
+        report = Ox.load(File.read(local_filename))
+        total_missed = report.coverage.locate('packages/package').sum { |package| parse_package_missed(package) }
+        puts "Lines missing coverage was #{total_missed}"
+        puts "Configured threshold was #{threshold}" if threshold
+        raise 'Code coverage not met' if threshold && total_missed > threshold
+      end
+
+      # Go through the package and add up all of the lines that were missed
+      # Ignore if the file was in the exlude list
+      private def parse_package_missed(package)
+        filename =  package.attributes[:name]
+        return if exclude.any? { |it| it.match(filename) }
+
+        missed = 0
+        lines_processed = Set.new
+        package.locate('classes/class/lines/line').each do |line|
+          # Don't count lines multiple times
+          line_number = line.attributes[:number]
+          next if lines_processed.include?(line_number)
+
+          lines_processed << line_number
+          missed += 1 unless line.attributes[:hits].to_i.positive?
         end
+        total = lines_processed.length
 
-        puts "Lines missing coverage was #{missed}"
-        puts "Configured threshold was #{threshold}" if threshold
-        raise 'Code coverage not met' if threshold && missed > threshold
+        sanity_check_coverage_against_cobertura_values(package, missed, total)
+        missed
+      end
+
+      # Calculate the coverage percent based off the numbers we got and compare to the
+      # value cobertura reported. This is meant as a sanity check that we are reading the data correctly
+      # TODO: This should be removed after the above logic has been vetted
+      private def sanity_check_coverage_against_cobertura_values(package, missed, total)
+        line_rate = package.attributes[:'line-rate']
+        cobertura_reported_coverage = line_rate.to_f
+        cobertura_reported_precision = line_rate.split('.').last.length
+
+        file_coverage = 0.0
+        file_coverage = ((total - missed).to_f / total).round(cobertura_reported_precision) if total.positive?
+        return if file_coverage == cobertura_reported_coverage
+
+        filename = package.attributes[:name]
+        puts "WARNINNG: #{filename} coverage (#{file_coverage}) differed from what cobertura reported (#{cobertura_reported_coverage})"
       end
     end
   end

data/lib/firespring_dev_commands/coverage/none.rb

@@ -0,0 +1,17 @@
+module Dev
+  module Coverage
+    class None < Base
+      def initialize(*)
+        super()
+      end
+
+      def php_options
+        []
+      end
+
+      def check(*)
+        puts 'Coverage not configured'
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/php.rb

@@ -8,12 +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, :coverage_threshold) 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_threshold = nil
+        self.coverage = nil
       end
     end
 
@@ -33,11 +33,11 @@ module Dev
 
     attr_accessor :container_path, :local_path, :package_file, :coverage
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage_threshold: 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 = Dev::Coverage::Cobertura.new(container_path:, local_path:, threshold: coverage_threshold)
+      @coverage = coverage || Dev::Coverage::None.new
     end
 
     # The base npm command that is the starting point for all subsequent commands
@@ -95,7 +95,7 @@ module Dev
     def test_command
       test = []
       test << './vendor/bin/phpunit'
-      test << coverage.php_options if coverage
+      test.concat(coverage.php_options) if coverage
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end

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

@@ -20,10 +20,10 @@ module Dev
             container_path: nil,
             local_path: nil,
             start_container_dependencies_on_test: true,
-            coverage_threshold: nil,
+            coverage: nil,
             exclude: []
           )
-            @php = Dev::Php.new(container_path:, local_path:, coverage_threshold:)
+            @php = Dev::Php.new(container_path:, local_path:, coverage:)
             @start_container_dependencies_on_test = start_container_dependencies_on_test
 
             super(application, exclude:)

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.21.pre.alpha.7
+  version: 2.1.21.pre.alpha.9
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -333,7 +333,9 @@ files:
 - 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/compose.rb