rspec-sequencing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f55448a904178a9d9de76f150466e1a16a62b20
+  data.tar.gz: 840557a2288455add1ff877359371601965e44f3
+SHA512:
+  metadata.gz: 17e9d48eaddc44c682889bbc52ae29f0db672f2fccaf0a322c4d5f2b71b6e595cc1550a87c33de796f31d281c98daff737e64912cf7e6403c921eb91c82ab085
+  data.tar.gz: 8fb78869e9c0e63cf5306c7cd927eeb864aa5614d0ad87176f4585db942eaf4d29d85220a7bca900c2519dbfc8fa5399acd04902d8eb5e23a8345de9bffeb228

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+Copyright (c) 2016 Elasticsearch <http://www.elastic.co>
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,196 @@
+# Rspec::Sequencing
+
+Define sequenced actions that simulate real-world scenarios, e.g. write_file then 2 seconds later rename it or execute a sequence of actions on a http server
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-sequencing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-sequencing
+
+## Usage
+
+Generally one would use this when you need to have a series of actions occur in way that reflects the real world in terms of being asynchronous, serial, and spread out over time especially when the library code you are testing has difficult to mock dependencies like sockets, files, servers or apis, i.e. integration testing.
+
+Add `require "rspec_sequencing"` in your spec_helper.rb or equivalent.
+
+### Example
+
+Lets start with an abstract example. Imagine you want to fully test a Order Processing external api. Suppose you want to test the Product Return/Refund api call.
+Assumptions:
+- you have a client class that connects to the gateway.
+- the client returns a response message from the api call.
+- the order processing system uses background jobs to handle order changes
+- necessary `let` variables for creds, order details and client etc. are available.
+
+```ruby
+  context "when refunding an order" do
+    let(:results)  { Hash.new(NullObject.new) }
+
+    it "returns-processing starts and a refund is pending" do
+      RSpec::Sequencing
+        .run("login") do
+          results[:auth] = client.login(*creds)
+        end
+        .then("place order") do
+          results[:new_order] = client.place_order(order_details)
+        end
+        .then_after(2, "pay for order") do #<-- wait for place order background job
+          results[:pay_order] = client.pay_for_order(order_details)
+        end
+        .then_after(1, "ship order because we received payment") do
+          results[:shipit] = client.ship_order(order_details)
+        end
+        .then_after(2, "refund order") do
+          results[:refund] = client.refund_order(order_details)
+        end
+        .value # <-- we need to wait for the last action to complete
+
+      expect(results[:auth]).to      eq("Welcome")
+      expect(results[:new_order]).to eq("Order placed. Picking started")
+      expect(results[:pay_order]).to eq("Payment received, thank you.")
+      expect(results[:shipit]).to    eq("Order shipped")
+      expect(results[:refund]).to    eq("Order returns processing started, you will receive a refund when we receive the goods back")
+    end
+  end
+```
+and the spec output will be
+```
+  when refunding an order
+    login
+    place order
+    pay for order
+    ship order because we received payment
+    refund order
+    returns-processing starts and a refund is pending
+```
+
+You might be tempted to think, I can just do:
+```ruby
+  context "when refunding an order" do
+    it "returns-processing starts and a refund is pending" do
+      message = client.login(*creds)
+      expect(message).to eq("Welcome")
+
+      message = client.place_order(order_details)
+      expect(message).to eq("Order placed. Picking started")
+
+      sleep 2
+      message = client.pay_for_order(order_details)
+      expect(message).to eq("Payment received, thank you.")
+
+      sleep 1
+      message = client.ship_order(order_details)
+      expect(message).to eq("Order shipped")
+
+      sleep 2
+      message = client.refund_order(order_details)
+      expect(message).to eq("Order returns processing started, you will receive a refund when we receive the goods back")
+    end
+  end
+```
+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.
+```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])
+      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]])
+    end
+  end
+end
+```
+
+### API
+
+There are two class level constructional methods:
+```ruby
+  run(description = '', &block) # block runs without delay
+  run_after(delay, description = '', &block) # block runs after delay seconds
+```
+
+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
+```
+Note that the description is optional, however by adding a description you document the action in the code and the spec output.
+
+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.
+
+### Please 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elastic/rspec-sequencing.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec/sequencing.rb

@@ -0,0 +1,64 @@
+require 'concurrent'
+
+module RSpec
+  class Sequencing
+    def self.run(description = '', &block)
+      run_after(0, description, &block)
+    end
+
+    def self.run_after(delay, description = '', &block)
+      new.then_after(delay, description, &block)
+    end
+
+    def initialize
+      @flow = nil
+    end
+
+    def then_after(delay, description = '', &block)
+      @flow = dataflow(delay, description, [@flow], &block)
+      self
+    end
+
+    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
+    end
+
+    def activate
+      # use this method if you define the sequencing in a let block
+      # so RSpec runs it
+      formatted_puts "sequence activated"
+    end
+
+    def value
+      @flow.value
+    end
+
+    private
+
+    def formatted_puts(text)
+      return if text.empty? || !doc_formatter?
+      txt = RSpec.configuration.format_docstrings_block.call(text)
+      RSpec.configuration.output_stream.puts "    #{txt}"
+    end
+
+    def doc_formatter?
+      @doc_formatter ||= RSpec.configuration.formatters.first.is_a?(
+        RSpec::Core::Formatters::DocumentationFormatter)
+    end
+  end
+end

data/lib/rspec_sequencing.rb

@@ -0,0 +1 @@
+require "rspec/sequencing"

data/rspec-sequencing.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-sequencing"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Elastic"]
+  spec.email         = ["info@elastic.co"]
+
+  spec.summary       = "Define sequenced actions that simulate real-world scenarios"
+  spec.homepage      = "https://github.com/elastic/rspec-sequencing"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", ">= 3.0.0"
+  spec.add_runtime_dependency "concurrent-ruby"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sequencing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-01-19 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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+- info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec/sequencing.rb
+- lib/rspec_sequencing.rb
+- rspec-sequencing.gemspec
+homepage: https://github.com/elastic/rspec-sequencing
+licenses: []
+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.8
+signing_key:
+specification_version: 4
+summary: Define sequenced actions that simulate real-world scenarios
+test_files: []