public static function getInterestingListBlobsOptions()
{
$ret = array();
$options = new ListBlobsOptions();
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setMaxResults(2);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setTimeout(10);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setTimeout(-10);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setPrefix(self::$nonExistBlobPrefix);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setPrefix(self::$testUniqueId);
array_push($ret, $options);
$options = new ListBlobsOptions();
// Cannot set Marker to arbitrary values. Must only use if the previous request returns a NextMarker.
// $options->setMarker('abc');
// So, add logic in listBlobsWorker to loop and setMarker if there is a NextMarker.
$options->setMaxResults(2);
$options->setPrefix(self::$testUniqueId);
$options->setTimeout(10);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setMaxResults(3);
$options->setPrefix(self::$testUniqueId);
$options->setTimeout(10);
array_push($ret, $options);
$options = new ListBlobsOptions();
$options->setMaxResults(4);
$options->setPrefix(self::$testUniqueId);
$options->setTimeout(10);
array_push($ret, $options);
return $ret;
}
/**
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::copyBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::createBlobSnapshot
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::createPageBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::deleteBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::getBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::listBlobs
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::setBlobMetadata
*/
private function copyBlobWorker($options, $sourceContainer, $destContainer)
{
$sourceBlob = BlobServiceFunctionalTestData::getInterestingBlobName($sourceContainer);
$destBlob = BlobServiceFunctionalTestData::getInterestingBlobName($destContainer);
// Make sure there is something to test
$sourceDataSize = 512;
$this->restProxy->createPageBlob($sourceContainer, $sourceBlob, $sourceDataSize);
$destDataSize = 2048;
$destBlobInfo = $this->restProxy->createPageBlob($destContainer, $destBlob, $destDataSize);
$this->restProxy->createBlobSnapshot($destContainer, $destBlob);
$metadata = BlobServiceFunctionalTestData::getNiceMetadata();
$this->restProxy->setBlobMetadata($sourceContainer, $sourceBlob, $metadata);
$snapshot = $this->restProxy->createBlobSnapshot($sourceContainer, $sourceBlob);
if (!is_null($options)) {
BlobServiceFunctionalTestData::fixETagAccessCondition($options->getSourceAccessCondition(), $snapshot->getETag());
BlobServiceFunctionalTestData::fixETagAccessCondition($options->getAccessCondition(), $destBlobInfo->getETag());
$options->setSourceSnapshot(is_null($options->getSourceSnapshot()) ? null : $snapshot->getSnapshot());
}
try {
if (is_null($options)) {
$this->restProxy->copyBlob($destContainer, $destBlob, $sourceContainer, $sourceBlob);
} else {
$this->restProxy->copyBlob($destContainer, $destBlob, $sourceContainer, $sourceBlob, $options);
}
if (is_null($options)) {
$options = new CopyBlobOptions();
}
if (!is_null($options->getTimeout()) && $options->getTimeout() < 1) {
$this->assertTrue(false, 'Expect negative timeouts in $options to throw');
}
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getSourceAccessCondition())) {
$this->assertTrue(false, 'Expect failing source temporal access condition should throw');
}
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getSourceAccessCondition())) {
$this->assertTrue(false, 'Expect failing source etag access condition to throw');
}
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getAccessCondition())) {
$this->assertTrue(false, 'Expect failing dest temporal access condition should throw');
}
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getAccessCondition())) {
$this->assertTrue(false, 'Expect failing dest etag access condition to throw');
}
$listOptions = new ListBlobsOptions();
$listOptions->setIncludeSnapshots(true);
$listOptions->setPrefix($destBlob);
$listBlobsResult = $this->restProxy->listBlobs($destContainer == '' ? '$root' : $destContainer, $listOptions);
$blobs = $listBlobsResult->getBlobs();
$getBlobResult = $this->restProxy->getBlob($destContainer, $destBlob);
$this->verifyCopyBlobWorker($options, $blobs, $getBlobResult, $sourceDataSize, $metadata);
} catch (ServiceException $e) {
if (is_null($options)) {
$options = new CopyBlobOptions();
}
if (!is_null($options->getTimeout()) && $options->getTimeout() < 1) {
$this->assertEquals(500, $e->getCode(), 'bad timeout: deleteHttpStatusCode');
} else {
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getSourceAccessCondition())) {
$this->assertEquals(412, $e->getCode(), 'bad source temporal access condition IF_UNMODIFIED_SINCE: deleteHttpStatusCode');
} else {
if (!BlobServiceFunctionalTestData::passETagAccessCondition($options->getSourceAccessCondition())) {
$this->assertEquals(412, $e->getCode(), 'bad source etag access condition: deleteHttpStatusCode');
} else {
if (!BlobServiceFunctionalTestData::passTemporalAccessCondition($options->getAccessCondition())) {
$this->assertEquals(412, $e->getCode(), 'bad dest temporal access condition IF_UNMODIFIED_SINCE: deleteHttpStatusCode');
} else {
if (!BlobServiceFunctionalTestData::passETagAccessCondition($options->getAccessCondition())) {
$this->assertEquals(412, $e->getCode(), 'bad dest etag access condition: deleteHttpStatusCode');
} else {
throw $e;
}
}
}
}
}
}
// Clean up.
$this->restProxy->deleteBlob($sourceContainer, $sourceBlob);
$this->restProxy->deleteBlob($destContainer, $destBlob);
}
/**
* @return void
*/
public function testGetFolderInFoldersSetsFolderPrefixToGivenFolder()
{
$this->folderInFolderMethodStubs();
$this->storageDriver->getFoldersInFolder('foo');
$options = new ListBlobsOptions();
$options->setPrefix('foo/');
$this->blobRestProxy->listBlobs(Arg::any(), $options)->shouldHaveBeenCalled();
}
/**
* @param string $sourceFolderIdentifier
* @return array
*/
protected function getBlobsFromFolder($sourceFolderIdentifier)
{
$blobs = [];
$options = new ListBlobsOptions();
$options->setPrefix($sourceFolderIdentifier);
$blobListResult = $this->blobRestProxy->listBlobs($this->container, $options);
if (is_object($blobListResult)) {
$blobs = $blobListResult->getBlobs();
}
return $blobs;
}
/**
* @covers MicrosoftAzure\Storage\Blob\Models\ListBlobsOptions::getIncludeUncommittedBlobs
*/
public function testGetIncludeUncommittedBlobs()
{
// Setup
$options = new ListBlobsOptions();
$expected = true;
$options->setIncludeUncommittedBlobs($expected);
// Test
$actual = $options->getIncludeUncommittedBlobs();
// Assert
$this->assertEquals($expected, $actual);
}
/**
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::createPageBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::deleteBlob
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::listBlobs
*/
public function testListBlobsWithDelimiterWorks()
{
// Arrange
$blobNames = array('myblob1', 'myblob2', 'dir1-blob1', 'dir1-blob2', 'dir2-dir21-blob3', 'dir2-dir22-blob3');
foreach ($blobNames as $blob) {
$this->restProxy->createPageBlob(self::$_test_container_for_listing, $blob, 512);
}
// Act
$opts = new ListBlobsOptions();
$opts->setDelimiter('-');
$results = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
$opts->setPrefix('dir1-');
$results2 = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
$opts->setPrefix('dir2-');
$results3 = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
$opts->setPrefix('dir2-dir21-');
$results4 = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
$opts->setPrefix('dir2-dir22-');
$results5 = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
$opts->setPrefix('dir2-dir44-');
$results6 = $this->restProxy->listBlobs(self::$_test_container_for_listing, $opts);
foreach ($blobNames as $blob) {
$this->restProxy->deleteBlob(self::$_test_container_for_listing, $blob);
}
// Assert
$this->assertNotNull($results, '$results');
$this->assertEquals(2, count($results->getBlobs()), 'count($results->getBlobs())');
$this->assertEquals(2, count($results->getBlobPrefixes()), 'count($results->getBlobPrefixes())');
$this->assertEquals(2, count($results2->getBlobs()), 'count($results2->getBlobs())');
$this->assertEquals(0, count($results2->getBlobPrefixes()), 'count($results2->getBlobPrefixes())');
$this->assertEquals(0, count($results3->getBlobs()), 'count($results3->getBlobs())');
$this->assertEquals(2, count($results3->getBlobPrefixes()), 'count($results3->getBlobPrefixes())');
$this->assertEquals(1, count($results4->getBlobs()), 'count($results4->getBlobs())');
$this->assertEquals(0, count($results4->getBlobPrefixes()), 'count($results4->getBlobPrefixes())');
$this->assertEquals(1, count($results5->getBlobs()), 'count($results5->getBlobs())');
$this->assertEquals(0, count($results5->getBlobPrefixes()), 'count($results5->getBlobPrefixes())');
$this->assertEquals(0, count($results6->getBlobs()), 'count($results6->getBlobs())');
$this->assertEquals(0, count($results6->getBlobPrefixes()), 'count($results6->getBlobPrefixes())');
}
/**
* @covers MicrosoftAzure\Storage\Blob\BlobRestProxy::createBlobSnapshot
* @covers MicrosoftAzure\Storage\Blob\Models\createBlobSnapshotResult::create
*/
public function testCreateBlobSnapshot()
{
// Setup
$containerName = 'createblobsnapshot' . $this->createSuffix();
$blobName = 'testBlob';
$blobValue = 'TestBlobValue';
$this->createContainer($containerName);
$this->restProxy->createBlockBlob($containerName, $blobName, $blobValue);
// Test
$snapshotResult = $this->restProxy->createBlobSnapshot($containerName, $blobName);
// Assert
$listOptions = new ListBlobsOptions();
$listOptions->setIncludeSnapshots(true);
$blobsResult = $this->restProxy->listBlobs($containerName, $listOptions);
$blobs = $blobsResult->getBlobs();
$actualBlob = $blobs[0];
$this->assertNotNull($snapshotResult->getETag());
$this->assertNotNull($snapshotResult->getLastModified());
$this->assertNotNull($snapshotResult->getSnapshot());
$this->assertEquals($snapshotResult->getSnapshot(), $actualBlob->getSnapshot());
}
/**
* {@inheritdoc}
*/
public function exists($key)
{
$this->init();
$listBlobsOptions = new ListBlobsOptions();
$listBlobsOptions->setPrefix($key);
try {
$blobsList = $this->blobProxy->listBlobs($this->containerName, $listBlobsOptions);
foreach ($blobsList->getBlobs() as $blob) {
if ($key === $blob->getName()) {
return true;
}
}
} catch (ServiceException $e) {
$this->failIfContainerNotFound($e, 'check if key exists');
$errorCode = $this->getErrorCodeFromServiceException($e);
throw new \RuntimeException(sprintf('Failed to check if key "%s" exists in container "%s": %s (%s).', $key, $this->containerName, $e->getErrorText(), $errorCode), $e->getCode());
}
return false;
}
/**
* Lists all of the blobs in the given container.
*
* @param string $container The container name.
* @param Models\ListBlobsOptions $options The optional parameters.
*
* @return Models\ListBlobsResult
*
* @see http://msdn.microsoft.com/en-us/library/windowsazure/dd135734.aspx
*/
public function listBlobs($container, $options = null)
{
Validate::isString($container, 'container');
$method = Resources::HTTP_GET;
$headers = array();
$postParams = array();
$queryParams = array();
$path = $container;
$statusCode = Resources::STATUS_OK;
if (is_null($options)) {
$options = new ListBlobsOptions();
}
$this->addOptionalQueryParam($queryParams, Resources::QP_TIMEOUT, $options->getTimeout());
$this->addOptionalQueryParam($queryParams, Resources::QP_REST_TYPE, 'container');
$this->addOptionalQueryParam($queryParams, Resources::QP_COMP, 'list');
$this->addOptionalQueryParam($queryParams, Resources::QP_PREFIX, str_replace('\\', '/', $options->getPrefix()));
$this->addOptionalQueryParam($queryParams, Resources::QP_MARKER, $options->getMarker());
$this->addOptionalQueryParam($queryParams, Resources::QP_DELIMITER, $options->getDelimiter());
$this->addOptionalQueryParam($queryParams, Resources::QP_MAX_RESULTS, $options->getMaxResults());
$includeMetadata = $options->getIncludeMetadata();
$includeSnapshots = $options->getIncludeSnapshots();
$includeUncommittedBlobs = $options->getIncludeUncommittedBlobs();
$includeValue = $this->groupQueryValues(array($includeMetadata ? 'metadata' : null, $includeSnapshots ? 'snapshots' : null, $includeUncommittedBlobs ? 'uncommittedblobs' : null));
$this->addOptionalQueryParam($queryParams, Resources::QP_INCLUDE, $includeValue);
$response = $this->send($method, $headers, $queryParams, $postParams, $path, $statusCode);
$parsed = $this->dataSerializer->unserialize($response->getBody());
return ListBlobsResult::create($parsed);
}
