crystalball 0.5.0 → 0.6.0

data/docs/runner.md

@@ -0,0 +1,24 @@
+## RSpec Runner
+
+Crystalball has a custom RSpec runner you can use in your development with `bundle exec crystalball` command. It builds a prediction and runs it.
+
+### Runner Configuration
+
+#### Config file
+
+Create a YAML file for the runner. Default locations are `./crystalball.yml` and `./config/crystalball.yml`.
+Please check an [example of a config file](https://github.com/toptal/crystalball/blob/master/spec/fixtures/crystalball.yml) and [configuration defaults](https://github.com/toptal/crystalball/blob/master/lib/crystalball/rspec/runner/configuration.rb#L10) for available options.
+Please keep in mind that additional generator\prediction strategies can introduce additional configuration options.
+
+#### Overriding config file
+
+If you want to override the path to config file please set `CRYSTALBALL_CONFIG=path/to/crystalball.yml` env variable.
+
+Any specific configuration option in `crystalball.yml` can be overridden by providing ENV variable with "CRYSTALBALL_" prefix. 
+E.g. `CRYSTALBALL_EXAMPLES_LIMIT=10` will set `examples_limit` value to 10 regardless of what you have in config file.
+
+More examples:
+
+* `CRYSTALBALL_EXAMPLES_LIMIT=0` sets no limit on prediction size
+* `CRYSTALBALL_MAP_EXPIRATION_PERIOD=0` sets no expiration period for maps
+* `CRYSTALBALL_DIFF_FROM=origin/master` changes diff building to be `git diff origin/master`

data/lib/crystalball.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+require 'crystalball/logging'
 require 'crystalball/git_repo'
+require 'crystalball/extensions/git'
 require 'crystalball/rspec/prediction_builder'
 require 'crystalball/rspec/runner'
 require 'crystalball/prediction'
 require 'crystalball/predictor'
 require 'crystalball/predictor/modified_execution_paths'
 require 'crystalball/predictor/modified_specs'
+require 'crystalball/predictor/modified_support_specs'
 require 'crystalball/predictor/associated_specs'
-require 'crystalball/case_map'
+require 'crystalball/example_group_map'
 require 'crystalball/execution_map'
 require 'crystalball/map_generator'
 require 'crystalball/map_generator/configuration'
@@ -23,7 +26,7 @@ module Crystalball
   # Prints the list of specs which might fail
   #
   # @param [String] workdir - path to the root directory of repository (usually contains .git folder inside). Default: current directory
-  # @param [String] map_path - path to the execution map. Default: execution_map.yml
+  # @param [String] map_path - path to the execution map. Default: crystalball_data.yml
   # @param [Proc] block - used to configure predictors
   #
   # @example
@@ -31,8 +34,10 @@ module Crystalball
   #     predictor.use Crystalball::Predictor::ModifiedExecutionPaths.new
   #     predictor.use Crystalball::Predictor::ModifiedSpecs.new
   #   end
-  def self.foresee(workdir: '.', map_path: 'execution_map.yml', &block)
+  def self.foresee(workdir: '.', map_path: 'crystalball_data.yml', &block)
     map = MapStorage::YAMLStorage.load(Pathname(map_path))
     Predictor.new(map, GitRepo.open(Pathname(workdir)), from: map.commit, &block).prediction.compact
   end
+
+  extend Logging
 end

data/lib/crystalball/active_record.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'crystalball/rails/tables_map_generator'
+require 'crystalball/rails/predictor/modified_schema'

data/lib/crystalball/example_group_map.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Crystalball
+  # Data object to store execution map for specific example
+  class ExampleGroupMap
+    attr_reader :uid, :file_path, :used_files
+    extend Forwardable
+
+    delegate %i[push each] => :used_files
+
+    # @param [Example|ExampleGroup] example - RSpec example or example group
+    # @param [Array<String>] used_files - list of files affected by example
+    def initialize(example, used_files = [])
+      @uid = example.id
+      @file_path = example.file_path
+      @used_files = used_files
+    end
+  end
+end

data/lib/crystalball/execution_map.rb

@@ -7,49 +7,50 @@ module Crystalball
 
     # Simple data object for map metadata information
     class Metadata
-      attr_accessor :commit, :type, :version
+      attr_reader :commit, :type, :version, :timestamp
 
       # @param [String] commit - SHA of commit
       # @param [String] type - type of execution map
       # @param [Numeric] version - map generator version number
-      def initialize(commit: nil, type: nil, version: nil)
+      def initialize(commit: nil, type: nil, version: nil, timestamp: nil)
         @commit = commit
         @type = type
+        @timestamp = timestamp
         @version = version
       end
 
       def to_h
-        {type: type, commit: commit, version: version}
+        {type: type, commit: commit, timestamp: timestamp, version: version}
       end
     end
 
-    attr_reader :cases, :metadata
+    attr_reader :example_groups, :metadata
 
-    delegate %i[commit commit= version version=] => :metadata
-    delegate %i[size] => :cases
+    delegate %i[commit version timestamp] => :metadata
+    delegate %i[size] => :example_groups
 
     # @param [Hash] metadata - add or override metadata of execution map
-    # @param [Hash] cases - initial list of cases
-    def initialize(metadata: {}, cases: {})
-      @cases = cases
+    # @param [Hash] example_groups - initial list of example groups data
+    def initialize(metadata: {}, example_groups: {})
+      @example_groups = example_groups
 
       @metadata = Metadata.new(type: self.class.name, **metadata)
     end
 
-    # Adds case map to the list
+    # Adds example group map to the list
     #
-    # @param [Crystalball::CaseMap] case_map
-    def <<(case_map)
-      cases[case_map.uid] = case_map.affected_files.uniq
+    # @param [Crystalball::ExampleGroupMap] example_group_map
+    def <<(example_group_map)
+      example_groups[example_group_map.uid] = example_group_map.used_files.uniq
     end
 
-    # Remove all cases
+    # Remove all example_groups
     def clear!
-      self.cases = {}
+      self.example_groups = {}
     end
 
     private
 
-    attr_writer :cases, :metadata
+    attr_writer :example_groups, :metadata
   end
 end

data/lib/crystalball/extensions/git.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'crystalball/extensions/git/base'
+require 'crystalball/extensions/git/lib'

data/lib/crystalball/extensions/git/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Git
+  # Represents git repo object itself.
+  class Base
+    # `git merge-base ...`. Returns common ancestor for all passed commits
+    #
+    # @param [Array<Object>] args - list of commits to process. Last argument can be options for merge-base command
+    # @return [Git::Object::Commit]
+    def merge_base(*args)
+      gcommit(lib.merge_base(*args))
+    end
+  end
+end

data/lib/crystalball/extensions/git/lib.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Git
+  # Class wich holds whole collection of raw methods to work with git
+  class Lib
+    # `git merge-base ...`. Returns common ancestor for all passed commits
+    #
+    # @param [Array<Object>] args - list of commits to process. Last argument can be options for merge-base command
+    # @return [String]
+    def merge_base(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+
+      arg_opts = opts.map { |k, v| "--#{k}" if v }.compact + args
+
+      command('merge-base', arg_opts)
+    end
+  end
+end

data/lib/crystalball/factory_bot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'crystalball/map_generator/factory_bot_strategy'

data/lib/crystalball/git_repo.rb

@@ -26,18 +26,13 @@ module Crystalball
       @repo_path = repo_path
     end
 
-    # Check if repository has no uncommitted changes
-    def pristine?
-      diff.empty?
-    end
-
     # Proxy all unknown calls to `Git` object
     def method_missing(method, *args, &block)
-      repo.public_send(method, *args, &block) || super
+      repo.public_send(method, *args, &block)
     end
 
     def respond_to_missing?(method, *)
-      repo.respond_to?(method, false) || super
+      repo.respond_to?(method, false)
     end
 
     # Creates diff

data/lib/crystalball/logging.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Crystalball
+  # This module logs information to the standard output based on the configured log level,
+  # and also logs unfiltered information to the configured log file.
+  module Logging
+    def log(severity_sym, *args, &block)
+      output_stream.log(severity(severity_sym), *args, &block)
+      log_file_output_stream.log(severity(severity_sym), *args, &block)
+    end
+
+    def self.extended(base)
+      base.private_class_method :severity, :output_stream, :log_file_output_stream, :configured_level, :config
+    end
+
+    # @api private
+    def reset_logger
+      @output_stream = nil
+      @log_file_output_stream = nil
+    end
+
+    def severity(severity_sym)
+      ::Logger.const_get(severity_sym.to_s.upcase)
+    end
+
+    def output_stream
+      @output_stream ||= ::Logger.new(STDOUT).tap do |logger|
+        logger.level = severity(configured_level)
+      end
+    end
+
+    def log_file_output_stream
+      @log_file_output_stream ||= begin
+        config['log_file'].dirname.mkpath
+        ::Logger.new(config['log_file']).tap do |logger|
+          logger.level = ::Logger::DEBUG
+        end
+      end
+    end
+
+    def configured_level
+      config['log_level'].to_sym
+    end
+
+    def config
+      @config ||= Crystalball::RSpec::Runner.config
+    end
+  end
+end

data/lib/crystalball/map_generator.rb

@@ -27,14 +27,12 @@ module Crystalball
 
     def initialize
       @configuration = Configuration.new
-      @configuration.commit = repo.object('HEAD').sha if repo
+      @configuration.commit = repo.gcommit('HEAD') if repo
       yield @configuration if block_given?
     end
 
     # Registers strategies and prepares metadata for execution map
     def start!
-      raise 'Repository is not pristine! Please stash all your changes' if repo && !repo.pristine?
-
       self.map = nil
       map_storage.clear!
       map_storage.dump(map.metadata.to_h)
@@ -45,7 +43,7 @@ module Crystalball
 
     # Runs example and collects execution map for it
     def refresh_for_case(example)
-      map << strategies.run(CaseMap.new(example), example) { example.run }
+      map << strategies.run(ExampleGroupMap.new(example), example) { example.run }
       check_dump_threshold
     end
 
@@ -54,11 +52,11 @@ module Crystalball
       return unless started
 
       strategies.each(&:before_finalize)
-      map_storage.dump(map.cases) if map.size.positive?
+      map_storage.dump(map.example_groups) if map.size.positive?
     end
 
     def map
-      @map ||= map_class.new(metadata: {commit: configuration.commit, version: configuration.version})
+      @map ||= map_class.new(metadata: {commit: configuration.commit&.sha, timestamp: configuration.commit&.date&.to_i, version: configuration.version})
     end
 
     private
@@ -74,7 +72,7 @@ module Crystalball
     def check_dump_threshold
       return unless dump_threshold.positive? && map.size >= dump_threshold
 
-      map_storage.dump(map.cases)
+      map_storage.dump(map.example_groups)
       map.clear!
     end
   end

data/lib/crystalball/map_generator/allocated_objects_strategy.rb

@@ -30,14 +30,15 @@ module Crystalball
         @execution_detector = execution_detector
       end
 
-      # Adds to the affected files every file which contain the definition of the
+      # Adds to the used files every file which contain the definition of the
       # classes of the objects allocated during the spec execution.
-      # @param [Crystalball::CaseMap] case_map - object holding example metadata and affected files
-      def call(case_map, example)
+      # @param [Crystalball::ExampleGroupMap] example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] example - a RSpec example
+      def call(example_map, example)
         classes = object_tracker.used_classes_during do
-          yield case_map, example
+          yield example_map, example
         end
-        case_map.push(*execution_detector.detect(classes))
+        example_map.push(*execution_detector.detect(classes))
       end
     end
   end

data/lib/crystalball/map_generator/allocated_objects_strategy/object_tracker.rb

@@ -35,6 +35,7 @@ module Crystalball
           @trace_point ||= TracePoint.new(:c_call) do |tp|
             next unless tp.method_id == :new || tp.method_id == :allocate
             next unless whitelisted_constants.any? { |c| tp.self <= c }
+
             created_object_classes << tp.self
           end
         end

data/lib/crystalball/map_generator/base_strategy.rb

@@ -10,10 +10,11 @@ module Crystalball
 
       def before_finalize; end
 
-      # Each strategy must implement #call augmenting the affected_files list and
-      # yielding back the CaseMap.
-      # @param [Crystalball::CaseMap] _case_map - object holding example metadata and affected files
-      def call(_case_map, _example)
+      # Each strategy must implement #call augmenting the used_files list and
+      # yielding back the ExampleGroupMap.
+      # @param [Crystalball::ExampleGroupMap] _example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] _example - a RSpec example
+      def call(_example_map, _example)
         raise NotImplementedError
       end
     end

data/lib/crystalball/map_generator/configuration.rb

@@ -23,7 +23,7 @@ module Crystalball
       end
 
       def map_storage_path
-        @map_storage_path ||= Pathname('execution_map.yml')
+        @map_storage_path ||= Pathname('tmp/crystalball_data.yml')
       end
 
       def map_storage_path=(value)

data/lib/crystalball/map_generator/coverage_strategy.rb

@@ -20,14 +20,15 @@ module Crystalball
         Coverage.start
       end
 
-      # Adds to the case_map's affected files the ones the ones in which
+      # Adds to the example_map's used files the ones the ones in which
       # the coverage has changed after the tests runs.
-      # @param [Crystalball::CaseMap] case_map - object holding example metadata and affected files
-      def call(case_map, _)
+      # @param [Crystalball::ExampleGroupMap] example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] example - a RSpec example
+      def call(example_map, example)
         before = Coverage.peek_result
-        yield case_map
+        yield example_map, example
         after = Coverage.peek_result
-        case_map.push(*execution_detector.detect(before, after))
+        example_map.push(*execution_detector.detect(before, after))
       end
     end
   end

data/lib/crystalball/map_generator/described_class_strategy.rb

@@ -21,14 +21,14 @@ module Crystalball
         @execution_detector = execution_detector
       end
 
-      # @param [Crystalball::CaseMap] case_map - object holding example metadata and affected files
-      # @param [RSpec::Core::Example] example
-      def call(case_map, example)
-        yield case_map
+      # @param [Crystalball::ExampleGroupMap] example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] example - a RSpec example
+      def call(example_map, example)
+        yield example_map, example
 
         described_class = example.metadata[:described_class]
 
-        case_map.push(*execution_detector.detect([described_class])) if described_class
+        example_map.push(*execution_detector.detect([described_class])) if described_class
       end
     end
   end

data/lib/crystalball/map_generator/factory_bot_strategy.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'crystalball/map_generator/factory_bot_strategy/factory_gem_loader'
+
+Crystalball::MapGenerator::FactoryBotStrategy::FactoryGemLoader.require!
+
+require 'crystalball/map_generator/base_strategy'
+require 'crystalball/map_generator/helpers/path_filter'
+require 'crystalball/map_generator/factory_bot_strategy/dsl_patch'
+require 'crystalball/map_generator/factory_bot_strategy/factory_runner_patch'
+
+module Crystalball
+  class MapGenerator
+    # Map generator strategy to include list of strategies which was used in an example.
+    class FactoryBotStrategy
+      include ::Crystalball::MapGenerator::BaseStrategy
+      include ::Crystalball::MapGenerator::Helpers::PathFilter
+
+      class << self
+        def factory_bot_constant
+          defined?(::FactoryBot) ? ::FactoryBot : ::FactoryGirl
+        end
+
+        # List of factories used by current example
+        #
+        # @return [Array<String>]
+        def used_factories
+          @used_factories ||= []
+        end
+
+        # Map of factories to files
+        #
+        # @return [Hash<String, String>]
+        def factory_definitions
+          @factory_definitions ||= {}
+        end
+
+        # Reset cached list of factories
+        def reset_used_factories
+          @used_factories = []
+        end
+      end
+
+      def after_register
+        DSLPatch.apply!
+        FactoryRunnerPatch.apply!
+      end
+
+      # Adds factories related to the spec to the map
+      # @param [Crystalball::ExampleGroupMap] example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] example - a RSpec example
+      def call(example_map, example)
+        self.class.reset_used_factories
+        yield example_map, example
+        example_map.push(*filter(self.class.used_factories.flat_map { |f| self.class.factory_definitions[f] }))
+      end
+    end
+  end
+end