crab 0.2.10 → 0.2.11

data/README.md

@@ -52,6 +52,10 @@ Thankfully, that part is easy:
     US1002: Launches Rockets Upon Command from Evil Mastermind
 
     $ crab story show US1001
+    # language: en
+    # state: grooming
+    # fetched: 2011-10-04T13:32:35-03:00
+    # revision: 17, by cv@lixo.org
     Feature: [US1001] Arms Rockets After Boot
 
       In order to gain bargaining power with Super Hero
@@ -60,11 +64,16 @@ Thankfully, that part is easy:
 
       ...
 
+Note the comments at the top of the file: language is relevant to
+Cucumber, but all others are only to help keeping track of revisions
+and changes.
+
 If there are any test cases associated with that story, they get converted
 into Cucumber scenarios:
 
     $ crab story show US1001
       ...
+      # revision: 6, by cv@lixo.org
       @critical @automated @high
       Scenario: [TC10001] Rocket Silo Is Unlocked
         Given a silo where the rockets are stored
@@ -129,6 +138,32 @@ straight from the command line:
 There are many more switches. Try exploring `crab --help` to find
 out more.
 
+Troubleshooting
+---------------
+
+This is still very rudimentary, but you can set `CRAB_LOG_LEVEL`
+to one of the constants defined in `Logger` to see more output for
+diagnosis. They are:
+
+  - 0: DEBUG
+  - 1: INFO
+  - 2: WARN
+  - 3: ERROR
+  - 4: FATAL
+  - 5: UNKNOWN
+
+The default is `WARN`, which should be good enough for most day-to-day
+usage, but if you are having trouble and would like to submit a bug
+report, please try again with `CRAB_LOG_LEVEL` set to `0` or `1`:
+
+    $ CRAB_LOG_LEVEL=0 crab story show US1001
+    I, [2011-10-04T02:33:22.795535 #16754]  INFO -- crab: Getting credentials...
+    I, [2011-10-04T02:33:22.795789 #16754]  INFO -- crab: Connecting to Rally as cvillela@thoughtworks.com...
+    I, [2011-10-04T02:33:28.343039 #16754]  INFO -- crab: Looking up story with ID US1001
+    I, [2011-10-04T02:33:31.861501 #16754]  INFO -- crab: US1001: 1 test case(s) found
+    I, [2011-10-04T02:33:38.681445 #16754]  INFO -- crab: TC10001: 3 step(s) found
+    ...
+
 i18n Support
 ------------
 
@@ -136,6 +171,10 @@ i18n Support
 Cucumber are also included:
 
     $ crab story show US1001 -l ja
+    # language: jp
+    # state: grooming
+    # fetched: 2011-10-04T13:32:35-03:00
+    # revision: 17, by cv@lixo.org
     機能: [US1001] Arms Rockets Upon Successful Boot
     ...
     シナリオ: [TC1501] Rocket Silo Is Unlocked
@@ -170,44 +209,15 @@ If you have any problems, please let us know.
 [4]: http://gembundler.com
 [5]: https://github.com/cucumber/aruba
 
-To do / Roadmap
----------------
-
-### 0.2.0
+To do / Roadmap / Known Bugs
+----------------------------
 
-- `pull` is not very smart and could detect feature files being moved from one dir to another
-- Recursively look for a `.crab` directory like Git does with `.git`
-- Make logging verbosity level configurable using a global command line option
-- Move more of the code away from the bin/ dir
-- More thorough automated testing of commands
-
-### 0.3.0
-
-- Do not add "default" tags to scenarios (`@important`, `@medium`, `@manual` and `@acceptance`)
-- Figure out how to stub or simulate Rally (tests are taking way too long already)
-- Make better use of Aruba to make sure generated files are OK
-- Use the Gherkin models and formatters instead of dumb string templates to generate feature files
-- Add a `push` subcommand which parses a Cucumber feature and adds or updates it (and test cases) in Rally
-- Add a config command + `.crab/config` file to hold settings like project, etc
-- A way to work in batches, or offline -- much faster!
-
-### 0.4.0
-
-- Error messages are still more cryptic than we'd like
-- Add a Cucumber Formatter that updates Test Runs in Rally with results from CI
-- Make it possible to associate defects with Features (essentially treating defects like stories)
-- Encrypt password in generated `~/.crab/credentials`
-- Test in Ruby 1.9
-
-### Before 1.0.0
-
-- Bash completion scripts
-- Man pages
-- Logo
-- Website
+Please see the [issues page][6] page.
 
 Suggestions? Please get in touch!
 
+[6]: https://github.com/cv/crab/issues
+
 Authors and Contributors
 ------------------------
 

data/features/show-from-rally.feature

@@ -15,7 +15,6 @@ Feature: Show Story From Rally
   Scenario: Show Story With Test Cases
     When I run `crab story show US5000`
     Then the output should contain "Feature: [US5000] Sample Crab Parent Story"
-    And the output should contain "@important @medium @manual @acceptance"
     And the output should contain "Scenario: [TC10388] Sample Testcase"
     And the output should contain "  Given Rally behaves"
     And the output should contain "  When I look at the test case steps"

data/features/update-story-in-rally.feature

@@ -19,14 +19,6 @@ Feature: Update Story in Rally
     Then the output should contain "US4988: Sample Crab Story (grooming)"
     And the story US4988 should be unblocked
 
-  Scenario: Setting Iteration
-    When I run `crab story update US4988 --iteration "Iteration 0"`
-    Then the story US4988 should be in iteration "Iteration 0"
-
-  Scenario: Setting Release
-    When I run `crab story update US4988 --release "Beta release"`
-    Then the story US4988 should be in release "Beta release"
-
   Scenario: Setting Parent
     When I run `crab story update US4988 --parent US5000`
     Then the story US4988 should have US5000 as its parent

data/lib/crab.rb

@@ -12,6 +12,7 @@ require 'sanitize'
 require 'trollop'
 
 # internals
+require "crab/logging"
 require "crab/utilities"
 require "crab/rally"
 require "crab/story"

data/lib/crab/cucumber_feature.rb

@@ -16,7 +16,7 @@ module Crab
       formatter.feature feature
 
       if include_testcases
-        Array(story.test_cases).tap {|tcs| logger.info "#{tcs.size} test case(s) found" }.each do |test_case|
+        Array(story.test_cases).tap {|tcs| logger.info "#{story.formatted_id}: #{tcs.size} test case(s) found" }.each do |test_case|
           formatter.scenario @adapter.scenario_from(test_case)
           @adapter.steps_from(test_case).each do |step|
             formatter.step step

data/lib/crab/logging.rb

@@ -0,0 +1,12 @@
+module Crab::Logging
+
+  def logger
+    $logger ||= Logger.new(STDERR)
+    $logger.formatter = Logger::Formatter.new
+    $logger.progname = 'crab'
+    # TODO - make this a global command-line or config option:
+    $logger.level = ENV['CRAB_LOG_LEVEL'].present? ? ENV['CRAB_LOG_LEVEL'].to_i : Logger::WARN
+    $logger
+  end
+
+end

data/lib/crab/rally_to_cucumber_adapter.rb

@@ -7,7 +7,12 @@ class Crab::RallyToCucumberAdapter
   end
 
   def feature_from(story)
-    comments = [Gherkin::Formatter::Model::Comment.new("# language: #{@language.iso_code}", 0)]
+    comments = [
+      "# language: #{@language.iso_code}",
+      "# state: #{story.state}",
+      "# fetched: #{DateTime.now}",
+      "# revision: #{story.revision}",
+    ].map {|c| Gherkin::Formatter::Model::Comment.new(c, 0) }
     tags = []
     keyword = @language.keywords('feature').last
     name = "[#{story.formatted_id}] #{story.name}"
@@ -18,7 +23,9 @@ class Crab::RallyToCucumberAdapter
   end
 
   def scenario_from(test_case)
-    comments = []
+    comments = [
+      "# revision: #{test_case.revision}",
+    ].map {|c| Gherkin::Formatter::Model::Comment.new(c, 0) }
     tags = test_case.tags.map {|tag| Gherkin::Formatter::Model::Tag.new("@#{tag}", 0) }
     keyword = @language.keywords('scenario').last
     name = "[#{test_case.formatted_id}] #{test_case.name}"
@@ -29,7 +36,7 @@ class Crab::RallyToCucumberAdapter
   end
 
   def steps_from(test_case)
-    test_case.steps.tap {|steps| logger.info "#{steps.size} step(s) found"}.map do |step|
+    test_case.steps.tap {|steps| logger.info "#{test_case.formatted_id}: #{steps.size} step(s) found"}.map do |step|
       step_words = step.split(' ')
       comments = []
       keyword = step_words.shift

data/lib/crab/story.rb

@@ -2,6 +2,8 @@ module Crab
 
   class Story
 
+    include Crab::Utilities
+
     VALID_STATES = %w{Grooming Defined In-Progress Completed Accepted Released}
 
     def initialize(rally_story, dry_run)
@@ -29,6 +31,11 @@ module Crab
       (@rally_story.schedule_state || "unknown").parameterize.underscore
     end
 
+    def revision
+      rev = @rally_story.revision_history.revisions.first
+      "#{rev.revision_number}, by #{rev.user}"
+    end
+
     def description
       # this could use a lot of rethinking :(
       # biggest problem is that Cucumber breaks if text in description looks like something
@@ -67,12 +74,6 @@ module Crab
 
     private
 
-    # took a while to figure out that we need to remove the CSS from inside embedded <style> tags!
-    # Rally uses some crazy rich text editor that I'd be soooooo happy to disable, somehow. Chrome Extension, perhaps?
-    def sanitize(source)
-      Sanitize.clean source, :remove_contents => %w{style}
-    end
-
   end
 
   module DryRun

data/lib/crab/testcase.rb

@@ -2,6 +2,8 @@ module Crab
 
   class TestCase
 
+    include Crab::Utilities
+
     PRIORITIES = %w{useful important critical}
     RISKS = %w{low medium high}
     METHODS = %w{automated manual}
@@ -21,11 +23,22 @@ module Crab
     end
 
     def description
-      @rally_test_case.description
+      # this could use a lot of rethinking :(
+      # biggest problem is that Cucumber breaks if text in description looks like something
+      # it might know how to parse, but doesn't
+      # our feature descriptions are quite like that, so I was being ultra-conservative
+      sanitize(@rally_test_case.description || '').gsub(/  +/, "\n").gsub(/\n\n/, "\n").gsub(/\n/, "\n  ")
     end
 
     def tags
-      [priority, risk, test_method, test_type].map &:parameterize
+      [priority, risk, test_method, test_type].map(&:parameterize).reject do |tag|
+        %w{important medium manual acceptance}.include? tag
+      end
+    end
+
+    def revision
+      rev = @rally_test_case.revision_history.revisions.first
+      "#{rev.revision_number}, by #{rev.user}"
     end
 
     def priority

data/lib/crab/utilities.rb

@@ -1,13 +1,7 @@
 module Crab
   module Utilities
 
-    def logger
-      $logger ||= Logger.new(STDERR)
-      $logger.formatter = Logger::Formatter.new
-      $logger.progname = 'crab'
-      # TODO - make this a global command-line or config option: $logger.level = Logger::WARN
-      $logger
-    end
+    include Logging
 
     def credentials_file
       FileUtils.mkdir_p File.expand_path("~/.crab")
@@ -77,5 +71,10 @@ module Crab
       result
     end
 
+    # took a while to figure out that we need to remove the CSS from inside embedded <style> tags!
+    # Rally uses some crazy rich text editor that I'd be soooooo happy to disable, somehow. Chrome Extension, perhaps?
+    def sanitize(source)
+      Sanitize.clean source, :remove_contents => %w{style}
+    end
   end
 end

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.2.10"
+  VERSION = "0.2.11"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 2
-  - 10
-  version: 0.2.10
+  - 11
+  version: 0.2.11
 platform: ruby
 authors: 
 - Carlos Villela
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 -03:00
+date: 2011-10-04 00:00:00 -03:00
 default_executable: crab
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -354,6 +354,7 @@ files:
 - lib/crab/cucumber_feature.rb
 - lib/crab/cucumber_scenario.rb
 - lib/crab/cucumber_to_rally_adapter.rb
+- lib/crab/logging.rb
 - lib/crab/rally.rb
 - lib/crab/rally_to_cucumber_adapter.rb
 - lib/crab/story.rb