commit/merkleroot: unit tests, bump coverage (#299)

smartcontractkit · Nov 5, 2024 · 733f5d2 · 733f5d2
1 parent c298311
commit 733f5d2
Show file tree

Hide file tree

Showing 7 changed files with 362 additions and 27 deletions.
diff --git a/commit/merkleroot/observation.go b/commit/merkleroot/observation.go
@@ -255,7 +255,7 @@ type Observer interface {
 	ObserveFChain() map[cciptypes.ChainSelector]int
 }
 
-type ObserverImpl struct {
+type observerImpl struct {
 	lggr         logger.Logger
 	homeChain    reader.HomeChain
 	nodeID       commontypes.OracleID
@@ -265,7 +265,7 @@ type ObserverImpl struct {
 }
 
 // ObserveOffRampNextSeqNums observes the next sequence numbers for each source chain from the OffRamp
-func (o ObserverImpl) ObserveOffRampNextSeqNums(ctx context.Context) []plugintypes.SeqNumChain {
+func (o observerImpl) ObserveOffRampNextSeqNums(ctx context.Context) []plugintypes.SeqNumChain {
 	supportsDestChain, err := o.chainSupport.SupportsDestChain(o.nodeID)
 	if err != nil {
 		o.lggr.Warnw("call to SupportsDestChain failed", "err", err)
@@ -304,7 +304,7 @@ func (o ObserverImpl) ObserveOffRampNextSeqNums(ctx context.Context) []plugintyp
 }
 
 // ObserveLatestOnRampSeqNums observes the latest onRamp sequence numbers for each configured source chain.
-func (o ObserverImpl) ObserveLatestOnRampSeqNums(
+func (o observerImpl) ObserveLatestOnRampSeqNums(
 	ctx context.Context, destChain cciptypes.ChainSelector) []plugintypes.SeqNumChain {
 
 	allSourceChains, err := o.chainSupport.KnownSourceChainsSlice()
@@ -353,7 +353,7 @@ func (o ObserverImpl) ObserveLatestOnRampSeqNums(
 }
 
 // ObserveMerkleRoots computes the merkle roots for the given sequence number ranges
-func (o ObserverImpl) ObserveMerkleRoots(
+func (o observerImpl) ObserveMerkleRoots(
 	ctx context.Context,
 	ranges []plugintypes.ChainRange,
 ) []cciptypes.MerkleRootChain {
@@ -414,7 +414,7 @@ func (o ObserverImpl) ObserveMerkleRoots(
 }
 
 // computeMerkleRoot computes the merkle root of a list of messages
-func (o ObserverImpl) computeMerkleRoot(ctx context.Context, msgs []cciptypes.Message) (cciptypes.Bytes32, error) {
+func (o observerImpl) computeMerkleRoot(ctx context.Context, msgs []cciptypes.Message) (cciptypes.Bytes32, error) {
 	var hashes [][32]byte
 	sort.Slice(msgs, func(i, j int) bool { return msgs[i].Header.SequenceNumber < msgs[j].Header.SequenceNumber })
 
@@ -452,7 +452,7 @@ func (o ObserverImpl) computeMerkleRoot(ctx context.Context, msgs []cciptypes.Me
 	return root, nil
 }
 
-func (o ObserverImpl) ObserveRMNRemoteCfg(
+func (o observerImpl) ObserveRMNRemoteCfg(
 	ctx context.Context,
 	dstChain cciptypes.ChainSelector) rmntypes.RemoteConfig {
 	rmnRemoteCfg, err := o.ccipReader.GetRMNRemoteConfig(ctx, dstChain)
@@ -468,7 +468,7 @@ func (o ObserverImpl) ObserveRMNRemoteCfg(
 	return rmnRemoteCfg
 }
 
-func (o ObserverImpl) ObserveFChain() map[cciptypes.ChainSelector]int {
+func (o observerImpl) ObserveFChain() map[cciptypes.ChainSelector]int {
 	fChain, err := o.homeChain.GetFChain()
 	if err != nil {
 		// TODO: metrics

diff --git a/commit/merkleroot/observation_test.go b/commit/merkleroot/observation_test.go
@@ -249,7 +249,7 @@ func Test_ObserveOffRampNextSeqNums(t *testing.T) {
 			defer chainSupport.AssertExpectations(t)
 			defer ccipReader.AssertExpectations(t)
 
-			o := ObserverImpl{
+			o := observerImpl{
 				nodeID:       nodeID,
 				lggr:         logger.Test(t),
 				msgHasher:    mocks.NewMessageHasher(),
@@ -468,7 +468,7 @@ func Test_ObserveMerkleRoots(t *testing.T) {
 				chainSupport.On("SupportedChains", nodeID).Return(tc.supportedChains, nil)
 			}
 
-			o := ObserverImpl{
+			o := observerImpl{
 				nodeID:       nodeID,
 				lggr:         logger.Test(t),
 				msgHasher:    mocks.NewMessageHasher(),
@@ -571,7 +571,7 @@ func Test_computeMerkleRoot(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			p := ObserverImpl{
+			p := observerImpl{
 				lggr:      logger.Test(t),
 				msgHasher: tc.messageHasher,
 			}

diff --git a/commit/merkleroot/outcome.go b/commit/merkleroot/outcome.go
@@ -75,7 +75,7 @@ func (w *Processor) getOutcome(
 func reportRangesOutcome(
 	_ Query,
 	lggr logger.Logger,
-	consensusObservation ConsensusObservation,
+	consensusObservation consensusObservation,
 	maxMerkleTreeSize uint64,
 	dstChain cciptypes.ChainSelector,
 ) Outcome {
@@ -143,7 +143,7 @@ func reportRangesOutcome(
 func buildReport(
 	q Query,
 	lggr logger.Logger,
-	consensusObservation ConsensusObservation,
+	consensusObservation consensusObservation,
 	prevOutcome Outcome,
 ) Outcome {
 	roots := maps.Values(consensusObservation.MerkleRoots)
@@ -232,7 +232,7 @@ func checkForReportTransmission(
 	lggr logger.Logger,
 	maxReportTransmissionCheckAttempts uint,
 	previousOutcome Outcome,
-	consensusObservation ConsensusObservation,
+	consensusObservation consensusObservation,
 ) Outcome {
 
 	offRampUpdated := false
@@ -271,7 +271,7 @@ func getConsensusObservation(
 	fRoleDON int,
 	destChain cciptypes.ChainSelector,
 	aos []plugincommon.AttributedObservation[Observation],
-) (ConsensusObservation, error) {
+) (consensusObservation, error) {
 	aggObs := aggregateObservations(aos)
 
 	// consensus on the fChain map uses the role DON F value
@@ -281,7 +281,7 @@ func getConsensusObservation(
 
 	_, exists := fChains[destChain]
 	if !exists {
-		return ConsensusObservation{},
+		return consensusObservation{},
 			fmt.Errorf("no consensus value for fDestChain, destChain: %d, fChainObs: %+v, fChainsConsensus: %+v",
 				destChain, aggObs.FChain, fChains,
 			)
@@ -292,7 +292,7 @@ func getConsensusObservation(
 
 	// Get consensus using strict 2fChain+1 threshold.
 	twoFChainPlus1 := consensus.MakeMultiThreshold(fChains, consensus.TwoFPlus1)
-	consensusObs := ConsensusObservation{
+	consensusObs := consensusObservation{
 		MerkleRoots:      consensus.GetConsensusMap(lggr, "Merkle Root", aggObs.MerkleRoots, twoFChainPlus1),
 		OnRampMaxSeqNums: consensus.GetConsensusMap(lggr, "OnRamp Max Seq Nums", aggObs.OnRampMaxSeqNums, twoFChainPlus1),
 		OffRampNextSeqNums: consensus.GetConsensusMap(

diff --git a/commit/merkleroot/outcome_test.go b/commit/merkleroot/outcome_test.go
@@ -19,7 +19,7 @@ func Test_buildReport(t *testing.T) {
 	t.Run("determinism check", func(t *testing.T) {
 		const rounds = 50
 
-		obs := ConsensusObservation{
+		obs := consensusObservation{
 			MerkleRoots: map[cciptypes.ChainSelector]cciptypes.MerkleRootChain{
 				cciptypes.ChainSelector(1): {
 					ChainSel:     1,
@@ -54,7 +54,7 @@ func Test_reportRangesOutcome(t *testing.T) {
 
 	testCases := []struct {
 		name                 string
-		consensusObservation ConsensusObservation
+		consensusObservation consensusObservation
 		merkleTreeSizeLimit  uint64
 		expectedOutcome      Outcome
 	}{
@@ -69,7 +69,7 @@ func Test_reportRangesOutcome(t *testing.T) {
 		},
 		{
 			name: "simple scenario with one chain",
-			consensusObservation: ConsensusObservation{
+			consensusObservation: consensusObservation{
 				OnRampMaxSeqNums: map[cciptypes.ChainSelector]cciptypes.SeqNum{
 					1: 20,
 				},
@@ -94,7 +94,7 @@ func Test_reportRangesOutcome(t *testing.T) {
 		},
 		{
 			name: "simple scenario with one chain",
-			consensusObservation: ConsensusObservation{
+			consensusObservation: consensusObservation{
 				OnRampMaxSeqNums: map[cciptypes.ChainSelector]cciptypes.SeqNum{
 					1: 20,
 					2: 1000,

diff --git a/commit/merkleroot/processor.go b/commit/merkleroot/processor.go
@@ -52,7 +52,7 @@ func NewProcessor(
 	rmnCrypto cciptypes.RMNCrypto,
 	rmnHomeReader readerpkg.RMNHome,
 ) *Processor {
-	observer := ObserverImpl{
+	observer := observerImpl{
 		lggr,
 		homeChain,
 		oracleID,

diff --git a/commit/merkleroot/types.go b/commit/merkleroot/types.go
@@ -31,8 +31,8 @@ func (o Observation) IsEmpty() bool {
 		len(o.FChain) == 0
 }
 
-// MerkleAggregatedObservation is the aggregation of a list of observations
-type MerkleAggregatedObservation struct {
+// aggregatedObservation is the aggregation of a list of merkle root processor observations
+type aggregatedObservation struct {
 	// A map from chain selectors to the list of merkle roots observed for each chain
 	MerkleRoots map[cciptypes.ChainSelector][]cciptypes.MerkleRootChain
 
@@ -50,8 +50,8 @@ type MerkleAggregatedObservation struct {
 }
 
 // aggregateObservations takes a list of observations and produces an MerkleAggregatedObservation
-func aggregateObservations(aos []plugincommon.AttributedObservation[Observation]) MerkleAggregatedObservation {
-	aggObs := MerkleAggregatedObservation{
+func aggregateObservations(aos []plugincommon.AttributedObservation[Observation]) aggregatedObservation {
+	aggObs := aggregatedObservation{
 		MerkleRoots:        make(map[cciptypes.ChainSelector][]cciptypes.MerkleRootChain),
 		OnRampMaxSeqNums:   make(map[cciptypes.ChainSelector][]cciptypes.SeqNum),
 		OffRampNextSeqNums: make(map[cciptypes.ChainSelector][]cciptypes.SeqNum),
@@ -94,8 +94,8 @@ func aggregateObservations(aos []plugincommon.AttributedObservation[Observation]
 	return aggObs
 }
 
-// ConsensusObservation holds the consensus values for all chains across all observations in a round
-type ConsensusObservation struct {
+// consensusObservation holds the consensus values for all chains across all observations in a round
+type consensusObservation struct {
 	// A map from chain selectors to each chain's consensus merkle root
 	MerkleRoots map[cciptypes.ChainSelector]cciptypes.MerkleRootChain