NN2024010801/vendor/alibabacloud/client/tests/LowerthanVersion7_2/Unit/Request/UserAgentTest.php

<?php

namespace AlibabaCloud\Client\Tests\LowerthanVersion7_2\Unit\Request;

use PHPUnit\Framework\TestCase;
use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\Client\Request\UserAgent;
use AlibabaCloud\Client\Request\RpcRequest;
use AlibabaCloud\Client\Exception\ClientException;

/**
 * Class UserAgentTest
 */
class UserAgentTest extends TestCase
{
    public static function testUserAgentString()
    {
        $userAgent = UserAgent::toString();
        self::assertStringStartsWith('AlibabaCloud', $userAgent);
    }

    public static function testUserAgentStringWithAppend()
    {
        $userAgent = UserAgent::toString([
                                             'Append'  => '1.0.0',
                                             'Append2' => '2.0.0',
                                             'PHP'     => '2.0.0',
                                         ]);

        self::assertStringStartsWith('AlibabaCloud', $userAgent);
        self::assertStringEndsWith('Append/1.0.0 Append2/2.0.0', $userAgent);
    }

    public static function testUserAgentAppend()
    {
        UserAgent::append('Append', '1.0.0');
        $userAgent = UserAgent::toString();
        self::assertStringEndsWith('Append/1.0.0', $userAgent);
    }

    public static function testUserAgentWith()
    {
        UserAgent::with([
                            'Append'  => '1.0.0',
                            'Append2' => '2.0.0',
                        ]);
        $userAgent = UserAgent::toString();
        self::assertStringEndsWith('Append/1.0.0 Append2/2.0.0', $userAgent);
    }

    /**
     * @throws ClientException
     */
    public static function testGuard()
    {
        UserAgent::append('PHP', '7.3');
        self::assertStringEndsNotWith('PHP/7.3', UserAgent::toString());
        UserAgent::append('Client', '1.0.0');
        self::assertStringEndsNotWith('Client/1.0.0', UserAgent::toString());
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Name cannot be empty
     */
    public static function testGuardWithNameEmpty()
    {
        UserAgent::append('', '7.3');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Name must be a string
     */
    public static function testGuardWithNameFormat()
    {
        UserAgent::append(null, '7.3');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Value cannot be empty
     */
    public static function testGuardWithValueEmpty()
    {
        UserAgent::append('PHP', '');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Value must be a string
     */
    public static function testGuardWithValueFormat()
    {
        UserAgent::append('PHP', null);
    }

    /**
     * @throws ClientException
     */
    public static function testAppendGlobalUserAgent()
    {
        AlibabaCloud::appendUserAgent('cli', '1.0.0');
        AlibabaCloud::appendUserAgent('cmp', 'fit2cloud');
        self::assertStringEndsWith('cli/1.0.0 cmp/fit2cloud', UserAgent::toString());
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Name cannot be empty
     */
    public static function testAppendUserAgentWithNameEmpty()
    {
        AlibabaCloud::appendUserAgent('', '1.0.0');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Name must be a string
     */
    public static function testAppendUserAgentWithNameFormat()
    {
        AlibabaCloud::appendUserAgent(null, '1.0.0');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Value cannot be empty
     */
    public static function testAppendUserAgentWithValueEmpty()
    {
        AlibabaCloud::appendUserAgent('cli', '');
    }

    /**
     * @throws ClientException
     * @expectedException \AlibabaCloud\Client\Exception\ClientException
     * @expectedExceptionMessage Value must be a string
     */
    public static function testAppendUserAgentWithValueFormat()
    {
        AlibabaCloud::appendUserAgent('cli', null);
    }

    public static function testWithGlobalUserAgent()
    {
        AlibabaCloud::withUserAgent([
                                        'Append'  => '1.0.0',
                                        'Append2' => '2.0.0',
                                    ]);

        self::assertStringEndsWith('Append/1.0.0 Append2/2.0.0', UserAgent::toString());

        AlibabaCloud::withUserAgent([]);

        self::assertStringEndsWith('PHP/' . PHP_VERSION, UserAgent::toString());
    }

    /**
     * @throws ClientException
     */
    public static function testAppendForRequest()
    {
        AlibabaCloud::appendUserAgent('cli', '1.0.0');

        $request = new RpcRequest();
        $request->appendUserAgent('cmp', 'fit2cloud');

        // Execution request to get UA information, expected exception.
        try {
            $request->request();
        } catch (\Exception $exception) {
        }

        self::assertStringEndsWith('cli/1.0.0 cmp/fit2cloud', $request->options['headers']['User-Agent']);
        self::assertStringEndsWith('cli/1.0.0', UserAgent::toString());
    }

    /**
     * @throws ClientException
     */
    public static function testWithForRequest()
    {
        AlibabaCloud::appendUserAgent('cli', '1.0.0');
        $request = new RpcRequest();
        $request->withUserAgent([
                                    'Append'  => '1.0.0',
                                    'Append2' => '2.0.0',
                                ]);

        // Execution request to get UA information, expected exception.
        try {
            $request->request();
        } catch (\Exception $exception) {
        }

        self::assertStringEndsWith(
            'cli/1.0.0 Append/1.0.0 Append2/2.0.0',
            $request->options['headers']['User-Agent']
        );
        self::assertStringEndsWith('cli/1.0.0', UserAgent::toString());
    }

    /**
     * @throws ClientException
     */
    public static function testRequestFirst()
    {
        AlibabaCloud::appendUserAgent('cli', '1.0.0');
        $request = new RpcRequest();
        $request->withUserAgent([
                                    'Append' => '1.0.0',
                                    'cli'    => '2.0.0',
                                ]);

        // Execution request to get UA information, expected exception.
        try {
            $request->request();
        } catch (\Exception $exception) {
        }

        self::assertStringEndsWith(
            'cli/2.0.0 Append/1.0.0',
            $request->options['headers']['User-Agent']
        );
        self::assertStringEndsWith('cli/1.0.0', UserAgent::toString());
    }

    public static function testNull()
    {
        AlibabaCloud::withUserAgent([
                                        'Append' => null,
                                    ]);

        self::assertStringEndsWith('Append', UserAgent::toString());
    }

    protected function tearDown()
    {
        UserAgent::clear();
    }
}