some unit test for the new ocs share api

apps/files_sharing/appinfo/routes.php

@@ -10,7 +10,7 @@ function() {
 
 OC_API::register('get',
 		'/apps/files_sharing/api/v1/shares',
-		array('\OCA\Files\Share\Api', 'getAllShare'),
+		array('\OCA\Files\Share\Api', 'getAllShares'),
 		'files_sharing');
 
 OC_API::register('post',

apps/files_sharing/lib/api.php

@@ -30,7 +30,7 @@ class Api {
 	 * @param array $params option 'file' to limit the result to a specific file/folder
 	 * @return \OC_OCS_Result share information
 	 */
-	public static function getAllShare($params) {
+	public static function getAllShares($params) {
 
 		// if a file is specified, get the share for this file
 		if (isset($_GET['file'])) {
@@ -59,17 +59,17 @@ class Api {
 		//  getAllShare() or we need to translate the shareID to a itemSource
 		if(isset($params['itemSource'])) {
 			$itemSource = $params['itemSource'];
-			$getAll = true;
+			$getSpecificShare = true;
 		} else {
 			$s = self::getShareFromId($params['id']);
 			$itemSource = $s['item_source'];
-			$getAll = false;
+			$getSpecificShare = false;
 		}
 
 		if ($itemSource !== null) {
 			$shares = \OCP\Share::getItemShared('file', $itemSource);
 			// if a specific share was specified only return this one
-			if ($getAll === false) {
+			if ($getSpecificShare === false) {
 				foreach ($shares as $share) {
 					if ($share['id'] === (int)$params['id']) {
 						$shares = array('element' => $share);
@@ -90,7 +90,7 @@ class Api {
 
 	/**
 	 * @breif create a new share
-	 * @param array $params 'path', 'shareWith', 'shareType'
+	 * @param array $params
 	 * @return \OC_OCS_Result
 	 */
 	public static function createShare($params) {
@@ -380,6 +380,7 @@ class Api {
 	 * @return string fileID or null
 	 */
 	private static function getFileId($path) {
+
 		$view = new \OC\Files\View('/'.\OCP\User::getUser().'/files');
 		$fileId = null;
 

apps/files_sharing/tests/api.php

@@ -0,0 +1,318 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Bjoern Schiessle
+ * @copyright 2013 Bjoern Schiessle <schiessle@owncloud.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+require_once __DIR__ . '/../../../lib/base.php';
+
+use OCA\Files\Share;
+
+/**
+ * Class Test_Encryption_Share
+ */
+class Test_Files_Sharing_Api extends \PHPUnit_Framework_TestCase {
+
+	const TEST_FILES_SHARING_API_USER1 = "test-share-user1";
+	const TEST_FILES_SHARING_API_USER2 = "test-share-user2";
+	const TEST_FILES_SHARING_API_USER3 = "test-share-user3";
+	const TEST_FILES_SHARING_API_USER4 = "test-share-user4";
+	const TEST_FILES_SHARING_API_GROUP1 = "test-share-group1";
+
+	public $filename;
+	public $data;
+	/**
+	 * @var OC_FilesystemView
+	 */
+	public $view;
+	public $folder;
+
+	public static function setUpBeforeClass() {
+		// reset backend
+		\OC_User::clearBackends();
+		\OC_User::useBackend('database');
+
+		// enable resharing
+		\OC_Appconfig::setValue('core', 'shareapi_allow_resharing', 'yes');
+
+		// clear share hooks
+		\OC_Hook::clear('OCP\\Share');
+		\OC::registerShareHooks();
+		\OCP\Util::connectHook('OC_Filesystem', 'setup', '\OC\Files\Storage\Shared', 'setup');
+
+		// create users
+		self::loginHelper(\Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER1, true);
+		self::loginHelper(\Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER2, true);
+
+	}
+
+	function setUp() {
+		$this->data = 'foobar';
+		$this->view = new \OC_FilesystemView('/' . \Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER1 . '/files');
+
+		$this->folder = '/folder';
+
+		$this->filename = 'share-api-test.txt';
+
+		// save file with content
+		$this->view->file_put_contents($this->filename, $this->data);
+		$this->view->mkdir($this->folder);
+		$this->view->file_put_contents($this->folder.'/'.$this->filename, $this->data);
+	}
+
+	function tearDown() {
+		$this->view->unlink($this->filename);
+		$this->view->deleteAll($this->folder);
+	}
+
+	public static function tearDownAfterClass() {
+
+		// cleanup users
+		\OC_User::deleteUser(\Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER1);
+		\OC_User::deleteUser(\Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER2);
+	}
+
+	/**
+	 * @medium
+	 */
+	function testCreateShare() {
+
+		//login as user1
+		\Test_Files_Sharing_Api::loginHelper(\Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER1);
+
+		// share to user
+
+		// simulate a post request
+		$_POST['path'] = $this->filename;
+		$_POST['shareWith'] = \Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER2;
+		$_POST['shareType'] = \OCP\Share::SHARE_TYPE_USER;
+
+		$result = Share\Api::createShare(array());
+
+		$this->assertTrue($result->succeeded());
+		$data = $result->getData();
+
+		$share = $this->getShareFromId($data['id']);
+
+		$items = \OCP\Share::getItemShared('file', $share['item_source']);
+
+		$this->assertTrue(!empty($items));
+
+		// share link
+
+		// simulate a post request
+		$_POST['path'] = $this->folder;
+		$_POST['shareType'] = \OCP\Share::SHARE_TYPE_LINK;
+
+		$result = Share\Api::createShare(array());
+
+		// check if API call was successful
+		$this->assertTrue($result->succeeded());
+
+		$data = $result->getData();
+
+		// check if we have a token
+		$this->assertTrue(is_string($data['token']));
+
+		$share = $this->getShareFromId($data['id']);
+
+		$items = \OCP\Share::getItemShared('file', $share['item_source']);
+
+		$this->assertTrue(!empty($items));
+
+
+
+	}
+
+	/**
+	 * @medium
+	 * @depends testCreateShare
+	 */
+	function testGetAllShares() {
+
+		$result = Share\Api::getAllShares(array());
+
+		$this->assertTrue($result->succeeded());
+
+        // test should return two shares created from testCreateShare()
+		$this->assertTrue(count($result->getData()) === 2);
+	}
+
+	/**
+	 * @medium
+	 * @depends testCreateShare
+	 */
+	function testGetShare() {
+
+		$fileInfo = $this->view->getFileInfo($this->filename);
+
+		$params = array('itemSource' => $fileInfo['fileid']);
+
+		$result = Share\Api::getShare($params);
+
+		$this->assertTrue($result->succeeded());
+
+        // test should return one share created from testCreateShare()
+		$this->assertTrue(count($result->getData()) === 1);
+
+	}
+
+	/**
+	 * @medium
+	 * @depends testCreateShare
+	 */
+	function testUpdateShare() {
+
+		$items = \OCP\Share::getItemShared('file', null);
+
+		$linkShare = null;
+		$userShare = null;
+
+		foreach ($items as $item) {
+			if ($item['share_type'] === \OCP\Share::SHARE_TYPE_LINK) {
+				$linkShare = $item;
+			}
+			if ($item['share_type'] === \OCP\Share::SHARE_TYPE_USER) {
+				$userShare = $item;
+			}
+		}
+
+		// make sure that we found a link share and a user share
+		$this->assertTrue(is_array($linkShare));
+		$this->assertTrue(is_array($userShare));
+
+		// update permissions
+
+		$this->assertEquals($userShare['permissions'], '31');
+
+		$params = array();
+		$params['id'] = $userShare['id'];
+		$params['_put'] = array();
+		$params['_put']['permissions'] = 1;
+
+		$result = Share\Api::updateShare($params);
+
+		$this->assertTrue($result->succeeded());
+
+		$items = \OCP\Share::getItemShared('file', $userShare['file_source']);
+
+		$newUserShare = null;
+		foreach ($items as $item) {
+			if ($item['share_with'] === \Test_Files_Sharing_Api::TEST_FILES_SHARING_API_USER2) {
+				$newUserShare = $item;
+				break;
+			}
+		}
+
+		$this->assertTrue(is_array($newUserShare));
+
+		$this->assertEquals($newUserShare['permissions'], '1');
+
+		// update password for link share
+
+		$this->assertTrue(empty($linkShare['share_with']));
+
+		$params = array();
+		$params['id'] = $linkShare['id'];
+		$params['_put'] = array();
+		$params['_put']['password'] = 'foo';
+
+		$result = Share\Api::updateShare($params);
+
+		$this->assertTrue($result->succeeded());
+
+		$items = \OCP\Share::getItemShared('file', $linkShare['file_source']);
+
+		$newLinkShare = null;
+		foreach ($items as $item) {
+			if ($item['share_type'] === \OCP\Share::SHARE_TYPE_LINK) {
+				$newLinkShare = $item;
+				break;
+			}
+		}
+
+		$this->assertTrue(is_array($newLinkShare));
+		$this->assertTrue(!empty($newLinkShare['share_with']));
+
+	}
+
+	/**
+	 * @medium
+	 * @depends testCreateShare
+	 */
+	function testDeleteShare() {
+		$items = \OCP\Share::getItemShared('file', null);
+
+		foreach ($items as $item) {
+			$result = Share\Api::deleteShare(array('id' => $item['id']));
+
+			$this->assertTrue($result->succeeded());
+		}
+
+		$itemsAfterDelete = \OCP\Share::getItemShared('file', null);
+
+		$this->assertTrue(empty($itemsAfterDelete));
+	}
+
+	/**
+	 * @param $user
+	 * @param bool $create
+	 * @param bool $password
+	 */
+	private static function loginHelper($user, $create = false, $password = false) {
+		if ($create) {
+			\OC_User::createUser($user, $user);
+		}
+
+		if ($password === false) {
+			$password = $user;
+		}
+
+		\OC_Util::tearDownFS();
+		\OC_User::setUserId('');
+		\OC\Files\Filesystem::tearDown();
+		\OC_Util::setupFS($user);
+		\OC_User::setUserId($user);
+
+		$params['uid'] = $user;
+		$params['password'] = $password;
+	}
+
+	/**
+	 * @brief get some information from a given share
+	 * @param int $shareID
+	 * @return array with: item_source, share_type, share_with, item_type, permissions
+	 */
+	private function getShareFromId($shareID) {
+		$sql = 'SELECT `item_source`, `share_type`, `share_with`, `item_type`, `permissions` FROM `*PREFIX*share` WHERE `id` = ?';
+		$args = array($shareID);
+		$query = \OCP\DB::prepare($sql);
+		$result = $query->execute($args);
+
+		$share = Null;
+
+		if ($result && $result->numRows() > 0) {
+				$share = $result->fetchRow();
+		}
+
+		return $share;
+
+	}
+
+}

tests/enable_all.php

@@ -8,6 +8,7 @@
 
 require_once __DIR__.'/../lib/base.php';
 
+OC_App::enable('files_sharing');
 OC_App::enable('files_encryption');
 OC_App::enable('calendar');
 OC_App::enable('contacts');