Add server rescue and unrescue

Author: casperboone

samples/compute/v2/servers/rescue_server.php

@@ -0,0 +1,24 @@
+<?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->rescue([
+    'imageId'   => '{imageId}',
+    'adminPass' => '{adminPass}',
+]);

samples/compute/v2/servers/unrescue_server.php

@@ -0,0 +1,21 @@
+<?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->unrescue();

src/Compute/v2/Api.php

@@ -335,6 +335,32 @@ public function rebuildServer(): array
         ];
     }
 
+    public function rescueServer(): array
+    {
+        return [
+            'method'  => 'POST',
+            'path'    => 'servers/{id}/action',
+            'jsonKey' => 'rescue',
+            'params'  => [
+                'id'          => $this->params->urlId('server'),
+                'imageId'     => $this->params->rescueImageId(),
+                'adminPass'   => $this->params->password(),
+            ],
+        ];
+    }
+
+    public function unrescueServer(): array
+    {
+        return [
+            'method'  => 'POST',
+            'path'    => 'servers/{id}/action',
+            'params'  => [
+                'id'       => $this->params->urlId('server'),
+                'unrescue' => $this->params->nullAction(),
+            ],
+        ];
+    }
+
     public function resizeServer(): array
     {
         return [

src/Compute/v2/Models/Server.php

@@ -214,6 +214,28 @@ public function rebuild(array $options)
         $this->populateFromResponse($response);
     }
 
+    /**
+     * Rescues the server.
+     *
+     * @param array $options {@see \OpenStack\Compute\v2\Api::rescueServer}
+     * @return string
+     */
+    public function rescue(array $options): string
+    {
+        $options['id'] = $this->id;
+        $response = $this->execute($this->api->rescueServer(), $options);
+
+        return Utils::jsonDecode($response)['adminPass'];
+    }
+
+    /**
+     * Unrescues the server.
+     */
+    public function unrescue()
+    {
+        $this->execute($this->api->unrescueServer(), ['unrescue' => null, 'id' => $this->id]);
+    }
+
     /**
      * 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()}.

src/Compute/v2/Params.php

@@ -120,6 +120,16 @@ public function imageId(): array
         ];
     }
 
+    public function rescueImageId(): array
+    {
+        return [
+            'type'        => self::STRING_TYPE,
+            'required'    => true,
+            'sentAs'      => 'rescue_image_ref',
+            'description' => 'The image reference to use to rescue your server instance. Specify the image reference by ID or full URL. If you omit an image reference, default is the base image reference',
+        ];
+    }
+
     public function flavorId(): array
     {
         return [

tests/integration/Compute/v2/CoreTest.php

@@ -148,6 +148,7 @@ public function runTests()
             $this->resizeServer();
             $this->confirmServerResize();
             $this->rebuildServer();
+            $this->rescueServer();
             $this->createServerImage();
             $this->rebootServer();
 
@@ -363,6 +364,26 @@ private function rebuildServer()
         $this->logStep('Rebuilt server {serverId}', $replacements);
     }
 
+    private function rescueServer()
+    {
+        $replacements = [
+            '{serverId}'  => $this->serverId,
+            '{imageId}'   => $this->imageId,
+            '{adminPass}' => $this->adminPass,
+        ];
+
+        /** @var $server \OpenStack\Compute\v2\Models\Server */
+        require_once $this->sampleFile($replacements, 'servers/rescue_server.php');
+
+        $server->waitUntil('RESCUE');
+
+        require_once $this->sampleFile($replacements, 'servers/unrescue_server.php');
+
+        $server->waitUntilActive();
+
+        $this->logStep('Rescued server {serverId}', $replacements);
+    }
+
     private function rebootServer()
     {
         $replacements = ['{serverId}' => $this->serverId];

tests/unit/Compute/v2/Fixtures/server-rescue.resp

@@ -0,0 +1,6 @@
+HTTP/1.1 200 Accepted
+Content-Type: application/json
+
+{
+    "adminPass": "foo"
+}

tests/unit/Compute/v2/Fixtures/server-unrescue.resp

@@ -0,0 +1,2 @@
+HTTP/1.1 202 Accepted
+Content-Type: application/json

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

@@ -167,6 +167,36 @@ public function test_it_rebuilds()
         $this->assertEquals($userOptions['name'], $this->server->name);
     }
 
+    public function test_it_rescues()
+    {
+        $userOptions = [
+            'imageId'     => 'newImage',
+            'adminPass'   => 'foo',
+        ];
+
+        $expectedJson = [
+            'rescue' => [
+                'rescue_image_ref' => $userOptions['imageId'],
+                'adminPass'        => $userOptions['adminPass']
+            ]
+        ];
+
+        $this->setupMock('POST', 'servers/serverId/action', $expectedJson, [], 'server-rescue');
+
+        $adminPass = $this->server->rescue($userOptions);
+
+        $this->assertEquals('foo', $adminPass);
+    }
+
+    public function test_it_unrescues()
+    {
+        $expectedJson = ['unrescue' => null];
+
+        $this->setupMock('POST', 'servers/serverId/action', $expectedJson, [], 'server-unrescue');
+
+        $this->assertNull($this->server->unrescue());
+    }
+
     public function test_it_starts()
     {
         $expectedJson = ['os-start' => null];