crab 0.1.7 → 0.1.8

data/.gitignore

@@ -1,3 +1,4 @@
+*.swp
 *.gem
 .bundle
 Gemfile.lock

data/README.md

@@ -144,7 +144,6 @@ To do / Roadmap
 
 ### 0.2.0
 
-- Add a `move` subcommand which moves the story from one state to the next (potentially, `move --back`)
 - `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`
 - Verbose logging (especially before any change or destructive operations in Rally)

data/Rakefile

@@ -12,12 +12,27 @@ namespace :cucumber do
   desc "Basic test suite set-up"
   task :setup do
     require 'highline/import'
-    test_project = ask("Name of the project in Rally to be used for tests: ")
 
-    dot_crab = File.expand_path("~/.crab")
+    puts """
+In order to run the Cucumber tests for crab itself, we need a few
+details from you. These are stored in ~/.crab/tests/ and do not affect
+normal usage.
+    """
+
+    username = ask("Username: ")
+    password = ask("Password: ") {|q| q.echo = false }
+    project = ask("Project to test against: ")
+
+    dot_crab = File.expand_path("~/.crab/tests")
     FileUtils.mkdir_p dot_crab
-    File.open(File.join(dot_crab, 'test_project'), 'w') do |file|
-      file.puts test_project
+
+    File.open(File.join(dot_crab, 'credentials'), 'w') do |file|
+      file.puts username
+      file.puts password
+    end
+
+    File.open(File.join(dot_crab, 'project'), 'w') do |file|
+      file.puts project
     end
   end
 

data/bin/crab-add

@@ -0,0 +1,19 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab create: create a new story in Rally
+
+Usage: crab create name [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+name = ARGV.join(" ")
+Trollop::die "Please specify a name for the story" if name.blank?
+
+rally.connect
+story = rally.create_story :name => name
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-change

@@ -0,0 +1,61 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab update: update a story in Rally
+
+Usage: crab update story [options]
+  BANNER
+  opt :name,      "Name (title)", :type => String, :short => "-n"
+  opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
+  opt :estimate,  "Estimate",     :type => :int,   :short => "-e"
+  opt :iteration, "Iteration",    :type => String, :short => "-i"
+  opt :release,   "Release",      :type => String, :short => "-r"
+  opt :blocked,   "Blocked",      :short => "-b"
+  opt :unblocked, "Unblocked",    :short => "-u"
+  opt :parent,    "Parent",       :type => String, :short => "-p"
+end
+
+rally = Crab::Rally.new
+
+Trollop::die "No story given" if ARGV.empty?
+Trollop::die "Nothing to update. Please provide some options" unless cmd_opts.any? {|k, v| k.to_s =~ /_given$/ }
+
+opts = {}
+opts[:name] = cmd_opts[:name] if cmd_opts[:name_given]
+opts[:schedule_state] = state_from(cmd_opts[:state]) if cmd_opts[:state_given]
+
+if cmd_opts[:estimate_given]
+  opts[:plan_estimate] = cmd_opts[:estimate] # nobody is going to remember "Plan Estimate", really
+end
+
+opts[:blocked] = cmd_opts[:blocked] if cmd_opts[:blocked_given]
+opts[:blocked] = !cmd_opts[:unblocked] if cmd_opts[:unblocked_given]
+
+rally.connect
+
+story = rally.find_story_with_id ARGV.first
+
+if cmd_opts[:iteration_given]
+  opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+  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]
+  Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
+end
+
+if cmd_opts[:parent_given]
+  opts[:parent] = rally.find_story_with_id(cmd_opts[:parent]).rally_object
+  Trollop::die "Unknown story \"#{cmd_opts[:parent]}\"" if opts[:parent].nil?
+end
+
+opts[:name] = story.name if opts[:name].blank?
+
+story.update opts
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-create

@@ -0,0 +1,19 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab create: create a new story in Rally
+
+Usage: crab create name [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+name = ARGV.join(" ")
+Trollop::die "Please specify a name for the story" if name.blank?
+
+rally.connect
+story = rally.create_story :name => name
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-del

@@ -0,0 +1,22 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab delete: delete an existing story in Rally
+
+Usage: crab delete story [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+
+story_id = ARGV.join(" ")
+Trollop::die "Story ID must be specified" if story_id.blank?
+
+rally.connect
+story = rally.find_story_with_id story_id
+
+story.delete
+
+puts "Story #{story_id} deleted."

data/bin/crab-delete

@@ -0,0 +1,22 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab delete: delete an existing story in Rally
+
+Usage: crab delete story [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+
+story_id = ARGV.join(" ")
+Trollop::die "Story ID must be specified" if story_id.blank?
+
+rally.connect
+story = rally.find_story_with_id story_id
+
+story.delete
+
+puts "Story #{story_id} deleted."

data/bin/crab-find

@@ -0,0 +1,27 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab find: find a story in Rally
+
+Usage: crab find [options] [text]
+  BANNER
+  opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+end
+
+rally = Crab::Rally.new
+pattern = ARGV.map(&:strip).reject(&:empty?)
+project_name = valid_project_name(cmd_opts)
+
+rally.connect
+
+project = rally.find_project(project_name)
+
+Trollop::die "Project #{cmd_opts[:project].inspect} not found" if project.nil?
+
+rally.find_stories(project, pattern).each do |story|
+  puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+end

data/bin/crab-login

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = Trollop::options do
+  banner <<-BANNER
+Usage: crab login [options]
+
+Log into Rally. Your credentials will be written to ~/.crab/credentials.
+  BANNER
+
+  opt :username, "Username", :type => String, :short => "-u"
+  opt :password, "Password", :type => String, :short => "-p"
+end
+
+username = opts[:username_given] ? opts[:username] : ask("Username: ")
+password = opts[:password_given] ? opts[:password] : ask("Password: ") {|q| q.echo = false }
+
+File.open(credentials_file, 'w') do |file|
+  file.puts username
+  file.puts password
+end
+
+puts "Logged in as #{username}"

data/bin/crab-move

@@ -0,0 +1,26 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab move: move a story from one status to the next (or previous)
+
+Usage: crab move story [options]
+  BANNER
+  opt :back, "Move story backwards (from accepted to completed, for example)"
+end
+
+rally = Crab::Rally.new
+story_id = ARGV.join(" ")
+Trollop::die "No story given" if story_id.empty?
+
+rally.connect
+
+story = rally.find_story_with_id story_id
+state = state_from(story.state)
+
+story.update :schedule_state => (cmd_opts[:back] ? state_before(state) : state_after(state))
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-mv

@@ -0,0 +1,26 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab move: move a story from one status to the next (or previous)
+
+Usage: crab move story [options]
+  BANNER
+  opt :back, "Move story backwards (from accepted to completed, for example)"
+end
+
+rally = Crab::Rally.new
+story_id = ARGV.join(" ")
+Trollop::die "No story given" if story_id.empty?
+
+rally.connect
+
+story = rally.find_story_with_id story_id
+state = state_from(story.state)
+
+story.update :schedule_state => (cmd_opts[:back] ? state_before(state) : state_after(state))
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-project

@@ -0,0 +1,35 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab project: show or persistently select project to work with in Rally
+
+Usage: crab project [name]
+  BANNER
+end
+
+rally = Crab::Rally.new
+
+current_project_name = self.class.current_project_name
+if current_project_name.present?
+  puts current_project_name
+
+elsif ARGV.reject {|arg| arg.blank? }.empty?
+  puts "No project currently selected."
+
+else
+  name = ARGV.join(" ").strip
+
+  rally.connect
+
+  project = rally.find_project name
+  Trollop::die "#{name.inspect} is not a valid project" if project.nil?
+
+  FileUtils.mkdir_p ".crab"
+  File.open(".crab/project", "w") do |file|
+    file.puts project.name
+  end
+end

data/bin/crab-pull

@@ -0,0 +1,28 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab pull: pulls stories from Rally and writes them out as Cucumber features
+
+Usage: crab pull [options] story1 [story2 ...]
+  BANNER
+  opt :language, "Language to generate Cucumber features in (ISO code)", :default => "en", :short => "-l"
+end
+
+rally = Crab::Rally.new
+rally.connect
+
+ARGV.each do |story_number|
+  story = rally.find_story_with_id story_number
+  Trollop::die "Could not find story with ID #{story_number}" if story.nil?
+
+  puts "#{story.formatted_id}: #{story.full_file_name}"
+
+  FileUtils.mkdir_p File.dirname(story.full_file_name)
+  FileUtils.touch story.full_file_name
+
+  File.open(story.full_file_name, "w") do |file|
+    file.write Crab::CucumberFeature.new(cmd_opts[:language]).generate_from story
+  end
+end

data/bin/crab-remove

@@ -0,0 +1,22 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab delete: delete an existing story in Rally
+
+Usage: crab delete story [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+
+story_id = ARGV.join(" ")
+Trollop::die "Story ID must be specified" if story_id.blank?
+
+rally.connect
+story = rally.find_story_with_id story_id
+
+story.delete
+
+puts "Story #{story_id} deleted."

data/bin/crab-rm

@@ -0,0 +1,22 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab delete: delete an existing story in Rally
+
+Usage: crab delete story [options]
+  BANNER
+end
+
+rally = Crab::Rally.new
+
+story_id = ARGV.join(" ")
+Trollop::die "Story ID must be specified" if story_id.blank?
+
+rally.connect
+story = rally.find_story_with_id story_id
+
+story.delete
+
+puts "Story #{story_id} deleted."

data/bin/crab-show

@@ -0,0 +1,20 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab show: displays a story in Rally as a Cucumber feature
+
+Usage: crab show story"
+  BANNER
+  opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
+end
+
+story_id = ARGV.first
+rally = Crab::Rally.new
+
+rally.connect
+
+story = rally.find_story_with_id story_id
+
+puts Crab::CucumberFeature.new(cmd_opts[:language]).generate_from story

data/bin/crab-tc

@@ -0,0 +1,79 @@
+# vim: set ft=ruby :
+require 'crab'
+
+def add_or_update_options(banner)
+  Trollop::options do
+    banner banner
+    opt :priority, "Priority (one of: #{Crab::TestCase::PRIORITIES.join(" ")}", :default => "important", :short => '-p'
+    opt :risk,     "Risk (one of: #{Crab::TestCase::RISKS.join(" ")})", :default => "medium", :short => '-r'
+    opt :method,   "Method (one of: #{Crab::TestCase::METHODS.join(" ")})", :default => "automated", :short => '-m'
+    opt :type,     "Type (one of: #{Crab::TestCase::TYPES.join(" ")})", :default => "acceptance", :short => '-t'
+    opt :pre,      "Pre-conditions", :default => "N/A"
+    opt :post,     "Post-conditions", :default => "N/A"
+    opt :desc,     "Description", :default => "N/A", :short => '-d'
+  end
+end
+
+def sanitize_options(opts, creating=true)
+  result = {}
+  result[:priority] = opts[:priority].capitalize if creating || opts[:priority_given]
+  result[:risk] = opts[:risk].capitalize if creating || opts[:risk_given]
+  result[:method] = opts[:method].capitalize if creating || opts[:method_given]
+  result[:type] = opts[:type].capitalize if creating || opts[:type_given]
+  result[:pre_conditions] = opts[:pre] if creating || opts[:pre_given]
+  result[:post_conditions] = opts[:post] if creating || opts[:post_given]
+  result[:description] = opts[:desc] if creating || opts[:desc_given]
+  result
+end
+
+rally = Crab::Rally.new
+
+Trollop::options do
+  banner <<-BANNER
+crab testcase: manage test cases in a story (add, update, delete)
+
+Usage: crab testcase add story name [options]
+       crab testcase update testcase [options]
+       crab testcase delete testcase [options]
+  BANNER
+  stop_on %w{add update delete}
+end
+
+sub = ARGV.shift
+case sub
+when "add"
+  opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+
+  story_id = ARGV.shift
+  name = ARGV.join(" ")
+  add(story_id, name, opts)
+
+  rally.connect
+  tc = rally.create_test_case(story_id, name, sanitize_options(opts))
+
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+
+when "update"
+  opts = add_or_update_options "crab testcase update: update a test case in Rally"
+
+  tc_id = ARGV.shift
+
+  rally.connect
+  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(" ")})"
+
+when "delete"
+  Trollop::options do
+    banner "crab testcase delete: delete a test case in Rally"
+  end
+
+  tc_id = ARGV.shift
+  rally.connect
+  tc = rally.find_test_case(tc_id)
+  tc.delete
+  puts "Test case #{tc_id} deleted."
+
+else
+  Trollop::die "Unknown subcommand#{' ' + sub.inspect if sub}"
+end