Server::addSecurityGroup() - Code Metrics - Inspection of "[wip] SSH Keys, Flavor, Add/remove SecGroup, Attac..." - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#50)

by Ha

created 2016-04-24 07:42 UTC

Server::addSecurityGroup() A

↳ Parent: Server

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Metric	Value
dl	0
loc	5
ccs	0
cts	0
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php declare (strict_types=1);

namespace OpenStack\Compute\v2\Models;

use OpenCloud\Common\Resource\HasWaiterTrait;
use OpenCloud\Common\Resource\Creatable;
use OpenCloud\Common\Resource\Deletable;
use OpenCloud\Common\Resource\Listable;
use OpenCloud\Common\Resource\Retrievable;
use OpenCloud\Common\Resource\Updateable;
use OpenCloud\Common\Resource\OperatorResource;
use OpenCloud\Common\Transport\Utils;
use OpenStack\BlockStorage\v2\Models\VolumeAttachment;
use OpenStack\Compute\v2\Enum;
use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
use Psr\Http\Message\ResponseInterface;

/**
 * @property \OpenStack\Compute\v2\Api $api
 */
class Server extends OperatorResource implements

    Creatable,
    Updateable,
    Deletable,
    Retrievable,
    Listable
{
    use HasWaiterTrait;

    /** @var string */
    public $id;

    /** @var string */
    public $ipv4;

    /** @var string */
    public $ipv6;

    /** @var array */
    public $addresses;

    /** @var \DateTimeImmutable */
    public $created;

    /** @var \DateTimeImmutable */
    public $updated;

    /** @var Flavor */
    public $flavor;

    /** @var string */
    public $hostId;

    /** @var Image */
    public $image;

    /** @var array */
    public $links;

    /** @var array */
    public $metadata;

    /** @var string */
    public $name;

    /** @var string */
    public $progress;

    /** @var string */
    public $status;

    /** @var string */
    public $tenantId;

    /** @var string */
    public $userId;

    /** @var string */
    public $adminPass;

    /** @var string */
    public $taskState;

    protected $resourceKey = 'server';
    protected $resourcesKey = 'servers';
    protected $markerKey = 'id';

    protected $aliases = [
        'block_device_mapping_v2' => 'blockDeviceMapping',
        'accessIPv4'              => 'ipv4',
        'accessIPv6'              => 'ipv6',
        'tenant_id'               => 'tenantId',
        'user_id'                 => 'userId',
        'security_groups'         => 'securityGroups',
        'OS-EXT-STS:task_state'   => 'taskState',
    ];

    /**
     * {@inheritDoc}
     *
     * @param array $userOptions {@see \OpenStack\Compute\v2\Api::postServer}
     */
    public function create(array $userOptions): Creatable
    {
        $response = $this->execute($this->api->postServer(), $userOptions);
        return $this->populateFromResponse($response);
    }

    /**
     * {@inheritDoc}
     */
    public function update()
    {
        $response = $this->execute($this->api->putServer(), $this->getAttrs(['id', 'name', 'ipv4', 'ipv6']));
        $this->populateFromResponse($response);
    }

    /**
     * {@inheritDoc}
     */
    public function delete()
    {
        $this->execute($this->api->deleteServer(), $this->getAttrs(['id']));
    }

    /**
     * {@inheritDoc}
     */
    public function retrieve()
    {
        $response = $this->execute($this->api->getServer(), $this->getAttrs(['id']));
        $this->populateFromResponse($response);
    }

    /**
     * Changes the root password for a server.
     *
     * @param string $newPassword The new root password
     */
    public function changePassword(string $newPassword)
    {
        $this->execute($this->api->changeServerPassword(), [
            'id'       => $this->id,
            'password' => $newPassword,
        ]);
    }

    /**
     * Reboots the server.
     *
     * @param string $type The type of reboot that will be performed. Either SOFT or HARD is supported.
     */
    public function reboot(string $type = Enum::REBOOT_SOFT)
    {
        if (!in_array($type, ['SOFT', 'HARD'])) {
            throw new \RuntimeException('Reboot type must either be SOFT or HARD');
        }

        $this->execute($this->api->rebootServer(), [
            'id'   => $this->id,
            'type' => $type,
        ]);
    }

    /**
     * Rebuilds the server.
     *
     * @param array $options {@see \OpenStack\Compute\v2\Api::rebuildServer}
     */
    public function rebuild(array $options)
    {
        $options['id'] = $this->id;
        $response = $this->execute($this->api->rebuildServer(), $options);

        $this->populateFromResponse($response);
    }

    /**
     * Resizes the server to a new flavor. Once this operation is complete and server has transitioned
     * to an active state, you will either need to call {@see confirmResize()} or {@see revertResize()}.
     *
     * @param string $flavorId The UUID of the new flavor your server will be based on.
     */
    public function resize(string $flavorId)
    {
        $response = $this->execute($this->api->resizeServer(), [
            'id'       => $this->id,
            'flavorId' => $flavorId,
        ]);

        $this->populateFromResponse($response);
    }

    /**
     * Confirms a previous resize operation.
     */
    public function confirmResize()
    {
        $this->execute($this->api->confirmServerResize(), ['confirmResize' => null, 'id' => $this->id]);
    }

    /**
     * Reverts a previous resize operation.
     */
    public function revertResize()
    {
        $this->execute($this->api->revertServerResize(), ['revertResize' => null, 'id' => $this->id]);
    }

    /**
     * Creates an image for the current server.
     *
     * @param array $options {@see \OpenStack\Compute\v2\Api::createServerImage}
     */
    public function createImage(array $options)
    {
        $options['id'] = $this->id;
        $this->execute($this->api->createServerImage(), $options);
    }

    /**
     * Iterates over all the IP addresses for this server.
     *
     * @param array $options {@see \OpenStack\Compute\v2\Api::getAddressesByNetwork}
     *
     * @return array An array containing to two keys: "public" and "private"
     */
    public function listAddresses(array $options = []): array
    {
        $options['id'] = $this->id;

        $data = (isset($options['networkLabel'])) ? $this->api->getAddressesByNetwork() : $this->api->getAddresses();
        $response = $this->execute($data, $options);
        return Utils::jsonDecode($response)['addresses'];
    }

    /**
     * Retrieves metadata from the API.
     *
     * @return array
     */
    public function getMetadata(): array
    {
        $response = $this->execute($this->api->getServerMetadata(), ['id' => $this->id]);
        return $this->parseMetadata($response);
    }

    /**
     * Resets all the metadata for this server with the values provided. All existing metadata keys
     * will either be replaced or removed.
     *
     * @param array $metadata {@see \OpenStack\Compute\v2\Api::putServerMetadata}
     */
    public function resetMetadata(array $metadata)
    {
        $response = $this->execute($this->api->putServerMetadata(), ['id' => $this->id, 'metadata' => $metadata]);
        $this->metadata = $this->parseMetadata($response);
    }

    /**
     * Merges the existing metadata for the server with the values provided. Any existing keys
     * referenced in the user options will be replaced with the user's new values. All other
     * existing keys will remain unaffected.
     *
     * @param array $metadata {@see \OpenStack\Compute\v2\Api::postServerMetadata}
     *
     * @return array
     */
    public function mergeMetadata(array $metadata)
    {
        $response = $this->execute($this->api->postServerMetadata(), ['id' => $this->id, 'metadata' => $metadata]);
        $this->metadata = $this->parseMetadata($response);
    }

    /**
     * Retrieve the value for a specific metadata key.
     *
     * @param string $key {@see \OpenStack\Compute\v2\Api::getServerMetadataKey}
     *
     * @return mixed
     */
    public function getMetadataItem(string $key)

    {
        $response = $this->execute($this->api->getServerMetadataKey(), ['id' => $this->id, 'key' => $key]);
        $value = $this->parseMetadata($response)[$key];
        $this->metadata[$key] = $value;
        return $value;
    }

    /**
     * Remove a specific metadata key.
     *
     * @param string $key {@see \OpenStack\Compute\v2\Api::deleteServerMetadataKey}
     */
    public function deleteMetadataItem(string $key)

    {
        if (isset($this->metadata[$key])) {
            unset($this->metadata[$key]);
        }

        $this->execute($this->api->deleteServerMetadataKey(), ['id' => $this->id, 'key' => $key]);
    }


    /**
     * Add security group to a server (addSecurityGroup action)
     *
     * @param array $options {@see \OpenStack\Compute\v2\Api::addSecurityGroup}
     */
    public function addSecurityGroup(array $options)
    {
        $options['id'] = $this->id;
        $this->execute($this->api->addSecurityGroup(), $options);
    }

    /**
     * Add security group to a server (addSecurityGroup action)
     *
     * @param array $options {@see \OpenStack\Compute\v2\Api::removeSecurityGroup}
     */
    public function removeSecurityGroup(array $options)
    {
        $options['id'] = $this->id;
        $this->execute($this->api->removeSecurityGroup(), $options);
    }

    public function parseMetadata(ResponseInterface $response): array
    {
        return Utils::jsonDecode($response)['metadata'];
    }

    /**
     * Returns Generator for SecurityGroups
     *
     * @return \Generator
     */
    public function listSecurityGroups()
    {
        return $this->model(SecurityGroup::class)->enumerate($this->api->listSecurityGroupByServer(), ['id' => $this->id]);
    }


    /**
     * Returns Generator for SecurityGroups
     *
     * @return \Generator
     */
    public function listVolumeAttachments()
    {
        return $this->model(VolumeAttachment::class)->enumerate($this->api->listVolumeAttachments(), ['id' => $this->id]);
    }

    /**
     * @param $volumeId
     *
     * @return VolumeAttachment
     */
    public function attachVolume($volumeId)
    {
        $response =  $this->execute($this->api->attachVolume(), ['id' => $this->id, 'volumeId' => $volumeId]);

        return $this->model(VolumeAttachment::class)->populateFromResponse($response);
    }

    public function detachVolume($attachmentId)
    {
        return $this->execute($this->api->detachVolume(), ['id' => $this->id, 'attachmentId' => $attachmentId]);
    }
}


1			<?php declare (strict_types=1);
2
3			namespace OpenStack\Compute\v2\Models;
4
5			use OpenCloud\Common\Resource\HasWaiterTrait;
6			use OpenCloud\Common\Resource\Creatable;
7			use OpenCloud\Common\Resource\Deletable;
8			use OpenCloud\Common\Resource\Listable;
9			use OpenCloud\Common\Resource\Retrievable;
10			use OpenCloud\Common\Resource\Updateable;
11			use OpenCloud\Common\Resource\OperatorResource;
12			use OpenCloud\Common\Transport\Utils;
13			use OpenStack\BlockStorage\v2\Models\VolumeAttachment;
14			use OpenStack\Compute\v2\Enum;
15			use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
16			use Psr\Http\Message\ResponseInterface;
17
18			/**
19			* @property \OpenStack\Compute\v2\Api $api
20			*/
21			class Server extends OperatorResource implements
			0 ignored issues – show Bug introduced 2016-04-11 10:20 UTC by Report Bug Copy Issue Report There is one abstract method `enumerate` in this class; you could implement it, or declare this class as abstract. Loading history...
22			Creatable,
23			Updateable,
24			Deletable,
25			Retrievable,
26			Listable
27			{
28			use HasWaiterTrait;
29
30			/** @var string */
31			public $id;
32
33			/** @var string */
34			public $ipv4;
35
36			/** @var string */
37			public $ipv6;
38
39			/** @var array */
40			public $addresses;
41
42			/** @var \DateTimeImmutable */
43			public $created;
44
45			/** @var \DateTimeImmutable */
46			public $updated;
47
48			/** @var Flavor */
49			public $flavor;
50
51			/** @var string */
52			public $hostId;
53
54			/** @var Image */
55			public $image;
56
57			/** @var array */
58			public $links;
59
60			/** @var array */
61			public $metadata;
62
63			/** @var string */
64			public $name;
65
66			/** @var string */
67			public $progress;
68
69			/** @var string */
70			public $status;
71
72			/** @var string */
73			public $tenantId;
74
75			/** @var string */
76			public $userId;
77
78			/** @var string */
79			public $adminPass;
80
81			/** @var string */
82			public $taskState;
83
84			protected $resourceKey = 'server';
85			protected $resourcesKey = 'servers';
86			protected $markerKey = 'id';
87
88			protected $aliases = [
89			'block_device_mapping_v2' => 'blockDeviceMapping',
90			'accessIPv4' => 'ipv4',
91			'accessIPv6' => 'ipv6',
92			'tenant_id' => 'tenantId',
93			'user_id' => 'userId',
94			'security_groups' => 'securityGroups',
95			'OS-EXT-STS:task_state' => 'taskState',
96			];
97
98			/**
99			* {@inheritDoc}
100			*
101	2		* @param array $userOptions {@see \OpenStack\Compute\v2\Api::postServer}
102			*/
103	2		public function create(array $userOptions): Creatable
104	2		{
105			$response = $this->execute($this->api->postServer(), $userOptions);
106			return $this->populateFromResponse($response);
107			}
108
109			/**
110	1		* {@inheritDoc}
111			*/
112	1		public function update()
113			{
114	1		$response = $this->execute($this->api->putServer(), $this->getAttrs(['id', 'name', 'ipv4', 'ipv6']));
115			$this->populateFromResponse($response);
116			}
117
118			/**
119			* {@inheritDoc}
120	1		*/
121			public function delete()
122	1		{
123	1		$this->execute($this->api->deleteServer(), $this->getAttrs(['id']));
124			}
125
126			/**
127			* {@inheritDoc}
128	1		*/
129			public function retrieve()
130	1		{
131			$response = $this->execute($this->api->getServer(), $this->getAttrs(['id']));
132	1		$this->populateFromResponse($response);
133			}
134
135			/**
136			* Changes the root password for a server.
137			*
138			* @param string $newPassword The new root password
139			*/
140	1		public function changePassword(string $newPassword)
141			{
142	1		$this->execute($this->api->changeServerPassword(), [
143	1		'id' => $this->id,
144			'password' => $newPassword,
145	1		]);
146	1		}
147
148			/**
149			* Reboots the server.
150			*
151			* @param string $type The type of reboot that will be performed. Either SOFT or HARD is supported.
152			*/
153	2		public function reboot(string $type = Enum::REBOOT_SOFT)
154			{
155	2		if (!in_array($type, ['SOFT', 'HARD'])) {
156	1		throw new \RuntimeException('Reboot type must either be SOFT or HARD');
157			}
158
159	1		$this->execute($this->api->rebootServer(), [
160	1		'id' => $this->id,
161	1		'type' => $type,
162	1		]);
163	1		}
164
165			/**
166			* Rebuilds the server.
167			*
168			* @param array $options {@see \OpenStack\Compute\v2\Api::rebuildServer}
169			*/
170	1		public function rebuild(array $options)
171			{
172	1		$options['id'] = $this->id;
173	1		$response = $this->execute($this->api->rebuildServer(), $options);
174
175	1		$this->populateFromResponse($response);
176	1		}
177
178			/**
179			* Resizes the server to a new flavor. Once this operation is complete and server has transitioned
180			* to an active state, you will either need to call {@see confirmResize()} or {@see revertResize()}.
181			*
182			* @param string $flavorId The UUID of the new flavor your server will be based on.
183			*/
184	1		public function resize(string $flavorId)
185			{
186	1		$response = $this->execute($this->api->resizeServer(), [
187	1		'id' => $this->id,
188	1		'flavorId' => $flavorId,
189	1		]);
190
191	1		$this->populateFromResponse($response);
192	1		}
193
194			/**
195			* Confirms a previous resize operation.
196			*/
197	1		public function confirmResize()
198			{
199	1		$this->execute($this->api->confirmServerResize(), ['confirmResize' => null, 'id' => $this->id]);
200	1		}
201
202			/**
203			* Reverts a previous resize operation.
204			*/
205	1		public function revertResize()
206			{
207	1		$this->execute($this->api->revertServerResize(), ['revertResize' => null, 'id' => $this->id]);
208	1		}
209
210			/**
211			* Creates an image for the current server.
212			*
213			* @param array $options {@see \OpenStack\Compute\v2\Api::createServerImage}
214			*/
215	1		public function createImage(array $options)
216			{
217	1		$options['id'] = $this->id;
218	1		$this->execute($this->api->createServerImage(), $options);
219	1		}
220
221			/**
222			* Iterates over all the IP addresses for this server.
223			*
224			* @param array $options {@see \OpenStack\Compute\v2\Api::getAddressesByNetwork}
225			*
226			* @return array An array containing to two keys: "public" and "private"
227			*/
228	2		public function listAddresses(array $options = []): array
229			{
230	2		$options['id'] = $this->id;
231
232	2		$data = (isset($options['networkLabel'])) ? $this->api->getAddressesByNetwork() : $this->api->getAddresses();
233	2		$response = $this->execute($data, $options);
234	2		return Utils::jsonDecode($response)['addresses'];
235			}
236
237			/**
238			* Retrieves metadata from the API.
239			*
240			* @return array
241			*/
242	1		public function getMetadata(): array
243			{
244	1		$response = $this->execute($this->api->getServerMetadata(), ['id' => $this->id]);
245	1		return $this->parseMetadata($response);
246			}
247
248			/**
249			* Resets all the metadata for this server with the values provided. All existing metadata keys
250			* will either be replaced or removed.
251			*
252			* @param array $metadata {@see \OpenStack\Compute\v2\Api::putServerMetadata}
253			*/
254			public function resetMetadata(array $metadata)
255			{
256	1		$response = $this->execute($this->api->putServerMetadata(), ['id' => $this->id, 'metadata' => $metadata]);
257			$this->metadata = $this->parseMetadata($response);
258	1		}
259	1
260			/**
261			* Merges the existing metadata for the server with the values provided. Any existing keys
262			* referenced in the user options will be replaced with the user's new values. All other
263			* existing keys will remain unaffected.
264			*
265			* @param array $metadata {@see \OpenStack\Compute\v2\Api::postServerMetadata}
266			*
267			* @return array
268			*/
269			public function mergeMetadata(array $metadata)
270			{
271	1		$response = $this->execute($this->api->postServerMetadata(), ['id' => $this->id, 'metadata' => $metadata]);
272			$this->metadata = $this->parseMetadata($response);
273	1		}
274	1
275			/**
276			* Retrieve the value for a specific metadata key.
277			*
278			* @param string $key {@see \OpenStack\Compute\v2\Api::getServerMetadataKey}
279			*
280			* @return mixed
281			*/
282		View Code Duplication	public function getMetadataItem(string $key)
			0 ignored issues – show Duplication introduced 2016-03-18 13:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
283			{
284	1		$response = $this->execute($this->api->getServerMetadataKey(), ['id' => $this->id, 'key' => $key]);
285			$value = $this->parseMetadata($response)[$key];
286	1		$this->metadata[$key] = $value;
287	1		return $value;
288			}
289
290			/**
291			* Remove a specific metadata key.
292			*
293			* @param string $key {@see \OpenStack\Compute\v2\Api::deleteServerMetadataKey}
294			*/
295	1	View Code Duplication	public function deleteMetadataItem(string $key)
			0 ignored issues – show Duplication introduced 2016-03-18 13:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
296			{
297	1		if (isset($this->metadata[$key])) {
298	1		unset($this->metadata[$key]);
299			}
300
301			$this->execute($this->api->deleteServerMetadataKey(), ['id' => $this->id, 'key' => $key]);
302			}
303
304
305			/**
306			* Add security group to a server (addSecurityGroup action)
307			*
308			* @param array $options {@see \OpenStack\Compute\v2\Api::addSecurityGroup}
309			*/
310			public function addSecurityGroup(array $options)
311			{
312			$options['id'] = $this->id;
313			$this->execute($this->api->addSecurityGroup(), $options);
314			}
315
316			/**
317			* Add security group to a server (addSecurityGroup action)
318			*
319			* @param array $options {@see \OpenStack\Compute\v2\Api::removeSecurityGroup}
320			*/
321			public function removeSecurityGroup(array $options)
322			{
323			$options['id'] = $this->id;
324			$this->execute($this->api->removeSecurityGroup(), $options);
325			}
326
327			public function parseMetadata(ResponseInterface $response): array
328			{
329			return Utils::jsonDecode($response)['metadata'];
330			}
331
332			/**
333			* Returns Generator for SecurityGroups
334			*
335			* @return \Generator
336			*/
337			public function listSecurityGroups()
338			{
339			return $this->model(SecurityGroup::class)->enumerate($this->api->listSecurityGroupByServer(), ['id' => $this->id]);
340			}
341
342
343			/**
344			* Returns Generator for SecurityGroups
345			*
346			* @return \Generator
347			*/
348			public function listVolumeAttachments()
349			{
350			return $this->model(VolumeAttachment::class)->enumerate($this->api->listVolumeAttachments(), ['id' => $this->id]);
351			}
352
353			/**
354			* @param $volumeId
355			*
356			* @return VolumeAttachment
357			*/
358			public function attachVolume($volumeId)
359			{
360			$response = $this->execute($this->api->attachVolume(), ['id' => $this->id, 'volumeId' => $volumeId]);
361
362			return $this->model(VolumeAttachment::class)->populateFromResponse($response);
363			}
364
365			public function detachVolume($attachmentId)
366			{
367			return $this->execute($this->api->detachVolume(), ['id' => $this->id, 'attachmentId' => $attachmentId]);
368			}
369			}
370

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#50)

Server::addSecurityGroup() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like