Add creation of interface attachments to servers

Author: casperboone

samples/compute/v2/servers/create_interface_attachment.php

@@ -0,0 +1,22 @@
+<?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}']);
+
+/**@var OpenStack\Networking\v2\Models\InterfaceAttachment $interface */
+$interface = $server->createInterfaceAttachment([
+    'networkId' => '{networkId}',
+]);

src/Compute/v2/Api.php

@@ -471,6 +471,22 @@ public function getInterfaceAttachments(): array
         ];
     }
 
+    public function postInterfaceAttachment(): array
+    {
+        return [
+            'method'  => 'POST',
+            'path'    => 'servers/{id}/os-interface',
+            'jsonKey' => 'interfaceAttachment',
+            'params'  => [
+                'id'  => $this->params->urlId('server'),
+                'portId' => $this->notRequired($this->params->portId()),
+                'networkId' => $this->notRequired($this->params->networkId()),
+                'fixedIpAddresses' => $this->notRequired($this->params->fixedIpAddresses()),
+                'tag' => $this->notRequired($this->params->tag()),
+            ]
+        ];
+    }
+
     public function getServerMetadata(): array
     {
         return [

src/Compute/v2/Models/Server.php

@@ -328,6 +328,22 @@ public function listInterfaceAttachments(array $options = []): \Generator
         return $this->model(InterfaceAttachment::class)->enumerate($this->api->getInterfaceAttachments(), ['id' => $this->id]);
     }
 
+    /**
+     * Creates an interface attachment.
+     *
+     * @param array $userOptions {@see \OpenStack\Compute\v2\Api::postInterfaceAttachment}
+     * @return InterfaceAttachment
+     */
+    public function createInterfaceAttachment(array $userOptions): InterfaceAttachment
+    {
+        if (!isset($userOptions['networkId']) && !isset($userOptions['portId'])) {
+            throw new \RuntimeException('networkId or portId must be set.');
+        }
+
+        $response = $this->execute($this->api->postInterfaceAttachment(), array_merge($userOptions, ['id' => $this->id]));
+        return $this->model(InterfaceAttachment::class)->populateFromResponse($response);
+    }
+
     /**
      * Retrieves metadata from the API.
      *

src/Compute/v2/Params.php

@@ -130,6 +130,46 @@ public function flavorId(): array
         ];
     }
 
+    public function networkId(): array
+    {
+        return [
+            'type'        => self::STRING_TYPE,
+            'required'    => true,
+            'sentAs'      => 'net_id',
+            'description' => 'The unique ID of a network',
+        ];
+    }
+
+    public function portId(): array
+    {
+        return [
+            'type'        => self::STRING_TYPE,
+            'required'    => true,
+            'sentAs'      => 'port_id',
+            'description' => 'The unique ID of a port',
+        ];
+    }
+
+    public function tag(): array
+    {
+        return [
+            'type' => self::STRING_TYPE,
+        ];
+    }
+
+    public function fixedIpAddresses(): array
+    {
+        return [
+            'type'        => self::ARRAY_TYPE,
+            'sentAs'      => 'fixed_ips',
+            'description' => 'A list of ip addresses which this interface will be associated with',
+            'items'       => [
+                'type'       => self::OBJECT_TYPE,
+                'properties' => ['ip_address' => ['type' => self::STRING_TYPE]]
+            ],
+        ];
+    }
+
     public function metadata(): array
     {
         return [

src/Networking/v2/Models/InterfaceAttachment.php

@@ -1,6 +1,7 @@
 <?php declare(strict_types=1);
 namespace OpenStack\Networking\v2\Models;
 
+use OpenStack\Common\Resource\Creatable;
 use OpenStack\Common\Resource\Listable;
 use OpenStack\Common\Resource\OperatorResource;
 

tests/integration/Compute/v2/CoreTest.php

@@ -188,6 +188,9 @@ public function runTests()
 
             // Console
             $this->getVncConsole();
+
+            // Interface attachments
+            $this->createInterfaceAttachment();
         } finally {
             // Teardown
             $this->deleteServer();
@@ -688,4 +691,16 @@ private function getVncConsole()
 
         $this->logStep('Get VNC console for server {serverId}', $replacements);
     }
+
+    private function createInterfaceAttachment()
+    {
+        $replacements = [
+            '{serverId}' => $this->serverId,
+            '{networkId}' => $this->network->id
+        ];
+
+        require_once $this->sampleFile($replacements, 'servers/create_interface_attachment.php');
+
+        $this->logStep('Create interface attachment for server {serverId}', $replacements);
+    }
 }

tests/unit/Compute/v2/Fixtures/server-interface-attachments-post.resp

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "interfaceAttachment": {
+    "port_state": "ACTIVE",
+    "fixed_ips": [
+      {
+        "subnet_id": "026f22e0-c827-4255-baea-1d4c29483fa4",
+        "ip_address": "10.0.0.1"
+      }
+    ],
+    "port_id": "901e54d5-0a91-48bf-8210-aacaa3185196",
+    "net_id": "338a30eb-3e65-4720-bfb8-105d3507a097",
+    "mac_addr": "ha:12:e3:bb:e7:5f"
+  }
+}

tests/unit/Compute/v2/Models/ServerTest.php

@@ -443,4 +443,21 @@ public function test_it_lists_interface_attachments()
 
         $this->assertInstanceOf(InterfaceAttachment::class, $interfaceAttachments[0]);
     }
+
+    /** @test */
+    public function test_it_creates_interface_attachments()
+    {
+        $networkId = 'fooooobarrrr';
+
+        $expectedJson = [
+            'interfaceAttachment' => ['net_id' => $networkId]
+        ];
+
+        $this->setupMock('POST', 'servers/serverId/os-interface', $expectedJson, [], 'server-interface-attachments-post');
+
+        $interfaceAttachment = $this->server->createInterfaceAttachment(['networkId' => $networkId]);
+
+        $this->assertEquals('ACTIVE', $interfaceAttachment->portState);
+        $this->assertEquals('10.0.0.1', $interfaceAttachment->fixedIps[0]['ip_address']);
+    }
 }