Unit-tests

Dockerfile

@@ -1,13 +1,23 @@
 # Use an official PHP image as the base image
 FROM php:8.1-cli
 
-# Install necessary extensions (e.g., for Composer)
-RUN apt-get update && apt-get install -y libpng-dev libjpeg-dev libfreetype6-dev git libzip-dev zip \
+RUN apt-get update && \
+    apt-get install -y \
+      libpng-dev \
+      libjpeg-dev \
+      libfreetype6-dev \
+      git \
+      libzip-dev \
+      zip \
     && docker-php-ext-configure gd --with-freetype --with-jpeg \
     && docker-php-ext-install gd zip
 
+RUN pecl install xdebug pcov && docker-php-ext-enable xdebug pcov
+
+# Configure Xdebug for coverage
+# RUN echo "xdebug.mode=coverage" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
 # Set working directory
 WORKDIR /var/www
 
-# Copy the composer.phar file to the container
 COPY --from=composer:latest /usr/bin/composer /usr/bin/composer

phpunit.dist.xml

@@ -7,6 +7,12 @@
         </testsuite>
     </testsuites>
 
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+
 <!--
     &lt;!&ndash; Logging &ndash;&gt;
     <logging>

src/Configuration.php

@@ -6,7 +6,7 @@
 use Neo4j\QueryAPI\Objects\Bookmarks;
 use Neo4j\QueryAPI\Enums\AccessMode;
 
-final class Configuration
+class Configuration
 {
     /**
      * Constructor for Configuration class.

src/Objects/Authentication.php

@@ -14,9 +14,6 @@ class Authentication
 {
     public static function basic(string $username, string $password): AuthenticateInterface
     {
-        $username = $username ?: 'defaultUsername';
-        $password = $password ?: 'defaultPassword';
-
         return new BasicAuthentication($username, $password);
     }
 
@@ -32,9 +29,6 @@ public static function fromEnvironment(): AuthenticateInterface
         );
     }
 
-
-
-
     public static function noAuth(): AuthenticateInterface
     {
         return new NoAuth();

src/Objects/Node.php

@@ -22,7 +22,7 @@ class Node
     private array $properties;
 
     /**
-     * Node constructor.
+     * Node constructor
      *
      * @param string[] $labels Array of labels for the node.
      * @param array<string, mixed> $properties Associative array of properties.

src/ResponseParser.php

@@ -14,7 +14,7 @@
 use Neo4j\QueryAPI\Objects\ProfiledQueryPlan;
 use Neo4j\QueryAPI\Objects\Point;
 
-final class ResponseParser
+class ResponseParser
 {
     public function __construct(private readonly OGM $ogm)
     {

tests/Unit/Authentication/BasicAuthenticationUnitTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\Authentication;
+
+use Neo4j\QueryAPI\Authentication\BasicAuthentication;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
+
+final class BasicAuthenticationUnitTest extends TestCase
+{
+    private BasicAuthentication $auth;
+    private MockObject $requestMock;
+
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->auth = new BasicAuthentication('testUser', 'testPass');
+        $this->requestMock = $this->createMock(RequestInterface::class);
+    }
+
+    public function testAuthenticateAddsAuthorizationHeader(): void
+    {
+        $authHeader = 'Basic ' . base64_encode('testUser:testPass');
+
+        $this->requestMock->expects($this->once())
+            ->method('withHeader')
+            ->with('Authorization', $authHeader)
+            ->willReturn($this->requestMock);
+
+        $result = $this->auth->authenticate($this->requestMock);
+        $this->assertSame($this->requestMock, $result);
+    }
+
+    public function testGetHeaderReturnsCorrectValue(): void
+    {
+        $expectedHeader = 'Basic ' . base64_encode('testUser:testPass');
+        $this->assertEquals($expectedHeader, $this->auth->getHeader());
+    }
+
+    public function testGetTypeReturnsBasic(): void
+    {
+        $this->assertEquals('Basic', $this->auth->getType());
+    }
+}

tests/Unit/Authentication/BearerAuthenticationUnitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\Authentication;
+
+use Neo4j\QueryAPI\Authentication\BearerAuthentication;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
+
+final class BearerAuthenticationUnitTest extends TestCase
+{
+    private BearerAuthentication $auth;
+    private RequestInterface $requestMock;
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->auth = new BearerAuthentication('testToken');
+        $this->requestMock = $this->createMock(RequestInterface::class);
+    }
+
+    public function testAuthenticateAddsAuthorizationHeader(): void
+    {
+        $authHeader = 'Bearer testToken';
+
+        $this->requestMock->expects($this->once())
+            ->method('withHeader')
+            ->with('Authorization', $authHeader)
+            ->willReturnSelf();
+
+        $result = $this->auth->authenticate($this->requestMock);
+        $this->assertSame($this->requestMock, $result);
+    }
+
+    public function testGetHeaderReturnsCorrectValue(): void
+    {
+        $expectedHeader = 'Bearer testToken';
+        $this->assertEquals($expectedHeader, $this->auth->getHeader());
+    }
+
+    public function testGetTypeReturnsBearer(): void
+    {
+        $this->assertEquals('Bearer', $this->auth->getType());
+    }
+}

tests/Unit/Authentication/NoAuthUnitTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\Authentication;
+
+use Neo4j\QueryAPI\Authentication\NoAuth;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
+
+final class NoAuthUnitTest extends TestCase
+{
+    private NoAuth $auth;
+    private RequestInterface $requestMock;
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->auth = new NoAuth();
+        $this->requestMock = $this->createMock(RequestInterface::class);
+    }
+
+    public function testAuthenticateReturnsUnmodifiedRequest(): void
+    {
+
+        $this->assertSame($this->requestMock, $this->auth->authenticate($this->requestMock));
+    }
+
+    public function testGetHeaderReturnsEmptyString(): void
+    {
+        $this->assertEquals('', $this->auth->getHeader());
+    }
+
+    public function testGetTypeReturnsNoAuth(): void
+    {
+        $this->assertEquals('NoAuth', $this->auth->getType());
+    }
+}

tests/Unit/objects/AuthenticationUnitTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\objects;
+
+use Neo4j\QueryAPI\Objects\Authentication;
+use Neo4j\QueryAPI\Authentication\BasicAuthentication;
+use Neo4j\QueryAPI\Authentication\BearerAuthentication;
+use Neo4j\QueryAPI\Authentication\NoAuth;
+use PHPUnit\Framework\TestCase;
+
+final class AuthenticationUnitTest extends TestCase
+{
+    public function testBasicReturnsBasicAuthenticationInstance(): void
+    {
+        $auth = Authentication::basic('testUser', 'testPass');
+        $this->assertInstanceOf(BasicAuthentication::class, $auth);
+    }
+
+    public function testFromEnvironmentReturnsBasicAuthenticationInstance(): void
+    {
+        putenv('NEO4J_USERNAME=testUser');
+        putenv('NEO4J_PASSWORD=testPass');
+
+        $auth = Authentication::fromEnvironment();
+        $this->assertInstanceOf(BasicAuthentication::class, $auth);
+    }
+
+    public function testNoAuthReturnsNoAuthInstance(): void
+    {
+        $auth = Authentication::noAuth();
+        $this->assertInstanceOf(NoAuth::class, $auth);
+    }
+
+    public function testBearerReturnsBearerAuthenticationInstance(): void
+    {
+        $auth = Authentication::bearer('testToken');
+        $this->assertInstanceOf(BearerAuthentication::class, $auth);
+    }
+}

tests/Unit/objects/BookmarksUnitTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\objects;
+
+use Neo4j\QueryAPI\Objects\Bookmarks;
+use PHPUnit\Framework\TestCase;
+
+final class BookmarksUnitTest extends TestCase
+{
+    private Bookmarks $bookmarks;
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->bookmarks = new Bookmarks(['bookmark1', 'bookmark2']);
+    }
+
+    public function testGetBookmarksReturnsCorrectArray(): void
+    {
+        $this->assertEquals(['bookmark1', 'bookmark2'], $this->bookmarks->getBookmarks());
+    }
+
+    public function testAddBookmarksMergesUniqueValues(): void
+    {
+        $newBookmarks = new Bookmarks(['bookmark1', 'bookmark2', 'bookmark3']);
+        $this->bookmarks->addBookmarks($newBookmarks);
+
+        $this->assertEquals(['bookmark1', 'bookmark2', 'bookmark3'], array_values($this->bookmarks->getBookmarks()));
+    }
+
+    public function testAddBookmarksDoesNothingWhenNullIsPassed(): void
+    {
+        $this->bookmarks->addBookmarks(null);
+        $this->assertEquals(['bookmark1', 'bookmark2'], $this->bookmarks->getBookmarks());
+    }
+
+    public function testCountReturnsCorrectNumber(): void
+    {
+        $this->assertEquals(2, $this->bookmarks->count());
+    }
+
+    public function testJsonSerializeReturnsCorrectArray(): void
+    {
+        $this->assertEquals(['bookmark1', 'bookmark2'], $this->bookmarks->jsonSerialize());
+    }
+}

tests/Unit/objects/NodeUnitTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\objects;
+
+use Neo4j\QueryAPI\Objects\Node;
+use PHPUnit\Framework\TestCase;
+
+final class NodeUnitTest extends TestCase
+{
+    private Node $node;
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->node = new Node(['Label1', 'Label2'], ['key1' => 'value1', 'key2' => 42]);
+    }
+
+    public function testGetLabelsReturnsCorrectArray(): void
+    {
+        $this->assertEquals(['Label1', 'Label2'], $this->node->getLabels());
+    }
+
+    public function testGetPropertiesReturnsCorrectArray(): void
+    {
+        $this->assertEquals(['key1' => 'value1', 'key2' => 42], $this->node->getProperties());
+    }
+
+    public function testToArrayReturnsCorrectStructure(): void
+    {
+        $expected = [
+            '_labels' => ['Label1', 'Label2'],
+            '_properties' => ['key1' => 'value1', 'key2' => 42],
+        ];
+
+        $this->assertEquals($expected, $this->node->toArray());
+    }
+}

tests/Unit/objects/PathUnitTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Neo4j\QueryAPI\Tests\Unit\objects;
+
+use Neo4j\QueryAPI\Objects\Path;
+use Neo4j\QueryAPI\Objects\Node;
+use Neo4j\QueryAPI\Objects\Relationship;
+use PHPUnit\Framework\TestCase;
+
+final class PathUnitTest extends TestCase
+{
+    private Path $path;
+    private array $nodes;
+    private array $relationships;
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->nodes = [
+            new Node(['Person'], ['name' => 'Alice']),
+            new Node(['Person'], ['name' => 'Bob'])
+        ];
+
+        $this->relationships = [
+            new Relationship('KNOWS', ['since' => 2020])
+        ];
+
+        $this->path = new Path($this->nodes, $this->relationships);
+    }
+
+    public function testGetNodesReturnsCorrectArray(): void
+    {
+        $this->assertEquals($this->nodes, $this->path->getNodes());
+    }
+
+    public function testGetRelationshipsReturnsCorrectArray(): void
+    {
+        $this->assertEquals($this->relationships, $this->path->getRelationships());
+    }
+}