ttnt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c69fb42081da978ceceab090449ce8267f72783e
+  data.tar.gz: eadd988f0e19af23b3b93323741fac8305f045f2
+SHA512:
+  metadata.gz: 8e5c3b484d7f8f337e8354e80841851c3cbb494dc24b5dc24d0cd0efa84054eea3e6490e11a895ade25a14de54ea0f428572a705d8513857d8ce5da5fd2869f1
+  data.tar.gz: 5dc1013d1aa5fb54b09a28b786a9ba6deabdad2b16418034988c04db79bf0372982a8e0343211831bce3039abcbbeb0fc0f4e4bccec6116661c226c0acecd693

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ttnt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Genki Sugimoto
+
+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,112 @@
+# TTNT: Test This, Not That!
+
+Developing under [Google Summer of Code 2015](http://www.google-melange.com/gsoc/homepage/google/gsoc2015) with mentoring organization [Ruby on Rails](http://rubyonrails.org/).
+
+Full proposal of this project is [here](https://github.com/Genki-S/gsoc2015/blob/master/proposal.md) (might be obsolete in some ways, read this README about this project itself rather than the proposal).
+
+## Goal of this project
+
+[rails/rails](https://github.com/rails/rails) has a problem that CI builds take hours to finish. This project aims to solve that problem by making it possible to run only tests related to changes introduced in target commits/branches/PRs.
+
+### Approach
+
+The idea is based on [Aaron Patterson](https://twitter.com/tenderlove)'s article ["Predicting Test Failures"](http://tenderlovemaking.com/2015/02/13/predicting-test-failues.html). This program uses differences in code between base commit (say, the latest commit of master branch) and target commit (say, HEAD of your feature branch) to calculate which test cases are affected by that change.
+
+## Terminology
+
+- test-to-code mapping
+    - mapping which maps test (file name) to code (file name and line number) executed on that test run for a given commit
+    - this will be used to determine tests that are affected by changes in code
+- base commit
+    - the commit to which the tests you should run will be calculated (e.g. the latest commit of master branch)
+    - this commit should have test-to-code mapping
+- target commit
+    - the commit on which you want to select tests you should run (e.g. HEAD of your feature branch)
+    - this commit does not have to have test-to-code mapping
+
+## Current Status
+
+This project is still in an early stage and we are experimenting the best approach to solve the problem.
+
+Currently, this program does:
+
+- Generate test-to-code mapping for a given commit
+- Given base commit and target commit, output test files you should run
+
+Limitations:
+
+- Test selection algorithm is not perfect yet (it may produce false-positives and false-negatives)
+- Only supports git
+- Only supports MiniTest
+- Only select test files, not fine-grained test cases
+- And a lot more!
+
+## Roadmap
+
+Roadmap is under construction.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ttnt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ttnt
+
+## Requirements
+
+Developed and only tested under ruby version 2.2.1.
+
+## Usage
+
+### Produce test-to-code mapping for a given commit
+
+This pre-computation is required to select tests later.
+
+Basically, you can substitute `ruby` command with `ttnt-anchor` command.
+For example, if you want to produce test-to-code mapping for `test/mail_layout_test.rb` in `ActionMailer` of rails/rails:
+
+```
+$ cd /your/local/rails/rails
+$ git checkout BASE_COMMIT
+$ cd actionmailer
+$ ttnt-anchor -w -Itest test/mail_layout_test.rb -n test_explicit_class_layout
+```
+
+(this example is taken from ["Contributing to Ruby on Rails — Ruby on Rails Guides"](http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#running-tests)).
+
+This will produce test-to-code mapping for the test file `test/mail_layout_test.rb` under `.ttnt/BASE_COMMIT_SHA/test_to_code_mapping/TEST_FILE_NAME.json` which resides in your project base directory (the same repository in which `.git` directory resides).
+
+### Select tests
+
+```
+$ git checkout TARGET_COMMIT
+$ ttnt BASE_COMMIT
+```
+
+This will assume test-to-code mapping is properly produced for the BASE\_COMMIT.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Genki-S/ttnt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+Please don't hesitate to [open a issue](https://github.com/Genki-S/ttnt/issues/new) to share your ideas for me! Any comment will be valuable especially in this early development stage.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ttnt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/ttnt

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'rugged'
+require_relative '../lib/ttnt/test_selector'
+
+USAGE = %{
+ttnt (Test This, Not That)
+
+Usage:
+  ttnt BASE_SHA
+
+What it does:
+  Output test files you should run based on changes between commits BASE_SHA and HEAD.
+}
+
+if ARGV.count != 1
+  puts USAGE
+  exit 1
+end
+
+repo = Rugged::Repository.discover('.')
+ts = TTNT::TestSelector.new(repo.head.target_id, ARGV[0])
+tests = ts.select_tests
+if tests.empty?
+  STDERR.puts 'No test selected.'
+else
+  puts tests.to_a.join("\n")
+end

data/exe/ttnt-anchor

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+gem_root = File.expand_path('../lib', File.dirname(File.expand_path(__FILE__)))
+argv = ARGV
+argv.unshift('ruby', '-I', gem_root, '-r', 'ttnt/anchor')
+
+exec(*argv)

data/lib/ttnt.rb

@@ -0,0 +1,5 @@
+require "ttnt/version"
+
+module TTNT
+  # Your code goes here...
+end

data/lib/ttnt/anchor.rb

@@ -0,0 +1,14 @@
+require 'coverage'
+require 'ttnt/test_to_code_mapping'
+require 'rugged'
+
+test_file = $0
+
+Coverage.start
+
+at_exit do
+  # Use current HEAD
+  sha = Rugged::Repository.discover('.').head.target_id
+  mapping = TTNT::TestToCodeMapping.new(sha)
+  mapping.append_from_coverage(test_file, Coverage.result)
+end

data/lib/ttnt/test_selector.rb

@@ -0,0 +1,40 @@
+require 'set'
+require 'rugged'
+require_relative './test_to_code_mapping'
+
+module TTNT
+  class TestSelector
+    def initialize(target_sha, base_sha)
+      @repo = Rugged::Repository.discover('.')
+      @target_obj = @repo.lookup(target_sha)
+      @base_obj = @repo.lookup(base_sha)
+    end
+
+    def select_tests
+      tests = Set.new
+      mapping = TTNT::TestToCodeMapping.new(@base_obj.oid)
+      # TODO: if mapping is not found (ttnt-anchor has not been run)
+
+      diff = @base_obj.diff(@target_obj)
+      diff.each_patch do |patch|
+        file = patch.delta.old_file[:path]
+        patch.each_hunk do |hunk|
+          # TODO: think if this selection covers all possibilities
+          hunk.each_line do |line|
+            case line.line_origin
+            when :addition
+              # FIXME: new_lineno is suspicious
+              #        (what if hunk1 adds 100 lines and hunk2 add 1 line?)
+              tests += mapping.get_tests(file: file, lineno: line.new_lineno)
+            when :deletion
+              tests += mapping.get_tests(file: file, lineno: line.old_lineno)
+            else
+              # do nothing
+            end
+          end
+        end
+      end
+      tests.delete(nil)
+    end
+  end
+end

data/lib/ttnt/test_to_code_mapping.rb

@@ -0,0 +1,95 @@
+require 'rugged'
+require 'json'
+
+# Terminologies:
+#   spectra: { filename => [line, numbers, executed], ... }
+
+module TTNT
+  class TestToCodeMapping
+    DIRECTORY_SEPARATOR_PLACEHOLDER = '=+='.freeze
+
+    def initialize(sha)
+      @sha = sha
+      @repo = Rugged::Repository.discover('.')
+      raise 'Not in a git repository' unless @repo
+    end
+
+    def append_from_coverage(test, coverage)
+      spectra =  normalize_path(select_project_files(spectra_from_coverage(coverage)))
+      save_spectra(test: test, spectra: spectra)
+    end
+
+    def read_spectra(test:)
+      if File.exists?(spectra_file(test: test))
+        JSON.parse(File.read(spectra_file(test: test)))
+      else
+        {}
+      end
+    end
+
+    def get_tests(file:, lineno:)
+      tests = Set.new
+      all_tests.each do |test|
+        spectra = read_spectra(test: test)
+        lines = spectra[file]
+        next unless lines
+        n = lines.bsearch { |x| x >= lineno }
+        if n == lineno
+          tests << test
+        end
+      end
+      tests
+    end
+
+    private
+
+    def normalize_path(spectra)
+      spectra.map do |filename, lines|
+        [filename.sub(@repo.workdir, ''), lines]
+      end.to_h
+    end
+
+    def select_project_files(spectra)
+      spectra.select do |filename, lines|
+        filename.start_with?(@repo.workdir)
+      end
+    end
+
+    def spectra_from_coverage(cov)
+      spectra = Hash.new { |h, k| h[k] = [] }
+      cov.each do |filename, executions|
+        executions.each_with_index do |execution, i|
+          next if execution.nil? || execution == 0
+          spectra[filename] << i + 1
+        end
+      end
+      spectra
+    end
+
+    def save_spectra(test:, spectra:)
+      dir = base_savedir
+      unless File.directory?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+      File.write(spectra_file(test: test), spectra.to_json)
+    end
+
+    def base_savedir
+      "#{@repo.workdir}/.ttnt/#{@sha}/test_to_code_mapping"
+    end
+
+    def spectra_file(test:)
+      filename = test.gsub('/', DIRECTORY_SEPARATOR_PLACEHOLDER)
+      "#{base_savedir}/#{filename}.json"
+    end
+
+    def all_tests
+      Dir["#{base_savedir}/*.json"].map do |filename|
+        filename
+          .sub(/.*\//, '')
+          .sub(/\.json\Z/, '')
+          .gsub(DIRECTORY_SEPARATOR_PLACEHOLDER, '/')
+      end
+    end
+  end
+end

data/lib/ttnt/version.rb

@@ -0,0 +1,3 @@
+module TTNT
+  VERSION = "0.0.1"
+end

data/ttnt.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ttnt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ttnt"
+  spec.version       = TTNT::VERSION
+  spec.authors       = ["Genki Sugimoto"]
+  spec.email         = ["cfhoyuk.reccos.nelg@gmail.com"]
+
+  spec.summary       = %q{Select test cases to run based on changes in committed code}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "http://github.com/Genki-S/ttnt"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+    # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rugged", "0.23.0b2"
+  spec.add_dependency "json", "1.8.3"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  # Pry
+  spec.add_development_dependency "hirb"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: ttnt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Genki Sugimoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.23.0b2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.23.0b2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- cfhoyuk.reccos.nelg@gmail.com
+executables:
+- ttnt
+- ttnt-anchor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ttnt
+- exe/ttnt-anchor
+- lib/ttnt.rb
+- lib/ttnt/anchor.rb
+- lib/ttnt/test_selector.rb
+- lib/ttnt/test_to_code_mapping.rb
+- lib/ttnt/version.rb
+- ttnt.gemspec
+homepage: http://github.com/Genki-S/ttnt
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Select test cases to run based on changes in committed code
+test_files: []