test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events #1201

shashankshampi · 2024-09-26T06:02:10Z

Test Plan: https://www.notion.so/Gossipsub-651e02d4d7894bb2ac1e4edb55f3192d

Topic Membership Tests:

Test added: (TC6.6: Verify the handling of subscription changes when the underlying pubsub framework sends SUBSCRIBE and UNSUBSCRIBE events.)

Simulate the SUBSCRIBE event and check proper handling in the mesh and gossipsub structures
This test will simulate an UNSUBSCRIBE event and check if the topic is removed from the relevant data structures but remains in gossipsub
This test ensures that multiple topics can be subscribed to and unsubscribed from, with proper initialization of the topic structures.
This test ensures that the number of subscriptions does not exceed the limit set in the GossipSub parameters

diegomrsantos · 2024-09-30T09:16:54Z

how about testgossiptopicmembership.nim?

diegomrsantos · 2024-09-30T09:34:51Z

tests/pubsub/testgossipmembership.nim

+  # Addition of Designed Test cases for 6. Topic Membership Tests: https://www.notion.so/Gossipsub-651e02d4d7894bb2ac1e4edb55f3192d
+
+  # Simulate the `SUBSCRIBE` event and check proper handling in the mesh and gossipsub structures
+  asyncTest "handle SUBSCRIBE event":


This test is very similar to

nim-libp2p/tests/pubsub/testgossipinternal.nim

Line 36 in 68306cf

asyncTest "subscribe/unsubscribeAll":

Agree on this but little difference is there

Subscription Handler:

Newly added test (handle SUBSCRIBE event):
Uses an anonymous function when subscribing to the topic, and it does not test for the dynamic dispatch mechanism used to handle topic messages.

Existing test (subscribe/unsubscribeAll):
It defines a handler function for handling messages sent to the subscribed topic. This makes the test more practical for simulating message reception and processing. It also uses dynamic dispatch for testing the subscription and unsubscription.

You can keep the newly added test if you want a lightweight, focused check for basic subscription functionality. If not required then will remove it as it was added keeping in mind for light sanity @AlejandroCabeza

Uses an anonymous function when subscribing to the topic, and it does not test for the dynamic dispatch mechanism used to handle topic messages.

This doesn't need to be tested in this test.

But we could replace the existing test with the first two you created. There's a lot of code repetition in testgossipinternal as pointed out here #1207.

Agree on it. I Will follow this as another task and can move all common lines of code to func to ensure testgossipinternal is clean with no redundant line of code in relevant file as well

Please remove asyncTest "subscribe/unsubscribeAll" in testgossipinternal.

Please remove asyncTest "subscribe/unsubscribeAll" in testgossipinternal.

Removed

tests/pubsub/testgossipmembership.nim

diegomrsantos · 2024-09-30T09:52:51Z

We follow conventional commits for the PR title. In this case, it will start with test(gossipsub):

shashankshampi · 2024-10-01T11:30:03Z

how about testgossiptopicmembership.nim?

I am adding other tests in the same file related to Topic Membership Tests for Join topic, leave topic, and mesh updated on peer subscribing and leaving topic.

Earlier suggestion looks fine but else will modify as per your suggestion

shashankshampi · 2024-10-01T11:31:03Z

We follow conventional commits for the PR title. In this case, it will start with test(gossipsub):

Thanks. Will follow same in upcoming PRs

added test wrt subscribe and unsubscribe added tests/pubsub/testgossipinternal2 file linters feat: rendezvous refactor (#1183) Hello! This PR aim to refactor rendezvous code so that it is easier to impl. Waku rdv strategy. The hardcoded min and max TTL were out of range with what we needed and specifying which peers to interact with is also needed since Waku deals with peers on multiple separate shards. I tried to keep the changes to a minimum, specifically I did not change the name of any public procs which result in less than descriptive names in some cases. I also wanted to return results instead of raising exceptions but didn't. Would it be acceptable to do so? Please advise on best practices, thank you. --------- Co-authored-by: Ludovic Chenut <ludovic@status.im> refactor and suite name refactor chore(ci): Enable S3 caching for interop (#1193) - Adds our S3 bucket for caching docker images as Protocol Labs shut down their shared one. - Remove the free disk space workaround that prevented the jobs from failing for using too much space for the images. --------- Co-authored-by: diegomrsantos <diego@status.im> PR review comment changes

diegomrsantos · 2024-10-02T11:53:13Z

how about testgossiptopicmembership.nim?

I am adding other tests in the same file related to Topic Membership Tests for Join topic, leave topic, and mesh updated on peer subscribing and leaving topic.

Earlier suggestion looks fine but else will modify as per your suggestion

I'm not sure if gossip membership makes sense.

tests/pubsub/testgossipmembership.nim

diegomrsantos · 2024-10-02T16:02:15Z

tests/pubsub/testgossipmembership.nim

+
+    check gossipSub.topics.contains(topic) # Check if the topic is in topics
+    check gossipSub.gossipsub[topic].len() > 0 # Check if topic added to gossipsub
+


The existing text also checks gossipSub.mesh[topic].len() > 0. Is there a place defining what the tests should ensure?

Test case are designed here: 6. Topic Membership Tests (❌ To Do)
https://www.notion.so/Gossipsub-651e02d4d7894bb2ac1e4edb55f3192d

These are split tests which check individual logic rather than subscribe and unsubscribe together

Only test title is there and based on that we are adding checks to ensure that functionality. We can have details check test if required

diegomrsantos · 2024-10-03T08:38:22Z

tests/pubsub/testgossipmembership.nim

+    # Iterate over the peers and check connection handling
+    for peer in gossipSub.peers.values:
+      check peer.sendConn != nil
+      check not peer.sendConn.closed()


I don't think this is necessary.

removed. Done

diegomrsantos · 2024-10-03T08:41:19Z

tests/pubsub/testgossipmembership.nim

+    let (gossipSub, conns) = setupGossipSub(topic, 5)
+
+    # Subscribe to the topic
+    subscribeToTopics(gossipSub, @[topic].toSeq()) # Pass topic as seq[string]


.toSeq() isn't necessary

Thanks done

diegomrsantos · 2024-10-03T08:43:51Z

tests/pubsub/testgossipmembership.nim

+    check topic notin gossipSub.topics # The topic should not be in topics
+    check topic notin gossipSub.mesh # The topic should be removed from the mesh


I think those comments aren't necessary as the code is clear.

removed all unwanted comments
Done

diegomrsantos · 2024-10-03T08:44:22Z

tests/pubsub/testgossipmembership.nim

+    let (gossipSub, conns) = setupGossipSub(topic, 5)
+
+    # Subscribe to the topic first
+    subscribeToTopics(gossipSub, @[topic]) # Pass topic as seq[string]


Comment here also isn't necessary.

removed
done

diegomrsantos · 2024-10-03T08:44:31Z

tests/pubsub/testgossipmembership.nim

+    subscribeToTopics(gossipSub, @[topic]) # Pass topic as seq[string]
+
+    # Now unsubscribe from the topic
+    unsubscribeFromTopics(gossipSub, @[topic]) # Pass topic as seq[string]


Comment here also isn't necessary.

removed
Done

diegomrsantos · 2024-10-03T08:45:56Z

tests/pubsub/testgossipmembership.nim

+      gossipSub.PubSub.unsubscribeAll(topic)
+
+  # Simulate the `SUBSCRIBE` to the topic and check proper handling in the mesh and gossipsub structures
+  asyncTest "handle SUBSCRIBE to the topic and verify connection handling":


"handle SUBSCRIBE to the topic" is enough for the name.

diegomrsantos · 2024-10-03T09:47:59Z

tests/pubsub/testgossipmembership.nim

+    check gossipSub.topics.contains(topic)
+
+    # Check if the topic is added to gossipsub and the peers list is not empty
+    check gossipSub.gossipsub[topic].len() > 0


If we move this line before subscribeToTopics(gossipSub, @[topic]) it's already true, so we aren't testing anything here.

codecov-commenter · 2024-10-03T09:53:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.55%. Comparing base (09fe199) to head (46b7125).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1201      +/-   ##
==========================================
+ Coverage   84.54%   84.55%   +0.01%     
==========================================
  Files          93       93              
  Lines       16650    16681      +31     
==========================================
+ Hits        14076    14104      +28     
- Misses       2574     2577       +3

see 6 files with indirect coverage changes

shashankshampi marked this pull request as ready for review September 26, 2024 07:58

shashankshampi requested review from diegomrsantos, lchenut, AlejandroCabeza and fbarbu15 September 26, 2024 07:59

diegomrsantos reviewed Sep 30, 2024

View reviewed changes

tests/pubsub/testgossipmembership.nim Outdated Show resolved Hide resolved

diegomrsantos mentioned this pull request Sep 30, 2024

test(gossipsub): block5 protobuf test cases #1204

Open

shashankshampi requested review from romanzac and AYAHASSAN287 October 1, 2024 10:20

shashankshampi closed this Oct 1, 2024

shashankshampi reopened this Oct 1, 2024

shashankshampi force-pushed the block6Test branch from 9230ecd to eb2f6bf Compare October 1, 2024 11:59

shashankshampi changed the title ~~Part 1: Test cases covering subscribe and unsubscribe Events~~ test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events Oct 1, 2024

Merge branch 'master' into block6Test

9c0966e

diegomrsantos reviewed Oct 2, 2024

View reviewed changes

tests/pubsub/testgossipmembership.nim Show resolved Hide resolved

diegomrsantos reviewed Oct 2, 2024

View reviewed changes

tests/pubsub/testgossipmembership.nim Outdated Show resolved Hide resolved

diegomrsantos reviewed Oct 2, 2024

View reviewed changes

updtaed as per review comment

25df50d

diegomrsantos reviewed Oct 3, 2024

View reviewed changes

shashankshampi added 2 commits October 3, 2024 15:00

review comments to remove unwanted comments

f0c8c5b

removed internal subscribe and unsubscribe test

46b7125

diegomrsantos reviewed Oct 3, 2024

View reviewed changes

removed unwanted check

19d3ead

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events #1201

test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events #1201

shashankshampi commented Sep 26, 2024

diegomrsantos commented Sep 30, 2024

diegomrsantos Sep 30, 2024

shashankshampi Oct 1, 2024

diegomrsantos Oct 2, 2024

diegomrsantos Oct 2, 2024 •

edited

Loading

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024 •

edited

Loading

shashankshampi Oct 3, 2024

diegomrsantos commented Sep 30, 2024

shashankshampi commented Oct 1, 2024

shashankshampi commented Oct 1, 2024

diegomrsantos commented Oct 2, 2024

diegomrsantos Oct 2, 2024

shashankshampi Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

shashankshampi Oct 3, 2024

diegomrsantos Oct 3, 2024

codecov-commenter commented Oct 3, 2024


		check gossipSub.topics.contains(topic) # Check if the topic is in topics
		check gossipSub.gossipsub[topic].len() > 0 # Check if topic added to gossipsub

		check topic notin gossipSub.topics # The topic should not be in topics
		check topic notin gossipSub.mesh # The topic should be removed from the mesh

test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events #1201

Are you sure you want to change the base?

test(gossipsub): Part 1 Test cases covering subscribe and unsubscribe Events #1201

Conversation

shashankshampi commented Sep 26, 2024

diegomrsantos commented Sep 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diegomrsantos Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diegomrsantos Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diegomrsantos commented Sep 30, 2024

shashankshampi commented Oct 1, 2024

shashankshampi commented Oct 1, 2024

diegomrsantos commented Oct 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 3, 2024

Codecov Report

diegomrsantos Oct 2, 2024 •

edited

Loading

diegomrsantos Oct 3, 2024 •

edited

Loading