BaseTestCase.php

<?php

declare(strict_types=1);

namespace ShopifyTest;

use GuzzleHttp\Psr7\Response;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Client\ClientInterface;
use Shopify\ApiVersion;
use Shopify\Clients\HttpClientFactory;
use Shopify\Context;
use Shopify\Exception\HttpRequestException;
use ShopifyTest\Auth\MockSessionStorage;
use ShopifyTest\Clients\MockRequest;

define('RUNNING_SHOPIFY_TESTS', 1);

class BaseTestCase extends TestCase
{
    /**
     * API version to use for tests. Uses the latest available version.
     */
    protected const TEST_API_VERSION = ApiVersion::APRIL_2026;

    protected const TEST_API_SECRET = '7008c5f4da4718b9b45d26d3fcbbb157';
    protected const TEST_API_SECRET_ALT = 'b4f15c37e89a23d6c701f4e82a9d5f0b';

    /** @var string */
    protected $domain = 'test-shop.myshopify.io';
    /** @var string */
    protected $version;

    public function setUp(): void
    {
        // Initialize Context before each test
        Context::initialize(
            apiKey: 'ash',
            apiSecretKey: self::TEST_API_SECRET,
            scopes: ['sleepy', 'kitty'],
            hostName: 'www.my-friends-cats.com',
            sessionStorage: new MockSessionStorage(),
            apiVersion: self::TEST_API_VERSION,
        );
        Context::$RETRY_TIME_IN_SECONDS = 0;
        $this->version = require dirname(__FILE__) . '/../src/version.php';

        // Make sure we always mock the transport layer so we don't accidentally make real requests
        $this->mockTransportRequests([]);
    }

    /**
     * Builds a mock HTTP response that can optionally also validate the parameters of the cURL call.
     *
     * @param int|null          $statusCode The HTTP status code to return
     * @param string|array|null $body       The body of the HTTP response
     * @param array             $headers    The headers expected in the response
     * @param string|null       $error      The cURL error message to return
     *
     * @return array
     */
    protected function buildMockHttpResponse(
        ?int $statusCode = null,
        $body = null,
        array $headers = [],
        ?string $error = null
    ): array {
        if ($body && !is_string($body)) {
            $body = json_encode($body);
        }

        return [
            'statusCode' => $statusCode,
            'body' => $body,
            'headers' => $headers,
            'error' => $error,
        ];
    }

    /**
     * Sets up a transport layer mock that expects the given requests to happen.
     *
     * @param MockRequest[] $requests
     */
    public function mockTransportRequests(array $requests): void
    {
        $requestMatchers = [];
        $newResponses = [];
        foreach ($requests as $request) {
            $matcher = new HttpRequestMatcher(
                $request->url,
                $request->method,
                "/$request->userAgent/",
                $request->headers,
                $request->body ?? "",
                true,
                $request->identicalBody
            );

            $requestMatchers[] = $matcher;

            $newResponses[] = $request->error ? 'TEST EXCEPTION' : new Response(
                $request->response['statusCode'],
                $request->response['headers'],
                $request->response['body'],
            );
        }

        /** @var MockObject */
        $client = $this->createMock(ClientInterface::class);

        $i = 0;
        $client->expects($this->exactly(count($requestMatchers)))
            ->method('sendRequest')
            ->with(self::callback(function ($request) use (&$i, $requestMatchers) {
                return $requestMatchers[$i]->matches($request);
            }))
            ->willReturnCallback(
                function () use (&$i, $newResponses) {
                    $response = $newResponses[$i++];
                    if ($response === 'TEST EXCEPTION') {
                        throw new HttpRequestException();
                    } else {
                        return $response;
                    }
                }
            );

        /** @var MockObject */
        $factory = $this->createMock(HttpClientFactory::class);

        $factory->expects($this->any())
            ->method('client')
            ->willReturn($client);

        Context::$HTTP_CLIENT_FACTORY = $factory;
    }
}