ci-queue 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d71f2dd528eeda6758bc37bb9142cac9814150ea
-  data.tar.gz: 3042fc3632751cc3ef1834dd749978dff2c628a6
+  metadata.gz: 98b80ab169a69259f71c570b707f087c3b81de3c
+  data.tar.gz: c2fdd8f99b8462fde12ba800f4e5060263705bc2
 SHA512:
-  metadata.gz: bc012267f7470bc5527ae5081ebfe2e268acf6d777db6c8c50d218e9aa21fa7a3dba46e2f1af467a9f7fcbf5ca98512322128dea0115ce4a047cd6a09aa09253
-  data.tar.gz: 80445ac4bb1f43a2a930269708c7f97178921d5da60b198af42ffdeecf07e0e0c3242cb4c065c6b220ee4ef19b6a7935716330875df1aa1b62b665f891641ae9
+  metadata.gz: 670223dbcfc6d462c25086fa449ef07063bb2b325d4e977489e7b78afd9e02bf07de55b240e92e9b95bb6a695500154dcce8c993e5ba81bfe1faafa5771d2fa9
+  data.tar.gz: 0c4a98d593e3088ea58b097785b002ac78bc51990545719f630144fdf72c59dfbe76c8ade54c157864163a3445811b29b452947bfbfdeae75545c0c356470275

data/README.md

@@ -51,4 +51,19 @@ minitest-queue --queue path/to/test_order.log --failing-test 'SomeTest#test_some
 
 ### RSpec
 
-The RSpec integration is not implemented yet.
+The RSpec integration is still missing some features, but is already usable:
+
+```bash
+rspec-queue --queue redis://example.com --build XXX --worker XXX
+```
+
+#### Missing features
+
+To be implemented:
+
+  - Requeueing
+  - Centralized reporting
+
+#### Limitations
+
+Because of how `ci-queue` execute the examples, `before(:all)` and `after(:all)` hooks are not supported. `rspec-queue` will explicitly reject them.

data/Rakefile

@@ -5,7 +5,7 @@ require 'ci/queue/version'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb'] - FileList['test/fixtures/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb'] - FileList['test/fixtures/**/*_test.rb']
 end
 
 task :default => :test

data/ci-queue.gemspec

@@ -26,9 +26,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'ansi'
+
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', "~> 10.0"
   spec.add_development_dependency 'minitest', '~> 5.9.1'
+  spec.add_development_dependency 'rspec', '~> 3.7.0'
   spec.add_development_dependency 'redis', '~> 3.3'
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'

data/exe/rspec-queue

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rspec/queue'
+RSpec::Queue::Runner.invoke

data/lib/ci/queue/redis/worker.rb

@@ -149,7 +149,7 @@ module CI
 
           if @master = redis.setnx(key('master-status'), 'setup')
             redis.multi do
-              redis.lpush(key('queue'), tests)
+              redis.lpush(key('queue'), tests) unless tests.empty?
               redis.set(key('total'), @total)
               redis.set(key('master-status'), 'ready')
             end

data/lib/ci/queue/version.rb

@@ -1,6 +1,6 @@
 module CI
   module Queue
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
     DEV_SCRIPTS_ROOT = ::File.expand_path('../../../../../redis', __FILE__)
     RELEASE_SCRIPTS_ROOT = ::File.expand_path('../redis', __FILE__)
   end

data/lib/minitest/queue/runner.rb

@@ -248,7 +248,7 @@ module Minitest
             Defaults to 0.
           EOS
           opts.separator ""
-          opts.on('--max-requeues MAX') do |max|
+          opts.on('--max-requeues MAX', *help) do |max|
             queue_config.max_requeues = Integer(max)
           end
 

data/lib/rspec/queue.rb

@@ -0,0 +1,202 @@
+require 'rspec/core'
+require 'ci/queue'
+
+module RSpec
+  module Queue
+    class << self
+      def config
+        @config ||= CI::Queue::Configuration.from_env(ENV)
+      end
+    end
+
+    module ConfigurationExtension
+      private
+
+      def command
+        'rspec' # trick rspec into enabling it's default behavior
+      end
+    end
+
+    Core::Configuration.add_setting(:queue_url)
+    Core::Configuration.prepend(ConfigurationExtension)
+
+    module ConfigurationOptionsExtension
+      attr_accessor :queue_url
+    end
+    Core::ConfigurationOptions.prepend(ConfigurationOptionsExtension)
+
+
+    module ParserExtension
+      private
+
+      def parser(options)
+        parser = super
+
+        parser.separator("\n  **** Queue options ****\n\n")
+
+        help = split_heredoc(<<-EOS)
+          URL of the queue, e.g. redis://example.com.
+          Defaults to $CI_QUEUE_URL if set.
+        EOS
+        parser.separator ""
+        parser.on('--queue URL', *help) do |url|
+          options[:queue_url] = url
+        end
+
+        help = split_heredoc(<<-EOS)
+          Unique identifier for the workload. All workers working on the same suite of tests must have the same build identifier.
+          If the build is tried again, or another revision is built, this value must be different.
+          It's automatically inferred on Buildkite, CircleCI and Travis.
+        EOS
+        parser.separator ""
+        parser.on('--build BUILD_ID', *help) do |build_id|
+          queue_config.build_id = build_id
+        end
+
+        help = split_heredoc(<<-EOS)
+          Optional. Sets a prefix for the build id in case a single CI build runs multiple independent test suites.
+            Example: --namespace integration
+        EOS
+        parser.separator ""
+        parser.on('--namespace NAMESPACE', *help) do |namespace|
+          queue_config.namespace = namespace
+        end
+
+        help = split_heredoc(<<-EOS)
+          Specify a timeout after which if a test haven't completed, it will be picked up by another worker.
+          It is very important to set this vlaue higher than the slowest test in the suite, otherwise performance will be impacted.
+          Defaults to 30 seconds.
+        EOS
+        parser.separator ""
+        parser.on('--timeout TIMEOUT', *help) do |timeout|
+          queue_config.timeout = Float(timeout)
+        end
+
+        help = split_heredoc(<<-EOS)
+          A unique identifier for this worker, It must be consistent to allow retries.
+          If not specified, retries won't be available.
+          It's automatically inferred on Buildkite and CircleCI.
+        EOS
+        parser.separator ""
+        parser.on('--worker WORKER_ID', *help) do |worker_id|
+          queue_config.worker_id = worker_id
+        end
+
+        help = split_heredoc(<<-EOS)
+          Defines how many time a single test can be requeued.
+          Defaults to 0.
+        EOS
+        parser.separator ""
+        parser.on('--max-requeues MAX', *help) do |max|
+          queue_config.max_requeues = Integer(max)
+        end
+
+        help = split_heredoc(<<-EOS)
+          Defines how many requeues can happen overall, based on the test suite size. e.g 0.05 for 5%.
+          Defaults to 0.
+        EOS
+        parser.separator ""
+        parser.on('--requeue-tolerance RATIO', *help) do |ratio|
+          queue_config.requeue_tolerance = Float(ratio)
+        end
+
+        parser
+      end
+
+      def split_heredoc(string)
+        string.lines.map(&:strip)
+      end
+
+      def queue_config
+        ::RSpec::Queue.config
+      end
+    end
+
+    RSpec::Core::Parser.prepend(ParserExtension)
+
+    class SingleExample
+      attr_reader :example_group, :example
+
+      def initialize(example_group, example)
+        @example_group = example_group
+        @example = example
+      end
+
+      def id
+        example.id
+      end
+
+      def run(reporter)
+        return if RSpec.world.wants_to_quit
+        instance = example_group.new(example.inspect_output)
+        example_group.set_ivars(instance, example_group.before_context_ivars)
+        succeeded = example.run(instance, reporter)
+        if !succeeded && reporter.fail_fast_limit_met?
+          RSpec.world.wants_to_quit = true
+        end
+        succeeded
+      end
+    end
+
+    class Runner < ::RSpec::Core::Runner
+      include CI::Queue::OutputHelpers
+
+      def setup(err, out)
+        super
+        invalid_usage!('Missing --queue parameter') unless queue_url
+        invalid_usage!('Missing --build parameter') unless RSpec::Queue.config.build_id
+        invalid_usage!('Missing --worker parameter') unless RSpec::Queue.config.worker_id
+      end
+
+      def run_specs(example_groups)
+        examples = example_groups.flat_map do |example_group|
+          example_group.filtered_examples.map do |example|
+            SingleExample.new(example_group, example)
+          end
+        end
+
+        queue = CI::Queue.from_uri(queue_url, RSpec::Queue.config)
+        queue.populate(examples, &:id)
+        examples_count = examples.size # TODO: figure out which stub value would be best
+        success = true
+        @configuration.reporter.report(examples_count) do |reporter|
+          @configuration.with_suite_hooks do
+            queue.poll do |example|
+              success &= example.run(reporter)
+              queue.acknowledge(example)
+            end
+          end
+        end
+
+        success &= !@world.non_example_failure
+        success ? 0 : @configuration.failure_exit_code
+      end
+
+      private
+
+      def queue_url
+        configuration.queue_url || ENV['CI_QUEUE_URL']
+      end
+
+      def invalid_usage!(message)
+        reopen_previous_step
+        puts red(message)
+        puts
+        puts 'Please use --help for a listing of valid options'
+        exit! 1 # exit! is required to avoid minitest at_exit callback
+      end
+
+      def exit!(*)
+        STDOUT.flush
+        STDERR.flush
+        super
+      end
+
+      def abort!(message)
+        reopen_previous_step
+        puts red(message)
+        exit! 1 # exit! is required to avoid minitest at_exit callback
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ci-queue
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.9.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +127,7 @@ email:
 - jean.boussier@shopify.com
 executables:
 - minitest-queue
+- rspec-queue
 extensions: []
 extra_rdoc_files: []
 files:
@@ -113,6 +142,7 @@ files:
 - ci-queue.gemspec
 - dev.yml
 - exe/minitest-queue
+- exe/rspec-queue
 - lib/ci/queue.rb
 - lib/ci/queue/bisect.rb
 - lib/ci/queue/configuration.rb
@@ -136,6 +166,7 @@ files:
 - lib/minitest/reporters/order_reporter.rb
 - lib/minitest/reporters/queue_reporter.rb
 - lib/minitest/reporters/redis_reporter.rb
+- lib/rspec/queue.rb
 homepage: https://github.com/Shopify/ci-queue
 licenses:
 - MIT