Sabre\DAVServerTest Class Reference

This class may be used as a basis for other webdav-related unittests. More...

Inheritance diagram for Sabre\DAVServerTest:

Collaboration diagram for Sabre\DAVServerTest:

Public Member Functions
	setUp ()
	initializeEverything ()
	request ($request, $expectedStatus=null)
	Makes a request, and returns a response object. More...
	autoLogin ($userName)
	This function takes a username and sets the server in a state where this user is logged in, and no longer requires an authentication check. More...
	setUpTree ()
	Override this to provide your own Tree for your test-case. More...
	setUpBackends ()
	assertHttpStatus ($expectedStatus, HTTP\Request $req)

Protected Attributes
	$setupCalDAV = false
	$setupCardDAV = false
	$setupACL = false
	$setupCalDAVSharing = false
	$setupCalDAVScheduling = false
	$setupCalDAVSubscriptions = false
	$setupCalDAVICSExport = false
	$setupLocks = false
	$setupFiles = false
	$setupSharing = false
	$setupPropertyStorage = false
	$caldavCalendars = []
	An array with calendars. More...
	$caldavCalendarObjects = []
	$carddavAddressBooks = []
	$carddavCards = []
	$server
	$tree = []
	$caldavBackend
	$carddavBackend
	$principalBackend
	$locksBackend
	$propertyStorageBackend
	$caldavPlugin
	$carddavPlugin
	$aclPlugin
	$caldavSharingPlugin
	$caldavSchedulePlugin
	$authPlugin
	$locksPlugin
	$sharingPlugin
	$propertyStoragePlugin
	$autoLogin = null
	If this string is set, we will automatically log in the user with this name. More...

Detailed Description

This class may be used as a basis for other webdav-related unittests.

This class is supposed to provide a reasonably big framework to quickly get a testing environment running.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 19 of file DAVServerTest.php.

Member Function Documentation

assertHttpStatus()

Sabre\DAVServerTest::assertHttpStatus	(		$expectedStatus,
		HTTP\Request	$req
	)

Definition at line 299 of file DAVServerTest.php.

                                                                  {
 
        $resp = $this->request($req);
        $this->assertEquals((int)$expectedStatus, (int)$resp->status, 'Incorrect HTTP status received: ' . $resp->body);
 
    }

References $req.

autoLogin()

Sabre\DAVServerTest::autoLogin

(

$userName

)

This function takes a username and sets the server in a state where this user is logged in, and no longer requires an authentication check.

Parameters

string

$userName

Definition at line 218 of file DAVServerTest.php.

                                  {
        $authBackend = new DAV\Auth\Backend\Mock();
        $authBackend->setPrincipal('principals/' . $userName);
        $this->authPlugin = new DAV\Auth\Plugin($authBackend);
 
        // If the auth plugin already exists, we're removing its hooks:
        if ($oldAuth = $this->server->getPlugin('auth')) {
            $this->server->removeListener('beforeMethod', [$oldAuth, 'beforeMethod']);
        }
        $this->server->addPlugin($this->authPlugin);
 
        // This will trigger the actual login procedure
        $this->authPlugin->beforeMethod(new Request(), new Response());
    }

References $authBackend.

initializeEverything()

Sabre\DAVServerTest::initializeEverything

(

)

Definition at line 117 of file DAVServerTest.php.

                                    {
 
        $this->setUpBackends();
        $this->setUpTree();
 
        $this->server = new DAV\Server($this->tree);
        $this->server->sapi = new HTTP\SapiMock();
        $this->server->debugExceptions = true;
 
        if ($this->setupCalDAV) {
            $this->caldavPlugin = new CalDAV\Plugin();
            $this->server->addPlugin($this->caldavPlugin);
        }
        if ($this->setupCalDAVSharing || $this->setupSharing) {
            $this->sharingPlugin = new DAV\Sharing\Plugin();
            $this->server->addPlugin($this->sharingPlugin);
        }
        if ($this->setupCalDAVSharing) {
            $this->caldavSharingPlugin = new CalDAV\SharingPlugin();
            $this->server->addPlugin($this->caldavSharingPlugin);
        }
        if ($this->setupCalDAVScheduling) {
            $this->caldavSchedulePlugin = new CalDAV\Schedule\Plugin();
            $this->server->addPlugin($this->caldavSchedulePlugin);
        }
        if ($this->setupCalDAVSubscriptions) {
            $this->server->addPlugin(new CalDAV\Subscriptions\Plugin());
        }
        if ($this->setupCalDAVICSExport) {
            $this->caldavICSExportPlugin = new CalDAV\ICSExportPlugin();
            $this->server->addPlugin($this->caldavICSExportPlugin);
        }
        if ($this->setupCardDAV) {
            $this->carddavPlugin = new CardDAV\Plugin();
            $this->server->addPlugin($this->carddavPlugin);
        }
        if ($this->setupLocks) {
            $this->locksPlugin = new DAV\Locks\Plugin(
                $this->locksBackend
            );
            $this->server->addPlugin($this->locksPlugin);
        }
        if ($this->setupPropertyStorage) {
            $this->propertyStoragePlugin = new DAV\PropertyStorage\Plugin(
                $this->propertyStorageBackend
            );
            $this->server->addPlugin($this->propertyStoragePlugin);
        }
        if ($this->autoLogin) {
            $this->autoLogin($this->autoLogin);
        }
        if ($this->setupACL) {
            $this->aclPlugin = new DAVACL\Plugin();
            if (!$this->autoLogin) {
                $this->aclPlugin->allowUnauthenticatedAccess = false;
            }
            $this->aclPlugin->adminPrincipals = ['principals/admin'];
            $this->server->addPlugin($this->aclPlugin);
        }
 
    }

request()

Sabre\DAVServerTest::request	(		$request,
			$expectedStatus = null
	)

Makes a request, and returns a response object.

You can either pass an instance of Sabre\HTTP\Request, or an array, which will then be used as the _SERVER array.

If $expectedStatus is set, we'll compare it with the HTTP status of the returned response. If it doesn't match, we'll immediately fail the test.

Parameters

array | \Sabre\HTTP\Request	$request
int	$expectedStatus

Returns

\Sabre\HTTP\Response

Definition at line 193 of file DAVServerTest.php.

                                                       {
 
        if (is_array($request)) {
            $request = HTTP\Request::createFromServerArray($request);
        }
        $response = new HTTP\ResponseMock();
 
        $this->server->httpRequest = $request;
        $this->server->httpResponse = $response;
        $this->server->exec();
 
        if ($expectedStatus) {
            $responseBody = $expectedStatus !== $response->getStatus() ? $response->getBodyAsString() : '';
            $this->assertEquals($expectedStatus, $response->getStatus(), 'Incorrect HTTP status received for request. Response body: ' . $responseBody);
        }
        return $this->server->httpResponse;
 
    }

References $request, and $response.

Referenced by Sabre\CalDAV\ICSExportPluginTest\testBeforeMethod(), Sabre\CalDAV\JCalTransformTest\testCalendarQueryDepth0(), Sabre\CalDAV\JCalTransformTest\testCalendarQueryDepth1(), Sabre\CardDAV\VCFExportTest\testContentDisposition(), Sabre\CardDAV\VCFExportTest\testContentDispositionBadChars(), Sabre\DAV\HttpCopyTest\testCopyColl(), Sabre\DAV\HttpCopyTest\testCopyCollIntoSubtree(), Sabre\DAV\HttpCopyTest\testCopyCollToExisting(), Sabre\DAV\HttpCopyTest\testCopyCollToExistingOverwriteF(), Sabre\DAV\HttpCopyTest\testCopyCollToExistingOverwriteT(), Sabre\DAV\HttpCopyTest\testCopyCollToSelf(), Sabre\DAV\HttpCopyTest\testCopyFile(), Sabre\DAV\HttpCopyTest\testCopyFileNonExistantParent(), Sabre\DAV\HttpCopyTest\testCopyFileToExistinBlockedCreateDestination(), Sabre\DAV\HttpCopyTest\testCopyFileToExisting(), Sabre\DAV\HttpCopyTest\testCopyFileToExistingOverwriteBadValue(), Sabre\DAV\HttpCopyTest\testCopyFileToExistingOverwriteF(), Sabre\DAV\HttpCopyTest\testCopyFileToExistingOverwriteT(), Sabre\DAV\HttpCopyTest\testCopyFileToSelf(), Sabre\DAV\ServerRangeTest\testCrazyRange(), Sabre\DAV\HttpDeleteTest\testDelete(), Sabre\DAV\HttpDeleteTest\testDeleteDirectory(), Sabre\DAV\HttpDeleteTest\testDeleteNotFound(), Sabre\DAV\HttpDeleteTest\testDeletePreconditions(), Sabre\DAV\HttpDeleteTest\testDeletePreconditionsFailed(), Sabre\CalDAV\Schedule\DeliverNewEventTest\testDelivery(), Sabre\DAV\HttpHeadTest\testDoubleAuth(), Sabre\DAV\ServerRangeTest\testEndRange(), Sabre\CardDAV\VCFExportTest\testExport(), Sabre\DAV\HttpPutTest\testFinderPutFail(), Sabre\DAV\HttpPutTest\testFinderPutSuccess(), Sabre\CalDAV\JCalTransformTest\testGet(), Sabre\DAV\HttpGetTest\testGet(), Sabre\DAV\HttpGetTest\testGet404(), Sabre\DAV\HttpGetTest\testGet404_aswell(), Sabre\DAV\HttpGetTest\testGetCollection(), Sabre\DAV\HttpGetTest\testGetDoubleSlash(), Sabre\DAV\HttpGetTest\testGetHttp10(), Sabre\DAV\HttpGetTest\testGetStreaming(), Sabre\DAV\HttpHeadTest\testHEAD(), Sabre\DAV\HttpHeadTest\testHEADCollection(), Sabre\DAV\Sync\PluginTest\testIfConditions(), Sabre\DAV\Sync\PluginTest\testIfConditionsNoSyncToken(), Sabre\DAV\Sync\PluginTest\testIfConditionsNot(), Sabre\DAV\ServerRangeTest\testIfRangeEtag(), Sabre\DAV\ServerRangeTest\testIfRangeEtagIncorrect(), Sabre\DAV\ServerRangeTest\testIfRangeModificationDate(), Sabre\DAV\ServerRangeTest\testIfRangeModificationDateModified(), Sabre\CalDAV\SharingPluginTest\testInviteBadXML(), Sabre\CalDAV\SharingPluginTest\testInviteReply(), Sabre\CalDAV\SharingPluginTest\testInviteWrongUrl(), Sabre\CalDAV\Subscriptions\CreateSubscriptionTest\testMKCALENDAR(), Sabre\CalDAV\Subscriptions\CreateSubscriptionTest\testMKCOL(), Sabre\DAV\HttpMoveTest\testMove(), Sabre\DAV\HttpMoveTest\testMoveToExisting(), Sabre\DAV\HttpMoveTest\testMoveToExistingBlockedDeleteSource(), Sabre\DAV\HttpMoveTest\testMoveToExistingOverwriteF(), Sabre\DAV\HttpMoveTest\testMoveToExistingOverwriteT(), Sabre\DAV\HttpMoveTest\testMoveToSelf(), Sabre\CalDAV\JCalTransformTest\testMultiGet(), Sabre\DAV\ServerRangeTest\testNonSeekableStream(), Sabre\DAV\PartialUpdate\PluginTest\testPatchBadRange(), Sabre\DAV\PartialUpdate\PluginTest\testPatchNoContentType(), Sabre\DAV\PartialUpdate\PluginTest\testPatchNoEndRange(), Sabre\DAV\PartialUpdate\PluginTest\testPatchNoLength(), Sabre\DAV\PartialUpdate\PluginTest\testPatchNoRange(), Sabre\DAV\PartialUpdate\PluginTest\testPatchNotSupported(), Sabre\DAV\PartialUpdate\PluginTest\testPatchSuccess(), Sabre\DAVACL\PrincipalMatchTest\testPrincipalMatch(), Sabre\DAV\HTTPPreferParsingTest\testpropfindMinimal(), Sabre\DAV\HTTPPreferParsingTest\testproppatchMinimal(), Sabre\DAV\HTTPPreferParsingTest\testproppatchMinimalError(), Sabre\CalDAV\SharingPluginTest\testPublish(), Sabre\CalDAV\SharingPluginTest\testPublishWrongUrl(), Sabre\DAV\HttpPutTest\testPut(), Sabre\DAV\HttpPutTest\testPutContentRange(), Sabre\DAV\HttpPutTest\testPutExisting(), Sabre\DAV\HttpPutTest\testPutExistingIfMatchCorrect(), Sabre\DAV\HttpPutTest\testPutExistingIfMatchStar(), Sabre\DAV\HttpPutTest\testPutExistingIfNoneMatchStar(), Sabre\DAV\HttpPutTest\testPutIfMatchStar(), Sabre\DAV\HttpPutTest\testPutIfNoneMatchStar(), Sabre\DAV\HttpPutTest\testPutIntercept(), Sabre\DAV\HttpPutTest\testPutNoParent(), Sabre\DAV\ServerRangeTest\testRange(), Sabre\DAVACL\AclPrincipalPropSetReportTest\testReport(), Sabre\DAVACL\AclPrincipalPropSetReportTest\testReportDepth1(), Sabre\CalDAV\SharingPluginTest\testShareRequest(), Sabre\CalDAV\SharingPluginTest\testShareRequestNoShareableCalendar(), Sabre\DAV\Sharing\ShareResourceTest\testShareResource(), Sabre\DAV\Sharing\ShareResourceTest\testShareResourceInviteProperty(), Sabre\DAV\Sharing\ShareResourceTest\testShareResourceNotFound(), Sabre\DAV\Sharing\ShareResourceTest\testShareResourceNotISharedNode(), Sabre\DAV\Sharing\ShareResourceTest\testShareResourceRemoveAccess(), Sabre\DAV\Sharing\ShareResourceTest\testShareResourceUnknownDoc(), Sabre\DAV\ServerRangeTest\testStartRange(), Sabre\DAV\Sync\PluginTest\testSubsequentSyncSyncCollection(), Sabre\DAV\Sync\PluginTest\testSubsequentSyncSyncCollectionDepthFallBack(), Sabre\DAV\Sync\PluginTest\testSubsequentSyncSyncCollectionLimit(), Sabre\DAV\Sync\PluginTest\testSyncInitialSyncCollection(), Sabre\DAV\Sync\PluginTest\testSyncInvalidToken(), Sabre\DAV\Sync\PluginTest\testSyncInvalidTokenNoPrefix(), Sabre\DAV\Sync\PluginTest\testSyncNoProp(), Sabre\DAV\Sync\PluginTest\testSyncNoSyncCollection(), Sabre\DAV\Sync\PluginTest\testSyncNoSyncInfo(), Sabre\DAV\Sync\PluginTest\testSyncNoSyncToken(), Sabre\DAV\ServerRangeTest\testTooHighRange(), Sabre\CalDAV\SharingPluginTest\testUnknownMethodNoNode(), Sabre\CalDAV\SharingPluginTest\testUnknownMethodNoPOST(), Sabre\CalDAV\SharingPluginTest\testUnknownMethodNoXML(), Sabre\CalDAV\SharingPluginTest\testUnknownXmlDoc(), Sabre\DAV\Locks\Plugin2Test\testUnlockAfterDelete(), Sabre\CalDAV\SharingPluginTest\testUnpublish(), and Sabre\CalDAV\SharingPluginTest\testUnpublishWrongUrl().

Here is the caller graph for this function:

setUp()

Sabre\DAVServerTest::setUp

(

)

Reimplemented in Sabre\CalDAV\ICSExportPluginTest, Sabre\CalDAV\Schedule\DeliverNewEventTest, Sabre\CalDAV\Schedule\PluginPropertiesTest, Sabre\CalDAV\Schedule\PluginPropertiesWithSharedCalendarTest, Sabre\CalDAV\Schedule\ScheduleDeliverTest, Sabre\CalDAV\SharingPluginTest, Sabre\CardDAV\VCFExportTest, Sabre\DAV\PartialUpdate\PluginTest, Sabre\DAV\PropertyStorage\PluginTest, Sabre\DAV\ServerRangeTest, and Sabre\DAV\Sync\PluginTest.

Definition at line 111 of file DAVServerTest.php.

                     {
 
        $this->initializeEverything();
 
    }

setUpBackends()

Sabre\DAVServerTest::setUpBackends

(

)

Definition at line 268 of file DAVServerTest.php.

                             {
 
        if ($this->setupCalDAVSharing && is_null($this->caldavBackend)) {
            $this->caldavBackend = new CalDAV\Backend\MockSharing($this->caldavCalendars, $this->caldavCalendarObjects);
        }
        if ($this->setupCalDAVSubscriptions && is_null($this->caldavBackend)) {
            $this->caldavBackend = new CalDAV\Backend\MockSubscriptionSupport($this->caldavCalendars, $this->caldavCalendarObjects);
        }
        if ($this->setupCalDAV && is_null($this->caldavBackend)) {
            if ($this->setupCalDAVScheduling) {
                $this->caldavBackend = new CalDAV\Backend\MockScheduling($this->caldavCalendars, $this->caldavCalendarObjects);
            } else {
                $this->caldavBackend = new CalDAV\Backend\Mock($this->caldavCalendars, $this->caldavCalendarObjects);
            }
        }
        if ($this->setupCardDAV && is_null($this->carddavBackend)) {
            $this->carddavBackend = new CardDAV\Backend\Mock($this->carddavAddressBooks, $this->carddavCards);
        }
        if ($this->setupCardDAV || $this->setupCalDAV || $this->setupACL) {
            $this->principalBackend = new DAVACL\PrincipalBackend\Mock();
        }
        if ($this->setupLocks) {
            $this->locksBackend = new DAV\Locks\Backend\Mock();
        }
        if ($this->setupPropertyStorage)  {
            $this->propertyStorageBackend = new DAV\PropertyStorage\Backend\Mock();
        }
 
    }

setUpTree()

Sabre\DAVServerTest::setUpTree

(

)

Override this to provide your own Tree for your test-case.

Reimplemented in Sabre\DAV\HttpCopyTest, Sabre\DAV\HttpDeleteTest, Sabre\DAV\HttpGetTest, Sabre\DAV\HttpHeadTest, Sabre\DAV\HttpMoveTest, Sabre\DAV\HttpPutTest, Sabre\DAV\Locks\Plugin2Test, Sabre\DAV\Sharing\PluginTest, Sabre\DAV\Sharing\ShareResourceTest, and Sabre\DAV\Sync\PluginTest.

Definition at line 236 of file DAVServerTest.php.

                         {
 
        if ($this->setupCalDAV) {
            $this->tree[] = new CalDAV\CalendarRoot(
                $this->principalBackend,
                $this->caldavBackend
            );
        }
        if ($this->setupCardDAV) {
            $this->tree[] = new CardDAV\AddressBookRoot(
                $this->principalBackend,
                $this->carddavBackend
            );
        }
 
        if ($this->setupCalDAV) {
            $this->tree[] = new CalDAV\Principal\Collection(
                $this->principalBackend
            );
        } elseif ($this->setupCardDAV || $this->setupACL) {
            $this->tree[] = new DAVACL\PrincipalCollection(
                $this->principalBackend
            );
        }
        if ($this->setupFiles) {
 
            $this->tree[] = new DAV\Mock\Collection('files');
 
        }
 
    }

Field Documentation

$aclPlugin

Sabre\DAVServerTest::$aclPlugin

protected

Definition at line 69 of file DAVServerTest.php.

$authPlugin

Sabre\DAVServerTest::$authPlugin

protected

Definition at line 86 of file DAVServerTest.php.

$autoLogin

Sabre\DAVServerTest::$autoLogin = null

protected

If this string is set, we will automatically log in the user with this name.

Definition at line 109 of file DAVServerTest.php.

$caldavBackend

Sabre\DAVServerTest::$caldavBackend

protected

Definition at line 50 of file DAVServerTest.php.

$caldavCalendarObjects

Sabre\DAVServerTest::$caldavCalendarObjects = []

protected

Definition at line 39 of file DAVServerTest.php.

$caldavCalendars

Sabre\DAVServerTest::$caldavCalendars = []

protected

An array with calendars.

Every calendar should have

• principaluri
• uri

Definition at line 38 of file DAVServerTest.php.

$caldavPlugin

Sabre\DAVServerTest::$caldavPlugin

protected

Definition at line 59 of file DAVServerTest.php.

$caldavSchedulePlugin

Sabre\DAVServerTest::$caldavSchedulePlugin

protected

Definition at line 81 of file DAVServerTest.php.

$caldavSharingPlugin

Sabre\DAVServerTest::$caldavSharingPlugin

protected

Definition at line 74 of file DAVServerTest.php.

$carddavAddressBooks

Sabre\DAVServerTest::$carddavAddressBooks = []

protected

Definition at line 41 of file DAVServerTest.php.

$carddavBackend

Sabre\DAVServerTest::$carddavBackend

protected

Definition at line 51 of file DAVServerTest.php.

$carddavCards

Sabre\DAVServerTest::$carddavCards = []

protected

Definition at line 42 of file DAVServerTest.php.

$carddavPlugin

Sabre\DAVServerTest::$carddavPlugin

protected

Definition at line 64 of file DAVServerTest.php.

$locksBackend

Sabre\DAVServerTest::$locksBackend

protected

Definition at line 53 of file DAVServerTest.php.

$locksPlugin

Sabre\DAVServerTest::$locksPlugin

protected

Definition at line 91 of file DAVServerTest.php.

$principalBackend

Sabre\DAVServerTest::$principalBackend

protected

Definition at line 52 of file DAVServerTest.php.

$propertyStorageBackend

Sabre\DAVServerTest::$propertyStorageBackend

protected

Definition at line 54 of file DAVServerTest.php.

$propertyStoragePlugin

Sabre\DAVServerTest::$propertyStoragePlugin

protected

Definition at line 103 of file DAVServerTest.php.

$server

Sabre\DAVServerTest::$server

protected

Definition at line 47 of file DAVServerTest.php.

Referenced by Sabre\DAV\HTTPPreferParsingTest\testBrief(), Sabre\DAV\HTTPPreferParsingTest\testParseMultiple(), Sabre\DAV\HTTPPreferParsingTest\testParseSimple(), Sabre\DAV\HTTPPreferParsingTest\testParseValue(), Sabre\DAV\HTTPPreferParsingTest\testParseWeirdValue(), and Sabre\CalDAV\SharingPluginTest\testSetupWithoutCoreSharingPlugin().

$setupACL

Sabre\DAVServerTest::$setupACL = false

protected

Definition at line 23 of file DAVServerTest.php.

$setupCalDAV

Sabre\DAVServerTest::$setupCalDAV = false

protected

Definition at line 21 of file DAVServerTest.php.

$setupCalDAVICSExport

Sabre\DAVServerTest::$setupCalDAVICSExport = false

protected

Definition at line 27 of file DAVServerTest.php.

$setupCalDAVScheduling

Sabre\DAVServerTest::$setupCalDAVScheduling = false

protected

Definition at line 25 of file DAVServerTest.php.

$setupCalDAVSharing

Sabre\DAVServerTest::$setupCalDAVSharing = false

protected

Definition at line 24 of file DAVServerTest.php.

$setupCalDAVSubscriptions

Sabre\DAVServerTest::$setupCalDAVSubscriptions = false

protected

Definition at line 26 of file DAVServerTest.php.

$setupCardDAV

Sabre\DAVServerTest::$setupCardDAV = false

protected

Definition at line 22 of file DAVServerTest.php.

$setupFiles

Sabre\DAVServerTest::$setupFiles = false

protected

Definition at line 29 of file DAVServerTest.php.

$setupLocks

Sabre\DAVServerTest::$setupLocks = false

protected

Definition at line 28 of file DAVServerTest.php.

$setupPropertyStorage

Sabre\DAVServerTest::$setupPropertyStorage = false

protected

Definition at line 31 of file DAVServerTest.php.

$setupSharing

Sabre\DAVServerTest::$setupSharing = false

protected

Definition at line 30 of file DAVServerTest.php.

$sharingPlugin

Sabre\DAVServerTest::$sharingPlugin

protected

Definition at line 98 of file DAVServerTest.php.

$tree

Sabre\DAVServerTest::$tree = []

protected

Definition at line 48 of file DAVServerTest.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/tests/Sabre/DAVServerTest.php