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::ProjectsTest < ActionController::IntegrationTest
Chris@909:   fixtures :projects, :versions, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,
Chris@909:            :trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages,
Chris@909:            :attachments, :custom_fields, :custom_values, :time_entries, :issue_categories
Chris@909: 
Chris@909:   def setup
Chris@909:     Setting.rest_api_enabled = '1'
Chris@909:     set_tmp_attachments_directory
Chris@909:   end
Chris@909: 
Chris@909:   context "GET /projects" do
Chris@909:     context ".xml" do
Chris@909:       should "return projects" do
Chris@909:         get '/projects.xml'
Chris@909:         assert_response :success
Chris@909:         assert_equal 'application/xml', @response.content_type
Chris@909: 
Chris@909:         assert_tag :tag => 'projects',
Chris@909:           :child => {:tag => 'project', :child => {:tag => 'id', :content => '1'}}
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     context ".json" do
Chris@909:       should "return projects" do
Chris@909:         get '/projects.json'
Chris@909:         assert_response :success
Chris@909:         assert_equal 'application/json', @response.content_type
Chris@909: 
Chris@909:         json = ActiveSupport::JSON.decode(response.body)
Chris@909:         assert_kind_of Hash, json
Chris@909:         assert_kind_of Array, json['projects']
Chris@909:         assert_kind_of Hash, json['projects'].first
Chris@909:         assert json['projects'].first.has_key?('id')
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   context "GET /projects/:id" do
Chris@909:     context ".xml" do
Chris@909:       # TODO: A private project is needed because should_allow_api_authentication
Chris@909:       # actually tests that authentication is *required*, not just allowed
Chris@909:       should_allow_api_authentication(:get, "/projects/2.xml")
Chris@909: 
Chris@909:       should "return requested project" do
Chris@909:         get '/projects/1.xml'
Chris@909:         assert_response :success
Chris@909:         assert_equal 'application/xml', @response.content_type
Chris@909: 
Chris@909:         assert_tag :tag => 'project',
Chris@909:           :child => {:tag => 'id', :content => '1'}
Chris@909:         assert_tag :tag => 'custom_field',
Chris@909:           :attributes => {:name => 'Development status'}, :content => 'Stable'
Chris@909: 
Chris@909:         assert_no_tag 'trackers'
Chris@909:         assert_no_tag 'issue_categories'
Chris@909:       end
Chris@909: 
Chris@909:       context "with hidden custom fields" do
Chris@909:         setup do
Chris@909:           ProjectCustomField.find_by_name('Development status').update_attribute :visible, false
Chris@909:         end
Chris@909: 
Chris@909:         should "not display hidden custom fields" do
Chris@909:           get '/projects/1.xml'
Chris@909:           assert_response :success
Chris@909:           assert_equal 'application/xml', @response.content_type
Chris@909: 
Chris@909:           assert_no_tag 'custom_field',
Chris@909:             :attributes => {:name => 'Development status'}
Chris@909:         end
Chris@909:       end
Chris@909: 
Chris@909:       should "return categories with include=issue_categories" do
Chris@909:         get '/projects/1.xml?include=issue_categories'
Chris@909:         assert_response :success
Chris@909:         assert_equal 'application/xml', @response.content_type
Chris@909: 
Chris@909:         assert_tag 'issue_categories',
Chris@909:           :attributes => {:type => 'array'},
Chris@909:           :child => {
Chris@909:             :tag => 'issue_category',
Chris@909:             :attributes => {
Chris@909:               :id => '2',
Chris@909:               :name => 'Recipes'
Chris@909:             }
Chris@909:           }
Chris@909:       end
Chris@909: 
Chris@909:       should "return trackers with include=trackers" do
Chris@909:         get '/projects/1.xml?include=trackers'
Chris@909:         assert_response :success
Chris@909:         assert_equal 'application/xml', @response.content_type
Chris@909: 
Chris@909:         assert_tag 'trackers',
Chris@909:           :attributes => {:type => 'array'},
Chris@909:           :child => {
Chris@909:             :tag => 'tracker',
Chris@909:             :attributes => {
Chris@909:               :id => '2',
Chris@909:               :name => 'Feature request'
Chris@909:             }
Chris@909:           }
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     context ".json" do
Chris@909:       should_allow_api_authentication(:get, "/projects/2.json")
Chris@909: 
Chris@909:       should "return requested project" do
Chris@909:         get '/projects/1.json'
Chris@909: 
Chris@909:         json = ActiveSupport::JSON.decode(response.body)
Chris@909:         assert_kind_of Hash, json
Chris@909:         assert_kind_of Hash, json['project']
Chris@909:         assert_equal 1, json['project']['id']
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   context "POST /projects" do
Chris@909:     context "with valid parameters" do
Chris@909:       setup do
Chris@909:         Setting.default_projects_modules = ['issue_tracking', 'repository']
Chris@909:         @parameters = {:project => {:name => 'API test', :identifier => 'api-test'}}
Chris@909:       end
Chris@909: 
Chris@909:       context ".xml" do
Chris@909:         should_allow_api_authentication(:post,
Chris@909:                                         '/projects.xml',
Chris@909:                                         {:project => {:name => 'API test', :identifier => 'api-test'}},
Chris@909:                                         {:success_code => :created})
Chris@909: 
Chris@909: 
Chris@909:         should "create a project with the attributes" do
Chris@909:           assert_difference('Project.count') do
Chris@909:             post '/projects.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
Chris@909: 
Chris@909:           project = Project.first(:order => 'id DESC')
Chris@909:           assert_equal 'API test', project.name
Chris@909:           assert_equal 'api-test', project.identifier
Chris@909:           assert_equal ['issue_tracking', 'repository'], project.enabled_module_names.sort
Chris@909:           assert_equal Tracker.all.size, project.trackers.size
Chris@909: 
Chris@909:           assert_response :created
Chris@909:           assert_equal 'application/xml', @response.content_type
Chris@909:           assert_tag 'project', :child => {:tag => 'id', :content => project.id.to_s}
Chris@909:         end
Chris@909: 
Chris@909:         should "accept enabled_module_names attribute" do
Chris@909:           @parameters[:project].merge!({:enabled_module_names => ['issue_tracking', 'news', 'time_tracking']})
Chris@909: 
Chris@909:           assert_difference('Project.count') do
Chris@909:             post '/projects.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
Chris@909: 
Chris@909:           project = Project.first(:order => 'id DESC')
Chris@909:           assert_equal ['issue_tracking', 'news', 'time_tracking'], project.enabled_module_names.sort
Chris@909:         end
Chris@909: 
Chris@909:         should "accept tracker_ids attribute" do
Chris@909:           @parameters[:project].merge!({:tracker_ids => [1, 3]})
Chris@909: 
Chris@909:           assert_difference('Project.count') do
Chris@909:             post '/projects.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
Chris@909: 
Chris@909:           project = Project.first(:order => 'id DESC')
Chris@909:           assert_equal [1, 3], project.trackers.map(&:id).sort
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     context "with invalid parameters" do
Chris@909:       setup do
Chris@909:         @parameters = {:project => {:name => 'API test'}}
Chris@909:       end
Chris@909: 
Chris@909:       context ".xml" do
Chris@909:         should "return errors" do
Chris@909:           assert_no_difference('Project.count') do
Chris@909:             post '/projects.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
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 => "Identifier can't be blank"}
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   context "PUT /projects/:id" do
Chris@909:     context "with valid parameters" do
Chris@909:       setup do
Chris@909:         @parameters = {:project => {:name => 'API update'}}
Chris@909:       end
Chris@909: 
Chris@909:       context ".xml" do
Chris@909:         should_allow_api_authentication(:put,
Chris@909:                                         '/projects/2.xml',
Chris@909:                                         {:project => {:name => 'API update'}},
Chris@909:                                         {:success_code => :ok})
Chris@909: 
Chris@909:         should "update the project" do
Chris@909:           assert_no_difference 'Project.count' do
Chris@909:             put '/projects/2.xml', @parameters, :authorization => credentials('jsmith')
Chris@909:           end
Chris@909:           assert_response :ok
Chris@909:           assert_equal 'application/xml', @response.content_type
Chris@909:           project = Project.find(2)
Chris@909:           assert_equal 'API update', project.name
Chris@909:         end
Chris@909: 
Chris@909:         should "accept enabled_module_names attribute" do
Chris@909:           @parameters[:project].merge!({:enabled_module_names => ['issue_tracking', 'news', 'time_tracking']})
Chris@909: 
Chris@909:           assert_no_difference 'Project.count' do
Chris@909:             put '/projects/2.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
Chris@909:           assert_response :ok
Chris@909:           project = Project.find(2)
Chris@909:           assert_equal ['issue_tracking', 'news', 'time_tracking'], project.enabled_module_names.sort
Chris@909:         end
Chris@909: 
Chris@909:         should "accept tracker_ids attribute" do
Chris@909:           @parameters[:project].merge!({:tracker_ids => [1, 3]})
Chris@909: 
Chris@909:           assert_no_difference 'Project.count' do
Chris@909:             put '/projects/2.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
Chris@909:           assert_response :ok
Chris@909:           project = Project.find(2)
Chris@909:           assert_equal [1, 3], project.trackers.map(&:id).sort
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     context "with invalid parameters" do
Chris@909:       setup do
Chris@909:         @parameters = {:project => {:name => ''}}
Chris@909:       end
Chris@909: 
Chris@909:       context ".xml" do
Chris@909:         should "return errors" do
Chris@909:           assert_no_difference('Project.count') do
Chris@909:             put '/projects/2.xml', @parameters, :authorization => credentials('admin')
Chris@909:           end
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 => "Name can't be blank"}
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   context "DELETE /projects/:id" do
Chris@909:     context ".xml" do
Chris@909:       should_allow_api_authentication(:delete,
Chris@909:                                       '/projects/2.xml',
Chris@909:                                       {},
Chris@909:                                       {:success_code => :ok})
Chris@909: 
Chris@909:       should "delete the project" do
Chris@909:         assert_difference('Project.count',-1) do
Chris@909:           delete '/projects/2.xml', {}, :authorization => credentials('admin')
Chris@909:         end
Chris@909:         assert_response :ok
Chris@909:         assert_nil Project.find_by_id(2)
Chris@909:       end
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