[th2-2469] builders for parsed/raw messages and events

build.gradle

@@ -158,7 +158,7 @@ test {
 dependencies {
     api platform('com.exactpro.th2:bom:3.0.0')
     api "com.exactpro.th2:cradle-core:${cradleVersion}"
-    api 'com.exactpro.th2:grpc-common:3.7.0'
+    api 'com.exactpro.th2:grpc-common:3.8.0-th2-2567-1380894854-SNAPSHOT'
 
     implementation 'com.google.protobuf:protobuf-java-util'
     implementation 'com.exactpro.th2:grpc-service-generator:3.1.12'

src/main/java/com/exactpro/th2/common/event/Event.java

@@ -60,6 +60,7 @@ public class Event {
     protected static final ThreadLocal<ObjectMapper> OBJECT_MAPPER = ThreadLocal.withInitial(() -> new ObjectMapper().setSerializationInclusion(NON_NULL));
 
     protected final String id = generateUUID();
+    protected String bookName;
     protected final List<Event> subEvents = new ArrayList<>();
     protected final List<MessageID> attachedMessageIDS = new ArrayList<>();
     protected final List<IBodyData> body = new ArrayList<>();
@@ -69,34 +70,73 @@ public class Event {
     protected String name;
     protected String description;
     protected Status status = Status.PASSED;
+    private final IEventFactory eventFactory;
 
-    protected Event(Instant startTimestamp, @Nullable Instant endTimestamp) {
+    Event(Instant startTimestamp, @Nullable Instant endTimestamp, IEventFactory eventFactory) {
         this.startTimestamp = startTimestamp;
         this.endTimestamp = endTimestamp;
+        this.eventFactory = eventFactory;
     }
 
-    protected Event(Instant startTimestamp) {
-        this(startTimestamp, null);
+    Event(Instant startTimestamp, IEventFactory eventFactory) {
+        this(startTimestamp, null, eventFactory);
     }
 
-    protected Event() {
-        this(Instant.now());
+    Event(IEventFactory eventFactory) {
+        this(Instant.now(), eventFactory);
     }
 
     /**
      * Creates event with current time as start
+     * @param eventFactory
      * @return new event
      */
+    public static Event start(IEventFactory eventFactory) {
+        return eventFactory.start();
+    }
+
+    /**
+     * Creates event with current time as start
+     * @return new event
+     */
+    @Deprecated
     public static Event start() {
-        return new Event();
+        // TODO eventFactory == null?
+        return new Event(null);
+    }
+
+    /**
+     * Sets event book name if passed {@code bookName} is not blank.
+     * @return current event
+     * @throws IllegalStateException if book name already set
+     */
+    public Event bookName(String bookName) {
+        if (isNotBlank(bookName)) {
+            if (this.bookName != null) {
+                throw new IllegalStateException(formatStateException("Book name", this.bookName));
+            }
+            this.bookName = bookName;
+        }
+        return this;
     }
 
+    /**
+     * Creates event with passed time as start
+     * @param eventFactory
+     * @return new event
+     */
+    public static Event from(Instant startTimestamp, IEventFactory eventFactory) {
+        return eventFactory.from(startTimestamp);
+    }
+
     /**
      * Creates event with passed time as start
      * @return new event
      */
+    @Deprecated
     public static Event from(Instant startTimestamp) {
-        return new Event(startTimestamp);
+        // TODO eventFactory == null?
+        return new Event(startTimestamp, null);
     }
 
     @Contract("null -> null")
@@ -185,7 +225,7 @@ public Event status(Status eventStatus) {
      */
     @SuppressWarnings("NonBooleanMethodNameMayNotStartWithQuestion")
     public Event addSubEventWithSamePeriod() {
-        return addSubEvent(new Event(startTimestamp, endTimestamp));
+        return addSubEvent(eventFactory.from(startTimestamp, endTimestamp, eventFactory));
     }
 
     /**
@@ -245,7 +285,7 @@ public Event messageID(MessageID attachedMessageID) {
      */
     @Deprecated
     public List<com.exactpro.th2.common.grpc.Event> toProtoEvents(@Nullable String parentID) throws JsonProcessingException {
-        return toListProto(toEventID(parentID));
+        return toListProto(toEventID(parentID, bookName));
     }
 
 
@@ -258,7 +298,7 @@ public List<com.exactpro.th2.common.grpc.Event> toListProto(@Nullable EventID pa
      */
     @Deprecated
     public com.exactpro.th2.common.grpc.Event toProtoEvent(@Nullable String parentID) throws JsonProcessingException {
-        return toProto(toEventID(parentID));
+        return toProto(toEventID(parentID, bookName));
     }
 
     public com.exactpro.th2.common.grpc.Event toProto(@Nullable EventID parentID) throws JsonProcessingException {
@@ -271,7 +311,7 @@ public com.exactpro.th2.common.grpc.Event toProto(@Nullable EventID parentID) th
                     .append(description);
         }
         var eventBuilder = com.exactpro.th2.common.grpc.Event.newBuilder()
-                .setId(toEventID(id))
+                .setId(toEventID(id, bookName))
                 .setName(nameBuilder.toString())
                 .setType(defaultIfBlank(type, UNKNOWN_EVENT_TYPE))
                 .setStartTimestamp(toTimestamp(startTimestamp))
@@ -349,13 +389,13 @@ public Instant getEndTimestamp() {
      */
     @Deprecated
     protected List<com.exactpro.th2.common.grpc.Event> collectSubEvents(List<com.exactpro.th2.common.grpc.Event> protoEvents, @Nullable String parentID) throws JsonProcessingException {
-        return collectSubEvents(protoEvents, toEventID(parentID));
+        return collectSubEvents(protoEvents, toEventID(parentID, bookName));
     }
 
     protected List<com.exactpro.th2.common.grpc.Event> collectSubEvents(List<com.exactpro.th2.common.grpc.Event> protoEvents, @Nullable EventID parentID) throws JsonProcessingException {
         protoEvents.add(toProto(parentID)); // collect current level
         for (Event subEvent : subEvents) {
-            subEvent.collectSubEvents(protoEvents, toEventID(id)); // collect sub level
+            subEvent.collectSubEvents(protoEvents, toEventID(id, bookName)); // collect sub level
         }
         return protoEvents;
     }
@@ -365,7 +405,7 @@ protected byte[] buildBody() throws JsonProcessingException {
     }
 
     protected String formatStateException(String fieldName, Object value) {
-        return fieldName + " in event '" + id + "' already sed with value '" + value + '\'';
+        return fieldName + " in event '" + id + "' already set with value '" + value + '\'';
     }
 
     /**

src/main/java/com/exactpro/th2/common/event/EventUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2020 Exactpro (Exactpro Systems Limited)
+ * Copyright 2020-2021 Exactpro (Exactpro Systems Limited)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,11 +38,18 @@ public static Message createMessageBean(String text) {
 
     @Contract("null -> null; !null -> !null")
     public static @Nullable EventID toEventID(@Nullable String id) {
+        return toEventID(id, null);
+    }
+
+    @Contract("null, null -> null; null, !null -> null; !null, !null -> !null; !null, null -> !null")
+    public static @Nullable EventID toEventID(@Nullable String id, @Nullable String bookName) {
         if (id == null) {
             return null;
         }
-        return EventID.newBuilder()
-                .setId(id)
-                .build();
+        EventID.Builder builder = EventID.newBuilder().setId(id);
+        if (bookName != null) {
+            builder.setBookName(bookName);
+        }
+        return builder.build();
     }
 }

src/main/java/com/exactpro/th2/common/message/Direction.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+public enum Direction {
+    FIRST(0),
+    SECOND(1);
+
+    private final int value;
+
+    Direction(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
+}

src/main/java/com/exactpro/th2/common/message/MessageBodyBuilder.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+import java.util.Collection;
+import java.util.function.Consumer;
+
+public interface MessageBodyBuilder {
+    MessageBodyBuilder putSimpleField(String name, Object value);
+
+    MessageBodyBuilder putSimpleField(String name, Collection<Object> value);
+
+    MessageBodyBuilder putMessage(String name, Consumer<MessageBodyBuilder> setup);
+
+    MessageBodyBuilder addMessage(String name, Consumer<MessageBodyBuilder> setup);
+
+    MessageBodyBuilder putMessages(String name, Collection<Consumer<MessageBodyBuilder>> setup);
+}

src/main/java/com/exactpro/th2/common/message/MessageBuilder.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+public interface MessageBuilder<Builder extends MessageBuilder<Builder, MB, R>, MB extends MetadataBuilder<MB>, R> {
+    Builder setParentEventId(String id, String bookName);
+
+    MB metadataBuilder();
+
+    R build();
+}

src/main/java/com/exactpro/th2/common/message/MessageFactory.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+import com.exactpro.th2.common.message.impl.ParsedMessageBuilderImpl;
+import com.exactpro.th2.common.message.impl.RawMessageBuilderImpl;
+
+public class MessageFactory {
+    public ParsedMessageBuilderImpl createParsedMessage() {
+        return new ParsedMessageBuilderImpl();
+    }
+
+    public RawMessageBuilderImpl createRawMessage() {
+        return new RawMessageBuilderImpl();
+    }
+}

src/main/java/com/exactpro/th2/common/message/MetadataBuilder.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+import java.time.Instant;
+
+public interface MetadataBuilder<Builder extends MetadataBuilder<Builder>> {
+    Builder setSessionAlias(String alias);
+
+    Builder setDirection(Direction direction);
+
+    Builder setSequence(long sequence);
+
+    Builder addSubsequence(int subSequence);
+
+    Builder setBookName(String bookName);
+
+    Builder setTimestamp(Instant timestamp);
+
+    Builder putProperty(String key, String value);
+
+    Builder setProtocol(String protocol);
+}

src/main/java/com/exactpro/th2/common/message/ParsedMessageBuilder.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+public interface ParsedMessageBuilder<R> extends MessageBuilder<ParsedMessageBuilder<R>, ParsedMetadataBuilder, R>,
+        MessageBodyBuilder {
+}

src/main/java/com/exactpro/th2/common/message/ParsedMetadataBuilder.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021-2021 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed 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 com.exactpro.th2.common.message;
+
+public interface ParsedMetadataBuilder extends MetadataBuilder<ParsedMetadataBuilder> {
+    ParsedMetadataBuilder setMessageType(String messageType);
+}