firespring_dev_commands 2.1.21.pre.alpha.7 → 2.1.21.pre.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8854ab66747e26c22780c4e6756df86dac09bc5a8029fae51f1382d29d18c27f
-  data.tar.gz: ca3ddd354a8faddb180d827891886ce78483accb7e7f1e2e5b5b9d6bcc9d36f7
+  metadata.gz: 82b69d61d6649aaa851e8000d68b651193d265b29be96318e5bbbf0383a901e7
+  data.tar.gz: 880ff091de3b0318a4c6b2838494ba4d68c47a325457d98a88008acee6d2bcf0
 SHA512:
-  metadata.gz: 4aace4ef89ab6ec98008184ffb58d71febc920bcc85195a3fe2fa645a4109f8523348cdfae5e281a731d6ce6ddac3769a101800ee7b6e63ad31f4efcfa2f84c4
-  data.tar.gz: c700fd928018dc384757fddeae412eb4990323b94b47a16026736738d43e4a8ff12202b15014ebd0b92d30f5705dcffeab439a78e61ea711e0074ecff22d6cec
+  metadata.gz: d5dfffdc56f103e23c0a00331003a1499a9cb9444a732a71355143b1e34682ee0d9a07215c096b29b42cbbd46d24d6ac43cc9ac890d6e4f2042fe31f463f8833
+  data.tar.gz: f08ea0a75721208a727934db0c3bd1b896b28f5f59e3c14efbd7a5468ac792df49543e175e73ad430cfcad8694318e1607d167ca06adccc17c91be9ac3456378

data/lib/firespring_dev_commands/coverage/cobertura.rb

@@ -3,13 +3,14 @@ module Dev
   module Coverage
     # Class for checking code coverage using cobertura
     class Cobertura
-      attr_reader :local_filename, :container_filename, :filename, :threshold
+      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)
+      def initialize(filename: File.join('coverage', 'cobertura.xml'), threshold: nil, container_path: nil, local_path: nil, exclude: nil)
         @filename = filename
         @local_filename = File.join(local_path || '.', @filename)
         @container_filename = File.join(container_path || '.', @filename)
         @threshold = threshold
+        @exclude = exclude || []
       end
 
       # Remove any previous versions of the local file that will be output
@@ -22,7 +23,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 +31,47 @@ 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
+        sanity_check_coverage_against_cobertura_values(package, missed, total)
+        missed
+      end
 
-        puts "Lines missing coverage was #{missed}"
-        puts "Configured threshold was #{threshold}" if threshold
-        raise 'Code coverage not met' if threshold && missed > threshold
+      # 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
+      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})".light_yellow
       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.7'.freeze
+    VERSION = '2.1.21.pre.alpha.8'.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.7
+  version: 2.1.21.pre.alpha.8
 platform: ruby
 authors:
 - Firespring