cucumber-pro 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57bcad6666fb5df2180cb02c2206bc18fe2bf99
-  data.tar.gz: 5957942d5725e1f253d222763e2e2493aaa69307
+  metadata.gz: 76e04aa1afc140a20a4c0575b6dba96a7ae0d430
+  data.tar.gz: fc8ae49cbc277d7f88549776ee4ed27f735cc5f5
 SHA512:
-  metadata.gz: 47a6059e95e4e5c381f33d74f2875785cfba2ca3a0cb47d77427b4fb8200cd6d33dcac1e9ab4dc83002eb676a418abdfb3b7a379172b64db0cbda4bf3dd8810a
-  data.tar.gz: c4efd4814be45731a516aeb7247584cab215696b6a280bfd2fa922641e9108f03bdf4bb30014452d8f7332b59c61d3d42e9a9fc3a636a91c0043d6c6d304b8ce
+  metadata.gz: 86a438c18d1ad6e6272fae960d701b99dd0237a2bafd0626b62060f21b4bb214a39d66f36a8867fb0a715f136c0001ac20efd4101df8ed5319bbf6a74c7cfef5
+  data.tar.gz: e9f5415c235a24459553c2a5226f1c8e174ecde9d42cae464f96adb9d8ff074ce678c858d2fcb5da446d5d8a13f3931697e28868116baf66edc96ac70b0a3a1c

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2013 Cucumber Ltd
+Copyright (c) 2013,2014 Cucumber Limited
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 # Cucumber Pro Client Gem
 [![Build Status](https://travis-ci.org/cucumber-ltd/cucumber-pro-ruby.svg?branch=master)](https://travis-ci.org/cucumber-ltd/cucumber-pro-ruby.svg?branch=master)
 
-This gem provides a formatter for Cucumber that publishes results to 
+This gem provides a formatter for Cucumber that publishes results to
 the [Cucumber Pro](https://cucumber.pro) web service.
 
 ## Usage
@@ -18,5 +18,6 @@ Now run Cucumber using the `Cucumber::Pro` formatter:
 CUCUMBER_PRO_TOKEN=<your auth token> cucumber -f Cucumber::Pro -o /dev/null -f pretty
 ```
 
-This will set up a connection to the Cucumber Pro server and stream results as your tests run. If you want to see debug output, replace `/dev/null` with the path to a log file.
-
+This will set up a connection to the Cucumber Pro server and stream results as
+your tests run. If you want to see debug output, replace `/dev/null` with the
+path to a log file.

data/lib/cucumber/pro/formatter.rb

@@ -1,4 +1,4 @@
-require 'cucumber/pro/scm'
+require 'cucumber/pro/scm/working_copy'
 require 'cucumber/pro/info'
 require 'securerandom'
 
@@ -53,11 +53,12 @@ module Cucumber
       private
 
       def send_header
-        scm = Scm::Repo.find
+        working_copy = Scm::WorkingCopy.detect
+        working_copy.check_clean
         @session.send({
-          repo_url: scm.remote,
-          branch: scm.branch,
-          rev: scm.rev,
+          repo_url: working_copy.repo_url,
+          branch: working_copy.branch,
+          rev: working_copy.rev,
           group: get_run_id,
           info: Info.new.to_h
         })

data/lib/cucumber/pro/info.rb

@@ -11,7 +11,8 @@ module Cucumber
           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}" 
+          client_version: "cucumber-pro-ruby #{File.read(File.dirname(__FILE__) + '/version').strip}",
+          cmd: ([$PROGRAM_NAME] + ARGV).join(' ')
         }
       end
     end

data/lib/cucumber/pro/scm/working_copy.rb

@@ -0,0 +1,80 @@
+module Cucumber
+  module Pro
+
+    module Scm
+
+      DirtyWorkingCopy = Class.new(StandardError)
+
+      class WorkingCopy
+
+        NoGitRepoFound = Class.new(StandardError)
+
+        def self.detect(path = Dir.pwd)
+          if Dir.entries(path).include? '.git'
+            GitWorkingCopy.new(path)
+          else
+            # TODO (aslak): This is likely to loop indefinitely on Windows - it's never '/'
+            # Maybe use Pathname?
+            raise NoGitRepoFound if path == '/'
+            detect File.expand_path(path + '/..')
+          end
+        end
+
+      end
+
+      class GitWorkingCopy
+
+        def initialize(path)
+          @path = path
+        end
+
+        def repo_url
+          cmd('git ls-remote --get-url').each do |remote|
+            return remote if remote =~ /(github|bitbucket)/
+          end
+          # Fallback if we didn't find one
+          cmd('git config --get remote.origin.url').last
+        end
+
+        def branch
+          branch = cmd("git branch --contains #{rev}").
+            reject { |b| /^\* \(detached from \w+\)/.match b }.
+            first.
+            gsub(/^\* /, '')
+        end
+
+        def rev
+          cmd("git rev-parse HEAD").last
+        end
+
+        def check_clean
+          check_no_modifications
+          check_current_branch_pushed
+        end
+
+        private
+
+        def cmd(cmd)
+          Dir.chdir(@path) { `#{cmd}` }.lines.map &:strip
+        end
+
+        def check_no_modifications
+          if cmd("git status --untracked-files=no --porcelain").any?
+            raise DirtyWorkingCopy.new("Please commit and push your changes before running with the Cucumber Pro formatter.")
+          end
+        end
+
+        def check_current_branch_pushed
+          if cmd("git branch -r").any?
+            # Only check if it's pushed if we actually have any remote branches
+            # (which we do not for our tests)
+            b = branch
+            if cmd("git log origin/#{b}..#{b} --oneline").any?
+              raise DirtyWorkingCopy.new("Your current branch has commits that haven't been pushed to origin. Please push your changes before running with the Cucumber Pro formatter.")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/pro/version

@@ -1 +1 @@
-0.0.8
+0.0.9

data/spec/cucumber/pro/info_spec.rb

@@ -4,7 +4,9 @@ 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/)
+        info = Info.new
+        expect(info.to_h[:client_version]).to match(/^cucumber-pro-ruby/)
+        expect(info.to_h[:cmd]).to match(/rspec/)
       end
     end
   end

data/spec/cucumber/pro/scm/git_working_copy_spec.rb

@@ -0,0 +1,60 @@
+require 'cucumber/pro/scm/working_copy'
+require 'aruba/api'
+
+module Cucumber
+  module Pro
+    module Scm
+      describe GitWorkingCopy do
+        include Aruba::Api
+        before do
+          clean_current_dir
+          in_current_dir do
+            run_simple "git init"
+            run_simple "git config user.email \"test@test.com\""
+            run_simple "git config user.name \"Test user\""
+          end
+        end
+
+        it "figures out the name of the branch, even on CI" do
+          in_current_dir do
+            run_simple "git commit --allow-empty -m 'Initial commit'"
+            run_simple "git rev-parse HEAD"
+            rev = all_stdout.split("\n").last
+            run_simple "git checkout #{rev}"
+            working_copy = WorkingCopy.detect(current_dir)
+            expect( working_copy.branch ).to eq "master"
+          end
+        end
+
+        it "figures out the name of the branch when that's what's checked out" do
+          in_current_dir do
+            run_simple "git commit --allow-empty -m 'Initial commit'"
+            working_copy = WorkingCopy.detect(current_dir)
+            expect( working_copy.branch ).to eq "master"
+          end
+        end
+
+        it "detects a dirty working copy" do
+          in_current_dir do
+            write_file "README.md", "# README"
+            run_simple "git add README.md"
+            working_copy = WorkingCopy.detect(current_dir)
+            expect { working_copy.check_clean }.to raise_error(DirtyWorkingCopy, /Please commit and push your changes/)
+          end
+        end
+
+        xit "detects unpushed changes" do
+          # This one is a little trickier to test. I think we may have to fetch commits
+          # from a repo first.
+          in_current_dir do
+            write_file "README.md", "# README"
+            run_simple "git add README.md"
+            run_simple "git commit -am 'I committed but that is not good enough'"
+            working_copy = WorkingCopy.detect(current_dir)
+            expect { working_copy.check_clean }.to raise_error(DirtyWorkingCopy, /Your current branch has commits that haven't been pushed to origin/)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-pro
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Matt Wynne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -158,16 +158,14 @@ 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/scm/working_copy.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/scm/git_working_copy_spec.rb
 - spec/cucumber/pro/web_socket/worker_spec.rb
-- tmp/.gitkeep
 homepage: https://cucumber.pro
 licenses:
 - MIT
@@ -192,7 +190,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: cucumber-pro-0.0.8
+summary: cucumber-pro-0.0.9
 test_files:
 - features/publish_results.feature
 - features/security.feature
@@ -202,6 +200,6 @@ test_files:
 - 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/scm/git_working_copy_spec.rb
 - spec/cucumber/pro/web_socket/worker_spec.rb
 has_rdoc: 

data/lib/cucumber/pro/README.md

@@ -1,153 +0,0 @@
-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/scm.rb

@@ -1,50 +0,0 @@
-module Cucumber
-  module Pro
-
-    module Scm
-
-      class Repo
-
-        NoGitRepoFound = Class.new(StandardError)
-
-        def self.find(path = Dir.pwd)
-          if Dir.entries(path).include? '.git'
-            GitRepo.new(path)
-          else
-            raise NoGitRepoFound if path == '/'
-            find File.expand_path(path + '/..')
-          end
-        end
-
-      end
-
-      class GitRepo
-
-        def initialize(path)
-          @path = path
-        end
-
-        def remote
-          cmd('git config --get remote.origin.url').last
-        end
-
-        def branch
-          branch = cmd("git branch --contains #{rev}").
-            reject { |b| /^\* \(detached from \w+\)/.match b }.
-            first.
-            gsub(/^\* /, '')
-        end
-
-        def rev
-          cmd("git rev-parse HEAD").last
-        end
-
-        private
-
-        def cmd(cmd)
-          Dir.chdir(@path) { `#{cmd}` }.lines.map &:strip
-        end
-      end
-    end
-  end
-end

data/spec/cucumber/pro/scm/git_repo_spec.rb

@@ -1,40 +0,0 @@
-require 'cucumber/pro/scm'
-require 'aruba/api'
-
-module Cucumber
-  module Pro
-    module Scm
-      describe GitRepo do
-        include Aruba::Api
-        before do
-          clean_current_dir
-        end
-
-        it "figures out the name of the branch, even on CI" do
-          in_current_dir do
-            run_simple "git init"
-            run_simple "git config user.email \"test@test.com\""
-            run_simple "git config user.name \"Test user\""
-            run_simple "git commit --allow-empty -m 'Initial commit'"
-            run_simple "git rev-parse HEAD"
-            rev = all_stdout.split("\n").last
-            run_simple "git checkout #{rev}"
-            repo = Repo.find(current_dir)
-            expect( repo.branch ).to eq "master"
-          end
-        end
-
-        it "figures out the name of the branch when that's what's checked out" do
-          in_current_dir do
-            run_simple "git init"
-            run_simple "git config user.email \"test@test.com\""
-            run_simple "git config user.name \"Test user\""
-            run_simple "git commit --allow-empty -m 'Initial commit'"
-            repo = Repo.find(current_dir)
-            expect( repo.branch ).to eq "master"
-          end
-        end
-      end
-    end
-  end
-end