[NONEVM-3216] Setup coverage reports for timelock/mcms (#459)

* ref: use generateRandomContractId instead of crc32

* feat: init blockchain once per test

* test: mcms and timelock test coverage

* fix: name

Author: patricios-space

contracts/tests/ccip/feequoter/FeeQuoter.getValidatedFee.spec.ts

@@ -414,7 +414,7 @@ describe('FeeQuoter GetValidatedFee', () => {
     })
   })
 
-  skip('should revert when fee token not supported', async () => {
+  it.skip('should revert when fee token not supported', async () => {
     const notAFeeToken = FeeQuoterSetup.CUSTOM_TOKEN.token
 
     const message: rt.CCIPSend = {

contracts/tests/ccip/onramp/OnRamp.setDynamicConfig.spec.ts

@@ -120,7 +120,7 @@ describe('OnRamp - set Dynamic Config', () => {
 
   afterAll(async () => {
     if (process.env['COVERAGE'] === 'true') {
-      coverage.generateCoverageArtifacts(blockchain, 'onramp_set-dynamic_config_tests', [
+      await coverage.generateCoverageArtifacts(blockchain, 'onramp_set-dynamic_config_tests', [
         {
           code: await onramp.getCode(),
           name: 'onramp',

contracts/tests/coverage/coverage.ts

@@ -2,6 +2,7 @@ import { compile } from '@ton/blueprint'
 import { Cell } from '@ton/core'
 import { Blockchain } from '@ton/sandbox'
 import { mkdirSync, writeFileSync } from 'fs'
+import { mcms } from '../../wrappers/mcms'
 
 export const CoverageContractName = {
   router: 'router',
@@ -12,6 +13,8 @@ export const CoverageContractName = {
   send_executor: 'send_executor',
   receive_executor: 'receive_executor',
   deployable: 'deployable',
+  mcms: 'mcms',
+  timelock: 'timelock',
 } as const
 export type CoverageConfigNames = keyof typeof CoverageContractName
 

contracts/tests/coverage/scriptMergeCoverageIntoHtmlReports.ts

@@ -11,6 +11,8 @@ const onRampSuffix = `${coverage.CoverageContractName.onramp}.json`
 const sendExecutorSuffix = `${coverage.CoverageContractName.send_executor}.json`
 const receiveExecutorSuffix = `${coverage.CoverageContractName.receive_executor}.json`
 const deployableSuffix = `${coverage.CoverageContractName.deployable}.json`
+const mcmsSuffix = `${coverage.CoverageContractName.mcms}.json`
+const timelockSuffix = `${coverage.CoverageContractName.timelock}.json`
 
 const offRampCoverageResults: Coverage[] = []
 const routerCoverageResults: Coverage[] = []
@@ -20,6 +22,8 @@ const onrampCoverageResults: Coverage[] = []
 const sendExecutorCoverageResults: Coverage[] = []
 const receiveExecutorCoverageResults: Coverage[] = []
 const deployableCoverageResults: Coverage[] = []
+const mcmsCoverageResults: Coverage[] = []
+const timelockCoverageResults: Coverage[] = []
 
 const coverageDir = './.coverage'
 
@@ -53,6 +57,12 @@ for (const file of files) {
   } else if (file.endsWith(deployableSuffix)) {
     const coverage = Coverage.fromJson(readFileSync(filePath, 'utf-8'))
     deployableCoverageResults.push(coverage)
+  } else if (file.endsWith(mcmsSuffix)) {
+    const coverage = Coverage.fromJson(readFileSync(filePath, 'utf-8'))
+    mcmsCoverageResults.push(coverage)
+  } else if (file.endsWith(timelockSuffix)) {
+    const coverage = Coverage.fromJson(readFileSync(filePath, 'utf-8'))
+    timelockCoverageResults.push(coverage)
   }
 }
 
@@ -70,6 +80,8 @@ const onRampMerged = mergeResults(onrampCoverageResults)
 const sendExecutorMerged = mergeResults(sendExecutorCoverageResults)
 const receiveExecutorMerged = mergeResults(receiveExecutorCoverageResults)
 const deployableMerged = mergeResults(deployableCoverageResults)
+const mcmsMerged = mergeResults(mcmsCoverageResults)
+const timelockMerged = mergeResults(timelockCoverageResults)
 
 // Generate HTML reports
 if (offRampMerged) {
@@ -135,3 +147,16 @@ if (deployableMerged) {
   )
   console.log('Generated deployable-coverage.html')
 }
+
+if (mcmsMerged) {
+  writeFileSync(`./.coverage/${coverage.CoverageContractName.mcms}.html`, mcmsMerged.report('html'))
+  console.log('Generated mcms-coverage.html')
+}
+
+if (timelockMerged) {
+  writeFileSync(
+    `./.coverage/${coverage.CoverageContractName.timelock}.html`,
+    timelockMerged.report('html'),
+  )
+  console.log('Generated timelock-coverage.html')
+}

contracts/tests/lib/funding/WithdrawableSpec.ts

@@ -432,7 +432,7 @@ export function newWithdrawableSpec<TContract extends withdrawable.Interface>(
         )
         const initialBalance = (await suiteSetup.blockchain.getContract(contract.address)).balance
 
-        testDrain(initialBalance, undefined, 5n, suiteSetup, contract)
+        await testDrain(initialBalance, undefined, 5n, suiteSetup, contract)
       })
 
       /**
@@ -447,7 +447,7 @@ export function newWithdrawableSpec<TContract extends withdrawable.Interface>(
         const initialBalance = (await suiteSetup.blockchain.getContract(contract.address)).balance
         const customReserve = customReserveAboveDefault(initialBalance)
 
-        testDrain(initialBalance, customReserve, 15n, suiteSetup, contract)
+        await testDrain(initialBalance, customReserve, 15n, suiteSetup, contract)
       })
 
       /**
@@ -462,7 +462,7 @@ export function newWithdrawableSpec<TContract extends withdrawable.Interface>(
         const initialBalance = (await suiteSetup.blockchain.getContract(contract.address)).balance
         const customReserve = customReserveBelowDefault()
 
-        testDrain(initialBalance, customReserve, 16n, suiteSetup, contract)
+        await testDrain(initialBalance, customReserve, 16n, suiteSetup, contract)
       })
 
       /**

contracts/tests/mcms/BaseTest.ts

@@ -1,11 +1,9 @@
 import '@ton/test-utils'
-
-import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox'
+import { Blockchain, BlockchainSnapshot, SandboxContract, TreasuryContract } from '@ton/sandbox'
 import { Cell, toNano, beginCell } from '@ton/core'
-import { compile } from '@ton/blueprint'
-import { crc32 } from 'zlib'
 
-import { asSnakeData } from '../../src/utils'
+import { asSnakeData, generateRandomContractId } from '../../src/utils'
+import * as coverage from '../coverage/coverage'
 
 import { mcms, rbactl } from '../../wrappers/mcms'
 import { ac } from '../../wrappers/lib/access'
@@ -46,11 +44,16 @@ export class BaseTestSetup {
   acc: TestAccounts
   bind: TestContracts
 
-  constructor() {
+  readonly testSuite: string
+  testID = 0
+  snapshot: BlockchainSnapshot
+
+  constructor(testSuite: string) {
     this.blockchain = null as any
     this.code = null as any
     this.acc = null as any
     this.bind = null as any
+    this.testSuite = testSuite
   }
 
   static async compileContracts(): Promise<TestCode> {
@@ -88,6 +91,11 @@ export class BaseTestSetup {
       vmLogs: 'none',
       debugLogs: true,
     }
+    if (process.env['COVERAGE'] === 'true') {
+      this.blockchain.enableCoverage()
+      this.blockchain.verbosity.print = false
+      this.blockchain.verbosity.vmLogs = 'vm_logs_verbose'
+    }
 
     // Set up accounts
     this.acc = {
@@ -113,7 +121,7 @@ export class BaseTestSetup {
   /**
    * Setup the timelock contract with RBAC configuration
    */
-  async setupTimelockContract(testId: string): Promise<void> {
+  async setupTimelockContract(): Promise<void> {
     const rbacStorage: ac.ContractData = {
       roles: ac.builder.data.rolesDict(
         new Map([
@@ -162,7 +170,7 @@ export class BaseTestSetup {
     }
 
     const data = {
-      id: crc32(`mcms.timelock.${testId}`),
+      id: Number(generateRandomContractId()),
       minDelay: BaseTestSetup.MIN_DELAY,
       executorRoleCheckEnabled: true,
       opPendingInfo: {
@@ -184,9 +192,9 @@ export class BaseTestSetup {
   /**
    * Setup the counter contract
    */
-  async setupCounterContract(testId: string): Promise<void> {
+  async setupCounterContract(): Promise<void> {
     const data = {
-      id: BigInt(crc32(`mcms.counter.${testId}`)),
+      id: generateRandomContractId(),
       value: 0,
       ownable: {
         owner: this.bind.timelock.address,
@@ -256,15 +264,20 @@ export class BaseTestSetup {
     })
   }
 
-  /**
-   * Complete setup for all contracts - convenience method that combines all setup steps
-   */
-  async setupAll(testId: string): Promise<void> {
-    await this.initializeBlockchain()
-    await this.setupTimelockContract(testId)
-    await this.deployTimelockContract()
-    await this.setupCounterContract(testId)
-    await this.deployCounterContract()
+  static async beforeAll(testsuite: string): Promise<BaseTestSetup> {
+    const self = new BaseTestSetup(testsuite)
+    self.code = await BaseTestSetup.compileContracts()
+    await self.initializeBlockchain()
+    await self.setupTimelockContract()
+    await self.deployTimelockContract()
+    await self.setupCounterContract()
+    await self.deployCounterContract()
+    self.snapshot = self.blockchain.snapshot()
+    return self
+  }
+
+  async beforeEach() {
+    await this.blockchain.loadFrom(this.snapshot)
   }
 
   /**
@@ -273,4 +286,21 @@ export class BaseTestSetup {
   warpTime(period: number) {
     this.blockchain.now = this.blockchain.now!! + period
   }
+
+  async generateCoverageArtifacts(): Promise<void> {
+    await coverage.generateCoverageArtifacts(
+      this.blockchain,
+      `rbac_${this.testSuite}_${this.testID++}`,
+      [
+        {
+          code: this.code.mcms,
+          name: 'mcms',
+        },
+        {
+          code: this.code.timelock,
+          name: 'timelock',
+        },
+      ],
+    )
+  }
 }

contracts/tests/mcms/Integration.spec.ts

@@ -2,18 +2,17 @@ import '@ton/test-utils'
 
 import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox'
 import { Address, Cell, toNano } from '@ton/core'
-import { compile } from '@ton/blueprint'
 import { SigningKey, randomBytes, computeAddress } from 'ethers'
 
-import { asSnakeData } from '../../src/utils'
+import { asSnakeData, generateRandomContractId } from '../../src/utils'
+import * as coverage from '../coverage/coverage'
 
 import { mcms } from '../../wrappers/mcms'
 import { rbactl } from '../../wrappers/mcms'
 import { ac } from '../../wrappers/lib/access'
 import * as counter from '../../wrappers/examples/Counter'
 import * as ownable2step from '../../wrappers/libraries/access/Ownable2Step'
 
-import { crc32 } from 'zlib'
 import { merkleProof } from '../../src/mcms'
 
 describe('MCMS - IntegrationTest', () => {
@@ -67,8 +66,16 @@ describe('MCMS - IntegrationTest', () => {
 
   let signerKeyPairs: SigningKey[] = []
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     blockchain = await Blockchain.create()
+    if (process.env['COVERAGE'] === 'true') {
+      blockchain.enableCoverage()
+      blockchain.verbosity.print = false
+      blockchain.verbosity.vmLogs = 'vm_logs_verbose'
+    }
+  })
+
+  beforeEach(async () => {
     blockchain.now = Math.floor(Date.now() / 1000) // set to current unix timestamp
 
     // Set up accounts
@@ -94,7 +101,7 @@ describe('MCMS - IntegrationTest', () => {
       bind.mcmsPropose = blockchain.openContract(
         mcms.ContractClient.newFrom(
           mcms.builder.data.contractDataEmpty(
-            crc32('mcms.mcms.test-integration-propose'),
+            Number(generateRandomContractId()),
             acc.deployer.address,
           ),
           code.mcms,
@@ -104,7 +111,7 @@ describe('MCMS - IntegrationTest', () => {
       bind.mcmsVeto = blockchain.openContract(
         mcms.ContractClient.newFrom(
           mcms.builder.data.contractDataEmpty(
-            crc32('mcms.mcms.test-integration-veto'),
+            Number(generateRandomContractId()),
             acc.deployer.address,
           ),
           code.mcms,
@@ -114,7 +121,7 @@ describe('MCMS - IntegrationTest', () => {
       bind.mcmsBypass = blockchain.openContract(
         mcms.ContractClient.newFrom(
           mcms.builder.data.contractDataEmpty(
-            crc32('mcms.mcms.test-integration-bypass'),
+            Number(generateRandomContractId()),
             acc.deployer.address,
           ),
           code.mcms,
@@ -172,7 +179,7 @@ describe('MCMS - IntegrationTest', () => {
       }
 
       const data = {
-        id: crc32('mcms.timelock.test-integration'), // unique ID for this instance
+        id: Number(generateRandomContractId()),
         minDelay: MIN_DELAY,
         executorRoleCheckEnabled: true,
         opPendingInfo: {
@@ -190,7 +197,7 @@ describe('MCMS - IntegrationTest', () => {
     // Set up Counter contract
     {
       const data = {
-        id: crc32('mcms.counter.test-integration'), // unique ID for this instance
+        id: Number(generateRandomContractId()),
         value: 0,
         ownable: {
           owner: bind.timelock.address,
@@ -1169,4 +1176,19 @@ describe('MCMS - IntegrationTest', () => {
 
     proposePredecessor = callsHash
   }, 20_000) // test can take a while
+
+  afterAll(async () => {
+    if (process.env['COVERAGE'] === 'true') {
+      await coverage.generateCoverageArtifacts(blockchain, 'rbac_mcms_integration', [
+        {
+          code: code.timelock,
+          name: 'timelock',
+        },
+        {
+          code: code.mcms,
+          name: 'mcms',
+        },
+      ])
+    }
+  })
 })