Merge pull request #65 from regnerisch/master

jasonbosco · web-flow · commit 3353573349ca · 2024-06-17T20:55:25.000-05:00
Adding tests for typesense-php
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 .idea
 .tmp
+.phpunit.result.cache
 /composer.lock
+phpunit.xml
 vendor
diff --git a/README.md b/README.md
@@ -49,6 +49,14 @@ Run Typesense Server:
 composer run-script typesenseServer
 ```
 
+Run tests:
+
+```shell script
+docker compose up
+cp phpunit.xml.dist phpunit.xml
+composer run-script test
+```
+
 ## Credits
 
 This client was originally developed by [Abdullah Al-Faqeir](https://github.org/abdullahfaqeir) from 
diff --git a/composer.json b/composer.json
@@ -29,6 +29,11 @@
       "Typesense\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
   "require": {
     "php": ">=7.4",
     "ext-json": "*",
@@ -42,6 +47,7 @@
     "psr/http-factory": "^1.0"
   },
   "require-dev": {
+    "phpunit/phpunit": "^11.2",
     "squizlabs/php_codesniffer": "3.*",
     "symfony/http-client": "^5.2"
   },
@@ -57,6 +63,7 @@
       "Composer\\Config::disableProcessTimeout",
       "docker-compose up"
     ],
+    "test": "vendor/bin/phpunit",
     "lint": "phpcs -v",
     "lint:fix": "phpcbf"
   }
diff --git a/examples/collection_operations.php b/examples/collection_operations.php
@@ -194,7 +194,7 @@
     echo "--------Delete Document-------\n";
     echo "\n";
     echo "--------Import Documents-------\n";
-    $docsToImport = [];
+    $docsToImport         = [];
     $exportedDocStrsArray = explode('\n', $exportedDocStrs);
     foreach ($exportedDocStrsArray as $exportedDocStr) {
         $docsToImport[] = json_decode($exportedDocStr, true);
diff --git a/phpcs.xml b/phpcs.xml
@@ -5,6 +5,7 @@
 
     <file>src</file>
     <file>examples</file>
+    <file>tests/</file>
 
     <exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
     <exclude-pattern>*/tests/Core/*/*\.(inc|css|js)$</exclude-pattern>
@@ -42,4 +43,4 @@
             </property>
         </properties>
     </rule>
-</ruleset>
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+>
+    <testsuites>
+        <testsuite name="feature">
+            <directory>tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <env name="TYPESENSE_NODE_HOST" value="host.docker.internal" />
+        <env name="TYPESENSE_NODE_PORT" value="8108" />
+        <env name="TYPESENSE_NODE_PROTOCOL" value="http" />
+        <env name="TYPESENSE_API_KEY" value="xyz" />
+    </php>
+</phpunit>
diff --git a/src/Alias.php b/src/Alias.php
@@ -14,7 +14,6 @@
  */
 class Alias
 {
-
     /**
      * @var string
      */
diff --git a/src/Aliases.php b/src/Aliases.php
@@ -14,7 +14,6 @@
  */
 class Aliases implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = '/aliases';
 
     /**
diff --git a/src/AnalyticsRule.php b/src/AnalyticsRule.php
@@ -10,7 +10,7 @@ class AnalyticsRule
     public function __construct(string $ruleName, ApiCall $apiCall)
     {
         $this->ruleName = $ruleName;
-        $this->apiCall = $apiCall;
+        $this->apiCall  = $apiCall;
     }
 
     public function retrieve()
diff --git a/src/ApiCall.php b/src/ApiCall.php
@@ -29,7 +29,6 @@
  */
 class ApiCall
 {
-
     private const API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY';
 
     /**
diff --git a/src/Client.php b/src/Client.php
@@ -92,7 +92,7 @@ public function __construct(array $config)
         $this->apiCall = new ApiCall($this->config);
 
         $this->collections = new Collections($this->apiCall);
-        $this->stopwords = new Stopwords($this->apiCall);
+        $this->stopwords   = new Stopwords($this->apiCall);
         $this->aliases     = new Aliases($this->apiCall);
         $this->keys        = new Keys($this->apiCall);
         $this->debug       = new Debug($this->apiCall);
diff --git a/src/Collections.php b/src/Collections.php
@@ -14,7 +14,6 @@
  */
 class Collections implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = '/collections';
 
     /**
diff --git a/src/Document.php b/src/Document.php
@@ -14,7 +14,6 @@
  */
 class Document
 {
-
     /**
      * @var string
      */
diff --git a/src/Documents.php b/src/Documents.php
@@ -14,7 +14,6 @@
  */
 class Documents implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = 'documents';
 
     /**
diff --git a/src/Exceptions/ConfigError.php b/src/Exceptions/ConfigError.php
@@ -11,5 +11,4 @@
  */
 class ConfigError extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/HTTPStatus0Error.php b/src/Exceptions/HTTPStatus0Error.php
@@ -10,5 +10,4 @@
  */
 class HTTPStatus0Error extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/ObjectAlreadyExists.php b/src/Exceptions/ObjectAlreadyExists.php
@@ -11,5 +11,4 @@
  */
 class ObjectAlreadyExists extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/ObjectNotFound.php b/src/Exceptions/ObjectNotFound.php
@@ -11,5 +11,4 @@
  */
 class ObjectNotFound extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/ObjectUnprocessable.php b/src/Exceptions/ObjectUnprocessable.php
@@ -11,5 +11,4 @@
  */
 class ObjectUnprocessable extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/RequestMalformed.php b/src/Exceptions/RequestMalformed.php
@@ -11,5 +11,4 @@
  */
 class RequestMalformed extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/RequestUnauthorized.php b/src/Exceptions/RequestUnauthorized.php
@@ -11,5 +11,4 @@
  */
 class RequestUnauthorized extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/ServerError.php b/src/Exceptions/ServerError.php
@@ -11,5 +11,4 @@
  */
 class ServerError extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/ServiceUnavailable.php b/src/Exceptions/ServiceUnavailable.php
@@ -11,5 +11,4 @@
  */
 class ServiceUnavailable extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/Timeout.php b/src/Exceptions/Timeout.php
@@ -11,5 +11,4 @@
  */
 class Timeout extends TypesenseClientError
 {
-
 }
diff --git a/src/Exceptions/TypesenseClientError.php b/src/Exceptions/TypesenseClientError.php
@@ -13,7 +13,6 @@
  */
 class TypesenseClientError extends Exception
 {
-
     public function setMessage(string $message): TypesenseClientError
     {
         $this->message = $message;
diff --git a/src/Key.php b/src/Key.php
@@ -14,7 +14,6 @@
  */
 class Key
 {
-
     /**
      * @var ApiCall
      */
diff --git a/src/Keys.php b/src/Keys.php
@@ -14,7 +14,6 @@
  */
 class Keys implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = '/keys';
 
     /**
@@ -59,15 +58,16 @@ public function generateScopedSearchKey(
         string $searchKey,
         array $parameters
     ): string {
-        $paramStr = json_encode($parameters, JSON_THROW_ON_ERROR);
-        $digest = base64_encode(
+        $paramStr     = json_encode($parameters, JSON_THROW_ON_ERROR);
+        $digest       = base64_encode(
             hash_hmac(
                 'sha256',
                 mb_convert_encoding($paramStr, 'UTF-8', 'ISO-8859-1'),
                 mb_convert_encoding($searchKey, 'UTF-8', 'ISO-8859-1'),
-                true)
+                true
+            )
         );
-        $keyPrefix = substr($searchKey, 0, 4);
+        $keyPrefix    = substr($searchKey, 0, 4);
         $rawScopedKey = sprintf(
             '%s%s%s',
             mb_convert_encoding($digest, 'ISO-8859-1', 'UTF-8'),
diff --git a/src/Lib/Configuration.php b/src/Lib/Configuration.php
@@ -20,7 +20,6 @@
  */
 class Configuration
 {
-
     /**
      * @var Node[]
      */
@@ -219,8 +218,8 @@ public function getClient(): ClientInterface
     {
         return new HttpMethodsClient(
             $this->client ?? Psr18ClientDiscovery::find(),
-                Psr17FactoryDiscovery::findRequestFactory(),
-                Psr17FactoryDiscovery::findStreamFactory(),
+            Psr17FactoryDiscovery::findRequestFactory(),
+            Psr17FactoryDiscovery::findStreamFactory(),
         );
     }
 }
diff --git a/src/Lib/Node.php b/src/Lib/Node.php
@@ -11,7 +11,6 @@
  */
 class Node
 {
-
     /**
      * @var string
      */
diff --git a/src/Override.php b/src/Override.php
@@ -14,7 +14,6 @@
  */
 class Override
 {
-
     /**
      * @var string
      */
diff --git a/src/Overrides.php b/src/Overrides.php
@@ -14,7 +14,6 @@
  */
 class Overrides implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = 'overrides';
 
     /**
diff --git a/src/Presets.php b/src/Presets.php
@@ -63,7 +63,7 @@ public function get()
      */
     public function put(array $options = [])
     {
-        $presetName = $options['preset_name'];
+        $presetName  = $options['preset_name'];
         $presetsData = $options['preset_data'];
 
         return $this->apiCall->put($this->endpointPath($presetName), $presetsData);
diff --git a/src/Synonym.php b/src/Synonym.php
@@ -12,7 +12,6 @@
  */
 class Synonym
 {
-
     /**
      * @var string
      */
diff --git a/src/Synonyms.php b/src/Synonyms.php
@@ -12,7 +12,6 @@
  */
 class Synonyms implements \ArrayAccess
 {
-
     public const RESOURCE_PATH = 'synonyms';
 
     /**
diff --git a/tests/Feature/CollectionTest.php b/tests/Feature/CollectionTest.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Feature;
+
+use Tests\TestCase;
+use Typesense\Exceptions\ObjectNotFound;
+
+class CollectionTest extends TestCase
+{
+    public function testCanCreateCollection(): void
+    {
+        $schema = $this->getSchema('books');
+
+        $response = $this->client()->collections->create($schema);
+
+        $this->assertEquals('books', $response['name']);
+    }
+
+    public function testCanRetrieveCollection(): void
+    {
+        $schema = $this->getSchema('books');
+        $this->client()->collections->create($schema);
+
+        $response = $this->client()->collections['books']->retrieve();
+
+        $this->assertEquals('books', $response['name']);
+    }
+
+    public function testCanDeleteCollection(): void
+    {
+        $schema = $this->getSchema('books');
+        $this->client()->collections->create($schema);
+
+        $this->client()->collections['books']->delete();
+
+        $this->expectException(ObjectNotFound::class);
+
+        $this->client()->collections['books']->retrieve();
+    }
+}
diff --git a/tests/Feature/DocumentsTest.php b/tests/Feature/DocumentsTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/data/books.data.json b/tests/data/books.data.json
diff --git a/tests/data/books.schema.json b/tests/data/books.schema.json

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`*/`
`15`	`15`	`class Alias`
`16`	`16`	`{`
`17`		`-`
`18`	`17`	`/**`
`19`	`18`	`* @var string`
`20`	`19`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class AnalyticsRule`
`10`	`10`	`public function __construct(string $ruleName, ApiCall $apiCall)`
`11`	`11`	`{`
`12`	`12`	`$this->ruleName = $ruleName;`
`13`		`- $this->apiCall = $apiCall;`
	`13`	`+ $this->apiCall = $apiCall;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`public function retrieve()`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,6 @@`
`29`	`29`	`*/`
`30`	`30`	`class ApiCall`
`31`	`31`	`{`
`32`		`-`
`33`	`32`	`private const API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY';`
`34`	`33`
`35`	`34`	`/**`