flatware-rspec 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96ee1612dd1b6bedadb6d14a2314dd62f8e06121
+  data.tar.gz: 57140b234970845f9ef60dcfcfe5a500ee03277a
+SHA512:
+  metadata.gz: ff248de8080055159ea82ad929ef1f0481153fd4cc3fa4b4dfcc55e7a584009024f6255d226c652ea8dd85a326005d98771d1f0bead85913999c1cdf12ef07c1
+  data.tar.gz: 9f44cdadf9e6fa43a3d56b0e2f601b5434460553d9c4962f89e4c36647f7ad7da3eb2c8806467c4058b2eeacbfe0df62ccb78edc2b08c7491ff756190310fa10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brian Dunn
+
+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,176 @@
+# Flatware [![Build Status][travis-badge]][travis] [![Code Climate][code-climate-badge]][code-climate]
+
+[travis-badge]: https://travis-ci.org/briandunn/flatware.svg?branch=master
+[travis]: http://travis-ci.org/briandunn/flatware
+[code-climate-badge]: https://codeclimate.com/github/briandunn/flatware.png
+[code-climate]: https://codeclimate.com/github/briandunn/flatware
+
+Flatware parallelizes your test suite to significantly reduce test time.
+
+## Requirements
+
+* ZeroMQ > 4.0
+
+## Installation
+
+### ZeroMQ
+
+#### Linux Ubuntu
+
+```sh
+sudo apt-get install -qq libzmq3-dev
+```
+
+(Never you mind the 3. This package contains ZMQ version 4.)
+
+#### Mac OSX
+
+Ruby FFI isn't getting along with the latest ZMQ formula. A tweaked verson is available in the Hashrocket tap.
+
+```sh
+brew tap hashrocket/formulas
+brew install hashrocket/formulas/zeromq
+brew install zeromq
+```
+
+### Flatware
+
+Add the runners you need to your Gemfile:
+
+```ruby
+gem 'flatware-rspec'    # one
+gem 'flatware-cucumber' # or both
+```
+
+then run
+
+```sh
+bundle install
+```
+
+## Usage
+
+### Cucumber
+
+To run your entire suite with the default cucumber options, add the `flatware-cucumber` gem and just:
+
+```sh
+$ flatware cucumber
+```
+
+### RSpec
+
+To run your entire suite with the default rspec options add the `flatware-rspec` gem and just:
+
+```sh
+$ flatware rspec
+```
+
+### Options
+
+If you'd like to limit the number of forked workers, you can pass the 'w' flag:
+
+```sh
+$ flatware -w 3
+```
+
+You can also pass most cucumber/rspec options to Flatware. For example, to run only
+features that are not tagged 'javascript', you can:
+
+```sh
+$ flatware cucumber -t ~@javascript
+```
+
+Additionally, for either cucumber or rspec you can specify a directory:
+
+```sh
+$ flatware rspec spec/features
+```
+
+## Typical Usage in a Rails App
+
+Add the following to your `config/database.yml`:
+
+```yml
+test:
+  database: foo_test
+```
+
+becomes:
+
+```yml
+test:
+  database: foo_test<%=ENV['TEST_ENV_NUMBER']%>
+```
+
+Run the following:
+
+```sh
+$ rake db:setup # if not already done
+$ flatware fan rake db:test:prepare
+```
+
+Now you are ready to rock:
+
+```sh
+$ flatware rspec && flatware cucumber
+```
+
+## Planned Features
+
+* Use heuristics to run your slowest tests first
+
+## Design Goals
+
+### Maintainable
+
+* Fully test at an integration level. Don't be afraid to change the code. If you
+  break it you'll know.
+* Couple as loosely as possible, and only to the most stable/public bits of
+  Cucumber and RSpec.
+
+### Minimal
+
+* Projects define their own preparation scripts
+* Only distribute to local cores (for now)
+
+### Robust
+
+* Depend on a dedicated messaging library
+* Be accountable for completed work; provide progress report regardless of
+  completing the suite.
+
+## Tinkering
+
+Flatware integration tests use [aruba][a]. In order to get a demo cucumber project you
+can add the `@no-clobber` tag to `features/flatware.feature` and run the test
+with `cucumber features/flatware.feature`. Now you should have a `./tmp/aruba`
+directory. CD there and `flatware` will be in your path so you can tinker away.
+
+## How it works
+
+Flatware relies on a message passing system to enable concurrency.
+The main process declares a worker for each cpu in the computer. Each
+worker forks from the main process and is then assigned a portion of the
+test suite.  As the worker runs the test suite it sends progress
+messages to the main process.  These messages are collected and when
+the last worker is finished the main process provides a report on the
+collected progress messages.
+
+## Resources
+
+To learn more about the messaging system that Flatware uses, take a look at the
+[excellent ZeroMQ guide][z].
+
+[z]: http://zguide.zeromq.org/page:all
+[a]: https://github.com/cucumber/aruba
+
+## Contributing to Flatware
+
+Do whatever you want. I'd love to help make sure Flatware meets your needs.
+
+## About
+
+[![Hashrocket logo](https://hashrocket.com/hashrocket_logo.svg)](https://hashrocket.com)
+
+Flatware is supported by the team at [Hashrocket](https://hashrocket.com), a multidisciplinary design & development consultancy. If you'd like to [work with us](https://hashrocket.com/contact-us/hire-us) or [join our team](https://hashrocket.com/contact-us/jobs), don't hesitate to get in touch.

data/lib/flatware-rspec.rb

@@ -0,0 +1 @@
+require 'flatware/rspec'

data/lib/flatware/rspec/checkpoint.rb

@@ -0,0 +1,29 @@
+require 'flatware/rspec/examples_notification'
+
+module Flatware
+  module RSpec
+    class Checkpoint
+      attr_reader :summary, :failures_notification
+
+      def initialize(summary, failures_notification)
+        @summary, @failures_notification = summary, ExamplesNotification.new(failures_notification.failure_notifications)
+      end
+
+      def +(other)
+        self.class.new summary + other.summary, failures_notification + other.failures_notification
+      end
+
+      def failures?
+        summary.failure_count > 0
+      end
+
+      def failure_notifications
+        failures_notification.failure_notifications
+      end
+
+      def fully_formatted_failed_examples(*args)
+        failures_notification.fully_formatted_failed_examples(*args)
+      end
+    end
+  end
+end

data/lib/flatware/rspec/cli.rb

@@ -0,0 +1,16 @@
+require 'flatware/cli'
+
+module Flatware
+  class CLI
+    worker_option
+    method_option 'dispatch-endpoint', type: :string, default: 'ipc://dispatch'
+    method_option 'sink-endpoint', type: :string, default: 'ipc://task'
+    desc "rspec [FLATWARE_OPTS]", "parallelizes rspec"
+    def rspec(*rspec_args)
+      jobs = RSpec.extract_jobs_from_args rspec_args, workers: workers
+      Flatware.verbose = options[:log]
+      Worker.spawn count: workers, runner: RSpec, dispatch: options['dispatch-endpoint'], sink: options['sink-endpoint']
+      start_sink jobs: jobs, workers: workers, formatter: Flatware::RSpec::Formatters::Console.new($stdout, $stderr)
+    end
+  end
+end

data/lib/flatware/rspec/example_notification.rb

@@ -0,0 +1,21 @@
+require 'rspec/core/formatters/console_codes'
+
+module Flatware
+  module RSpec
+    class ExampleNotification
+      attr_reader :formatted
+      def initialize(notification)
+        @formatted = notification.fully_formatted '!', default_colorizer
+      end
+
+      def fully_formatted(i, _=nil)
+        formatted.sub '!', i.to_s
+      end
+
+      private
+      def default_colorizer
+        ::RSpec::Core::Formatters::ConsoleCodes
+      end
+    end
+  end
+end

data/lib/flatware/rspec/examples_notification.rb

@@ -0,0 +1,24 @@
+require 'flatware/rspec/example_notification'
+module Flatware
+  module RSpec
+    class ExamplesNotification
+      attr_reader :failure_notifications
+
+      def initialize(failure_notifications)
+        @failure_notifications = failure_notifications.map(&ExampleNotification.method(:new))
+      end
+
+      def +(other)
+        self.class.new failure_notifications + other.failure_notifications
+      end
+
+      def fully_formatted_failed_examples(*)
+        formatted = "\n\nFailures:\n"
+        failure_notifications.each_with_index do |failure, index|
+          formatted << failure.fully_formatted(index.next)
+        end
+        formatted
+      end
+    end
+  end
+end

data/lib/flatware/rspec/formatter.rb

@@ -0,0 +1,50 @@
+require 'flatware/rspec/checkpoint'
+require 'flatware/rspec/summary'
+require 'rspec/core/formatters/console_codes'
+
+module Flatware
+  module RSpec
+    ProgressMessage = Struct.new(:progress)
+
+    class Formatter
+      attr_reader :summary, :output
+
+      def initialize(stdout)
+        @output = stdout
+      end
+
+      def example_passed(example)
+        send_progress :passed
+      end
+
+      def example_failed(example)
+        send_progress :failed
+      end
+
+      def example_pending(example)
+        send_progress :pending
+      end
+
+      def dump_summary(summary)
+        @summary = Summary.from_notification(summary)
+      end
+
+      def dump_failures(failure_notification)
+        @failure_notification = failure_notification
+      end
+
+      def close(*)
+        Sink::client.checkpoint Checkpoint.new(summary, @failure_notification)
+        @failure_notification = nil
+      end
+
+      private
+
+      def send_progress(status)
+        Sink::client.progress ProgressMessage.new status
+      end
+    end
+
+    ::RSpec::Core::Formatters.register Formatter, :example_passed, :example_failed, :example_pending, :dump_summary, :dump_failures, :close
+  end
+end

data/lib/flatware/rspec/formatters/console.rb

@@ -0,0 +1,33 @@
+module Flatware::RSpec::Formatters
+  class Console
+    attr_reader :formatter
+
+    def initialize(out, err)
+      ::RSpec::configuration.tty = true
+      ::RSpec::configuration.color = true
+      @formatter = ::RSpec::Core::Formatters::ProgressFormatter.new(out)
+    end
+
+    def progress(result)
+      formatter.send(message_for(result),nil)
+    end
+
+    def summarize(checkpoints)
+      result = checkpoints.reduce :+
+      if result
+        formatter.dump_failures result
+        formatter.dump_summary result.summary
+      end
+    end
+
+    private
+
+    def message_for(result)
+      {
+        passed:  :example_passed,
+        failed:  :example_failed,
+        pending: :example_pending
+      }.fetch result.progress
+    end
+  end
+end

data/lib/flatware/rspec/summary.rb

@@ -0,0 +1,40 @@
+require 'rspec/core/notifications'
+module Flatware
+  module RSpec
+    Summary = Struct.new(:duration, :examples, :failed_examples, :pending_examples, :load_time)
+
+    class Example
+      attr_reader :location_rerun_argument, :full_description
+      def initialize(rspec_example)
+        @full_description        = rspec_example.full_description
+        @location_rerun_argument = rspec_example.location_rerun_argument
+      end
+    end
+
+    class Summary
+      def +(other)
+        self.class.new duration + other.duration,
+          examples + other.examples,
+          failed_examples + other.failed_examples,
+          pending_examples + other.pending_examples,
+          load_time + other.load_time
+      end
+
+      def fully_formatted
+        ::RSpec::Core::Notifications::SummaryNotification.new(duration, examples, failed_examples, pending_examples, load_time).fully_formatted
+      end
+
+      def failure_count
+        failed_examples.size
+      end
+
+      def self.from_notification(summary)
+        serialized_examples = [summary.examples, summary.failed_examples, summary.pending_examples].map do |examples|
+          examples.map(&Example.method(:new))
+        end
+
+        new summary.duration, *serialized_examples, summary.load_time
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: flatware-rspec
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Brian Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flatware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: A distributed rspec runner
+email: brian@hashrocket.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/flatware-rspec.rb
+- lib/flatware/rspec/checkpoint.rb
+- lib/flatware/rspec/cli.rb
+- lib/flatware/rspec/example_notification.rb
+- lib/flatware/rspec/examples_notification.rb
+- lib/flatware/rspec/formatter.rb
+- lib/flatware/rspec/formatters/console.rb
+- lib/flatware/rspec/summary.rb
+homepage: http://github.com/briandunn/flatware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A distributed rspec runner
+test_files: []