chris@37: # Redmine - project management software
chris@37: # Copyright (C) 2006-2010  Jean-Philippe Lang
chris@37: #
chris@37: # This program is free software; you can redistribute it and/or
chris@37: # modify it under the terms of the GNU General Public License
chris@37: # as published by the Free Software Foundation; either version 2
chris@37: # of the License, or (at your option) any later version.
chris@37: # 
chris@37: # This program is distributed in the hope that it will be useful,
chris@37: # but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@37: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@37: # GNU General Public License for more details.
chris@37: # 
chris@37: # You should have received a copy of the GNU General Public License
chris@37: # along with this program; if not, write to the Free Software
chris@37: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
chris@37: 
Chris@117: require File.expand_path('../../../test_helper', __FILE__)
chris@37: 
chris@37: class ApiTest::IssuesTest < ActionController::IntegrationTest
chris@37:   fixtures :projects,
chris@37:     :users,
chris@37:     :roles,
chris@37:     :members,
chris@37:     :member_roles,
chris@37:     :issues,
chris@37:     :issue_statuses,
chris@37:     :versions,
chris@37:     :trackers,
chris@37:     :projects_trackers,
chris@37:     :issue_categories,
chris@37:     :enabled_modules,
chris@37:     :enumerations,
chris@37:     :attachments,
chris@37:     :workflows,
chris@37:     :custom_fields,
chris@37:     :custom_values,
chris@37:     :custom_fields_projects,
chris@37:     :custom_fields_trackers,
chris@37:     :time_entries,
chris@37:     :journals,
chris@37:     :journal_details,
chris@37:     :queries
chris@37: 
chris@37:   def setup
chris@37:     Setting.rest_api_enabled = '1'
chris@37:   end
chris@37: 
chris@37:   context "/index.xml" do
Chris@117:     # Use a private project to make sure auth is really working and not just
Chris@117:     # only showing public issues.
chris@37:     should_allow_api_authentication(:get, "/projects/private-child/issues.xml")
Chris@117:     
Chris@117:     should "contain metadata" do
Chris@117:       get '/issues.xml'
Chris@117:       
Chris@117:       assert_tag :tag => 'issues',
Chris@117:         :attributes => {
Chris@117:           :type => 'array',
Chris@117:           :total_count => assigns(:issue_count),
Chris@117:           :limit => 25,
Chris@117:           :offset => 0
Chris@117:         }
Chris@117:     end
Chris@117:     
Chris@117:     context "with offset and limit" do
Chris@117:       should "use the params" do
Chris@117:         get '/issues.xml?offset=2&limit=3'
Chris@117:         
Chris@117:         assert_equal 3, assigns(:limit)
Chris@117:         assert_equal 2, assigns(:offset)
Chris@117:         assert_tag :tag => 'issues', :children => {:count => 3, :only => {:tag => 'issue'}}
Chris@117:       end
Chris@117:     end
Chris@117: 
Chris@117:     context "with nometa param" do
Chris@117:       should "not contain metadata" do
Chris@117:         get '/issues.xml?nometa=1'
Chris@117:         
Chris@117:         assert_tag :tag => 'issues',
Chris@117:           :attributes => {
Chris@117:             :type => 'array',
Chris@117:             :total_count => nil,
Chris@117:             :limit => nil,
Chris@117:             :offset => nil
Chris@117:           }
Chris@117:       end
Chris@117:     end
Chris@117: 
Chris@117:     context "with nometa header" do
Chris@117:       should "not contain metadata" do
Chris@117:         get '/issues.xml', {}, {'X-Redmine-Nometa' => '1'}
Chris@117:         
Chris@117:         assert_tag :tag => 'issues',
Chris@117:           :attributes => {
Chris@117:             :type => 'array',
Chris@117:             :total_count => nil,
Chris@117:             :limit => nil,
Chris@117:             :offset => nil
Chris@117:           }
Chris@117:       end
Chris@117:     end
chris@37:   end
chris@37: 
chris@37:   context "/index.json" do
chris@37:     should_allow_api_authentication(:get, "/projects/private-child/issues.json")
chris@37:   end
chris@37: 
chris@37:   context "/index.xml with filter" do
chris@37:     should_allow_api_authentication(:get, "/projects/private-child/issues.xml?status_id=5")
chris@37: 
chris@37:     should "show only issues with the status_id" do
chris@37:       get '/issues.xml?status_id=5'
chris@37:       assert_tag :tag => 'issues',
chris@37:                  :children => { :count => Issue.visible.count(:conditions => {:status_id => 5}), 
chris@37:                                 :only => { :tag => 'issue' } }
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   context "/index.json with filter" do
chris@37:     should_allow_api_authentication(:get, "/projects/private-child/issues.json?status_id=5")
chris@37: 
chris@37:     should "show only issues with the status_id" do
chris@37:       get '/issues.json?status_id=5'
chris@37: 
chris@37:       json = ActiveSupport::JSON.decode(response.body)
Chris@117:       status_ids_used = json['issues'].collect {|j| j['status']['id'] }
chris@37:       assert_equal 3, status_ids_used.length
chris@37:       assert status_ids_used.all? {|id| id == 5 }
chris@37:     end
chris@37: 
chris@37:   end
chris@37: 
chris@37:   # Issue 6 is on a private project
chris@37:   context "/issues/6.xml" do
chris@37:     should_allow_api_authentication(:get, "/issues/6.xml")
chris@37:   end
chris@37: 
chris@37:   context "/issues/6.json" do
chris@37:     should_allow_api_authentication(:get, "/issues/6.json")
chris@37:   end
Chris@117:   
Chris@117:   context "GET /issues/:id" do
Chris@117:     context "with journals" do
Chris@117:       context ".xml" do
Chris@117:         should "display journals" do
Chris@117:           get '/issues/1.xml?include=journals'
Chris@117:           
Chris@117:           assert_tag :tag => 'issue',
Chris@117:             :child => {
Chris@117:               :tag => 'journals',
Chris@117:               :attributes => { :type => 'array' },
Chris@117:               :child => {
Chris@117:                 :tag => 'journal',
Chris@117:                 :attributes => { :id => '1'},
Chris@117:                 :child => {
Chris@117:                   :tag => 'details',
Chris@117:                   :attributes => { :type => 'array' },
Chris@117:                   :child => {
Chris@117:                     :tag => 'detail',
Chris@117:                     :attributes => { :name => 'status_id' },
Chris@117:                     :child => {
Chris@117:                       :tag => 'old_value',
Chris@117:                       :content => '1',
Chris@117:                       :sibling => {
Chris@117:                         :tag => 'new_value',
Chris@117:                         :content => '2'
Chris@117:                       }
Chris@117:                     }
Chris@117:                   }
Chris@117:                 }
Chris@117:               }
Chris@117:             }
Chris@117:         end
Chris@117:       end
Chris@117:     end
Chris@117:     
Chris@117:     context "with custom fields" do
Chris@117:       context ".xml" do
Chris@117:         should "display custom fields" do
Chris@117:           get '/issues/3.xml'
Chris@117:           
Chris@117:           assert_tag :tag => 'issue', 
Chris@117:             :child => {
Chris@117:               :tag => 'custom_fields',
Chris@117:               :attributes => { :type => 'array' },
Chris@117:               :child => {
Chris@117:                 :tag => 'custom_field',
Chris@117:                 :attributes => { :id => '1'},
Chris@117:                 :child => {
Chris@117:                   :tag => 'value',
Chris@117:                   :content => 'MySQL'
Chris@117:                 }
Chris@117:               }
Chris@117:             }
Chris@117:             
Chris@117:           assert_nothing_raised do
Chris@117:             Hash.from_xml(response.body).to_xml
Chris@117:           end
Chris@117:         end
Chris@117:       end
Chris@117:     end
Chris@117:     
Chris@117:     context "with subtasks" do
Chris@117:       setup do
Chris@117:         @c1 = Issue.generate!(:status_id => 1, :subject => "child c1", :tracker_id => 1, :project_id => 1, :parent_issue_id => 1)
Chris@117:         @c2 = Issue.generate!(:status_id => 1, :subject => "child c2", :tracker_id => 1, :project_id => 1, :parent_issue_id => 1)
Chris@117:         @c3 = Issue.generate!(:status_id => 1, :subject => "child c3", :tracker_id => 1, :project_id => 1, :parent_issue_id => @c1.id)
Chris@117:       end
Chris@117:       
Chris@117:       context ".xml" do
Chris@117:         should "display children" do
Chris@117:           get '/issues/1.xml?include=children'
Chris@117:           
Chris@117:           assert_tag :tag => 'issue', 
Chris@117:             :child => {
Chris@117:               :tag => 'children',
Chris@117:               :children => {:count => 2},
Chris@117:               :child => {
Chris@117:                 :tag => 'issue',
Chris@117:                 :attributes => {:id => @c1.id.to_s},
Chris@117:                 :child => {
Chris@117:                   :tag => 'subject',
Chris@117:                   :content => 'child c1',
Chris@117:                   :sibling => {
Chris@117:                     :tag => 'children',
Chris@117:                     :children => {:count => 1},
Chris@117:                     :child => {
Chris@117:                       :tag => 'issue',
Chris@117:                       :attributes => {:id => @c3.id.to_s}
Chris@117:                     }
Chris@117:                   }
Chris@117:                 }
Chris@117:               }
Chris@117:             }
Chris@117:         end
Chris@117:         
Chris@117:         context ".json" do
Chris@117:           should "display children" do
Chris@117:             get '/issues/1.json?include=children'
Chris@117:             
Chris@117:             json = ActiveSupport::JSON.decode(response.body)
Chris@117:             assert_equal([
Chris@117:               {
Chris@117:                 'id' => @c1.id, 'subject' => 'child c1', 'tracker' => {'id' => 1, 'name' => 'Bug'},
Chris@117:                 'children' => [{ 'id' => @c3.id, 'subject' => 'child c3', 'tracker' => {'id' => 1, 'name' => 'Bug'} }]
Chris@117:               },
Chris@117:               { 'id' => @c2.id, 'subject' => 'child c2', 'tracker' => {'id' => 1, 'name' => 'Bug'} }
Chris@117:               ],
Chris@117:               json['issue']['children'])
Chris@117:           end
Chris@117:         end
Chris@117:       end
Chris@117:     end
Chris@117:   end
chris@37: 
chris@37:   context "POST /issues.xml" do
chris@37:     should_allow_api_authentication(:post,
chris@37:                                     '/issues.xml',
chris@37:                                     {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}},
chris@37:                                     {:success_code => :created})
chris@37: 
chris@37:     should "create an issue with the attributes" do
chris@37:       assert_difference('Issue.count') do
chris@37:         post '/issues.xml', {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}}, :authorization => credentials('jsmith')
chris@37:       end
chris@37:         
chris@37:       issue = Issue.first(:order => 'id DESC')
chris@37:       assert_equal 1, issue.project_id
chris@37:       assert_equal 2, issue.tracker_id
chris@37:       assert_equal 3, issue.status_id
chris@37:       assert_equal 'API test', issue.subject
chris@37:   
chris@37:       assert_response :created
chris@37:       assert_equal 'application/xml', @response.content_type
chris@37:       assert_tag 'issue', :child => {:tag => 'id', :content => issue.id.to_s}
chris@37:     end
chris@37:   end
chris@37:   
chris@37:   context "POST /issues.xml with failure" do
chris@37:     should_allow_api_authentication(:post,
chris@37:                                     '/issues.xml',
chris@37:                                     {:issue => {:project_id => 1}},
chris@37:                                     {:success_code => :unprocessable_entity})
chris@37: 
chris@37:     should "have an errors tag" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         post '/issues.xml', {:issue => {:project_id => 1}}, :authorization => credentials('jsmith')
chris@37:       end
chris@37: 
chris@37:       assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   context "POST /issues.json" do
chris@37:     should_allow_api_authentication(:post,
chris@37:                                     '/issues.json',
chris@37:                                     {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}},
chris@37:                                     {:success_code => :created})
chris@37: 
chris@37:     should "create an issue with the attributes" do
chris@37:       assert_difference('Issue.count') do
chris@37:         post '/issues.json', {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}}, :authorization => credentials('jsmith')
chris@37:       end
chris@37:         
chris@37:       issue = Issue.first(:order => 'id DESC')
chris@37:       assert_equal 1, issue.project_id
chris@37:       assert_equal 2, issue.tracker_id
chris@37:       assert_equal 3, issue.status_id
chris@37:       assert_equal 'API test', issue.subject
chris@37:     end
chris@37:     
chris@37:   end
chris@37:   
chris@37:   context "POST /issues.json with failure" do
chris@37:     should_allow_api_authentication(:post,
chris@37:                                     '/issues.json',
chris@37:                                     {:issue => {:project_id => 1}},
chris@37:                                     {:success_code => :unprocessable_entity})
chris@37: 
chris@37:     should "have an errors element" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         post '/issues.json', {:issue => {:project_id => 1}}, :authorization => credentials('jsmith')
chris@37:       end
chris@37: 
chris@37:       json = ActiveSupport::JSON.decode(response.body)
Chris@117:       assert json['errors'].include?(['subject', "can't be blank"])
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   # Issue 6 is on a private project
chris@37:   context "PUT /issues/6.xml" do
chris@37:     setup do
chris@37:       @parameters = {:issue => {:subject => 'API update', :notes => 'A new note'}}
chris@37:       @headers = { :authorization => credentials('jsmith') }
chris@37:     end
chris@37:     
chris@37:     should_allow_api_authentication(:put,
chris@37:                                     '/issues/6.xml',
chris@37:                                     {:issue => {:subject => 'API update', :notes => 'A new note'}},
chris@37:                                     {:success_code => :ok})
chris@37: 
chris@37:     should "not create a new issue" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         put '/issues/6.xml', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "create a new journal" do
chris@37:       assert_difference('Journal.count') do
chris@37:         put '/issues/6.xml', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "add the note to the journal" do
chris@37:       put '/issues/6.xml', @parameters, @headers
chris@37:       
chris@37:       journal = Journal.last
chris@37:       assert_equal "A new note", journal.notes
chris@37:     end
chris@37: 
chris@37:     should "update the issue" do
chris@37:       put '/issues/6.xml', @parameters, @headers
chris@37:       
chris@37:       issue = Issue.find(6)
chris@37:       assert_equal "API update", issue.subject
chris@37:     end
chris@37:     
chris@37:   end
chris@37:   
Chris@117:   context "PUT /issues/3.xml with custom fields" do
Chris@117:     setup do
Chris@117:       @parameters = {:issue => {:custom_fields => [{'id' => '1', 'value' => 'PostgreSQL' }, {'id' => '2', 'value' => '150'}]}}
Chris@117:       @headers = { :authorization => credentials('jsmith') }
Chris@117:     end
Chris@117:     
Chris@117:     should "update custom fields" do
Chris@117:       assert_no_difference('Issue.count') do
Chris@117:         put '/issues/3.xml', @parameters, @headers
Chris@117:       end
Chris@117:       
Chris@117:       issue = Issue.find(3)
Chris@117:       assert_equal '150', issue.custom_value_for(2).value
Chris@117:       assert_equal 'PostgreSQL', issue.custom_value_for(1).value
Chris@117:     end
Chris@117:   end
Chris@117:   
chris@37:   context "PUT /issues/6.xml with failed update" do
chris@37:     setup do
chris@37:       @parameters = {:issue => {:subject => ''}}
chris@37:       @headers = { :authorization => credentials('jsmith') }
chris@37:     end
chris@37: 
chris@37:     should_allow_api_authentication(:put,
chris@37:                                     '/issues/6.xml',
chris@37:                                     {:issue => {:subject => ''}}, # Missing subject should fail
chris@37:                                     {:success_code => :unprocessable_entity})
chris@37: 
chris@37:     should "not create a new issue" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         put '/issues/6.xml', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "not create a new journal" do
chris@37:       assert_no_difference('Journal.count') do
chris@37:         put '/issues/6.xml', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "have an errors tag" do
chris@37:       put '/issues/6.xml', @parameters, @headers
chris@37: 
chris@37:       assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   context "PUT /issues/6.json" do
chris@37:     setup do
chris@37:       @parameters = {:issue => {:subject => 'API update', :notes => 'A new note'}}
chris@37:       @headers = { :authorization => credentials('jsmith') }
chris@37:     end
chris@37:     
chris@37:     should_allow_api_authentication(:put,
chris@37:                                     '/issues/6.json',
chris@37:                                     {:issue => {:subject => 'API update', :notes => 'A new note'}},
chris@37:                                     {:success_code => :ok})
chris@37: 
chris@37:     should "not create a new issue" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         put '/issues/6.json', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "create a new journal" do
chris@37:       assert_difference('Journal.count') do
chris@37:         put '/issues/6.json', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "add the note to the journal" do
chris@37:       put '/issues/6.json', @parameters, @headers
chris@37:       
chris@37:       journal = Journal.last
chris@37:       assert_equal "A new note", journal.notes
chris@37:     end
chris@37: 
chris@37:     should "update the issue" do
chris@37:       put '/issues/6.json', @parameters, @headers
chris@37:       
chris@37:       issue = Issue.find(6)
chris@37:       assert_equal "API update", issue.subject
chris@37:     end
chris@37:     
chris@37:   end
chris@37:   
chris@37:   context "PUT /issues/6.json with failed update" do
chris@37:     setup do
chris@37:       @parameters = {:issue => {:subject => ''}}
chris@37:       @headers = { :authorization => credentials('jsmith') }
chris@37:     end
chris@37: 
chris@37:     should_allow_api_authentication(:put,
chris@37:                                     '/issues/6.json',
chris@37:                                     {:issue => {:subject => ''}}, # Missing subject should fail
chris@37:                                     {:success_code => :unprocessable_entity})
chris@37: 
chris@37:     should "not create a new issue" do
chris@37:       assert_no_difference('Issue.count') do
chris@37:         put '/issues/6.json', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "not create a new journal" do
chris@37:       assert_no_difference('Journal.count') do
chris@37:         put '/issues/6.json', @parameters, @headers
chris@37:       end
chris@37:     end
chris@37: 
chris@37:     should "have an errors attribute" do
chris@37:       put '/issues/6.json', @parameters, @headers
chris@37: 
chris@37:       json = ActiveSupport::JSON.decode(response.body)
Chris@117:       assert json['errors'].include?(['subject', "can't be blank"])
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   context "DELETE /issues/1.xml" do
chris@37:     should_allow_api_authentication(:delete,
chris@37:                                     '/issues/6.xml',
chris@37:                                     {},
chris@37:                                     {:success_code => :ok})
chris@37: 
chris@37:     should "delete the issue" do
chris@37:       assert_difference('Issue.count',-1) do
chris@37:         delete '/issues/6.xml', {}, :authorization => credentials('jsmith')
chris@37:       end
chris@37:       
chris@37:       assert_nil Issue.find_by_id(6)
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   context "DELETE /issues/1.json" do
chris@37:     should_allow_api_authentication(:delete,
chris@37:                                     '/issues/6.json',
chris@37:                                     {},
chris@37:                                     {:success_code => :ok})
chris@37: 
chris@37:     should "delete the issue" do
chris@37:       assert_difference('Issue.count',-1) do
chris@37:         delete '/issues/6.json', {}, :authorization => credentials('jsmith')
chris@37:       end
chris@37:       
chris@37:       assert_nil Issue.find_by_id(6)
chris@37:     end
chris@37:   end
chris@37: 
chris@37:   def credentials(user, password=nil)
chris@37:     ActionController::HttpAuthentication::Basic.encode_credentials(user, password || user)
chris@37:   end
chris@37: end