firespring_dev_commands 2.1.22 → 2.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e072ae981046f7bdcd86b078617c9503a5d72ac2b21c2fdfce1c5c51ee8eae5b
-  data.tar.gz: b98bf6d2bb8c8c9598e5a124f9f10ba0c9c94c384e6065a7dafa1a9cefb5aff2
+  metadata.gz: e63ba948a4c8c755d644d4e651f14cd354b0b8086447134da735c9dfb1425b3d
+  data.tar.gz: 4ffa7a76482a10e277f0c2be17f28dcbabe4eb9f9dbf21f49420d11329444beb
 SHA512:
-  metadata.gz: 17ded1bd8523d1d695935404d604f66d724c9b032585f4d36d16f30a51485d73154438d8d37c2eb9a38a1a48c1d7e95bd21bb76290f893c9a43f4926b886bdf5
-  data.tar.gz: a971fca800581cd4ee592e9da0605c9f7c3c43702ce22ae7070c81f27ff796553eea5a8ce083d2380421019999d6af768c5df44aa9eaf73affe20d7c54817126
+  metadata.gz: 842d17d7290d5a1537766d76bb3c6935b57b19826fa70387af69730af796f684c50a05a85faebc04522da83a7368b128bf433ea6bd3d51c043da8472143f4233
+  data.tar.gz: ffb4634e2a02c33ea2e16fb53785d0c72eec929ce439c86bea9b9ea98adb8e75689e25c614d495e5857b6e6fa8f7725621ac9bf9f430c38a5094653de8aaff64

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

@@ -0,0 +1,86 @@
+module Dev
+  # Module containing different classes for interfacing with coverage files
+  module Coverage
+    # Class for checking code coverage using cobertura
+    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()
+
+        @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
+      # 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)
+
+        # Return the needed php commands to generate the cobertura report
+        %W(--coverage-cobertura #{container_filename})
+      end
+
+      # 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)
+          container = Dev::Docker::Compose.new.container_by_name(application)
+          Dev::Docker.new.copy_from_container(container, container_filename, local_filename, required: true)
+        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
+
+      # 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
+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/docker.rb

@@ -138,8 +138,14 @@ module Dev
       Docker::Compose.new.mapped_public_port(name, private_port)
     end
 
+    # Gets the default working dir of the container
+    def 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)
+      dest_path = File.join(working_dir(container), dest_path) unless dest_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       container.archive_in(source_path, dest_path, overwrite: true)
@@ -154,6 +160,7 @@ module Dev
     # Copies the source path on the container to the destination path on your local machine
     # If required is set to true, the command will fail if the source path does not exist on the container
     def copy_from_container(container, source_path, dest_path, required: true)
+      source_path = File.join(working_dir(container), source_path) unless source_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       tar = StringIO.new

data/lib/firespring_dev_commands/php.rb

@@ -8,11 +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) 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 = nil
       end
     end
 
@@ -30,12 +31,14 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :container_path, :local_path, :package_file
+    attr_accessor :container_path, :local_path, :package_file, :coverage
 
-    def initialize(container_path: nil, local_path: nil, package_file: 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 = coverage || Dev::Coverage::None.new
+      raise 'coverage must be an instance of the base class' unless @coverage.is_a?(Dev::Coverage::Base)
     end
 
     # The base npm command that is the starting point for all subsequent commands
@@ -93,10 +96,16 @@ module Dev
     def test_command
       test = []
       test << './vendor/bin/phpunit'
+      test.concat(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(application:)
+      coverage.check(application:)
+    end
+
     # Build the php fast test command
     def test_fast_command(processes = 4)
       test = []

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

@@ -20,10 +20,12 @@ module Dev
             container_path: nil,
             local_path: nil,
             start_container_dependencies_on_test: true,
+            coverage: nil,
             exclude: []
           )
-            @php = Dev::Php.new(container_path:, local_path:)
+            @php = Dev::Php.new(container_path:, local_path:, coverage:)
             @start_container_dependencies_on_test = start_container_dependencies_on_test
+
             super(application, exclude:)
           end
 
@@ -133,6 +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(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.22'.freeze
+    VERSION = '2.1.23'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.22
+  version: 2.1.23
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -333,6 +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