aboutsummaryrefslogtreecommitdiffstats
path: root/apps/settings/tests/UserMigration
diff options
context:
space:
mode:
Diffstat (limited to 'apps/settings/tests/UserMigration')
-rw-r--r--apps/settings/tests/UserMigration/AccountMigratorTest.php165
-rw-r--r--apps/settings/tests/UserMigration/assets/account-complex-config.json1
-rw-r--r--apps/settings/tests/UserMigration/assets/account-complex.jpgbin0 -> 1040846 bytes
-rw-r--r--apps/settings/tests/UserMigration/assets/account-complex.json1
-rw-r--r--apps/settings/tests/UserMigration/assets/account-config.json1
-rw-r--r--apps/settings/tests/UserMigration/assets/account.json1
-rw-r--r--apps/settings/tests/UserMigration/assets/account.pngbin0 -> 451063 bytes
7 files changed, 169 insertions, 0 deletions
diff --git a/apps/settings/tests/UserMigration/AccountMigratorTest.php b/apps/settings/tests/UserMigration/AccountMigratorTest.php
new file mode 100644
index 00000000000..b8f8301f777
--- /dev/null
+++ b/apps/settings/tests/UserMigration/AccountMigratorTest.php
@@ -0,0 +1,165 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Settings\Tests\UserMigration;
+
+use OCA\Settings\AppInfo\Application;
+use OCA\Settings\UserMigration\AccountMigrator;
+use OCP\Accounts\IAccountManager;
+use OCP\AppFramework\App;
+use OCP\IAvatarManager;
+use OCP\IConfig;
+use OCP\IUserManager;
+use OCP\Server;
+use OCP\UserMigration\IExportDestination;
+use OCP\UserMigration\IImportSource;
+use PHPUnit\Framework\Constraint\JsonMatches;
+use PHPUnit\Framework\MockObject\MockObject;
+use Sabre\VObject\UUIDUtil;
+use Symfony\Component\Console\Output\OutputInterface;
+use Test\TestCase;
+
+/**
+ * @group DB
+ */
+class AccountMigratorTest extends TestCase {
+ private IUserManager $userManager;
+ private IAvatarManager $avatarManager;
+ private AccountMigrator $migrator;
+ private IImportSource&MockObject $importSource;
+ private IExportDestination&MockObject $exportDestination;
+ private OutputInterface&MockObject $output;
+
+ private const ASSETS_DIR = __DIR__ . '/assets/';
+
+ private const REGEX_ACCOUNT_FILE = '/^' . Application::APP_ID . '\/' . '[a-z]+\.json' . '$/';
+
+ private const REGEX_AVATAR_FILE = '/^' . Application::APP_ID . '\/' . 'avatar\.(jpg|png)' . '$/';
+
+ private const REGEX_CONFIG_FILE = '/^' . Application::APP_ID . '\/' . '[a-z]+\.json' . '$/';
+
+ protected function setUp(): void {
+ parent::setUp();
+
+ $app = new App(Application::APP_ID);
+ $container = $app->getContainer();
+ $container->get(IConfig::class)->setSystemValue('has_internet_connection', false);
+
+ $this->userManager = $container->get(IUserManager::class);
+ $this->avatarManager = $container->get(IAvatarManager::class);
+ $this->migrator = $container->get(AccountMigrator::class);
+
+ $this->importSource = $this->createMock(IImportSource::class);
+ $this->exportDestination = $this->createMock(IExportDestination::class);
+ $this->output = $this->createMock(OutputInterface::class);
+ }
+
+ protected function tearDown(): void {
+ Server::get(IConfig::class)->setSystemValue('has_internet_connection', true);
+ parent::tearDown();
+ }
+
+ public static function dataImportExportAccount(): array {
+ return array_map(
+ static function (string $filename): array {
+ $dataPath = static::ASSETS_DIR . $filename;
+ // For each account json file there is an avatar image and a config json file with the same basename
+ $basename = pathinfo($filename, PATHINFO_FILENAME);
+ $avatarPath = static::ASSETS_DIR . (file_exists(static::ASSETS_DIR . "$basename.jpg") ? "$basename.jpg" : "$basename.png");
+ $configPath = static::ASSETS_DIR . "$basename-config." . pathinfo($filename, PATHINFO_EXTENSION);
+ return [
+ UUIDUtil::getUUID(),
+ json_decode(file_get_contents($dataPath), true, 512, JSON_THROW_ON_ERROR),
+ $avatarPath,
+ json_decode(file_get_contents($configPath), true, 512, JSON_THROW_ON_ERROR),
+ ];
+ },
+ array_filter(
+ scandir(static::ASSETS_DIR),
+ fn (string $filename) => pathinfo($filename, PATHINFO_EXTENSION) === 'json' && mb_strpos(pathinfo($filename, PATHINFO_FILENAME), 'config') === false,
+ ),
+ );
+ }
+
+ #[\PHPUnit\Framework\Attributes\DataProvider('dataImportExportAccount')]
+ public function testImportExportAccount(string $userId, array $importData, string $avatarPath, array $importConfig): void {
+ $user = $this->userManager->createUser($userId, 'topsecretpassword');
+ $avatarExt = pathinfo($avatarPath, PATHINFO_EXTENSION);
+ $exportData = $importData;
+ $exportConfig = $importConfig;
+ // Verification status of email will be set to in progress on import so we set the export data to reflect that
+ $exportData[IAccountManager::PROPERTY_EMAIL]['verified'] = IAccountManager::VERIFICATION_IN_PROGRESS;
+
+ $this->importSource
+ ->expects($this->once())
+ ->method('getMigratorVersion')
+ ->with($this->migrator->getId())
+ ->willReturn(1);
+
+ $calls = [
+ [static::REGEX_ACCOUNT_FILE, json_encode($importData)],
+ [static::REGEX_CONFIG_FILE, json_encode($importConfig)],
+ ];
+ $this->importSource
+ ->expects($this->exactly(2))
+ ->method('getFileContents')
+ ->willReturnCallback(function ($path) use (&$calls) {
+ $expected = array_shift($calls);
+ $this->assertMatchesRegularExpression($expected[0], $path);
+ return $expected[1];
+ });
+
+ $this->importSource
+ ->expects($this->once())
+ ->method('getFolderListing')
+ ->with(Application::APP_ID . '/')
+ ->willReturn(["avatar.$avatarExt"]);
+
+ $this->importSource
+ ->expects($this->once())
+ ->method('getFileAsStream')
+ ->with($this->matchesRegularExpression(static::REGEX_AVATAR_FILE))
+ ->willReturn(fopen($avatarPath, 'r'));
+
+ $this->migrator->import($user, $this->importSource, $this->output);
+
+ $importedAvatar = $this->avatarManager->getAvatar($user->getUID());
+ $this->assertTrue($importedAvatar->isCustomAvatar());
+
+ /**
+ * Avatar images are re-encoded on import therefore JPEG images which use lossy compression cannot be checked for equality
+ * @see https://github.com/nextcloud/server/blob/9644b7e505dc90a1e683f77ad38dc6dc4e90fa2f/lib/private/legacy/OC_Image.php#L383-L390
+ */
+
+ if ($avatarExt !== 'jpg') {
+ $this->assertStringEqualsFile(
+ $avatarPath,
+ $importedAvatar->getFile(-1)->getContent(),
+ );
+ }
+
+ $calls = [
+ [static::REGEX_ACCOUNT_FILE, new JsonMatches(json_encode($importData))],
+ [static::REGEX_CONFIG_FILE,new JsonMatches(json_encode($importConfig))],
+ ];
+ $this->exportDestination
+ ->expects($this->exactly(2))
+ ->method('addFileContents')
+ ->willReturnCallback(function ($path) use (&$calls) {
+ $expected = array_shift($calls);
+ $this->assertMatchesRegularExpression($expected[0], $path);
+ return $expected[1];
+ });
+
+ $this->exportDestination
+ ->expects($this->once())
+ ->method('addFileAsStream')
+ ->with($this->matchesRegularExpression(static::REGEX_AVATAR_FILE), $this->isType('resource'));
+
+ $this->migrator->export($user, $this->exportDestination, $this->output);
+ }
+}
diff --git a/apps/settings/tests/UserMigration/assets/account-complex-config.json b/apps/settings/tests/UserMigration/assets/account-complex-config.json
new file mode 100644
index 00000000000..fecf819057c
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account-complex-config.json
@@ -0,0 +1 @@
+{"address":{"visibility":"show_users_only"},"avatar":{"visibility":"show_users_only"},"biography":{"visibility":"show"},"displayname":{"visibility":"show"},"fediverse":{"visibility":"show_users_only"},"headline":{"visibility":"show"},"organisation":{"visibility":"show"},"role":{"visibility":"show"},"email":{"visibility":"hide"},"phone":{"visibility":"hide"},"twitter":{"visibility":"show_users_only"},"website":{"visibility":"show_users_only"},"talk":{"visibility":"show"},"birthdate":{"visibility":"show_users_only"},"pronouns":{"visibility":"show"}} \ No newline at end of file
diff --git a/apps/settings/tests/UserMigration/assets/account-complex.jpg b/apps/settings/tests/UserMigration/assets/account-complex.jpg
new file mode 100644
index 00000000000..94508343322
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account-complex.jpg
Binary files differ
diff --git a/apps/settings/tests/UserMigration/assets/account-complex.json b/apps/settings/tests/UserMigration/assets/account-complex.json
new file mode 100644
index 00000000000..cb4668cf18c
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account-complex.json
@@ -0,0 +1 @@
+{"displayname":{"name":"displayname","value":"Steve Smith","scope":"v2-local","verified":"0","verificationData":""},"address":{"name":"address","value":"123 Water St","scope":"v2-local","verified":"0","verificationData":""},"website":{"name":"website","value":"https://example.org","scope":"v2-local","verified":"0","verificationData":""},"email":{"name":"email","value":"steve@example.org","scope":"v2-federated","verified":"1","verificationData":""},"avatar":{"name":"avatar","value":"","scope":"v2-local","verified":"0","verificationData":""},"phone":{"name":"phone","value":"+12178515387","scope":"v2-private","verified":"0","verificationData":""},"twitter":{"name":"twitter","value":"steve","scope":"v2-federated","verified":"0","verificationData":""},"fediverse":{"name":"fediverse","value":"steve@floss.social","scope":"v2-federated","verified":"0","verificationData":""},"organisation":{"name":"organisation","value":"Mytery Machine","scope":"v2-private","verified":"0","verificationData":""},"role":{"name":"role","value":"Manager","scope":"v2-private","verified":"0","verificationData":""},"headline":{"name":"headline","value":"I am Steve","scope":"v2-local","verified":"0","verificationData":""},"biography":{"name":"biography","value":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris porttitor ullamcorper dictum. Sed fermentum ut ligula scelerisque semper. Aliquam interdum convallis tellus eu dapibus. Integer in justo sollicitudin, hendrerit ligula sit amet, blandit sem.\n\nSuspendisse consectetur ultrices accumsan. Quisque sagittis bibendum lectus ut placerat. Mauris tincidunt ornare neque, et pulvinar tortor porttitor eu.","scope":"v2-local","verified":"0","verificationData":""},"birthdate":{"name":"birthdate","value":"","scope":"v2-local","verified":"0","verificationData":""},"profile_enabled":{"name":"profile_enabled","value":"1","scope":"v2-local","verified":"0","verificationData":""},"pronouns":{"name":"pronouns","value":"they/them","scope":"v2-local","verified":"0","verificationData":""},"additional_mail":[{"name":"additional_mail","value":"steve@example.com","scope":"v2-published","verified":"0","verificationData":""},{"name":"additional_mail","value":"steve@earth.world","scope":"v2-local","verified":"0","verificationData":""}]} \ No newline at end of file
diff --git a/apps/settings/tests/UserMigration/assets/account-config.json b/apps/settings/tests/UserMigration/assets/account-config.json
new file mode 100644
index 00000000000..a1250fab8e9
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account-config.json
@@ -0,0 +1 @@
+{"address":{"visibility":"show_users_only"},"avatar":{"visibility":"show"},"biography":{"visibility":"show"},"displayname":{"visibility":"show"},"fediverse":{"visibility":"show"},"headline":{"visibility":"show"},"organisation":{"visibility":"show"},"role":{"visibility":"show"},"email":{"visibility":"show_users_only"},"phone":{"visibility":"show_users_only"},"twitter":{"visibility":"show"},"website":{"visibility":"show"},"birthdate":{"visibility":"show"},"pronouns":{"visibility":"show"}} \ No newline at end of file
diff --git a/apps/settings/tests/UserMigration/assets/account.json b/apps/settings/tests/UserMigration/assets/account.json
new file mode 100644
index 00000000000..6bdc3c72d47
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account.json
@@ -0,0 +1 @@
+{"displayname":{"name":"displayname","value":"Emma Jones","scope":"v2-federated","verified":"0","verificationData":""},"address":{"name":"address","value":"920 Grass St","scope":"v2-local","verified":"0","verificationData":""},"website":{"name":"website","value":"","scope":"v2-local","verified":"0","verificationData":""},"email":{"name":"email","value":"","scope":"v2-federated","verified":"1","verificationData":""},"avatar":{"name":"avatar","value":"","scope":"v2-federated","verified":"0","verificationData":""},"phone":{"name":"phone","value":"","scope":"v2-local","verified":"0","verificationData":""},"twitter":{"name":"twitter","value":"","scope":"v2-local","verified":"0","verificationData":""},"fediverse":{"name":"fediverse","value":"","scope":"v2-local","verified":"0","verificationData":""},"organisation":{"name":"organisation","value":"","scope":"v2-local","verified":"0","verificationData":""},"role":{"name":"role","value":"","scope":"v2-local","verified":"0","verificationData":""},"headline":{"name":"headline","value":"","scope":"v2-local","verified":"0","verificationData":""},"biography":{"name":"biography","value":"","scope":"v2-local","verified":"0","verificationData":""},"birthdate":{"name":"birthdate","value":"","scope":"v2-local","verified":"0","verificationData":""},"profile_enabled":{"name":"profile_enabled","value":"1","scope":"v2-local","verified":"0","verificationData":""},"pronouns":{"name":"pronouns","value":"","scope":"v2-federated","verified":"0","verificationData":""},"additional_mail":[]} \ No newline at end of file
diff --git a/apps/settings/tests/UserMigration/assets/account.png b/apps/settings/tests/UserMigration/assets/account.png
new file mode 100644
index 00000000000..41c4924e569
--- /dev/null
+++ b/apps/settings/tests/UserMigration/assets/account.png
Binary files differ
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 08:58:33 +0000