towel 0.1.0

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

@@ -0,0 +1,2 @@
+--require towel/rspec
+--format Towel::RSpec::Formatter

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

@@ -0,0 +1,22 @@
+Foo = Class.new
+
+RSpec.describe Foo do
+  describe "#foo" do
+    it "acts normally" do
+      puts "OK"
+    end
+
+    it "stays cool"
+    it "never gives up"
+  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/extensions/towel-rspec/lib/towel/rspec/formatter.rb

@@ -0,0 +1,63 @@
+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(io)
+        @session = Towel::Session.new
+      end
+
+      def start(_notification)
+        super
+        url = @session.create_invocation
+        puts "View test results at #{url}"
+      end
+
+      def example_started(notification)
+        example_group = notification.example.example_group
+        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
+        )
+      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::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}'"
+                end
+
+        @session.update_result(
+          group,
+          example.id,
+          state: state
+        )
+      end
+
+      def close(_notification)
+        super
+        @session.finish_invocation
+      end
+    end
+  end
+end

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

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

data/extensions/towel-rspec/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/extensions/towel-rspec/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/extensions/towel-rspec/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

data/generated/.gitignore

@@ -0,0 +1 @@
+*

data/generated/towel/v1alpha/collector_pb.rb

@@ -0,0 +1,61 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: towel/v1alpha/collector.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+require 'towel/v1alpha/towel_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("towel/v1alpha/collector.proto", :syntax => :proto3) do
+    add_message "towel.v1alpha.CreateInvocationRequest" do
+      optional :invocation, :message, 1, "towel.v1alpha.Invocation"
+    end
+    add_message "towel.v1alpha.CreateGroupRequest" do
+      optional :group, :message, 1, "towel.v1alpha.Group"
+    end
+    add_message "towel.v1alpha.CreateResultRequest" do
+      optional :result, :message, 1, "towel.v1alpha.Result"
+    end
+    add_message "towel.v1alpha.UpdateResultRequest" do
+      optional :result, :message, 1, "towel.v1alpha.Result"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "towel.v1alpha.CreateLogRequest" do
+      optional :log, :message, 1, "towel.v1alpha.Log"
+    end
+    add_message "towel.v1alpha.AppendLogRequest" do
+      optional :name, :string, 1
+      repeated :entries, :message, 2, "towel.v1alpha.LogEntry"
+    end
+    add_message "towel.v1alpha.AppendLogResponse" do
+    end
+    add_message "towel.v1alpha.FinishInvocationRequest" do
+      optional :name, :string, 1
+      optional :end_time, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "towel.v1alpha.FinishInvocationResponse" do
+    end
+    add_message "towel.v1alpha.CancelInvocationRequest" do
+      optional :name, :string, 1
+    end
+    add_message "towel.v1alpha.CancelInvocationResponse" do
+    end
+  end
+end
+
+module Towel
+  module V1alpha
+    CreateInvocationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CreateInvocationRequest").msgclass
+    CreateGroupRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CreateGroupRequest").msgclass
+    CreateResultRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CreateResultRequest").msgclass
+    UpdateResultRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.UpdateResultRequest").msgclass
+    CreateLogRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CreateLogRequest").msgclass
+    AppendLogRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.AppendLogRequest").msgclass
+    AppendLogResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.AppendLogResponse").msgclass
+    FinishInvocationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.FinishInvocationRequest").msgclass
+    FinishInvocationResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.FinishInvocationResponse").msgclass
+    CancelInvocationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CancelInvocationRequest").msgclass
+    CancelInvocationResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.CancelInvocationResponse").msgclass
+  end
+end

data/generated/towel/v1alpha/collector_services_pb.rb

@@ -0,0 +1,41 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: towel/v1alpha/collector.proto for package 'towel.v1alpha'
+
+require 'grpc'
+require 'towel/v1alpha/collector_pb'
+
+module Towel
+  module V1alpha
+    module Collector
+      # Collector is the low-level interface to stream test/build/cron results to
+      # Towel.
+      class Service
+
+        include GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'towel.v1alpha.Collector'
+
+        # Start recording a new invocation.
+        rpc :CreateInvocation, CreateInvocationRequest, Invocation
+        # Add a new group under which results or other groups can be placed.
+        rpc :CreateGroup, CreateGroupRequest, Group
+        # Add a new result.
+        rpc :CreateResult, CreateResultRequest, Result
+        # Update the progress of a result.
+        rpc :UpdateResult, UpdateResultRequest, Result
+        # Start recording a new log file.
+        rpc :CreateLog, CreateLogRequest, Log
+        # Append entries to a log.
+        rpc :AppendLog, AppendLogRequest, AppendLogResponse
+        # Finalize an invocation that was previously started.
+        rpc :FinishInvocation, FinishInvocationRequest, FinishInvocationResponse
+        # Declare an in-progress invocation as cancelled.
+        rpc :CancelInvocation, CancelInvocationRequest, CancelInvocationResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end

data/generated/towel/v1alpha/towel_pb.rb

@@ -0,0 +1,88 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: towel/v1alpha/towel.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("towel/v1alpha/towel.proto", :syntax => :proto3) do
+    add_message "towel.v1alpha.Invocation" do
+      optional :name, :string, 1
+      optional :url, :string, 8
+      optional :project, :string, 2
+      map :labels, :string, :string, 3
+      optional :platform, :message, 9, "towel.v1alpha.Platform"
+      optional :hostname, :string, 10
+      optional :user, :string, 11
+      optional :working_dir, :string, 12
+      repeated :argv, :string, 13
+      map :env_vars, :string, :string, 14
+      optional :revision, :string, 15
+      optional :create_time, :message, 4, "google.protobuf.Timestamp"
+      optional :update_time, :message, 5, "google.protobuf.Timestamp"
+      optional :start_time, :message, 6, "google.protobuf.Timestamp"
+      optional :end_time, :message, 7, "google.protobuf.Timestamp"
+    end
+    add_message "towel.v1alpha.Platform" do
+      optional :os, :string, 1
+      optional :os_version, :string, 2
+      optional :arch, :string, 3
+    end
+    add_message "towel.v1alpha.Group" do
+      optional :name, :string, 1
+      optional :parent_group, :string, 2
+      optional :display_name, :string, 3
+    end
+    add_message "towel.v1alpha.Result" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      optional :state, :enum, 3, "towel.v1alpha.ResultState"
+      optional :attempt, :int32, 4
+      optional :description, :string, 5
+      optional :start_time, :message, 6, "google.protobuf.Timestamp"
+      optional :duration, :message, 7, "google.protobuf.Duration"
+      repeated :timespans, :message, 8, "towel.v1alpha.Timespan"
+    end
+    add_message "towel.v1alpha.Timespan" do
+      optional :display_name, :string, 1
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :duration, :message, 3, "google.protobuf.Duration"
+    end
+    add_message "towel.v1alpha.Log" do
+      optional :name, :string, 1
+      optional :size, :int64, 2
+      optional :create_time, :message, 3, "google.protobuf.Timestamp"
+      optional :update_time, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_message "towel.v1alpha.LogEntry" do
+      optional :entry_id, :int64, 1
+      optional :parent, :string, 2
+      optional :log_time, :message, 3, "google.protobuf.Timestamp"
+      optional :contents, :string, 4
+    end
+    add_enum "towel.v1alpha.ResultState" do
+      value :QUEUED, 0
+      value :RUNNING, 1
+      value :SUCCESS, 2
+      value :FAILURE, 3
+      value :ERROR, 4
+      value :ENVIRONMENT_ERROR, 5
+      value :CANCELLED, 6
+      value :SKIPPED, 7
+    end
+  end
+end
+
+module Towel
+  module V1alpha
+    Invocation = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Invocation").msgclass
+    Platform = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Platform").msgclass
+    Group = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Group").msgclass
+    Result = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Result").msgclass
+    Timespan = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Timespan").msgclass
+    Log = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.Log").msgclass
+    LogEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.LogEntry").msgclass
+    ResultState = Google::Protobuf::DescriptorPool.generated_pool.lookup("towel.v1alpha.ResultState").enummodule
+  end
+end

data/lib/towel/configuration.rb

@@ -0,0 +1,82 @@
+module Towel
+  # Loads and merges configuration settings for Towel.
+  class Configuration
+    # Acceptable filenames in which to define Towel settings. These will be
+    # read in the defined order.
+    FILENAMES = %w[Towel.toml towel.toml .Towel.toml .towel.toml].freeze
+
+    # Read the configuration from files and environment variables.
+    def self.read
+      # Load configuration from files, starting in the current working directory
+      # and working upwards in the filesystem hierarchy until no configuration
+      # files are found.
+      files = []
+
+      directory = Dir.pwd
+      while true
+        FILENAMES.each do |filename|
+          possible_file = File.join(directory, filename)
+          files << possible_file if File.exist?(possible_file)
+        end
+
+        parent = File.expand_path("..", directory)
+        if directory == parent
+          break
+        else
+          directory = parent
+        end
+      end
+
+      # Combine all discovered files into one configuration.
+      config = files
+        .reverse
+        .map { |file| TOML.load_file(file) }
+        .inject({}) do |acc, toml|
+          acc.merge(toml) do |key, old, new|
+            case old
+            when Hash then old.merge(new)
+            else
+              new
+            end
+          end
+        end
+
+      # Override with environment variables where appropriate.
+      override = ->(env, section, key) do
+        if ENV.key?(env)
+          section_values = config[section] || {}
+          section_values[key] = ENV[env]
+          config[section] = section_values
+        end
+      end
+      override.call("TOWEL_API_KEY", "auth", "api_key")
+      override.call("TOWEL_ACCOUNT", "auth", "account")
+      override.call("TOWEL_ADDRESS", "collector", "address")
+
+      new(config)
+    end
+
+    # Creates a new configuration from a Hash.
+    def initialize(hash = {})
+      @config = {
+        "auth" => {
+          "account" => nil,
+          "api_key" => nil
+        },
+        "collector" => {
+          "address" => "towel.dev",
+          "organization" => nil,
+          "project" => nil
+        },
+        "labels" => {}
+      }
+      @config.merge!(hash)
+      @config.freeze
+    end
+
+    # Retrieves a configuration section ("auth", "collector", "labels", etc).
+    def [](key)
+      @config[key]
+    end
+  end
+end