Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Missing test(s) for message recovery #9137

Merged
merged 8 commits into from
Nov 23, 2023
Merged

Missing test(s) for message recovery #9137

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d15984
Update message recovery code & tests
sitetester Nov 6, 2023
d1e24f0
Add missing test for schema verification
sitetester Nov 6, 2023
142e547
Revert check, since this check would be needed only in case message r…
sitetester Nov 9, 2023
62fe774
Revert test for valid params
sitetester Nov 9, 2023
fd5c2ce
Rearrange expects per code & cover recoveredCCMs part
sitetester Nov 16, 2023
ebefc84
Simplify tests
sitetester Nov 21, 2023
9b50638
Better use `.toHaveBeenCalledWith(ctx)`
sitetester Nov 21, 2023
bc3dc83
Merge branch 'release/6.1.0' into 8193-verify-message-recovery
ishantiw Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 74 additions & 21 deletions framework/test/unit/modules/interoperability/mainchain/commands/recover_message.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import { codec } from '@liskhq/lisk-codec';
import { Transaction } from '@liskhq/lisk-chain';
import { utils } from '@liskhq/lisk-cryptography';
import { MerkleTree } from '@liskhq/lisk-tree';
import { MerkleTree, regularMerkleTree } from '@liskhq/lisk-tree';
import { Proof } from '@liskhq/lisk-tree/dist-node/merkle_tree/types';
import {
CROSS_CHAIN_COMMAND_NAME_TRANSFER,
Expand Down Expand Up @@ -574,6 +574,13 @@ describe('MessageRecoveryCommand', () => {

await expect(command.execute(commandExecuteContext)).resolves.toBeUndefined();

expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
1,
CONTEXT_STORE_KEY_CCM_PROCESSING,
true,
);

const recoveredCCMs: Buffer[] = [];
for (const crossChainMessage of commandExecuteContext.params.crossChainMessages) {
const ccm = codec.decode<CCMsg>(ccmSchema, crossChainMessage);
const ctx: CrossChainMessageContext = {
Expand All @@ -584,25 +591,53 @@ describe('MessageRecoveryCommand', () => {
),
};

const recoveredCCM = await command['_applyRecovery'](ctx);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

due to this, the expectation in line 597 will be met, even though it was not triggered from the function you are testing, right? Alternatively, you could create a copy of ctx, change the status of ccm to CCM_STATUS_CODE_RECOVERED and swap ccm.sendingChainID and ccm.receivingChainID.

recoveredCCMs.push(codec.encode(ccmSchema, recoveredCCM));

expect(command['_applyRecovery']).toHaveBeenCalledWith(ctx);
expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
1,
CONTEXT_STORE_KEY_CCM_PROCESSING,
true,
);
expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
2,
CONTEXT_STORE_KEY_CCM_PROCESSING,
false,
);
}

expect(interopModule.stores.get(TerminatedOutboxStore).set).toHaveBeenCalledTimes(1);
expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
2,
CONTEXT_STORE_KEY_CCM_PROCESSING,
false,
);

const terminatedOutboxSubstore = interopModule.stores.get(TerminatedOutboxStore);
jest.spyOn(terminatedOutboxSubstore, 'set');

expect(terminatedOutboxSubstore.set).toHaveBeenCalledTimes(1);

const terminatedOutboxAccount = await terminatedOutboxSubstore.get(
commandExecuteContext,
commandExecuteContext.params.chainID,
);
const proofLocal = {
size: terminatedOutboxAccount.outboxSize,
idxs: commandExecuteContext.params.idxs,
siblingHashes: commandExecuteContext.params.siblingHashes,
};
terminatedOutboxAccount.outboxRoot = regularMerkleTree.calculateRootFromUpdateData(
recoveredCCMs.map(ccm => utils.hash(ccm)),
{ ...proofLocal, indexes: proofLocal.idxs },
);
expect(terminatedOutboxSubstore.set).toHaveBeenCalledWith(
commandExecuteContext,
commandExecuteContext.params.chainID,
terminatedOutboxAccount,
);
});

it('should call forwardRecovery when sending chain is not mainchain', async () => {
await expect(command.execute(commandExecuteContext)).resolves.toBeUndefined();

expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
1,
CONTEXT_STORE_KEY_CCM_PROCESSING,
true,
);

const recoveredCCMs: Buffer[] = [];
for (const crossChainMessage of commandExecuteContext.params.crossChainMessages) {
const ccm = codec.decode<CCMsg>(ccmSchema, crossChainMessage);
const ctx: CrossChainMessageContext = {
Expand All @@ -613,23 +648,41 @@ describe('MessageRecoveryCommand', () => {
),
};

const recoveredCCM = await command['_forwardRecovery'](ctx);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

recoveredCCMs.push(codec.encode(ccmSchema, recoveredCCM));

expect(command['_forwardRecovery']).toHaveBeenCalledWith(ctx);
}

const terminatedOutboxStore = command['stores'].get(TerminatedOutboxStore);
jest.spyOn(terminatedOutboxStore, 'set');

expect(terminatedOutboxStore.set).toHaveBeenCalledTimes(1);
expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
1,
CONTEXT_STORE_KEY_CCM_PROCESSING,
true,
);
expect(commandExecuteContext.contextStore.set).toHaveBeenNthCalledWith(
2,
CONTEXT_STORE_KEY_CCM_PROCESSING,
false,
);

const terminatedOutboxSubstore = command['stores'].get(TerminatedOutboxStore);
const terminatedOutboxAccount = await terminatedOutboxSubstore.get(
commandExecuteContext,
commandExecuteContext.params.chainID,
);
jest.spyOn(terminatedOutboxSubstore, 'set');

expect(terminatedOutboxSubstore.set).toHaveBeenCalledTimes(1);

const proofLocal = {
size: terminatedOutboxAccount.outboxSize,
idxs: commandExecuteContext.params.idxs,
siblingHashes: commandExecuteContext.params.siblingHashes,
};
terminatedOutboxAccount.outboxRoot = regularMerkleTree.calculateRootFromUpdateData(
recoveredCCMs.map(ccm => utils.hash(ccm)),
{ ...proofLocal, indexes: proofLocal.idxs },
);
expect(terminatedOutboxSubstore.set).toHaveBeenCalledWith(
commandExecuteContext,
commandExecuteContext.params.chainID,
terminatedOutboxAccount,
);
});
});

Expand Down