Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 15 | class RoleTest extends RESTFunctionalTestCase |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * @covers POST /user/roles |
||
| 19 | * |
||
| 20 | * @return string The created role href |
||
| 21 | */ |
||
| 22 | View Code Duplication | public function testCreateRole() |
|
| 23 | { |
||
| 24 | $xml = <<< XML |
||
| 25 | <?xml version="1.0" encoding="UTF-8"?> |
||
| 26 | <RoleInput> |
||
| 27 | <identifier>testCreateRole</identifier> |
||
| 28 | <mainLanguageCode>eng-GB</mainLanguageCode> |
||
| 29 | <names> |
||
| 30 | <value languageCode="eng-GB">testCreateRole</value> |
||
| 31 | </names> |
||
| 32 | <descriptions> |
||
| 33 | <value languageCode="eng-GB">testCreateRole description</value> |
||
| 34 | </descriptions> |
||
| 35 | </RoleInput> |
||
| 36 | XML; |
||
| 37 | $request = $this->createHttpRequest( |
||
| 38 | 'POST', |
||
| 39 | '/api/ezp/v2/user/roles?publish=true', |
||
| 40 | 'RoleInput+xml', |
||
| 41 | 'Role+json' |
||
| 42 | ); |
||
| 43 | $request->setContent($xml); |
||
| 44 | $response = $this->sendHttpRequest($request); |
||
| 45 | |||
| 46 | self::assertHttpResponseCodeEquals($response, 201); |
||
| 47 | self::assertHttpResponseHasHeader($response, 'Location'); |
||
| 48 | |||
| 49 | $href = $response->getHeader('Location'); |
||
| 50 | $this->addCreatedElement($href); |
||
| 51 | |||
| 52 | return $href; |
||
| 53 | } |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @covers GET /user/roles |
||
| 57 | */ |
||
| 58 | public function testListRoles() |
||
| 59 | { |
||
| 60 | $response = $this->sendHttpRequest( |
||
| 61 | $this->createHttpRequest('GET', '/api/ezp/v2/user/roles') |
||
| 62 | ); |
||
| 63 | |||
| 64 | self::assertHttpResponseCodeEquals($response, 200); |
||
| 65 | } |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @depends testCreateRole |
||
| 69 | * @covers GET /user/roles/{roleId} |
||
| 70 | */ |
||
| 71 | public function testLoadRole($roleHref) |
||
| 72 | { |
||
| 73 | $response = $this->sendHttpRequest( |
||
| 74 | $this->createHttpRequest('GET', $roleHref) |
||
| 75 | ); |
||
| 76 | |||
| 77 | self::assertHttpResponseCodeEquals($response, 200); |
||
| 78 | } |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @depends testCreateRole |
||
| 82 | * @covers PATCH /user/roles/{roleId} |
||
| 83 | */ |
||
| 84 | public function testUpdateRole($roleHref) |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @covers POST /user/roles/{roleId}/policies |
||
| 109 | * @depends testCreateRole |
||
| 110 | * |
||
| 111 | * @return string The created policy href |
||
| 112 | */ |
||
| 113 | View Code Duplication | public function testAddPolicy($roleHref) |
|
| 142 | |||
| 143 | /** |
||
| 144 | * @covers GET /user/roles/{roleId}/policies/{policyId} |
||
| 145 | * @depends testAddPolicy |
||
| 146 | */ |
||
| 147 | public function testLoadPolicy($policyHref) |
||
| 155 | |||
| 156 | /** |
||
| 157 | * @covers GET /user/roles/{roleId}/policies |
||
| 158 | * @depends testCreateRole |
||
| 159 | */ |
||
| 160 | public function testLoadPolicies($roleHref) |
||
| 168 | |||
| 169 | /** |
||
| 170 | * @covers PATCH /user/roles/{roleId}/policies/{policyId} |
||
| 171 | * @depends testAddPolicy |
||
| 172 | */ |
||
| 173 | public function testUpdatePolicy($policyHref) |
||
| 194 | |||
| 195 | /** |
||
| 196 | * @depends testCreateRole |
||
| 197 | * @covers POST /user/users/{userId}/roles |
||
| 198 | * |
||
| 199 | * @return string assigned role href |
||
| 200 | * |
||
| 201 | * @todo stop using the anonymous user, this is dangerous... |
||
| 202 | */ |
||
| 203 | View Code Duplication | public function testAssignRoleToUser($roleHref) |
|
| 233 | |||
| 234 | /** |
||
| 235 | * @covers GET /user/users/{userId}/roles/{roleId} |
||
| 236 | * @depends testAssignRoleToUser |
||
| 237 | */ |
||
| 238 | public function testLoadRoleAssignmentForUser($roleAssignmentHref) |
||
| 246 | |||
| 247 | /** |
||
| 248 | * @covers DELETE /user/users/{userId}/roles/{roleId} |
||
| 249 | * @depends testAssignRoleToUser |
||
| 250 | */ |
||
| 251 | public function testUnassignRoleFromUser($roleAssignmentHref) |
||
| 259 | |||
| 260 | /** |
||
| 261 | * @depends testCreateRole |
||
| 262 | * @covers POST /user/groups/{groupId}/roles |
||
| 263 | * |
||
| 264 | * @return string role assignment href |
||
| 265 | */ |
||
| 266 | View Code Duplication | public function testAssignRoleToUserGroup($roleHref) |
|
| 296 | |||
| 297 | /** |
||
| 298 | * @covers GET /user/groups/{groupId}/roles/{roleId} |
||
| 299 | * @depends testAssignRoleToUserGroup |
||
| 300 | */ |
||
| 301 | View Code Duplication | public function testLoadRoleAssignmentForUserGroup($roleAssignmentHref) |
|
| 310 | |||
| 311 | /** |
||
| 312 | * @covers DELETE /user/groups/{groupId}/roles/{roleId} |
||
| 313 | * @depends testAssignRoleToUserGroup |
||
| 314 | */ |
||
| 315 | View Code Duplication | public function testUnassignRoleFromUserGroup($roleAssignmentHref) |
|
| 324 | |||
| 325 | /** |
||
| 326 | * @covers GET /user/users/{userId}/roles |
||
| 327 | */ |
||
| 328 | public function testLoadRoleAssignmentsForUser() |
||
| 336 | |||
| 337 | /** |
||
| 338 | * @covers GET /user/groups/{groupPath}/roles |
||
| 339 | */ |
||
| 340 | public function testLoadRoleAssignmentsForUserGroup() |
||
| 348 | |||
| 349 | /** |
||
| 350 | * @covers GET /user/policies?userId={userId} |
||
| 351 | */ |
||
| 352 | public function testListPoliciesForUser() |
||
| 360 | |||
| 361 | /** |
||
| 362 | * @covers DELETE /user/roles/{roleId}/policies/{policyId} |
||
| 363 | * @depends testAddPolicy |
||
| 364 | */ |
||
| 365 | public function testDeletePolicy($policyHref) |
||
| 373 | |||
| 374 | /** |
||
| 375 | * @covers DELETE /user/roles/{roleId}/policies |
||
| 376 | * @depends testCreateRole |
||
| 377 | */ |
||
| 378 | public function testDeletePolicies($roleHref) |
||
| 386 | |||
| 387 | /** |
||
| 388 | * @covers DELETE /user/roles/{roleId} |
||
| 389 | * @depends testCreateRole |
||
| 390 | */ |
||
| 391 | public function testDeleteRole($roleHref) |
||
| 399 | } |
||
| 400 |