Add a ClientSyncHandler spec.

Author: ChadSikorra

tests/spec/FreeDSx/Ldap/Protocol/ClientProtocolHandler/ClientSyncHandlerSpec.php

@@ -0,0 +1,154 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\FreeDSx\Ldap\Protocol\ClientProtocolHandler;
+
+use FreeDSx\Ldap\ClientOptions;
+use FreeDSx\Ldap\Control\Sync\SyncDoneControl;
+use FreeDSx\Ldap\Control\Sync\SyncRequestControl;
+use FreeDSx\Ldap\Entry\Entry;
+use FreeDSx\Ldap\Exception\RuntimeException;
+use FreeDSx\Ldap\LdapUrl;
+use FreeDSx\Ldap\Operation\Request\SyncRequest;
+use FreeDSx\Ldap\Operation\Response\SearchResultDone;
+use FreeDSx\Ldap\Operation\Response\SearchResultEntry;
+use FreeDSx\Ldap\Operation\Response\SearchResultReference;
+use FreeDSx\Ldap\Protocol\ClientProtocolHandler\ClientProtocolContext;
+use FreeDSx\Ldap\Protocol\ClientProtocolHandler\ClientSyncHandler;
+use FreeDSx\Ldap\Protocol\ClientProtocolHandler\RequestHandlerInterface;
+use FreeDSx\Ldap\Protocol\ClientProtocolHandler\ResponseHandlerInterface;
+use FreeDSx\Ldap\Protocol\LdapMessageRequest;
+use FreeDSx\Ldap\Protocol\LdapMessageResponse;
+use FreeDSx\Ldap\Protocol\Queue\ClientQueue;
+use PhpSpec\ObjectBehavior;
+use spec\FreeDSx\Ldap\TestFactoryTrait;
+
+class ClientSyncHandlerSpec extends ObjectBehavior
+{
+    use TestFactoryTrait;
+
+    public function it_is_initializable(): void
+    {
+        $this->shouldHaveType(ClientSyncHandler::class);
+    }
+
+
+    public function it_should_implement_ResponseHandlerInterface(): void
+    {
+        $this->shouldBeAnInstanceOf(ResponseHandlerInterface::class);
+    }
+
+    public function it_should_implement_RequestHandlerInterface(): void
+    {
+        $this->shouldBeAnInstanceOf(RequestHandlerInterface::class);
+    }
+
+    public function it_should_set_a_default_DN_for_a_request_that_has_none(
+        ClientProtocolContext $context,
+        LdapMessageResponse $response,
+        ClientQueue $queue,
+        LdapMessageRequest $message,
+        SyncRequest $request
+    ): void {
+        $queue->getMessage(1)->shouldBeCalled()->willReturn($response);
+        $queue->sendMessage($message)->shouldBeCalledOnce();
+
+        $message->getMessageId()->willReturn(1);
+        $message->getRequest()->willReturn($request);
+        $request->getBaseDn()->willReturn(null);
+
+        $context->messageToSend()->willReturn($message);
+        $context->getRequest()->willReturn($request);
+        $context->getQueue()->willReturn($queue);
+        $context->getOptions()->willReturn(
+            (new ClientOptions())
+                ->setBaseDn('cn=foo')
+        );
+
+        $request->setBaseDn('cn=foo')
+            ->shouldBeCalledOnce();
+
+        $this->handleRequest($context);
+    }
+
+
+    public function it_should_retrieve_results_until_it_receives_a_search_done_with_a_sync_done_control(
+        ClientQueue $queue,
+    ): void {
+        $messageTo = new LdapMessageRequest(
+            1,
+            new SyncRequest(),
+            new SyncRequestControl(),
+        );
+        $response = new LdapMessageResponse(
+            1,
+            new SearchResultEntry(new Entry('bar'))
+        );
+
+        $entries = [
+            new SearchResultEntry(new Entry('foo')),
+            new SearchResultEntry(new Entry('foo')),
+            new SearchResultEntry(new Entry('foo')),
+        ];
+        $referrals = [
+            new SearchResultReference(new LdapUrl('ldap://foo')),
+        ];
+
+        $queue->getMessage(1)->willReturn(
+            new LdapMessageResponse(1, $entries[0]),
+            new LdapMessageResponse(1, $entries[1]),
+            new LdapMessageResponse(1, $referrals[0]),
+            new LdapMessageResponse(1, $entries[2]),
+            new LdapMessageResponse(
+                1,
+                new SearchResultDone(
+                    0,
+                    'cn=foo',
+                    'bar'
+                ),
+                new SyncDoneControl('foo')
+            )
+        );
+
+        $queue->getMessage(1)
+            ->shouldBeCalledTimes(5);
+
+        $this->handleResponse(
+            $messageTo,
+            $response,
+            $queue,
+            new ClientOptions()
+        )->shouldBeLike(
+            $this::makeSearchResponseFromEntries(
+                dn: 'cn=foo',
+                diagnostic: 'bar',
+                controls: [
+                    new SyncDoneControl('foo'),
+                ]
+            )
+        );
+    }
+
+    public function it_should_throw_an_exception_if_a_sync_request_control_was_not_provided(ClientQueue $queue,): void
+    {
+        $this->shouldThrow(new RuntimeException(sprintf(
+            'Expected a "%s", but there is none.',
+            SyncRequestControl::class,
+        )))->during(
+            'handleResponse',
+            [
+                new LdapMessageRequest(
+                    1,
+                    new SyncRequest(),
+                ),
+                new LdapMessageResponse(
+                    1,
+                    new SearchResultEntry(new Entry('bar'))
+                ),
+                $queue,
+                new ClientOptions(),
+            ]
+        );
+    }
+}