hyperledger-labs / fabric-smart-client / 33733870469

86%

Build Type

push

github

Committed by web-flow

Commit Message

test(delivery): cover the delivery package and fix Stop (#1706)

platform/fabric/core/generic/delivery sat at 17.7% of statements. Add unit tests
for Delivery's lifecycle, Service's scan entry points and the deliver client
helpers -- roughly 1,300 lines behind one set of configurable doubles in
helpers_test.go -- taking the package to 93.4%.

Writing them turned up three bugs. Stop closed the stop channel unguarded, so a
second call panicked; it is now guarded by a sync.Once. NewService dereferenced a
nil channelConfig; it now rejects it. And Stop published its cause by sending on
the unbuffered stop channel, which untilStop, readBlocks and runReceiver all
read, so only one of them observed the cause and Run could return nil for a
shutdown that had one -- the lifecycle tests flaked about one run in ten. stop is
now a signal channel that is only ever closed, with the cause in an atomic
written before the close. That also removes a latent deadlock: with no reader
left the send blocked forever, wedging every later Stop caller behind the Once.

With shutdown deterministic the tests stop guessing at timing -- both time.Sleep
calls are gone and the subtests assert the reason for the stop.

Document the package per docs/agents/conventions.md: add the package comment it
never had, keep implementation detail out of the exported comments, and adopt
Godoc links.

Co-authored-by: Shashank <yshashank959@gmail.com>
Signed-off-by: Shashank <yshashank959@gmail.com>
Signed-off-by: Marcus Brandenburger <bur@zurich.ibm.com>

Coverage Stats

20 of 20 new or added lines in 2 files covered. (100.0%)

12 existing lines in 5 files now uncovered.

31334 of 36991 relevant lines covered (84.71%)

3307.97 hits per line