Skip to content

Provide an API to interact with CalDav server #1465

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.

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

Merged
merged 13 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions docs/modules/ROOT/pages/tmail-backend/configure/openpaas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ For more information about the OpenPaas integration, see xref:tmail-backend/feat
| Whether the OpenPaaS Rest client should trust all SSL certificates. Optional, boolean. Default to false.
| openpaas.queues.quorum.bypass
| Whether to ignore quorum queues setting from `rabbitmq.properties`. Optional, boolean. Default to false. If `true`, OpenPaaS queues would use classic queues.
| carddav.api.uri
| Optional. URI for CardDAV API. Example: `carddav.api.uri=http://sabre_dav:80/api`
| carddav.admin.user
| Admin username for CardDAV. Example: `carddav.admin.user=admin`
| carddav.admin.password
| Admin password for CardDAV. Example: `carddav.admin.password=admin`
| carddav.rest.client.trust.all.ssl.certs
| Whether the CardDAV Rest client should trust all SSL certificates. Optional, boolean. Default to false.
| carddav.rest.client.response.timeout
| Timeout for CardDAV Rest client. Optional, integer. Unit is milliseconds. Default to 10000.
| dav.api.uri
| Optional. URI for DAV API. Example: `dav.api.uri=http://sabre_dav:80/api`
| dav.admin.user
| Admin username for DAV. Example: `dav.admin.user=admin`
| dav.admin.password
| Admin password for DAV. Example: `dav.admin.password=admin`
| dav.rest.client.trust.all.ssl.certs
| Whether the DAV Rest client should trust all SSL certificates. Optional, boolean. Default to false.
| dav.rest.client.response.timeout
| Timeout for DAV Rest client. Optional, integer. Unit is milliseconds. Default to 10000.
|===

== OpenPaasAmqpForwardAttribute
Expand Down
4 changes: 2 additions & 2 deletions tmail-backend/apps/distributed/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,8 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mock-server</groupId>
<artifactId>mockserver-netty</artifactId>
<groupId>org.wiremock</groupId>
<artifactId>wiremock-standalone</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,8 @@ private static List<Module> chooseLinagoraServicesDiscovery(LinagoraServicesDisc
private static List<Module> chooseOpenPaasModule(OpenPaasModuleChooserConfiguration openPaasModuleChooserConfiguration) {
if (openPaasModuleChooserConfiguration.enabled()) {
ImmutableList.Builder<Module> moduleBuilder = ImmutableList.<Module>builder().add(new OpenPaasModule());
if (openPaasModuleChooserConfiguration.cardDavCollectedContactEnabled()) {
moduleBuilder.add(new OpenPaasModule.CardDavModule());
if (openPaasModuleChooserConfiguration.shouldEnableDavServerInteraction()) {
moduleBuilder.add(new OpenPaasModule.DavModule());
}
if (openPaasModuleChooserConfiguration.contactsConsumerEnabled()) {
moduleBuilder.add(new OpenPaasContactsConsumerModule());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
package com.linagora.tmail.james.app;

import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLED;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CARDDAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_DAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CONTACTS_CONSUMER;
import static com.linagora.tmail.configuration.OpenPaasConfiguration.OPENPAAS_QUEUES_QUORUM_BYPASS_DISABLED;
import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -34,6 +34,7 @@
import org.apache.james.backends.redis.RedisExtension;
import org.apache.james.utils.GuiceProbe;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

Expand All @@ -44,22 +45,22 @@
import com.linagora.tmail.OpenPaasModuleChooserConfiguration;
import com.linagora.tmail.OpenPaasTestModule;
import com.linagora.tmail.UsersRepositoryModuleChooser;
import com.linagora.tmail.api.OpenPaasServerExtension;
import com.linagora.tmail.carddav.CardDavServerExtension;
import com.linagora.tmail.combined.identity.LdapExtension;
import com.linagora.tmail.combined.identity.UsersRepositoryClassProbe;
import com.linagora.tmail.configuration.OpenPaasConfiguration;
import com.linagora.tmail.dav.DavServerExtension;
import com.linagora.tmail.dav.WireMockOpenPaaSServerExtension;

public class DistributedServerWithOpenPaasConfiguredTest {

@RegisterExtension
static OpenPaasServerExtension openPaasServerExtension = new OpenPaasServerExtension();
static WireMockOpenPaaSServerExtension openPaasServerExtension = new WireMockOpenPaaSServerExtension();

@RegisterExtension
static RabbitMQExtension rabbitMQExtension = new RabbitMQExtension();

@Nested
class ContactsConsumer {
class ContactsConsumerConfigured {
static Function<RabbitMQExtension, OpenPaasConfiguration.ContactConsumerConfiguration> contactConsumerConfigurationFunction = rabbitMQExtension -> new OpenPaasConfiguration.ContactConsumerConfiguration(
ImmutableList.of(AmqpUri.from(Throwing.supplier(() -> rabbitMQExtension.dockerRabbitMQ().amqpUri()).get())),
OPENPAAS_QUEUES_QUORUM_BYPASS_DISABLED);
Expand All @@ -73,7 +74,7 @@ class ContactsConsumer {
.searchConfiguration(SearchConfiguration.openSearch())
.usersRepository(UsersRepositoryModuleChooser.Implementation.COMBINED)
.eventBusKeysChoice(EventBusKeysChoice.REDIS)
.openPassModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_CARDDAV, ENABLE_CONTACTS_CONSUMER))
.openPassModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_DAV, ENABLE_CONTACTS_CONSUMER))
.build())
.server(configuration -> DistributedServer.createServer(configuration)
.overrideWith(binder -> Multibinder.newSetBinder(binder, GuiceProbe.class).addBinding().to(UsersRepositoryClassProbe.class))
Expand All @@ -94,10 +95,12 @@ void serverShouldStart(GuiceJamesServer server) {
}

@Nested
class CardDav {
class DavConfigured {
@RegisterExtension
static CardDavServerExtension cardDavServerExtension = new CardDavServerExtension();
@Order(1)
static DavServerExtension davServerExtension = new DavServerExtension();

@Order(2)
@RegisterExtension
static JamesServerExtension
testExtension = new JamesServerBuilder<DistributedJamesConfiguration>(tmpDir ->
Expand All @@ -107,11 +110,12 @@ class CardDav {
.searchConfiguration(SearchConfiguration.openSearch())
.usersRepository(UsersRepositoryModuleChooser.Implementation.COMBINED)
.eventBusKeysChoice(EventBusKeysChoice.REDIS)
.openPassModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, ENABLE_CARDDAV, !ENABLE_CONTACTS_CONSUMER))
.openPassModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED,
ENABLE_DAV, !ENABLE_CONTACTS_CONSUMER))
.build())
.server(configuration -> DistributedServer.createServer(configuration)
.overrideWith(binder -> Multibinder.newSetBinder(binder, GuiceProbe.class).addBinding().to(UsersRepositoryClassProbe.class))
.overrideWith(new OpenPaasTestModule(openPaasServerExtension, Optional.of(cardDavServerExtension.getCardDavConfiguration()), Optional.empty())))
.overrideWith(new OpenPaasTestModule(openPaasServerExtension, Optional.of(davServerExtension.getDavConfiguration()), Optional.empty())))
.extension(new DockerOpenSearchExtension())
.extension(new CassandraExtension())
.extension(new RabbitMQExtension())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@
import com.linagora.tmail.OpenPaasModule;
import com.linagora.tmail.OpenPaasTestModule;
import com.linagora.tmail.ScheduledReconnectionHandler;
import com.linagora.tmail.api.OpenPaasServerExtension;
import com.linagora.tmail.blob.guice.BlobStoreConfiguration;
import com.linagora.tmail.combined.identity.UsersRepositoryClassProbe;
import com.linagora.tmail.configuration.OpenPaasConfiguration;
import com.linagora.tmail.dav.WireMockOpenPaaSServerExtension;
import com.linagora.tmail.encrypted.MailboxConfiguration;
import com.linagora.tmail.encrypted.MailboxManagerClassProbe;
import com.linagora.tmail.module.LinagoraTestJMAPServerModule;
Expand All @@ -80,7 +80,7 @@ class SchedulerReconnectionHandlerIntegrationTest {
.await();

@RegisterExtension
static OpenPaasServerExtension openPaasServerExtension = new OpenPaasServerExtension();
static WireMockOpenPaaSServerExtension openPaasServerExtension = new WireMockOpenPaaSServerExtension();

static Function<RabbitMQExtension, OpenPaasConfiguration.ContactConsumerConfiguration> contactConsumerConfigurationFunction = rabbitMQExtension -> new OpenPaasConfiguration.ContactConsumerConfiguration(
ImmutableList.of(AmqpUri.from(Throwing.supplier(() -> rabbitMQExtension.dockerRabbitMQ().amqpUri()).get())),
Expand Down Expand Up @@ -242,7 +242,7 @@ private long consumerCount(DockerRabbitMQ dockerRabbitMQ, String queueName) {
}
}

private static Module getOpenPaasModule(OpenPaasServerExtension openPaasServerExtension, RabbitMQExtension rabbitMQExtension) {
private static Module getOpenPaasModule(WireMockOpenPaaSServerExtension openPaasServerExtension, RabbitMQExtension rabbitMQExtension) {
return Modules.override(new OpenPaasModule(), new OpenPaasContactsConsumerModule())
.with(new OpenPaasTestModule(openPaasServerExtension, Optional.empty(),
Optional.of(contactConsumerConfigurationFunction.apply(rabbitMQExtension))));
Expand Down
11 changes: 11 additions & 0 deletions tmail-backend/apps/memory/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@
<groupId>${james.groupId}</groupId>
<artifactId>jmap-rfc-8621-integration-tests-common</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.mock-server</groupId>
<artifactId>mockserver-netty</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>${james.groupId}</groupId>
Expand Down Expand Up @@ -187,6 +193,11 @@
<groupId>com.linagora.tmail</groupId>
<artifactId>logback-json-classic</artifactId>
</dependency>
<dependency>
<groupId>org.wiremock</groupId>
<artifactId>wiremock-standalone</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,8 @@ private static List<Module> chooseOpenPaas(OpenPaasModuleChooserConfiguration mo
if (moduleChooserConfiguration.enabled()) {
ImmutableList.Builder<Module> moduleBuilder = ImmutableList.<Module>builder().add(new OpenPaasModule());

if (moduleChooserConfiguration.cardDavCollectedContactEnabled()) {
moduleBuilder.add(new OpenPaasModule.CardDavModule());
if (moduleChooserConfiguration.shouldEnableDavServerInteraction()) {
moduleBuilder.add(new OpenPaasModule.DavModule());
}
if (moduleChooserConfiguration.contactsConsumerEnabled()) {
moduleBuilder.add(Modules.override(new OpenPaasContactsConsumerModule())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
package com.linagora.tmail.james.app;

import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLED;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CARDDAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_DAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CONTACTS_CONSUMER;
import static com.linagora.tmail.configuration.OpenPaasConfiguration.OPENPAAS_QUEUES_QUORUM_BYPASS_DISABLED;
import static org.apache.james.data.UsersRepositoryModuleChooser.Implementation.DEFAULT;
Expand All @@ -43,23 +43,23 @@
import com.linagora.tmail.AmqpUri;
import com.linagora.tmail.OpenPaasModuleChooserConfiguration;
import com.linagora.tmail.OpenPaasTestModule;
import com.linagora.tmail.api.OpenPaasServerExtension;
import com.linagora.tmail.carddav.CardDavServerExtension;
import com.linagora.tmail.configuration.OpenPaasConfiguration;
import com.linagora.tmail.dav.DavServerExtension;
import com.linagora.tmail.dav.WireMockOpenPaaSServerExtension;
import com.linagora.tmail.encrypted.MailboxConfiguration;
import com.linagora.tmail.encrypted.MailboxManagerClassProbe;
import com.linagora.tmail.module.LinagoraTestJMAPServerModule;

class MemoryServerWithOpenPaasConfiguredTest {

@RegisterExtension
static OpenPaasServerExtension openPaasServerExtension = new OpenPaasServerExtension();
static WireMockOpenPaaSServerExtension openPaasServerExtension = new WireMockOpenPaaSServerExtension();

@RegisterExtension
static RabbitMQExtension rabbitMQExtension = new RabbitMQExtension();

@Nested
class ContactsConsumer {
class ContactsConsumerConfigured {
static Function<RabbitMQExtension, OpenPaasConfiguration.ContactConsumerConfiguration> contactConsumerConfigurationFunction = rabbitMQExtension -> new OpenPaasConfiguration.ContactConsumerConfiguration(
ImmutableList.of(AmqpUri.from(Throwing.supplier(() -> rabbitMQExtension.dockerRabbitMQ().amqpUri()).get())),
OPENPAAS_QUEUES_QUORUM_BYPASS_DISABLED);
Expand All @@ -71,7 +71,7 @@ class ContactsConsumer {
.configurationFromClasspath()
.mailbox(new MailboxConfiguration(false))
.usersRepository(DEFAULT)
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_CARDDAV, ENABLE_CONTACTS_CONSUMER))
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_DAV, ENABLE_CONTACTS_CONSUMER))
.build())
.server(configuration -> MemoryServer.createServer(configuration)
.overrideWith(new LinagoraTestJMAPServerModule())
Expand All @@ -89,9 +89,9 @@ void serverShouldStart(GuiceJamesServer server) {
}

@Nested
class CardDav {
class DavConfigured {
@RegisterExtension
static CardDavServerExtension cardDavServerExtension = new CardDavServerExtension();
static DavServerExtension davServerExtension = new DavServerExtension();

@RegisterExtension
static JamesServerExtension jamesServerExtension = new JamesServerBuilder<MemoryConfiguration>(tmpDir ->
Expand All @@ -100,13 +100,14 @@ class CardDav {
.configurationFromClasspath()
.mailbox(new MailboxConfiguration(false))
.usersRepository(DEFAULT)
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, ENABLE_CARDDAV, !ENABLE_CONTACTS_CONSUMER))
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED,
ENABLE_DAV, !ENABLE_CONTACTS_CONSUMER))
.build())
.server(configuration -> MemoryServer.createServer(configuration)
.overrideWith(new LinagoraTestJMAPServerModule())
.overrideWith(binder -> Multibinder.newSetBinder(binder, GuiceProbe.class).addBinding().to(MailboxManagerClassProbe.class))
.overrideWith(new RabbitMQModule())
.overrideWith(new OpenPaasTestModule(openPaasServerExtension, Optional.of(cardDavServerExtension.getCardDavConfiguration()), Optional.empty())))
.overrideWith(new OpenPaasTestModule(openPaasServerExtension, Optional.of(davServerExtension.getDavConfiguration()), Optional.empty())))
.extension(new RabbitMQExtension())
.build();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
package com.linagora.tmail.james;

import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLED;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CARDDAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_DAV;
import static com.linagora.tmail.OpenPaasModuleChooserConfiguration.ENABLE_CONTACTS_CONSUMER;
import static com.linagora.tmail.configuration.OpenPaasConfiguration.OPENPAAS_QUEUES_QUORUM_BYPASS_DISABLED;
import static com.linagora.tmail.configuration.OpenPaasConfiguration.OPENPAAS_REST_CLIENT_TRUST_ALL_SSL_CERTS_DISABLED;
Expand Down Expand Up @@ -82,7 +82,7 @@ public class MemoryCalendarEventReplyWithAMQPWorkflowTest implements LinagoraCal
.workingDirectory(tmpDir)
.usersRepository(DEFAULT)
.firebaseModuleChooserConfiguration(FirebaseModuleChooserConfiguration.DISABLED)
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_CARDDAV, ENABLE_CONTACTS_CONSUMER))
.openPaasModuleChooserConfiguration(new OpenPaasModuleChooserConfiguration(ENABLED, !ENABLE_DAV, ENABLE_CONTACTS_CONSUMER))
.build();
})
.server(configuration -> MemoryServer.createServer(configuration)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mock-server</groupId>
<artifactId>mockserver-netty</artifactId>
<groupId>org.wiremock</groupId>
<artifactId>wiremock-standalone</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
Expand Down
Loading