rspec-sequencing 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f55448a904178a9d9de76f150466e1a16a62b20
-  data.tar.gz: 840557a2288455add1ff877359371601965e44f3
+SHA256:
+  metadata.gz: 9ff6bcb858f98c3a60578bb99c9b7c5944ed85fe174d97f4d2b1d808b3cf3568
+  data.tar.gz: 19db7c75c1c8ae858070a430a2c9c3983abc4dd4ba02b4ea0aa82e616343fa0c
 SHA512:
-  metadata.gz: 17e9d48eaddc44c682889bbc52ae29f0db672f2fccaf0a322c4d5f2b71b6e595cc1550a87c33de796f31d281c98daff737e64912cf7e6403c921eb91c82ab085
-  data.tar.gz: 8fb78869e9c0e63cf5306c7cd927eeb864aa5614d0ad87176f4585db942eaf4d29d85220a7bca900c2519dbfc8fa5399acd04902d8eb5e23a8345de9bffeb228
+  metadata.gz: 2446014dd4416e4e774adcddf6d1fdbffe6cd546a90f2a6f5a45fd7039bb97c2a6eefd68e2518522e29bf3744cdf3fd94a9681c3c8fd1e9b8bd9ff3ef7e3ffaf
+  data.tar.gz: 0aa4c7910af0457c715fc5b7b9e2a161c0ae8a1c708821fee8d1241326b9365a191f76c0fa5c242e17df9ea6a9c19fc37719ad443ff9451f9a0370ab3c05497e

data/README.md

@@ -101,71 +101,36 @@ You might be tempted to think, I can just do:
 ```
 and you would be correct, for this contrived example.
 
-Here is a real example from the ruby-file_watch library. Here we use Sequencing to let files age and other elapsed time mechanisms.
+Here is a real example from the Logstash file input plugin tests. Here we use Sequencing to let files age and other elapsed time mechanisms.
 ```ruby
-describe FileWatch::Watch do
-  before(:all) do
-    @thread_abort = Thread.abort_on_exception
-    Thread.abort_on_exception = true
-  end
-
-  after(:all) do
-    Thread.abort_on_exception = @thread_abort
-  end
-
-  let(:directory) { Stud::Temporary.directory }
-  let(:watch_dir) { File.join(directory, "*.log") }
-  let(:file_path) { File.join(directory, "1.log") }
-  let(:loggr)     { double("loggr", :debug? => true) }
-  let(:results)   { [] }
-  let(:stat_interval) { 0.1 }
-  let(:discover_interval) { 4 }
-
-  let(:subscribe_proc) do
-    lambda do
-      formatted_puts("subscribing")
-      # subject subscribe does not return until subject.quit is called
-      subject.subscribe(stat_interval, discover_interval) do |event, watched_file|
-        results.push([event, watched_file.path])
+    context "when ignore_older is less than close_older and all files are not expired" do
+      let(:opts) { super.merge(:ignore_older => 1, :close_older => 1.1) }
+      let(:suffix) { "N" }
+      let(:actions) do
+        RSpec::Sequencing
+          .run_after(0.1, "file created") do
+            File.open(file_path, "wb") { |file|  file.write("line1\nline2\n") }
+          end
+          .then("start watching before file age reaches ignore_older") do
+            tailing.watch_this(watch_dir)
+          end
+          .then("wait for lines") do
+            wait(1.2).for{listener1.calls}.to eq([:open, :accept, :accept, :timed_out])
+          end
+          .then("quit after allowing time to close the file") do
+            tailing.quit
+          end
       end
-    end
-  end
-
-  subject { FileWatch::Watch.new(:logger => loggr) }
-
-  before do
-    allow(loggr).to receive(:debug)
-  end
-  after do
-    FileUtils.rm_rf(directory)
-  end
 
-  context "when ignore older and close older expiry is enabled and after timeout the file is appended-to" do
-    before do
-      subject.ignore_older = 2
-      subject.close_older = 2
-
-      RSpec::Sequencing
-        .run("create file") do
-          File.open(file_path, "wb") { |file|  file.write("line1\nline2\n") }
-        end
-        .then_after(3.1, "start watching after the file ages more than two seconds") do
-          subject.watch(watch_dir)
-        end
-        .then("append more lines to file when its 'ignored'") do
-          File.open(file_path, "ab") { |file|  file.write("line3\nline4\n") }
-        end
-        .then_after(3.1, "quit after allowing time for the close mechanism (timeout)") do
-          subject.quit #<--- this unblocks the subscribe loop
-        end
-    end
-
-    it "yields unignore, modify then timeout file events" do
-      subscribe_proc.call #<--- the rspec thread is in a forever loop until quit is called in another thread
-      expect(results).to eq([[:unignore, file_path], [:modify, file_path], [:timeout, file_path]])
+      it "reads lines normally" do
+        actions.activate
+        # subscribe is a blocking operation until tailing.quit is called on the sequence threads
+        # and that last step is dependent on the wait(1.2).for rspec expectation to succeed. 
+        tailing.subscribe(observer)
+        actions.assert_no_errors # if the rspec `wait` call times out then this raises the RSpec failed assertion exception.
+        expect(listener1.lines).to eq(["line1", "line2"])
+      end
     end
-  end
-end
 ```
 
 ### API
@@ -180,13 +145,22 @@ and some instance methods:
 ```ruby
   then(description = '', &block) # when the previous action completed the block runs without delay
   then_after(delay, description = '', &block) # when the previous action completed the block runs after delay seconds
+  
+ # use `activate` or `activate_quietly`, when defining a sequence in a `let` block,
+ #   to get RSpec to instantiate the sequence.
+  activate # this will print 'sequence activated' to the RSpec output_stream
+  activate_quietly # this will print nothing to the RSpec output_stream
+  value # this will block until the value from the last step is available
 ```
-Note that the description is optional, however by adding a description you document the action in the code and the spec output.
+#### Note:
+The description is optional, however by adding a description you document
+the action in the code and the spec output. The description is printed after the delay and before the block is executed - use present tense, e.g. "Creating file" 
 
-This library is multithreaded and uses the `concurrent-ruby` Dataflow and ScheduledTask mechanisms so you should set `Thread.abort_on_exception = true`
-in your specs so any exceptions in your actions bubble up to spec execution.
+This library is multithreaded and uses the `concurrent-ruby` Dataflow feature.
+Dataflow will absorb any exceptions and cause the dataflow to be rejected with the `reason` set to the Exception.
+In this case, use the `assert_no_errors` method - this will re-raise the first exception it finds.
 
-### Please note:
+#### Note:
 - The sequence executes in different threads from the main RSpec thread. You will need to wait for the sequence value (see this library's specs) otherwise the test will end before the sequence ends and any expectations based on side effects of the sequence will not be met. However, if you are testing scenarios where the main RSpec thread is blocked in some way, e.g. a subscribe loop, then one, usually the last, task should act to unblock the RSpec main thread. In this case you should not wait on the sequence value.
 - The system that you are testing needs to be thread safe.
 

data/lib/rspec/sequencing.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'concurrent'
 
 module RSpec
@@ -10,42 +12,49 @@ module RSpec
       new.then_after(delay, description, &block)
     end
 
+    attr_reader :flows
+
     def initialize
-      @flow = nil
+      @flows = []
     end
 
     def then_after(delay, description = '', &block)
-      @flow = dataflow(delay, description, [@flow], &block)
+      @flows << Concurrent.dataflow(*@flows) do
+        sleep delay
+        formatted_puts(description) unless description.empty?
+        block.call
+      end
       self
     end
 
-    def then(description, &block)
+    def then(description = '', &block)
       then_after(0, description, &block)
     end
 
-    def dataflow(delay, description = '', inputs = [], &block)
-      Concurrent.dataflow(*inputs.compact) do
-        task(delay, &block).execute.value.tap do
-          formatted_puts(description)
-        end
-      end
-    end
-
-    def task(delay, &block)
-      Concurrent::ScheduledTask.new(delay) do
-        block.call
-        true
-      end
+    def activate_quietly
+      # use this method if you define the sequencing in a let block so RSpec instantiates it
     end
 
     def activate
-      # use this method if you define the sequencing in a let block
-      # so RSpec runs it
+      # use this method if you define the sequencing in a let block so RSpec instantiates it
       formatted_puts "sequence activated"
     end
 
+    def assert_no_errors
+      # if you think you might get exceptions raised in any step the use this to get rspec to see them
+      # the raised error gets set as the dataflow `reason`.
+      value
+      @flows.map do |flow|
+        if flow.rejected?
+          raise flow.reason
+        end
+        flow.value
+      end
+    end
+
     def value
-      @flow.value
+      # this is a blocking operation
+      @flows.last.value
     end
 
     private

data/lib/rspec_sequencing.rb

@@ -1 +1,3 @@
+# encoding: utf-8
+
 require "rspec/sequencing"

data/rspec-sequencing.gemspec

@@ -4,7 +4,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rspec-sequencing"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.1"
+  spec.licenses      = ['Apache-2.0']
   spec.authors       = ["Elastic"]
   spec.email         = ["info@elastic.co"]
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sequencing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   name: rspec
@@ -21,13 +21,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: concurrent-ruby
@@ -35,13 +35,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   name: bundler
@@ -49,13 +49,13 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   name: rake
@@ -63,7 +63,7 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description:
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,7 +82,8 @@ files:
 - lib/rspec_sequencing.rb
 - rspec-sequencing.gemspec
 homepage: https://github.com/elastic/rspec-sequencing
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -90,17 +91,17 @@ 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.8
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Define sequenced actions that simulate real-world scenarios