[WIP] PubSub and FloodSub development (#133)

* Add notifee interface * Add notify function to network interface * Implement notify feature * Add tests for notify * Make notifee functions all async * Fix linting issue * Fix linting issue * Scaffold pubsub router interface * Scaffold pubsub directory * Store peer_id in muxed connection * Implement pubsub notifee * Remove outdated files * Implement pubsub first attempt * Prepare pubsub for floodsub * Add mplex conn to net stream and add conn in notify tests * Implement floodsub * Use NetStream in generic protocol handler * Debugging async issues * Modify test to perform proper assert. Test passes * Remove callbacks. Reduce sleep time * Add simple three node test * Clean up code. Add message classes * Add test for two topics * Add conn to net stream and conn tests * Refactor test setup to remove duplicate code * Fix linting issues * Fix linting issue * Fix linting issue * Fix outstanding unrelated lint issue in multiselect_client * Add connect function * Remove debug prints * Remove debug prints from floodsub * Use MessageTalk in place of direct message breakdown * Remove extra prints * Remove outdated function * Add message to queues for all topics in message * Debugging * Add message self delivery * Increase read timeout to 5 to get pubsub tests passing * Refactor testing helper func. Add tests * Add tests and increase timeout to get tests passing * Add dummy account demo scaffolding * Attempt to use threads. Test fails * Implement basic dummy node tests using threads * Add generic testing function * Add simple seven node tree test * Add more complex seven node tree tests * Add five node ring tests * Remove unnecessary get_message_type func * Add documentation to classes * Add message id to messages * Add documentation to test helper func * Add docs to dummy account node helper func * Add more docs to dummy account node test helper func * fixed linting errors in floodsub * small notify bugfix * move pubsub into libp2p * fixed pubsub linting * fixing pubsub test failures * linting
2026-02-12 16:10:57 +00:00 · 2019-03-23 13:52:02 -04:00
parent fee905ace2
commit 9c6d441f9f
14 changed files with 1474 additions and 11 deletions
--- a/tests/pubsub/test_dummyaccount_demo.py
+++ b/tests/pubsub/test_dummyaccount_demo.py
@ -0,0 +1,189 @@
+import asyncio
+import multiaddr
+import pytest
+
+from threading import Thread
+from tests.utils import cleanup
+from libp2p import new_node
+from libp2p.peer.peerinfo import info_from_p2p_addr
+from libp2p.pubsub.pubsub import Pubsub
+from libp2p.pubsub.floodsub import FloodSub
+from libp2p.pubsub.message import MessageTalk
+from libp2p.pubsub.message import create_message_talk
+from dummy_account_node import DummyAccountNode
+
+# pylint: disable=too-many-locals
+
+async def connect(node1, node2):
+    # node1 connects to node2
+    addr = node2.get_addrs()[0]
+    info = info_from_p2p_addr(addr)
+    await node1.connect(info)
+
+def create_setup_in_new_thread_func(dummy_node):
+    def setup_in_new_thread():
+        asyncio.ensure_future(dummy_node.setup_crypto_networking())
+    return setup_in_new_thread
+
+async def perform_test(num_nodes, adjacency_map, action_func, assertion_func):
+    """
+    Helper function to allow for easy construction of custom tests for dummy account nodes
+    in various network topologies
+    :param num_nodes: number of nodes in the test
+    :param adjacency_map: adjacency map defining each node and its list of neighbors
+    :param action_func: function to execute that includes actions by the nodes, 
+    such as send crypto and set crypto
+    :param assertion_func: assertions for testing the results of the actions are correct
+    """
+
+    # Create nodes
+    dummy_nodes = []
+    for i in range(num_nodes):
+        dummy_nodes.append(await DummyAccountNode.create())
+
+    # Create network
+    for source_num in adjacency_map:
+        target_nums = adjacency_map[source_num]
+        for target_num in target_nums:
+            await connect(dummy_nodes[source_num].libp2p_node, \
+                dummy_nodes[target_num].libp2p_node)
+
+    # Allow time for network creation to take place
+    await asyncio.sleep(0.25)
+
+    # Start a thread for each node so that each node can listen and respond
+    # to messages on its own thread, which will avoid waiting indefinitely
+    # on the main thread. On this thread, call the setup func for the node,
+    # which subscribes the node to the CRYPTO_TOPIC topic
+    for dummy_node in dummy_nodes:
+        thread = Thread(target=create_setup_in_new_thread_func(dummy_node))
+        thread.run()
+
+    # Allow time for nodes to subscribe to CRYPTO_TOPIC topic
+    await asyncio.sleep(0.25)
+
+    # Perform action function
+    await action_func(dummy_nodes)
+
+    # Allow time for action function to be performed (i.e. messages to propogate)
+    await asyncio.sleep(0.25)
+
+    # Perform assertion function
+    for dummy_node in dummy_nodes:
+        assertion_func(dummy_node)
+
+    # Success, terminate pending tasks.
+    await cleanup()
+
+@pytest.mark.asyncio
+async def test_simple_two_nodes():
+    num_nodes = 2
+    adj_map = {0: [1]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 10)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 10
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_simple_three_nodes_line_topography():
+    num_nodes = 3
+    adj_map = {0: [1], 1: [2]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 10)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 10
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_simple_three_nodes_triangle_topography():
+    num_nodes = 3
+    adj_map = {0: [1, 2], 1: [2]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 20)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 20
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_simple_seven_nodes_tree_topography():
+    num_nodes = 7
+    adj_map = {0: [1, 2], 1: [3, 4], 2: [5, 6]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 20)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 20
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_set_then_send_from_root_seven_nodes_tree_topography():
+    num_nodes = 7
+    adj_map = {0: [1, 2], 1: [3, 4], 2: [5, 6]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 20)
+        await asyncio.sleep(0.25)
+        await dummy_nodes[0].publish_send_crypto("aspyn", "alex", 5)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 15
+        assert dummy_node.get_balance("alex") == 5
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_set_then_send_from_different_leafs_seven_nodes_tree_topography():
+    num_nodes = 7
+    adj_map = {0: [1, 2], 1: [3, 4], 2: [5, 6]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[6].publish_set_crypto("aspyn", 20)
+        await asyncio.sleep(0.25)
+        await dummy_nodes[4].publish_send_crypto("aspyn", "alex", 5)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 15
+        assert dummy_node.get_balance("alex") == 5
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_simple_five_nodes_ring_topography():
+    num_nodes = 5
+    adj_map = {0: [1], 1: [2], 2: [3], 3: [4], 4: [0]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("aspyn", 20)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("aspyn") == 20
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)
+
+@pytest.mark.asyncio
+async def test_set_then_send_from_diff_nodes_five_nodes_ring_topography():
+    num_nodes = 5
+    adj_map = {0: [1], 1: [2], 2: [3], 3: [4], 4: [0]}
+
+    async def action_func(dummy_nodes):
+        await dummy_nodes[0].publish_set_crypto("alex", 20)
+        await asyncio.sleep(0.25)
+        await dummy_nodes[3].publish_send_crypto("alex", "rob", 12)
+
+    def assertion_func(dummy_node):
+        assert dummy_node.get_balance("alex") == 8
+        assert dummy_node.get_balance("rob") == 12
+
+    await perform_test(num_nodes, adj_map, action_func, assertion_func)