Merge pull request #145 from casperboone/console_output

Add server console output

Author: haphan

samples/compute/v2/servers/get_server_console_output.php

@@ -0,0 +1,20 @@
+<?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 string $consoleOutput */
+$consoleOutput = $server->getConsoleOutput();

src/Compute/v2/Api.php

@@ -398,6 +398,31 @@ public function revertServerResize(): array
         ];
     }
 
+    public function getConsoleOutput(): array
+    {
+        return [
+            'method'  => 'POST',
+            'path'    => 'servers/{id}/action',
+            'jsonKey' => 'os-getConsoleOutput',
+            'params'  => [
+                'id'     => $this->params->urlId('server'),
+                'length' => $this->notRequired($this->params->consoleLogLength()),
+            ],
+        ];
+    }
+
+    public function getAllConsoleOutput(): array
+    {
+        return [
+            'method'  => 'POST',
+            'path'    => 'servers/{id}/action',
+            'params'  => [
+                'id'                  => $this->params->urlId('server'),
+                'os-getConsoleOutput' => $this->params->emptyObject(),
+            ],
+        ];
+    }
+
     public function createServerImage(): array
     {
         return [

src/Compute/v2/Models/Server.php

@@ -285,6 +285,25 @@ public function revertResize()
         $this->execute($this->api->revertServerResize(), ['revertResize' => null, 'id' => $this->id]);
     }
 
+    /**
+     * Gets the console output of the server.
+     *
+     * @param int $length The number of lines, by default all lines will be returned.
+     * @return string
+     */
+    public function getConsoleOutput(int $length = -1): string
+    {
+        $definition = $length == -1 ? $this->api->getAllConsoleOutput() : $this->api->getConsoleOutput();
+
+        $response = $this->execute($definition, [
+            'os-getConsoleOutput' => new \stdClass(),
+            'id' => $this->id,
+            'length' => $length,
+        ]);
+
+        return Utils::jsonDecode($response)['output'];
+    }
+
     /**
      * Gets a VNC console for a server.
      *

src/Compute/v2/Params.php

@@ -519,6 +519,22 @@ public function consoleType(): array
         ];
     }
 
+    public function consoleLogLength(): array
+    {
+        return [
+            'type'     => self::INT_TYPE,
+            'location' => self::JSON,
+            'required' => false,
+        ];
+    }
+
+    public function emptyObject(): array
+    {
+        return [
+            'type'  => self::OBJECT_TYPE,
+        ];
+    }
+
     protected function quotaSetLimit($sentAs, $description): array
     {
         return [

tests/integration/Compute/v2/CoreTest.php

@@ -724,4 +724,15 @@ private function createInterfaceAttachment()
 
         $this->logStep('Create interface attachment for server {serverId}', $replacements);
     }
+
+    private function getConsoleOutput()
+    {
+        $replacements = [
+            '{serverId}' => $this->serverId
+        ];
+
+        require_once $this->sampleFile($replacements, 'servers/get_server_console_output.php');
+
+        $this->logStep('Get console output for server {serverId}', $replacements);
+    }
 }

tests/unit/Compute/v2/Fixtures/server-get-console-output.resp

@@ -0,0 +1,6 @@
+HTTP/1.1 200 Accepted
+Content-Type: application/json
+
+{
+    "output": "FAKE CONSOLE OUTPUT\nANOTHER\nLAST LINE"
+}

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

@@ -239,6 +239,22 @@ public function test_it_reverts_resizes()
         $this->assertNull($this->server->revertResize());
     }
 
+    public function test_it_gets_console_output()
+    {
+        $expectedJson = ["os-getConsoleOutput" => ["length" => 3]];
+        $this->setupMock('POST', 'servers/serverId/action', $expectedJson, [], 'server-get-console-output');
+
+        $this->assertEquals("FAKE CONSOLE OUTPUT\nANOTHER\nLAST LINE", $this->server->getConsoleOutput(3));
+    }
+
+    public function test_it_gets_all_console_output()
+    {
+        $expectedJson = ["os-getConsoleOutput" => new \stdClass()];
+        $this->setupMock('POST', 'servers/serverId/action', $expectedJson, [], 'server-get-console-output');
+
+        $this->assertEquals("FAKE CONSOLE OUTPUT\nANOTHER\nLAST LINE", $this->server->getConsoleOutput());
+    }
+
     public function test_it_gets_vnc_console()
     {
         $type = 'novnc';