Add authentication support for WireMock Cloud (wiremock.io)

src/WireMock/Client/Authentication/Authenticator.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace WireMock\Client\Authentication;
+
+interface Authenticator
+{
+    /**
+     * @param list<non-empty-string> $headers
+     * @return list<non-empty-string>
+     */
+    public function modifyHeaders(array $headers): array;
+
+    /**
+     * @param non-empty-string $url
+     * @return non-empty-string
+     */
+    public function modifyUrl(string $url): string;
+}

src/WireMock/Client/Authentication/NullAuthenticator.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace WireMock\Client\Authentication;
+
+final class NullAuthenticator implements Authenticator
+{
+    public function modifyHeaders(array $headers): array
+    {
+        return $headers;
+    }
+
+    public function modifyUrl(string $url): string
+    {
+        return $url;
+    }
+}

src/WireMock/Client/Authentication/TokenAuthenticator.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace WireMock\Client\Authentication;
+
+final class TokenAuthenticator implements Authenticator
+{
+    /**
+     * @var non-empty-string
+     */
+    private $token;
+
+    /**
+     * @param non-empty-string $token
+     */
+    public function __construct(string $token)
+    {
+        $this->token = $token;
+    }
+
+    public function modifyHeaders(array $headers): array
+    {
+        return array_merge($headers, [sprintf('Authorization: Token %s', $this->token)]);
+    }
+
+    public function modifyUrl(string $url): string
+    {
+        return $url;
+    }
+}

src/WireMock/Client/Curl.php

@@ -2,8 +2,21 @@
 
 namespace WireMock\Client;
 
+use WireMock\Client\Authentication\Authenticator;
+use WireMock\Client\Authentication\NullAuthenticator;
+
 class Curl
 {
+    /**
+     * @var Authenticator
+     */
+    private $authenticator;
+
+    public function __construct(?Authenticator $authenticator = null)
+    {
+        $this->authenticator = $authenticator ?? new NullAuthenticator();
+    }
+
     /**
      * @param string $url
      * @return string The response body
@@ -51,7 +64,7 @@ public function delete(string $url): string
      */
     private function makeCurlRequest(string $method, string $url, ?string $json = null)
     {
-        $ch = curl_init($url);
+        $ch = curl_init($this->authenticator->modifyUrl($url));
         curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
         if ($json !== null) {
             curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
@@ -60,10 +73,12 @@ private function makeCurlRequest(string $method, string $url, ?string $json = nu
             $contentLength = 0;
         }
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
+
+        $defaultHeaders = [
             'Content-Type: application/json',
-            "Content-Length: $contentLength",
-        ));
+            sprintf('Content-Length: %s', $contentLength),
+        ];
+        curl_setopt($ch, CURLOPT_HTTPHEADER, $this->authenticator->modifyHeaders($defaultHeaders));
 
         $result = curl_exec($ch);
 

src/WireMock/Client/HttpWait.php

@@ -4,33 +4,35 @@
 
 class HttpWait
 {
+    /**
+     * @var Curl
+     */
+    private $curl;
+
+    public function __construct(?Curl $curl = null)
+    {
+        $this->curl = $curl ?? new Curl();
+    }
+
     public function waitForServerToGive200($url, $timeoutSecs = 10, $debug = true)
     {
         $debugTrace = array();
         $startTime = microtime(true);
         $serverStarted = false;
         while (microtime(true) - $startTime < $timeoutSecs) {
             try {
-                $headers = @get_headers($url, 1);
-            } catch (\Exception $e) {
-                $debugTrace[] = "$url not yet up. Error getting headers: " . $e->getMessage();
-                continue;
-            }
-
-            if (isset($headers) && isset($headers[0]) && strpos($headers[0], '200 OK') !== false) {
+                $this->curl->get($url);
                 $serverStarted = true;
                 break;
-            } else {
-                if (!isset($headers)) {
-                    $debugTrace[] = "$url not yet up. \$headers not set";
-                } else if (!isset($headers[0])) {
-                    $debugTrace[] = "$url not yet up. \$headers[0] not set";
-                } else {
-                    $debugTrace[] = "$url not yet up. \$headers[0] was {$headers[0]}";
-                }
+            } catch (\Exception $e) {
+                $debugTrace[] = "$url not yet up. " . $e->getMessage();
+
+                usleep(100000);
+
+                continue;
             }
-            usleep(100000);
         }
+
         if (!$serverStarted) {
             $time = microtime(true) - $startTime;
             if ($debug) {

src/WireMock/Client/LogicalOperatorMatchingStrategy.php

@@ -30,4 +30,4 @@ public static function orAll(...$matchers): LogicalOperatorMatchingStrategy
     {
         return new self("or", $matchers);
     }
-}
+}

src/WireMock/Client/WireMock.php

@@ -24,6 +24,8 @@ class WireMock
     private $hostname;
     /** @var int */
     private $port;
+    /** @var string */
+    private $scheme;
     /** @var HttpWait */
     private $httpWait;
     /** @var Curl  */
@@ -45,13 +47,15 @@ public function __construct(
         Curl $curl,
         Serializer $serializer,
         $hostname = 'localhost',
-        $port = 8080
+        $port = 8080,
+        $scheme = 'http'
     ) {
-        $this->hostname = $hostname;
-        $this->port = $port;
         $this->httpWait = $httpWait;
         $this->curl = $curl;
         $this->serializer = $serializer;
+        $this->hostname = $hostname;
+        $this->port = $port;
+        $this->scheme = $scheme;
     }
 
     public function isAlive($timeoutSecs = 10, $debug = true)
@@ -98,11 +102,11 @@ public function importStubs($stubImportsOrBuilder)
 
     /**
      * @param RequestPatternBuilder|CountMatchingStrategy|integer $requestPatternBuilderOrCount
-     * @param RequestPatternBuilder|null $requestPatternBuilder
+     * @param ?RequestPatternBuilder $requestPatternBuilder
      * @throws ClientException
      * @throws VerificationException
      */
-    public function verify($requestPatternBuilderOrCount, RequestPatternBuilder $requestPatternBuilder = null)
+    public function verify($requestPatternBuilderOrCount, ?RequestPatternBuilder $requestPatternBuilder = null)
     {
         if ($requestPatternBuilderOrCount instanceof CountMatchingStrategy) {
             $patternBuilder = $requestPatternBuilder;
@@ -506,9 +510,9 @@ private function doDelete(string $path, ?string $resultType = null)
         }
     }
 
-    private function _makeUrl($path)
+    private function _makeUrl($path): string
     {
-        return "http://$this->hostname:$this->port/$path";
+        return sprintf('%s://%s:%d/%s', $this->scheme, $this->hostname, $this->port, $path);
     }
 
     /**

src/WireMock/Serde/PropNaming/ReferencingPropertyNamingStrategy.php

@@ -4,6 +4,7 @@
 
 use ReflectionException;
 use ReflectionMethod;
+use WireMock\Serde\ReflectionUtils;
 use WireMock\Serde\SerializationException;
 use WireMock\Serde\StaticFactoryMethodValidator;
 
@@ -47,8 +48,8 @@ function getSerializedName(array $data): string
      */
     function getPossibleSerializedNames(): array
     {
-        $refMethod = new ReflectionMethod($this->possibleNamesGenerator);
+        $refMethod = ReflectionUtils::reflectMethod($this->possibleNamesGenerator);
         $refMethod->setAccessible(true);
         return $refMethod->invoke(null);
     }
-}
+}

src/WireMock/Serde/ReflectionUtils.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace WireMock\Serde;
+
+
+use ReflectionMethod;
+
+final class ReflectionUtils
+{
+    public static function reflectMethod(string $methodName): ReflectionMethod
+    {
+        if (PHP_VERSION_ID >= 80300) {
+            $refMethod = ReflectionMethod::createFromMethodName($methodName);
+        } else {
+            $refMethod = new ReflectionMethod($methodName);
+        }
+
+        return $refMethod;
+    }
+}

src/WireMock/Serde/SerdeClassDiscriminationInfo.php

@@ -36,7 +36,7 @@ public function __construct(string $discriminatorFactoryName, array $possibleSer
      */
     public function getDiscriminator(): ?ClassDiscriminator
     {
-        $refMethod = new ReflectionMethod($this->discriminatorFactoryName);
+        $refMethod = ReflectionUtils::reflectMethod($this->discriminatorFactoryName);
         $refMethod->setAccessible(true);
         return $refMethod->invoke(null);
     }
@@ -51,4 +51,4 @@ public function getTypeByFullyQualifiedClassName(string $fqn): SerdeTypeClass
         }
         return $this->possibleSerdeTypes[$fqn];
     }
-}
+}

src/WireMock/Serde/SerdeProp.php

@@ -38,7 +38,7 @@ public function __construct(
         string $name,
         string $owningClassName,
         SerdeType $serdeType,
-        PropertyNamingStrategy $propertyNamingStrategy = null,
+        ?PropertyNamingStrategy $propertyNamingStrategy = null,
         bool $unwrapped = false,
         bool $catchAll = false
     )
@@ -105,4 +105,4 @@ public function getPotentiallyNullableSerdeTypeClassOrThrow(): SerdeTypeClass {
         }
         throw new SerializationException("Cannot get SerdeTypeClass for prop $this->name because it is of type " . $this->serdeType->displayName());
     }
-}
+}

src/WireMock/Serde/StaticFactoryMethodValidator.php

@@ -12,7 +12,7 @@ class StaticFactoryMethodValidator
      * @throws SerializationException
      */
     public static function validate($fqMethodName) {
-        $refMethod = new ReflectionMethod($fqMethodName);
+        $refMethod = ReflectionUtils::reflectMethod($fqMethodName);
         if (!$refMethod->isStatic()) {
             throw new SerializationException("$fqMethodName must be a static method but is not");
         }
@@ -21,4 +21,4 @@ public static function validate($fqMethodName) {
             throw new SerializationException("$fqMethodName must take no required args, but requires $numRequiredParams");
         }
     }
-}
+}

test/WireMock/Integration/CloudIntegrationTest.php

@@ -0,0 +1,27 @@
+<?php
+namespace WireMock\Integration;
+
+use PHPUnit\Framework\TestCase;
+use WireMock\Client\Authentication\TokenAuthenticator;
+use WireMock\Client\Curl;
+use WireMock\Client\HttpWait;
+use WireMock\Client\WireMock;
+use WireMock\Serde\SerializerFactory;
+
+class CloudIntegrationTest extends TestCase
+{
+    public function testConnectToCloudHost(): void
+    {
+        $wiremockCloudHost = getenv('WIREMOCK_CLOUD_HOST');
+        $wiremockCloudToken = getenv('WIREMOCK_CLOUD_TOKEN');
+
+        if ($wiremockCloudToken === false || $wiremockCloudHost === false) {
+            self::markTestSkipped('Env variables WIREMOCK_CLOUD_HOST or WIREMOCK_CLOUD_TOKEN not set');
+        }
+
+        $curl = new Curl(new TokenAuthenticator($wiremockCloudToken));
+        $client = new WireMock(new HttpWait($curl), $curl, SerializerFactory::default(), $wiremockCloudHost, 443, 'https');
+
+        self::assertTrue($client->isAlive());
+    }
+}