Client: Add tests to verify shutdown #1641

acolytec3 · 2022-01-17T17:20:14Z

Add two tests to detect client shutdown message and that SIGINT signal successfully shuts down client process.

Addresses

See if the shutdown works correctly
Test if a (local) libp2p connection works

codecov · 2022-01-17T17:24:44Z

Codecov Report

Merging #1641 (1295e44) into master (9440a83) will increase coverage by 0.01%.
The diff coverage is n/a.

Flag	Coverage Δ
block	`85.01% <ø> (ø)`
blockchain	`83.28% <ø> (ø)`
client	`71.27% <ø> (ø)`
common	`93.89% <ø> (ø)`
devp2p	`82.83% <ø> (+0.13%)`	⬆️
ethash	`90.76% <ø> (ø)`
trie	`86.18% <ø> (ø)`
tx	`89.94% <ø> (ø)`
util	`92.69% <ø> (ø)`
vm	`81.27% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

ryanio · 2022-01-17T17:30:41Z

packages/client/test/cli/cli-rpc.spec.ts

-  child.stderr.removeAllListeners()
-  child.kill('SIGINT')
+  const res = child.kill('SIGINT')
+  st.ok(res === true, 'client shut down successfully')


Suggested change

st.ok(res === true, 'client shut down successfully')

st.ok(res, 'client shut down successfully')

ryanio · 2022-01-17T17:32:06Z

packages/client/test/cli/cli-rpc.spec.ts

@@ -7,9 +7,8 @@ const cliArgs = ['--rpc', '--ws', '--dev', '--transports=rlpx']
 const end = (child: ChildProcessWithoutNullStreams, hasEnded: boolean, st: tape.Test) => {
  if (hasEnded) return
  hasEnded = true
-  child.stdout.removeAllListeners()
-  child.stderr.removeAllListeners()


is it possible to keep these here in the end() function, but just after the new st.ok check?

I just gave up on checking for the exit message. If you remove them in function after the kill signal is sent, it removes them before the client prints the "Exiting..." message to the console so the test never registers. But the res value of true should be just as good because that SIGINT is what we listen for in the client to shut it down and if the result we get back is something screwy, that return value should be false in our test.

acolytec3 · 2022-01-17T21:09:39Z

I added a new test to connect from one libp2p peer to another so this PR technically addresses 2 of @holgerd77 's points from #1636 now. 😁

holgerd77

I learned so much on this review, thanks a lot, could have never done this!

That looks fantastic, will merge! 😄 👍

* VM: Adopted Backwards-compatible Dynamic Gas Cost Refactoring (#1553) * VM: report dynamic gas values in `fee` field of `step` event (#1364) * vm: codes: add dynamicGas property vm: codes: make codes more typesafe * vm: create no-op dynamic gas handlers * vm: first batch of dynamic gas up to 0x3f * vm: add other opcodes to gas map vm: change step event fee type from number to BN vm: deduct dynamic gas vm: fix stack peek vm: do not add gasLimit to gas cost for CREATE * vm: move errors to gas map * vm: fix memory dynamic gas bug * vm: fix gas bugs caused by not considering base fee * vm: fix message call gas related bugs, clone current gas left * add typedoc for peek use underscore for unused peek params (and fix eslint config) format some comment newlines for readability switch from require to import for exceptions * simplify the 2929 state manager castings in runTx * add changelog entry * vm: add EIP1283 tests * vm: split non-eip2929 and eip2929 gas costs * vm: fix gas costs * vm: add early-hardfork coverage * vm: clarify pre-Constantinople SSTORE gas vm: clarify EIP-150 comment * run coverage for all state and blockchain tests, remove redundant istanbul run * vm: fix CALLCODE gas vm: explicitly clone gasLimit for maxCallGas * vm: remove TODO in interpreter * update defaultCost to BN, cast 2929 statemanager to simplify use syntax * use underscore for unused variables, simplify types since they can be inferred * vm: fix browser tests + fix rebase * VM: moved dynamic fee to dedicated dynamicFee field in step event and retained fee behavior and type for backwards compatibility * VM: aligned InterpreterStep and step event object property documentation, completed missing step event properties * VM: test fix * vm: fix hardhat e2e tests * vm: fix MSTORE opcodes * vm: added dynamicGas property to push0 (EIP-3855) opcode * hardhat e2e: add temporary workaround for skipping tests with inconsistent memory field * nit style: use underscore instead of comment out unused variable Co-authored-by: Jochem Brouwer <jochembrouwer96@gmail.com> Co-authored-by: Ryan Ghods <ryan@ryanio.com> * ci: bump karma-typescript version (#1631) * bump karma-typescript to new release * bump libp2p-bootstrap * update package-lock * VM: Jump dest analysis enhancements (#1629) * Change valid jumps to single array * Switch array to Uint8Array * use correct opt code * Check for jumpsub * Address feedback * Address fixes * More efficiency * Adjust if/else logic for efficiency * Move comments Co-authored-by: Holger Drewes <Holger.Drewes@gmail.com> Co-authored-by: Ryan Ghods <ryan@ryanio.com> * rlp: add to root readme (#1642) * add rlp to root readme * add carryforward for rlp flag since it is not always tested on every build unless its paths are modified * Client: Add tests to verify shutdown (#1641) * Add tests to verify client shutdown * Add libp2p test * Address feedback * most libp2p into separate file * VM: Add comparison testing between branchs for State Test Runner (#1634) * Add diff tester and performance * update script * Simplify script * Readme updates * move start * Update stashing logic in script * tx: input value testing (#1620) * tx: helper methods to generate tx values * tx: helper methods to generate tx values * chore: scaffold test and add extra to values * chore: add missing spread operator * chore: single value for each tx key * tx: add generateCombinations method and legacy + eip 1559 test cases * chore: remove console log * chore: use london hardfork for eip1559 * tx: refactor generateCombinations interface and properly compare hash * tx: deterministically randomly sample 1000 elements from array for testing * chore: remove v * chore: remove todo * chore: clearer variable declarations and types * tx: fix and simplify random sampling * tx: display tx hash in testing output * tx: convert buffer to hex for output log * ci: fix node-versions run for node <16 (#1653) * re-add updating to npm v7 for node versions <16 * only upgrade npm for node v <16 * fix bin/rlp js: node 12 doesn't support ES11 which added support for nullish coalescing operator (??) so we'll use ternary here alternatively we could write this file in TS and compile to e.g. dist/bin/rlp (like we do in the client bin), but maybe if the file gets more complicated, in its current state i don't think it's so neccessary * use same errorMsg format for JSON.parse, remove unneeded extra Uint8Array.from (already is uint8array) * rlp: v3 updates from integration (#1648) * rlp updates * util: add arrToBufArr and bufArrToArr and tests * util updates, add deprecation notice for re-exports * rlp tsconfig: include rootDir for composite option * remove util exports deprecation notices * rlp: add readme note for buffer compatibility * undo capitalization * Devp2p, Client: Fix duplicated debug messages (#1643) * devp2p: update debug package * blockchain: update debug package * client: update debug package * vm: update debug package * devp2p/dpt fix for #1485 * devp2p/eth: Fix for 485 * devp2p: Fix for #1485: add base debug * devp2p/dpt #1485: change to debug.extend() * devp2p:dpt:server change to degub.extend() * devp2p:eth change to debug.extend() * devp2p/les: change to debug.extend() * devp2p:rlpx: change to debug.extend() * rlps: change to debug.extend() * Update debug to use IP as first tag * vm, client: removed ProofStateManager interface, added optional getProof, verifyProof methods to StateManager interface (#1660) * Monorepo (& Tx, VM): Examples scripts in CI (#1658) * chore(examples): examples added to ci * chore(examples-ci): remove script from VM (for now) & rename examples workflow file * chore(ci): new script formwatted with prettier & example workflow changes to run with non-test branches Co-authored-by: Holger Drewes <Holger.Drewes@gmail.com> Co-authored-by: Holger Drewes <Holger.Drewes@gmail.com> Co-authored-by: acolytec3 <17355484+acolytec3@users.noreply.github.com> Co-authored-by: Gabriel Rocheleau <contact@rockwaterweb.com> Co-authored-by: ScottyPoi <66335769+ScottyPoi@users.noreply.github.com> Co-authored-by: Cesar Brazon <cesarbrazon10@gmail.com>

Add tests to verify client shutdown

02a949b

acolytec3 added package: client type: tests PR state: needs review labels Jan 17, 2022

acolytec3 requested review from ryanio and holgerd77 January 17, 2022 17:20

acolytec3 added PR state: WIP and removed PR state: needs review labels Jan 17, 2022

ryanio reviewed Jan 17, 2022

View reviewed changes

acolytec3 added 4 commits January 17, 2022 16:00

Add libp2p test

55bb90d

Address feedback

050a1c9

Merge branch 'master' into client-shutdown-tests

975740c

most libp2p into separate file

1295e44

acolytec3 added PR state: needs review and removed PR state: WIP labels Jan 17, 2022

holgerd77 approved these changes Jan 18, 2022

View reviewed changes

holgerd77 changed the title ~~Add tests to verify client shutdown~~ Client: Add tests to verify shutdown Jan 18, 2022

holgerd77 merged commit 6bb2f23 into master Jan 18, 2022

holgerd77 deleted the client-shutdown-tests branch January 18, 2022 09:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Client: Add tests to verify shutdown #1641

Client: Add tests to verify shutdown #1641

acolytec3 commented Jan 17, 2022 •

edited

Loading

codecov bot commented Jan 17, 2022 •

edited

Loading

ryanio Jan 17, 2022

ryanio Jan 17, 2022

acolytec3 Jan 17, 2022

acolytec3 commented Jan 17, 2022

holgerd77 left a comment

	st.ok(res === true, 'client shut down successfully')
	st.ok(res, 'client shut down successfully')

Client: Add tests to verify shutdown #1641

Client: Add tests to verify shutdown #1641

Conversation

acolytec3 commented Jan 17, 2022 • edited Loading

codecov bot commented Jan 17, 2022 • edited Loading

Codecov Report

ryanio Jan 17, 2022

Choose a reason for hiding this comment

ryanio Jan 17, 2022

Choose a reason for hiding this comment

acolytec3 Jan 17, 2022

Choose a reason for hiding this comment

acolytec3 commented Jan 17, 2022

holgerd77 left a comment

Choose a reason for hiding this comment

acolytec3 commented Jan 17, 2022 •

edited

Loading

codecov bot commented Jan 17, 2022 •

edited

Loading