Initial commit of a swiftfs stream wrapper. This is not yet complete. The swift stream wrapper implements the features present in the api. This does not include all the features needed (e.g., directory management) if you want to 'mount' swift as a filesystem for existing applications written expecing a file system. The stream wrapper attempts to work in this case as a drop in.
This commit is contained in:
Matt Farina
@@ -149,7 +149,7 @@ class Bootstrap {
|
||||
/**
|
||||
* Register stream wrappers for HPCloud.
|
||||
*
|
||||
* This register the ObjectStorage stream wrapper, which allows you to access
|
||||
* This register the ObjectStorage stream wrappers, which allow you to access
|
||||
* ObjectStorage through standard file access mechanisms.
|
||||
*
|
||||
* @code
|
||||
@@ -169,10 +169,17 @@ class Bootstrap {
|
||||
* @endcode
|
||||
*/
|
||||
public static function useStreamWrappers() {
|
||||
return stream_wrapper_register(
|
||||
$swift = stream_wrapper_register(
|
||||
\HPCloud\Storage\ObjectStorage\StreamWrapper::DEFAULT_SCHEME,
|
||||
'\HPCloud\Storage\ObjectStorage\StreamWrapper'
|
||||
);
|
||||
|
||||
$swiftfs = stream_wrapper_register(
|
||||
\HPCloud\Storage\ObjectStorage\StreamWrapperFS::DEFAULT_SCHEME,
|
||||
'\HPCloud\Storage\ObjectStorage\StreamWrapperFS'
|
||||
);
|
||||
|
||||
return ($swift && $swiftfs);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
350
src/HPCloud/Storage/ObjectStorage/StreamWrapperFS.php
Normal file
350
src/HPCloud/Storage/ObjectStorage/StreamWrapperFS.php
Normal file
@@ -0,0 +1,350 @@
|
||||
<?php
|
||||
/* ============================================================================
|
||||
(c) Copyright 2012 Hewlett-Packard Development Company, L.P.
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge,publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
============================================================================ */
|
||||
/**
|
||||
* @file
|
||||
* Contains the stream wrapper for `swiftfs://` URLs.
|
||||
*
|
||||
* The stream wrapper implemented in HPCloud\Storage\ObjectStorage\StreamWrapper
|
||||
* only supports the elements of a stream
|
||||
*/
|
||||
|
||||
namespace HPCloud\Storage\ObjectStorage;
|
||||
|
||||
use \HPCloud\Bootstrap;
|
||||
use \HPCloud\Storage\ObjectStorage;
|
||||
|
||||
/**
|
||||
* Provides stream wrapping for Swift like a file system.
|
||||
*
|
||||
* This provides a full stream wrapper to expose `swiftfs://` URLs to the
|
||||
* PHP stream system.
|
||||
*
|
||||
*
|
||||
* @see http://us3.php.net/manual/en/class.streamwrapper.php
|
||||
*/
|
||||
class StreamWrapperFS extends StreamWrapper {
|
||||
|
||||
const DEFAULT_SCHEME = 'swiftfs';
|
||||
|
||||
/**
|
||||
* Cache of auth token -> service catalog.
|
||||
*
|
||||
* This will eventually be replaced by a better system, but for a system of
|
||||
* moderate complexity, many, many file operations may be run during the
|
||||
* course of a request. Caching the catalog can prevent numerous calls
|
||||
* to identity services.
|
||||
*/
|
||||
protected static $serviceCatalogCache = array();
|
||||
|
||||
/**
|
||||
* The stream context.
|
||||
*
|
||||
* This is set automatically when the stream wrapper is created by
|
||||
* PHP. Note that it is not set through a constructor.
|
||||
*/
|
||||
public $context;
|
||||
protected $contextArray = array();
|
||||
|
||||
protected $schemeName = self::DEFAULT_SCHEME;
|
||||
protected $authToken;
|
||||
|
||||
|
||||
// File flags. These should probably be replaced by O_ const's at some point.
|
||||
protected $isBinary = FALSE;
|
||||
protected $isText = TRUE;
|
||||
protected $isWriting = FALSE;
|
||||
protected $isReading = FALSE;
|
||||
protected $isTruncating = FALSE;
|
||||
protected $isAppending = FALSE;
|
||||
protected $noOverwrite = FALSE;
|
||||
protected $createIfNotFound = TRUE;
|
||||
|
||||
/**
|
||||
* If this is TRUE, no data is ever sent to the remote server.
|
||||
*/
|
||||
protected $isNeverDirty = FALSE;
|
||||
|
||||
protected $triggerErrors = FALSE;
|
||||
|
||||
/**
|
||||
* Indicate whether the local differs from remote.
|
||||
*
|
||||
* When the file is modified in such a way that
|
||||
* it needs to be written remotely, the isDirty flag
|
||||
* is set to TRUE.
|
||||
*/
|
||||
protected $isDirty = FALSE;
|
||||
|
||||
/**
|
||||
* Object storage instance.
|
||||
*/
|
||||
protected $store;
|
||||
|
||||
/**
|
||||
* The Container.
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* The Object.
|
||||
*/
|
||||
protected $obj;
|
||||
|
||||
/**
|
||||
* The IO stream for the Object.
|
||||
*/
|
||||
protected $objStream;
|
||||
|
||||
/**
|
||||
* Directory listing.
|
||||
*
|
||||
* Used for directory methods.
|
||||
*/
|
||||
protected $dirListing = array();
|
||||
protected $dirIndex = 0;
|
||||
protected $dirPrefix = '';
|
||||
|
||||
|
||||
/**
|
||||
* Open a directory for reading.
|
||||
*
|
||||
* @code
|
||||
* <?php
|
||||
*
|
||||
* // Assuming a valid context in $cxt...
|
||||
*
|
||||
* // Get the container as if it were a directory.
|
||||
* $dir = opendir('swift://mycontainer', $cxt);
|
||||
*
|
||||
* // Do something with $dir
|
||||
*
|
||||
* closedir($dir);
|
||||
* ?>
|
||||
* @endcode
|
||||
*
|
||||
* See opendir() and scandir().
|
||||
*
|
||||
* @param string $path
|
||||
* The URL to open.
|
||||
* @param int $options
|
||||
* Unused.
|
||||
* @retval boolean
|
||||
* TRUE if the directory is opened, FALSE otherwise.
|
||||
*/
|
||||
public function dir_opendir($path, $options) {
|
||||
$url = $this->parseUrl($path);
|
||||
|
||||
if (empty($url['host'])) {
|
||||
trigger_error('Container name is required.' , E_USER_WARNING);
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
try {
|
||||
$this->initializeObjectStorage();
|
||||
$container = $this->store->container($url['host']);
|
||||
|
||||
if (empty($url['path'])) {
|
||||
$this->dirPrefix = '';
|
||||
}
|
||||
else {
|
||||
$this->dirPrefix = $url['path'];
|
||||
}
|
||||
|
||||
$sep = '/';
|
||||
|
||||
|
||||
$this->dirListing = $container->objectsWithPrefix($this->dirPrefix, $sep);
|
||||
}
|
||||
catch (\HPCloud\Exception $e) {
|
||||
trigger_error('Directory could not be opened: ' . $e->getMessage(), E_USER_WARNING);
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fake a make a dir.
|
||||
*
|
||||
* ObjectStorage has pathy objects, but not directories.
|
||||
*/
|
||||
public function mkdir($uri, $mode, $options) {
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/*
|
||||
public function rmdir($path, $options) {
|
||||
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* Perform stat()/lstat() operations.
|
||||
*
|
||||
* @code
|
||||
* <?php
|
||||
* $file = fopen('swift://foo/bar', 'r+', FALSE, $cxt);
|
||||
* $stats = fstat($file);
|
||||
* ?>
|
||||
* @endcode
|
||||
*
|
||||
* To use standard \c stat() on a Swift stream, you will
|
||||
* need to set account information (tenant ID, account ID, secret,
|
||||
* etc.) through HPCloud::Bootstrap::setConfiguration().
|
||||
*
|
||||
* @retval array
|
||||
* The stats array.
|
||||
*/
|
||||
public function stream_stat() {
|
||||
$stat = fstat($this->objStream);
|
||||
|
||||
// FIXME: Need to calculate the length of the $objStream.
|
||||
//$contentLength = $this->obj->contentLength();
|
||||
$contentLength = $stat['size'];
|
||||
|
||||
return $this->generateStat($this->obj, $this->container, $contentLength);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see stream_stat().
|
||||
*/
|
||||
public function url_stat($path, $flags) {
|
||||
$url = $this->parseUrl($path);
|
||||
|
||||
if (empty($url['host']) || empty($url['path'])) {
|
||||
if ($flags & STREAM_URL_STAT_QUIET) {
|
||||
trigger_error('Container name (host) and path are required.', E_USER_WARNING);
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
try {
|
||||
$this->initializeObjectStorage();
|
||||
|
||||
// Since we are throwing the $container away without really using its
|
||||
// internals, we create an unchecked container. It may not actually
|
||||
// exist on the server, which will cause a 404 error.
|
||||
//$container = $this->store->container($url['host']);
|
||||
$name = $url['host'];
|
||||
$token = $this->store->token();
|
||||
$endpoint_url = $this->store->url() . '/' . rawurlencode($name);
|
||||
$container = new \HPCloud\Storage\ObjectStorage\Container($name, $endpoint_url, $token);
|
||||
$obj = $container->remoteObject($url['path']);
|
||||
}
|
||||
catch(\HPCloud\Exception $e) {
|
||||
// Apparently file_exists does not set STREAM_URL_STAT_QUIET.
|
||||
//if ($flags & STREAM_URL_STAT_QUIET) {
|
||||
//trigger_error('Could not stat remote file: ' . $e->getMessage(), E_USER_WARNING);
|
||||
//}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
if ($flags & STREAM_URL_STAT_QUIET) {
|
||||
try {
|
||||
return @$this->generateStat($obj, $container, $obj->contentLength());
|
||||
}
|
||||
catch (\HPCloud\Exception $e) {
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
return $this->generateStat($obj, $container, $obj->contentLength());
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a reasonably accurate STAT array.
|
||||
*
|
||||
* Notes on mode:
|
||||
* - All modes are of the (octal) form 100XXX, where
|
||||
* XXX is replaced by the permission string. Thus,
|
||||
* this always reports that the type is "file" (100).
|
||||
* - Currently, only two permission sets are generated:
|
||||
* - 770: Represents the ACL::makePrivate() perm.
|
||||
* - 775: Represents the ACL::makePublic() perm.
|
||||
*
|
||||
* Notes on mtime/atime/ctime:
|
||||
* - For whatever reason, Swift only stores one timestamp.
|
||||
* We use that for mtime, atime, and ctime.
|
||||
*
|
||||
* Notes on size:
|
||||
* - Size must be calculated externally, as it will sometimes
|
||||
* be the remote's Content-Length, and it will sometimes be
|
||||
* the cached stat['size'] for the underlying buffer.
|
||||
*/
|
||||
protected function generateStat($object, $container, $size) {
|
||||
// This is not entirely accurate. Basically, if the
|
||||
// file is marked public, it gets 100775, and if
|
||||
// it is private, it gets 100770.
|
||||
//
|
||||
// Mode is always set to file (100XXX) because there
|
||||
// is no alternative that is more sensible. PHP docs
|
||||
// do not recommend an alternative.
|
||||
//
|
||||
// octdec(100770) == 33272
|
||||
// octdec(100775) == 33277
|
||||
$mode = $container->acl()->isPublic() ? 33277 : 33272;
|
||||
|
||||
// We have to fake the UID value in order for is_readible()/is_writable()
|
||||
// to work. Note that on Windows systems, stat does not look for a UID.
|
||||
if (function_exists('posix_geteuid')) {
|
||||
$uid = posix_geteuid();
|
||||
$gid = posix_getegid();
|
||||
}
|
||||
else {
|
||||
$uid = 0;
|
||||
$gid = 0;
|
||||
}
|
||||
|
||||
if ($object instanceof \HPCloud\Storage\ObjectStorage\RemoteObject) {
|
||||
$modTime = $object->lastModified();
|
||||
}
|
||||
else {
|
||||
$modTime = 0;
|
||||
}
|
||||
$values = array(
|
||||
'dev' => 0,
|
||||
'ino' => 0,
|
||||
'mode' => $mode,
|
||||
'nlink' => 0,
|
||||
'uid' => $uid,
|
||||
'gid' => $gid,
|
||||
'rdev' => 0,
|
||||
'size' => $size,
|
||||
'atime' => $modTime,
|
||||
'mtime' => $modTime,
|
||||
'ctime' => $modTime,
|
||||
'blksize' => -1,
|
||||
'blocks' => -1,
|
||||
);
|
||||
|
||||
$final = array_values($values) + $values;
|
||||
|
||||
return $final;
|
||||
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////////////
|
||||
// INTERNAL METHODS
|
||||
// All methods beneath this line are not part of the Stream API.
|
||||
///////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
}
|
||||
606
test/Tests/StreamWrapperFSTest.php
Normal file
606
test/Tests/StreamWrapperFSTest.php
Normal file
@@ -0,0 +1,606 @@
|
||||
<?php
|
||||
/* ============================================================================
|
||||
(c) Copyright 2012 Hewlett-Packard Development Company, L.P.
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge,publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
============================================================================ */
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* Unit tests for the stream wrapper file systema.
|
||||
*/
|
||||
namespace HPCloud\Tests\Storage\ObjectStorage;
|
||||
|
||||
require_once 'src/HPCloud/Bootstrap.php';
|
||||
require_once 'test/TestCase.php';
|
||||
|
||||
use \HPCloud\Storage\ObjectStorage\StreamWrapperFS;
|
||||
use \HPCloud\Storage\ObjectStorage\Container;
|
||||
use \HPCloud\Storage\ObjectStorage\Object;
|
||||
use \HPCloud\Storage\ObjectStorage\ACL;
|
||||
|
||||
class StreamWrapperFSTest extends \HPCloud\Tests\TestCase {
|
||||
|
||||
const FNAME = 'streamTest.txt';
|
||||
const FTYPE = 'application/x-tuna-fish; charset=iso-8859-13';
|
||||
|
||||
protected function newUrl($objectName) {
|
||||
$scheme = StreamWrapperFS::DEFAULT_SCHEME;
|
||||
$cname = self::$settings['hpcloud.swift.container'];
|
||||
$cname = urlencode($cname);
|
||||
|
||||
$objectParts = explode('/', $objectName);
|
||||
for ($i = 0; $i < count($objectParts); ++$i) {
|
||||
$objectParts[$i] = urlencode($objectParts[$i]);
|
||||
}
|
||||
$objectName = implode('/', $objectParts);
|
||||
|
||||
$url = $scheme . '://' . $cname . '/' . $objectName;
|
||||
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* This assumes auth has already been done.
|
||||
*/
|
||||
protected function basicSwiftContext($add = array(), $scheme = NULL) {
|
||||
$cname = self::$settings['hpcloud.swift.container'];
|
||||
|
||||
if (empty($scheme)) {
|
||||
$scheme = StreamWrapperFS::DEFAULT_SCHEME;
|
||||
}
|
||||
|
||||
if (empty(self::$ostore)) {
|
||||
throw new \Exception('OStore is gone.');
|
||||
}
|
||||
|
||||
$params = $add + array(
|
||||
'token' => $this->objectStore()->token(),
|
||||
'swift_endpoint' => $this->objectStore()->url(),
|
||||
'content_type' => self::FTYPE,
|
||||
);
|
||||
$cxt = array($scheme => $params);
|
||||
|
||||
return stream_context_create($cxt);
|
||||
}
|
||||
|
||||
/**
|
||||
* This performs authentication via context.
|
||||
*
|
||||
* UPDATE: This now users IdentityServices instead of deprecated
|
||||
* swauth.
|
||||
*/
|
||||
protected function authSwiftContext($add = array(), $scheme = NULL) {
|
||||
$cname = self::$settings['hpcloud.swift.container'];
|
||||
$account = self::$settings['hpcloud.identity.account'];
|
||||
$key = self::$settings['hpcloud.identity.secret'];
|
||||
$tenant = self::$settings['hpcloud.identity.tenantId'];
|
||||
$baseURL = self::$settings['hpcloud.identity.url'];
|
||||
|
||||
if (empty($scheme)) {
|
||||
$scheme = StreamWrapperFS::DEFAULT_SCHEME;
|
||||
}
|
||||
|
||||
$params = $add + array(
|
||||
'account' => $account,
|
||||
'key' => $key,
|
||||
'endpoint' => $baseURL,
|
||||
'tenantid' => $tenant,
|
||||
'content_type' => self::FTYPE,
|
||||
);
|
||||
$cxt = array($scheme => $params);
|
||||
|
||||
return stream_context_create($cxt);
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Add additional params to the config.
|
||||
*
|
||||
* This allows us to insert credentials into the
|
||||
* bootstrap config, which in turn allows us to run
|
||||
* high-level context-less functions like
|
||||
* file_get_contents(), stat(), and is_file().
|
||||
*/
|
||||
protected function addBootstrapConfig() {
|
||||
$opts = array(
|
||||
'account' => self::$settings['hpcloud.identity.account'],
|
||||
'key' => self::$settings['hpcloud.identity.secret'],
|
||||
'endpoint' => self::$settings['hpcloud.identity.url'],
|
||||
'tenantit' => self::$settings['hpcloud.identity.tenantId'],
|
||||
'token' => $this->objectStore()->token(),
|
||||
'swift_endpoint' => $this->objectStore()->url(),
|
||||
);
|
||||
\HPCloud\Bootstrap::setConfiguration($opts);
|
||||
|
||||
}
|
||||
|
||||
// Canary. There are UTF-8 encoding issues in stream wrappers.
|
||||
public function testStreamContext() {
|
||||
$cxt = $this->authSwiftContext();
|
||||
$array = stream_context_get_options($cxt);
|
||||
|
||||
$opts = $array['swiftfs'];
|
||||
$endpoint = self::conf('hpcloud.identity.url');
|
||||
|
||||
$this->assertEquals($endpoint, $opts['endpoint'], 'A UTF-8 encoding issue.');
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testStreamContext
|
||||
*/
|
||||
public function testRegister() {
|
||||
// Canary
|
||||
$this->assertNotEmpty(StreamWrapperFS::DEFAULT_SCHEME);
|
||||
|
||||
$klass = '\HPCloud\Storage\ObjectStorage\StreamWrapperFS';
|
||||
stream_wrapper_register(StreamWrapperFS::DEFAULT_SCHEME, $klass);
|
||||
|
||||
$wrappers = stream_get_wrappers();
|
||||
|
||||
$this->assertContains(StreamWrapperFS::DEFAULT_SCHEME, $wrappers);
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testRegister
|
||||
*/
|
||||
public function testOpenFailureWithoutContext() {
|
||||
$url = $this->newUrl('foo→/bar.txt');
|
||||
$ret = @fopen($url, 'r');
|
||||
|
||||
$this->assertFalse($ret);
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testRegister
|
||||
*/
|
||||
public function testOpen() {
|
||||
$cname = self::$settings['hpcloud.swift.container'];
|
||||
|
||||
// Create a fresh container.
|
||||
$this->eradicateContainer($cname);
|
||||
$this->containerFixture();
|
||||
|
||||
// Simple write test.
|
||||
$oUrl = $this->newUrl('foo→/test.csv');
|
||||
|
||||
$res = fopen($oUrl, 'nope', FALSE, $this->authSwiftContext());
|
||||
|
||||
$this->assertTrue(is_resource($res));
|
||||
|
||||
fclose($res);
|
||||
|
||||
// Now we test the same, but re-using the auth token:
|
||||
$cxt = $this->basicSwiftContext();
|
||||
$res = fopen($oUrl, 'nope', FALSE, $cxt);
|
||||
|
||||
$this->assertTrue(is_resource($res));
|
||||
|
||||
fclose($res);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testOpen
|
||||
*/
|
||||
public function testOpenWithCDN() {
|
||||
// Unfortunately we cannot test with CDN directly, because CDN requires ten
|
||||
// minutes to an our to configure itself. Use the `php test/CDNTest.php` program
|
||||
// to directly test CDN on an already-prepared container.
|
||||
|
||||
$this->containerFixture();
|
||||
|
||||
// Simple write test.
|
||||
$oUrl = $this->newUrl('foo→/test.csv');
|
||||
|
||||
// Now we test the same, but re-using the auth token:
|
||||
$cxt = $this->authSwiftContext(array('use_cdn' => TRUE));
|
||||
$res = fopen($oUrl, 'nope', FALSE, $cxt);
|
||||
|
||||
$this->assertTrue(is_resource($res));
|
||||
|
||||
// For this to work, we need to re-use auth tokens.
|
||||
$md = stream_get_meta_data($res);
|
||||
$wrapper = $md['wrapper_data'];
|
||||
|
||||
fclose($res);
|
||||
|
||||
// Test with auth token.
|
||||
$cxt = $this->basicSwiftContext(array('token' => $wrapper->token(), 'use_cdn' => TRUE));
|
||||
$res = fopen($oUrl, 'nope', FALSE, $cxt);
|
||||
$this->assertTrue(is_resource($res));
|
||||
fclose($res);
|
||||
|
||||
// Test with CDN object
|
||||
$cdn = \HPCloud\Storage\CDN::newFromServiceCatalog($wrapper->serviceCatalog(), $wrapper->token());
|
||||
$cxt = $this->basicSwiftContext(array('use_cdn' => $cdn));
|
||||
$res = fopen($oUrl, 'nope', FALSE, $cxt);
|
||||
$this->assertTrue(is_resource($res));
|
||||
fclose($res);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testOpen
|
||||
*/
|
||||
public function testOpenFailureWithRead() {
|
||||
$url = $this->newUrl(__FUNCTION__);
|
||||
$res = @fopen($url, 'r', FALSE, $this->basicSwiftContext());
|
||||
|
||||
$this->assertFalse($res);
|
||||
|
||||
}
|
||||
|
||||
// DO we need to test other modes?
|
||||
|
||||
/**
|
||||
* @depends testOpen
|
||||
*/
|
||||
public function testOpenCreateMode() {
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$res = fopen($url, 'c+', FALSE, $this->basicSwiftContext());
|
||||
$this->assertTrue(is_resource($res));
|
||||
//fclose($res);
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testOpenCreateMode
|
||||
*/
|
||||
public function testTell($res) {
|
||||
// Sould be at the beginning of the buffer.
|
||||
$this->assertEquals(0, ftell($res));
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testTell
|
||||
*/
|
||||
public function testWrite($res) {
|
||||
$str = 'To be is to be the value of a bound variable. -- Quine';
|
||||
fwrite($res, $str);
|
||||
$this->assertGreaterThan(0, ftell($res));
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testWrite
|
||||
*/
|
||||
public function testStat($res) {
|
||||
$stat = fstat($res);
|
||||
|
||||
$this->assertGreaterThan(0, $stat['size']);
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testStat
|
||||
*/
|
||||
public function testSeek($res) {
|
||||
$then = ftell($res);
|
||||
rewind($res);
|
||||
|
||||
$now = ftell($res);
|
||||
|
||||
// $now should be 0
|
||||
$this->assertLessThan($then, $now);
|
||||
$this->assertEquals(0, $now);
|
||||
|
||||
fseek($res, 0, SEEK_END);
|
||||
$final = ftell($res);
|
||||
|
||||
$this->assertEquals($then, $final);
|
||||
|
||||
return $res;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testSeek
|
||||
*/
|
||||
public function testEof($res) {
|
||||
rewind($res);
|
||||
|
||||
$this->assertEquals(0, ftell($res));
|
||||
|
||||
$this->assertFalse(feof($res));
|
||||
|
||||
fseek($res, 0, SEEK_END);
|
||||
$this->assertGreaterThan(0, ftell($res));
|
||||
|
||||
$read = fread($res, 8192);
|
||||
|
||||
$this->assertEmpty($read);
|
||||
|
||||
$this->assertTrue(feof($res));
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testEof
|
||||
*/
|
||||
public function testFlush($res) {
|
||||
|
||||
$stat1 = fstat($res);
|
||||
|
||||
fflush($res);
|
||||
|
||||
// Grab a copy of the object.
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$newObj = fopen($url, 'r', FALSE, $this->basicSwiftContext());
|
||||
|
||||
$stat2 = fstat($newObj);
|
||||
|
||||
$this->assertEquals($stat1['size'], $stat2['size']);
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testFlush
|
||||
*/
|
||||
public function testStreamGetMetadata($res) {
|
||||
// Grab a copy of the object.
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$newObj = fopen($url, 'r', FALSE, $this->basicSwiftContext());
|
||||
|
||||
$md = stream_get_meta_data($newObj);
|
||||
//throw new \Exception(print_r($md, true));
|
||||
$obj = $md['wrapper_data']->object();
|
||||
|
||||
$this->assertInstanceOf('\HPCloud\Storage\ObjectStorage\RemoteObject', $obj);
|
||||
|
||||
$this->assertEquals(self::FTYPE, $obj->contentType());
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testFlush
|
||||
*/
|
||||
public function testClose($res) {
|
||||
$this->assertTrue(is_resource($res));
|
||||
fwrite($res, '~~~~');
|
||||
//throw new \Exception(stream_get_contents($res));
|
||||
fflush($res);
|
||||
|
||||
// This is occasionally generating seemingly
|
||||
// spurious PHP errors about Bootstrap::$config.
|
||||
fclose($res);
|
||||
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$res2 = fopen($url, 'r', FALSE, $this->basicSwiftContext());
|
||||
$this->assertTrue(is_resource($res2));
|
||||
|
||||
$contents = stream_get_contents($res2);
|
||||
fclose($res2);
|
||||
$this->assertRegExp('/~{4}$/', $contents);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testClose
|
||||
*/
|
||||
public function testCast() {
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$res = fopen($url, 'r', FALSE, $this->basicSwiftContext());
|
||||
|
||||
$read = array($res);
|
||||
$write = array();
|
||||
$except = array();
|
||||
$num_changed = stream_select($read, $write, $except, 0);
|
||||
$this->assertGreaterThan(0, $num_changed);
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testClose
|
||||
*/
|
||||
public function testUrlStat(){
|
||||
// Add context to the bootstrap config.
|
||||
$this->addBootstrapConfig();
|
||||
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
|
||||
$ret = stat($url);
|
||||
|
||||
// Check that the array looks right.
|
||||
$this->assertEquals(26, count($ret));
|
||||
$this->assertEquals(0, $ret[3]);
|
||||
$this->assertEquals($ret[2], $ret['mode']);
|
||||
|
||||
$this->assertTrue(file_exists($url));
|
||||
$this->assertTrue(is_readable($url));
|
||||
$this->assertTrue(is_writeable($url));
|
||||
$this->assertFalse(is_link($url));
|
||||
$this->assertGreaterThan(0, filemtime($url));
|
||||
$this->assertGreaterThan(5, filesize($url));
|
||||
|
||||
$perm = fileperms($url);
|
||||
|
||||
// Assert that this is a file. Objects are
|
||||
// *always* marked as files.
|
||||
$this->assertEquals(0x8000, $perm & 0x8000);
|
||||
|
||||
// Assert writeable by owner.
|
||||
$this->assertEquals(0x0080, $perm & 0x0080);
|
||||
|
||||
// Assert not world writable.
|
||||
$this->assertEquals(0, $perm & 0x0002);
|
||||
|
||||
$contents = file_get_contents($url);
|
||||
$this->assertGreaterThan(5, strlen($contents));
|
||||
|
||||
$fsCopy = '/tmp/hpcloud-copy-test.txt';
|
||||
copy($url, $fsCopy, $this->basicSwiftContext());
|
||||
$this->assertTrue(file_exists($fsCopy));
|
||||
unlink($fsCopy);
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testFlush
|
||||
*/
|
||||
public function testUnlink(){
|
||||
$url = $this->newUrl(self::FNAME);
|
||||
$cxt = $this->basicSwiftContext();
|
||||
|
||||
$ret = unlink($url, $cxt);
|
||||
$this->assertTrue($ret);
|
||||
|
||||
$ret2 = unlink($url, $cxt);
|
||||
$this->assertFalse($ret2);
|
||||
}
|
||||
|
||||
public function testSetOption() {
|
||||
$url = $this->newUrl('fake.foo');
|
||||
$fake = fopen($url, 'nope', FALSE, $this->basicSwiftContext());
|
||||
|
||||
$this->assertTrue(stream_set_blocking($fake, 1));
|
||||
|
||||
// Returns 0 on success.
|
||||
$this->assertEquals(0, stream_set_write_buffer($fake, 8192));
|
||||
|
||||
// Cant set a timeout on a tmp storage:
|
||||
$this->assertFalse(stream_set_timeout($fake, 10));
|
||||
|
||||
fclose($fake);
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testUnlink
|
||||
*/
|
||||
public function testRename(){
|
||||
$url = $this->newUrl('rename.foo');
|
||||
$fake = fopen($url, 'w+', FALSE, $this->basicSwiftContext());
|
||||
fwrite($fake, 'test');
|
||||
fclose($fake);
|
||||
|
||||
$this->assertTrue(file_exists($url));
|
||||
|
||||
$url2 = $this->newUrl('rename.txt');
|
||||
|
||||
rename($url, $url2, $this->basicSwiftContext());
|
||||
|
||||
$this->assertTrue(file_exists($url2));
|
||||
$this->assertFalse(file_exists($url));
|
||||
|
||||
unlink($url2, $this->basicSwiftContext());
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testUnlink
|
||||
*/
|
||||
public function testOpenDir() {
|
||||
$urls = array('test1.txt', 'foo/test2.txt', 'foo/test3.txt', 'bar/test4.txt');
|
||||
foreach ($urls as $base) {
|
||||
$url = $this->newUrl($base);
|
||||
$f = fopen($url, 'c+', FALSE, $this->basicSwiftContext());
|
||||
fwrite($f, 'Test.');
|
||||
fclose($f);
|
||||
}
|
||||
|
||||
$dirUrl = $this->newUrl('');
|
||||
$dir = opendir($dirUrl, $this->basicSwiftContext());
|
||||
|
||||
$this->assertTrue(is_resource($dir));
|
||||
|
||||
return $dir;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testOpenDir
|
||||
*/
|
||||
public function testReaddir($dir){
|
||||
// Order should be newest to oldest.
|
||||
$expects = array('bar/', 'foo/', 'test1.txt');
|
||||
|
||||
$buffer = array();
|
||||
while (($entry = readdir($dir)) !== FALSE) {
|
||||
$should_be = array_shift($expects);
|
||||
$this->assertEquals($should_be, $entry);
|
||||
}
|
||||
$this->assertFalse(readdir($dir));
|
||||
|
||||
return $dir;
|
||||
}
|
||||
/**
|
||||
* @depends testReaddir
|
||||
*/
|
||||
public function testRewindDir($dir){
|
||||
$this->assertFalse(readdir($dir));
|
||||
rewinddir($dir);
|
||||
$this->assertEquals('bar/', readdir($dir));
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testRewindDir
|
||||
*/
|
||||
public function testCloseDir($dir) {
|
||||
$this->assertTrue(is_resource($dir));
|
||||
closedir($dir);
|
||||
|
||||
// There is a bug in PHP where a
|
||||
// resource buffer is not getting cleared.
|
||||
// So this might return a value even though
|
||||
// the underlying stream is cleared.
|
||||
//$this->assertFalse(readdir($dir));
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testCloseDir
|
||||
*/
|
||||
public function testOpenSubdir() {
|
||||
|
||||
// Opening foo we should find test2.txt and test3.txt.
|
||||
$url = $this->newUrl('foo/');
|
||||
$dir = opendir($url, $this->basicSwiftContext());
|
||||
|
||||
// I don't know why, but these are always returned in
|
||||
// lexical order.
|
||||
$this->assertEquals('test2.txt', readdir($dir));
|
||||
$this->assertEquals('test3.txt', readdir($dir));
|
||||
|
||||
$array = scandir($url, -1, $this->basicSwiftContext());
|
||||
$this->assertEquals(2, count($array));
|
||||
$this->assertEquals('test3.txt', $array[0]);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @depends testReaddir
|
||||
*/
|
||||
// public function testIsdir($dir) {
|
||||
|
||||
// }
|
||||
|
||||
public function testMkdir() {
|
||||
$url = $this->newUrl('baz/');
|
||||
|
||||
// Because object names are pathy we should always see TRUE when creating
|
||||
// a new directory.
|
||||
$this->assertTrue(mkdir($url, $this->basicSwiftContext()));
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user