New api: add/remove/list SecurityGroups for a server

Author: haphan

samples/compute/v2/servers/add_remove_security_group.php

@@ -0,0 +1,23 @@
+<?php
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+$compute = $openstack->computeV2(['region' => '{region}']);
+
+$server = $compute->getServer([
+    'id' => '{serverId}',
+]);
+
+$server->addSecurityGroup(['name' => 'secgroup name']);
+$server->removeSecurityGroup(['name' => 'default']);
+

samples/compute/v2/servers/list_security_groups.php

@@ -0,0 +1,31 @@
+<?php
+
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroupRule;
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+$compute = $openstack->computeV2(['region' => '{region}']);
+
+$server = $compute->getServer(['id' => 'uuid']);
+foreach($server->listSecurityGroups() as $securityGroup)
+{
+    /**@var SecurityGroup $securityGroup */
+    $rules = $securityGroup->securityGroupRules;
+
+    foreach($rules as $rule)
+    {
+        /**@var SecurityGroupRule $rule */
+        $rule->direction;
+    }
+}

src/Compute/v2/Api.php

@@ -472,4 +472,42 @@ public function deleteKeypair(): array
         ];
     }
 
+    public function addSecurityGroup(): array
+    {
+        return [
+            'method' => 'POST',
+            'path'   => 'servers/{id}/action',
+            'jsonKey' => 'addSecurityGroup',
+            'params' => [
+                'id'   => $this->params->urlId('server'),
+                'name' => $this->isRequired($this->params->name('securityGroup')),
+            ],
+        ];
+    }
+
+    public function removeSecurityGroup(): array
+    {
+        return [
+            'method' => 'POST',
+            'path'   => 'servers/{id}/action',
+            'jsonKey' => 'removeSecurityGroup',
+            'params' => [
+                'id'   => $this->params->urlId('server'),
+                'name' => $this->isRequired($this->params->name('securityGroup')),
+            ],
+        ];
+    }
+
+    public function listSecurityGroupByServer(): array
+    {
+        return [
+            'method'  => 'GET',
+            'path'    => 'servers/{id}/os-security-groups',
+            'jsonKey' => 'security_groups',
+            'params'  => [
+                'id' => $this->params->urlId('server')
+            ],
+        ];
+    }
+
 }

src/Compute/v2/Models/Server.php

@@ -11,7 +11,9 @@
 use OpenCloud\Common\Resource\OperatorResource;
 use OpenCloud\Common\Transport\Utils;
 use OpenStack\Compute\v2\Enum;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
 use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\VarDumper\VarDumper;
 
 /**
  * @property \OpenStack\Compute\v2\Api $api
@@ -299,8 +301,41 @@ public function deleteMetadataItem(string $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]);
+    }
 }

src/Networking/v2/Extensions/SecurityGroups/Models/SecurityGroup.php

@@ -42,6 +42,7 @@ class SecurityGroup extends OperatorResource implements Creatable, Listable, Del
 
     protected $aliases = [
         'security_group_rules' => 'securityGroupRules',
+        'rules'                => 'securityGroupRules',
         'tenant_id'            => 'tenantId',
     ];