Merge pull request rackspace#605 from evanlucas/backups

Add ability to interact with backups.

Author: Jamie Hannaford

lib/OpenCloud/Common/Exceptions/BackupInstanceError.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright 2012-2014 Rackspace US, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenCloud\Common\Exceptions;
+
+class BackupInstanceError extends \Exception
+{
+}

lib/OpenCloud/Common/Exceptions/BackupNameError.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright 2012-2014 Rackspace US, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenCloud\Common\Exceptions;
+
+class BackupNameError extends \Exception
+{
+}

lib/OpenCloud/Database/Resource/Backup.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * Copyright 2012-2014 Rackspace US, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenCloud\Database\Resource;
+
+use OpenCloud\Common\Lang;
+use OpenCloud\Common\Exceptions;
+use OpenCloud\Common\Resource\PersistentResource;
+use OpenCloud\Database\Service;
+
+/**
+ * This class represents a Backup
+ */
+class Backup extends PersistentResource
+{
+    public $id;
+    public $name;
+    public $description;
+    public $created;
+    public $datastore;
+    public $updated;
+    public $instance;
+    public $instanceId;
+    public $locationRef;
+
+    protected static $json_name = 'backup';
+    protected static $url_resource = 'backups';
+
+    protected $createKeys = array(
+        'name',
+        'instanceId',
+        'description'
+    );
+
+    protected $associatedResources = array(
+        'instance' => 'Instance'
+    );
+
+    protected $aliases = array(
+        'instance_id' => 'instanceId'
+    );
+
+    public function __construct(Service $service, $info = null)
+    {
+        $this->instance = new \stdClass;
+        return parent::__construct($service, $info);
+    }
+
+    /**
+     * Returns the JSON object for creating the backup
+     */
+    protected function createJson()
+    {
+        if (!isset($this->instanceId)) {
+            throw new Exceptions\BackupInstanceError(
+                Lang::translate('The `instanceId` attribute is required and must be a string')
+            );
+        }
+
+        if (!isset($this->name)) {
+            throw new Exceptions\BackupNameError(
+                Lang::translate('Backup name is required')
+            );
+        }
+
+        $out = [
+            'backup' => [
+                  'name'        => $this->name,
+                  'instance'    => $this->instanceId
+            ]
+        ];
+
+        if (isset($this->description)) {
+            $out['backup']['description'] = $this->description;
+        }
+        return (object) $out;
+    }
+}

lib/OpenCloud/Database/Resource/Instance.php

@@ -39,6 +39,7 @@ class Instance extends NovaResource
     public $created;
     public $updated;
     public $flavor;
+    public $backupRef;
 
     protected static $json_name = 'instance';
     protected static $url_resource = 'instances';
@@ -171,6 +172,49 @@ public function userList()
         return $this->getService()->resourceList('User', $this->getUrl('users'), $this);
     }
 
+    /**
+     * Returns a Collection of all backups for the instance
+     *
+     * @return OpenCloud\Common\Collection\PaginatedIterator
+     */
+    public function backupList()
+    {
+        return $this->getService()->resourceList('Backup', $this->getUrl('backups'), $this);
+    }
+
+    /**
+     * Creates a backup for the given instance
+     *
+     * @api
+     * @param array $params - an associate array of key/value pairs
+     *                      name is required
+     *                      description is optional
+     * @return Backup
+     */
+    public function createBackup($params = array())
+    {
+        if (!isset($params['instanceId'])) {
+            $params['instanceId'] = $this->id;
+        }
+
+        $backup = new Backup($this->getService(), $params);
+        $backup->create($params);
+        return $backup;
+    }
+
+    public function populate($info, $setObjects = true)
+    {
+        parent::populate($info, $setObjects);
+
+        if (is_object($info)) {
+            $info = (array) $info;
+        }
+
+        if (isset($info['restorePoint']['backupRef'])) {
+            $this->backupRef = $info['restorePoint']['backupRef'];
+        }
+    }
+
     /**
      * Generates the JSON string for Create()
      *
@@ -190,13 +234,21 @@ protected function createJson()
             );
         }
 
-        return (object) array(
-            'instance' => (object) array(
+        $out = [
+            'instance' => [
                     'flavorRef' => $this->flavor->links[0]->href,
                     'name'      => $this->name,
                     'volume'    => $this->volume
-                )
-        );
+                ]
+        ];
+
+        if (isset($this->backupRef)) {
+            $out['instance']['restorePoint'] = [
+                'backupRef' => $this->backupRef
+            ];
+        }
+
+        return (object) $out;
     }
 
     /**

lib/OpenCloud/Database/Service.php

@@ -22,6 +22,7 @@
 use OpenCloud\Database\Resource\Instance;
 use OpenCloud\Database\Resource\Configuration;
 use OpenCloud\Database\Resource\Datastore;
+use OpenCloud\Database\Resource\Backup;
 
 /**
  * The Rackspace Database service
@@ -105,4 +106,29 @@ public function datastoreList($params = array())
 
         return $this->resourceList('Datastore', $url);
     }
+
+    /**
+     * Returns a Backup
+     *
+     * @param string $id the ID of the backup to retrieve
+     * @return \OpenCloud\Database\Resource\Backup
+     */
+    public function backup($id = null)
+    {
+        return $this->resource('Backup', $id);
+    }
+
+    /**
+     * Returns a Collection of Backup objects
+     *
+     * @param array $params
+     * @return \OpenCloud\Common\Collection\PaginatedIterator
+     */
+    public function backupList($params = array())
+    {
+        $url = clone $this->getUrl();
+        $url->addPath(Backup::resourceName())->setQuery($params);
+
+        return $this->resourceList('Backup', $url);
+    }
 }

tests/OpenCloud/Tests/Database/DatabaseTestCase.php

@@ -39,6 +39,7 @@ public function setupObjects()
         $this->configuration = $this->service->configuration('005a8bb7-a8df-40ee-b0b7-fc144641abc2');
         $this->datastore = $this->service->datastore('10000000-0000-0000-0000-000000000001');
         $this->datastoreVersion = $this->datastore->version('b00000b0-00b0-0b00-00b0-000b000000bb');
+        $this->backup = $this->service->backup();
     }
 
     protected function assertCriticalMessageWasLogged()

tests/OpenCloud/Tests/Database/Resource/BackupTest.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * Copyright 2012-2014 Rackspace US, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenCloud\Tests\Database\Resource;
+
+use OpenCloud\Tests\Database\DatabaseTestCase;
+
+class BackupTest extends DatabaseTestCase
+{
+    public function test_Class()
+    {
+        $this->assertInstanceOf('OpenCloud\Database\Resource\Backup', $this->backup);
+    }
+
+    public function testDelete()
+    {
+        $this->backup->delete();
+    }
+
+    /**
+     * @expectedException OpenCloud\Common\Exceptions\BackupInstanceError
+     */
+    public function test_Create_Fails_Without_InstanceId()
+    {
+        $this->assertFalse($this->backup->create(array(
+            'name' => 'test',
+            'description' => 'test desc'
+        )));
+    }
+
+    /**
+     * @expectedException OpenCloud\Common\Exceptions\BackupNameError
+     */
+    public function test_Create_Fails_Without_Name()
+    {
+        $this->assertFalse($this->backup->create(array(
+            'description' => 'test description',
+            'instanceId' => '1234'
+        )));
+    }
+
+    public function testCreate()
+    {
+        $this->backup->create(array(
+            'name' => 'test backup',
+            'instanceId' => '1234'
+        ));
+
+        $this->assertEquals('test backup', $this->backup->name);
+        $this->assertEquals('1234', $this->backup->instanceId);
+    }
+}

tests/OpenCloud/Tests/Database/Resource/InstanceTest.php

@@ -31,10 +31,10 @@ public function testUpdateJson()
         $replacementValues = array(
             'configuration' => '005a8bb7-a8df-40ee-b0b7-fc144641abc2'
         );
-        
+
         $method = new \ReflectionMethod('OpenCloud\Database\Resource\Instance', 'updateJson');
         $method->setAccessible(true);
-        
+
         $expected = (object) array(
             'instance' => $replacementValues
         );
@@ -91,4 +91,18 @@ public function testUserList()
     {
         $this->assertInstanceOf(self::COLLECTION_CLASS, $this->instance->userList());
     }
+
+    public function testBackupList()
+    {
+        $this->assertInstanceOf(self::COLLECTION_CLASS, $this->instance->backupList());
+    }
+
+    public function testCreateBackup()
+    {
+        $backup = $this->instance->createBackup(array(
+            'name' => 'test-backup',
+            'description' => 'test'
+        ));
+        $this->assertInstanceOf('OpenCloud\Database\Resource\Backup', $backup);
+    }
 }

tests/OpenCloud/Tests/Database/ServiceTest.php

@@ -73,4 +73,14 @@ public function testDatastoreList()
     {
         $this->assertInstanceOf(self::COLLECTION_CLASS, $this->service->datastoreList());
     }
+
+    public function testBackup()
+    {
+        $this->assertInstanceOf('OpenCloud\Database\Resource\Backup', $this->service->Backup());
+    }
+
+    public function testBackupList()
+    {
+        $this->assertInstanceOf(self::COLLECTION_CLASS, $this->service->backupList());
+    }
 }