refactor: Migrate some tests to use event test util (#12471)

Signed-off-by: Austin Littley <[email protected]>

Author: litt3

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/event/FutureEventBufferTests.java

@@ -31,41 +31,14 @@
 import com.swirlds.config.extensions.test.fixtures.TestConfigBuilder;
 import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.eventhandling.EventConfig_;
-import com.swirlds.platform.system.BasicSoftwareVersion;
-import com.swirlds.platform.system.events.BaseEventHashedData;
-import com.swirlds.platform.system.events.BaseEventUnhashedData;
-import edu.umd.cs.findbugs.annotations.NonNull;
+import com.swirlds.platform.test.fixtures.event.TestingEventBuilder;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Random;
 import org.junit.jupiter.api.Test;
 
 class FutureEventBufferTests {
-
-    /**
-     * Generate an event with random data. Most fields don't need to be non-null, just enough to ensure events are
-     * unique.
-     *
-     * @param random     the random number generator
-     * @param birthRound the birth round of the event
-     * @return the event
-     */
-    @NonNull
-    final GossipEvent generateEvent(@NonNull final Random random, final long birthRound) {
-        final BaseEventHashedData baseEventHashedData = new BaseEventHashedData(
-                new BasicSoftwareVersion(1),
-                new NodeId(random.nextInt(100)),
-                null,
-                List.of(),
-                birthRound,
-                randomInstant(random),
-                null);
-        final BaseEventUnhashedData baseEventUnhashedData = new BaseEventUnhashedData();
-
-        return new GossipEvent(baseEventHashedData, baseEventUnhashedData);
-    }
-
     /**
      * This test verifies the following:
      * <ul>
@@ -101,7 +74,11 @@ void futureEventsBufferedTest() {
         final int count = 1000;
         final List<GossipEvent> events = new ArrayList<>(count);
         for (int i = 0; i < count; i++) {
-            final GossipEvent event = generateEvent(random, random.nextLong(1, maxFutureRound));
+            final GossipEvent event = new TestingEventBuilder(random)
+                    .setBirthRound(random.nextLong(1, maxFutureRound))
+                    .setCreatorId(new NodeId(random.nextInt(100)))
+                    .setTimeCreated(randomInstant(random))
+                    .build();
             events.add(event);
         }
         // Put the events in topological order
@@ -182,7 +159,11 @@ void eventsGoAncientWhileBufferedTest() {
         final int count = 1000;
         final List<GossipEvent> events = new ArrayList<>(count);
         for (int i = 0; i < count; i++) {
-            final GossipEvent event = generateEvent(random, random.nextLong(1, maxFutureRound));
+            final GossipEvent event = new TestingEventBuilder(random)
+                    .setBirthRound(random.nextLong(1, maxFutureRound))
+                    .setCreatorId(new NodeId(random.nextInt(100)))
+                    .setTimeCreated(randomInstant(random))
+                    .build();
             events.add(event);
         }
         // Put the events in topological order
@@ -237,7 +218,11 @@ void eventInBufferIsReleasedOnTimeTest() {
 
         final long roundsUntilRelease = random.nextLong(10, 20);
         final long eventBirthRound = pendingConsensusRound + roundsUntilRelease;
-        final GossipEvent event = generateEvent(random, eventBirthRound);
+        final GossipEvent event = new TestingEventBuilder(random)
+                .setBirthRound(eventBirthRound)
+                .setCreatorId(new NodeId(random.nextInt(100)))
+                .setTimeCreated(randomInstant(random))
+                .build();
 
         // Event is from the future, we can't release it yet
         assertNull(futureEventBuffer.addEvent(event));

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/system/events/BirthRoundMigrationShimTests.java

@@ -17,8 +17,6 @@
 package com.swirlds.platform.system.events;
 
 import static com.swirlds.common.test.fixtures.RandomUtils.getRandomPrintSeed;
-import static com.swirlds.common.test.fixtures.RandomUtils.randomHash;
-import static com.swirlds.common.test.fixtures.RandomUtils.randomInstant;
 import static com.swirlds.platform.consensus.ConsensusConstants.ROUND_FIRST;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertSame;
@@ -30,8 +28,8 @@
 import com.swirlds.platform.event.GossipEvent;
 import com.swirlds.platform.system.BasicSoftwareVersion;
 import com.swirlds.platform.system.SoftwareVersion;
+import com.swirlds.platform.test.fixtures.event.TestingEventBuilder;
 import edu.umd.cs.findbugs.annotations.NonNull;
-import java.util.List;
 import java.util.Random;
 import org.junit.jupiter.api.Test;
 
@@ -45,20 +43,20 @@ private GossipEvent buildEvent(
             final long generation,
             final long birthRound) {
 
-        final GossipEvent event = new GossipEvent(
-                new BaseEventHashedData(
-                        softwareVersion,
-                        new NodeId(random.nextLong(1, 10)),
-                        new EventDescriptor(
-                                randomHash(random),
-                                new NodeId(random.nextInt(1, 10)),
-                                generation - 1 /* chose parent generation to yield desired self generation */,
-                                random.nextLong(birthRound - 2, birthRound + 1)) /* realistic range */,
-                        List.of() /* don't bother with other parents, unimportant for this test */,
-                        birthRound,
-                        randomInstant(random),
-                        null),
-                new BaseEventUnhashedData());
+        final NodeId creatorId = new NodeId(random.nextLong(1, 10));
+        final GossipEvent selfParent = new TestingEventBuilder(random)
+                .setCreatorId(creatorId)
+                .setBirthRound(random.nextLong(birthRound - 2, birthRound + 1)) /* realistic range */
+                .build();
+
+        final GossipEvent event = new TestingEventBuilder(random)
+                .setSoftwareVersion(softwareVersion)
+                .setCreatorId(creatorId)
+                .setBirthRound(birthRound)
+                .setSelfParent(selfParent)
+                /* chose parent generation to yield desired self generation */
+                .overrideSelfParentGeneration(generation - 1)
+                .build();
 
         platformContext.getCryptography().digestSync(event.getHashedData());
 

platform-sdk/swirlds-unit-tests/core/swirlds-platform-test/src/test/java/com/swirlds/platform/test/EventStringsTest.java

@@ -18,20 +18,17 @@
 
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-import com.swirlds.common.crypto.Hash;
 import com.swirlds.common.platform.NodeId;
+import com.swirlds.common.test.fixtures.RandomUtils;
 import com.swirlds.common.test.fixtures.junit.tags.TestComponentTags;
 import com.swirlds.platform.EventStrings;
 import com.swirlds.platform.event.GossipEvent;
 import com.swirlds.platform.internal.EventImpl;
-import com.swirlds.platform.system.BasicSoftwareVersion;
 import com.swirlds.platform.system.events.BaseEventHashedData;
-import com.swirlds.platform.system.events.BaseEventUnhashedData;
-import com.swirlds.platform.system.events.EventConstants;
-import com.swirlds.platform.system.events.EventDescriptor;
-import com.swirlds.platform.system.transaction.ConsensusTransactionImpl;
+import com.swirlds.platform.test.fixtures.event.EventImplTestUtils;
+import com.swirlds.platform.test.fixtures.event.TestingEventBuilder;
 import java.time.Instant;
-import java.util.Collections;
+import java.util.Random;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
@@ -42,7 +39,9 @@ class EventStringsTest {
     @Tag(TestComponentTags.PLATFORM)
     @DisplayName("Test event strings")
     void testCopy() {
-        printAssert(EventStrings.toShortString((EventImpl) null), "null", "should indicate that the object is null");
+        final Random random = RandomUtils.getRandomPrintSeed();
+
+        printAssert(EventStrings.toShortString(null), "null", "should indicate that the object is null");
         printAssert(EventStrings.toShortString((GossipEvent) null), "null", "should indicate that the object is null");
         printAssert(EventStrings.toShortString(new EventImpl()), "null", "should indicate that the object is null");
 
@@ -53,31 +52,31 @@ void testCopy() {
 
         final NodeId selfId = new NodeId(id);
         final NodeId otherId = new NodeId(opId);
-        final EventDescriptor selfParent =
-                new EventDescriptor(new Hash(), selfId, spGen, EventConstants.BIRTH_ROUND_UNDEFINED);
-        final EventDescriptor otherParent =
-                new EventDescriptor(new Hash(), otherId, opGen, EventConstants.BIRTH_ROUND_UNDEFINED);
 
-        BaseEventHashedData hashedData = new BaseEventHashedData(
-                new BasicSoftwareVersion(1),
-                selfId,
-                selfParent,
-                Collections.singletonList(otherParent),
-                EventConstants.BIRTH_ROUND_UNDEFINED,
-                Instant.now(),
-                new ConsensusTransactionImpl[0]);
-        hashedData.setHash(new Hash());
-        BaseEventUnhashedData unhashedData = new BaseEventUnhashedData(new NodeId(opId), new byte[0]);
+        final EventImpl selfParent =
+                EventImplTestUtils.createEventImpl(new TestingEventBuilder(random).setCreatorId(selfId), null, null);
+        final EventImpl otherParent =
+                EventImplTestUtils.createEventImpl(new TestingEventBuilder(random).setCreatorId(otherId), null, null);
+
+        final TestingEventBuilder childBuilder = new TestingEventBuilder(random)
+                .setCreatorId(selfId)
+                .overrideSelfParentGeneration(spGen)
+                .overrideOtherParentGeneration(opGen)
+                .setTimeCreated(Instant.now());
+
+        final EventImpl eventImplChild = EventImplTestUtils.createEventImpl(childBuilder, selfParent, otherParent);
+        final GossipEvent gossipEventChild = childBuilder.build();
+
         printAssert(
-                EventStrings.toShortString(new EventImpl(hashedData, unhashedData)),
+                EventStrings.toShortString(eventImplChild),
                 String.format("%d,%d", id, BaseEventHashedData.calculateGeneration(spGen, opGen)),
                 "should have creator and generation");
         printAssert(
-                EventStrings.toShortString(new GossipEvent(hashedData, unhashedData)),
+                EventStrings.toShortString(gossipEventChild),
                 String.format("%d,%d", id, BaseEventHashedData.calculateGeneration(spGen, opGen)),
                 "should have creator and generation");
         printAssert(
-                EventStrings.toMediumString(new EventImpl(hashedData, unhashedData)),
+                EventStrings.toMediumString(eventImplChild),
                 String.format("%d,%d", opId, opGen),
                 "should have op creator and generation");
     }

platform-sdk/swirlds-unit-tests/core/swirlds-platform-test/src/test/java/com/swirlds/platform/test/event/tipset/TipsetEventCreatorTests.java

@@ -17,7 +17,6 @@
 package com.swirlds.platform.test.event.tipset;
 
 import static com.swirlds.common.test.fixtures.RandomUtils.getRandomPrintSeed;
-import static com.swirlds.common.test.fixtures.RandomUtils.randomHash;
 import static com.swirlds.common.test.fixtures.RandomUtils.randomSignature;
 import static com.swirlds.common.utility.CompareTo.isGreaterThanOrEqualTo;
 import static com.swirlds.platform.consensus.ConsensusConstants.ROUND_FIRST;
@@ -53,14 +52,13 @@
 import com.swirlds.platform.system.SoftwareVersion;
 import com.swirlds.platform.system.address.Address;
 import com.swirlds.platform.system.address.AddressBook;
-import com.swirlds.platform.system.events.BaseEventHashedData;
-import com.swirlds.platform.system.events.BaseEventUnhashedData;
 import com.swirlds.platform.system.events.ConsensusData;
 import com.swirlds.platform.system.events.EventConstants;
 import com.swirlds.platform.system.events.EventDescriptor;
 import com.swirlds.platform.system.transaction.ConsensusTransactionImpl;
 import com.swirlds.platform.system.transaction.SwirldTransaction;
 import com.swirlds.platform.test.fixtures.addressbook.RandomAddressBookGenerator;
+import com.swirlds.platform.test.fixtures.event.TestingEventBuilder;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.time.Duration;
@@ -798,37 +796,29 @@ void sizeOneNetworkTest(final boolean advancingClock, final boolean useBirthRoun
     }
 
     @NonNull
-    private GossipEvent createMockEvent(
+    private GossipEvent createTestEvent(
             @NonNull final Random random,
             @NonNull final NodeId creator,
             long selfParentGeneration,
             @Nullable final NodeId otherParentId,
             final long otherParentGeneration) {
-        final GossipEvent event = mock(GossipEvent.class);
 
-        final BaseEventHashedData hashedData = mock(BaseEventHashedData.class);
-        when(hashedData.getCreatorId()).thenReturn(creator);
-        when(hashedData.getCreatorId()).thenReturn(creator);
-        final long generation = Math.max(selfParentGeneration, otherParentGeneration) + 1;
-        when(hashedData.getGeneration()).thenReturn(generation);
-        when(event.getGeneration()).thenReturn(generation);
+        final GossipEvent selfParent =
+                new TestingEventBuilder(random).setCreatorId(creator).build();
 
-        final Hash hash = randomHash(random);
-        when(hashedData.getHash()).thenReturn(hash);
+        final TestingEventBuilder eventBuilder = new TestingEventBuilder(random)
+                .setCreatorId(creator)
+                .setSelfParent(selfParent)
+                .overrideSelfParentGeneration(selfParentGeneration);
 
-        final EventDescriptor descriptor =
-                new EventDescriptor(hash, creator, generation, -EventConstants.BIRTH_ROUND_UNDEFINED);
+        if (otherParentId != null) {
+            final GossipEvent otherParent =
+                    new TestingEventBuilder(random).setCreatorId(otherParentId).build();
 
-        when(hashedData.createEventDescriptor()).thenReturn(descriptor);
-        when(event.getDescriptor()).thenReturn(descriptor);
-
-        when(event.getHashedData()).thenReturn(hashedData);
-
-        final BaseEventUnhashedData unhashedData = mock(BaseEventUnhashedData.class);
-        when(unhashedData.getOtherId()).thenReturn(otherParentId);
-        when(event.getUnhashedData()).thenReturn(unhashedData);
+            eventBuilder.setOtherParent(otherParent).overrideOtherParentGeneration(otherParentGeneration);
+        }
 
-        return event;
+        return eventBuilder.build();
     }
 
     /**
@@ -863,11 +853,11 @@ void frozenEventCreationBug() {
         final GossipEvent eventA1 = eventCreator.maybeCreateEvent();
         assertNotNull(eventA1);
 
-        final GossipEvent eventB1 = createMockEvent(
+        final GossipEvent eventB1 = createTestEvent(
                 random, nodeB, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
-        final GossipEvent eventC1 = createMockEvent(
+        final GossipEvent eventC1 = createTestEvent(
                 random, nodeC, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
-        final GossipEvent eventD1 = createMockEvent(
+        final GossipEvent eventD1 = createTestEvent(
                 random, nodeD, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
 
         eventCreator.registerEvent(eventB1);
@@ -896,7 +886,7 @@ void frozenEventCreationBug() {
         // but has not been updated in the current snapshot.
 
         final NodeId otherParentId = eventA2.getUnhashedData().getOtherId();
-        final GossipEvent legalOtherParent = createMockEvent(random, otherParentId, 0, nodeA, 0);
+        final GossipEvent legalOtherParent = createTestEvent(random, otherParentId, 0, nodeA, 0);
 
         eventCreator.registerEvent(legalOtherParent);
 
@@ -936,13 +926,13 @@ void notRegisteringEventsFromNodesNotInAddressBook() {
         final GossipEvent eventA1 = eventCreator.maybeCreateEvent();
         assertNotNull(eventA1);
 
-        final GossipEvent eventB1 = createMockEvent(
+        final GossipEvent eventB1 = createTestEvent(
                 random, nodeB, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
-        final GossipEvent eventC1 = createMockEvent(
+        final GossipEvent eventC1 = createTestEvent(
                 random, nodeC, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
-        final GossipEvent eventD1 = createMockEvent(
+        final GossipEvent eventD1 = createTestEvent(
                 random, nodeD, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
-        final GossipEvent eventE1 = createMockEvent(
+        final GossipEvent eventE1 = createTestEvent(
                 random, nodeE, EventConstants.GENERATION_UNDEFINED, null, EventConstants.GENERATION_UNDEFINED);
 
         eventCreator.registerEvent(eventB1);