trackinator 0.0.14 → 0.0.15

data/README.md

@@ -12,11 +12,11 @@ benefits to this approach:
 
 The format of the spreadsheet is as follows (columns can be in any order):
 
-####project
+####project (required)
 The abbreviation for the project in YouTrack.  The project must
 exist in YouTrack already, this gem will not create the project for you
 
-####id
+####id (required)
 Similar to a version number.  Must be unique in this test plan.  Follows
 the format x.y.z (this example is 3 levels deep) and there is no limit
 to nesting depth.  Each level denotes sub-tickets that will be created
@@ -25,29 +25,29 @@ and associated to the level above.
 ####type
 "Story" for top level items, "Features" and "Tasks" for items one or more
 levels below "Story".  “Features” are user facing and "Tasks" are
-implementation details.  "Tasks" will not be acceptance tested.
+implementation details.  "Tasks" will not be acceptance tested. Defaults to "bug"
 
-####summary
+####subsystem (required)
+This is one of iOS, Android, Backend
+
+####summary (required)
 A one-line summarizing of the feature.
 
-####description
+####description (required)
 A description of the feature including steps to use the feature.
 
-####outcome
+####outcome (required)
 The expected outcome if the feature is used per the steps in the description.
 
 ####notes
 Any additional notes (which will show up as a comment) that might be useful
 for the developer or tester.
 
-####references
+####design reference
 A reference to the design document.  The format should be wf/c-<page>-<screen
 (or range)>.  E.g. wf-12-5 or c-9-2-3 (where "wf" refers to wireframe and "c"
 refers to composition)
 
-####platform
-This is usually one of iOS, iPhone, iPad, Android, Desktop Web, Mobile Web
-
 ####priority
 One of Low, Normal, High, Show-stopper
 
@@ -76,6 +76,8 @@ Options:
          --youtrack-host, -o <s>:   YouTrack host
          --youtrack-port, -r <i>:   YouTrack port (default: 80)
   --youtrack-path-prefix, -e <s>:   YouTrack path prefix (e.g. '/youtrack/') (default: /)
+                 --create-rc, -c:   Create a .trackinatorrc file in your home dir
+                   --dry-run, -d:   Try it out but don't actually import
                       --help, -h:   Show this message
                         filename:   File name in Google Docs
 </pre>

data/lib/trackinator/importer.rb

@@ -18,7 +18,9 @@ module Trackinator
     def import file_name
       ticket_data = @google.get_tickets file_name
 
-      issues = validate_tickets(ticket_data)
+      issues = []
+      issues.concat validate_headings(ticket_data[0])
+      issues.concat validate_tickets(ticket_data)
 
       if issues.length == 0 && !@dry_run
         puts "importing..."
@@ -34,6 +36,10 @@ module Trackinator
 
     private
 
+    def validate_headings headings
+      []
+    end
+
     def validate_tickets tickets
       puts "validating..."
       issues = []
@@ -47,7 +53,7 @@ module Trackinator
       issues.concat(@you_track.project_exists?(project))
 
       tickets.each do |ticket|
-        issues.concat(@you_track.you_track_fields_defined?(project, ticket.keys.collect! { |key| key.downcase }))
+        issues.concat(@you_track.required_you_track_fields_defined?(project))
 
         issues.concat(validate_fields(ticket))
         issues.concat(validate_formats(ticket))
@@ -59,7 +65,7 @@ module Trackinator
     def validate_fields ticket
       issues = []
 
-      REQUIRED.each do |req_field|
+      GOOGLE_REQUIRED.each do |req_field|
         unless ticket.keys.include?(req_field) || ticket["type"].downcase.eql?("story")
           issues << "Validation Error: Ticket with ID: #{ticket["id"]} is missing required field '#{req_field}'"
         end
@@ -72,7 +78,9 @@ module Trackinator
       issues = []
 
       ticket.keys.each do |key|
-        validate_format(key, ticket[key])
+        unless validate_format(key, ticket[key])
+          issues << "Validation Error: Ticket with ID: #{ticket["id"]} has field '#{key}' with invalid format"
+        end
       end
 
       issues
@@ -80,7 +88,9 @@ module Trackinator
 
     def validate_format key, value
       if Trackinator.const_defined?("#{key.upcase}") && Trackinator.const_get("#{key.upcase}").match(value.downcase).nil?
-        issues << "Validation Error: Ticket with ID: #{ticket["id"]} has field '#{key}' with invalid format"
+        false
+      else
+        true
       end
     end
   end

data/lib/trackinator/version.rb

@@ -1,3 +1,3 @@
 module Trackinator
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/lib/trackinator/you_track.rb

@@ -52,23 +52,35 @@ module Trackinator
       issues
     end
 
-    def you_track_fields_defined?(project, fields)
+    # Here's a potential approach for validating that YouTrack fields are present
+    #
+    # get YouTrack fields from server
+    # augment YouTrack fields where necessary (import identifier?)
+    # copy YouTrack fields and normalize copy (remove spaces, downcase)
+    # create map of YouTrack fields to nYouTrack fields
+    # get Google fields from doc
+    # normalize Google fields (remove spaces, downcase)
+    # subtract nGoogle from nYouTrack (leaving only missing YouTrack fields)
+    # subtract nYouTrack from nGoogle (leaving only missing Google fields)
+    # warn on missing nGoogle
+    # fail validation on nYouTrack using map to get actual field names for display
+    # ...
+    # or, just hard code the fucking thing and be done with it
+
+    def required_you_track_fields_defined?(project)
+      you_track_fields = []
       issues = []
 
       response = @connection.get("#{@path_prefix}rest/admin/project/#{project}/customfield", { 'Cookie' => @cookie, 'Content-Type' => 'text/plain; charset=utf-8' })
       response_xml = REXML::Document.new(response.body)
 
-      you_track_fields = %w{ notes }
-
       response_xml.elements.each('projectCustomFieldRefs/projectCustomField') do |element|
-        you_track_fields << element.attributes["name"].sub(' ', '').downcase
+        you_track_fields << element.attributes["name"]
       end
 
-      required_fields = fields - REQUIRED
-
-      required_fields.each do |document_field|
-        unless you_track_fields.include?(document_field)
-          issues << "Validation Error: Custom field '#{document_field}' not found in YouTrack"
+      YOU_TRACK_REQUIRED.each do |required_field|
+        unless you_track_fields.include?(required_field)
+          issues << "Validation Error: Required field '#{required_field}' not found in YouTrack project"
         end
       end
 

data/lib/trackinator.rb

@@ -13,14 +13,21 @@ module Trackinator
 
   SUBSYSTEM = /^android$|^backend$|^ios$/
 
-  REQUIRED = %w{
+  GOOGLE_REQUIRED = %w{
       project
       id
+      subsystem
       summary
       description
       outcome
   }
 
+  YOU_TRACK_REQUIRED = [
+      "Type",
+      "Subsystem",
+      "Import Identifier"
+  ]
+
   TRACKINATOR_RC = %w{
       youtrack_username
       youtrack_password

data/spec/trackinator/importer_spec.rb

@@ -68,36 +68,42 @@ module Trackinator
       end
 
       it "#validate_fields should return no issues and validate feature" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "project" => "YTTP", "id" => "1.2", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "id" => "1.2", "type" => "feature", "subsystem" => "ios", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
         issues.should == []
       end
 
       it "#validate_fields should return 1 issue: missing project" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "id" => "1.2", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
+        issues = @importer.send(:validate_fields, { "id" => "1.2", "type" => "feature", "subsystem" => "ios", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID: 1.2 is missing required field 'project'"
       end
 
       it "#validate_fields should return 1 issue: missing id" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "project" => "YTTP", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "type" => "feature", "subsystem" => "ios", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID:  is missing required field 'id'"
       end
 
+      it "#validate_fields should return 1 issue: missing subsystem" do
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "id" => "1.2", "type" => "feature", "summary" => "A summary", "description" => "A description", "outcome" => "An outcome" })
+        issues.size.should == 1
+        issues[0].should == "Validation Error: Ticket with ID: 1.2 is missing required field 'subsystem'"
+      end
+
       it "#validate_fields should return 1 issue: missing summary" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "project" => "YTTP", "id" => "1.2", "description" => "A description", "outcome" => "An outcome" })
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "id" => "1.2", "type" => "feature", "subsystem" => "ios", "description" => "A description", "outcome" => "An outcome" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID: 1.2 is missing required field 'summary'"
       end
 
       it "#validate_fields should return 1 issue: missing description" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "project" => "YTTP", "id" => "1.2", "summary" => "A summary", "outcome" => "An outcome" })
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "id" => "1.2", "type" => "feature", "subsystem" => "ios", "summary" => "A summary", "outcome" => "An outcome" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID: 1.2 is missing required field 'description'"
       end
 
       it "#validate_fields should return 1 issue: missing outcome" do
-        issues = @importer.send(:validate_fields, { "type" => "feature", "project" => "YTTP", "id" => "1.2", "summary" => "A summary", "description" => "A description" })
+        issues = @importer.send(:validate_fields, { "project" => "YTTP", "id" => "1.2", "type" => "feature", "subsystem" => "ios", "summary" => "A summary", "description" => "A description" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID: 1.2 is missing required field 'outcome'"
       end
@@ -111,34 +117,34 @@ module Trackinator
         @importer = Importer.new @you_track, @google
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should return no issues and validate type" do
         issues = @importer.send(:validate_formats, { "type" => "feature" })
         issues.should == []
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should fail validation on type" do
         issues = @importer.send(:validate_formats, { "type" => "foo" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID:  has field 'type' with invalid format"
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should fail validation on id" do
         issues = @importer.send(:validate_formats, { "id" => "1.2" })
         issues.should == []
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should fail validation on id" do
         issues = @importer.send(:validate_formats, { "id" => "junk" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID: junk has field 'id' with invalid format"
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should return no issues and validate priority" do
         issues = @importer.send(:validate_formats, { "priority" => "normal" })
         issues.should == []
       end
 
-      it "#validate_formats should return no issues and validate" do
+      it "#validate_formats should fail validation on priority" do
         issues = @importer.send(:validate_formats, { "priority" => "junk" })
         issues.size.should == 1
         issues[0].should == "Validation Error: Ticket with ID:  has field 'priority' with invalid format"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackinator
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gdata_19