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