Fossology\UI\Api\Test\Controllers\GroupControllerTest Class Reference

Tests for GroupController. More...

Inheritance diagram for Fossology\UI\Api\Test\Controllers\GroupControllerTest:

Collaboration diagram for Fossology\UI\Api\Test\Controllers\GroupControllerTest:

Public Member Functions
	testCreateGroupV1 ()
	testCreateGroupV2 ()
	testDeleteGroupV1 ()
	testDeleteGroupV2 ()
	testGetDeletableGroupsV1 ()
	testGetDeletableGroupsV2 ()
	testGetGroupMembersV2 ()
	testGetGroupMembersV1 ()
	testAddMemberUserNotMemberV1 ()
	testAddMemberUserNotMemberV2 ()
	testAddMemberUserNotMember ($version=ApiVersion::V2)
	testAddMemberUserNotAdminV2 ()
	testAddMemberUserNotAdminV1 ()
	testAddMemberUserGroupAdminV1 ()
	testAddMemberUserGroupAdminV2 ()
	testAddMemberUserAlreadyMemberV2 ()
	testAddMemberUserAlreadyMemberV1 ()
	testChangeUserPermissionV2 ()
	testChangeUserPermissionV1 ()
	testDeleteGroupMemberSuccessV2 ()
	testDeleteGroupMemberSuccessV1 ()
	testDeleteGroupMemberUserNotFoundV2 ()
	testAddMemberUserNotFoundV2 ()
	testChangeUserPermissionUserNotFoundV2 ()

Public Attributes
const	YAML_LOC = __DIR__ . '/../../../ui/api/documentation/openapi.yaml'

Protected Member Functions
	setUp ()
	Setup test objects. More...
	tearDown ()
	Remove test objects. More...

Private Member Functions
	getResponseJson ($response)
	getGroupMembers ($userIds)
	getUsersWithGroup ($userIds)
	testCreateGroup ($version=ApiVersion::V2)
	testDeleteGroup ($version=ApiVersion::V2)
	testGetDeletableGroups ($version=ApiVersion::V2)
	testGetGroupMembers ($version=ApiVersion::V2)
	testAddMemberUserNotAdmin ($version=ApiVersion::V2)
	testAddMemberUserGroupAdmin ($version=ApiVersion::V2)
	testAddMemberUserAlreadyMember ($version=ApiVersion::V2)
	testChangeUserPermission ($version=ApiVersion::V2)
	testDeleteGroupMemberSuccess ($version=ApiVersion::V2)

Private Attributes
	$assertCountBefore
	$dbHelper
	$restHelper
	$adminPlugin

Detailed Description

Tests for GroupController.

Definition at line 43 of file GroupControllerTest.php.

Member Function Documentation

getGroupMembers()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::getGroupMembers (   $userIds )

private

Generate array of group-members

Parameters

array

$userIds

User ids to be generated

Returns

array[]

Definition at line 134 of file GroupControllerTest.php.

getResponseJson()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::getResponseJson (   $response )

private

Helper function to get JSON array from response

Parameters

Response

$response

Returns

array Decoded response

Definition at line 123 of file GroupControllerTest.php.

getUsersWithGroup()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::getUsersWithGroup (   $userIds )

private

Generate array of users-with-group

Parameters

array

$userIds

User ids to be generated

Returns

array[]

Definition at line 154 of file GroupControllerTest.php.

setUp()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::setUp ( )

protected

Setup test objects.

See also

PHPUnit_Framework_TestCase::setUp()

Definition at line 80 of file GroupControllerTest.php.

tearDown()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::tearDown ( )

protected

Remove test objects.

See also

PHPUnit_Framework_TestCase::tearDown()

Definition at line 110 of file GroupControllerTest.php.

testAddMemberUserAlreadyMember()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserAlreadyMember (   $version = ApiVersion::V2 )

private

Parameters

$version

to test

Returns

void

Definition at line 594 of file GroupControllerTest.php.

testAddMemberUserAlreadyMemberV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserAlreadyMemberV1

(

)

Test:

1. Test GroupController::addMember() for version 1
2. The user already a member
3. Test if the response body matches
4. Test if the response status is 400

Definition at line 585 of file GroupControllerTest.php.

testAddMemberUserAlreadyMemberV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserAlreadyMemberV2

(

)

Test:

1. Test GroupController::addMember() for version 2
2. The user already a member
3. Test if the response body matches
4. Test if the response status is 400

Definition at line 573 of file GroupControllerTest.php.

testAddMemberUserGroupAdminV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserGroupAdminV1

(

)

Test:

1. Test GroupController::addMember() for version 1
2. The user is not an admin but group admin
3. Test if the response status is 200

Definition at line 511 of file GroupControllerTest.php.

testAddMemberUserGroupAdminV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserGroupAdminV2

(

)

Test:

1. Test GroupController::addMember() for version 2
2. The user is not an admin but group admin
3. Test if the response status is 200

Definition at line 521 of file GroupControllerTest.php.

testAddMemberUserNotAdmin()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotAdmin (   $version = ApiVersion::V2 )

private

Parameters

$version

to test

Returns

void

Definition at line 472 of file GroupControllerTest.php.

testAddMemberUserNotAdminV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotAdminV1

(

)

Test:

1. Test GroupController::addMember() for version 1
2. The user is not an admin
3. Test if the response status is 403

Definition at line 464 of file GroupControllerTest.php.

testAddMemberUserNotAdminV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotAdminV2

(

)

Test:

1. Test GroupController::addMember() for version 2
2. The user is not an admin
3. Test if the response status is 403

Definition at line 454 of file GroupControllerTest.php.

testAddMemberUserNotFoundV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotFoundV2

(

)

Test:

1. Test GroupController::addMember() for V2 when username not found
2. Check if HttpNotFoundException is thrown

Definition at line 779 of file GroupControllerTest.php.

testAddMemberUserNotMember()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotMember

(

$version = ApiVersion::V2

)

Parameters

$version

to test

Returns

void

Definition at line 409 of file GroupControllerTest.php.

testAddMemberUserNotMemberV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotMemberV1

(

)

Test:

1. Test GroupController::addMember() for version 1
2. The user already a member
3. Test if the response body matches
4. Test if the response status is 200

Definition at line 389 of file GroupControllerTest.php.

testAddMemberUserNotMemberV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testAddMemberUserNotMemberV2

(

)

Test:

1. Test GroupController::addMember() for version 2
2. The user already a member
3. Test if the response body matches
4. Test if the response status is 200

Definition at line 401 of file GroupControllerTest.php.

testChangeUserPermission()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testChangeUserPermission (   $version = ApiVersion::V2 )

private

Parameters

$version

to test

Returns

void

Definition at line 650 of file GroupControllerTest.php.

testChangeUserPermissionUserNotFoundV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testChangeUserPermissionUserNotFoundV2

(

)

Test:

1. Test GroupController::changeUserPermission() for V2 when username not found
2. Check if HttpNotFoundException is thrown

Definition at line 806 of file GroupControllerTest.php.

testChangeUserPermissionV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testChangeUserPermissionV1

(

)

Test:

1. Test GroupController::changeUserPermission() in version 1
2. Check if the response is list of group members

Definition at line 642 of file GroupControllerTest.php.

testChangeUserPermissionV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testChangeUserPermissionV2

(

)

Test:

1. Test GroupController::changeUserPermission() in version 2
2. Check if the response is list of group members

Definition at line 633 of file GroupControllerTest.php.

testCreateGroup()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testCreateGroup (   $version = ApiVersion::V2 )

private

Parameters

$version

Returns

void

Definition at line 195 of file GroupControllerTest.php.

testCreateGroupV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testCreateGroupV1

(

)

Test:

1. Test GroupController::createGroup() for valid create request in version 1
2. Check if response status is 200

Definition at line 178 of file GroupControllerTest.php.

testCreateGroupV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testCreateGroupV2

(

)

Test:

1. Test GroupController::createGroup() for valid create request in version 2
2. Check if response status is 201

Definition at line 187 of file GroupControllerTest.php.

testDeleteGroup()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroup (   $version = ApiVersion::V2 )

private

Parameters

$version

Returns

void

Definition at line 253 of file GroupControllerTest.php.

testDeleteGroupMemberSuccess()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupMemberSuccess (   $version = ApiVersion::V2 )

private

Parameters

int

$version

API version

Definition at line 712 of file GroupControllerTest.php.

testDeleteGroupMemberSuccessV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupMemberSuccessV1

(

)

Test:

1. Test GroupController::deleteGroupMember() for V1 with a valid member removal
2. Check if the response status is 202

Definition at line 704 of file GroupControllerTest.php.

testDeleteGroupMemberSuccessV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupMemberSuccessV2

(

)

Test:

1. Test GroupController::deleteGroupMember() for V2 with a valid member removal
2. Check if the response status is 202

Definition at line 694 of file GroupControllerTest.php.

testDeleteGroupMemberUserNotFoundV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupMemberUserNotFoundV2

(

)

Test:

1. Test GroupController::deleteGroupMember() for V2 when username not found
2. Check if HttpNotFoundException is thrown

Definition at line 755 of file GroupControllerTest.php.

testDeleteGroupV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupV1

(

)

Test:

1. Test GroupController::deleteGroup() for valid delete request in version 1
2. Check if response status is 202

Definition at line 236 of file GroupControllerTest.php.

testDeleteGroupV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testDeleteGroupV2

(

)

Test:

1. Test GroupController::deleteGroup() for valid delete request in version 2
2. Check if response status is 202

Definition at line 245 of file GroupControllerTest.php.

testGetDeletableGroups()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetDeletableGroups (   $version = ApiVersion::V2 )

private

Parameters

$version

Returns

void

Definition at line 308 of file GroupControllerTest.php.

testGetDeletableGroupsV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetDeletableGroupsV1

(

)

Test:

1. Test GroupController::getDeletableGroups() for version 1
2. Check if the response is a list of groups.

Definition at line 291 of file GroupControllerTest.php.

testGetDeletableGroupsV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetDeletableGroupsV2

(

)

Test:

1. Test GroupController::getDeletableGroups() for version 2
2. Check if the response is a list of groups.

Definition at line 300 of file GroupControllerTest.php.

testGetGroupMembers()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetGroupMembers (   $version = ApiVersion::V2 )

private

Parameters

$version

Returns

void

Definition at line 343 of file GroupControllerTest.php.

testGetGroupMembersV1()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetGroupMembersV1

(

)

Test:

1. Test GroupController::getGroupMembers() for all groups in version 1
2. Check if the response is list of group members

Definition at line 335 of file GroupControllerTest.php.

testGetGroupMembersV2()

Fossology\UI\Api\Test\Controllers\GroupControllerTest::testGetGroupMembersV2

(

)

Test:

1. Test GroupController::getGroupMembers() for all groups in version 2
2. Check if the response is list of group members

Definition at line 326 of file GroupControllerTest.php.

Member Data Documentation

$adminPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\GroupControllerTest::$adminPlugin

private

AdminGroupUsersPlugin mock

Definition at line 74 of file GroupControllerTest.php.

$assertCountBefore

integer Fossology\UI\Api\Test\Controllers\GroupControllerTest::$assertCountBefore

private

Assertions before running tests

Definition at line 56 of file GroupControllerTest.php.

$dbHelper

DbHelper Fossology\UI\Api\Test\Controllers\GroupControllerTest::$dbHelper

private

DbHelper mock

Definition at line 62 of file GroupControllerTest.php.

$restHelper

RestHelper Fossology\UI\Api\Test\Controllers\GroupControllerTest::$restHelper

private

RestHelper mock

Definition at line 68 of file GroupControllerTest.php.

YAML_LOC

string Fossology\UI\Api\Test\Controllers\GroupControllerTest::YAML_LOC = __DIR__ . '/../../../ui/api/documentation/openapi.yaml'

Location of openapi.yaml file

Definition at line 50 of file GroupControllerTest.php.

---

The documentation for this class was generated from the following file:

• src/www/ui_tests/api/Controllers/GroupControllerTest.php