OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	08/12/2024 10:35:16 AM	rwxr-xr-x
📄 AgentHeaderTest.php	5.89 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 ApiExceptionTest.php	22.46 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 ApiStatusTest.php	5.41 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 ArrayTraitTest.php	5.71 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 BidiStreamTest.php	11.36 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 ClientOptionsTraitTest.php	20.93 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 ClientStreamTest.php	6.04 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 CredentialsWrapperTest.php	24.32 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 FixedSizeCollectionTest.php	7.5 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 GapicClientTraitTest.php	62.45 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 GeneratedTestTest.php	4.5 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 GrpcSupportTraitTest.php	1.49 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 InsecureCredentialsWrapperTest.php	3.1 KB	08/12/2024 10:35:16 AM	rw-r--r--
📁 Middleware	-	08/12/2024 10:36:19 AM	rwxr-xr-x
📄 MyMessage.php	743 bytes	08/12/2024 10:35:16 AM	rw-r--r--
📄 OperationResponseTest.php	16.37 KB	08/12/2024 10:35:16 AM	rw-r--r--
📁 Options	-	08/12/2024 10:36:19 AM	rwxr-xr-x
📄 PageStreamingDescriptorTest.php	2.16 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 PageTest.php	5.44 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 PagedListResponseTest.php	5.69 KB	08/12/2024 10:35:16 AM	rw-r--r--
📄 PathTemplateTest.php	9.19 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ProtobufBandaidTest.php	1.15 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ProtobufExtensionTest.php	2.17 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 RequestBuilderTest.php	17.19 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 RequestParamsHeaderDescriptorTest.php	3.28 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ResourceHelperTraitTest.php	4.01 KB	08/12/2024 10:35:17 AM	rw-r--r--
📁 ResourceTemplate	-	08/12/2024 10:36:19 AM	rwxr-xr-x
📄 RetrySettingsTest.php	14.3 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 SerializerTest.php	10.21 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ServerStreamTest.php	7.4 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ServiceAddressTraitTest.php	2.2 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 TestTrait.php	4.72 KB	08/12/2024 10:35:17 AM	rw-r--r--
📁 Transport	-	08/12/2024 10:36:38 AM	rwxr-xr-x
📄 UriTraitTest.php	2.45 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 ValidationTraitTest.php	2.17 KB	08/12/2024 10:35:17 AM	rw-r--r--
📄 VersionTest.php	1.89 KB	08/12/2024 10:35:17 AM	rw-r--r--
📁 testdata	-	08/12/2024 10:36:45 AM	rwxr-xr-x

Editing: OperationResponseTest.php

<?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\LongRunning\OperationsClient;
use Google\ApiCore\OperationResponse;
use Google\LongRunning\Operation;
use Google\Protobuf\Any;
use Google\Rpc\Code;
use LogicException;
use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;

class OperationResponseTest extends TestCase
{
    use ProphecyTrait;
    use TestTrait;

public function testBasic()
    {
        $opName = 'operations/opname';
        $opClient = $this->createOperationsClient();
        $op = new OperationResponse($opName, $opClient);

$this->assertSame($opName, $op->getName());
        $this->assertSame($opClient, $op->getOperationsClient());
    }

public function testWithoutResponse()
    {
        $opName = 'operations/opname';
        $opClient = $this->createOperationsClient();
        $op = new OperationResponse($opName, $opClient);

$this->assertNull($op->getLastProtoResponse());
        $this->assertFalse($op->isDone());
        $this->assertNull($op->getResult());
        $this->assertNull($op->getError());
        $this->assertNull($op->getMetadata());
        $this->assertFalse($op->operationSucceeded());
        $this->assertFalse($op->operationFailed());
        $this->assertEquals([
            'operationReturnType' => null,
            'metadataReturnType' => null,
            'initialPollDelayMillis' => 1000.0,
            'pollDelayMultiplier' => 2.0,
            'maxPollDelayMillis' => 60000.0,
            'totalPollTimeoutMillis' => 0.0,
        ], $op->getDescriptorOptions());
    }

public function testWithResponse()
    {
        $opName = 'operations/opname';
        $opClient = $this->createOperationsClient();
        $protoResponse = new Operation();
        $op = new OperationResponse($opName, $opClient, [
            'lastProtoResponse' => $protoResponse,
        ]);

$this->assertSame($protoResponse, $op->getLastProtoResponse());
        $this->assertFalse($op->isDone());
        $this->assertNull($op->getResult());
        $this->assertNull($op->getError());
        $this->assertNull($op->getMetadata());
        $this->assertFalse($op->operationSucceeded());
        $this->assertFalse($op->operationFailed());
        $this->assertEquals([
            'operationReturnType' => null,
            'metadataReturnType' => null,
            'initialPollDelayMillis' => 1000.0,
            'pollDelayMultiplier' => 2.0,
            'maxPollDelayMillis' => 60000.0,
            'totalPollTimeoutMillis' => 0.0,
        ], $op->getDescriptorOptions());

$response = $this->createAny($this->createStatus(0, "response"));
        $error = $this->createStatus(2, "error");
        $metadata = $this->createAny($this->createStatus(0, "metadata"));

$protoResponse->setDone(true);
        $protoResponse->setResponse($response);
        $protoResponse->setMetadata($metadata);
        $this->assertTrue($op->isDone());
        $this->assertSame($response, $op->getResult());
        $this->assertSame($metadata, $op->getMetadata());
        $this->assertTrue($op->operationSucceeded());
        $this->assertFalse($op->operationFailed());

$protoResponse->setError($error);
        $this->assertNull($op->getResult());
        $this->assertSame($error, $op->getError());
        $this->assertFalse($op->operationSucceeded());
        $this->assertTrue($op->operationFailed());
    }

public function testWithOptions()
    {
        $opName = 'operations/opname';
        $opClient = $this->createOperationsClient();
        $protoResponse = new Operation();
        $op = new OperationResponse($opName, $opClient, [
            'operationReturnType' => '\Google\Rpc\Status',
            'metadataReturnType' => '\Google\Protobuf\Any',
            'lastProtoResponse' => $protoResponse,
        ]);

$this->assertSame($protoResponse, $op->getLastProtoResponse());
        $this->assertFalse($op->isDone());
        $this->assertNull($op->getResult());
        $this->assertNull($op->getError());
        $this->assertNull($op->getMetadata());
        $this->assertEquals([
            'operationReturnType' => '\Google\Rpc\Status',
            'metadataReturnType' => '\Google\Protobuf\Any',
            'initialPollDelayMillis' => 1000.0,
            'pollDelayMultiplier' => 2.0,
            'maxPollDelayMillis' => 60000.0,
            'totalPollTimeoutMillis' => 0.0,

], $op->getDescriptorOptions());

$innerResponse = $this->createStatus(0, "response");
        $innerMetadata = new Any();
        $innerMetadata->setValue("metadata");

$response = $this->createAny($innerResponse);
        $metadata = $this->createAny($innerMetadata);

$protoResponse->setDone(true);
        $protoResponse->setResponse($response);
        $protoResponse->setMetadata($metadata);
        $this->assertTrue($op->isDone());
        $this->assertEquals($innerResponse, $op->getResult());
        $this->assertEquals($innerMetadata, $op->getMetadata());
    }

/**
     * @dataProvider pollingDataProvider
     */
    public function testPolling($op, $pollArgs, $expectedSleeps, $expectedComplete)
    {
        $op->pollUntilComplete($pollArgs);

$this->assertEquals($op->isDone(), $expectedComplete);
        $this->assertEquals($op->getSleeps(), $expectedSleeps);
    }

public function pollingDataProvider()
    {
        $pollingArgs = [
            'initialPollDelayMillis' => 10.0,
            'pollDelayMultiplier' => 3.0,
            'maxPollDelayMillis' => 50.0,
            'totalPollTimeoutMillis' => 100.0,
        ];
        return [
            [$this->createOperationResponse([], 3), [], [1000.0, 2000.0, 4000.0], true], // Defaults
            [$this->createOperationResponse([], 3), $pollingArgs, [10, 30, 50], true], // Args to pollUntilComplete
            [$this->createOperationResponse($pollingArgs, 3), [], [10, 30, 50], true], // Args to constructor
            [$this->createOperationResponse([], 4), [
                'totalPollTimeoutMillis' => 80.0,
            ] + $pollingArgs, [10, 30, 50], false], // Polling timeout
        ];
    }

public function testCustomOperation()
    {
        $operationName = 'test-123';
        $operation = $this->prophesize(CustomOperation::class);
        $operation->isThisOperationDoneOrWhat()
            ->shouldBeCalledTimes(2)
            ->willReturn('Yes, it is!');
        $operation->getError()
            ->shouldBeCalledOnce()
            ->willReturn(null);
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $operationClient->getMyOperationPlease($operationName, 'arg1', 'arg2')
            ->shouldBeCalledOnce()
            ->willReturn($operation->reveal());
        $operationClient->cancelMyOperationPlease($operationName, 'arg1', 'arg2')
            ->shouldBeCalledOnce()
            ->willReturn(true);
        $operationClient->deleteMyOperationPlease($operationName, 'arg1', 'arg2')
            ->shouldBeCalledOnce()
            ->willReturn(true);
        $options = [
            'getOperationMethod' => 'getMyOperationPlease',
            'cancelOperationMethod' => 'cancelMyOperationPlease',
            'deleteOperationMethod' => 'deleteMyOperationPlease',
            'additionalOperationArguments' => ['arg1', 'arg2'],
            'operationStatusMethod' => 'isThisOperationDoneOrWhat',
            'operationStatusDoneValue' => 'Yes, it is!',
        ];
        $operationResponse = new OperationResponse($operationName, $operationClient->reveal(), $options);

// Test getOperationMethod
        $operationResponse->reload();

// Test operationStatusMethod and operationStatusDoneValue
        $this->assertTrue($operationResponse->isDone());

$this->assertTrue($operationResponse->operationSucceeded());

// test cancelOperationMethod
        $operationResponse->cancel();

// test deleteOperationMethod
        $operationResponse->delete();
    }

public function testCustomOperationError()
    {
        $operationName = 'test-123';
        $operation = $this->prophesize(CustomOperationWithErrorAnnotations::class);
        $operation->isThisOperationDoneOrWhat()
            ->shouldBeCalledTimes(2)
            ->willReturn('Yes, it is!');
        $operation->getTheErrorCode()
            ->shouldBeCalledTimes(2)
            ->willReturn(500);
        $operation->getTheErrorMessage()
            ->shouldBeCalledOnce()
            ->willReturn('It failed, sorry :(');
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $options = [
            'operationStatusMethod' => 'isThisOperationDoneOrWhat',
            'operationStatusDoneValue' => 'Yes, it is!',
            'operationErrorCodeMethod' => 'getTheErrorCode',
            'operationErrorMessageMethod' => 'getTheErrorMessage',
            'lastProtoResponse' => $operation->reveal(),
        ];
        $operationResponse = new OperationResponse($operationName, $operationClient->reveal(), $options);

$this->assertFalse($operationResponse->operationSucceeded());

$error = $operationResponse->getError();

$this->assertNotNull($error);
        $this->assertEquals(Code::INTERNAL, $error->getCode());
        $this->assertSame('It failed, sorry :(', $error->getMessage());
    }

public function testEmptyCustomOperationErrorIsSuccessful()
    {
        $operationName = 'test-123';
        $operation = $this->prophesize(CustomOperationWithErrorAnnotations::class);
        $operation->isThisOperationDoneOrWhat()
            ->shouldBeCalledOnce()
            ->willReturn('Yes, it is!');
        $operation->getTheErrorCode()
            ->shouldBeCalledOnce()
            ->willReturn(null);
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $options = [
            'operationStatusMethod' => 'isThisOperationDoneOrWhat',
            'operationStatusDoneValue' => 'Yes, it is!',
            'operationErrorCodeMethod' => 'getTheErrorCode',
            'lastProtoResponse' => $operation->reveal(),
        ];
        $operationResponse = new OperationResponse($operationName, $operationClient->reveal(), $options);

$this->assertTrue($operationResponse->operationSucceeded());
    }

public function testMisconfiguredCustomOperationThrowsException()
    {
        $operationName = 'test-123';
        $operation = $this->prophesize(CustomOperationWithErrorAnnotations::class);
        $operation->isThisOperationDoneOrWhat()
            ->shouldBeCalledOnce()
            ->willReturn('Yes, it is!');
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $options = [
            'operationStatusMethod' => 'isThisOperationDoneOrWhat',
            'operationStatusDoneValue' => 'Yes, it is!',
            'operationErrorCodeMethod' => null, // The OperationResponse has no way to determine error status
            'lastProtoResponse' => $operation->reveal(),
        ];
        $operationResponse = new OperationResponse($operationName, $operationClient->reveal(), $options);

$this->expectException(LogicException::class);
        $this->expectExceptionMessage('Unable to determine operation error status for this service');

$operationResponse->operationSucceeded();
    }

public function testNoCancelOperation()
    {
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $options = [
            'cancelOperationMethod' => null,
        ];
        $operationResponse = new OperationResponse('test-123', $operationClient->reveal(), $options);

$this->expectException(LogicException::class);
        $this->expectExceptionMessage('The cancel operation is not supported by this API');

$operationResponse->cancel();
    }

public function testNoDeleteOperation()
    {
        $operationClient = $this->prophesize(CustomOperationClient::class);
        $options = [
            'deleteOperationMethod' => null,
        ];
        $operationResponse = new OperationResponse('test-123', $operationClient->reveal(), $options);

$this->expectException(LogicException::class);
        $this->expectExceptionMessage('The delete operation is not supported by this API');
        $operationResponse->delete();
    }

public function testPollingCastToInt()
    {
        $op = $this->createOperationResponse([], 3);
        $op->pollUntilComplete([
            'initialPollDelayMillis' => 3.0,
            'pollDelayMultiplier' => 1.5,
        ]);

$this->assertEquals($op->isDone(), true);
        $this->assertEquals($op->getSleeps(), [3, 4, 6]);
    }

private function createOperationResponse($options, $reloadCount)
    {
        $opName = 'operations/opname';
        return new FakeOperationResponse($opName, $this->createOperationClient($reloadCount), $options);
    }

private function createOperationClient($reloadCount)
    {
        $consecutiveCalls = [];
        for ($i = 0; $i < $reloadCount - 1; $i++) {
            $consecutiveCalls[] = $this->returnValue(new Operation);
        }
        $consecutiveCalls[] = $this->returnValue(new Operation(['done' => true]));

$opClient = $this->getMockBuilder(OperationsClient::class)
            ->setConstructorArgs([[
                'apiEndpoint' => '',
                'scopes' => [],
            ]])
            ->setMethods(['getOperation'])
            ->getMock();

$opClient->expects($this->exactly($reloadCount))
            ->method('getOperation')
            ->will($this->onConsecutiveCalls(...$consecutiveCalls));

return $opClient;
    }
}

class FakeOperationResponse extends OperationResponse
{
    private $currentTime = 0;
    private $sleeps;

public function getSleeps()
    {
        return $this->sleeps;
    }

public function sleepMillis(int $millis)
    {
        $this->currentTime += $millis;
        $this->sleeps[] = $millis;
    }

public function setTimes($times)
    {
        $this->times = $times;
    }

public function getCurrentTimeMillis()
    {
        return $this->currentTime;
    }
}

interface CustomOperationClient
{
    public function getMyOperationPlease($name, $requiredArg1, $requiredArg2);
    public function cancelMyOperationPlease($name, $requiredArg1, $requiredArg2);
    public function deleteMyOperationPlease($name, $requiredArg1, $requiredArg2);
}

interface CustomOperation
{
    public function isThisOperationDoneOrWhat();
    public function getError();
}

interface CustomOperationWithErrorAnnotations
{
    public function isThisOperationDoneOrWhat();
    public function getTheErrorCode();
    public function getTheErrorMessage();
}