Enforce configuration of an XStream instance

Enforce configuration of an XStream instance #49
AxonFramework · Oct 25, 2021 · 479ee29 · 479ee29
1 parent b9e402b
commit 479ee29
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 28 deletions.
diff --git a/...main/java/org/axonframework/extensions/mongo/serialization/DBObjectXStreamSerializer.java b/...main/java/org/axonframework/extensions/mongo/serialization/DBObjectXStreamSerializer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2020. Axon Framework
+ * Copyright (c) 2010-2021. Axon Framework
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,9 +52,9 @@ protected DBObjectXStreamSerializer(Builder builder) {
     /**
      * Instantiate a Builder to be able to create a {@link DBObjectXStreamSerializer}.
      * <p>
-     * The {@link XStream} is defaulted to a {@link XStream#XStream()} call, the {@link Charset} is defaulted to a
-     * {@link Charset#forName(String)} using the {@code UTF-8} character set, the {@link RevisionResolver} defaults to
-     * an {@link AnnotationRevisionResolver} and the {@link Converter} defaults to a {@link ChainingConverter}.
+     * The {@link Charset} is defaulted to a {@link Charset#forName(String)} using the {@code UTF-8} character set, the
+     * {@link RevisionResolver} defaults to an {@link AnnotationRevisionResolver} and the {@link Converter} defaults to
+     * a {@link ChainingConverter}.
      * <p>
      * Upon instantiation, several defaults aliases are added to the XStream instance, for example for the {@link
      * org.axonframework.eventhandling.GenericDomainEventMessage}, the {@link org.axonframework.commandhandling.GenericCommandMessage}
@@ -94,9 +94,9 @@ protected Object doDeserialize(SerializedObject serializedObject, XStream xStrea
     /**
      * Builder class to instantiate a {@link DBObjectXStreamSerializer}.
      * <p>
-     * The {@link XStream} is defaulted to a {@link XStream#XStream()} call, the {@link Charset} is defaulted to a
-     * {@link Charset#forName(String)} using the {@code UTF-8} character set, the {@link RevisionResolver} defaults to
-     * an {@link AnnotationRevisionResolver} and the {@link Converter} defaults to a {@link ChainingConverter}.
+     * The {@link Charset} is defaulted to a {@link Charset#forName(String)} using the {@code UTF-8} character set, the
+     * {@link RevisionResolver} defaults to an {@link AnnotationRevisionResolver} and the {@link Converter} defaults to
+     * a {@link ChainingConverter}.
      * <p>
      * Upon instantiation, several defaults aliases are added to the XStream instance, for example for the {@link
      * org.axonframework.eventhandling.GenericDomainEventMessage}, the {@link org.axonframework.commandhandling.GenericCommandMessage},
@@ -108,13 +108,6 @@ protected Object doDeserialize(SerializedObject serializedObject, XStream xStrea
      */
     public static class Builder extends AbstractXStreamSerializer.Builder {
 
-        private Builder() {
-            xStream(new XStream());
-        }
-
-        /**
-         * {@inheritDoc} Defaults to a {@link XStream#XStream()} call.
-         */
         @Override
         public Builder xStream(XStream xStream) {
             super.xStream(xStream);

diff --git a/...ons/mongo/eventsourcing/eventstore/MongoEventStorageEngineTest_DBObjectSerialization.java b/...ons/mongo/eventsourcing/eventstore/MongoEventStorageEngineTest_DBObjectSerialization.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2020. Axon Framework
+ * Copyright (c) 2010-2021. Axon Framework
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@
 import org.axonframework.extensions.mongo.MongoTemplate;
 import org.axonframework.extensions.mongo.serialization.DBObjectXStreamSerializer;
 import org.axonframework.extensions.mongo.util.MongoTemplateFactory;
-import org.axonframework.serialization.Serializer;
+import org.axonframework.extensions.mongo.utils.TestSerializer;
 import org.junit.jupiter.api.*;
 import org.testcontainers.containers.MongoDBContainer;
 import org.testcontainers.junit.jupiter.Container;
@@ -48,7 +48,6 @@ class MongoEventStorageEngineTest_DBObjectSerialization extends AbstractMongoEve
 
     @Container
     private static final MongoDBContainer MONGO_CONTAINER = new MongoDBContainer("mongo");
-    private static final Serializer DB_OBJECT_XSTREAM_SERIALIZER = DBObjectXStreamSerializer.builder().build();
 
     private MongoTemplate mongoTemplate;
     @SuppressWarnings("FieldCanBeLocal")
@@ -78,7 +77,7 @@ public void tearDown() {
     }
 
     /**
-     * Mongo orders events in time instead of per global index. Thus events with mixing timestamps will be read in the
+     * Mongo orders events in time instead of per global index. Thus, events with mixing timestamps will be read in the
      * time based order, if the {@link org.axonframework.extensions.mongo.eventsourcing.eventstore.documentperevent.DocumentPerEventStorageStrategy}
      * is used.
      */
@@ -103,8 +102,8 @@ public void testCreateTokenAtTimeBeforeFirstEvent() {
     protected MongoEventStorageEngine createEngine(UnaryOperator<MongoEventStorageEngine.Builder> customization) {
         MongoEventStorageEngine.Builder engineBuilder =
                 MongoEventStorageEngine.builder()
-                                       .snapshotSerializer(DB_OBJECT_XSTREAM_SERIALIZER)
-                                       .eventSerializer(DB_OBJECT_XSTREAM_SERIALIZER)
+                                       .snapshotSerializer(TestSerializer.dbObjectXStreamSerializer())
+                                       .eventSerializer(TestSerializer.dbObjectXStreamSerializer())
                                        .mongoTemplate(mongoTemplate);
         return customization.apply(engineBuilder).build();
     }

diff --git a/...k/extensions/mongo/eventsourcing/eventstore/MongoEventStorageEngineTest_DocPerCommit.java b/...k/extensions/mongo/eventsourcing/eventstore/MongoEventStorageEngineTest_DocPerCommit.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2020. Axon Framework
+ * Copyright (c) 2010-2021. Axon Framework
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,10 +25,9 @@
 import org.axonframework.eventsourcing.eventstore.EventStoreException;
 import org.axonframework.extensions.mongo.MongoTemplate;
 import org.axonframework.extensions.mongo.eventsourcing.eventstore.documentpercommit.DocumentPerCommitStorageStrategy;
-import org.axonframework.extensions.mongo.serialization.DBObjectXStreamSerializer;
 import org.axonframework.extensions.mongo.util.MongoTemplateFactory;
+import org.axonframework.extensions.mongo.utils.TestSerializer;
 import org.axonframework.modelling.command.AggregateStreamCreationException;
-import org.axonframework.serialization.Serializer;
 import org.junit.jupiter.api.*;
 import org.testcontainers.containers.MongoDBContainer;
 import org.testcontainers.junit.jupiter.Container;
@@ -55,7 +54,6 @@ class MongoEventStorageEngineTest_DocPerCommit extends AbstractMongoEventStorage
 
     @Container
     private static final MongoDBContainer MONGO_CONTAINER = new MongoDBContainer("mongo");
-    private static final Serializer DB_OBJECT_XSTREAM_SERIALIZER = DBObjectXStreamSerializer.builder().build();
 
     private MongoTemplate mongoTemplate;
     private MongoEventStorageEngine testSubject;
@@ -192,8 +190,8 @@ public void testCreateTokenWithUnorderedEvents() {
     protected MongoEventStorageEngine createEngine(UnaryOperator<MongoEventStorageEngine.Builder> customization) {
         MongoEventStorageEngine.Builder engineBuilder =
                 MongoEventStorageEngine.builder()
-                                       .snapshotSerializer(DB_OBJECT_XSTREAM_SERIALIZER)
-                                       .eventSerializer(DB_OBJECT_XSTREAM_SERIALIZER)
+                                       .snapshotSerializer(TestSerializer.dbObjectXStreamSerializer())
+                                       .eventSerializer(TestSerializer.dbObjectXStreamSerializer())
                                        .mongoTemplate(mongoTemplate)
                                        .storageStrategy(new DocumentPerCommitStorageStrategy());
         return customization.apply(engineBuilder).build();

diff --git a/.../java/org/axonframework/extensions/mongo/serialization/DBObjectXStreamSerializerTest.java b/.../java/org/axonframework/extensions/mongo/serialization/DBObjectXStreamSerializerTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2020. Axon Framework
+ * Copyright (c) 2010-2021. Axon Framework
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 package org.axonframework.extensions.mongo.serialization;
 
+import com.thoughtworks.xstream.XStream;
 import org.axonframework.serialization.Revision;
 import org.axonframework.serialization.SerializedObject;
 import org.junit.jupiter.api.*;
@@ -45,7 +46,9 @@ class DBObjectXStreamSerializerTest {
 
     @BeforeEach
     void setUp() {
-        this.testSubject = DBObjectXStreamSerializer.builder().build();
+        this.testSubject = DBObjectXStreamSerializer.builder()
+                                                    .xStream(new XStream())
+                                                    .build();
     }
 
     @Test

diff --git a/mongo/src/test/java/org/axonframework/extensions/mongo/utils/TestSerializer.java b/mongo/src/test/java/org/axonframework/extensions/mongo/utils/TestSerializer.java
@@ -17,6 +17,7 @@
 package org.axonframework.extensions.mongo.utils;
 
 import com.thoughtworks.xstream.XStream;
+import org.axonframework.extensions.mongo.serialization.DBObjectXStreamSerializer;
 import org.axonframework.serialization.xml.CompactDriver;
 import org.axonframework.serialization.xml.XStreamSerializer;
 
@@ -41,4 +42,15 @@ public static XStreamSerializer xStreamSerializer() {
                                 .xStream(new XStream(new CompactDriver()))
                                 .build();
     }
+
+    /**
+     * Return a {@link DBObjectXStreamSerializer} using a default {@link XStream} instance.
+     *
+     * @return a {@link DBObjectXStreamSerializer} using a default {@link XStream} instance
+     */
+    public static DBObjectXStreamSerializer dbObjectXStreamSerializer() {
+        return DBObjectXStreamSerializer.builder()
+                                        .xStream(new XStream())
+                                        .build();
+    }
 }