crab 0.2.2 → 0.2.3

data/bin/{crab-rm → crab-story-rm}

@@ -3,15 +3,15 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab delete: delete an existing story in Rally
+crab story delete: delete an existing story in Rally
 
-Usage: crab delete story [options]
+Usage: crab story delete <id> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end
 
 id = ARGV.join(" ")
-Trollop::die "Story ID must be specified" if story_id.blank?
+Trollop::die "Story ID must be specified" if id.blank?
 
 Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id id

data/bin/{crab-show → crab-story-show}

@@ -3,9 +3,9 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab show: displays a story in Rally as a Cucumber feature
+crab story show: displays a story in Rally as a Cucumber feature
 
-Usage: crab show story"
+Usage: crab story show <id> [options*]"
   BANNER
   opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-up → crab-story-up}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 cmd_opts = Trollop::options do
   banner <<-BANNER
-crab update: update a story in Rally
+crab story update: update a story in Rally
 
-Usage: crab update story [options]
+Usage: crab story update <id> [options*]
   BANNER
   opt :name,      "Name (title)", :type => String, :short => "-n"
   opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
@@ -40,12 +40,12 @@ Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id ARGV.first
 
   if cmd_opts[:iteration_given]
-    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration], story.project
     Trollop::die "Unknown iteration \"#{cmd_opts[:iteration]}\"" if opts[:iteration].nil?
   end
 
   if cmd_opts[:release_given]
-    opts[:release] = rally.find_release_by_name cmd_opts[:release]
+    opts[:release] = rally.find_release_by_name cmd_opts[:release], story.project
     Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
   end
 

data/bin/{crab-update → crab-story-update}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 cmd_opts = Trollop::options do
   banner <<-BANNER
-crab update: update a story in Rally
+crab story update: update a story in Rally
 
-Usage: crab update story [options]
+Usage: crab story update <id> [options*]
   BANNER
   opt :name,      "Name (title)", :type => String, :short => "-n"
   opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
@@ -40,12 +40,12 @@ Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id ARGV.first
 
   if cmd_opts[:iteration_given]
-    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration], story.project
     Trollop::die "Unknown iteration \"#{cmd_opts[:iteration]}\"" if opts[:iteration].nil?
   end
 
   if cmd_opts[:release_given]
-    opts[:release] = rally.find_release_by_name cmd_opts[:release]
+    opts[:release] = rally.find_release_by_name cmd_opts[:release], story.project
     Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
   end
 

data/bin/crab-testcase

@@ -11,7 +11,7 @@ end
 
 unless system("crab-testcase-#{cmd}", *ARGV)
   if $?.exitstatus == 127 # bash 'command not found'
-    $stderr.puts "Unknown subcommand \"template #{cmd}\""
+    $stderr.puts "Unknown subcommand \"testcase #{cmd}\""
     system "crab-testcase-help"
     exit 127
   end

data/bin/crab-testcase-add

@@ -3,7 +3,11 @@ require 'crab'
 
 include Crab::Utilities
 
-opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+opts = add_or_update_options <<-BANNER
+crab testcase create: add a test case to a story in Rally
+
+Usage: crab testcase create <story> <name> [options*]
+BANNER
 
 story_id = ARGV.shift
 unless story_id

data/bin/crab-testcase-change

@@ -0,0 +1,18 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options <<-BANNER
+crab testcase update: update a test case in Rally
+
+Usage: crab testcase update <id> [options*]
+BANNER
+
+tc_id = ARGV.shift
+
+Crab::Rally.new(opts[:dry]) do |rally|
+  tc = rally.find_test_case(tc_id)
+  tc.update(sanitize_options(opts))
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+end

data/bin/crab-testcase-create

@@ -3,7 +3,11 @@ require 'crab'
 
 include Crab::Utilities
 
-opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+opts = add_or_update_options <<-BANNER
+crab testcase create: add a test case to a story in Rally
+
+Usage: crab testcase create <story> <name> [options*]
+BANNER
 
 story_id = ARGV.shift
 unless story_id

data/bin/crab-testcase-del

@@ -0,0 +1,18 @@
+# vim: set ft=ruby :
+require 'crab'
+
+Trollop::options do
+  banner <<-BANNER
+crab testcase delete: delete a test case in Rally
+
+Usage: crab testcase delete <id> [options*]
+BANNER
+  opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
+end
+
+tc_id = ARGV.shift
+Crab::Rally.new(opts[:dry]) do |rally|
+  tc = rally.find_test_case(tc_id)
+  tc.delete
+  puts "Test case #{tc_id} deleted."
+end

data/bin/crab-testcase-delete

@@ -2,7 +2,11 @@
 require 'crab'
 
 Trollop::options do
-  banner "crab testcase delete: delete a test case in Rally"
+  banner <<-BANNER
+crab testcase delete: delete a test case in Rally
+
+Usage: crab testcase delete <id> [options*]
+BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end
 

data/bin/crab-testcase-find

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby :
+
+require 'crab'
+
+puts <<-BANNER
+crab testcase find: find a test case in Rally
+
+Usage: crab testcase find <story> [options*]
+BANNER

data/bin/crab-testcase-help

@@ -1,10 +1,16 @@
 # vim: set ft=ruby :
-require 'crab'
 
 puts <<-HELP
-crab testcase: manage test cases in a story (add, update, delete)
+Usage: crab testcase <command> [options*]
 
-Usage: crab testcase add story name [options]
-       crab testcase update testcase [options]
-       crab testcase delete testcase [options]
+  Available commands:
+
+  create  Create a new test case in a story
+  delete  Delete an existing test case
+    help  Show this help text
+    list  List test cases in a story
+    show  Show a test case (and its steps) as a Cucumber scenario
+  update  Update a test case (name, priority, testing method, etc)
+
+     --help, -h:   Show this message
 HELP

data/bin/crab-testcase-list

@@ -5,7 +5,7 @@ opts = Trollop::options do
   banner <<-BANNER
 crab testcase list: displays all testcases in Rally in a story as Cucumber scenarios
 
-Usage: crab testcase list <story> [options]"
+Usage: crab testcase list <story> [options*]"
   BANNER
   opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/crab-testcase-ls

@@ -1,25 +1,10 @@
+#!/usr/bin/env ruby
 # vim: set ft=ruby :
-require 'crab'
-
-opts = Trollop::options do
-  banner <<-BANNER
-crab testcase list: displays all testcases in Rally in a story as Cucumber scenarios
 
-Usage: crab testcase list <story> [options]"
-  BANNER
-  opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
-  opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
-end
-
-id = ARGV.shift
-unless id
-  $stderr.puts "Error: No story ID provided."
-  system "crab-testcase-help"
-  exit 1
-end
+require 'crab'
 
-Crab::Rally.new(opts[:dry]) do |rally|
-  story = rally.find_story_with_id id
+puts <<-BANNER
+crab testcase find: find a test case in Rally
 
-  puts Array(story.scenarios).map {|scenario| Crab::CucumberScenario.new(opts[:language]).generate_from scenario }.join.strip
-end
+Usage: crab testcase find <story> [options*]
+BANNER

data/bin/crab-testcase-new

@@ -3,7 +3,11 @@ require 'crab'
 
 include Crab::Utilities
 
-opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+opts = add_or_update_options <<-BANNER
+crab testcase create: add a test case to a story in Rally
+
+Usage: crab testcase create <story> <name> [options*]
+BANNER
 
 story_id = ARGV.shift
 unless story_id

data/bin/crab-testcase-rm

@@ -2,7 +2,11 @@
 require 'crab'
 
 Trollop::options do
-  banner "crab testcase delete: delete a test case in Rally"
+  banner <<-BANNER
+crab testcase delete: delete a test case in Rally
+
+Usage: crab testcase delete <id> [options*]
+BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end
 

data/bin/crab-testcase-show

@@ -5,7 +5,7 @@ opts = Trollop::options do
   banner <<-BANNER
 crab testcase show: displays a testcase in Rally as a Cucumber scenario
 
-Usage: crab testcase show <testcase> [options]"
+Usage: crab testcase show <id> [options*]"
   BANNER
   opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/crab-testcase-up

@@ -0,0 +1,18 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options <<-BANNER
+crab testcase update: update a test case in Rally
+
+Usage: crab testcase update <id> [options*]
+BANNER
+
+tc_id = ARGV.shift
+
+Crab::Rally.new(opts[:dry]) do |rally|
+  tc = rally.find_test_case(tc_id)
+  tc.update(sanitize_options(opts))
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+end

data/bin/crab-testcase-update

@@ -3,7 +3,11 @@ require 'crab'
 
 include Crab::Utilities
 
-opts = add_or_update_options "crab testcase update: update a test case in Rally"
+opts = add_or_update_options <<-BANNER
+crab testcase update: update a test case in Rally
+
+Usage: crab testcase update <id> [options*]
+BANNER
 
 tc_id = ARGV.shift
 

data/features/find-text-in-stories.feature

@@ -9,7 +9,7 @@ Feature: Find Text in Stories
     And I have selected my test project
 
   Scenario: Matching Name
-    When I run `crab find Sample Crab`
+    When I run `crab story find Sample Crab`
     Then the output should contain:
       """
       US4988: Sample Crab Story (grooming)
@@ -19,11 +19,11 @@ Feature: Find Text in Stories
   @quick
   Scenario: Project Must be Specified If Not Set
     Given no project is selected
-    When I run `crab find pattern`
+    When I run `crab story find pattern`
     Then the output should contain "Error: argument --project must be specified."
 
   Scenario: Project Must Exist
-    When I run `crab find --project "foo" pattern`
+    When I run `crab story find --project "foo" pattern`
     Then the output should contain:
       """
       Error: Project "foo" not found.

data/features/login-and-out-of-rally.feature

@@ -1,11 +1,10 @@
 Feature: Log In and Out of Rally
-  
+
   In order to avoid typing his credentials all the time
   A lazy and security-conscious developer
   Wants to log in and out of Rally in order to perform operations
 
   Scenario: Logged Out, Logging In
-    Given I am logged out
     When I run `crab login` interactively
     And I type my username
     And I type my password

data/features/move-in-rally.feature

@@ -8,8 +8,8 @@ Feature: Move in Rally
     Given I am logged in
 
   Scenario: Move Then Go Back
-    When I run `crab move US4988`
+    When I run `crab story move US4988`
     Then the output should contain "US4988: Sample Crab Story (defined)"
 
-    When I run `crab move US4988 --back`
+    When I run `crab story move US4988 --back`
     Then the output should contain "US4988: Sample Crab Story (grooming)"

data/features/pull-from-rally-into-cucumber.feature

@@ -1,16 +1,16 @@
 Feature: Pull From Rally Into Cucumber
-  
+
   In order to begin development of a story that was written in Rally
   A developer who doesn't want to open a browser or click things
   Wants the story converted into the much nicer Cucumber format
 
-  Background: 
+  Background:
     Given I am logged in
 
   Scenario: Pulling a Single Story
     Given a directory named "crab-pull"
     And I cd to "crab-pull"
-    When I run `crab pull US4988`
+    When I run `crab story pull US4988`
     Then the output should contain "US4988: features/grooming/US4988-sample-crab-story.feature"
     And a directory named "features" should exist
     And a file named "features/grooming/US4988-sample-crab-story.feature" should exist
@@ -23,7 +23,7 @@ Feature: Pull From Rally Into Cucumber
       """
 
   Scenario: Pulling Multiple Stories
-    When I run `crab pull US4988 US5000`
+    When I run `crab story pull US4988 US5000`
     Then the output should contain "US4988: features/grooming/US4988-sample-crab-story.feature"
     Then the output should contain "US5000: features/grooming/US5000-sample-crab-parent-story.feature"
 

data/features/show-from-rally.feature

@@ -8,7 +8,7 @@ Feature: Show Story From Rally
     Given I am logged in
 
   Scenario: Show Simple Story
-    When I run `crab show US4988`
+    When I run `crab story show US4988`
     Then the output should contain:
       """
       Feature: [US4988] Sample Crab Story
@@ -17,7 +17,7 @@ Feature: Show Story From Rally
       """
 
   Scenario: Show Story With Test Cases
-    When I run `crab show US5000`
+    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"
@@ -26,7 +26,7 @@ Feature: Show Story From Rally
     And the output should contain "  Then I should be able to export them into Cucumber format"
 
   Scenario: Story In Different Language
-    When I run `crab show US5000 --language pt`
+    When I run `crab story show US5000 --language pt`
     Then the output should contain "Funcionalidade: "
     And the output should contain "Cenario: "
 

data/features/steps/rally_steps.rb

@@ -1,5 +1,41 @@
 require 'rally_rest_api'
 
+def get_rally_credentials
+  file = File.expand_path("~/.crab/tests/credentials")
+
+  if File.exists? file
+    username, password = File.read(file).split(/\n/)
+    [ username, password ]
+  else
+    raise "Please run rake cucumber:setup first"
+  end
+end
+
+def get_rally
+  username, password = get_rally_credentials
+  @rally = RallyRestAPI.new :username => username, :password => password
+end
+
+def get_story(story_id)
+  get_rally.find(:hierarchical_requirement, :fetch => true) { equal :formatted_i_d, story_id }.first
+end
+
+def get_project
+  if File.exists? ".crab/tests/project"
+    File.read(".crab/tests/project").strip
+  else
+    raise "Please run rake cucumber:setup first"
+  end
+end
+
+def get_test_project
+  begin
+    test_project = File.read(File.expand_path("~/.crab/tests/project"))
+  rescue
+    raise "Looks like your test project isn't set up. Please run 'rake cucumber:setup'"
+  end
+end
+
 Then /^I should see a usage screen$/ do
   Then "the output should contain:", <<-TEXT
 Usage: crab <command> [options*]
@@ -8,48 +44,24 @@ crab version #{Crab::VERSION}: A Cucumber-Rally bridge
 
   Available commands:
 
-    create  Create a new story in Rally
-    delete  Delete an existing story in Rally
-      find  Find stories by text in name, description or notes
-     login  Persistently authenticate user with Rally
-      move  Move a story from one status to the next (or previous)
-   project  Persistently select project to work with in Rally
-      pull  Downloads stories (and its test cases) as Cucumber feature files
-    rename  Rename a story
-      show  Show a story (and its test cases) as a Cucumber feature
-  testcase  Manage test cases in a story (add, update, delete)
-    update  Update a story (name, estimate, etc)
-
+       help  Show this help text
+  iteration  Manipulate iterations
+      login  Persistently authenticate user with Rally
+     logout  Remove stored Rally credentials
+    project  Persistently select project to work with in Rally
+    release  Manipulate releases
+      story  Manipulate stories
+   testcase  Manipulate test cases
 
   --version, -v:   Print version and exit
      --help, -h:   Show this message
   TEXT
 end
 
-Given /^I am logged out$/ do
-end
-
-Given /^an instance of Rally$/ do
-end
-
-Given /^Rally has a story with ID "([^"]*)"$/ do |arg1|
-end
-
 Then /^the user's home directory should have a file named "([^"]*)"$/ do |file|
   File.exists? File.expand_path("~/#{file}")
 end
 
-def get_rally_credentials
-  file = File.expand_path("~/.crab/tests/credentials")
-
-  if File.exists? file
-    username, password = File.read(file).split(/\n/)
-    [ username, password ]
-  else
-    raise "Please run rake cucumber:setup first"
-  end
-end
-
 When /^I type my username$/ do
   When %Q{I type "#{get_rally_credentials.first}"}
 end
@@ -61,9 +73,8 @@ end
 Given /^I am logged in$/ do
   username, password = get_rally_credentials
   steps %Q{
-    Given I am logged out
     When I run `crab login -u #{username} -p #{password}`
-    Then the output should contain "Logged in as #{username}"
+    Then the output should contain "Credentials stored for #{username}"
   }
 end
 
@@ -71,15 +82,6 @@ Then /^a file named "([^"]*)" in the user's home directory should exist$/ do |ar
   pending # express the regexp above with the code you wish you had
 end
 
-def get_rally
-  username, password = get_rally_credentials
-  @rally = RallyRestAPI.new :username => username, :password => password
-end
-
-def get_story(story_id)
-  get_rally.find(:hierarchical_requirement, :fetch => true) { equal :formatted_i_d, story_id }.first
-end
-
 Then /^the story ([A-Z]{2}\d+) should be blocked$/ do |story_id|
   story = get_story(story_id)
   story.blocked.should == "true"
@@ -110,14 +112,6 @@ Given /^no project is selected$/ do
   Given 'I run `rm -rf ".crab/project"`'
 end
 
-def get_project
-  if File.exists? ".crab/tests/project"
-    File.read(".crab/tests/project").strip
-  else
-    raise "Please run rake cucumber:setup first"
-  end
-end
-
 Given /^I have selected the project "([^"]*)"$/ do |project|
   unless get_project == project
     steps %Q{
@@ -127,14 +121,6 @@ Given /^I have selected the project "([^"]*)"$/ do |project|
   end
 end
 
-def get_test_project
-  begin
-    test_project = File.read(File.expand_path("~/.crab/tests/project"))
-  rescue
-    raise "Looks like your test project isn't set up. Please run 'rake cucumber:setup'"
-  end
-end
-
 Given /^I have selected my test project$/ do
   When %Q{I run `crab project "#{get_test_project}"`}
 end