crab 0.2.12 → 0.2.13

data/bin/crab-defect

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby:
+require 'crab'
+
+class Crab::DefectMain
+
+  class << self
+
+    include Crab::Utilities
+
+    def run(args=ARGV)
+      cmd = args.shift # get the subcommand
+
+      case cmd
+      when "-h", "--help", NilClass
+        system "crab-defect-help"
+        exit 0
+      end
+
+      unless system("crab-defect-#{cmd}", *args)
+        if $?.exitstatus == 127 # bash 'command not found'
+          logger.error "Unknown subcommand \"defect #{cmd}\""
+          system "crab-defect-help"
+          exit 1
+        end
+      end
+    end
+  end
+end
+
+Crab::DefectMain.run

data/bin/crab-defect-delete

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby :
+require 'crab'
+
+class Crab::DefectDelete
+
+  def self.run(args=ARGV)
+    opts = Trollop::options(args) do
+      banner <<-BANNER
+crab defect delete: delete an existing defect in Rally
+
+Usage: crab defect delete <id> [options*]
+      BANNER
+      opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
+    end
+
+    id = args.join(" ")
+    Trollop::die "Defect ID must be specified" if id.blank?
+
+    Crab::Rally.new(opts[:dry]) do |rally|
+      defect = rally.find_defect_with_id id
+      defect.delete
+
+      puts "Defect #{id} deleted."
+    end
+  end
+end
+
+Crab::DefectDelete.run

data/bin/crab-defect-find

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby :
+require 'crab'
+
+class Crab::DefectFind
+
+  class << self
+
+    include Crab::Utilities
+
+    def run(args=ARGV)
+      opts = Trollop::options(args) do
+        banner <<-BANNER
+crab defect find: find a defect in Rally
+
+Usage: crab defect find [options*] [text]
+        BANNER
+        opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+        opt :iteration, "Limit search to this iteration",          :short => "-i", :type => String
+        opt :release,   "Limit search to this release",            :short => "-r", :type => String
+        opt :parent,    "Limit search to children of this defect", :short => "-P", :type => String
+        opt :dry,       "Dry-run (don't change anything)",         :short => "-D", :default => false
+      end
+
+      pattern = args.map(&:strip).reject(&:empty?)
+      project_name = valid_project_name(opts)
+
+      Crab::Rally.new(opts[:dry]) do |rally|
+        project = rally.find_project(project_name)
+        Trollop::die "Project #{opts[:project].inspect} not found" if project.nil?
+
+        find_opts = {}
+        find_opts[:iteration] = rally.find_iteration_by_name opts[:iteration], project if opts[:iteration_given]
+        find_opts[:release] = rally.find_release_by_name opts[:release], project if opts[:release_given]
+        find_opts[:parent] = rally.find_defect_with_id opts[:parent] if opts[:parent_given]
+
+        rally.find_defects(project, pattern, find_opts).each do |defect|
+          puts "#{defect.formatted_id}: #{defect.name} (#{defect.state})"
+        end
+      end
+    end
+  end
+end
+
+Crab::DefectFind.run

data/bin/crab-defect-help

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby :
+require 'crab'
+
+class Crab::DefectHelp
+
+  def self.run
+    puts <<-HELP
+Usage: crab defect <command> [options*]
+
+  Available commands:
+
+  create  Create a new defect in a story
+  delete  Delete an existing defect
+    find  Find defects
+    help  Show this help text
+    list  List defects
+    show  Show a defect (and its steps) as a Cucumber scenario
+  update  Update a defect
+
+     --help, -h:   Show this message
+    HELP
+  end
+end
+
+Crab::DefectHelp.run

data/bin/crab-help

@@ -13,10 +13,12 @@ crab version #{Crab::VERSION}: A Cucumber-Rally bridge
   Available commands:
 
        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
+
+     defect  Manipulate defects
+  iteration  Manipulate iterations
     release  Manipulate releases
       story  Manipulate stories
    testcase  Manipulate test cases

data/bin/crab-login

@@ -13,16 +13,26 @@ class Crab::Login
         banner <<-BANNER
 Usage: crab login [options*]
 
-Log into Rally. Your credentials will be written to ~/.crab/credentials.
+Log into Rally. Your credentials will be written to ~/.crab/credentials unless --project is specified.
         BANNER
 
         opt :username, "Username", :type => String, :short => "-u"
         opt :password, "Password", :type => String, :short => "-p"
+        opt :project, "Store credentials into current folder", :short => "-P", :default => false
       end
 
       username = opts[:username_given] ? opts[:username] : ask("Username: ")
       password = opts[:password_given] ? opts[:password] : ask("Password: ") {|q| q.echo = false }
 
+      crab_dir = if opts[:project]
+        File.expand_path "./.crab"
+      else
+        File.expand_path "~/.crab"
+      end
+
+      FileUtils.mkdir_p crab_dir
+      credentials_file = "#{crab_dir}/credentials"
+
       File.open(credentials_file, 'w') do |file|
         file.puts username
         file.puts password

data/bin/crab-logout

@@ -14,15 +14,16 @@ class Crab::Logout
         banner <<-BANNER
 Usage: crab logout [options*]
 
-Log out of Rally. Your credentials will be removed from ~/.crab/credentials.
+Log out of Rally. Your credentials will be removed from current project directory or home folder (~/.crab/credentials).
         BANNER
         opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
       end
 
       fileutils_opts = opts[:dry] ? {:noop => true, :verbose => true} : {}
-      FileUtils.rm_rf(credentials_file, fileutils_opts)
+      file = credentials_file
+      FileUtils.rm_rf(file, fileutils_opts)
 
-      puts "Credentials removed for #{username}"
+      puts "Credentials removed from #{file}"
 
     end
   end

data/bin/crab-project

@@ -15,14 +15,21 @@ crab project: show or persistently select project to work with in Rally
 
 Usage: crab project [name] [options*]
         BANNER
+        opt :clear, "Remove a previous project selection", :short => "-c", :default => false
         opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
       end
 
       name = args.join(" ").strip
+      is_dry_run = opts[:dry] ? { :noop => true, :verbose => true } : {}
 
       if name.empty?
         if current_project_name.present?
-          puts current_project_name
+          if opts[:clear]
+            FileUtils.rm_rf dotcrab_file("project"), is_dry_run
+            puts "Project selection removed."
+          else
+            puts current_project_name
+          end
         else
           puts "No project currently selected."
         end
@@ -33,7 +40,7 @@ Usage: crab project [name] [options*]
         project = rally.find_project name
         Trollop::die "#{name.inspect} is not a valid project" if project.nil?
 
-        FileUtils.mkdir_p ".crab", opts[:dry] ? { :noop => true, :verbose => true } : {}
+        FileUtils.mkdir_p ".crab", is_dry_run
         file = ".crab/project"
         output = project.name
 

data/bin/crab-tc-add

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

data/bin/crab-tc-create

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

data/bin/crab-tc-new

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

data/bin/crab-testcase-add

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

data/bin/crab-testcase-create

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

data/bin/crab-testcase-new

@@ -12,7 +12,7 @@ class Crab::TestCaseCreate
       opts = add_or_update_options <<-BANNER, args
 crab testcase create: add a test case to a story in Rally
 
-Usage: crab testcase create <story> <name> [options*]
+Usage: crab testcase create <story> --name <name> [options*]
       BANNER
 
       story_id = args.shift
@@ -24,7 +24,6 @@ Usage: crab testcase create <story> <name> [options*]
 
       unless opts[:name_given]
         logger.error "Error: Test case name not provided."
-        system "crab-testcase-help"
         exit 1
       end
 
@@ -32,7 +31,6 @@ Usage: crab testcase create <story> <name> [options*]
         tc = rally.create_test_case(story_id, name, sanitize_options(opts))
         puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
       end
-
     end
   end
 end

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

@@ -11,3 +11,11 @@ Feature: Log In and Out of Rally
     Then the exit status should be 0
     And the user's home directory should have a file named ".crab/credentials"
 
+  Scenario: Logged Out, Logging In project specific
+    Given a directory named "my-project"
+    And I cd to "my-project"
+    When I run `crab login -P` interactively
+    And I type my username
+    And I type my password
+    Then the exit status should be 0
+    And a file named ".crab/credentials" should exist

data/features/project-selection.feature

@@ -1,18 +1,24 @@
 Feature: Project Selection
-  
+
   In order to work with the find, list etc commands more effectively
   A lazy developer
   Wants to set the project persistently across all commands
 
-  Background: 
+  Background:
     Given I am logged in
 
-  Scenario: Selecting a Project
-    Given no project is selected
+  Scenario: Selecting and Clearing Projects
+    Given I select my test project
+
+    When I run `crab project --clear`
+    Then the output should contain "Project selection removed."
+
     When I run `crab project`
     Then the output should contain "No project currently selected."
+
     When I select my test project
     Then the exit status should be 0
+
     When I run `crab project`
     Then the output should be the name of my test project
 

data/features/recursively-look-for-dotcrab-folder.feature

@@ -0,0 +1,31 @@
+Feature: Recursively looks for .crab folder
+
+  In order to easily work with multiple projects and avoid having to cd back into project's root
+  A lazy developer
+  Wants to run crab from any project's subfolder
+
+  Background:
+    Given a directory named "crab-project/subfolder/othersubfolder"
+
+  Scenario: Uses Parent Folder Project Settings From Any Subfolder
+    Given I am logged in
+    And no project is selected
+    And I cd to "crab-project"
+    And I have selected my test project
+    When I cd to "subfolder"
+    And I run `crab project`
+    Then the output should be the name of my test project
+    When I cd to "othersubfolder"
+    And I run `crab project`
+    Then the output should be the name of my test project
+
+  Scenario: Uses Parent Folder Credentials From Subfolder
+    Given I run `crab logout`
+    And I cd to "crab-project"
+    When I run `crab login -P` interactively
+    And I type my username
+    And I type my password
+    Then a file named ".crab/credentials" should exist
+    When I cd to "subfolder"
+    And I run `crab logout`
+    Then a file named "../.crab/credentials" should not exist

data/features/steps/rally_steps.rb

@@ -21,17 +21,10 @@ def get_story(story_id)
 end
 
 def get_project
-  if File.exists? ".crab/tests/project"
-    File.read(".crab/tests/project").strip
+  project_file = File.expand_path("~/.crab/tests/project")
+  if File.exists? project_file
+    File.read(project_file).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
@@ -45,10 +38,12 @@ crab version #{Crab::VERSION}: A Cucumber-Rally bridge
   Available commands:
 
        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
+
+     defect  Manipulate defects
+  iteration  Manipulate iterations
     release  Manipulate releases
       story  Manipulate stories
    testcase  Manipulate test cases
@@ -110,6 +105,7 @@ end
 
 Given /^no project is selected$/ do
   Given 'I run `rm -rf ".crab/project"`'
+  Then 'the exit status should be 0'
 end
 
 Given /^I have selected the project "([^"]*)"$/ do |project|
@@ -122,13 +118,15 @@ Given /^I have selected the project "([^"]*)"$/ do |project|
 end
 
 Given /^I have selected my test project$/ do
-  When %Q{I run `crab project "#{get_test_project}"`}
+  When %{I run `crab project "#{get_project}"`}
+  Then %{the exit status should be 0}
 end
 
 When /^I select my test project$/ do
-  When %Q{I run `crab project "#{get_test_project}"`}
+  When %{I run `crab project "#{get_project}"`}
+  Then %{the exit status should be 0}
 end
 
 Then /^the output should be the name of my test project$/ do
-  Then %Q{the output should contain "#{get_test_project}"}
+  Then %Q{the output should contain "#{get_project}"}
 end

data/features/subcommand-help.feature

@@ -38,7 +38,7 @@ Feature: Subcommand Help
       | story show      | Usage: crab story show <id> [options*]                |
       | story help      | Usage: crab story <command> [options*]                |
 
-      | testcase create | Usage: crab testcase create <story> <name> [options*] |
+      | testcase create | Usage: crab testcase create <story> --name <name> [options*] |
       | testcase update | Usage: crab testcase update <id> [options*]           |
       | testcase delete | Usage: crab testcase delete <id> [options*]           |
       | testcase find   | Usage: crab testcase find [options*] [text]           |

data/lib/crab/defect.rb

@@ -0,0 +1,51 @@
+class Crab::Defect
+
+  def initialize(rally_defect)
+    @rally_defect = rally_defect
+  end
+
+  def formatted_id
+    @rally_defect.formatted_i_d
+  end
+
+  def name
+    @rally_defect.name
+  end
+
+  def description
+    @rally_defect.description
+  end
+
+  def environment
+    @rally_defect.environment
+  end
+
+  def browser
+    @rally_defect.navegador
+  end
+
+  def statte
+    @rally_defect.schedule_state
+  end
+
+  def severity
+    @rally_defect.severity
+  end
+
+  def target_date
+    @rally_defect.target_date
+  end
+
+  def task_status
+    @rally_defect.task_status
+  end
+
+  def test_case_status
+    @rally_defect.test_case_status
+  end
+
+  def delete
+    @rally_defect.delete
+  end
+
+end

data/lib/crab/rally.rb

@@ -15,7 +15,13 @@ module Crab
     def connect
       get_credentials
       logger.info "Connecting to Rally as #{@username}..."
-      @rally = ::RallyRestAPI.new :username => @username, :password => @password
+
+      rally_logger = Logger.new(STDERR)
+      rally_logger.formatter = Logger::Formatter.new
+      rally_logger.progname = 'rally'
+      rally_logger.level = ENV['CRAB_LOG_LEVEL'].present? ? ENV['CRAB_LOG_LEVEL'].to_i : Logger::WARN
+
+      @rally = ::RallyRestAPI.new :username => @username, :password => @password, :logger => rally_logger
     end
 
     def get_credentials
@@ -30,6 +36,13 @@ module Crab
       Crab::Story.new(story, @dry_run)
     end
 
+    def find_defect_with_id defect_id
+      logger.info "Looking up defect with ID #{defect_id}"
+      defect = @rally.find(:defect) { equal :formatted_i_d, defect_id }.first
+      Trollop::die "Defect with ID #{defect_id.inspect} not found" if defect.nil?
+      Crab::Defect.new(defect, @dry_run)
+    end
+
     def find_testcases(project, pattern, opts)
       logger.info "Looking for testcases matching #{pattern.inspect} with options #{opts.keys.inspect} in #{project.name.inspect}"
 
@@ -52,6 +65,25 @@ module Crab
       end
     end
 
+    def find_defects(project, pattern, opts)
+      logger.info "Looking for defects matching #{pattern.inspect} with options #{opts.keys.inspect} in #{project.name.inspect}"
+      if pattern.join.empty? && opts.empty?
+        return @rally.find_all(:defect, :fetch => true, :project => project).map {|s| Crab::Defect.new(s, @dry_run) }
+      end
+
+      rally_stories = @rally.find(:defect, :fetch => true, :project => project) do
+        Crab::Rally.search_for_words_in pattern, self
+
+        equal :iteration, opts[:iteration] if opts[:iteration]
+        equal :release,   opts[:release]   if opts[:release]
+        equal :parent,    opts[:parent].rally_object if opts[:parent]
+      end
+
+      rally_stories.map {|defect| Crab::Defect.new(defect, @dry_run) }.tap do |defects|
+        logger.info "Found #{defects.size} defects"
+      end
+    end
+
     def find_stories(project, pattern, opts)
       logger.info "Looking for stories matching #{pattern.inspect} with options #{opts.keys.inspect} in #{project.name.inspect}"
       if pattern.join.empty? && opts.empty?

data/lib/crab/utilities.rb

@@ -4,8 +4,7 @@ module Crab
     include Logging
 
     def credentials_file
-      FileUtils.mkdir_p File.expand_path("~/.crab")
-      File.expand_path("~/.crab/credentials")
+      dotcrab_file 'credentials'
     end
 
     def valid_credentials_file
@@ -20,9 +19,8 @@ module Crab
     end
 
     def current_project_name
-      if File.exists? ".crab/project"
-        File.read(".crab/project").strip
-      end
+      project_file = dotcrab_file('project')
+      File.read(project_file).strip if File.exists?(project_file)
     end
 
     def state_from(option)
@@ -77,5 +75,21 @@ module Crab
     def sanitize(source)
       Sanitize.clean source, :remove_contents => %w{style}
     end
+
+    def dotcrab_file(file)
+      current_folder = File.expand_path '.'
+
+      while current_folder != '/'
+
+        dotcrab = "#{current_folder}/.crab"
+        if File.exists? "#{dotcrab}/#{file}"
+          return "#{dotcrab}/#{file}"
+        end
+        current_folder = File.expand_path "#{current_folder}/.."
+
+      end
+
+      File.expand_path "~/.crab/#{file}"
+    end
   end
 end

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.2.12"
+  VERSION = "0.2.13"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 2
-  - 12
-  version: 0.2.12
+  - 13
+  version: 0.2.13
 platform: ruby
 authors: 
 - Carlos Villela
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-05 00:00:00 -03:00
+date: 2011-10-06 00:00:00 -03:00
 default_executable: crab
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -149,6 +149,10 @@ email:
 - cvillela@thoughtworks.com
 executables: 
 - crab
+- crab-defect
+- crab-defect-delete
+- crab-defect-find
+- crab-defect-help
 - crab-help
 - crab-it
 - crab-it-help
@@ -249,6 +253,10 @@ files:
 - README.md
 - Rakefile
 - bin/crab
+- bin/crab-defect
+- bin/crab-defect-delete
+- bin/crab-defect-find
+- bin/crab-defect-help
 - bin/crab-help
 - bin/crab-it
 - bin/crab-it-help
@@ -345,6 +353,7 @@ files:
 - features/move-in-rally.feature
 - features/project-selection.feature
 - features/pull-from-rally-into-cucumber.feature
+- features/recursively-look-for-dotcrab-folder.feature
 - features/show-from-rally.feature
 - features/steps/rally_steps.rb
 - features/subcommand-help.feature
@@ -354,6 +363,7 @@ files:
 - lib/crab/cucumber_feature.rb
 - lib/crab/cucumber_scenario.rb
 - lib/crab/cucumber_to_rally_adapter.rb
+- lib/crab/defect.rb
 - lib/crab/logging.rb
 - lib/crab/rally.rb
 - lib/crab/rally_to_cucumber_adapter.rb