test: use separate address book for unit tests (#899)

* test: do not commit local addressbook Signed-off-by: Tomás Migone <[email protected]> * fix: tests assuming address.json Signed-off-by: Tomás Migone <[email protected]> * chore: clean up address book Signed-off-by: Tomás Migone <[email protected]> * test: fix coverage command Signed-off-by: Tomás Migone <[email protected]> * test: fix coverage ci Signed-off-by: Tomás Migone <[email protected]> --------- Signed-off-by: Tomás Migone <[email protected]>
graphprotocol · Dec 26, 2023 · 37a59dd · 37a59dd
1 parent d9aafd1
commit 37a59dd
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 339 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,7 +31,7 @@ bin/
 .vscode
 
 # Coverage and other reports
-/reports
+reports/
 coverage.json
 
 # Local test files

diff --git a/packages/contracts/addresses.json b/packages/contracts/addresses.json
diff --git a/packages/contracts/cli/defaults.ts b/packages/contracts/cli/defaults.ts
@@ -4,7 +4,7 @@ import { Overrides } from 'ethers'
 export const local = {
   mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
   providerUrl: 'http://localhost:8545',
-  addressBookPath: './addresses.json',
+  addressBookPath: './addresses-local.json',
   graphConfigPath: './config/graph.mainnet.yml',
   accountNumber: '0',
   arbitrumAddressBookPath: './arbitrum-addresses.json',

diff --git a/packages/contracts/scripts/coverage b/packages/contracts/scripts/coverage
@@ -4,7 +4,10 @@ set -eo pipefail
 
 yarn build
 
+echo {} > addresses-local.json
+
 DISABLE_SECURE_ACCOUNTS=true \
 L1_GRAPH_CONFIG=config/graph.hardhat.yml \
 L2_GRAPH_CONFIG=config/graph.arbitrum-hardhat.yml \
+ADDRESS_BOOK=addresses-local.json \
   npx hardhat coverage $@
diff --git a/packages/contracts/scripts/test b/packages/contracts/scripts/test
@@ -26,6 +26,9 @@ fi
 
 ### Main
 
+# Init address book
+echo {} > addresses-local.json
+
 mkdir -p reports
 
 # Run using the standalone evm instance

diff --git a/packages/contracts/test/gns.test.ts b/packages/contracts/test/gns.test.ts
@@ -37,6 +37,7 @@ import {
   loadContractAt,
 } from '@graphprotocol/sdk'
 import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'
+import { SubgraphNFT } from '../build/types'
 
 const { AddressZero, HashZero } = ethers.constants
 
@@ -45,7 +46,7 @@ const toFloat = (n: BigNumber) => parseFloat(formatGRT(n))
 const toRound = (n: number) => n.toFixed(12)
 
 describe('L1GNS', () => {
-  const graph = hre.graph()
+  const graph = hre.graph({ addressBook: 'addresses-local.json' })
 
   let me: SignerWithAddress
   let other: SignerWithAddress
@@ -65,6 +66,7 @@ describe('L1GNS', () => {
   let curation: Curation
   let controller: Controller
   let proxyAdmin: GraphProxyAdmin
+  let subgraphNFT: SubgraphNFT
   let l1GraphTokenGateway: L1GraphTokenGateway
   let arbitrumMocks: ArbitrumL1Mocks
 
@@ -244,6 +246,7 @@ describe('L1GNS', () => {
     controller = fixtureContracts.Controller as Controller
     proxyAdmin = fixtureContracts.GraphProxyAdmin as GraphProxyAdmin
     l1GraphTokenGateway = fixtureContracts.L1GraphTokenGateway as L1GraphTokenGateway
+    subgraphNFT = fixtureContracts.SubgraphNFT as SubgraphNFT
 
     newSubgraph0 = buildSubgraph()
     newSubgraph1 = buildSubgraph()
@@ -888,17 +891,17 @@ describe('L1GNS', () => {
 
   describe('NFT descriptor', function () {
     it('cannot be minted by an account that is not the minter (i.e. GNS)', async function () {
-      const tx = graph.contracts.SubgraphNFT.connect(me).mint(me.address, 1)
+      const tx = subgraphNFT.connect(me).mint(me.address, 1)
       await expect(tx).revertedWith('Must be a minter')
     })
     it('cannot be burned by an account that is not the minter (i.e. GNS)', async function () {
-      const tx = graph.contracts.SubgraphNFT.connect(me).burn(1)
+      const tx = subgraphNFT.connect(me).burn(1)
       await expect(tx).revertedWith('Must be a minter')
     })
     it('with token descriptor', async function () {
       const subgraph0 = await publishNewSubgraph(me, newSubgraph0, gns, graph.chainId)
 
-      const tokenURI = await graph.contracts.SubgraphNFT.connect(me).tokenURI(subgraph0.id)
+      const tokenURI = await subgraphNFT.connect(me).tokenURI(subgraph0.id)
 
       const sub = new SubgraphDeploymentID(newSubgraph0.subgraphMetadata)
       expect(sub.ipfsHash).eq(tokenURI)
@@ -907,8 +910,8 @@ describe('L1GNS', () => {
     it('with token descriptor and baseURI', async function () {
       const subgraph0 = await publishNewSubgraph(me, newSubgraph0, gns, graph.chainId)
 
-      await graph.contracts.SubgraphNFT.connect(governor).setBaseURI('ipfs://')
-      const tokenURI = await graph.contracts.SubgraphNFT.connect(me).tokenURI(subgraph0.id)
+      await subgraphNFT.connect(governor).setBaseURI('ipfs://')
+      const tokenURI = await subgraphNFT.connect(me).tokenURI(subgraph0.id)
 
       const sub = new SubgraphDeploymentID(newSubgraph0.subgraphMetadata)
       expect('ipfs://' + sub.ipfsHash).eq(tokenURI)
@@ -917,8 +920,8 @@ describe('L1GNS', () => {
     it('without token descriptor', async function () {
       const subgraph0 = await publishNewSubgraph(me, newSubgraph0, gns, graph.chainId)
 
-      await graph.contracts.SubgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
-      const tokenURI = await graph.contracts.SubgraphNFT.connect(me).tokenURI(subgraph0.id)
+      await subgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
+      const tokenURI = await subgraphNFT.connect(me).tokenURI(subgraph0.id)
 
       const sub = new SubgraphDeploymentID(newSubgraph0.subgraphMetadata)
       expect(sub.bytes32).eq(tokenURI)
@@ -927,9 +930,9 @@ describe('L1GNS', () => {
     it('without token descriptor and baseURI', async function () {
       const subgraph0 = await publishNewSubgraph(me, newSubgraph0, gns, graph.chainId)
 
-      await graph.contracts.SubgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
-      await graph.contracts.SubgraphNFT.connect(governor).setBaseURI('ipfs://')
-      const tokenURI = await graph.contracts.SubgraphNFT.connect(me).tokenURI(subgraph0.id)
+      await subgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
+      await subgraphNFT.connect(governor).setBaseURI('ipfs://')
+      const tokenURI = await subgraphNFT.connect(me).tokenURI(subgraph0.id)
 
       const sub = new SubgraphDeploymentID(newSubgraph0.subgraphMetadata)
       expect('ipfs://' + sub.bytes32).eq(tokenURI)
@@ -940,9 +943,9 @@ describe('L1GNS', () => {
       newSubgraphNoMetadata.subgraphMetadata = HashZero
       const subgraph0 = await publishNewSubgraph(me, newSubgraphNoMetadata, gns, graph.chainId)
 
-      await graph.contracts.SubgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
-      await graph.contracts.SubgraphNFT.connect(governor).setBaseURI('ipfs://')
-      const tokenURI = await graph.contracts.SubgraphNFT.connect(me).tokenURI(subgraph0.id)
+      await subgraphNFT.connect(governor).setTokenDescriptor(AddressZero)
+      await subgraphNFT.connect(governor).setBaseURI('ipfs://')
+      const tokenURI = await subgraphNFT.connect(me).tokenURI(subgraph0.id)
       expect('ipfs://' + subgraph0.id).eq(tokenURI)
     })
   })

diff --git a/packages/contracts/test/lib/fixtures.ts b/packages/contracts/test/lib/fixtures.ts
@@ -80,7 +80,7 @@ export class NetworkFixture {
 
     // Deploy contracts
     await deployGraphNetwork(
-      './addresses.json',
+      './addresses-local.json',
       l2Deploy ? './config/graph.arbitrum-hardhat.yml' : './config/graph.hardhat.yml',
       1337,
       deployer,
@@ -93,7 +93,7 @@ export class NetworkFixture {
     )
 
     const contracts = loadGraphNetworkContracts(
-      './addresses.json',
+      './addresses-local.json',
       1337,
       this.provider,
       undefined,

diff --git a/packages/contracts/test/staking/allocation.test.ts b/packages/contracts/test/staking/allocation.test.ts
@@ -79,7 +79,7 @@ const ABI_LIB_EXPONENTIAL = [
 ]
 
 describe('Staking:Allocation', () => {
-  const graph = hre.graph()
+  const graph = hre.graph({ addressBook: 'addresses-local.json' })
   let me: SignerWithAddress
   let governor: SignerWithAddress
   let indexer: SignerWithAddress

diff --git a/packages/contracts/test/staking/rebate.test.ts b/packages/contracts/test/staking/rebate.test.ts
@@ -103,7 +103,7 @@ export function exponentialRebates(
 }
 
 describe('Staking:rebates', () => {
-  const graph = hre.graph()
+  const graph = hre.graph({ addressBook: 'addresses-local.json' })
 
   let libExponential: LibExponential
   let fixture: NetworkFixture