-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: liteprotocoltester for simulation and for fleets (#2813)
* Added phase 2 - waku-simulatior integration in README.md * Enhancement on statistics reports, added list of sent messages with hash, fixed latency calculations * Enable standalonde running liteprotocoltester agains any waku network/fleet * Fix missing env vars on run_tester_node.sh * Adjustment on log levels, fix REST initialization * Added standalon docker image build, fine tune duplicate detection and logging. * Adjustments for waku-simulator runs * Extended liteprotocoltester README.md with docker build * Fix test inside docker service node connectivity failure * Update apps/liteprotocoltester/README.md Co-authored-by: gabrielmer <[email protected]> * Apply suggestions from code review Co-authored-by: gabrielmer <[email protected]> Co-authored-by: Ivan FB <[email protected]> * Explain minLatency calculation in code comment --------- Co-authored-by: gabrielmer <[email protected]> Co-authored-by: Ivan FB <[email protected]>
- Loading branch information
3 people
authored
Aug 21, 2024
1 parent
d63e343
commit f4fa73e
Showing
18 changed files
with
951 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| START_PUBLISHING_AFTER=10 | ||
| # can add some seconds delay before SENDER starts publishing | ||
|
|
||
| NUM_MESSAGES=0 | ||
| # 0 for infinite number of messages | ||
|
|
||
| DELAY_MESSAGES=8000 | ||
| # ms delay between messages | ||
|
|
||
|
|
||
| MIN_MESSAGE_SIZE=15Kb | ||
| MAX_MESSAGE_SIZE=145Kb | ||
|
|
||
| ## for wakusim | ||
| PUBSUB=/waku/2/rs/66/0 | ||
| CONTENT_TOPIC=/tester/2/light-pubsub-test/wakusim | ||
| CLUSTER_ID=66 | ||
|
|
||
| ## for status.prod | ||
| #PUBSUB=/waku/2/rs/16/32 | ||
| #CONTENT_TOPIC=/tester/2/light-pubsub-test/fleet | ||
| #CLUSTER_ID=16 | ||
|
|
||
| ## for TWN | ||
| #PUBSUB=/waku/2/rs/1/4 | ||
| #CONTENT_TOPIC=/tester/2/light-pubsub-test/twn | ||
| #CLUSTER_ID=1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # TESTING IMAGE -------------------------------------------------------------- | ||
|
|
||
| ## NOTICE: This is a short cut build file for ubuntu users who compiles nwaku in ubuntu distro. | ||
| ## This is used for faster turnaround time for testing the compiled binary. | ||
| ## Prerequisites: compiled liteprotocoltester binary in build/ directory | ||
|
|
||
| FROM ubuntu:noble AS prod | ||
|
|
||
| LABEL maintainer="[email protected]" | ||
| LABEL source="https://github.com/waku-org/nwaku" | ||
| LABEL description="Lite Protocol Tester: Waku light-client" | ||
| LABEL commit="unknown" | ||
| LABEL version="unknown" | ||
|
|
||
| # DevP2P, LibP2P, and JSON RPC ports | ||
| EXPOSE 30303 60000 8545 | ||
|
|
||
| # Referenced in the binary | ||
| RUN apt-get update && apt-get install -y --no-install-recommends \ | ||
| libgcc1 \ | ||
| libpcre3 \ | ||
| libpq-dev \ | ||
| wget \ | ||
| iproute2 \ | ||
| && rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # Fix for 'Error loading shared library libpcre.so.3: No such file or directory' | ||
| RUN ln -s /usr/lib/libpcre.so /usr/lib/libpcre.so.3 | ||
|
|
||
| COPY build/liteprotocoltester /usr/bin/ | ||
| COPY apps/liteprotocoltester/run_tester_node.sh /usr/bin/ | ||
|
|
||
| ENTRYPOINT ["/usr/bin/run_tester_node.sh", "/usr/bin/liteprotocoltester"] | ||
|
|
||
| # # By default just show help if called without arguments | ||
| CMD ["--help"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |
| ## This is used for faster turnaround time for testing the compiled binary. | ||
| ## Prerequisites: compiled liteprotocoltester binary in build/ directory | ||
|
|
||
| FROM ubuntu:noble as prod | ||
| FROM ubuntu:noble AS prod | ||
|
|
||
| LABEL maintainer="[email protected]" | ||
| LABEL source="https://github.com/waku-org/nwaku" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| when (NimMajor, NimMinor) < (1, 4): | ||
| {.push raises: [Defect].} | ||
| else: | ||
| {.push raises: [].} | ||
|
|
||
| import | ||
| std/[options, strutils, os, sequtils, net, strformat], | ||
| chronicles, | ||
| chronos, | ||
| metrics, | ||
| libbacktrace, | ||
| system/ansi_c, | ||
| libp2p/crypto/crypto, | ||
| confutils, | ||
| libp2p/wire | ||
|
|
||
| import | ||
| ../../waku/common/logging, | ||
| ../../waku/factory/waku, | ||
| ../../waku/factory/external_config, | ||
| ../../waku/node/health_monitor, | ||
| ../../waku/node/waku_metrics, | ||
| ../../waku/waku_api/rest/builder as rest_server_builder, | ||
| ../../waku/node/peer_manager, | ||
| ../../waku/waku_lightpush/common, | ||
| ../../waku/waku_relay, | ||
| ../../waku/waku_filter_v2, | ||
| ../../waku/waku_api/rest/client, | ||
| ../../waku/waku_api/rest/admin/client, | ||
| ./tester_config, | ||
| ./lightpush_publisher, | ||
| ./filter_subscriber | ||
|
|
||
| logScope: | ||
| topics = "diagnose connections" | ||
|
|
||
| proc logSelfPeersLoop(pm: PeerManager, interval: Duration) {.async.} = | ||
| trace "Starting logSelfPeersLoop diagnosis loop" | ||
| while true: | ||
| let selfLighpushPeers = pm.peerStore.getPeersByProtocol(WakuLightPushCodec) | ||
| let selfRelayPeers = pm.peerStore.getPeersByProtocol(WakuRelayCodec) | ||
| let selfFilterPeers = pm.peerStore.getPeersByProtocol(WakuFilterSubscribeCodec) | ||
|
|
||
| let printable = catch: | ||
| """*------------------------------------------------------------------------------------------* | ||
| | Self ({pm.switch.peerInfo}) peers: | ||
| *------------------------------------------------------------------------------------------* | ||
| | Lightpush peers({selfLighpushPeers.len()}): ${selfLighpushPeers} | ||
| *------------------------------------------------------------------------------------------* | ||
| | Filter peers({selfFilterPeers.len()}): ${selfFilterPeers} | ||
| *------------------------------------------------------------------------------------------* | ||
| | Relay peers({selfRelayPeers.len()}): ${selfRelayPeers} | ||
| *------------------------------------------------------------------------------------------*""".fmt() | ||
|
|
||
| if printable.isErr(): | ||
| echo "Error while printing statistics: " & printable.error().msg | ||
| else: | ||
| echo printable.get() | ||
|
|
||
| await sleepAsync(interval) | ||
|
|
||
| proc logServiceRelayPeers( | ||
| pm: PeerManager, codec: string, interval: Duration | ||
| ) {.async.} = | ||
| trace "Starting service node connectivity diagnosys loop" | ||
| while true: | ||
| echo "*------------------------------------------------------------------------------------------*" | ||
| echo "| Service peer connectivity:" | ||
| let selfLighpushPeers = pm.selectPeer(codec) | ||
| if selfLighpushPeers.isSome(): | ||
| let ma = selfLighpushPeers.get().addrs[0] | ||
| var serviceIp = initTAddress(ma).valueOr: | ||
| echo "Error while parsing multiaddress: " & $error | ||
| continue | ||
|
|
||
| serviceIp.port = Port(8645) | ||
| let restClient = newRestHttpClient(initTAddress($serviceIp)) | ||
|
|
||
| let getPeersRes = await restClient.getPeers() | ||
|
|
||
| if getPeersRes.status == 200: | ||
| let nrOfPeers = getPeersRes.data.len() | ||
| echo "Service node (@" & $ma & ") peers: " & $getPeersRes.data | ||
| else: | ||
| echo "Error while fetching service node (@" & $ma & ") peers: " & | ||
| $getPeersRes.data | ||
| else: | ||
| echo "No service node peers found" | ||
|
|
||
| echo "*------------------------------------------------------------------------------------------*" | ||
|
|
||
| await sleepAsync(interval) | ||
|
|
||
| proc startPeriodicPeerDiagnostic*(pm: PeerManager, codec: string) {.async.} = | ||
| asyncSpawn logSelfPeersLoop(pm, chronos.seconds(60)) | ||
| # asyncSpawn logServiceRelayPeers(pm, codec, chronos.seconds(20)) |
Oops, something went wrong.