diff_test 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cac8148799f86b799f536964cbaf80ee3b77d99f915f33eb3c4e54c76cafd465
+  data.tar.gz: 52332e3b52034d18dd9572b85e9f2d4cf807000fd2049c27d6177a6f48caf1c5
+SHA512:
+  metadata.gz: c9059223409cd8347bfe233adf8d65d19577d90cefa72e1b1cacd3a660cb33a018d0609d75710154f9addcbb057e207cbbb449b3c8d8cc7f7fd695fd3ae210f1
+  data.tar.gz: 89a3b42a009650ea1a6cd970627c40474b563d8afafa24371103dbfd933287b601359c220afeb6af19a52b2f78e19478290c343bd6c9cb14df115956664b624a

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Owais
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,208 @@
+# DiffTest
+
+## Configuration
+
+### enabled
+```ruby
+  DiffTest.configure do |config|
+    config.enabled = ENV['CI'].present?
+
+    config.project_root = Rails.root
+
+    config.vendor_bundle_path = File.join(Rails.root, 'vendor')
+
+    # Default: All files generated by git
+    config.project_files = [
+      -> { `git -C "#{Rails.root}" ls-files`.split("\n") }
+    ]
+
+    # These paths don't factor into determining if tests should be run at all.
+    # Its as if they aren't even there.
+    config.ignored_paths = [
+      'db/migrate/**/*',
+      '**/*.md',
+      # 'doc/**/*',
+      # 'services/video_encoding/**/*
+      # 'simplero-mobile-app/**/*
+      # **/*.css
+      # **/*.scss
+    ]
+
+    # Add patterns where you ruby/template files live.
+    # If you change any file that does not match these patterns, we will run all the tests.
+    config.tracked_paths = [
+      'app/**/*.rb',
+      'app/**/*.html.erb',
+      'lib/**/*.rb',
+      'lib/**/*.html.erb',
+      'test/**/*.rb',
+    ]
+
+    # For this to work correctly,
+    # You need to ensure that these files are annotated
+    # You can automatically annotate your files with
+    #   rake diff_test:annotate
+    # This also happens automatically when you run RAILS_ENV=test rails assets:precompile
+    config.tracked_js_paths = [
+      'app/javascript/**/*.{js,jsx,ts,tsx,mjs,cjs,coffee}',
+      'app/assets/javascripts/**/*.{js,jsx,ts,tsx,mjs,cjs,coffee}',
+    ]
+
+  end
+```
+
+# TODO
+* Testing strategy
+* Documentation
+--
+* Fixture tracker
+* Factory tracker
+* CSS tracker
+
+- TracePointTracker
+- ConstantTracker (depends_on TracePointTracker)
+- FileTracker
+- FixtureTracker
+- JavascriptTracker
+-
+
+- ImpactedFileTracker
+  - FileTracker
+  - ConstantTracker
+  - TracePointTracker
+
+
+
+
+
+
+
+Number of commits (out of last 2000) with any changes NOT matching allowed patterns:
+base_only                                          => 592
+with_factories_fixtures                            => 583
+with_js_ts                                         => 422
+with_js_ts_css                                     => 325
+with_js_css_db_except_schema                       => 298
+with_factories_fixtures_js_css                     => 316
+with_factories_fixtures_js_css_db_except_schema    => 288
+with_factories_fixtures_except_schema              => 558
+with_factories_fixtures_css_except_schema          => 487
+with_css                                           => 521
+with_css_except_schema                             => 497
+ruby cookbooks/track_non_matching.rb 1000  23.75s user 8.41s system 95% cpu 33.642 total
+
+
+
+
+
+
+######
+
+* Write tests on diff_test_web
+  * These are all system tests.
+  * Creates test suite executions
+  * Creates test executions
+  * Runs tests when impacted files change
+  * Runs tests when project files change
+  * Runs system test when js version change (in unrelated file) but no previous js run
+  * Skips system test when no js version change
+  * Runs system test when related js file changes
+  * Skip system test when related js file changes after a succesful run
+
+* ImpactedFileTracker
+  - Ruby
+  - HTML
+  - Javascript
+
+
+### Test TODO
+
+Test rails app
+[ ] UserTest model
+    - class access
+[ ] AccountTest model
+    - calls searchable
+    - uses fixtures for users and accounts
+[ ] Controller/Integration test
+[ ] System test
+    - AccountController#index - views, controller, js, css, fixtures
+    - AccountController#partial
+    - AccountController#stream
+    - AccountController#components
+    - AccountController#layouts
+    - AccountController#helpers
+[ ] Mailer test
+[ ] Job test
+
+
+# Tasks
+X Allow login
+X Allow signup
+   xpassword confirmation controller
+X Allow account creation
+   xhandle check controller
+   xinherit from controller
+X Account#show
+   xMake account#show view render a user_card partial
+X Allow customer creation (assoc to user & account)
+x Write model unit tests for User
+x Write model unit tests for Account
+x View component with html
+x View component with call
+x Write integration tests for AccountController around the handle_connect helper
+x Make a mailer that sends a email about the details of a newly created account
+x Make a job that runs every hour deleting accounts with invalid users
+x View comopnent test
+x Write system test for signup
+  password mismatch test
+x Write system test for login
+x Write system test for account creation
+  - handle check
+  - currency (USD)
+  - user
+x Write system test for customer creation
+  -
+
+
+
+DiffTestWeb
+[ ] Test each test written above
+    assert impacted file.
+    run it again
+    assert skipped
+    change some unrelated files
+    run it again
+    change some related files
+    assert not skipped
+
+[ ] Test various configurations
+    Changing JS version hash
+    Changing project version hash
+    All JS files annotated tracking
+
+
+
+
+# Works locally
+# Won't auto-annotate files locally
+# Annotate files in CI through precompile or db:prepare
+
+
+### LAter
+# config.enabled = Rails.env.test?
+# config.enabled = Rails.env.test? && ENV['CI'].present?
+
+
+# Annotates JS files so they are be able to tracked as well.
+# By default, we only do this in CI env.
+# As an alternative, you can run `bundle exec rake diff_test:annotate` manually.
+# To unannotate, simply run `bundle exec rake diff_test:unannoate`
+# config.auto_annotate_js_files = :ci
+
+
+
+# TODO
+- Initialier/install script
+- Set unskippable
+- Skip from branch/commit/author name
+- Unskippable branches

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/diff_test/api_client.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+
+module DiffTest
+  class ApiClient
+    include HTTParty
+
+    def self.get(path, options = {}, &block)
+      set_api_key_in_headers(options)
+      super
+    end
+
+    def self.post(path, options = {}, &block)
+      set_api_key_in_headers(options)
+      super
+    end
+
+    def self.put(path, options = {}, &block)
+      set_api_key_in_headers(options)
+      super
+    end
+
+    def self.patch(path, options = {}, &block)
+      set_api_key_in_headers(options)
+      super
+    end
+
+    def self.delete(path, options = {}, &block)
+      set_api_key_in_headers(options)
+      super
+    end
+
+    def self.set_api_key_in_headers(options)
+      base_uri "http://localhost:#{DiffTest.configuration.port}"
+      options[:headers] ||= {}
+      options[:headers]['X-Diff-Test-Api-Key'] = DiffTest.configuration.api_key
+    end
+  end
+end

data/lib/diff_test/configuration.rb

@@ -0,0 +1,178 @@
+module DiffTest
+  class Configuration
+    attr_writer \
+      :api_key,
+      :port,
+      :project_root,
+      :vendor_bundle_path,
+      :project_files,
+      :ignored_files,
+      :tracked_files,
+      :tracked_js_files
+
+    def api_key
+      @api_key || ENV['DIFF_TEST_API_KEY']
+    end
+
+    def port
+      @port || 8085
+    end
+
+    def project_root
+      return @project_root if @project_root
+
+      @project_root = ::Rails.root.to_s if defined?(::Rails)
+
+      unless @project_root
+        raise "Please specify a project root in config/environments/test.rb using
+          DiffTest.configure do |config|
+            config.project_root = '/path/to/your/project'
+          end
+        "
+      end
+
+      @project_root
+    end
+
+    def vendor_bundle_path
+      return @vendor_bundle_path if @vendor_bundle_path
+
+      @vendor_bundle_path = File.join(project_root, 'vendor', 'bundle').to_s if defined?(::Rails)
+    end
+
+    def project_files
+      @expanded_project_files ||=
+        begin
+          @project_files ||= [-> { `git -C "#{project_root}" ls-files`.split("\n") }]
+
+          expand_files(@project_files)
+        end
+    end
+
+    def ignored_files
+      @expanded_ignored_files ||=
+        begin
+          @ignored_files ||= ['db/migrate/**/*', '**/*.md']
+          filter_from_project_files(@ignored_files)
+        end
+    end
+
+    def tracked_files
+      @expanded_tracked_files ||=
+        begin
+          @tracked_files ||= [
+            'app/**/*.rb',
+            'app/**/*.html.erb',
+            'lib/**/*.rb',
+            'lib/**/*.html.erb',
+            'test/**/*.rb',
+            '!test/fixtures/**/*',
+            '!test/factories/**/*',
+            '!test/factories.rb',
+          ]
+          filter_from_project_files(@tracked_files)
+        end
+    end
+
+    def tracked_js_files
+      @expanded_js_files ||=
+        begin
+          @tracked_js_files ||= [
+            'app/components/**/*.{js,jsx,ts,tsx,mjs,cjs,coffee}',
+            'app/javascript/**/*.{js,jsx,ts,tsx,mjs,cjs,coffee}',
+            'app/assets/javascripts/**/*.{js,jsx,ts,tsx,mjs,cjs,coffee}'
+          ]
+          filter_from_project_files(@tracked_js_files)
+        end
+    end
+
+    def system_test_paths
+      @expanded_system_test_paths ||=
+        begin
+          @system_test_paths ||= [
+            'test/system/**/*.rb',
+            'test/system/**/*.html.erb'
+          ]
+          filter_from_project_files(@system_test_paths)
+        end
+    end
+
+    def ci_platform
+      if ENV['CIRCLECI']
+        'circleci'
+      elsif ENV['GITHUB_ACTIONS']
+        'github-actions'
+      elsif ENV['TRAVIS']
+        'travis'
+      elsif ENV['BUILDKITE']
+        'buildkite'
+      elsif ENV['JENKINS_URL']
+        'jenkins'
+      end
+    end
+
+    def auto_annotate_js_files?
+      case auto_annotate_js_files
+      when :ci
+        !!ci_platform
+      else
+        auto_annotate_js_files
+      end
+    end
+
+    def auto_annotate_js_files
+      return :ci if @auto_annotate_js_files.nil?
+      @auto_annotate_js_files
+    end
+
+    def auto_annotate_js_files=(value)
+      @auto_annotate_js_files = value.nil? ? !!value : value
+    end
+
+    private
+
+    def file_matches_pattern?(file_path, pattern)
+      File.fnmatch?(pattern, file_path, File::Constants::FNM_PATHNAME | File::Constants::FNM_EXTGLOB)
+    end
+
+    def file_matches_any_patterns?(file_path, patterns)
+      patterns.any? { |pattern| file_matches_pattern?(file_path, pattern) }
+    end
+
+    def file_matches_any_negative_patterns?(file_path, negative_patterns)
+      negative_patterns.any? { |pattern| file_matches_pattern?(file_path, pattern[1..-1]) }
+    end
+
+    def filter_from_project_files(patterns)
+      negative_patterns, positive_patterns = patterns.partition { |pattern| pattern.start_with?('!') }
+
+      project_files.select do |file_path|
+        file_matches_any_patterns?(file_path, positive_patterns) &&
+          !file_matches_any_negative_patterns?(file_path, negative_patterns)
+      end.to_set
+    end
+
+    def expand_files(files)
+      files = files.flat_map do |file|
+        if file.is_a?(Proc)
+          file.call
+        elsif file.is_a?(String) && file.start_with?('!')
+          file
+        else
+          Dir.glob(file, base: project_root)
+        end
+      end
+
+      negative_patterns, files = files.partition { |file| file.is_a?(String) && file.start_with?('!') }
+
+      files = files.reject do |file|
+        file_matches_any_negative_patterns?(file, negative_patterns)
+      end unless negative_patterns.empty?
+
+      files.select do |file_path|
+        File.file?(DiffTest::Helper.expand_path(file_path))
+      end.to_set
+    end
+
+  end
+end

data/lib/diff_test/file_hash_computer.rb

@@ -0,0 +1,21 @@
+require 'xxhash'
+
+module DiffTest
+  class FileHashComputer
+    # Save hashesh in a global cache. If available use it, otherwise compute it.
+    #
+    def self.compute(file_path)
+      return @cache[file_path] if @cache&.key?(file_path)
+
+      content = File.read(file_path)
+      content = DiffTest::Integrations::RailsJs::Annotator.unannotate(content)
+
+      @cache ||= {}
+      @cache[file_path] = XXhash.xxh64(content).to_s
+    end
+
+    def self.compute_relative(file_path)
+      self.compute(DiffTest::Helper.absolute_path_from_project_root(file_path))
+    end
+  end
+end

data/lib/diff_test/helper.rb

@@ -0,0 +1,37 @@
+module DiffTest
+  module Helper
+    module_function
+
+    def test_id(test_file_path, test_name)
+      [test_file_path, test_name].join(':')
+    end
+
+    def relative_path_from_project_root(file_path)
+      raise 'Expected file_path to be an absolute path' unless file_path.start_with?('/')
+
+      Pathname.new(file_path).relative_path_from(DiffTest.configuration.project_root).to_s
+    end
+
+    def relative_const_source_path_from_project_root(const_name)
+      relative_path_from_project_root(const_source_path(const_name))
+    end
+
+    def const_source_path(const_name)
+      Module.const_source_location(const_name).first
+    end
+
+    def absolute_path_from_project_root(file_path)
+      File.join(DiffTest.configuration.project_root, file_path)
+    end
+
+    def file_in_project?(file_path)
+      file_path &&
+        file_path.start_with?(DiffTest.configuration.project_root) &&
+        !file_path.start_with?(DiffTest.configuration.vendor_bundle_path)
+    end
+
+    def expand_path(file_path)
+      File.expand_path(file_path, DiffTest.configuration.project_root)
+    end
+  end
+end

data/lib/diff_test/impacted_file_tracker.rb

@@ -0,0 +1,34 @@
+require_relative 'file_hash_computer'
+require_relative 'trackers/ruby_file'
+require_relative 'trackers/js_file'
+
+module DiffTest
+  class ImpactedFileTracker
+    attr_reader :trackers
+
+    def initialize
+      @trackers = [
+        DiffTest::Trackers::RubyFile.new,
+        DiffTest::Trackers::JsFile.new
+      ]
+    end
+
+    def save_payload
+      impacted_files.each_with_object({}) do |file_path, payload|
+        payload[file_path] = FileHashComputer.compute(file_path)
+      end
+    end
+
+    def impacted_files
+      trackers.map(&:impacted_files).reduce(Set.new, :|)
+    end
+
+    def start
+      trackers.each(&:enable)
+    end
+
+    def stop
+      trackers.each(&:disable)
+    end
+  end
+end

data/lib/diff_test/integrations/integration.rb

@@ -0,0 +1,29 @@
+module DiffTest
+  module Integrations
+    class Integration
+      def supported?
+        Gem.loaded_specs[gem_name]&.version > minimum_compatible_version
+      end
+
+      def gem_name
+        raise NotImplementedError
+      end
+
+      def loaded?
+        raise NotImplementedError
+      end
+
+      def integrate
+        raise NotImplementedError
+      end
+
+      def integrate_if_ready
+        integrate if supported? && loaded?
+      end
+
+      def self.instance
+        @instance ||= new
+      end
+    end
+  end
+end

data/lib/diff_test/integrations/minitest/integration.rb

@@ -0,0 +1,26 @@
+require_relative '../integration'
+require_relative 'lifecycle'
+
+module DiffTest
+  module Integrations
+    module Minitest
+      class Integration < DiffTest::Integrations::Integration
+        def gem_name
+          'minitest'
+        end
+
+        def minimum_compatible_version
+          '5.0.0'
+        end
+
+        def loaded?
+          supported? && defined?(::Minitest) && defined?(::Minitest::Test)
+        end
+
+        def integrate
+          ::Minitest::Test.include(DiffTest::Integrations::Minitest::Lifecycle)
+        end
+      end
+    end
+  end
+end

data/lib/diff_test/integrations/minitest/lifecycle.rb

@@ -0,0 +1,77 @@
+module DiffTest
+  module Integrations
+    module Minitest
+      module Lifecycle
+        def self.included(base)
+          base.prepend(InstanceMethods)
+        end
+
+        module InstanceMethods
+          def before_setup
+            super
+
+            unless DiffTest::TestSuiteExecution.current
+              tests = ::Minitest::Test.runnables.flat_map do |runnable|
+                next if runnable.runnable_methods.empty?
+
+                test_file_path = Helper.relative_const_source_path_from_project_root(runnable.name)
+
+                runnable.runnable_methods.map do |test_name|
+                  DiffTest::Helper.test_id(test_file_path, test_name)
+                end
+              end.compact
+
+              test_suite_execution = DiffTest::TestSuiteExecution.find_or_create(tests)
+
+              at_exit do
+                DiffTest::TestSuiteExecution.current.save
+              end
+            end
+
+            raise "Expected DiffTest::TestExecution to be nil. Please report this issue." if DiffTest::TestExecution.current
+
+            test_file_path = Helper.relative_const_source_path_from_project_root(self.class.name)
+            test_name = self.name
+
+            DiffTest::TestExecution.current = execution =  DiffTest::TestExecution.new(test_file_path:, test_name:)
+
+            if execution.should_run?
+              DiffTest::TestSuiteExecution.current.ensure_application_eager_loaded!
+            else
+              if defined?(ActiveSupport::TestCase) && respond_to?(:run_callbacks)
+                # ActionMailer::TestCase has setup/teardown hook
+                # Since we call skip here, the setup hook won't be called.
+                # This is cause the ActiveSupport::Testcase's before_setup is higher up in the call chain and is invoked first
+                # But if calls super before run_callbacks. which leads to this method being called.
+                # But then since we skip here, we never reach the run_callbacks call because skip raises an exception.
+                run_callbacks(:setup)
+              end
+              skip("Impacted files have not changed. Skipping...")
+            end
+          ensure
+            execution.start
+          end
+
+          def after_teardown
+            execution = DiffTest::TestExecution.current
+
+            if execution.should_run?
+              if skipped?
+                execution.skipped!
+              elsif passed?
+                execution.passed!
+              else
+                execution.failed!
+              end
+            else
+              execution.not_run!
+            end
+            execution.stop
+            DiffTest::TestExecution.current = nil
+            super
+          end
+        end
+      end
+    end
+  end
+end