towel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68eca600df5e66fcd66ff9eb9a6da854e87c119f00009d84bf1ed89d2877c987
-  data.tar.gz: 716f88d28f357cbe649de0eff946195fca8e0f46331a5094fa6b73c7e68ea0aa
+  metadata.gz: 4c801c1b0875a6adef94c5c999b78faa1e30a1915f88d1b8bd00ac9116bff8ff
+  data.tar.gz: b65d98d9d20b055089d4b71e85e221c54d9dfbe31381df6187f124ad475142c3
 SHA512:
-  metadata.gz: 6756fd95bb799753858ea7a831007221a535dd40b4cac855367e9f257d3ad089f39621a8a247b3c02806fffe77d684e20c73ae52d451980b57ed303446d281a6
-  data.tar.gz: fb398200fb9b52ec72d19c0c3e25305d471546ed2b3884d30ca24771377a2293df67c778d24285434bb5ff945a76076dc86608e12861195e7a8baa9b8681efce
+  metadata.gz: 891f98b490fcd6a6158f3c7e477295f3fb8bc2ffde9f727b4b035995f68235895f0c474057bed38cc28112dc7bfb999ded2708f85ba21a88cf0aa1c12fbf2470
+  data.tar.gz: f2b5fed2e95665584de1e048855e494f286266e4ef450a088f46fe4bb2dccc8d6f0f8a85ccf86155fae8f17e8561fbceb00652fe918cfa38246b6c02ae6b9e44

data/README.md

@@ -1,28 +1,14 @@
 # Towel
 
-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`. 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'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install towel
+[Towel](https://towel.dev) is a test results collector. As you run tests, Towel streams them to its storage service and displays them in your web browser. You can search for and filter results, see nicely formatted errors, dig into test logs, view artifacts such as screenshots, and more.
 
 ## Usage
 
-TODO: Write usage instructions here
+This repository holds several gems:
+
+* `towel` -- The base gem that contains gRPC-generated code and support code that applies to all test frameworks. You won't use this directly.
+* [towel-minitest](extensions/towel-minitest/README.md) -- Supports collecting Minitest results.
+* [towel-rspec](extensions/towel-rspec/README.md) -- Supports collecting RSpec results.
 
 ## Development
 
@@ -32,7 +18,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/towel. 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.
+Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/VelvetSoftware/towel-ruby. 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
 
@@ -40,4 +26,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Towel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/towel/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Towel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://bitbucket.org/VelvetSoftware/towel-ruby/src/master/CODE_OF_CONDUCT.md).

data/extensions/towel-minitest/examples/.towel.toml

@@ -35,3 +35,5 @@ project = "dynamite"
 [labels]
 branch = "master"
 environment = "test"
+language = "ruby"
+framework = "minitest"

data/extensions/towel-rspec/examples/.rspec

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

data/extensions/towel-rspec/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/extensions/towel-rspec/examples/simple_spec.rb

@@ -7,7 +7,9 @@ RSpec.describe Foo do
     end
 
     it "stays cool"
-    it "never gives up"
+    it "never gives up" do
+      sleep 10
+    end
   end
 
   describe "#bar" do

data/extensions/towel-rspec/lib/towel/rspec/formatter.rb

@@ -10,14 +10,48 @@ module Towel
                                                :close
 
       def initialize(io)
-        super(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)
@@ -25,12 +59,14 @@ module Towel
         example = notification.example
         group = example_group.described_class.to_s + example_group.description
 
-        puts "CALLING create_result(#{group.inspect}, #{example.id.inspect})"
         context = @session.create_result(
           group,
           example.id,
           display_name: example.description
         )
+
+        @stdout.context = context
+        @stderr.context = context
       end
 
       def example_finished(notification)
@@ -39,24 +75,48 @@ module Towel
         group = example_group.described_class.to_s + example_group.description
 
         state = case example.execution_result.status
-                when :passed then Towel::ResultState::PASSED
-                when :failed then Towel::ResultState::FAILURE
-                when :pending then Towel::ResultState::SKIPPED
-                else
-                  status = example.execution_result.status
-                  raise RuntimeError, "Unknown RSpec result state '#{status}'"
+                when :passed then Towel::V1alpha::ResultState::SUCCESS
+                when :failed then Towel::V1alpha::ResultState::FAILURE
+                when :pending then Towel::V1alpha::ResultState::SKIPPED
                 end
 
-        @session.update_result(
-          group,
-          example.id,
-          state: state
-        )
+        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
-        @session.finish_invocation
+
+        $stdout = @previous_stdout
+        $stderr = @previous_stderr
+
+        unless @cancel_queue.closed?
+          @session.finish_invocation
+        end
       end
     end
   end

data/lib/towel/session.rb

@@ -25,7 +25,6 @@ module Towel
     def create_invocation
         invocation = Towel::V1alpha::Invocation.new
         invocation.project = @project
-        invocation.labels["language"] = "ruby"
         @config["labels"].each {|k, v| invocation.labels[k] = v }
         invocation.start_time = Time.now.utc
 

data/lib/towel/version.rb

@@ -1,3 +1,3 @@
 module Towel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/towel.gemspec

@@ -33,7 +33,7 @@ END
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "generated"]
 
-  spec.add_dependency "concurrent-ruby", "~> 1.1"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
   spec.add_dependency "grpc", "~> 1.22"
   spec.add_dependency "toml", "~> 0.2"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: towel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - extensions/towel-rspec/bin/console
 - extensions/towel-rspec/bin/setup
 - extensions/towel-rspec/examples/.rspec
+- extensions/towel-rspec/examples/.towel.toml
 - extensions/towel-rspec/examples/simple_spec.rb
 - extensions/towel-rspec/lib/towel/rspec.rb
 - extensions/towel-rspec/lib/towel/rspec/formatter.rb