ENH: refs #236. Add a test for uploading via the web API using upload token

Author: zachmullen

core/tests/databaseDataset/default.xml

@@ -8,7 +8,7 @@
 		parent_id="-1"/>
 	<folder folder_id="3" name="name Folder 3" description="Description Folder 3"  left_indice="5" right_indice="6" uuid='4e311fdf82007c245b07d8d6c4fcb4205f2621eb72802'
 		parent_id="-1"/>
-		
+
 	<folder folder_id="1000" name="User 1 name Folder 1"  uuid='4e311fdf82007c245b07d8d6c4fcb4205f2621eb72760'
 		description="Description Folder 1" left_indice="1000" right_indice="1005"
 		parent_id="-1" />
@@ -30,13 +30,13 @@
 	<folder folder_id="1005" name="Community test User 1 name Folder 3" uuid='4e311fdf82007c245b07d8d6c4fcb4205f2621eb72765'
 		description="Description Folder 3" left_indice="1009" right_indice="1010"
 		parent_id="1003" />
-		
-		
+
+
 	<community community_id="2000" name="Community test User 1"
 		description="Community test User 1" creation="2011-01-27 12:09:02"
 		privacy="0" folder_id="1003" publicfolder_id="1004" privatefolder_id="1005"
 		admingroup_id="3000" moderatorgroup_id="3001" membergroup_id="3002" />
-		
+
 
 	<group group_id="3000" community_id="2000" name="Community test User 1 Admin" />
 	<group group_id="3001" community_id="2000"
@@ -66,24 +66,25 @@
 	<item2folder item_id="2" folder_id='1001' />
 	<item item_id="3" name="name 3" description="Description 3" type="3" uuid='4e311fdf82007c245b07d8d6c4fcb4205f2621eb72752' />
 
-
+	<bitstream bitstream_id="1" itemrevision_id="3" name="foo.png" mimetype="image/png" sizebytes="64" checksum="f283bc88b24491ba85c65ba960642753"
+		path="f2/83/f283bc88b24491ba85c65ba960642753" assetstore_id="1" date="2011-01-27 12:09:02" />
 
 	<!-- MIDAS_FEED_CREATE_COMMUNITY -->
 	<feed feed_id="1" date="2011-01-27 12:09:02" user_id='1' type="0"
 		ressource="2000" />
 	<feedpolicygroup feed_id="1" group_id="0" policy='0'  />
-		
+
 	<!-- MIDAS_FEED_DELETE_COMMUNITY -->
 	<feed feed_id="2" date="2011-01-27 12:09:02" user_id='1' type="1"
 		ressource="CommunityName" />
 	<feedpolicygroup feed_id="2" group_id="3000" policy='1'  />
-	
+
 	<!-- MIDAS_FEED_UPDATE_COMMUNITY -->
 	<feed feed_id="3" date="2011-01-27 12:09:02" user_id='1' type="2"
 		ressource="2000" />
 	<feedpolicyuser feed_id="3" user_id="1" policy='2'  />
 	<feed2community feed_id="2" community_id="2000" />
-	
+
 	<!-- MIDAS_FEED_CREATE_USER -->
 	<feed feed_id="4" date="2011-01-27 12:09:02" user_id='1' type="10"
 		ressource="1" />
@@ -106,4 +107,3 @@
 	<feed feed_id="10" date="2011-01-27 12:09:02" user_id='1' type="40"
 		ressource="1" />
 </dataset>
-

modules/api/controllers/components/ApiComponent.php

@@ -189,6 +189,7 @@ function resourceSearch($args)
 
   /**
    * Generate a unique upload token
+   * @param token Authentication token
    * @param itemid The id of the parent item to upload into
    * @param filename The filename of the bitstream you will upload
    * @return An upload token that can be used to upload a file
@@ -245,7 +246,6 @@ function uploadPerform($args)
       }
 
     list($userid, $resourceid, ) = explode('/', $args['uploadtoken']);
-    //TODO check if this upload token is valid
 
     $modelLoader = new MIDAS_ModelLoader();
     $itemModel = $modelLoader->loadModel('Item');
@@ -333,6 +333,12 @@ function uploadPerform($args)
     $mode = array_key_exists('mode', $args) ? $args['mode'] : 'stream';
     $uploadApi = new KwUploadAPI($this->apiSetup);
 
+    if(array_key_exists('testingmode', $args))
+      {
+      $uploadApi->testing_enable = true;
+      $args['localinput'] = $this->apiSetup['tmp_directory'].'/'.$args['filename'];
+      }
+
     // Use KWUploadApi to handle the actual file upload
     if($mode == 'stream')
       {

modules/api/tests/controllers/ApiCallMethodsTest.php

@@ -19,7 +19,7 @@ public function setUp()
     $this->setupDatabase(array('default')); //core dataset
     $this->setupDatabase(array('default'), 'api'); // module dataset
     $this->enabledModules = array('api');
-    $this->_models = array('User', 'Folder', 'Item');
+    $this->_models = array('User', 'Folder', 'Item', 'ItemRevision');
     $this->_daos = array('User', 'Folder', 'Item');
 
     parent::setUp();
@@ -251,4 +251,88 @@ public function testSessionAuthentication()
     $this->assertEquals($resp->data[0]->name, 'User 1 name Folder 2');
     $this->assertEquals($resp->data[1]->name, 'User 1 name Folder 3');
     }
+
+  /** Test file upload */
+  public function testUpload()
+    {
+    $this->resetAll();
+    $usersFile = $this->loadData('User', 'default');
+    $itemsFile = $this->loadData('Item', 'default');
+
+    $this->params['token'] = $this->_loginUsingApiKey();
+    $this->params['method'] = 'midas.upload.generatetoken';
+    $this->params['filename'] = 'test.txt';
+    // call should fail for the first item since we don't have write permission
+    $this->params['itemid'] = $itemsFile[0]->getKey();
+    $this->request->setMethod('POST');
+    $resp = $this->_callJsonApi();
+    $this->assertEquals($resp->stat, 'fail');
+    $this->assertEquals($resp->message, 'Invalid policy or itemid');
+    $this->assertTrue($resp->code != 0);
+
+    $this->resetAll();
+    $usersFile = $this->loadData('User', 'default');
+    $itemsFile = $this->loadData('Item', 'default');
+
+    $this->params['token'] = $this->_loginUsingApiKey();
+    $this->params['method'] = 'midas.upload.generatetoken';
+    $this->params['filename'] = 'test.txt';
+    // use the second item since it has write permission set for our user
+    $this->params['itemid'] = $itemsFile[1]->getKey();
+    $this->request->setMethod('POST');
+    $resp = $this->_callJsonApi();
+
+    $this->_assertStatusOk($resp);
+    $token = $resp->data->token;
+    $this->assertTrue(
+      preg_match('/^'.$usersFile[0]->getKey().'\/'.$itemsFile[1]->getKey().'\/.+\.tmp$/', $token) > 0,
+      'Upload token is not of the form <userid>/<itemid>/*.tmp');
+    $this->assertTrue(file_exists(BASE_PATH.'/tmp/misc/'.$token),
+      "Token placeholder file $token was not created in the temp dir");
+
+    //now upload using our token
+    $this->resetAll();
+
+    $string = '';
+    $length = 100;
+    for($i = 0; $i < $length; $i++)
+      {
+      $string .= 'a';
+      }
+    $fh = fopen(BASE_PATH.'/tmp/misc/test.txt', 'w');
+    fwrite($fh, $string);
+    fclose($fh);
+    $md5 = md5($string);
+    $assetstoreFile = BASE_PATH.'/data/assetstore/'.substr($md5, 0, 2).'/'.substr($md5, 2, 2).'/'.$md5;
+    unlink($assetstoreFile);
+
+    $this->params['method'] = 'midas.upload.perform';
+    $this->params['uploadtoken'] = $token;
+    $this->params['filename'] = 'test.txt';
+    $this->params['length'] = $length;
+    $this->params['itemid'] = $itemsFile[1]->getKey();
+    $this->params['revision'] = 'head'; //upload into head revision
+    $this->params['testingmode'] = 'true';
+
+    $this->request->setMethod('POST');
+    $resp = $this->_callJsonApi();
+
+    unlink(BASE_PATH.'/tmp/misc/test.txt');
+
+    $this->_assertStatusOk($resp);
+    
+    $this->assertTrue(file_exists($assetstoreFile), 'File was not written to the assetstore');
+    $this->assertEquals(filesize($assetstoreFile), $length, 'Assetstore file is the wrong length: '.filesize($assetstoreFile));
+    $this->assertEquals(md5_file($assetstoreFile), $md5, 'Assetstore file had incorrect checksum');
+
+    // make sure it was uploaded to the head revision of the item
+    $itemDao = $this->Item->load($itemsFile[1]->getKey());
+    $revisions = $itemDao->getRevisions();
+    $this->assertEquals(count($revisions), 1, 'Too many revisions in the item');
+    $bitstreams = $revisions[0]->getBitstreams();
+    $this->assertEquals(count($bitstreams), 1, 'Too many bitstreams in the revision');
+    $this->assertEquals($bitstreams[0]->name, 'test.txt');
+    $this->assertEquals($bitstreams[0]->sizebytes, $length);
+    $this->assertEquals($bitstreams[0]->checksum, $md5);
+    }
   }