php-opencloud /
openstack
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:
Complex classes like Server often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Server, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 22 | class Server extends OperatorResource implements |
||
| 23 | Creatable, |
||
| 24 | Updateable, |
||
| 25 | Deletable, |
||
| 26 | Retrievable, |
||
| 27 | Listable |
||
| 28 | { |
||
| 29 | use HasWaiterTrait; |
||
| 30 | |||
| 31 | /** @var string */ |
||
| 32 | public $id; |
||
| 33 | |||
| 34 | /** @var string */ |
||
| 35 | public $ipv4; |
||
| 36 | |||
| 37 | /** @var string */ |
||
| 38 | public $ipv6; |
||
| 39 | |||
| 40 | /** @var array */ |
||
| 41 | public $addresses; |
||
| 42 | |||
| 43 | /** @var \DateTimeImmutable */ |
||
| 44 | public $created; |
||
| 45 | |||
| 46 | /** @var \DateTimeImmutable */ |
||
| 47 | public $updated; |
||
| 48 | |||
| 49 | /** @var Flavor */ |
||
| 50 | public $flavor; |
||
| 51 | |||
| 52 | /** @var string */ |
||
| 53 | public $hostId; |
||
| 54 | |||
| 55 | /** @var string */ |
||
| 56 | public $hypervisorHostname; |
||
| 57 | |||
| 58 | /** @var Image */ |
||
| 59 | public $image; |
||
| 60 | |||
| 61 | /** @var array */ |
||
| 62 | public $links; |
||
| 63 | |||
| 64 | /** @var array */ |
||
| 65 | public $metadata; |
||
| 66 | |||
| 67 | /** @var string */ |
||
| 68 | public $name; |
||
| 69 | |||
| 70 | /** @var string */ |
||
| 71 | public $progress; |
||
| 72 | |||
| 73 | /** @var string */ |
||
| 74 | public $status; |
||
| 75 | |||
| 76 | /** @var string */ |
||
| 77 | public $tenantId; |
||
| 78 | |||
| 79 | /** @var string */ |
||
| 80 | public $userId; |
||
| 81 | |||
| 82 | /** @var string */ |
||
| 83 | public $adminPass; |
||
| 84 | |||
| 85 | /** @var string */ |
||
| 86 | public $taskState; |
||
| 87 | |||
| 88 | /** @var string */ |
||
| 89 | public $powerState; |
||
| 90 | |||
| 91 | /** @var string */ |
||
| 92 | public $vmState; |
||
| 93 | |||
| 94 | protected $resourceKey = 'server'; |
||
| 95 | protected $resourcesKey = 'servers'; |
||
| 96 | protected $markerKey = 'id'; |
||
| 97 | |||
| 98 | protected $aliases = [ |
||
| 99 | 'block_device_mapping_v2' => 'blockDeviceMapping', |
||
| 100 | 'accessIPv4' => 'ipv4', |
||
| 101 | 2 | 'accessIPv6' => 'ipv6', |
|
| 102 | 'tenant_id' => 'tenantId', |
||
| 103 | 2 | 'user_id' => 'userId', |
|
| 104 | 2 | 'security_groups' => 'securityGroups', |
|
| 105 | 'OS-EXT-STS:task_state' => 'taskState', |
||
| 106 | 'OS-EXT-STS:power_state' => 'powerState', |
||
| 107 | 'OS-EXT-STS:vm_state' => 'vmState', |
||
| 108 | 'OS-EXT-SRV-ATTR:hypervisor_hostname' => 'hypervisorHostname', |
||
| 109 | ]; |
||
| 110 | 1 | ||
| 111 | /** |
||
| 112 | 1 | * {@inheritDoc} |
|
| 113 | * |
||
| 114 | 1 | * @param array $userOptions {@see \OpenStack\Compute\v2\Api::postServer} |
|
| 115 | */ |
||
| 116 | public function create(array $userOptions): Creatable |
||
| 125 | |||
| 126 | /** |
||
| 127 | * {@inheritDoc} |
||
| 128 | 1 | */ |
|
| 129 | public function update() |
||
| 134 | |||
| 135 | /** |
||
| 136 | * {@inheritDoc} |
||
| 137 | */ |
||
| 138 | public function delete() |
||
| 142 | 1 | ||
| 143 | 1 | /** |
|
| 144 | * {@inheritDoc} |
||
| 145 | 1 | */ |
|
| 146 | 1 | public function retrieve() |
|
| 151 | |||
| 152 | /** |
||
| 153 | 2 | * Changes the root password for a server. |
|
| 154 | * |
||
| 155 | 2 | * @param string $newPassword The new root password |
|
| 156 | 1 | */ |
|
| 157 | public function changePassword(string $newPassword) |
||
| 164 | |||
| 165 | /** |
||
| 166 | * Reboots the server. |
||
| 167 | * |
||
| 168 | * @param string $type The type of reboot that will be performed. Either SOFT or HARD is supported. |
||
| 169 | */ |
||
| 170 | 1 | public function reboot(string $type = Enum::REBOOT_SOFT) |
|
| 181 | |||
| 182 | /** |
||
| 183 | * Starts server |
||
| 184 | 1 | */ |
|
| 185 | public function start() |
||
| 192 | 1 | ||
| 193 | /** |
||
| 194 | * Stops server |
||
| 195 | */ |
||
| 196 | public function stop() |
||
| 203 | |||
| 204 | /** |
||
| 205 | 1 | * Shelves server |
|
| 206 | */ |
||
| 207 | 1 | public function shelve() |
|
| 214 | |||
| 215 | 1 | /* |
|
| 216 | * Suspend server |
||
| 217 | 1 | */ |
|
| 218 | 1 | public function suspend() |
|
| 225 | |||
| 226 | /** |
||
| 227 | * Shelf-offloads server |
||
| 228 | 2 | */ |
|
| 229 | public function shelveOffload() |
||
| 236 | |||
| 237 | /** |
||
| 238 | * Unshelves server |
||
| 239 | */ |
||
| 240 | public function unshelve() |
||
| 247 | |||
| 248 | /* |
||
| 249 | * Resume server |
||
| 250 | */ |
||
| 251 | public function resume() |
||
| 258 | 1 | ||
| 259 | 1 | /** |
|
| 260 | * Rebuilds the server. |
||
| 261 | * |
||
| 262 | * @param array $options {@see \OpenStack\Compute\v2\Api::rebuildServer} |
||
| 263 | */ |
||
| 264 | public function rebuild(array $options) |
||
| 271 | 1 | ||
| 272 | /** |
||
| 273 | 1 | * Resizes the server to a new flavor. Once this operation is complete and server has transitioned |
|
| 274 | 1 | * to an active state, you will either need to call {@see confirmResize()} or {@see revertResize()}. |
|
| 275 | * |
||
| 276 | * @param string $flavorId The UUID of the new flavor your server will be based on. |
||
| 277 | */ |
||
| 278 | public function resize(string $flavorId) |
||
| 287 | 1 | ||
| 288 | /** |
||
| 289 | * Confirms a previous resize operation. |
||
| 290 | */ |
||
| 291 | public function confirmResize() |
||
| 295 | 1 | ||
| 296 | /** |
||
| 297 | 1 | * Reverts a previous resize operation. |
|
| 298 | 1 | */ |
|
| 299 | public function revertResize() |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Gets a VNC console for a server. |
||
| 306 | * |
||
| 307 | * @param string $type The type of VNC console: novnc|xvpvnc. |
||
| 308 | * Defaults to novnc. |
||
| 309 | * |
||
| 310 | * @return array |
||
| 311 | */ |
||
| 312 | public function getVncConsole($type = Enum::CONSOLE_NOVNC): array |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Gets a RDP console for a server. |
||
| 320 | * |
||
| 321 | * @param string $type The type of VNC console: rdp-html5 (default). |
||
| 322 | * |
||
| 323 | * @return array |
||
| 324 | */ |
||
| 325 | public function getRDPConsole($type = Enum::CONSOLE_RDP_HTML5): array |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Gets a Spice console for a server. |
||
| 333 | * |
||
| 334 | * @param string $type The type of VNC console: spice-html5. |
||
| 335 | * |
||
| 336 | * @return array |
||
| 337 | */ |
||
| 338 | public function getSpiceConsole($type = Enum::CONSOLE_SPICE_HTML5): array |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Gets a serial console for a server. |
||
| 346 | * |
||
| 347 | * @param string $type The type of VNC console: serial. |
||
| 348 | * |
||
| 349 | * @return array |
||
| 350 | */ |
||
| 351 | public function getSerialConsole($type = Enum::CONSOLE_SERIAL): array |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Get the console log. |
||
| 359 | * |
||
| 360 | * @param int $length Number of lines of console log to grab. |
||
| 361 | * |
||
| 362 | * @return string - the console log output |
||
| 363 | */ |
||
| 364 | public function getConsoleLog(int $length = 50): string { |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Creates an image for the current server. |
||
| 371 | * |
||
| 372 | * @param array $options {@see \OpenStack\Compute\v2\Api::createServerImage} |
||
| 373 | */ |
||
| 374 | public function createImage(array $options) |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Iterates over all the IP addresses for this server. |
||
| 382 | * |
||
| 383 | * @param array $options {@see \OpenStack\Compute\v2\Api::getAddressesByNetwork} |
||
| 384 | * |
||
| 385 | * @return array An array containing to two keys: "public" and "private" |
||
| 386 | */ |
||
| 387 | public function listAddresses(array $options = []): array |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Returns Generator for InterfaceAttachment |
||
| 398 | * |
||
| 399 | * @return \Generator |
||
| 400 | */ |
||
| 401 | public function listInterfaceAttachments(array $options = []): \Generator |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Retrieves metadata from the API. |
||
| 408 | * |
||
| 409 | * @return array |
||
| 410 | */ |
||
| 411 | public function getMetadata(): array |
||
| 416 | |||
| 417 | /** |
||
| 418 | * Resets all the metadata for this server with the values provided. All existing metadata keys |
||
| 419 | * will either be replaced or removed. |
||
| 420 | * |
||
| 421 | * @param array $metadata {@see \OpenStack\Compute\v2\Api::putServerMetadata} |
||
| 422 | */ |
||
| 423 | public function resetMetadata(array $metadata) |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Merges the existing metadata for the server with the values provided. Any existing keys |
||
| 431 | * referenced in the user options will be replaced with the user's new values. All other |
||
| 432 | * existing keys will remain unaffected. |
||
| 433 | * |
||
| 434 | * @param array $metadata {@see \OpenStack\Compute\v2\Api::postServerMetadata} |
||
| 435 | * |
||
| 436 | * @return array |
||
| 437 | */ |
||
| 438 | public function mergeMetadata(array $metadata) |
||
| 443 | |||
| 444 | /** |
||
| 445 | * Retrieve the value for a specific metadata key. |
||
| 446 | * |
||
| 447 | * @param string $key {@see \OpenStack\Compute\v2\Api::getServerMetadataKey} |
||
| 448 | * |
||
| 449 | * @return mixed |
||
| 450 | */ |
||
| 451 | View Code Duplication | public function getMetadataItem(string $key) |
|
| 458 | |||
| 459 | /** |
||
| 460 | * Remove a specific metadata key. |
||
| 461 | * |
||
| 462 | * @param string $key {@see \OpenStack\Compute\v2\Api::deleteServerMetadataKey} |
||
| 463 | */ |
||
| 464 | View Code Duplication | public function deleteMetadataItem(string $key) |
|
| 472 | |||
| 473 | |||
| 474 | /** |
||
| 475 | * Add security group to a server (addSecurityGroup action) |
||
| 476 | * |
||
| 477 | * @param array $options {@see \OpenStack\Compute\v2\Api::postSecurityGroup} |
||
| 478 | * |
||
| 479 | * @return SecurityGroup |
||
| 480 | */ |
||
| 481 | public function addSecurityGroup(array $options) : SecurityGroup |
||
| 489 | |||
| 490 | /** |
||
| 491 | * Add security group to a server (addSecurityGroup action) |
||
| 492 | * |
||
| 493 | * @param array $options {@see \OpenStack\Compute\v2\Api::deleteSecurityGroup} |
||
| 494 | */ |
||
| 495 | public function removeSecurityGroup(array $options) |
||
| 500 | |||
| 501 | public function parseMetadata(ResponseInterface $response): array |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Returns Generator for SecurityGroups |
||
| 508 | * |
||
| 509 | * @return \Generator |
||
| 510 | */ |
||
| 511 | public function listSecurityGroups(): \Generator |
||
| 515 | |||
| 516 | |||
| 517 | /** |
||
| 518 | * Returns Generator for VolumeAttachment |
||
| 519 | * |
||
| 520 | * @return \Generator |
||
| 521 | */ |
||
| 522 | public function listVolumeAttachments(): \Generator |
||
| 526 | |||
| 527 | /** |
||
| 528 | * Attach a volume and returns volume that was attached |
||
| 529 | * |
||
| 530 | * @param $volumeId |
||
| 531 | * |
||
| 532 | * @return VolumeAttachment |
||
| 533 | */ |
||
| 534 | public function attachVolume(string $volumeId): VolumeAttachment |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Detach a volume |
||
| 543 | * |
||
| 544 | * @param $attachmentId |
||
| 545 | * |
||
| 546 | * @return void |
||
| 547 | */ |
||
| 548 | public function detachVolume(string $attachmentId) |
||
| 552 | } |
||
| 553 |
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.