Skip to content

test(carddav): refactor testSearch to use clearer assertions and unique UIDs #60463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshtrichards wants to merge 2 commits into
base: master
Choose a base branch
from
+110 −86
Open

test(carddav): refactor testSearch to use clearer assertions and unique UIDs #60463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92cd85a
test(CardDav): name all search data cases accurately
joshtrichards May 15, 2026
4a9022a
test(carddav): tighten search assertions and clarify search cases
joshtrichards May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 110 additions & 86 deletions apps/dav/tests/unit/CardDAV/CardDavBackendTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,18 +657,20 @@ public function testGetCardIdFailed(): void {
}

#[\PHPUnit\Framework\Attributes\DataProvider(methodName: 'dataTestSearch')]
public function testSearch(string $pattern, array $properties, array $options, array $expected): void {
/** @var VCard $vCards */
public function testSearch(string $pattern, array $properties, array $options, array $expectedUris, array $expectedNeedles): void {
$vCards = [];

$vCards[0] = new VCard();
$vCards[0]->add(new Text($vCards[0], 'UID', 'uid'));
$vCards[0]->add(new Text($vCards[0], 'UID', 'uid-0'));
$vCards[0]->add(new Text($vCards[0], 'FN', 'John Doe'));
$vCards[0]->add(new Text($vCards[0], 'CLOUD', 'john@nextcloud.com'));

$vCards[1] = new VCard();
$vCards[1]->add(new Text($vCards[1], 'UID', 'uid'));
$vCards[1]->add(new Text($vCards[1], 'UID', 'uid-1'));
$vCards[1]->add(new Text($vCards[1], 'FN', 'John M. Doe'));

$vCards[2] = new VCard();
$vCards[2]->add(new Text($vCards[2], 'UID', 'uid'));
$vCards[2]->add(new Text($vCards[2], 'UID', 'uid-2'));
$vCards[2]->add(new Text($vCards[2], 'FN', 'find without options'));
$vCards[2]->add(new Text($vCards[2], 'CLOUD', 'peter_pan@nextcloud.com'));

Expand All @@ -690,95 +692,117 @@ public function testSearch(string $pattern, array $properties, array $options, a
$vCardIds[] = $query->getLastInsertId();
}

$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($vCardIds[0]),
'name' => $query->createNamedParameter('FN'),
'value' => $query->createNamedParameter('John Doe'),
'preferred' => $query->createNamedParameter(0)
]
);
$query->executeStatement();
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($vCardIds[0]),
'name' => $query->createNamedParameter('CLOUD'),
'value' => $query->createNamedParameter('John@nextcloud.com'),
'preferred' => $query->createNamedParameter(0)
]
);
$query->executeStatement();
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($vCardIds[1]),
'name' => $query->createNamedParameter('FN'),
'value' => $query->createNamedParameter('John M. Doe'),
'preferred' => $query->createNamedParameter(0)
]
);
$query->executeStatement();
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($vCardIds[2]),
'name' => $query->createNamedParameter('FN'),
'value' => $query->createNamedParameter('find without options'),
'preferred' => $query->createNamedParameter(0)
]
);
$query->executeStatement();
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($vCardIds[2]),
'name' => $query->createNamedParameter('CLOUD'),
'value' => $query->createNamedParameter('peter_pan@nextcloud.com'),
'preferred' => $query->createNamedParameter(0)
]
);
$query->executeStatement();
$propertyRows = [
[$vCardIds[0], 'FN', 'John Doe'],
[$vCardIds[0], 'CLOUD', 'John@nextcloud.com'],
[$vCardIds[1], 'FN', 'John M. Doe'],
[$vCardIds[2], 'FN', 'find without options'],
[$vCardIds[2], 'CLOUD', 'peter_pan@nextcloud.com'],
];

foreach ($propertyRows as [$cardId, $name, $value]) {
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($cardId),
'name' => $query->createNamedParameter($name),
'value' => $query->createNamedParameter($value),
'preferred' => $query->createNamedParameter(0),
]
);
$query->executeStatement();
}

$result = $this->backend->search(0, $pattern, $properties, $options);

// check result
$this->assertSame(count($expected), count($result));
$found = [];
foreach ($result as $r) {
foreach ($expected as $exp) {
if ($r['uri'] === $exp[0] && strpos($r['carddata'], $exp[1]) > 0) {
$found[$exp[1]] = true;
break;
}
}
}
$this->assertCount(count($expectedUris), $result);

$actualUris = array_map(static fn (array $row): string => $row['uri'], $result);
sort($actualUris);
$expectedSortedUris = $expectedUris;
sort($expectedSortedUris);

$this->assertSame($expectedSortedUris, $actualUris, 'Search returned unexpected URIs');

$this->assertSame(count($expected), count($found));
$expectedByUri = array_combine($expectedUris, $expectedNeedles);
$this->assertIsArray($expectedByUri);

foreach ($result as $row) {
$this->assertArrayHasKey($row['uri'], $expectedByUri, 'Unexpected URI in search result');
$this->assertNotFalse(
strpos($row['carddata'], $expectedByUri[$row['uri']]),
'Returned carddata does not contain expected fragment for ' . $row['uri']
);
}
}

public static function dataTestSearch(): array {
return [
['John', ['FN'], [], [['uri0', 'John Doe'], ['uri1', 'John M. Doe']]],
['M. Doe', ['FN'], [], [['uri1', 'John M. Doe']]],
['Do', ['FN'], [], [['uri0', 'John Doe'], ['uri1', 'John M. Doe']]],
'check if duplicates are handled correctly' => ['John', ['FN', 'CLOUD'], [], [['uri0', 'John Doe'], ['uri1', 'John M. Doe']]],
'case insensitive' => ['john', ['FN'], [], [['uri0', 'John Doe'], ['uri1', 'John M. Doe']]],
'limit' => ['john', ['FN'], ['limit' => 1], [['uri0', 'John Doe']]],
'limit and offset' => ['john', ['FN'], ['limit' => 1, 'offset' => 1], [['uri1', 'John M. Doe']]],
'find "_" escaped' => ['_', ['CLOUD'], [], [['uri2', 'find without options']]],
'find not empty CLOUD' => ['%_%', ['CLOUD'], ['escape_like_param' => false], [['uri0', 'John Doe'], ['uri2', 'find without options']]],
'basic FN match' => [
'pattern' => 'John',
'properties' => ['FN'],
'options' => [],
'expectedUris' => ['uri0', 'uri1'],
'expectedNeedles' => ['John Doe', 'John M. Doe'],
],
'partial FN match' => [
'pattern' => 'M. Doe',
'properties' => ['FN'],
'options' => [],
'expectedUris' => ['uri1'],
'expectedNeedles' => ['John M. Doe'],
],
'substring FN match' => [
'pattern' => 'Do',
'properties' => ['FN'],
'options' => [],
'expectedUris' => ['uri0', 'uri1'],
'expectedNeedles' => ['John Doe', 'John M. Doe'],
],
'search across multiple properties returns one result per card' => [
'pattern' => 'John',
'properties' => ['FN', 'CLOUD'],
'options' => [],
'expectedUris' => ['uri0', 'uri1'],
'expectedNeedles' => ['John Doe', 'John M. Doe'],
],
'case-insensitive search' => [
'pattern' => 'john',
'properties' => ['FN'],
'options' => [],
'expectedUris' => ['uri0', 'uri1'],
'expectedNeedles' => ['John Doe', 'John M. Doe'],
],
'limit' => [
'pattern' => 'john',
'properties' => ['FN'],
'options' => ['limit' => 1],
'expectedUris' => ['uri0'],
'expectedNeedles' => ['John Doe'],
],
'limit with offset' => [
'pattern' => 'john',
'properties' => ['FN'],
'options' => ['limit' => 1, 'offset' => 1],
'expectedUris' => ['uri1'],
'expectedNeedles' => ['John M. Doe'],
],
'underscore is escaped by default' => [
'pattern' => '_',
'properties' => ['CLOUD'],
'options' => [],
'expectedUris' => ['uri2'],
'expectedNeedles' => ['find without options'],
],
'underscore wildcard search when escape_like_param is false' => [
'pattern' => '%_%',
'properties' => ['CLOUD'],
'options' => ['escape_like_param' => false],
'expectedUris' => ['uri0', 'uri2'],
'expectedNeedles' => ['John Doe', 'find without options'],
],
];
}

Expand Down
Loading