Skip to content
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

Provide an API to interact with CalDav server #1465

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -498,8 +498,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 @@ -18,8 +18,9 @@

package com.linagora.tmail.james.app;

import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
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,21 +35,23 @@
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;

import com.github.fge.lambdas.Throwing;
import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import com.google.common.collect.ImmutableList;
import com.google.inject.multibindings.Multibinder;
import com.linagora.tmail.AmqpUri;
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;

public class DistributedServerWithOpenPaasConfiguredTest {

Expand All @@ -59,7 +62,7 @@ public class DistributedServerWithOpenPaasConfiguredTest {
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 +76,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 +97,14 @@ void serverShouldStart(GuiceJamesServer server) {
}

@Nested
class CardDav {
class DavConfigured {
@RegisterExtension
static CardDavServerExtension cardDavServerExtension = new CardDavServerExtension();
@Order(1)
static DavServerExtension davServerExtension = new DavServerExtension(
WireMockExtension.extensionOptions()
.options(wireMockConfig().dynamicPort()));

@Order(2)
@RegisterExtension
static JamesServerExtension
testExtension = new JamesServerBuilder<DistributedJamesConfiguration>(tmpDir ->
Expand All @@ -107,11 +114,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 @@ -265,8 +265,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());
chibenwa marked this conversation as resolved.
Show resolved Hide resolved
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 @@ -18,8 +18,9 @@

package com.linagora.tmail.james.app;

import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
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 @@ -38,14 +39,15 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import com.github.fge.lambdas.Throwing;
import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import com.google.common.collect.ImmutableList;
import com.google.inject.multibindings.Multibinder;
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.encrypted.MailboxConfiguration;
import com.linagora.tmail.encrypted.MailboxManagerClassProbe;
import com.linagora.tmail.module.LinagoraTestJMAPServerModule;
Expand All @@ -59,7 +61,7 @@ class MemoryServerWithOpenPaasConfiguredTest {
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 +73,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 +91,11 @@ void serverShouldStart(GuiceJamesServer server) {
}

@Nested
class CardDav {
class DavConfigured {
@RegisterExtension
static CardDavServerExtension cardDavServerExtension = new CardDavServerExtension();
static DavServerExtension davServerExtension = new DavServerExtension(
WireMockExtension.extensionOptions()
.options(wireMockConfig().dynamicPort()));

@RegisterExtension
static JamesServerExtension jamesServerExtension = new JamesServerBuilder<MemoryConfiguration>(tmpDir ->
Expand All @@ -100,13 +104,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 @@ -18,6 +18,7 @@

package com.linagora.tmail.integration.distributed;

import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static io.restassured.RestAssured.given;
import static org.apache.james.jmap.JmapRFCCommonRequests.ACCEPT_JMAP_RFC_HEADER;
import static org.hamcrest.Matchers.empty;
Expand All @@ -40,13 +41,14 @@
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import com.google.inject.util.Modules;
import com.linagora.tmail.OpenPaasModule;
import com.linagora.tmail.OpenPaasTestModule;
import com.linagora.tmail.api.OpenPaasServerExtension;
import com.linagora.tmail.blob.guice.BlobStoreConfiguration;
import com.linagora.tmail.carddav.CardDavCreationFactory;
import com.linagora.tmail.carddav.CardDavServerExtension;
import com.linagora.tmail.dav.CardDavUtils;
import com.linagora.tmail.dav.DavServerExtension;
import com.linagora.tmail.integration.ContactIndexingIntegrationContract;
import com.linagora.tmail.james.app.CassandraExtension;
import com.linagora.tmail.james.app.DistributedJamesConfiguration;
Expand All @@ -63,7 +65,9 @@ public class DistributedOpenpaasContactIndexingIntegrationTest extends ContactIn
static OpenPaasServerExtension openPaasServerExtension = new OpenPaasServerExtension();

@RegisterExtension
static CardDavServerExtension cardDavServerExtension = new CardDavServerExtension();
static DavServerExtension davServerExtension = new DavServerExtension(
WireMockExtension.extensionOptions()
.options(wireMockConfig().dynamicPort()));

@RegisterExtension
static JamesServerExtension testExtension = new JamesServerBuilder<DistributedJamesConfiguration>(tmpDir ->
Expand All @@ -88,8 +92,8 @@ public class DistributedOpenpaasContactIndexingIntegrationTest extends ContactIn
.extension(new ClockExtension())
.server(configuration -> DistributedServer.createServer(configuration)
.overrideWith(new LinagoraTestJMAPServerModule())
.overrideWith(Modules.override(new OpenPaasModule(), new OpenPaasModule.CardDavModule())
.with(new OpenPaasTestModule(openPaasServerExtension, Optional.of(cardDavServerExtension.getCardDavConfiguration()), Optional.empty()))))
.overrideWith(Modules.override(new OpenPaasModule(), new OpenPaasModule.DavModule())
.with(new OpenPaasTestModule(openPaasServerExtension, Optional.of(davServerExtension.getDavConfiguration()), Optional.empty()))))
.build();

@Disabled("This is responsibility of the OpenPaas server")
Expand All @@ -105,11 +109,11 @@ void contactIndexingTaskShouldCreateCardDavContact(GuiceJamesServer server) thro

// Set up the scenario for openpaas & carddav extensions
String bobOpenPassUid = UUID.randomUUID().toString();
String andreContactUid = CardDavCreationFactory.createContactUid(ANDRE.asMailAddress());
String andreContactUid = CardDavUtils.createContactUid(ANDRE.asMailAddress());

openPaasServerExtension.setSearchEmailExist(BOB.asString(), bobOpenPassUid);
cardDavServerExtension.setCollectedContactExists(BOB.asString(), bobOpenPassUid, andreContactUid, false);
cardDavServerExtension.setCreateCollectedContact(BOB.asString(), bobOpenPassUid, andreContactUid);
davServerExtension.setCollectedContactExists(BOB.asString(), bobOpenPassUid, andreContactUid, false);
davServerExtension.setCreateCollectedContact(BOB.asString(), bobOpenPassUid, andreContactUid);

// Verify that the andre contact is not indexed
given(jmapSpec)
Expand Down Expand Up @@ -152,6 +156,6 @@ void contactIndexingTaskShouldCreateCardDavContact(GuiceJamesServer server) thro
.body("additionalInformation.failedUsers", empty());

// Verify that the andre contact was created in carddav
cardDavServerExtension.assertCreateCollectedContactWasCalled(BOB.asString(), bobOpenPassUid, andreContactUid, 1);
davServerExtension.assertCreateCollectedContactWasCalled(BOB.asString(), bobOpenPassUid, andreContactUid, 1);
}
}
9 changes: 9 additions & 0 deletions tmail-backend/jmap/extensions-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,15 @@
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>
<dependency>
<groupId>com.ibm.icu</groupId>
<artifactId>icu4j</artifactId>
</dependency>
<dependency>
<groupId>org.mnode.ical4j</groupId>
<artifactId>ical4j</artifactId>
<version>3.2.9</version>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Count on me for forgetting to update the dependency, resulting in a delta, and non-previsible behaviour because of non allignement with Apache James.

We should:

  • Add ical4j in james project management and use it within the scope of Apache James projects
  • And then remove specific versions of Tmail so that we align with James BOM (bill of material)

</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
Expand Down
Loading