cross_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d38aa581806d1683766f7ee70c3dc0236152e46a
+  data.tar.gz: a03f9af4c9f5d9023e7fe6e3929312c81d21e42e
+SHA512:
+  metadata.gz: 0fb4744501e0a442bb053fe886dce327c415a165188256ea1c5145fa00475a54ce8a69c3c8abac69187eb8e86e8e734745ba8b6871ac53c3c6c15aba11984faf
+  data.tar.gz: 4e5d9ae00e2d9e9a849bd29b3f13f079dfad7322ef593c4868a7c7425d7832301cd9e3fdc4d6b361e2382b6c469627c80268bb66e5fdf541c798a5417cce1af8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cross_spec.gemspec
+gemspec
+gem "distributed_tracing", path: "../distributed_tracing_ruby"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ben Fischer
+
+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,75 @@
+# CrossSpec
+
+A utility library for marking cross app testing easier with tools for distributed factories, test parallelism, and verification of async events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cross_spec'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Listen for service requests in your app
+```ruby
+CrossSpec.handle("app1:create_user") do
+  # create a user in here
+  # then tell the spec that the data is ready
+  CrossSpec.beacon("app1:user_created", {id: 123})
+end
+
+CrossSpec.listen! # blocks forever
+```
+
+### Notify of side effects in your app
+```ruby
+CrossSpec.beacon("app1:background_job1_success")
+```
+
+### Notify of failures in your app
+```ruby
+CrossSpec.failure_beacon!
+```
+
+### Ask for data in a spec and wait for it
+```ruby
+CrossSpec::Spec.trace do
+  user = sync(service: "app1:create_user", {email: "email@example.com"}, tasks: "app1:user_created")
+  user["id"] # 123
+end
+```
+
+### Ask for data in a spec async and wait for it later
+```ruby
+CrossSpec::Spec.trace do
+  async(service: "app1:create_user", {email: "email@example.com"})
+  async(service: "app2:create_blogpost", {title: "Read me"})
+  # keep doing things if you want ...
+
+  # block until the data is all ready
+  user, blogpost = await(tasks: ["app1:user_created", "app2:blogpost_created"])
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bundle exec rspec` to run the tests.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cross_spec.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cross_spec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cross_spec.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cross_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cross_spec"
+  spec.version       = CrossSpec::VERSION
+  spec.authors       = ["Ben Fischer"]
+  spec.email         = ["bfischer@doximity.com"]
+
+  spec.summary       = %q{A framework for doing cross app testing with support for distributed factories, test parallelism, and verification of async events.}
+  spec.description   = %q{A framework for doing cross app testing with support for distributed factories, test parallelism, and verification of async events.}
+  spec.homepage      = "https://github.com/doximity/cross_spec_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "ruby-kafka"
+  spec.add_dependency "distributed_tracing"
+end

data/lib/cross_spec/client.rb

@@ -0,0 +1,35 @@
+module CrossSpec
+  class Client
+    def initialize(driver, handlers = {})
+      @driver = driver
+      @handlers = Hash(handlers)
+    end
+
+    def broadcast(str)
+      @driver.broadcast(str)
+    end
+
+    def listen!(&block)
+      @driver.each_message do |message|
+        json = JSON.parse(message)
+        message = if json.key?("service")
+          ServiceMessage.from_json(json)
+        elsif json.key?("task")
+          TaskMessage.from_json(json)
+        end
+
+        next unless message
+
+        result = if block_given?
+          yield message
+        elsif message.is_a?(TaskMessage) && @handlers[message.task]
+          @handlers[message.task].call(message)
+        elsif message.is_a?(ServiceMessage) && @handlers[message.service]
+          @handlers[message.service].call(message)
+        end
+
+        return unless result.nil?
+      end
+    end
+  end
+end

data/lib/cross_spec/config.rb

@@ -0,0 +1,33 @@
+module CrossSpec
+  class Config
+    def client
+      return @client if defined?(@client)
+      self.client = Client.new(KafkaClient.new(kafka), handlers)
+      @client
+    end
+
+    def handlers
+      @handlers ||= {}
+    end
+
+    def kafka_connection_string
+      return @kafka_connection_string if defined?(@kafka_connection_string)
+      self.kafka_connection_string = "localhost"
+      @kafka_connection_string
+    end
+
+    attr_writer :client, :handlers
+
+    def kafka_connection_string=(value)
+      @kafka_connection_string = value
+      @kafka = Kafka.new(seed_brokers: @kafka_connection_string)
+      value
+    end
+
+    private
+
+    def kafka
+      @kafka ||= Kafka.new(seed_brokers: kafka_connection_string)
+    end
+  end
+end

data/lib/cross_spec/kafka_client.rb

@@ -0,0 +1,22 @@
+module CrossSpec
+  class KafkaClient
+    TOPIC = "cross-spec.messages"
+    def initialize(kafka)
+      @kafka = kafka
+    end
+
+    def broadcast(str)
+      @kafka.deliver_message(str, topic: TOPIC)
+    end
+
+    def each_message(&block)
+      consumer = @kafka.consumer(group_id: group_id)
+      consumer.subscribe(TOPIC)
+      consumer.each_message(&block)
+    end
+
+    def group_id
+      @group_id ||= "cross-spec-#{SecureRandom.hex}"
+    end
+  end
+end

data/lib/cross_spec/message.rb

@@ -0,0 +1,14 @@
+module CrossSpec
+  class Message
+    def initialize(data: nil, biomarkers: nil)
+      @data = data
+      @biomarkers = Array(biomarkers)
+    end
+
+    attr_reader :data, :biomarkers
+
+    def origin_biomarker
+      @biomarkers.last
+    end
+  end
+end

data/lib/cross_spec/service_message.rb

@@ -0,0 +1,18 @@
+module CrossSpec
+  class ServiceMessage < Message
+    def initialize(service:, data: nil, biomarkers: nil)
+      super(data: data, biomarkers: biomarkers)
+      @service = service
+    end
+
+    attr_reader :service
+
+    def self.from_json(json)
+      new(
+        service: json["service"],
+        data: json["data"],
+        biomarkers: json["biomarkers"]
+      )
+    end
+  end
+end

data/lib/cross_spec/spec.rb

@@ -0,0 +1,84 @@
+module CrossSpec
+  class SpecWaiting
+    def initialize(tasks)
+      @positive_matches = 0
+      @data = []
+      @tasks = Array(tasks)
+    end
+
+    def process(message, &block)
+      return unless message.is_a?(TaskMessage)
+      return unless @tasks.include?(message.task)
+
+      positive_match = if block
+        yield message.data, message.biomarkers
+      elsif DistributedTracing.get.any?
+        (message.biomarkers & DistributedTracing.get).any?
+      else
+        false
+      end
+
+      if positive_match
+        increment_matches
+        store_data(message)
+      end
+    end
+
+    def done?
+      @positive_matches === @tasks.length
+    end
+
+    def data
+      @data
+    end
+
+    private
+
+    def increment_matches
+      @positive_matches += 1
+    end
+
+    def store_data(message)
+      i = @tasks.index(message.task)
+      @data[i] = message.data
+    end
+  end
+
+  class Spec
+    def self.trace(&block)
+      spec = new
+      DistributedTracing.trace do
+        spec.instance_eval(&block)
+      end
+    end
+
+    def async(service:, data: nil)
+      DistributedTracing.trace do
+        str = JSON.dump(
+          service: service,
+          biomarkers: DistributedTracing.get,
+          data: data
+        )
+        CrossSpec.broadcast(str)
+      end
+      nil
+    end
+
+    def sync(service:, data: nil, tasks:, options: {}, &block)
+      async(service: service, data: data)
+      await(tasks: tasks, options: options, &block)
+    end
+
+    def await(tasks:, options: {}, &block)
+      combined = { timeout: 5 }.merge(options)
+      waiting = SpecWaiting.new(tasks)
+      ::Timeout::timeout(combined[:timeout]) do
+        CrossSpec.listen! do |message|
+          waiting.process(message, &block)
+          return waiting.data.length == 1 ? waiting.data.first : waiting.data if waiting.done?
+          nil # nil keeps blocking listen!
+        end
+      end
+    end
+  end
+end

data/lib/cross_spec/task_message.rb

@@ -0,0 +1,18 @@
+module CrossSpec
+  class TaskMessage < Message
+    def initialize(task:, data: nil, biomarkers: nil)
+      super(data: data, biomarkers: biomarkers)
+      @task = task
+    end
+
+    attr_reader :task
+
+    def self.from_json(json)
+      new(
+        task: json["task"],
+        data: json["data"],
+        biomarkers: json["biomarkers"]
+      )
+    end
+  end
+end

data/lib/cross_spec/version.rb

@@ -0,0 +1,3 @@
+module CrossSpec
+  VERSION = "0.1.0"
+end

data/lib/cross_spec.rb

@@ -0,0 +1,59 @@
+require "cross_spec/version"
+require "rubygems"
+require "bundler/setup"
+Bundler.setup
+require "distributed_tracing"
+require "json"
+require "kafka"
+require "securerandom"
+require "timeout"
+
+module CrossSpec
+  class FailureBeacon < StandardError; end
+  FAIL_TASK = "cross_spec:failure".freeze
+
+  autoload :Beacon,           "cross_spec/beacon"
+  autoload :Client,           "cross_spec/client"
+  autoload :Config,           "cross_spec/config"
+  autoload :KafkaClient,      "cross_spec/kafka_client"
+  autoload :Message,          "cross_spec/message"
+  autoload :Spec,             "cross_spec/spec"
+  autoload :SpecWaiting,      "cross_spec/spec"
+  autoload :ServiceMessage,   "cross_spec/service_message"
+  autoload :TaskMessage,      "cross_spec/task_message"
+
+  def self.configure
+    @config = Config.new
+    yield(@config)
+  end
+
+  def self.config
+    return @config if defined?(@config)
+    @config = Config.new
+    @config
+  end
+
+  def self.handle(service, &block)
+    config.handlers[service] = Proc.new do |*args|
+      block.call(*args)
+      nil
+    end
+  end
+
+  def self.listen!
+    config.client.listen!
+  end
+
+  def self.failure_beacon!(data = nil)
+    beacon(FAIL_TASK, data)
+  end
+
+  def self.beacon(task, data = nil, biomarkers = nil)
+    str = JSON.dump(
+      task: task,
+      biomarkers: biomarkers || DistributedTracing.get,
+      data: data
+    )
+    config.client.broadcast(str)
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: cross_spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Fischer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  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: distributed_tracing
+  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: A framework for doing cross app testing with support for distributed
+  factories, test parallelism, and verification of async events.
+email:
+- bfischer@doximity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cross_spec.gemspec
+- lib/cross_spec.rb
+- lib/cross_spec/client.rb
+- lib/cross_spec/config.rb
+- lib/cross_spec/kafka_client.rb
+- lib/cross_spec/message.rb
+- lib/cross_spec/service_message.rb
+- lib/cross_spec/spec.rb
+- lib/cross_spec/task_message.rb
+- lib/cross_spec/version.rb
+homepage: https://github.com/doximity/cross_spec_ruby
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A framework for doing cross app testing with support for distributed factories,
+  test parallelism, and verification of async events.
+test_files: []