]> source.dussan.org Git - nextcloud-server.git/commitdiff
adding unit tests for quota checks
authorThomas Müller <thomas.mueller@tmit.eu>
Thu, 8 Aug 2013 11:33:00 +0000 (13:33 +0200)
committerThomas Müller <thomas.mueller@tmit.eu>
Thu, 8 Aug 2013 11:33:00 +0000 (13:33 +0200)
lib/connector/sabre/quotaplugin.php
tests/lib/connector/sabre/quotaplugin.php

index 730a86666be24dcce58b3b8e5b7ce177dd50132d..eb95a839b867621cfb52e3c8e5f86741febf6a2e 100644 (file)
@@ -3,45 +3,55 @@
 /**
  * This plugin check user quota and deny creating files when they exceeds the quota.
  *
- * @copyright Copyright (C) 2012 entreCables S.L. All rights reserved.
  * @author Sergio Cambra
+ * @copyright Copyright (C) 2012 entreCables S.L. All rights reserved.
  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  */
 class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin {
 
        /**
-               * Reference to main server object
-               *
-               * @var Sabre_DAV_Server
-               */
+        * Reference to main server object
+        *
+        * @var Sabre_DAV_Server
+        */
        private $server;
 
        /**
-               * This initializes the plugin.
-               *
-               * This function is called by Sabre_DAV_Server, after
-               * addPlugin is called.
-               *
-               * This method should set up the requires event subscriptions.
-               *
-               * @param Sabre_DAV_Server $server
-               * @return void
-               */
+        * is kept public to allow overwrite for unit testing
+        *
+        * @var \OC\Files\View
+        */
+       public $fileView;
+
+       /**
+        * This initializes the plugin.
+        *
+        * This function is called by Sabre_DAV_Server, after
+        * addPlugin is called.
+        *
+        * This method should set up the requires event subscriptions.
+        *
+        * @param Sabre_DAV_Server $server
+        * @return void
+        */
        public function initialize(Sabre_DAV_Server $server) {
 
-                       $this->server = $server;
-                       $this->server->subscribeEvent('beforeWriteContent', array($this, 'checkQuota'), 10);
-                       $this->server->subscribeEvent('beforeCreateFile', array($this, 'checkQuota'), 10);
+               $this->server = $server;
 
+               $server->subscribeEvent('beforeWriteContent', array($this, 'checkQuota'), 10);
+               $server->subscribeEvent('beforeCreateFile', array($this, 'checkQuota'), 10);
+
+               // initialize fileView
+               $this->fileView = \OC\Files\Filesystem::getView();
        }
 
        /**
-               * This method is called before any HTTP method and forces users to be authenticated
-               *
-               * @param string $method
-               * @throws Sabre_DAV_Exception
-               * @return bool
-               */
+        * This method is called before any HTTP method and validates there is enough free space to store the file
+        *
+        * @param string $method
+        * @throws Sabre_DAV_Exception
+        * @return bool
+        */
        public function checkQuota($uri, $data = null) {
                $length = $this->getLength();
                if ($length) {
@@ -49,7 +59,7 @@ class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin {
                                $uri='/'.$uri;
                        }
                        list($parentUri, $newName) = Sabre_DAV_URLUtil::splitPath($uri);
-                       $freeSpace = \OC\Files\Filesystem::free_space($parentUri);
+                       $freeSpace = $this->fileView->free_space($parentUri);
                        if ($freeSpace !== \OC\Files\FREE_SPACE_UNKNOWN && $length > $freeSpace) {
                                throw new Sabre_DAV_Exception_InsufficientStorage();
                        }
@@ -59,15 +69,16 @@ class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin {
 
        public function getLength()
        {
-               $expected = $this->server->httpRequest->getHeader('X-Expected-Entity-Length');
-               if ($expected)
-                       return $expected;
-
-               $length = $this->server->httpRequest->getHeader('Content-Length');
-               $ocLength = $this->server->httpRequest->getHeader('OC-Total-Length');
+               $req = $this->server->httpRequest;
+               $length = $req->getHeader('X-Expected-Entity-Length');
+               if (!$length) {
+                       $length = $req->getHeader('Content-Length');
+               }
 
-               if ($length && $ocLength)
+               $ocLength = $req->getHeader('OC-Total-Length');
+               if ($length && $ocLength) {
                        return max($length, $ocLength);
+               }
 
                return $length;
        }
index 9582af6ec4e2ce1b43bbef8d1395e3967fe05893..1186de28742bdf76c502344b416ce44b915c5841 100644 (file)
@@ -34,14 +34,68 @@ class Test_OC_Connector_Sabre_QuotaPlugin extends PHPUnit_Framework_TestCase {
                $this->assertEquals($expected, $length);
        }
 
-       public function lengthProvider()
+       /**
+        * @dataProvider quotaOkayProvider
+        */
+       public function testCheckQuota($quota, $headers)
        {
+               $this->plugin->fileView = $this->buildFileViewMock($quota);
+
+               $this->server->httpRequest = new Sabre_HTTP_Request($headers);
+               $result = $this->plugin->checkQuota('');
+               $this->assertTrue($result);
+       }
+
+       /**
+        * @expectedException Sabre_DAV_Exception_InsufficientStorage
+        * @dataProvider quotaExceededProvider
+        */
+       public function testCheckExceededQuota($quota, $headers)
+       {
+               $this->plugin->fileView = $this->buildFileViewMock($quota);
+
+               $this->server->httpRequest = new Sabre_HTTP_Request($headers);
+               $this->plugin->checkQuota('');
+       }
+
+       public function quotaOkayProvider() {
+               return array(
+                       array(1024, array()),
+                       array(1024, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
+                       array(1024, array('HTTP_CONTENT_LENGTH' => '512')),
+                       array(1024, array('HTTP_OC_TOTAL_LENGTH' => '1024', 'HTTP_CONTENT_LENGTH' => '512')),
+                       // OC\Files\FREE_SPACE_UNKNOWN = -2
+                       array(-2, array()),
+                       array(-2, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
+                       array(-2, array('HTTP_CONTENT_LENGTH' => '512')),
+                       array(-2, array('HTTP_OC_TOTAL_LENGTH' => '1024', 'HTTP_CONTENT_LENGTH' => '512')),
+               );
+       }
+
+       public function quotaExceededProvider() {
+               return array(
+                       array(1023, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
+                       array(511, array('HTTP_CONTENT_LENGTH' => '512')),
+                       array(2047, array('HTTP_OC_TOTAL_LENGTH' => '2048', 'HTTP_CONTENT_LENGTH' => '1024')),
+               );
+       }
+
+       public function lengthProvider() {
                return array(
                        array(null, array()),
                        array(1024, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
                        array(512, array('HTTP_CONTENT_LENGTH' => '512')),
                        array(2048, array('HTTP_OC_TOTAL_LENGTH' => '2048', 'HTTP_CONTENT_LENGTH' => '1024')),
+                       array(4096, array('HTTP_OC_TOTAL_LENGTH' => '2048', 'HTTP_X_EXPECTED_ENTITY_LENGTH' => '4096')),
                );
        }
 
+       private function buildFileViewMock($quota) {
+               // mock filesysten
+               $view = $this->getMock('\OC\Files\View', array('free_space'), array(), '', FALSE);
+               $view->expects($this->any())->method('free_space')->withAnyParameters()->will($this->returnValue($quota));
+
+               return $view;
+       }
+
 }