You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ro...@apache.org on 2019/07/31 07:49:40 UTC
[james-project] 03/13: JAMES-2813 Add serialization for
ClearMailQueueTaskTest
This is an automated email from the ASF dual-hosted git repository.
rouazana pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 724e995d434127be1acf13effe52dca96c664d71
Author: Gautier DI FOLCO <gd...@linagora.com>
AuthorDate: Thu Jul 18 16:00:31 2019 +0200
JAMES-2813 Add serialization for ClearMailQueueTaskTest
---
.../james/webadmin/service/ClearMailQueueTask.java | 52 ++++++++++++++-
.../webadmin/service/ClearMailQueueTaskTest.java | 77 ++++++++++++++++++++++
2 files changed, 128 insertions(+), 1 deletion(-)
diff --git a/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/service/ClearMailQueueTask.java b/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/service/ClearMailQueueTask.java
index bbf8db9..b9dc686 100644
--- a/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/service/ClearMailQueueTask.java
+++ b/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/service/ClearMailQueueTask.java
@@ -20,15 +20,23 @@
package org.apache.james.webadmin.service;
import java.util.Optional;
+import java.util.function.Function;
import java.util.function.Supplier;
+import org.apache.james.json.DTOModule;
import org.apache.james.queue.api.MailQueue;
+import org.apache.james.queue.api.MailQueueFactory;
import org.apache.james.queue.api.ManageableMailQueue;
+import org.apache.james.server.task.json.dto.TaskDTO;
+import org.apache.james.server.task.json.dto.TaskDTOModule;
import org.apache.james.task.Task;
import org.apache.james.task.TaskExecutionDetails;
+
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
public class ClearMailQueueTask implements Task {
public static class AdditionalInformation implements TaskExecutionDetails.AdditionalInformation {
@@ -55,8 +63,50 @@ public class ClearMailQueueTask implements Task {
}
}
+ public static class UnknownSerializedQueue extends RuntimeException {
+ public UnknownSerializedQueue(String queueName) {
+ super("Unable to retrieve '" + queueName + "' queue");
+ }
+ }
+
+ private static class ClearMailQueueTaskDTO implements TaskDTO {
+
+ public static ClearMailQueueTaskDTO toDTO(ClearMailQueueTask domainObject, String typeName) {
+ return new ClearMailQueueTaskDTO(typeName, domainObject.queue.getName());
+ }
+
+ private final String type;
+ private final String queue;
+
+ public ClearMailQueueTaskDTO(@JsonProperty("type") String type, @JsonProperty("queue") String queue) {
+ this.type = type;
+ this.queue = queue;
+ }
+
+ public ClearMailQueueTask fromDTO(MailQueueFactory<ManageableMailQueue> mailQueueFactory) {
+ return new ClearMailQueueTask(mailQueueFactory.getQueue(queue).orElseThrow(() -> new UnknownSerializedQueue(queue)));
+ }
+
+ @Override
+ public String getType() {
+ return type;
+ }
+
+ public String getQueue() {
+ return queue;
+ }
+ }
+
private static final Logger LOGGER = LoggerFactory.getLogger(ClearMailQueueTask.class);
- public static final String TYPE = "clearMailQueue";
+ public static final String TYPE = "clear-mail-queue";
+ public static final Function<MailQueueFactory<ManageableMailQueue>, TaskDTOModule<ClearMailQueueTask, ClearMailQueueTaskDTO>> MODULE = (mailQueueFactory) ->
+ DTOModule
+ .forDomainObject(ClearMailQueueTask.class)
+ .convertToDTO(ClearMailQueueTaskDTO.class)
+ .toDomainObjectConverter(dto -> dto.fromDTO(mailQueueFactory))
+ .toDTOConverter(ClearMailQueueTaskDTO::toDTO)
+ .typeName(TYPE)
+ .withFactory(TaskDTOModule::new);
private final ManageableMailQueue queue;
private final AdditionalInformation additionalInformation;
diff --git a/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/service/ClearMailQueueTaskTest.java b/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/service/ClearMailQueueTaskTest.java
new file mode 100644
index 0000000..cb2b75a
--- /dev/null
+++ b/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/service/ClearMailQueueTaskTest.java
@@ -0,0 +1,77 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ * ***************************************************************/
+
+package org.apache.james.webadmin.service;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.Optional;
+
+import org.apache.james.queue.api.MailQueueFactory;
+import org.apache.james.queue.api.ManageableMailQueue;
+import org.apache.james.server.task.json.JsonTaskSerializer;
+
+import net.javacrumbs.jsonunit.assertj.JsonAssertions;
+import org.junit.jupiter.api.Test;
+
+class ClearMailQueueTaskTest {
+
+ private static final String SERIALIZED = "{\"type\": \"clear-mail-queue\", \"queue\": \"anyQueue\"}";
+
+ @Test
+ void taskShouldBeSerializable() throws Exception {
+ MailQueueFactory<ManageableMailQueue> mailQueueFactory = mock(MailQueueFactory.class);
+ ManageableMailQueue mockedQueue = mock(ManageableMailQueue.class);
+ String queueName = "anyQueue";
+ when(mockedQueue.getName()).thenReturn(queueName);
+ when(mailQueueFactory.getQueue(anyString())).thenAnswer(arg -> Optional.of(mockedQueue));
+ JsonTaskSerializer testee = new JsonTaskSerializer(ClearMailQueueTask.MODULE.apply(mailQueueFactory));
+
+ ManageableMailQueue queue = mailQueueFactory.getQueue(queueName).get();
+ ClearMailQueueTask task = new ClearMailQueueTask(queue);
+ JsonAssertions.assertThatJson(testee.serialize(task)).isEqualTo(SERIALIZED);
+ }
+
+ @Test
+ void taskShouldBeDeserializable() throws Exception {
+ MailQueueFactory<ManageableMailQueue> mailQueueFactory = mock(MailQueueFactory.class);
+ ManageableMailQueue mockedQueue = mock(ManageableMailQueue.class);
+ String queueName = "anyQueue";
+ when(mockedQueue.getName()).thenReturn(queueName);
+ when(mailQueueFactory.getQueue(anyString())).thenAnswer(arg -> Optional.of(mockedQueue));
+ JsonTaskSerializer testee = new JsonTaskSerializer(ClearMailQueueTask.MODULE.apply(mailQueueFactory));
+
+ ManageableMailQueue queue = mailQueueFactory.getQueue(queueName).get();
+ ClearMailQueueTask task = new ClearMailQueueTask(queue);
+ assertThat(testee.deserialize(SERIALIZED)).isEqualToIgnoringGivenFields(task, "additionalInformation");
+ }
+
+ @Test
+ void taskShouldThrowWhenDeserializeAnUnknownQueue() throws Exception {
+ MailQueueFactory<ManageableMailQueue> mailQueueFactory = mock(MailQueueFactory.class);
+ when(mailQueueFactory.getQueue(anyString())).thenReturn(Optional.empty());
+ JsonTaskSerializer testee = new JsonTaskSerializer(ClearMailQueueTask.MODULE.apply(mailQueueFactory));
+
+ String serializedJson = "{\"type\": \"clear-mail-queue\", \"queue\": \"anyQueue\"}";
+ assertThatThrownBy(() -> testee.deserialize(serializedJson))
+ .isInstanceOf(ClearMailQueueTask.UnknownSerializedQueue.class);
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org