ae_test_coverage 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50dbd85d09d8e913781ba926e51d4a2f2c0b067cd1adda6d70a68971ef9efff0
+  data.tar.gz: 71a897c4163320ed8a7ad8be672cfedbde65d2d1b876e8cbf5f10145248d21da
+SHA512:
+  metadata.gz: 6591eb80941f55aa63028c3be3a6f4c870a64760425811bc7b819350921d70f8dc442307c3245a3b695589188f057e8d70467ba4357d2989e022527f1642be5c
+  data.tar.gz: '0996828626e12f9a29a4b87cc3c51aab3ae1b02bffcf9ac452f87da3d407cb12fe1a1db6c1bf13d663436294de38d6d057538b404de1034e0d41096a85d36ac3'

data/lib/ae_test_coverage.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'active_record'
+
+require 'ae_test_coverage/version'
+require 'ae_test_coverage/test_coverage_methods'
+
+require 'ae_test_coverage/collectors/ruby_coverage_collector'
+require 'ae_test_coverage/collectors/active_record/association_collector'
+require 'ae_test_coverage/collectors/active_record/attribute_reader_collector'
+require 'ae_test_coverage/collectors/active_record/attribute_writer_collector'
+require 'ae_test_coverage/collectors/action_view/asset_tag_collector'
+require 'ae_test_coverage/collectors/action_view/rendered_template_collector'
+require 'ae_test_coverage/collectors/webpacker/webpacker_app_collector'
+require 'ae_test_coverage/collectors/sprockets_asset_collector'
+
+module AeTestCoverage
+  class Config
+    attr_accessor :enabled_collector_classes
+    attr_accessor :webpacker_app_locations
+    attr_accessor :file_exclusion_check
+    attr_accessor :enable_check
+    attr_accessor :coverage_path
+    attr_accessor :sprockets_asset_collector_class
+
+    def initialize
+      @enabled_collector_classes = [
+        AeTestCoverage::Collectors::RubyCoverageCollector,
+        AeTestCoverage::Collectors::ActiveRecord::AssociationCollector,
+        AeTestCoverage::Collectors::ActiveRecord::AttributeWriterCollector,
+        AeTestCoverage::Collectors::ActiveRecord::AttributeReaderCollector,
+        AeTestCoverage::Collectors::ActionView::RenderedTemplateCollector,
+        AeTestCoverage::Collectors::ActionView::AssetTagCollector,
+        AeTestCoverage::Collectors::Webpacker::WebpackerAppCollector
+      ]
+      @webpacker_app_locations = []
+      @file_exclusion_check = Proc.new { |file| false }
+      @enable_check = Proc.new { false }
+      @coverage_path = './coverage'
+      @sprockets_asset_collector_class = AeTestCoverage::Collectors::SprocketsAssetCollector
+    end
+  end
+
+  class << self
+    attr_accessor :single_test_coverage_enabled, :coverage_collectors
+
+    def configure
+      @config ||= Config.new
+      yield @config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def initialize_collectors
+      if enabled?
+        @coverage_collectors = {}
+        config.enabled_collector_classes.each do |coverage_collector_class|
+          coverage_collectors[coverage_collector_class] = coverage_collector_class.new
+        end
+      end
+    end
+
+    def start_coverage
+      if self.enabled?
+        coverage_collectors.values.each do |coverage_collector|
+          coverage_collector.on_start
+        end
+      end
+    end
+
+    def exclude_file?(file)
+      AeTestCoverage.config.file_exclusion_check.call(file)
+    end
+
+    def enabled?
+      AeTestCoverage.config.enable_check.call
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/action_view/asset_tag_collector.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/action_view/asset_tag_helper'
+
+module AeTestCoverage
+  module Collectors
+    module ActionView
+      class AssetTagCollector
+        @@action_view_hook_set = false
+
+        def initialize
+          unless @@action_view_hook_set
+            ActiveSupport.on_load(:action_view) do
+              prepend AeTestCoverage::Collectors::ActionView::AssetTagHelper
+            end
+            @@action_view_hook_set = true
+          end
+        end
+
+        def on_start
+          @covered_assets_collection = Set.new
+        end
+
+        def add_covered_assets(*assets)
+          @covered_assets_collection&.merge(assets)
+        end
+
+        def covered_files
+          test_assets = Set.new(
+            @covered_assets_collection.flat_map do |asset_path|
+              AeTestCoverage.config.sprockets_asset_collector_class.new(asset_path).collect
+            end
+          )
+          {}.tap do |coverage_data|
+            test_assets.to_a.map do |asset_uri|
+              coverage_data[URI.parse(asset_uri).path] = {asset: true}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/action_view/asset_tag_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActionView
+      module AssetTagHelper
+        def javascript_include_tag(*sources)
+          AeTestCoverage.coverage_collectors[AssetTagCollector].add_covered_assets(*js_sources(sources))
+          super
+        end
+
+        def stylesheet_link_tag(*sources)
+          AeTestCoverage.coverage_collectors[AssetTagCollector].add_covered_assets(*css_sources(sources))
+          super
+        end
+
+        private
+
+        def sources_without_options(sources)
+          sources.last.is_a?(Hash) ? sources[0...-1] : sources
+        end
+
+        def js_sources(sources)
+          sources_without_options(sources).map { |source| "#{source}.js" }
+        end
+
+        def css_sources(sources)
+          sources_without_options(sources).map { |source| "#{source}.css" }
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/action_view/rendered_template_collector.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActionView
+      class RenderedTemplateCollector
+        class << self
+          attr_reader :subscriber
+
+          def subscribe(collector)
+            @subscriber = ActiveSupport::Notifications.subscribe('!render_template.action_view') do |_name, _start, _finish, _id, payload|
+              collector.add_covered_templates(payload[:identifier])
+            end
+          end
+
+          def unsubscribe
+            if @subscriber
+              ActiveSupport::Notifications.unsubscribe(@subscriber)
+              @subscriber = nil
+            end
+          end
+        end
+
+        def initialize
+          RenderedTemplateCollector.subscribe(self) unless RenderedTemplateCollector.subscriber.present?
+        end
+
+        def on_start
+          @covered_templates_collection = Set.new
+        end
+
+        def add_covered_templates(*tempates)
+          @covered_templates_collection&.merge(tempates)
+        end
+
+        def covered_files
+          {}.tap do |coverage_data|
+            @covered_templates_collection.map do |template_file|
+              coverage_data[template_file] = {template: true}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/association_collector.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/active_record/model_collector'
+require 'ae_test_coverage/collectors/active_record/association_helper'
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      class AssociationCollector < ModelCollector
+
+        private
+
+        def set_hook
+          ActiveSupport.on_load(:active_record) do
+            include AssociationHelper
+          end
+        end
+
+        def data
+          {association_referenced: true}
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/association_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      module AssociationHelper
+        def association(name)
+          AeTestCoverage.coverage_collectors[AssociationCollector].add_covered_models(self.class)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/attribute_reader_collector.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/active_record/model_collector'
+require 'ae_test_coverage/collectors/active_record/attribute_reader_helper'
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      class AttributeReaderCollector < ModelCollector
+
+        private
+
+        def set_hook
+          ActiveSupport.on_load(:active_record) do
+            include AttributeReaderHelper
+          end
+        end
+
+        def data
+          {attribute_referenced: true}
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/attribute_reader_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      module AttributeReaderHelper
+        def _read_attribute(attr_name)
+          AeTestCoverage.coverage_collectors[AttributeReaderCollector].add_covered_models(self.class)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/attribute_writer_collector.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/active_record/model_collector'
+require 'ae_test_coverage/collectors/active_record/attribute_writer_helper'
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      class AttributeWriterCollector < ModelCollector
+
+        private
+
+        def set_hook
+          ActiveSupport.on_load(:active_record) do
+            include AttributeWriterHelper
+          end
+        end
+
+        def data
+          {attribute_written: true}
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/attribute_writer_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      module AttributeWriterHelper
+        def _write_attribute(attr_name, value)
+          AeTestCoverage.coverage_collectors[AttributeWriterCollector].add_covered_models(self.class)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/model_collector.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/active_record/model_file_finder'
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      class ModelCollector
+
+        def initialize
+          set_hook
+        end
+
+        def on_start
+          @covered_model_collection = Set.new
+        end
+
+        def add_covered_models(*models)
+          @covered_model_collection&.merge(models)
+        end
+
+        def covered_files
+          {}.tap do |coverage_data|
+            @covered_model_collection.each do |model|
+              file = ModelFileFinder.new.file_path(model)
+              coverage_data[file] = data
+            end
+          end
+        end
+
+        private
+
+        def set_hook
+          raise 'Not Implemented'
+          ActiveSupport.on_load(:active_record) do
+            raise "helper_module is not defined" unless @@helper_module.present?
+            include @@helper_module
+          end
+        end
+
+        def data
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/active_record/model_file_finder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module ActiveRecord
+      class ModelFileFinder
+        def file_path(model)
+          Rails.application.config.paths['app/models'].each do |model_root|
+            path = Rails.root.join(model_root, "#{model.name.underscore}.rb").to_s
+            return path if File.exist?(path)
+          end
+          Rails::Engine.subclasses.each do |engine|
+            engine.paths['app/models'].each do |model_root|
+              path = engine.root.join(model_root, "#{model.name.underscore}.rb").to_s
+              return path if File.exist?(path)
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/ruby_coverage_collector.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    class RubyCoverageCollector
+      @@initialized = false
+
+      def initialize
+        unless @@initialized
+          require 'coverage'
+          Coverage.start(oneshot_lines: true, methods: true)
+          @@initialized = true
+        end
+      end
+
+      def on_start
+        Coverage.result(clear: true)
+      end
+
+      def covered_files
+        coverage = Coverage.result(clear: true)
+        {}.tap do |coverage_data|
+          coverage.each do |file, data|
+            next if AeTestCoverage.exclude_file?(file)
+
+            called_methods = data[:methods].select { |_, call_count| call_count > 0 }
+            oneshot_lines = reject_oneshot_lines_from_methods(called_methods, data[:oneshot_lines])
+            coverage_data[file] = {methods: called_methods, oneshot_lines: oneshot_lines} unless called_methods.empty? && oneshot_lines.empty?
+          end
+        end
+      end
+
+      private
+
+      def reject_oneshot_lines_from_methods(methods, oneshot_lines)
+        return [] if oneshot_lines.blank?
+
+        ranges_covered_by_called_methods = methods.keys.map { |method_data| method_data[2]..method_data[4] }
+        oneshot_lines.reject { |line| ranges_covered_by_called_methods.any? { |range| range.include?(line) } }
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/sprockets_asset_collector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    class SprocketsAssetCollector
+      def initialize(asset_path)
+        @asset_path = asset_path
+      end
+
+      def collect
+        asset = ::Rails.application.assets[@asset_path]
+        # It's not clear why an asset would not be found in the cache.  It happens but it seems to happen rarely and repeatably
+        # If there is a bug with assets changes not triggering a test to run, look here to see if the asset was not included
+        # as a dependency because it was not found in the cache
+        
+        if asset.nil?
+          puts "Skipping asset #{@asset_path} because it was not found in the cache"
+          []
+        else
+          asset.metadata[:dependencies].select { |d| d.ends_with?('.js', '.es6', '.css', '.scss') }
+        end
+      end
+    end
+  end
+end
+ 

data/lib/ae_test_coverage/collectors/webpacker/helpers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module Collectors
+    module Webpacker
+      module Helpers
+        def javascript_packs_with_chunks_tag(*names, **options)
+          raise(StandardError, 'AeTestCoverage.config.webpacker_app_locations must be set to collect webpacker app coverage') if AeTestCoverage.config.webpacker_app_locations.blank?
+
+          globs = names.flat_map do |name|
+            app_home = javascript_app_home(name)
+            raise(StandardError, "Unable to locate source location for javascript app #{name}") unless Dir.exist?(app_home)
+
+            [
+              File.join(app_home, 'src', '**.{scss,css,js}'),
+              File.join(app_home, 'package*.json')
+            ]
+          end
+          AeTestCoverage.coverage_collectors[WebpackerAppCollector].add_covered_globs(*globs)
+          super
+        end
+
+        def javascript_app_home(name)
+          AeTestCoverage.config.webpacker_app_locations.map do |potential_app_root|
+            File.join(potential_app_root, name)
+          end.detect do |potential_app_home|
+            Dir.exist?(potential_app_home)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/collectors/webpacker/webpacker_app_collector.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'ae_test_coverage/collectors/webpacker/helpers'
+
+module AeTestCoverage
+  module Collectors
+    module Webpacker
+      class WebpackerAppCollector
+        @@hook_set = false
+
+        def initialize
+          unless @@hook_set
+            ActiveSupport.on_load(:action_view) do
+              prepend AeTestCoverage::Collectors::Webpacker::Helpers
+            end
+          end
+          @@hook_set = true
+        end
+
+        def on_start
+          @covered_globs = Set.new
+        end
+
+        def add_covered_globs(*globs)
+          @covered_globs&.merge(globs)
+        end
+
+        def covered_files
+          {}.tap do |coverage_data|
+            @covered_globs.each do |glob_pattern|
+              coverage_data[glob_pattern] = { glob: true }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ae_test_coverage/test_coverage_methods.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  module TestCoverageMethods
+    def start_recording_code_coverage
+      if AeTestCoverage.enabled?
+        AeTestCoverage.coverage_collectors.each do |coverage_collector_class, coverage_collector|
+          coverage_collector.on_start
+        end
+      end
+    end
+
+    def write_code_coverage_artifact
+      if AeTestCoverage.enabled?
+        cleanup_stubs
+        test_filename = method(name_of_test).source_location[0]
+        FileUtils.mkdir_p(coverage_path)
+        f = File.open(coverage_file_name, 'w')
+        cleaned_coverage = {}.tap do |cleaned|
+          AeTestCoverage.coverage_collectors.values.each do |coverage_collector|
+            coverage_collector.covered_files.each do |covered_file, coverage_data|
+              next if AeTestCoverage.exclude_file?(covered_file)
+              cleaned[covered_file] ||= {}
+              cleaned[covered_file][coverage_collector.class.name] = coverage_data
+            end
+          end
+        end
+        coverage_file_data = {
+          filename: test_filename,
+          coverage: cleaned_coverage
+        }
+        f.write(coverage_file_data.to_json)
+        f.close
+      end
+    end
+
+    def name_of_test
+      method_name
+    end
+
+    def coverage_path
+      AeTestCoverage.config.coverage_path
+    end
+
+    def coverage_file_name
+      basename = "#{self.class.name}__#{name_of_test}.json".tr(' /', '__')
+      max_filename_length = 255
+      basename = trim_front(basename, max_filename_length - coverage_path.length)
+      File.join(coverage_path, basename)
+    end
+
+    def trim_front(str, max_length)
+      str.length > max_length ? str[-max_length...] : str
+    end
+
+    def cleanup_stubs
+      File.unstub(:open)
+      File.unstub(:directory?)
+    end
+  end
+end

data/lib/ae_test_coverage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AeTestCoverage
+  VERSION = '1.1.0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ae_test_coverage
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Appfolio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tools for collecting code coverage from tests
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ae_test_coverage.rb
+- lib/ae_test_coverage/collectors/action_view/asset_tag_collector.rb
+- lib/ae_test_coverage/collectors/action_view/asset_tag_helper.rb
+- lib/ae_test_coverage/collectors/action_view/rendered_template_collector.rb
+- lib/ae_test_coverage/collectors/active_record/association_collector.rb
+- lib/ae_test_coverage/collectors/active_record/association_helper.rb
+- lib/ae_test_coverage/collectors/active_record/attribute_reader_collector.rb
+- lib/ae_test_coverage/collectors/active_record/attribute_reader_helper.rb
+- lib/ae_test_coverage/collectors/active_record/attribute_writer_collector.rb
+- lib/ae_test_coverage/collectors/active_record/attribute_writer_helper.rb
+- lib/ae_test_coverage/collectors/active_record/model_collector.rb
+- lib/ae_test_coverage/collectors/active_record/model_file_finder.rb
+- lib/ae_test_coverage/collectors/ruby_coverage_collector.rb
+- lib/ae_test_coverage/collectors/sprockets_asset_collector.rb
+- lib/ae_test_coverage/collectors/webpacker/helpers.rb
+- lib/ae_test_coverage/collectors/webpacker/webpacker_app_collector.rb
+- lib/ae_test_coverage/test_coverage_methods.rb
+- lib/ae_test_coverage/version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Tools for collecting code coverage from tests
+test_files: []