speedyrspec 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea0fb5d298348727492a61c9c521baf64aa37955
+  data.tar.gz: f1cc5b4d5f3e9b294f134177ec9d83b895fecdea
+SHA512:
+  metadata.gz: e7e6829b791caf95e95f63c96966f0678c5e7cc8e267c591bb4b54b5c0816fe35da7db3011b48d6feee1aa9f4fb51e2aad9ecdee79c9b3c80c422a1535724fa1
+  data.tar.gz: c0d7f785ee02bfd3d62865b645a7b1797e3ed5fc0f63b8e5a4a10371e22841f9bdcdbad3418bb5fe7187d97fa00d2a69651cd85f6b306409e512189abb33d1c3

data/README.md

@@ -0,0 +1,83 @@
+# Speedy RSpec
+
+Faster testing by running only the needed tests.
+
+## Description
+
+Speedy RSpec computes which tests are relevant for certain code changes. It
+does this by tracing all calls during a test run and saving for each test all
+the files which are seen. At runtime it uses this file to compute which tests
+offer coverage for a particular file.
+
+## Install
+
+```ruby
+gem 'speedyrspec'
+```
+
+## Configuration
+
+Set path for the trace_file. This is where SpeedyRspec stores its dependency
+graph.
+
+```ruby
+SpeedyRspec.configure do |config|
+  config.trace_file = 'speedy_traces.json'
+end
+```
+
+## Usage
+
+In order to compute the smallest amount of tests needed to be run, the
+following steps should be followed.
+
+1. Compute dependency graph. This stores in the trace_file the dependency list
+   of each file. This process is best repeated weekly.
+
+  ```bash
+  rake speedyrspec:collect
+  ```
+
+2. Run tests for the changed files.
+
+  2.1 Tests for app files.
+
+  ```bash
+  rake speedyrspec:run <app/files>
+  ```
+
+  2.2. Tests from git changes. Load list of changed files and compute which
+  tests to run.
+
+  ```bash
+  rake speedyrspec:run:git
+  ```
+
+## Rake tasks
+
+SppedyRspec exposes the following rake tasks:
+
+```bash
+rake speedyrspec:collect   # run tests and collect trace information.
+rake speedyrspec:run       # run tests that exercise code in files given as parameters.
+rake speedyrspec:run:git   # run tests that exercise code in modiffied git files.
+rake speedyrspec:show      # show which files should be run for given tests.
+rake speedyrspec:show:git  # show which files should be run for modffied git files.
+```
+
+
+## Recommended setup
+
+It is recommended to periodically collect traces. This can be done weekly in a
+test run followed by a commit of the traces file into your repository. This is
+possible with a configuration similar to the following:
+
+```ruby
+SpeedyRspec.configure do |config|
+  config.trace_file = 'speedy_traces.json'
+end
+```
+
+Another option is to write the traces file in S3 bucket set-up for static
+hosting. At trace-collection the AWS access credentials will have to be stored
+in the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

data/lib/speedyrspec.rb

@@ -0,0 +1,4 @@
+require_relative 'speedyrspec/config'
+require_relative 'speedyrspec/rake_tasks'
+require_relative 'speedyrspec/resolver'
+require_relative 'speedyrspec/dependency_manager'

data/lib/speedyrspec/config.rb

@@ -0,0 +1,22 @@
+module SpeedyRspec
+  class << self
+    attr_accessor :trace_file
+    def output=(val)
+      @output = val
+    end
+
+    def output
+      return @output if @output
+      return {type: :file, name: self.trace_file}
+    end
+
+    def configure
+      yield self
+    end
+  end
+end
+
+SpeedyRspec.configure do |config|
+  config.trace_file ||= 'speedy_traces.json'
+  # config.output = {type: :s3, name: 'shore_core_traces.json', bucket: 'speedyrspec'}.merge(config.output || {})
+end

data/lib/speedyrspec/dependency_manager.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'open-uri'
+require_relative 'json_writers'
+
+module SpeedyRspec
+  class DependencyManagerFactory
+    class << self
+      def new_dependencies
+        build_manager(build_traces_writer).tap { |manager| manager.new_dependencies}
+      end
+
+      def load_dependencies
+        build_manager(nil).tap { |manager| manager.load_dependencies}
+      end
+
+      private
+
+      def build_traces_writer
+        case SpeedyRspec.output[:type]
+        when :file
+          JsonFileWriter.new
+        when :s3
+          JsonS3Writer.new
+        else
+          JsonFileWriter.new
+        end
+      end
+
+      def build_manager(file_writer)
+        JsonDependencyManager.new(file_writer)
+      end
+    end
+  end
+
+  class JsonDependencyManager
+    def initialize(data_writer)
+      @writer = data_writer
+    end
+
+    def new_dependencies
+      @data = Hash.new{|h, k| h[k] = Set.new}
+    end
+
+    def load_dependencies
+      open(SpeedyRspec.trace_file) do |f|
+        @data = JSON.parse(f.read)
+      end
+    end
+
+    def add_dependency(from, to)
+      @data[from].add(to)
+    end
+
+    def get_dependencies(from)
+      Array(@data[from]) || []
+    end
+
+    def finish
+      @writer.write(to_json)
+    end
+
+    private
+
+    def to_json
+      JSON.pretty_generate(@data.map{|k,v| [k, Array(v)]}.to_h)
+    end
+  end
+end

data/lib/speedyrspec/json_writers.rb

@@ -0,0 +1,23 @@
+require 'aws-sdk-resources'
+
+class JsonFileWriter
+  def write(json)
+    File.write(SpeedyRspec.output[:name], json)
+  end
+end
+
+class JsonS3Writer
+  def initialize
+    fail 'Please setup AWS login environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY' \
+      unless ENV.key?('AWS_SECRET_ACCESS_KEY') && ENV.key?('AWS_SECRET_ACCESS_KEY')
+
+    @s3 = Aws::S3::Resource.new(region: 'eu-west-1')
+  end
+
+  def write(json)
+    bucket = @s3.bucket(SpeedyRspec.output[:bucket] || 'speedyrspec')
+    object = bucket.object(SpeedyRspec.output[:name] || SpeedyRspec.trace_file)
+    object.put(body: json)
+  end
+end
+

data/lib/speedyrspec/rake_tasks.rb

@@ -0,0 +1,67 @@
+require 'rake/tasklib'
+require 'rspec/core/rake_task'
+
+def git_modified_files
+  status = open('|git status -s').readlines
+  status.map(&:strip).flat_map{|s| s.split.drop(1)}.tap do |files|
+    raise 'No file was modiffied in your git repository.' if files.empty?
+  end
+end
+
+def set_files_to_run(t, files_to_test)
+  t.pattern = 'deliberately-left-blank'
+  t.rspec_opts = SpeedyRspec::Resolver.new.get_tests(files_to_test)
+end
+
+def files_from_args(args)
+  (args[:files] || ARGV.drop(1) || []).tap do |files_to_test|
+    raise 'Please specify which file needs to be tested' if files_to_test.empty?
+  end
+end
+
+def show_files_to_run(files_to_test)
+  files = SpeedyRspec::Resolver.new.get_tests(files_to_test)
+  puts "Files to run: \n\t#{files.join("\n\t")}"
+end
+
+Rake::Task.define_task(:environment) do
+  ENV['RACK_ENV'] = 'test'
+  ENV['RAILS_ENV'] = 'test'
+end
+
+desc 'run tests and collect trace information.'
+RSpec::Core::RakeTask.new('speedyrspec:collect' => :environment) do |t, args|
+  t.rspec_opts ||= []
+  specfiles = ARGV.drop(1)
+
+  if specfiles && !specfiles.empty?
+    t.rspec_opts << specfiles.join(' ')
+    t.pattern = 'deliberately-left-blank'
+  end
+
+  t.rspec_opts << '--require speedyrspec/rspec_config'
+end
+
+desc 'run tests that exercise code in files given as parameters.'
+RSpec::Core::RakeTask.new('speedyrspec:run' => :environment) do |t, args|
+  files_to_test = files_from_args(args)
+  set_files_to_run(t, files_to_test)
+end
+
+desc 'run tests that exercise code in modiffied git files.'
+RSpec::Core::RakeTask.new('speedyrspec:run:git' => :environment) do |t, args|
+  files_to_test = git_modified_files
+  set_files_to_run(t, files_to_test)
+end
+
+desc 'show which files should be run for given tests.'
+task 'speedyrspec:show' => :environment do |t, args|
+  files_to_test = files_from_args(args)
+  show_files_to_run(files_to_test)
+end
+
+desc 'show which files should be run for modffied git files.'
+task 'speedyrspec:show:git' => :environment do |t, args|
+  files_to_test = git_modified_files
+  show_files_to_run(files_to_test)
+end

data/lib/speedyrspec/resolver.rb

@@ -0,0 +1,13 @@
+module SpeedyRspec
+  class Resolver
+    def initialize
+      @dependencies = DependencyManagerFactory.load_dependencies
+    end
+
+    def get_tests(files_to_test)
+      files_to_test.flat_map do |f|
+        @dependencies.get_dependencies(f)
+      end.compact.uniq
+    end
+  end
+end

data/lib/speedyrspec/rspec_config.rb

@@ -0,0 +1,21 @@
+require 'speedyrspec'
+require_relative 'spies'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    SpeedyRspec.spy.start
+  end
+
+  config.after(:suite) do
+    SpeedyRspec.spy.finish
+  end
+
+  config.before(:each) do |example|
+    SpeedyRspec.spy.test_starts(example)
+  end
+
+  config.after(:each) do |example|
+    SpeedyRspec.spy.test_ends(example)
+  end
+end

data/lib/speedyrspec/spies.rb

@@ -0,0 +1,50 @@
+module SpeedyRspec
+  def self.spy
+    @spy ||= TracingSpy.new
+  end
+
+  class TracingSpy
+    def initialize
+      @datamanager = DependencyManagerFactory.new_dependencies
+    end
+
+    def start
+      puts 'Starting test suite with tracing enabled.'
+      @tracer = set_tracer
+    end
+
+    def finish
+      @datamanager.finish
+    end
+
+    def test_starts(example)
+      deduce_workingdir(example) unless @working_dir
+      @current_test = example.file_path
+      @tracer.enable
+    end
+
+    def test_ends(example)
+      @tracer.disable
+    end
+
+    private
+
+      def deduce_workingdir(example)
+        fp = example.metadata[:file_path]
+        path = example.metadata[:absolute_file_path]
+        @working_dir = path[0, path.index(fp[1, fp.length])]
+        @wd_path = Pathname.new(@working_dir)
+      end
+
+      def set_tracer
+        TracePoint.new(*%i[call b_call]) do |tp|
+          unless tp.path.index(@working_dir).nil?
+            tp_path = Pathname.new(tp.path)
+            rel_path = tp_path.relative_path_from(@wd_path).to_s
+            @datamanager.add_dependency(rel_path, @current_test) unless @current_test.index(rel_path)
+          end
+        end
+      end
+  end
+end
+

data/lib/speedyrspec/version.rb

@@ -0,0 +1,3 @@
+module SpeedyRspec
+  VERSION = '0.0.2'
+end

data/spec/models/dependency_manager_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe SpeedyRspec::JsonDependencyManager do
+  describe 'new traces' do
+    let(:manager) { SpeedyRspec::DependencyManagerFactory.new_dependencies }
+
+    it 'has no dependencies' do
+      expect(manager.get_dependencies('foo')).to be_empty
+    end
+
+    it 'can add dependencies' do
+      manager.add_dependency('foo', 'bar')
+      expect(manager.get_dependencies('foo')).to eq(['bar'])
+    end
+  end
+
+  describe 'existing traces' do
+    before do
+      SpeedyRspec.trace_file = 'spec/models/test.json'
+    end
+    let(:manager) { SpeedyRspec::DependencyManagerFactory.load_dependencies }
+
+    it 'has correct dependencies' do
+      expect(manager.get_dependencies('foo')).to eq ['bar']
+      expect(manager.get_dependencies('bar')).to be_empty
+    end
+  end
+end

data/spec/models/resolver_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'pry-byebug'
+
+RSpec.describe SpeedyRspec::Resolver do
+  before do
+    SpeedyRspec.trace_file = 'spec/models/test.json'
+    allow(File).to receive(:absolute_path) { |arg| arg }
+  end
+
+  let(:resolver) { SpeedyRspec::Resolver.new }
+
+  it 'returns tests for file' do
+    expect(resolver.get_tests(['foo'])).to eq(['bar'])
+    expect(resolver.get_tests(['foo', 'baz'])).to eq(['bar'])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'speedyrspec/config'
+require 'speedyrspec/resolver'
+require 'speedyrspec/dependency_manager'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: speedyrspec
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Cristian Eigel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Compute the dependency list in a certain project and use this information
+  for computing the minimum list of tests to run for a change.
+email: eigelc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/speedyrspec.rb
+- lib/speedyrspec/config.rb
+- lib/speedyrspec/dependency_manager.rb
+- lib/speedyrspec/json_writers.rb
+- lib/speedyrspec/rake_tasks.rb
+- lib/speedyrspec/resolver.rb
+- lib/speedyrspec/rspec_config.rb
+- lib/speedyrspec/spies.rb
+- lib/speedyrspec/version.rb
+- spec/models/dependency_manager_spec.rb
+- spec/models/resolver_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ceigel/speedyrspec
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Compute the minimum set of tests exercising certain files
+test_files:
+- spec/models/dependency_manager_spec.rb
+- spec/models/resolver_spec.rb
+- spec/spec_helper.rb
+has_rdoc: