towel-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cc10be7a1c89656bbd2a694f453970eada08fe806ebcec895909256b4f6955b
+  data.tar.gz: c6554e265d94defbecbe57648109009327783002a5d7c9b91da733a4b39adf43
+SHA512:
+  metadata.gz: dad5755c7d1c22541c2455291d54a3de3b655d4a69ecdc7714ec679f9846ae2f3d31e5f4a704e660fd8a8a7c91f469e6ae5b0384d96138919ef5057ae2948e4e
+  data.tar.gz: 2618ee82ffdbd5099ea43730a6ac5f569f3082d9345fa3e19d27f4a852efb914594911fee0fcd7f4f45b456a49dd20c29b16ac87877b37cdd84a969847829ab4

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in towel-rspec.gemspec
+gemspec

data/README.md

@@ -0,0 +1,43 @@
+# Towel::Rspec
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/towel/rspec`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'towel-rspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install towel-rspec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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]/towel-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Towel::Rspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/towel-rspec/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "towel/rspec"
+
+# 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/examples/.rspec

@@ -0,0 +1,3 @@
+--no-color
+--require towel/rspec
+--format Towel::RSpec::Formatter

data/examples/.towel.toml

@@ -0,0 +1,39 @@
+# This is an example configuration file for Towel. It shows most of the
+# different options that can be set, even though a normal config file will only
+# have a subset of options specified. Towel uses TOML for configuration. It's a
+# lot like INI, but well-defined. To get a feel for the syntax, look at
+# https://github.com/toml-lang/toml/blob/v0.5.0/README.md
+
+
+[auth]
+# The Towel account that is reporting invocations. This is how your invocations
+# are linked to you.
+account = "wile.e.coyote@acme.corp"
+
+# The API key to communicate with. DO NOT commit this or make this public to
+# others that you do not want them to be able to report to Towel.
+api_key = "AezKF3gPPyzD8dvgDYFYF9we5YP4R87UqhTzDxs3CnkY"
+
+
+[collector]
+# Where should results be reported to. This should be a hostname and port if
+# non-standard (443). This allows you to point against different Towel instances
+# (staging for example).
+address = "localhost:10081"
+
+# The organization handle for the organization that holds your Towel projects.
+organization = "acme"
+
+# The project handle for the project that invocations should be reported under.
+project = "dynamite"
+
+
+# This section is free-form. You can add whatever labels you would like to
+# appear on all invocations reported using this configuration. This is useful
+# for per-branch or per-environment annotations. NOTE: Only string values are
+# allowed here.
+[labels]
+branch = "master"
+environment = "test"
+language = "ruby"
+framework = "rspec"

data/examples/simple_spec.rb

@@ -0,0 +1,24 @@
+Foo = Class.new
+
+RSpec.describe Foo do
+  describe "#foo" do
+    it "acts normally" do
+      puts "OK"
+    end
+
+    it "stays cool"
+    it "never gives up" do
+      sleep 10
+    end
+  end
+
+  describe "#bar" do
+    it "is a little unsure of itself" do
+      raise ArgumentError, "Not sure of myself"
+    end
+
+    it "needs affirmation" do
+      expect(false).to eq(true)
+    end
+  end
+end

data/lib/towel/rspec.rb

@@ -0,0 +1,13 @@
+# Gems
+require "rspec/core"
+require "towel"
+
+require "towel/rspec/formatter"
+require "towel/rspec/version"
+
+module Towel
+  module RSpec
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/towel/rspec/formatter.rb

@@ -0,0 +1,123 @@
+require "rspec/core/formatters/base_formatter"
+
+module Towel
+  module RSpec
+    # Takes RSpec events and turns them into a streaming upload to Towel.
+    class Formatter < ::RSpec::Core::Formatters::BaseFormatter
+      ::RSpec::Core::Formatters.register self, :start,
+                                               :example_started,
+                                               :example_finished,
+                                               :close
+
+      def initialize(io)
+        super
+        @session = Towel::Session.new
+        @stdout = nil
+        @stderr = nil
+        @previous_stdout = nil
+        @previous_stderr = nil
+        @cancel_queue = Queue.new
+
+        # Start a thread to listen for cancellations. Cancel the invocation if
+        # requested. This exists because gRPC requests may not be made directly
+        # from within a signal handler. It appears that RSpec shutdown runs as
+        # such.
+        Thread.new do
+          cancelled = @cancel_queue.pop
+          @session.cancel_invocation if cancelled
+        end
+      end
+
+      def start(_notification)
+        super
+
+        url = @session.create_invocation
+        puts "View test results at #{url}"
+
+        # Register a cancellation handler
+        old_handler = Signal.trap("INT") do
+          @cancel_queue << true
+          # Mark the queue as closed so that other observers can determine if
+          # the run has been cancelled or not.
+          @cancel_queue.close
+          if old_handler.respond_to?(:call)
+            old_handler.call
+          else
+            raise Interrupt
+          end
+        end
+
+        # Capture logs
+        @previous_stdout = $stdout
+        $stdout = @stdout = Towel::LogIO.new(@session.create_log("STDOUT"))
+        @previous_stderr = $stderr
+        $stderr = @stderr = Towel::LogIO.new(@session.create_log("STDERR"))
+      end
+
+      def example_started(notification)
+        example_group = notification.example.example_group
+        example = notification.example
+        group = example_group.described_class.to_s + example_group.description
+
+        context = @session.create_result(
+          group,
+          example.id,
+          display_name: example.description
+        )
+
+        @stdout.context = context
+        @stderr.context = context
+      end
+
+      def example_finished(notification)
+        example_group = notification.example.example_group
+        example = notification.example
+        group = example_group.described_class.to_s + example_group.description
+
+        state = case example.execution_result.status
+                when :passed then Towel::V1alpha::ResultState::SUCCESS
+                when :failed then Towel::V1alpha::ResultState::FAILURE
+                when :pending then Towel::V1alpha::ResultState::SKIPPED
+                end
+
+        duration = nil
+        unless state == Towel::V1alpha::ResultState::SKIPPED
+          duration = example.execution_result.run_time
+        end
+
+        description = nil
+        if state == Towel::V1alpha::ResultState::SKIPPED
+          description = example.execution_result.pending_message
+        elsif state == Towel::V1alpha::ResultState::FAILURE
+          description = example.execution_result.exception.message
+        end
+
+        # Cannot make a gRPC call from a signal handler, so check to make sure
+        # we aren't operating from one.
+        unless @cancel_queue.closed?
+          @session.update_result(
+            group,
+            example.id,
+            state: state,
+            duration: duration,
+            description: description
+          )
+        end
+
+        @stdout.context = nil
+        @stderr.context = nil
+      end
+
+      def close(_notification)
+        super
+
+        $stdout = @previous_stdout
+        $stderr = @previous_stderr
+
+        unless @cancel_queue.closed?
+          @session.finish_invocation
+        end
+      end
+    end
+  end
+end

data/lib/towel/rspec/version.rb

@@ -0,0 +1,5 @@
+module Towel
+  module RSpec
+    VERSION = "0.1.0"
+  end
+end

data/towel-rspec.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "towel/rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "towel-rspec"
+  spec.version       = Towel::RSpec::VERSION
+  spec.authors       = ["Andrew Smith"]
+  spec.email         = ["andrew@velvet.software"]
+
+  spec.summary       = "Towel integration for collecting results from RSpec"
+  spec.description   = <<END
+Towel collects test results as they run, reporting them to towel.dev for easier
+inspection, debugging, and sharing.
+END
+  spec.homepage      = "https://towel.dev"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://bitbucket.org/VelvetSoftware/towel-ruby"
+    spec.metadata["changelog_uri"] = "https://bitbucket.org/VelvetSoftware/towel-ruby/src/master/extensions/towel-rspec/CHANGELOG.md"
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "rspec-core", "~> 3"
+  spec.add_dependency "towel", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: towel-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: towel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |
+  Towel collects test results as they run, reporting them to towel.dev for easier
+  inspection, debugging, and sharing.
+email:
+- andrew@velvet.software
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/.rspec
+- examples/.towel.toml
+- examples/simple_spec.rb
+- lib/towel/rspec.rb
+- lib/towel/rspec/formatter.rb
+- lib/towel/rspec/version.rb
+- towel-rspec.gemspec
+homepage: https://towel.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://towel.dev
+  source_code_uri: https://bitbucket.org/VelvetSoftware/towel-ruby
+  changelog_uri: https://bitbucket.org/VelvetSoftware/towel-ruby/src/master/extensions/towel-rspec/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Towel integration for collecting results from RSpec
+test_files: []