rspec-ordering-mttf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab6f52747514ec2196e536585a6eddc495659ca1df08fbc1f4f36841dcbc7b27
+  data.tar.gz: 34603849812cd2b060df5bc3b637e5342382c9e5de6361ee2733b2492c9bd1a3
+SHA512:
+  metadata.gz: f000b0d0cacb15544e10900924340b8d3c235ca97a6b7faf3229a007d0db5d4db1370dfa03b0b2a3f9aff12a08fb9e6c04f4a2f39408c9c00d36ea49b88d7f44
+  data.tar.gz: 60ff68191448b04924a22f2a71288b111f889916ed36b8b930670ea245f69345bdb8030e449c2da58a12a38203ab042b3095464f7334260e1edd676fe9d54aca

data/.dir-locals.el

@@ -0,0 +1,4 @@
+;;; Directory Local Variables
+;;; For more information see (info "(emacs) Directory Variables")
+
+((ruby-mode . ((flycheck-checker . ruby-standard))))

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+-I lib/rspec/ordering/mttf

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-ordering-mttf.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"
+
+gem "guard-rspec", require: false

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    rspec-ordering-mttf (0.1.0)
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.16.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  guard-rspec
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec-ordering-mttf!
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.15

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  notification :emacs
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  watch(ruby.lib_files) { rspec.spec_dir }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Brandon Duff
+
+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,44 @@
+# RSpec::Ordering::Mttf (Mean Time to Failure) [![Ruby](https://github.com/brandonduff/rspec-ordering-mttf/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/brandonduff/rspec-ordering-mttf/actions/workflows/main.yml)
+
+A custom orderer for RSpec that optimizes for test latency (mean time to failure) over test throughput.
+
+## Why would I want this?
+
+If you do Test-Driven Development, you likely implement some version of this algorithm manually all the time. It's likely you have too many tests to run them all on every change, so you decide which tests to run based on those that are likely to fail and how quickly they run. This orderer uses a basic set of heuristics to automate that work:
+
+1. Never-run tests first, in arbitrary order
+1. Group remaining tests by the date at which they most recently failed.
+1. Sort groups such that the most recent failure date is first, and never-failing tests are at the end.
+1. Within a group, run the fastest tests first.
+
+These heuristics are taken from [JUnitMax](https://junit.org/junit4/javadoc/latest/org/junit/experimental/max/MaxCore.html).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rspec-ordering-mttf
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rspec-ordering-mttf
+
+## Usage
+
+Call `RSpec::Ordering::Mttf.configure` with the RSpec configuration. This will configure a default global ordering of "mean time to failure." I expect to change these ergonomics soon, but I haven't yet decided how.
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+This gem uses Standard for code styling.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brandonduff/rspec-ordering-mttf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # Ignored
+end
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/TODO.md

@@ -0,0 +1,9 @@
+- [x] Record metadata at end of run
+- [x] Read metadata at start of run
+- [x] Running in date groups, ordering by fastest
+  - [x] record and compare run time on examples
+  - [x] record run time on groups
+- [x] merge on metadata, don't overwrite
+- [x] sort the groups as well. our orderer will get called with groups and then with examples in the groups
+- [x] parent groups will reflect the most relevant of their deepest children
+- [x] refactoring: make RunResults a class instead of a hash. Should clean up a lot

data/lib/rspec/ordering/mttf/example_result_data.rb

@@ -0,0 +1,72 @@
+module RSpec
+  module Ordering
+    module Mttf
+      class ExampleResultData
+        include Comparable
+
+        def self.from_example(example)
+          last_failed_date = if example.execution_result.status == :failed
+            RSpec.configuration.current_date
+          else
+            example.metadata[:last_failed_date]
+          end
+          new(status: example.execution_result.status,
+            last_failed_date: last_failed_date,
+            last_run_date: RSpec.configuration.current_date,
+            run_time: example.execution_result.run_time)
+        end
+
+        def self.from_example_metadata(example)
+          metadata = example.metadata
+          new(status: metadata[:status],
+            last_failed_date: metadata[:last_failed_date],
+            last_run_date: metadata[:last_run_date],
+            run_time: metadata[:last_run_time])
+        end
+
+        def self.add_examples_to_group_results(examples, group_results)
+          examples = Array(examples)
+          summed_run_time = examples.map(&:run_time).compact.sum
+          smallest_result = [group_results, examples.min].compact.min
+
+          new(
+            status: smallest_result.status,
+            last_failed_date: smallest_result.last_failed_date,
+            last_run_date: smallest_result.last_run_date,
+            run_time: (group_results&.run_time || 0) + summed_run_time
+          )
+        end
+
+        def initialize(status:, last_failed_date:, last_run_date:, run_time:)
+          @status = status
+          @last_failed_date = last_failed_date
+          @last_run_date = last_run_date
+          @run_time = run_time
+        end
+
+        attr_reader :status, :last_failed_date, :last_run_date, :run_time
+
+        def <=>(other)
+          if last_run_date.nil?
+            -1
+          elsif other.last_run_date.nil?
+            1
+          elsif last_failed_date.nil? && !other.last_failed_date.nil?
+            1
+          elsif other.last_failed_date.nil? && !last_failed_date.nil?
+            -1
+          elsif other.last_failed_date && last_failed_date &&
+              other.last_failed_date != last_failed_date
+            other.last_failed_date <=> last_failed_date
+          elsif run_time && !other.run_time
+            -1
+          elsif !run_time && other.run_time
+            1
+          else
+            run_time <=> other.run_time
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/ordering/mttf/orderer.rb

@@ -0,0 +1,25 @@
+module RSpec
+  module Ordering
+    module Mttf
+      class Orderer
+        def initialize(memory)
+          @run_results = memory.read
+        end
+
+        def order(items)
+          items.each do |example|
+            run_results.annotate_example(example)
+          end
+
+          items.sort_by do |example|
+            ExampleResultData.from_example_metadata(example)
+          end
+        end
+
+        private
+
+        attr_reader :run_results
+      end
+    end
+  end
+end

data/lib/rspec/ordering/mttf/run_memory.rb

@@ -0,0 +1,41 @@
+module RSpec
+  module Ordering
+    module Mttf
+      class RunMemory
+        def initialize(filename)
+          @store = YAML::Store.new(filename)
+          @run_results = RunResults.new
+        end
+
+        def example_group_finished(summary_notification)
+          collect_result(summary_notification.group)
+        end
+
+        def stop(_reporter)
+          write
+        end
+
+        def read
+          store.transaction(true) do
+            RunResults.new(store["results"] || {})
+          end
+        end
+
+        private
+
+        def write
+          existing = read
+          store.transaction do
+            store["results"] = existing.merge(run_results)
+          end
+        end
+
+        def collect_result(group)
+          run_results.record_group(group)
+        end
+
+        attr_reader :store, :run_results
+      end
+    end
+  end
+end

data/lib/rspec/ordering/mttf/run_results.rb

@@ -0,0 +1,54 @@
+module RSpec
+  module Ordering
+    module Mttf
+      class RunResults
+        def initialize(hash = {})
+          @results = hash
+        end
+
+        def merge(other)
+          results.merge(other.results)
+        end
+
+        def record_group(group)
+          new_examples = record_examples(group)
+          updated_group_results = update_group(group, new_examples)
+          update_group(group.superclass, updated_group_results) unless group.top_level?
+        end
+
+        def annotate_example(example)
+          if (example_run_result = self[example])
+            example.metadata[:last_run_date] = example_run_result.last_run_date
+            example.metadata[:last_failed_date] = example_run_result.last_failed_date
+            example.metadata[:last_run_time] = example_run_result.run_time
+          end
+        end
+
+        def [](example)
+          results[example.id]
+        end
+
+        protected
+
+        attr_reader :results
+
+        private
+
+        def []=(example, value)
+          results[example.id] = value
+        end
+
+        def update_group(group, new_examples)
+          self[group] = ExampleResultData
+            .add_examples_to_group_results(new_examples, self[group])
+        end
+
+        def record_examples(group)
+          group.examples.map do |example|
+            self[example] = ExampleResultData.from_example(example)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/ordering/mttf/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Ordering
+    module Mttf
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rspec/ordering/mttf.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "mttf/version"
+require_relative "mttf/run_results"
+require_relative "mttf/run_memory"
+require_relative "mttf/orderer"
+require_relative "mttf/example_result_data"
+require "yaml/store"
+
+module RSpec
+  module Ordering
+    module Mttf
+      def self.configure(config, current_date: Date.today, previous_run_data: ".rspec-run-data.store")
+        run_memory = RunMemory.new(previous_run_data)
+        config.register_ordering(:global, Orderer.new(run_memory))
+
+        config.reporter.register_listener(run_memory, :example_group_finished)
+        config.reporter.register_listener(run_memory, :stop)
+
+        config.add_setting :current_date
+        config.current_date = current_date
+      end
+    end
+  end
+end

data/rspec-ordering-mttf.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec/ordering/mttf/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec-ordering-mttf"
+  spec.version = RSpec::Ordering::Mttf::VERSION
+  spec.authors = ["Brandon Duff"]
+  spec.email = ["bduff@hey.com"]
+
+  spec.summary = "Order tests optimizing for Mean Time to Failure"
+  spec.homepage = "https://github.com/brandonduff/rspec-ordering-mttf"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/brandonduff/rspec-ordering-mttf"
+  spec.metadata["changelog_uri"] = "https://github.com/brandonduff/rspec-ordering-mttf/blob/main/changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rspec"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rspec/ordering/mttf.rbs

@@ -0,0 +1,8 @@
+module Rspec
+  module Ordering
+    module Mttf
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ordering-mttf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Duff
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bduff@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dir-locals.el"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/rspec/ordering/mttf.rb
+- lib/rspec/ordering/mttf/example_result_data.rb
+- lib/rspec/ordering/mttf/orderer.rb
+- lib/rspec/ordering/mttf/run_memory.rb
+- lib/rspec/ordering/mttf/run_results.rb
+- lib/rspec/ordering/mttf/version.rb
+- rspec-ordering-mttf.gemspec
+- sig/rspec/ordering/mttf.rbs
+homepage: https://github.com/brandonduff/rspec-ordering-mttf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/brandonduff/rspec-ordering-mttf
+  source_code_uri: https://github.com/brandonduff/rspec-ordering-mttf
+  changelog_uri: https://github.com/brandonduff/rspec-ordering-mttf/blob/main/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Order tests optimizing for Mean Time to Failure
+test_files: []