cucumber-pro 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2f9c9dbcd22da3dd2ba2f4425bdedf75ad38e81
-  data.tar.gz: 09b7f4082579620d02cd18ee40a69c478b954c75
+  metadata.gz: a57bcad6666fb5df2180cb02c2206bc18fe2bf99
+  data.tar.gz: 5957942d5725e1f253d222763e2e2493aaa69307
 SHA512:
-  metadata.gz: 353dfdd453bed887ec481e1e612e6aaf778fdb5343520dcb7336f292c1c4e64cf1a79fc012c78fe067fba81824f25becbe6fcaa9bbde61ae3602527d4bcf05a7
-  data.tar.gz: 39c8b407a6640993f972b1a04c2537a8b5f3e5488afde5040fee2e2249c88308bb3e4e4f6eedd2d275455a4b82ee0d9a5fb13c84b1a9e0e3d6bd775d7775c266
+  metadata.gz: 47a6059e95e4e5c381f33d74f2875785cfba2ca3a0cb47d77427b4fb8200cd6d33dcac1e9ab4dc83002eb676a418abdfb3b7a379172b64db0cbda4bf3dd8810a
+  data.tar.gz: c4efd4814be45731a516aeb7247584cab215696b6a280bfd2fa922641e9108f03bdf4bb30014452d8f7332b59c61d3d42e9a9fc3a636a91c0043d6c6d304b8ce

data/lib/cucumber/pro/README.md

@@ -0,0 +1,153 @@
+Metarepo is a service for storing and retrieving metadata about files in
+a repository.
+
+Metarepo is both a standalone server (for receiving and storing metadata via
+a WebSocket connection) and a library (npm module) for querying stored metadata.
+
+The typical use case is an application that displays files in a repository
+such as Git or Subversion where there is additional information about files
+that can't live in Git/Subversion. For example:
+
+* Comments or discussions about a file
+* Information about a line in a file
+
+Metarepo stores this extra information (metadata) about files.
+Each little piece of information has the following attributes:
+
+* `url` (what repository is it)
+* `rev` (what branch does the file live in)
+* `rev` (what revision of the file is it)
+* `group` (grouping metadata for the same url+rev) - typically a CI run id.
+* `path` (where is the file)
+* `location` (where in the file should the metadata be attached - currently a line number)
+* `mime_type` (what kind of data)
+* `json_body` (the metadata)
+
+This is split up over 3 tables:
+
+    +-------+       +--------+       +-----------+
+    | repos +-----> | group  +-----> | metadata  |
+    +-------+       +--------+       +-----------+
+    | url   |       | branch |       | path      |
+    +-------+       | rev    |       | location  |
+                    | group  |       | mime_type |
+                    +--------+       | json_body |
+                                     +-----------+
+
+
+Here are some examples of metadata:
+
+## Ruby Stacktrace
+
+    mime_type: text/vnd.cucumber-pro.stacktrace.ruby+plain
+    json_body: { "text" : "some ruby stacktrace" }
+
+## Screenshot
+
+    mime_type: image/png
+    json_body: { "path" : "path/within/s3" }
+
+See below about the protocol for storing binary attachments.
+
+## Test Case result (typically a Cucumber Scenario, but could also be from RSpec, JUnit etc)
+
+    mime_type: application/vnd.cucumber-pro.test-case-result+json
+    json_body: { "status" : "failed" }
+
+
+## Test Step result (Cucumber Step)
+
+    application/vnd.cucumber.test-step-result+json
+    json_body: { "status" : "failed" }
+
+## Discussion
+
+    mime_type: application/vnd.cucumber-pro.discussion-message+json
+    json_body: { "who": "matt", "message": "I like this" }
+
+Metadata can be stored with WebSockets (for the standalone mode) and retrieved with method calls
+(in the npm module mode).
+
+# Hacking
+
+## Create the local databases
+
+```
+createdb metarepo-test
+createdb metarepo-development
+createuser -s -r postgres
+```
+
+Run the tests (this will automatically migrate the databases):
+
+```
+npm test
+```
+
+# Try it out
+
+## Fire up the server
+
+```
+DEBUG="metarepo:*,omnirepo:*,svnlite:*" npm start
+```
+
+## Store some metadata over the WebSocket API
+
+First, you need the `authToken` of a cpro user, which you will find in mongodb.
+
+Connect a WebSocket
+
+```
+./node_modules/.bin/wscat --connect ws://localhost:5000/ws?token=authToken
+```
+
+Or if you want to do it on Heroku:
+
+```
+./node_modules/.bin/wscat --no-check --connect wss://results.cucumber.pro/ws?token=authToken
+```
+
+Initiate the session
+
+```json
+{ "repo_url": "memory://metarepo/test", "rev": "1", "branch": "master", "group": "run-1", "info": {} }
+```
+
+Store some metadata
+
+```json
+{ "path": "hello/world.feature", "location": 2, "mime_type": "application/vnd.cucumber.test-case-result+json", "body": { "status": "passed" } }
+{ "path": "hello/world.feature", "location": 3, "mime_type": "application/vnd.cucumber.test-case-result+json", "body": { "status": "failed" } }
+{ "path": "hello/world.feature", "location": 4, "mime_type": "application/vnd.cucumber.test-case-result+json", "body": { "status": "pending" } }
+```
+
+Query the database:
+
+```sql
+SELECT json_body->>'status' AS status, count(json_body) FROM metadata GROUP BY json_body->>'status';
+```
+
+The `PgStore.aggregateResult` method uses a similar query to report aggregate results.
+
+## Storing blobs
+
+The protocol for storing metadata where the body is a blob (such as an image) is
+to send two messages where the first one is a regular metadata JSON message
+*without* the body field set.
+
+When the `body` field is not set, metarepo expects the next message to be a *binary* message.
+The body of the binary message will be stored in an external store (S3), and the metadata record
+in the database will point to the path of the file in S3.
+
+## BUGS
+
+2) Not storing timezones
+
+See http://www.craigkerstiens.com/2014/05/07/Postgres-datatypes-the-ones-youre-not-using/
+
+## Release process
+
+    npm version NEW_VERSION
+    npm publish
+    git push --tags

data/lib/cucumber/pro/info.rb

@@ -0,0 +1,19 @@
+require 'rbconfig'
+require 'etc'
+require 'cucumber/platform'
+
+module Cucumber
+  module Pro
+    class Info
+      def to_h
+        {
+          os: "#{RbConfig::CONFIG['host_os']} (#{RbConfig::CONFIG['host_cpu']})",
+          platform_version: "#{RbConfig::CONFIG['ruby_install_name']} #{RbConfig::CONFIG['ruby_version']}",
+          tool_version: "cucumber-ruby #{Cucumber::VERSION}}",
+          os_user: Etc.getlogin,
+          client_version: "cucumber-pro-ruby #{File.read(File.dirname(__FILE__) + '/version').strip}" 
+        }
+      end
+    end
+  end
+end

data/lib/cucumber/pro/version

@@ -1 +1 @@
-0.0.7
+0.0.8

data/spec/cucumber/pro/info_spec.rb

@@ -0,0 +1,11 @@
+require 'cucumber/pro/info'
+
+module Cucumber
+  module Pro
+    describe Info do
+      it "can create a meaningful Hash" do
+        expect(Info.new.to_h[:client_version]).to match(/^cucumber-pro-ruby/)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-pro
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Matt Wynne
@@ -158,10 +158,13 @@ files:
 - features/support/fake_results_service.rb
 - features/support/world.rb
 - lib/cucumber/pro.rb
+- lib/cucumber/pro/README.md
 - lib/cucumber/pro/formatter.rb
+- lib/cucumber/pro/info.rb
 - lib/cucumber/pro/scm.rb
 - lib/cucumber/pro/version
 - lib/cucumber/pro/web_socket/session.rb
+- spec/cucumber/pro/info_spec.rb
 - spec/cucumber/pro/scm/git_repo_spec.rb
 - spec/cucumber/pro/web_socket/worker_spec.rb
 - tmp/.gitkeep
@@ -189,7 +192,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: cucumber-pro-0.0.7
+summary: cucumber-pro-0.0.8
 test_files:
 - features/publish_results.feature
 - features/security.feature
@@ -198,6 +201,7 @@ test_files:
 - features/support/env.rb
 - features/support/fake_results_service.rb
 - features/support/world.rb
+- spec/cucumber/pro/info_spec.rb
 - spec/cucumber/pro/scm/git_repo_spec.rb
 - spec/cucumber/pro/web_socket/worker_spec.rb
 has_rdoc: