Viewing file:  ApiExceptionTest.php (8.31 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2016 Google LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace Google\ApiCore\Tests\Unit;
use Google\ApiCore\ApiException;
use Google\Protobuf\Any;
use Google\Protobuf\Duration;
use Google\Rpc\BadRequest;
use Google\Rpc\Code;
use Google\Rpc\DebugInfo;
use Google\Rpc\Help;
use Google\Rpc\LocalizedMessage;
use Google\Rpc\QuotaFailure;
use Google\Rpc\RequestInfo;
use Google\Rpc\ResourceInfo;
use Google\Rpc\RetryInfo;
use Google\Rpc\Status;
use PHPUnit\Framework\TestCase;
class ApiExceptionTest extends TestCase
{
public function testWithoutMetadata()
{
$status = new \stdClass();
$status->code = Code::OK;
$status->details = 'testWithoutMetadata';
$apiException = ApiException::createFromStdClass($status);
$expectedMessage = json_encode([
'message' => 'testWithoutMetadata',
'code' => Code::OK,
'status' => 'OK',
'details' => []
], JSON_PRETTY_PRINT);
$this->assertSame(Code::OK, $apiException->getCode());
$this->assertSame($expectedMessage, $apiException->getMessage());
$this->assertNull($apiException->getMetadata());
}
/**
* @dataProvider getMetadata
*/
public function testWithMetadata($metadata, $metadataArray)
{
$status = new \stdClass();
$status->code = Code::OK;
$status->details = 'testWithMetadata';
$status->metadata = $metadata;
$apiException = ApiException::createFromStdClass($status);
$expectedMessage = json_encode([
'message' => 'testWithMetadata',
'code' => Code::OK,
'status' => 'OK',
'details' => $metadataArray
], JSON_PRETTY_PRINT);
$this->assertSame(Code::OK, $apiException->getCode());
$this->assertSame($expectedMessage, $apiException->getMessage());
$this->assertSame($metadata, $apiException->getMetadata());
}
public function getMetadata()
{
$retryInfo = new RetryInfo();
$duration = new Duration();
$duration->setSeconds(1);
$duration->setNanos(2);
$retryInfo->setRetryDelay($duration);
$unknownBinData = [
[
'@type' => 'unknown-bin',
'data' => '<Unknown Binary Data>'
]
];
$asciiData = [
[
'@type' => 'ascii',
'data' => 'ascii-data'
]
];
$retryInfoData = [
[
'@type' => 'google.rpc.retryinfo-bin',
'retryDelay' => [
'seconds' => 1,
'nanos' => 2,
],
]
];
$allKnownTypesData = [
[
'@type' => 'google.rpc.retryinfo-bin',
],
[
'@type' => 'google.rpc.debuginfo-bin',
"stackEntries" => [],
"detail" => ""
],
[
'@type' => 'google.rpc.quotafailure-bin',
'violations' => [],
],
[
'@type' => 'google.rpc.badrequest-bin',
'fieldViolations' => []
],
[
'@type' => 'google.rpc.requestinfo-bin',
'requestId' => '',
'servingData' => '',
],
[
'@type' => 'google.rpc.resourceinfo-bin',
'resourceType' => '',
'resourceName' => '',
'owner' => '',
'description' => '',
],
[
'@type' => 'google.rpc.help-bin',
'links' => [],
],
[
'@type' => 'google.rpc.localizedmessage-bin',
'locale' => '',
'message' => '',
],
];
return [
[['unknown-bin' => ['some-data-that-should-not-appear']], $unknownBinData],
[['ascii' => ['ascii-data']], $asciiData],
[['google.rpc.retryinfo-bin' => [$retryInfo->serializeToString()]], $retryInfoData],
[[
'google.rpc.retryinfo-bin' => [(new RetryInfo())->serializeToString()],
'google.rpc.debuginfo-bin' => [(new DebugInfo())->serializeToString()],
'google.rpc.quotafailure-bin' => [(new QuotaFailure())->serializeToString()],
'google.rpc.badrequest-bin' => [(new BadRequest())->serializeToString()],
'google.rpc.requestinfo-bin' => [(new RequestInfo())->serializeToString()],
'google.rpc.resourceinfo-bin' => [(new ResourceInfo())->serializeToString()],
'google.rpc.help-bin' => [(new Help())->serializeToString()],
'google.rpc.localizedmessage-bin' => [(new LocalizedMessage())->serializeToString()],
], $allKnownTypesData],
];
}
/**
* @dataProvider getMetadata
*/
public function testCreateFromApiResponse($metadata, $metadataArray) {
$basicMessage = 'testWithMetadata';
$code = Code::OK;
$status = 'OK';
$apiException = ApiException::createFromApiResponse($basicMessage, $code, $metadata);
$expectedMessage = json_encode([
'message' => $basicMessage,
'code' => $code,
'status' => $status,
'details' => $metadataArray
], JSON_PRETTY_PRINT);
$this->assertSame(Code::OK, $apiException->getCode());
$this->assertSame($expectedMessage, $apiException->getMessage());
$this->assertSame($metadata, $apiException->getMetadata());
}
/**
* @dataProvider getRpcStatusData
*/
public function testCreateFromRpcStatus($status, $expectedApiException) {
$actualApiException = ApiException::createFromRpcStatus($status);
$this->assertEquals($expectedApiException, $actualApiException);
}
public function getRpcStatusData()
{
$debugInfo = new DebugInfo();
$debugInfo->setDetail("debug detail");
$any = new Any();
$any->pack($debugInfo);
$status = new Status();
$status->setMessage("status string");
$status->setCode(Code::OK);
$status->setDetails([$any]);
$expectedMessage = json_encode([
'message' => $status->getMessage(),
'code' => $status->getCode(),
'status' => 'OK',
'details' => [
[
'stackEntries' => [],
'detail' => 'debug detail',
]
],
], JSON_PRETTY_PRINT);
return [
[
$status,
new ApiException($expectedMessage, Code::OK, 'OK', [
'metadata' => $status->getDetails(),
'basicMessage' => $status->getMessage(),
]
)
]
];
}
}
|