Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/st2/vendor/google/gax/tests/ApiCore/Tests/Unit/ |
<?php
/**
* Copyright 2016 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\ApiCore\Tests\Unit;
use Google\ApiCore\RequestBuilder;
use Google\ApiCore\Testing\MockRequestBody;
use Google\Protobuf\StringValue;
use Google\Protobuf\FieldMask;
use PHPUnit\Framework\TestCase;
/**
* @group core
*/
class RequestBuilderTest extends TestCase
{
const SERVICE_NAME = 'test.interface.v1.api';
public function setUp()
{
$this->builder = new RequestBuilder(
'www.example.com',
__DIR__ . '/testdata/test_service_rest_client_config.php'
);
}
public function testMethodWithUrlPlaceholder()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithUrlPlaceholder', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo', $uri->getPath());
$this->assertEquals('number=0', $uri->getQuery());
$this->assertEquals('', (string) $request->getBody());
}
public function testMethodWithBody()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$nestedMessage = new MockRequestBody();
$nestedMessage->setName('nested/foo');
$message->setNestedMessage($nestedMessage);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithBody', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo', $uri->getPath());
$this->assertEquals('', $uri->getQuery());
$this->assertEquals(
['name' => 'message/foo', 'nestedMessage' => ['name' => 'nested/foo']],
json_decode($request->getBody(), true)
);
}
public function testMethodWithNestedMessageAsBody()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$nestedMessage = new MockRequestBody();
$nestedMessage->setName('nested/foo');
$message->setNestedMessage($nestedMessage);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithNestedMessageAsBody', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo', $uri->getPath());
$this->assertEquals('number=0', $uri->getQuery());
$this->assertEquals(
['name' => 'nested/foo'],
json_decode($request->getBody(), true)
);
}
public function testMethodWithNestedUrlPlaceholder()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$nestedMessage = new MockRequestBody();
$nestedMessage->setName('nested/foo');
$message->setNestedMessage($nestedMessage);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithNestedUrlPlaceholder', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/nested/foo', $uri->getPath());
$this->assertEquals('', $uri->getQuery());
$this->assertEquals(
['name' => 'message/foo', 'nestedMessage' => ['name' => 'nested/foo']],
json_decode($request->getBody(), true)
);
}
public function testMethodWithUrlRepeatedField()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$message->setRepeatedField(['bar1', 'bar2']);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithUrlPlaceholder', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo', $uri->getPath());
$this->assertEquals('number=0&repeated_field=bar1&repeated_field=bar2', $uri->getQuery());
$this->assertEquals('', (string) $request->getBody());
}
public function testMethodWithHeaders()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithUrlPlaceholder', $message, [
'header1' => 'value1',
'header2' => 'value2']
);
$this->assertEquals('value1', $request->getHeaderLine('header1'));
$this->assertEquals('value2', $request->getHeaderLine('header2'));
$this->assertEquals('application/json', $request->getHeaderLine('Content-Type'));
}
public function testMethodWithColon()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithColonInUrl', $message);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo:action', $uri->getPath());
$this->assertEquals('number=0', $uri->getQuery());
}
public function testMethodWithMultipleWildcardsAndColonInUrl()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$message->setNumber(10);
$request = $this->builder->build(
self::SERVICE_NAME . '/MethodWithMultipleWildcardsAndColonInUrl',
$message
);
$uri = $request->getUri();
$this->assertEquals('/v1/message/foo/number/10:action', $uri->getPath());
$this->assertEquals('', $uri->getQuery());
}
public function testMethodWithSimplePlaceholder()
{
$message = new MockRequestBody();
$message->setName('message-name');
$request = $this->builder->build(
self::SERVICE_NAME . '/MethodWithSimplePlaceholder',
$message
);
$uri = $request->getUri();
$this->assertEquals('/v1/message-name', $uri->getPath());
}
public function testMethodWithAdditionalBindings()
{
$message = new MockRequestBody();
$message->setName('message/foo');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithAdditionalBindings', $message);
$this->assertEquals('/v1/message/foo/additional/bindings', $request->getUri()->getPath());
$message->setName('different/format/foo');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithAdditionalBindings', $message);
$this->assertEquals('/v1/different/format/foo/additional/bindings', $request->getUri()->getPath());
$nestedMessage = new MockRequestBody();
$nestedMessage->setName('nested/foo');
$message->setNestedMessage($nestedMessage);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithAdditionalBindings', $message);
$this->assertEquals('/v2/nested/foo/additional/bindings', $request->getUri()->getPath());
}
public function testMethodWithSpecialJsonMapping()
{
if (extension_loaded('protobuf')) {
$this->markTestSkipped('This is currently broken for the protobuf extension');
}
$stringValue = (new StringValue)
->setValue('some-value');
$fieldMask = (new FieldMask)
->setPaths(['path1', 'path2']);
$message = (new MockRequestBody())
->setStringValue($stringValue)
->setFieldMask($fieldMask);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithSpecialJsonMapping', $message);
parse_str($request->getUri()->getQuery(), $query);
$this->assertEquals('path1,path2', $query['field_mask']);
$this->assertEquals('some-value', $query['string_value']);
}
public function testMethodWithoutPlaceholders()
{
if (extension_loaded('protobuf')) {
$this->markTestSkipped('This is currently broken for the protobuf extension');
}
$stringValue = (new StringValue)
->setValue('some-value');
$fieldMask = (new FieldMask)
->setPaths(['path1', 'path2']);
$message = (new MockRequestBody())
->setStringValue($stringValue)
->setFieldMask($fieldMask);
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithoutPlaceholders', $message);
parse_str($request->getUri()->getQuery(), $query);
$this->assertEquals('path1,path2', $query['field_mask']);
$this->assertEquals('some-value', $query['string_value']);
}
/**
* @expectedException \Google\ApiCore\ValidationException
* @expectedExceptionMessage Could not map bindings for test.interface.v1.api/MethodWithAdditionalBindings to any Uri template.
*/
public function testThrowsExceptionWithNonMatchingFormat()
{
$message = new MockRequestBody();
$message->setName('invalid/name/format');
$request = $this->builder->build(self::SERVICE_NAME . '/MethodWithAdditionalBindings', $message);
}
/**
* @expectedException \Google\ApiCore\ValidationException
* @expectedExceptionMessage Failed to build request, as the provided path (myResource/doesntExist) was not found in the configuration.
*/
public function testThrowsExceptionWithNonExistantMethod()
{
$message = new MockRequestBody();
$this->builder->build('myResource/doesntExist', $message);
}
}