@@ -272,6 +355,11 @@ export default {
smtpPort: this.settings.smtpPort || 587,
smtpUser: this.settings.smtpUser || '%USERID%domain.com',
smtpSslMode: this.settings.smtpSslMode || 'tls',
+ sieveEnabled: this.settings.sieveEnabled,
+ sieveHost: this.settings.sieveHost,
+ sievePort: this.settings.sievePort,
+ sieveSslMode: this.settings.sieveSslMode,
+ sieveUser: this.settings.sieveUser,
previewData1: {
uid: 'user123',
email: '',
@@ -295,6 +383,11 @@ export default {
smtpHost: this.smtpHost,
smtpPort: this.smtpPort,
smtpSslMode: this.smtpSslMode,
+ sieveEnabled: this.sieveEnabled,
+ sieveUser: this.sieveUser,
+ sieveHost: this.sieveHost,
+ sievePort: this.sievePort,
+ sieveSslMode: this.sieveSslMode,
}
},
},
@@ -315,6 +408,11 @@ export default {
smtpHost: this.smtpHost,
smtpPort: this.smtpPort,
smtpSslMode: this.smtpSslMode,
+ sieveEnabled: this.sieveEnabled,
+ sieveUser: this.sieveUser,
+ sieveHost: this.sieveHost,
+ sievePort: this.sievePort,
+ sieveSslMode: this.sieveSslMode,
})
.then(() => {
logger.info('provisioning settings updated')
diff --git a/src/errors/CouldNotConnectError.js b/src/errors/CouldNotConnectError.js
new file mode 100644
index 0000000000..94a8c9a508
--- /dev/null
+++ b/src/errors/CouldNotConnectError.js
@@ -0,0 +1,31 @@
+/**
+ * @author Daniel Kesselberg
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+export default class CouldNotConnectError extends Error {
+
+ constructor(message) {
+ super(message)
+ this.name = CouldNotConnectError.getName()
+ }
+
+ static getName() {
+ return 'CouldNotConnectError'
+ }
+
+}
diff --git a/src/errors/ManageSieveError.js b/src/errors/ManageSieveError.js
new file mode 100644
index 0000000000..e6f716e036
--- /dev/null
+++ b/src/errors/ManageSieveError.js
@@ -0,0 +1,31 @@
+/**
+ * @author Daniel Kesselberg
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+export default class ManageSieveError extends Error {
+
+ constructor(message) {
+ super(message)
+ this.name = ManageSieveError.getName()
+ }
+
+ static getName() {
+ return 'ManageSieveError'
+ }
+
+}
diff --git a/src/errors/convert.js b/src/errors/convert.js
index a860999a33..c4f52fbb5b 100644
--- a/src/errors/convert.js
+++ b/src/errors/convert.js
@@ -24,6 +24,8 @@ import MailboxNotCachedError from './MailboxNotCachedError'
import NoDraftsMailboxConfiguredError from './NoDraftsMailboxConfiguredError'
import NoSentMailboxConfiguredError from './NoSentMailboxConfiguredError'
import NoTrashMailboxConfiguredError from './NoTrashMailboxConfiguredError'
+import CouldNotConnectError from './CouldNotConnectError'
+import ManageSieveError from './ManageSieveError'
const map = {
'OCA\\Mail\\Exception\\DraftsMailboxNotSetException': NoDraftsMailboxConfiguredError,
@@ -31,6 +33,8 @@ const map = {
'OCA\\Mail\\Exception\\MailboxNotCachedException': MailboxNotCachedError,
'OCA\\Mail\\Exception\\SentMailboxNotSetException': NoSentMailboxConfiguredError,
'OCA\\Mail\\Exception\\TrashMailboxNotSetException': NoTrashMailboxConfiguredError,
+ 'OCA\\Mail\\Exception\\CouldNotConnectException': CouldNotConnectError,
+ 'Horde\\ManageSieve\\Exception': ManageSieveError,
}
/**
@@ -54,5 +58,5 @@ export const convertAxiosError = (axiosError) => {
return axiosError
}
- return new map[response.data.data.type]()
+ return new map[response.data.data.type](response.data.message)
}
diff --git a/src/service/SieveService.js b/src/service/SieveService.js
new file mode 100644
index 0000000000..62af4821af
--- /dev/null
+++ b/src/service/SieveService.js
@@ -0,0 +1,58 @@
+/**
+ * @author Daniel Kesselberg
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+import { generateUrl } from '@nextcloud/router'
+import axios from '@nextcloud/axios'
+import { convertAxiosError } from '../errors/convert'
+
+export async function updateAccount(id, data) {
+ const url = generateUrl('/apps/mail/api/sieve/account/{id}', {
+ id,
+ })
+
+ try {
+ return (await axios.put(url, data)).data
+ } catch (error) {
+ throw convertAxiosError(error)
+ }
+}
+
+export async function getActiveScript(id) {
+ const url = generateUrl('/apps/mail/api/sieve/active/{id}', {
+ id,
+ })
+
+ try {
+ return (await axios.get(url)).data
+ } catch (error) {
+ throw convertAxiosError(error)
+ }
+}
+
+export async function updateActiveScript(id, data) {
+ const url = generateUrl('/apps/mail/api/sieve/active/{id}', {
+ id,
+ })
+
+ try {
+ return (await axios.put(url, data)).data
+ } catch (error) {
+ throw convertAxiosError(error)
+ }
+}
diff --git a/src/store/actions.js b/src/store/actions.js
index 85ab40fa13..545ca31bdd 100644
--- a/src/store/actions.js
+++ b/src/store/actions.js
@@ -62,10 +62,10 @@ import {
fetchEnvelope,
fetchEnvelopes,
fetchMessage,
- setEnvelopeFlag,
- syncEnvelopes,
fetchThread,
moveMessage,
+ setEnvelopeFlag,
+ syncEnvelopes,
} from '../service/MessageService'
import { createAlias, deleteAlias } from '../service/AliasService'
import logger from '../logger'
@@ -76,6 +76,7 @@ import SyncIncompleteError from '../errors/SyncIncompleteError'
import MailboxLockedError from '../errors/MailboxLockedError'
import { wait } from '../util/wait'
import { UNIFIED_INBOX_ID } from './constants'
+import { updateAccount as updateSieveAccount } from '../service/SieveService'
const PAGE_SIZE = 20
@@ -715,4 +716,14 @@ export default {
commit('removeEnvelope', { id })
commit('removeMessage', { id })
},
+ async updateSieveAccount({ commit }, { account, data }) {
+ logger.debug(`update sieve settings for account ${account.id}`)
+ try {
+ await updateSieveAccount(account.id, data)
+ commit('patchAccount', { account, data })
+ } catch (error) {
+ logger.error('failed to update sieve account: ', { error })
+ throw error
+ }
+ },
}
diff --git a/tests/Integration/Db/MailAccountTest.php b/tests/Integration/Db/MailAccountTest.php
index 8bf2af9493..fd2ad11e3c 100644
--- a/tests/Integration/Db/MailAccountTest.php
+++ b/tests/Integration/Db/MailAccountTest.php
@@ -69,6 +69,7 @@ public function testToAPI() {
'draftsMailboxId' => null,
'sentMailboxId' => null,
'trashMailboxId' => null,
+ 'sieveEnabled' => false,
], $a->toJson());
}
@@ -95,6 +96,7 @@ public function testMailAccountConstruct() {
'draftsMailboxId' => null,
'sentMailboxId' => null,
'trashMailboxId' => null,
+ 'sieveEnabled' => false,
];
$a = new MailAccount($expected);
// TODO: fix inconsistency
diff --git a/tests/Integration/Sieve/SieveClientFactoryTest.php b/tests/Integration/Sieve/SieveClientFactoryTest.php
new file mode 100644
index 0000000000..47964c32c4
--- /dev/null
+++ b/tests/Integration/Sieve/SieveClientFactoryTest.php
@@ -0,0 +1,117 @@
+
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+namespace OCA\Mail\Tests\Integration\Sieve;
+
+use ChristophWurst\Nextcloud\Testing\TestCase;
+use Horde\ManageSieve;
+use OC;
+use OCA\Mail\Account;
+use OCA\Mail\Db\MailAccount;
+use OCA\Mail\Sieve\SieveClientFactory;
+use OCP\IConfig;
+use OCP\Security\ICrypto;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class SieveClientFactoryTest extends TestCase {
+
+ /** @var ICrypto|MockObject */
+ private $crypto;
+
+ /** @var IConfig|MockObject */
+ private $config;
+
+ /** @var SieveClientFactory */
+ private $factory;
+
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->crypto = $this->createMock(ICrypto::class);
+ $this->config = $this->createMock(IConfig::class);
+
+ $this->config->method('getSystemValue')
+ ->willReturnCallback(static function ($key, $default) {
+ if ($key === 'app.mail.sieve.timeout') {
+ return 5;
+ }
+ if ($key === 'debug') {
+ return false;
+ }
+ return null;
+ });
+
+ $this->config->method('getSystemValueBool')
+ ->with('app.mail.verify-tls-peer', true)
+ ->willReturn(false);
+
+ $this->factory = new SieveClientFactory($this->crypto, $this->config);
+ }
+
+ /**
+ * @return Account
+ */
+ private function getTestAccount() {
+ $mailAccount = new MailAccount();
+ $mailAccount->setId(123);
+ $mailAccount->setEmail('user@domain.tld');
+ $mailAccount->setInboundHost('127.0.0.1');
+ $mailAccount->setInboundPort(993);
+ $mailAccount->setInboundSslMode('ssl');
+ $mailAccount->setInboundUser('user@domain.tld');
+ $mailAccount->setInboundPassword(OC::$server->get(ICrypto::class)->encrypt('mypassword'));
+ $mailAccount->setSieveHost('127.0.0.1');
+ $mailAccount->setSievePort(4190);
+ $mailAccount->setSieveSslMode('');
+ $mailAccount->setSieveUser('');
+ $mailAccount->setSievePassword('');
+ return new Account($mailAccount);
+ }
+
+ public function testClientConnectivity() {
+ $account = $this->getTestAccount();
+ $this->crypto->expects($this->once())
+ ->method('decrypt')
+ ->with($account->getMailAccount()->getInboundPassword())
+ ->willReturn('mypassword');
+
+ $client = $this->factory->getClient($account);
+ $this->assertInstanceOf(ManageSieve::class, $client);
+ }
+
+ public function testClientInstallScript() {
+ $account = $this->getTestAccount();
+ $this->crypto->expects($this->once())
+ ->method('decrypt')
+ ->with($account->getMailAccount()->getInboundPassword())
+ ->willReturn('mypassword');
+
+ $client = $this->factory->getClient($account);
+
+ $client->installScript('test', '#test');
+ $this->assertCount(1, $client->listScripts());
+
+ $client->removeScript('test');
+ $this->assertCount(0, $client->listScripts());
+ }
+}
diff --git a/tests/Integration/Sieve/SieveLoggerTest.php b/tests/Integration/Sieve/SieveLoggerTest.php
new file mode 100644
index 0000000000..fbb526a761
--- /dev/null
+++ b/tests/Integration/Sieve/SieveLoggerTest.php
@@ -0,0 +1,46 @@
+
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+namespace OCA\Mail\Tests\Integration\Sieve;
+
+use ChristophWurst\Nextcloud\Testing\TestCase;
+use OCA\Mail\Sieve\SieveLogger;
+
+class SieveLoggerTest extends TestCase {
+ public function testOpenInvalidFile(): void {
+ $this->expectException(\InvalidArgumentException::class);
+ $this->expectDeprecationMessage('Unable to use "/root/horde_sieve.log" as log file for sieve.');
+ new SieveLogger('/root/horde_sieve.log');
+ }
+
+ public function testWriteLog(): void {
+ $logFile = sys_get_temp_dir() . '/horde_sieve.log';
+ @unlink($logFile);
+
+ $logger = new SieveLogger($logFile);
+ $logger->debug('Test');
+ unset($logger);
+
+ $this->assertStringEqualsFile($logFile, 'Test');
+ }
+}
diff --git a/tests/Unit/Controller/SettingsControllerTest.php b/tests/Unit/Controller/SettingsControllerTest.php
index 0c97f60f7b..c19b459ca8 100644
--- a/tests/Unit/Controller/SettingsControllerTest.php
+++ b/tests/Unit/Controller/SettingsControllerTest.php
@@ -58,7 +58,12 @@ public function testProvisioning() {
'%USERID%@domain.com',
'mx.domain.com',
567,
- 'tls'
+ 'tls',
+ false,
+ '',
+ '',
+ 0,
+ ''
);
$response = $this->controller->provisioning(
@@ -70,7 +75,12 @@ public function testProvisioning() {
'%USERID%@domain.com',
'mx.domain.com',
567,
- 'tls'
+ 'tls',
+ false,
+ '',
+ '',
+ 0,
+ ''
);
$this->assertInstanceOf(JSONResponse::class, $response);
diff --git a/tests/Unit/Controller/SieveControllerTest.php b/tests/Unit/Controller/SieveControllerTest.php
new file mode 100644
index 0000000000..2d80afcbb8
--- /dev/null
+++ b/tests/Unit/Controller/SieveControllerTest.php
@@ -0,0 +1,166 @@
+
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+namespace OCA\Mail\Tests\Unit\Controller;
+
+use ChristophWurst\Nextcloud\Testing\ServiceMockObject;
+use Horde\ManageSieve\Exception;
+use OCA\Mail\Account;
+use OCA\Mail\Controller\SieveController;
+use OCA\Mail\Db\MailAccount;
+use OCA\Mail\Exception\CouldNotConnectException;
+use OCA\Mail\Tests\Integration\TestCase;
+
+class SieveControllerTest extends TestCase {
+
+ /** @var ServiceMockObject */
+ private $serviceMock;
+
+ /** @var SieveController */
+ private $sieveController;
+
+
+ protected function setUp(): void {
+ parent::setUp();
+ $this->serviceMock = $this->createServiceMock(
+ SieveController::class,
+ ['UserId' => '1']
+ );
+ $this->sieveController = $this->serviceMock->getService();
+ }
+
+ public function testUpdateAccountDisable(): void {
+ $mailAccountMapper = $this->serviceMock->getParameter('mailAccountMapper');
+ $mailAccountMapper->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new MailAccount());
+ $mailAccountMapper->expects($this->once())
+ ->method('save');
+
+ $response = $this->sieveController->updateAccount(2, false, '', 0, '', '', '');
+ $this->assertEquals(false, $response->getData()['sieveEnabled']);
+ }
+
+ public function testUpdateAccountEnable(): void {
+ $mailAccountMapper = $this->serviceMock->getParameter('mailAccountMapper');
+ $mailAccountMapper->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new MailAccount());
+ $mailAccountMapper->expects($this->once())
+ ->method('save');
+
+ $response = $this->sieveController->updateAccount(2, true, 'localhost', 4190, 'user', 'password', '');
+ $this->assertEquals(true, $response->getData()['sieveEnabled']);
+ }
+
+ public function testUpdateAccountEnableImapCredentials(): void {
+ $mailAccount = new MailAccount();
+ $mailAccount->setInboundUser('imap_user');
+ $mailAccount->setInboundPassword('imap_password');
+
+ $mailAccountMapper = $this->serviceMock->getParameter('mailAccountMapper');
+ $mailAccountMapper->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn($mailAccount);
+ $mailAccountMapper->expects($this->once())
+ ->method('save');
+
+ $response = $this->sieveController->updateAccount(2, true, 'localhost', 4190, '', '', '');
+ $this->assertEquals(true, $response->getData()['sieveEnabled']);
+ }
+
+ public function testUpdateAccountEnableNoConnection(): void {
+ $this->expectException(CouldNotConnectException::class);
+ $this->expectExceptionMessage('Connection to ManageSieve at localhost:4190 failed. Computer says no');
+
+ $mailAccountMapper = $this->serviceMock->getParameter('mailAccountMapper');
+ $mailAccountMapper->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new MailAccount());
+
+ $sieveClientFactory = $this->serviceMock->getParameter('sieveClientFactory');
+ $sieveClientFactory->expects($this->once())
+ ->method('createClient')
+ ->willThrowException(new Exception('Computer says no'));
+
+ $this->sieveController->updateAccount(2, true, 'localhost', 4190, 'user', 'password', '');
+ }
+
+ public function testGetActiveScript(): void {
+ $mailAccount = new MailAccount();
+ $mailAccount->setSieveEnabled(true);
+ $mailAccount->setSieveHost('localhost');
+ $mailAccount->setSievePort(4190);
+ $mailAccount->setSieveUser('user');
+ $mailAccount->setSievePassword('password');
+ $mailAccount->setSieveSslMode('');
+
+ $accountService = $this->serviceMock->getParameter('accountService');
+ $accountService->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new Account($mailAccount));
+
+ $response = $this->sieveController->getActiveScript(2);
+ $this->assertEquals(['scriptName' => '', 'script' => ''], $response->getData());
+ }
+
+ public function testGetActiveScriptNoSieve(): void {
+ $this->expectException(CouldNotConnectException::class);
+ $this->expectExceptionMessage('ManageSieve is disabled');
+
+ $mailAccount = new MailAccount();
+ $mailAccount->setSieveEnabled(false);
+
+ $accountService = $this->serviceMock->getParameter('accountService');
+ $accountService->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new Account($mailAccount));
+
+ $this->sieveController->getActiveScript(2);
+ }
+
+ public function testUpdateActiveScript(): void {
+ $mailAccount = new MailAccount();
+ $mailAccount->setSieveEnabled(true);
+ $mailAccount->setSieveHost('localhost');
+ $mailAccount->setSievePort(4190);
+ $mailAccount->setSieveUser('user');
+ $mailAccount->setSievePassword('password');
+ $mailAccount->setSieveSslMode('');
+
+ $accountService = $this->serviceMock->getParameter('accountService');
+ $accountService->expects($this->once())
+ ->method('find')
+ ->with('1', 2)
+ ->willReturn(new Account($mailAccount));
+
+ $response = $this->sieveController->updateActiveScript(2, 'sieve script');
+ $this->assertEquals([], $response->getData());
+ }
+}
diff --git a/tests/Unit/Migration/AddSieveToProvisioningConfigTest.php b/tests/Unit/Migration/AddSieveToProvisioningConfigTest.php
new file mode 100644
index 0000000000..a8ddcec3c6
--- /dev/null
+++ b/tests/Unit/Migration/AddSieveToProvisioningConfigTest.php
@@ -0,0 +1,121 @@
+
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see
+ *
+ */
+
+namespace OCA\Mail\Tests\Unit\Migration;
+
+use ChristophWurst\Nextcloud\Testing\ServiceMockObject;
+use ChristophWurst\Nextcloud\Testing\TestCase;
+use OCA\Mail\Migration\AddSieveToProvisioningConfig;
+use OCA\Mail\Service\Provisioning\Config;
+use OCP\Migration\IOutput;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class AddSieveToProvisioningConfigTest extends TestCase {
+
+ /** @var ServiceMockObject */
+ private $mock;
+
+ /** @var AddSieveToProvisioningConfig */
+ private $repairStep;
+
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->mock = $this->createServiceMock(AddSieveToProvisioningConfig::class);
+ $this->repairStep = $this->mock->getService();
+ }
+
+
+ public function testRunNoConfigToMigrate() {
+ $this->mock->getParameter('config')
+ ->expects($this->once())
+ ->method('getAppValue')
+ ->with('mail', 'installed_version')
+ ->willReturn('1.8.0');
+
+ /** @var IOutput|MockObject $output */
+ $output = $this->createMock(IOutput::class);
+ $output->expects($this->never())
+ ->method('info');
+
+ $this->repairStep->run($output);
+ }
+
+ public function testRun() {
+ $this->mock->getParameter('config')
+ ->expects($this->once())
+ ->method('getAppValue')
+ ->with('mail', 'installed_version')
+ ->willReturn('1.8.0');
+
+ $this->mock->getParameter('configMapper')
+ ->expects($this->once())
+ ->method('load')
+ ->willReturn(new Config([
+ 'email' => '%USERID%@domain.com',
+ 'imapUser' => '%USERID%@domain.com',
+ 'imapHost' => 'mx.domain.com',
+ 'imapPort' => 993,
+ 'imapSslMode' => 'ssl',
+ 'smtpUser' => '%USERID%@domain.com',
+ 'smtpHost' => 'mx.domain.com',
+ 'smtpPort' => 567,
+ 'smtpSslMode' => 'tls',
+ ]));
+
+ $this->mock->getParameter('configMapper')
+ ->expects($this->once())
+ ->method('save')
+ ->with(new Config([
+ 'email' => '%USERID%@domain.com',
+ 'imapUser' => '%USERID%@domain.com',
+ 'imapHost' => 'mx.domain.com',
+ 'imapPort' => 993,
+ 'imapSslMode' => 'ssl',
+ 'smtpUser' => '%USERID%@domain.com',
+ 'smtpHost' => 'mx.domain.com',
+ 'smtpPort' => 567,
+ 'smtpSslMode' => 'tls',
+ 'sieveEnabled' => false,
+ 'sieveHost' => '',
+ 'sievePort' => 4190,
+ 'sieveUser' => '',
+ 'sieveSslMode' => 'tls',
+ ]));
+
+ /** @var IOutput|MockObject $output */
+ $output = $this->createMock(IOutput::class);
+ $output->expects($this->once())
+ ->method('info')
+ ->with('added sieve defaults to provisioning config');
+
+ $this->repairStep->run($output);
+ }
+
+ public function testGetName() {
+ $this->assertEquals(
+ 'Add sieve defaults to provisioning config',
+ $this->repairStep->getName()
+ );
+ }
+}
diff --git a/tests/Unit/Service/Provisioning/ConfigTest.php b/tests/Unit/Service/Provisioning/ConfigTest.php
index b5222be645..839bfcb767 100644
--- a/tests/Unit/Service/Provisioning/ConfigTest.php
+++ b/tests/Unit/Service/Provisioning/ConfigTest.php
@@ -56,30 +56,6 @@ public function testBuildEmailWithEmailPlaceholder() {
$this->assertEquals('user@domain.se', $config->buildEmail($user));
}
- public function testGetImapHost() {
- $config = new Config([
- 'imapHost' => 'imap.domain.com',
- ]);
-
- $this->assertEquals('imap.domain.com', $config->getImapHost());
- }
-
- public function testGetImapPort() {
- $config = new Config([
- 'imapPort' => 993,
- ]);
-
- $this->assertEquals(993, $config->getImapPort());
- }
-
- public function testGetImapSslMode() {
- $config = new Config([
- 'imapSslMode' => 'ssl',
- ]);
-
- $this->assertEquals('ssl', $config->getImapSslMode());
- }
-
public function testBuildImapUserWithUserId() {
$user = $this->createMock(IUser::class);
$config = new Config([
@@ -125,34 +101,55 @@ public function testBuildImapUserFromDefaultEmail() {
$this->assertEquals('user@domain.se', $config->buildImapUser($user));
}
- public function testGetSmtpSslMode() {
+ public function testBuildSmtpUserWithUserId() {
+ $user = $this->createMock(IUser::class);
$config = new Config([
- 'smtpSslMode' => 'tls',
+ 'smtpUser' => '%USERID%@domain.se',
]);
+ $user->expects($this->exactly(2))
+ ->method('getUID')
+ ->willReturn('test');
+ $user->expects($this->once())
+ ->method('getEMailAddress')
+ ->willReturn(null);
- $this->assertEquals('tls', $config->getSmtpSslMode());
+ $this->assertEquals('test@domain.se', $config->buildSmtpUser($user));
}
- public function testGetSmtpHost() {
+ public function testBuilldSmtpUserWithEmailPlaceholder() {
+ $user = $this->createMock(IUser::class);
$config = new Config([
- 'smtpHost' => 'smtp.domain.com',
+ 'smtpUser' => '%EMAIL%',
]);
+ $user->expects($this->any())
+ ->method('getUID')
+ ->willReturn(null);
+ $user->expects($this->any())
+ ->method('getEMailAddress')
+ ->willReturn('user@domain.se');
- $this->assertEquals('smtp.domain.com', $config->getSmtpHost());
+ $this->assertEquals('user@domain.se', $config->buildSmtpUser($user));
}
- public function testGetSmtpPort() {
+ public function testBuildSmtpUserFromDefaultEmail() {
+ $user = $this->createMock(IUser::class);
$config = new Config([
- 'smtpPort' => 465,
+ 'email' => '%EMAIL%',
]);
+ $user->expects($this->exactly(2))
+ ->method('getUID')
+ ->willReturn('user');
+ $user->expects($this->exactly(2))
+ ->method('getEMailAddress')
+ ->willReturn('user@domain.se');
- $this->assertEquals(465, $config->getSmtpPort());
+ $this->assertEquals('user@domain.se', $config->buildImapUser($user));
}
- public function testBuildSmtpUserWithUserId() {
+ public function testBuildSieveUserWithUserId(): void {
$user = $this->createMock(IUser::class);
$config = new Config([
- 'smtpUser' => '%USERID%@domain.se',
+ 'sieveUser' => '%USERID%@domain.se',
]);
$user->expects($this->exactly(2))
->method('getUID')
@@ -161,25 +158,25 @@ public function testBuildSmtpUserWithUserId() {
->method('getEMailAddress')
->willReturn(null);
- $this->assertEquals('test@domain.se', $config->buildSmtpUser($user));
+ $this->assertEquals('test@domain.se', $config->buildSieveUser($user));
}
- public function testBuilldSmtpUserWithEmailPlaceholder() {
+ public function testBuilldSieveUserWithEmailPlaceholder(): void {
$user = $this->createMock(IUser::class);
$config = new Config([
- 'smtpUser' => '%EMAIL%',
+ 'sieveUser' => '%EMAIL%',
]);
- $user->expects($this->any())
+ $user->expects($this->once())
->method('getUID')
->willReturn(null);
- $user->expects($this->any())
+ $user->expects($this->exactly(2))
->method('getEMailAddress')
->willReturn('user@domain.se');
- $this->assertEquals('user@domain.se', $config->buildSmtpUser($user));
+ $this->assertEquals('user@domain.se', $config->buildSieveUser($user));
}
- public function testBuildSmtpUserFromDefaultEmail() {
+ public function testBuildSieveUserFromDefaultEmail(): void {
$user = $this->createMock(IUser::class);
$config = new Config([
'email' => '%EMAIL%',
@@ -191,6 +188,33 @@ public function testBuildSmtpUserFromDefaultEmail() {
->method('getEMailAddress')
->willReturn('user@domain.se');
- $this->assertEquals('user@domain.se', $config->buildImapUser($user));
+ $this->assertEquals('user@domain.se', $config->buildSieveUser($user));
+ }
+
+ /**
+ * @param string $key
+ * @param mixed $value
+ * @dataProvider providerTestGetter
+ */
+ public function testGetter(string $key, $value): void {
+ $config = new Config([
+ $key => $value
+ ]);
+ $this->assertEquals($value, $config->{'get' . ucfirst($key)}());
+ }
+
+ public function providerTestGetter(): array {
+ return [
+ 'smtpHost' => ['smtpHost', 'smtp.domain.com'],
+ 'smtpPort' => ['smtpPort', 465],
+ 'smtpSslMode' => ['smtpSslMode', 'tls'],
+ 'imapHost' => ['imapHost', 'imap.domain.com'],
+ 'imapPort' => ['imapPort', 993],
+ 'imapSslMode' => ['imapSslMode', 'tls'],
+ 'sieveEnabled' => ['sieveEnabled', true],
+ 'sieveHost' => ['sieveHost', 'imap.domain.com'],
+ 'sievePort' => ['sieveHost', 4190],
+ 'sieveSslMode' => ['sieveSslMode', 'tls'],
+ ];
}
}
diff --git a/tests/Unit/Service/Provisioning/ManagerTest.php b/tests/Unit/Service/Provisioning/ManagerTest.php
index 66b0accfc7..81b0ede1e6 100644
--- a/tests/Unit/Service/Provisioning/ManagerTest.php
+++ b/tests/Unit/Service/Provisioning/ManagerTest.php
@@ -178,6 +178,11 @@ public function testNewProvisioning() {
'%USERID%@domain.com',
'mx.domain.com',
567,
+ 'tls',
+ false,
+ '',
+ '',
+ 0,
'tls'
);
}
diff --git a/tests/Unit/Service/Provisioning/TestConfig.php b/tests/Unit/Service/Provisioning/TestConfig.php
index 26cf72bdc3..9ebf3157a1 100644
--- a/tests/Unit/Service/Provisioning/TestConfig.php
+++ b/tests/Unit/Service/Provisioning/TestConfig.php
@@ -39,6 +39,11 @@ public function __construct() {
'smtpHost' => 'mx.domain.com',
'smtpPort' => 567,
'smtpSslMode' => 'tls',
+ 'sieveEnabled' => false,
+ 'sieveHost' => '',
+ 'sievePort' => 4190,
+ 'sieveUser' => '',
+ 'sieveSslMode' => 'tls',
]);
}
}
diff --git a/tests/Unit/Service/SetupServiceTest.php b/tests/Unit/Service/SetupServiceTest.php
index 0bf424a578..70288db2a6 100644
--- a/tests/Unit/Service/SetupServiceTest.php
+++ b/tests/Unit/Service/SetupServiceTest.php
@@ -28,6 +28,7 @@
use OCA\Mail\Account;
use OCA\Mail\Db\MailAccount;
+use OCA\Mail\IMAP\IMAPClientFactory;
use OCA\Mail\Service\AccountService;
use OCA\Mail\Service\AutoConfig\AutoConfig;
use OCA\Mail\Service\SetupService;
@@ -51,6 +52,9 @@ class SetupServiceTest extends TestCase {
/** @var SmtpClientFactory|MockObject */
private $smtpClientFactory;
+ /** @var IMAPClientFactory|MockObject */
+ private $imapClientFactory;
+
/** @var LoggerInterface|MockObject */
private $logger;
@@ -64,6 +68,7 @@ protected function setUp(): void {
$this->accountService = $this->createMock(AccountService::class);
$this->crypto = $this->createMock(ICrypto::class);
$this->smtpClientFactory = $this->createMock(SmtpClientFactory::class);
+ $this->imapClientFactory = $this->createMock(IMAPClientFactory::class);
$this->logger = $this->createMock(LoggerInterface::class);
$this->service = new SetupService(
@@ -71,6 +76,7 @@ protected function setUp(): void {
$this->accountService,
$this->crypto,
$this->smtpClientFactory,
+ $this->imapClientFactory,
$this->logger
);
}