jro_apps/redmine Files · test/integration/api_test/projects_test.rb

Declare safe attributes for User and Projects models....

Declare safe attributes for User and Projects models. git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@4492 e93f8b46-1217-0410-a6f0-8f06a7374b81

Jean-Philippe Lang - - Load All Authors

File last commit:

r4346:9284a32c9ac7


                r4378:a4d7a99c22d9

Download file

             projects_test.rb
        
                    216 lines
            
             | 7.5 KiB
            
                | text/x-ruby
            
             |
                RubyLexer
            
             / test / integration / api_test / projects_test.rb
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
      # Redmine - project management software

      # Copyright (C) 2006-2010  Jean-Philippe Lang

      #

      # This program is free software; you can redistribute it and/or

      # modify it under the terms of the GNU General Public License

      # as published by the Free Software Foundation; either version 2

      # of the License, or (at your option) any later version.

      # 

      # This program is distributed in the hope that it will be useful,

      # but WITHOUT ANY WARRANTY; without even the implied warranty of

      # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

      # GNU General Public License for more details.

      # 

      # You should have received a copy of the GNU General Public License

      # along with this program; if not, write to the Free Software

      # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

        Eric Davis
    
Move all API tests into the ApiTest module to make management easier...

              r4243
            
      require "#{File.dirname(__FILE__)}/../../test_helper"

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
        Eric Davis
    
Move all API tests into the ApiTest module to make management easier...

              r4243
            
      class ApiTest::ProjectsTest < ActionController::IntegrationTest

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
        fixtures :projects, :versions, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,

                 :trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages,

                 :attachments, :custom_fields, :custom_values, :time_entries

        def setup

          Setting.rest_api_enabled = '1'

        end

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#destroy (#6841)....

              r4329
            
        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
        context "GET /projects" do

          context ".xml" do

            should "return projects" do

              get '/projects.xml'

              assert_response :success

              assert_equal 'application/xml', @response.content_type

              assert_tag :tag => 'projects',

                :child => {:tag => 'project', :child => {:tag => 'id', :content => '1'}}

            end

          end

          context ".json" do

            should "return projects" do

              get '/projects.json'

              assert_response :success

              assert_equal 'application/json', @response.content_type

              json = ActiveSupport::JSON.decode(response.body)

              assert_kind_of Hash, json

              assert_kind_of Array, json['projects']

              assert_kind_of Hash, json['projects'].first

              assert json['projects'].first.has_key?('id')

            end

          end

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#show (#6841)....

              r4330
            
        end

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
        context "GET /projects/:id" do

          context ".xml" do

            # TODO: A private project is needed because should_allow_api_authentication

            # actually tests that authentication is *required*, not just allowed

            should_allow_api_authentication(:get, "/projects/2.xml")

        Jean-Philippe Lang
    
Adds a "visible" option on User and Project custom fields (#1738)....

              r4268
            
        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
            should "return requested project" do

              get '/projects/1.xml'

              assert_response :success

              assert_equal 'application/xml', @response.content_type

              assert_tag :tag => 'project',

                :child => {:tag => 'id', :content => '1'}

              assert_tag :tag => 'custom_field',

                :attributes => {:name => 'Development status'}, :content => 'Stable'

            end

            context "with hidden custom fields" do

              setup do

                ProjectCustomField.find_by_name('Development status').update_attribute :visible, false

              end

              should "not display hidden custom fields" do

                get '/projects/1.xml'

                assert_response :success

                assert_equal 'application/xml', @response.content_type

                assert_no_tag 'custom_field',

                  :attributes => {:name => 'Development status'}

              end

            end

          end

        Jean-Philippe Lang
    
Makes projects API return XML description when creating a project (#6874)....

              r4283
            
        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
          context ".json" do

            should_allow_api_authentication(:get, "/projects/2.json")

            should "return requested project" do

              get '/projects/1.json'

              json = ActiveSupport::JSON.decode(response.body)

              assert_kind_of Hash, json

              assert_kind_of Hash, json['project']

              assert_equal 1, json['project']['id']

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#create (#6841)....

              r4327
            
            end

          end

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
        end

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
        context "POST /projects" do

          context "with valid parameters" do

            setup do

        Jean-Philippe Lang
    
Moves project attributes default assignments from ProjectsController#new to the model (#6064)....

              r4346
            
              Setting.default_projects_modules = ['issue_tracking', 'repository']

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
              @parameters = {:project => {:name => 'API test', :identifier => 'api-test'}}

            end

            context ".xml" do

              should_allow_api_authentication(:post,

                                              '/projects.xml',

                                              {:project => {:name => 'API test', :identifier => 'api-test'}},

                                              {:success_code => :created})

              should "create a project with the attributes" do

                assert_difference('Project.count') do

                  post '/projects.xml', @parameters, :authorization => credentials('admin')

                end

                project = Project.first(:order => 'id DESC')

                assert_equal 'API test', project.name

                assert_equal 'api-test', project.identifier

        Jean-Philippe Lang
    
Moves project attributes default assignments from ProjectsController#new to the model (#6064)....

              r4346
            
                assert_equal ['issue_tracking', 'repository'], project.enabled_module_names

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
                assert_response :created

                assert_equal 'application/xml', @response.content_type

                assert_tag 'project', :child => {:tag => 'id', :content => project.id.to_s}

              end

            end

          end

          context "with invalid parameters" do

            setup do

              @parameters = {:project => {:name => 'API test'}}

            end

            context ".xml" do

              should "return errors" do

                assert_no_difference('Project.count') do

                  post '/projects.xml', @parameters, :authorization => credentials('admin')

                end

                assert_response :unprocessable_entity

                assert_equal 'application/xml', @response.content_type

                assert_tag 'errors', :child => {:tag => 'error', :content => "Identifier can't be blank"}

              end

            end

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
          end

        end

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
        context "PUT /projects/:id" do

          context "with valid parameters" do

            setup do

              @parameters = {:project => {:name => 'API update'}}

            end

            context ".xml" do

              should_allow_api_authentication(:put,

                                              '/projects/2.xml',

                                              {:project => {:name => 'API update'}},

                                              {:success_code => :ok})

              should "update the project" do

                assert_no_difference 'Project.count' do

                  put '/projects/2.xml', @parameters, :authorization => credentials('jsmith')

                end

                assert_response :ok

                assert_equal 'application/xml', @response.content_type

                project = Project.find(2)

                assert_equal 'API update', project.name

              end

            end

          end

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#update (#6841)....

              r4328
            
        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
          context "with invalid parameters" do

            setup do

              @parameters = {:project => {:name => ''}}

            end

            context ".xml" do

              should "return errors" do

                assert_no_difference('Project.count') do

                  put '/projects/2.xml', @parameters, :authorization => credentials('admin')

                end

                assert_response :unprocessable_entity

                assert_equal 'application/xml', @response.content_type

                assert_tag 'errors', :child => {:tag => 'error', :content => "Name can't be blank"}

              end

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#update (#6841)....

              r4328
            
            end

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
          end

        end

        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
        context "DELETE /projects/:id" do

          context ".xml" do

            should_allow_api_authentication(:delete,

                                            '/projects/2.xml',

                                            {},

                                            {:success_code => :ok})

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#destroy (#6841)....

              r4329
            
        Jean-Philippe Lang
    
Projects API tests rewriting....

              r4343
            
            should "delete the project" do

              assert_difference('Project.count',-1) do

                delete '/projects/2.xml', {}, :authorization => credentials('admin')

              end

              assert_response :ok

              assert_nil Project.find_by_id(2)

        Jean-Philippe Lang
    
Accept key auth for ProjectsController#destroy (#6841)....

              r4329
            
            end

        Jean-Philippe Lang
    
XML REST API for Projects (#296)....

              r3199
            
          end

        end

        def credentials(user, password=nil)

          ActionController::HttpAuthentication::Basic.encode_credentials(user, password || user)

        end

      end

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	# Redmine - project management software
		# Copyright (C) 2006-2010 Jean-Philippe Lang
		#
		# This program is free software; you can redistribute it and/or
		# modify it under the terms of the GNU General Public License
		# as published by the Free Software Foundation; either version 2
		# of the License, or (at your option) any later version.
		#
		# This program is distributed in the hope that it will be useful,
		# but WITHOUT ANY WARRANTY; without even the implied warranty of
		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		# GNU General Public License for more details.
		#
		# You should have received a copy of the GNU General Public License
		# along with this program; if not, write to the Free Software
		# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Eric Davis Move all API tests into the ApiTest module to make management easier...	r4243	require "#{File.dirname(__FILE__)}/../../test_helper"
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199
Eric Davis Move all API tests into the ApiTest module to make management easier...	r4243	class ApiTest::ProjectsTest < ActionController::IntegrationTest
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	fixtures :projects, :versions, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,
		:trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages,
		:attachments, :custom_fields, :custom_values, :time_entries

		def setup
		Setting.rest_api_enabled = '1'
		end
Jean-Philippe Lang Accept key auth for ProjectsController#destroy (#6841)....	r4329
Jean-Philippe Lang Projects API tests rewriting....	r4343	context "GET /projects" do
		context ".xml" do
		should "return projects" do
		get '/projects.xml'
		assert_response :success
		assert_equal 'application/xml', @response.content_type

		assert_tag :tag => 'projects',
		:child => {:tag => 'project', :child => {:tag => 'id', :content => '1'}}
		end
		end

		context ".json" do
		should "return projects" do
		get '/projects.json'
		assert_response :success
		assert_equal 'application/json', @response.content_type

		json = ActiveSupport::JSON.decode(response.body)
		assert_kind_of Hash, json
		assert_kind_of Array, json['projects']
		assert_kind_of Hash, json['projects'].first
		assert json['projects'].first.has_key?('id')
		end
		end
Jean-Philippe Lang Accept key auth for ProjectsController#show (#6841)....	r4330	end

Jean-Philippe Lang Projects API tests rewriting....	r4343	context "GET /projects/:id" do
		context ".xml" do
		# TODO: A private project is needed because should_allow_api_authentication
		# actually tests that authentication is required, not just allowed
		should_allow_api_authentication(:get, "/projects/2.xml")
Jean-Philippe Lang Adds a "visible" option on User and Project custom fields (#1738)....	r4268
Jean-Philippe Lang Projects API tests rewriting....	r4343	should "return requested project" do
		get '/projects/1.xml'
		assert_response :success
		assert_equal 'application/xml', @response.content_type

		assert_tag :tag => 'project',
		:child => {:tag => 'id', :content => '1'}
		assert_tag :tag => 'custom_field',
		:attributes => {:name => 'Development status'}, :content => 'Stable'
		end

		context "with hidden custom fields" do
		setup do
		ProjectCustomField.find_by_name('Development status').update_attribute :visible, false
		end

		should "not display hidden custom fields" do
		get '/projects/1.xml'
		assert_response :success
		assert_equal 'application/xml', @response.content_type

		assert_no_tag 'custom_field',
		:attributes => {:name => 'Development status'}
		end
		end
		end
Jean-Philippe Lang Makes projects API return XML description when creating a project (#6874)....	r4283
Jean-Philippe Lang Projects API tests rewriting....	r4343	context ".json" do
		should_allow_api_authentication(:get, "/projects/2.json")

		should "return requested project" do
		get '/projects/1.json'

		json = ActiveSupport::JSON.decode(response.body)
		assert_kind_of Hash, json
		assert_kind_of Hash, json['project']
		assert_equal 1, json['project']['id']
Jean-Philippe Lang Accept key auth for ProjectsController#create (#6841)....	r4327	end
		end
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	end

Jean-Philippe Lang Projects API tests rewriting....	r4343	context "POST /projects" do
		context "with valid parameters" do
		setup do
Jean-Philippe Lang Moves project attributes default assignments from ProjectsController#new to the model (#6064)....	r4346	Setting.default_projects_modules = ['issue_tracking', 'repository']
Jean-Philippe Lang Projects API tests rewriting....	r4343	@parameters = {:project => {:name => 'API test', :identifier => 'api-test'}}
		end

		context ".xml" do
		should_allow_api_authentication(:post,
		'/projects.xml',
		{:project => {:name => 'API test', :identifier => 'api-test'}},
		{:success_code => :created})


		should "create a project with the attributes" do
		assert_difference('Project.count') do
		post '/projects.xml', @parameters, :authorization => credentials('admin')
		end

		project = Project.first(:order => 'id DESC')
		assert_equal 'API test', project.name
		assert_equal 'api-test', project.identifier
Jean-Philippe Lang Moves project attributes default assignments from ProjectsController#new to the model (#6064)....	r4346	assert_equal ['issue_tracking', 'repository'], project.enabled_module_names
Jean-Philippe Lang Projects API tests rewriting....	r4343
		assert_response :created
		assert_equal 'application/xml', @response.content_type
		assert_tag 'project', :child => {:tag => 'id', :content => project.id.to_s}
		end
		end
		end

		context "with invalid parameters" do
		setup do
		@parameters = {:project => {:name => 'API test'}}
		end

		context ".xml" do
		should "return errors" do
		assert_no_difference('Project.count') do
		post '/projects.xml', @parameters, :authorization => credentials('admin')
		end

		assert_response :unprocessable_entity
		assert_equal 'application/xml', @response.content_type
		assert_tag 'errors', :child => {:tag => 'error', :content => "Identifier can't be blank"}
		end
		end
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	end
		end

Jean-Philippe Lang Projects API tests rewriting....	r4343	context "PUT /projects/:id" do
		context "with valid parameters" do
		setup do
		@parameters = {:project => {:name => 'API update'}}
		end

		context ".xml" do
		should_allow_api_authentication(:put,
		'/projects/2.xml',
		{:project => {:name => 'API update'}},
		{:success_code => :ok})

		should "update the project" do
		assert_no_difference 'Project.count' do
		put '/projects/2.xml', @parameters, :authorization => credentials('jsmith')
		end
		assert_response :ok
		assert_equal 'application/xml', @response.content_type
		project = Project.find(2)
		assert_equal 'API update', project.name
		end
		end
		end
Jean-Philippe Lang Accept key auth for ProjectsController#update (#6841)....	r4328
Jean-Philippe Lang Projects API tests rewriting....	r4343	context "with invalid parameters" do
		setup do
		@parameters = {:project => {:name => ''}}
		end

		context ".xml" do
		should "return errors" do
		assert_no_difference('Project.count') do
		put '/projects/2.xml', @parameters, :authorization => credentials('admin')
		end

		assert_response :unprocessable_entity
		assert_equal 'application/xml', @response.content_type
		assert_tag 'errors', :child => {:tag => 'error', :content => "Name can't be blank"}
		end
Jean-Philippe Lang Accept key auth for ProjectsController#update (#6841)....	r4328	end
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	end
		end

Jean-Philippe Lang Projects API tests rewriting....	r4343	context "DELETE /projects/:id" do
		context ".xml" do
		should_allow_api_authentication(:delete,
		'/projects/2.xml',
		{},
		{:success_code => :ok})
Jean-Philippe Lang Accept key auth for ProjectsController#destroy (#6841)....	r4329
Jean-Philippe Lang Projects API tests rewriting....	r4343	should "delete the project" do
		assert_difference('Project.count',-1) do
		delete '/projects/2.xml', {}, :authorization => credentials('admin')
		end
		assert_response :ok
		assert_nil Project.find_by_id(2)
Jean-Philippe Lang Accept key auth for ProjectsController#destroy (#6841)....	r4329	end
Jean-Philippe Lang XML REST API for Projects (#296)....	r3199	end
		end

		def credentials(user, password=nil)
		ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)
		end
		end