feat: split e2e tests into config and init

tmigone · tmigone · commit 58830050f342 · 2022-07-26T14:39:38.000+02:00
Signed-off-by: Tomás Migone &lt;tomas@edgeandnode.com&gt;
diff --git a/README.md b/README.md
@@ -90,34 +90,58 @@ To test a single file run: `npx hardhat test test/<FILE_NAME>.ts`
 
 ## E2E Testing
 
-End to end tests are also available and can be run against a local network or a live network. These can be useful to validate a protocol deployment is configured and working as expected.
+End to end tests are also available and can be run against a local network or a live network. These can be useful to validate a protocol deployment is configured and working as expected. 
+
+There are several types of e2e tests which can be run separately:
+- **deployment/config**
+  - Test the configuration of deployed contracts (parameters that don't change over time).
+  - Can be run against any network at any time and the tests should pass.
+  - Only read only interactions with the blockchain.
+  - Example: a test validating the curation default reserve ratio matches the value in the graph config file.
+- **deployment/init** 
+  - Test the initialization of deployed contracts (parameters that change with protocol usage).
+  - Can be run against a "fresh" protocol deployment. Running these tests against a protocol with pre-existing state will probably fail.
+  - Only read only interactions with the blockchain.
+  - Example: a test validating that the GRT total supply equals 10B, this is only true on a freshly deployed protocol until the first allocation is closed and protocol issuance kicks in.
+- **scenarios**
+  - Test the execution of common protocol actions.
+  - Can be run against any network at any time and the tests should pass.
+  - Read and write interactions with the blockchain. _Requires an account with sufficient balance!_
+  - Example: a test validating that a user can add signal to a subgraph.
 
 ### Hardhat local node
 
-To run e2e tests against a hardhat local node run:
+To run all e2e tests against a hardhat local node run:
 
 ```bash
 yarn test:e2e
 ```
 
-The command will invoke several hardhat tasks, including:
+The command will perform the following actions:
 
 - Start a hardhat node (localhost)
 - Run `migrate:accounts` hardhat task to create keys for all protocol roles (deployer, governor, arbiter, etc). This currently doesn't support multisig accounts.
 - Run `migrate` hardhat task to deploy the protocol
 - Run `migrate:ownership` hardhat task to transfer ownership of governed contracts to the governor
 - Run `migrate:unpause` to unpause the protocol
-- Run e2e tests
+- Run `e2e` hardhat task to run all e2e tests
 
 ### Other networks
 
 To run tests against a live testnet or even mainnet run:
 
 ```bash
-GRAPH_CONFIG=config/graph.<network>.yml ADDRESS_BOOK=addresses.json npx hardhat test e2e/**/*.ts --network <network>
+# All e2e tests
+npx hardhat e2e --network <network> --graph-config config/graph.<network>.yml
+
+# Only deployment config tests
+npx hardhat e2e:config --network <network> --graph-config config/graph.<network>.yml
+
+# Only deployment init tests
+npx hardhat e2e:init --network <network> --graph-config config/graph.<network>.yml
 ```
 
-This command will only run the tests so you need to be sure the protocol is already deployed and the graph config file and address book files are up to date.
+Note that this command will only run the tests so you need to be sure the protocol is already deployed and the graph config file and address book files are up to date.
 
 # Interacting with the contracts
 
diff --git a/e2e/deployment/config/allocationExchange.test.ts b/e2e/deployment/config/allocationExchange.test.ts
@@ -1,11 +1,11 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('AllocationExchange deployment', () => {
+describe('AllocationExchange configuration', () => {
   const {
     graphConfig,
-    contracts: { AllocationExchange, GraphToken, Staking },
+    contracts: { AllocationExchange },
   } = hre.graph()
 
   it('should be owned by allocationExchangeOwner', async function () {
@@ -23,9 +23,4 @@ describe('AllocationExchange deployment', () => {
   // graphToken and staking are private variables so we can't verify
   it.skip('graphToken should match the GraphToken deployment address')
   it.skip('staking should match the Staking deployment address')
-
-  it('should allow Staking contract to spend MAX_UINT256 tokens on AllocationExchange behalf', async function () {
-    const allowance = await GraphToken.allowance(AllocationExchange.address, Staking.address)
-    expect(allowance).eq(hre.ethers.constants.MaxUint256)
-  })
 })
diff --git a/e2e/deployment/config/controller.test.ts b/e2e/deployment/config/controller.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre, { ethers } from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('Controller deployment', () => {
+describe('Controller configuration', () => {
   const { contracts, graphConfig } = hre.graph()
   const { Controller } = contracts
 
diff --git a/e2e/deployment/config/curation.test.ts b/e2e/deployment/config/curation.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('Curation deployment', () => {
+describe('Curation configuration', () => {
   const {
     graphConfig,
     contracts: { Controller, Curation, BancorFormula, GraphCurationToken },
diff --git a/e2e/deployment/config/disputeManager.test.ts b/e2e/deployment/config/disputeManager.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('DisputeManager deployment', () => {
+describe('DisputeManager configuration', () => {
   const {
     graphConfig,
     contracts: { Controller, DisputeManager },
diff --git a/e2e/deployment/config/epochManager.test.ts b/e2e/deployment/config/epochManager.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('EpochManager deployment', () => {
+describe('EpochManager configuration', () => {
   const {
     graphConfig,
     contracts: { EpochManager, Controller },
diff --git a/e2e/deployment/config/gns.test.ts b/e2e/deployment/config/gns.test.ts
@@ -1,9 +1,9 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
 
-describe('GNS deployment', () => {
+describe('GNS configuration', () => {
   const {
-    contracts: { Controller, GNS, BancorFormula, SubgraphNFT, GraphToken, Curation },
+    contracts: { Controller, GNS, BancorFormula, SubgraphNFT },
   } = hre.graph()
 
   it('should be controlled by Controller', async function () {
@@ -20,9 +20,4 @@ describe('GNS deployment', () => {
     const subgraphNFT = await GNS.subgraphNFT()
     expect(subgraphNFT).eq(SubgraphNFT.address)
   })
-
-  it('should allow Curation contract to spend MAX_UINT256 tokens on GNS behalf', async function () {
-    const allowance = await GraphToken.allowance(GNS.address, Curation.address)
-    expect(allowance).eq(hre.ethers.constants.MaxUint256)
-  })
 })
diff --git a/e2e/deployment/config/graphProxyAdmin.test.ts b/e2e/deployment/config/graphProxyAdmin.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('GraphProxyAdmin deployment', () => {
+describe('GraphProxyAdmin configuration', () => {
   const {
     contracts: { GraphProxyAdmin },
     graphConfig,
diff --git a/e2e/deployment/config/graphToken.test.ts b/e2e/deployment/config/graphToken.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('GraphToken deployment', () => {
+describe('GraphToken configuration', () => {
   const {
     graphConfig,
     contracts: { GraphToken, RewardsManager },
@@ -25,10 +25,4 @@ describe('GraphToken deployment', () => {
     const deployerIsMinter = await GraphToken.isMinter(RewardsManager.address)
     expect(deployerIsMinter).eq(true)
   })
-
-  it('total supply should match "initialSupply" on the config file', async function () {
-    const value = await GraphToken.totalSupply()
-    const expected = getItemValue(graphConfig, 'contracts/GraphToken/init/initialSupply')
-    hre.network.config.chainId === 1337 ? expect(value).eq(expected) : expect(value).gte(expected)
-  })
 })
diff --git a/e2e/deployment/config/protocol.test.ts b/e2e/deployment/config/protocol.test.ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
 
-describe('Protocol', () => {
+describe('Protocol configuration', () => {
   const { contracts } = hre.graph()
 
   it('should be unpaused', async function () {
diff --git a/e2e/deployment/config/rewardsManager.test.ts b/e2e/deployment/config/rewardsManager.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('RewardsManager deployment', () => {
+describe('RewardsManager configuration', () => {
   const {
     graphConfig,
     contracts: { RewardsManager, Controller },
diff --git a/e2e/deployment/config/serviceRegistry.test..ts b/e2e/deployment/config/serviceRegistry.test..ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
 
-describe('ServiceRegistry deployment', () => {
+describe('ServiceRegistry configuration', () => {
   const {
     contracts: { ServiceRegistry, Controller },
   } = hre.graph()
diff --git a/e2e/deployment/config/staking.test.ts b/e2e/deployment/config/staking.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('Staking deployment', () => {
+describe('Staking configuration', () => {
   const {
     graphConfig,
     contracts: { Staking, Controller, DisputeManager, AllocationExchange },
diff --git a/e2e/deployment/config/subgraphNFT.test.ts b/e2e/deployment/config/subgraphNFT.test.ts
@@ -1,8 +1,8 @@
 import { expect } from 'chai'
 import hre from 'hardhat'
-import { getItemValue } from '../../cli/config'
+import { getItemValue } from '../../../cli/config'
 
-describe('SubgraphNFT deployment', () => {
+describe('SubgraphNFT configuration', () => {
   const {
     graphConfig,
     contracts: { SubgraphNFT, GNS, SubgraphNFTDescriptor },
diff --git a/e2e/deployment/init/allocationExchange.test.ts b/e2e/deployment/init/allocationExchange.test.ts
@@ -0,0 +1,13 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+
+describe('AllocationExchange initialization', () => {
+  const {
+    contracts: { AllocationExchange, GraphToken, Staking },
+  } = hre.graph()
+
+  it('should allow Staking contract to spend MAX_UINT256 tokens on AllocationExchange behalf', async function () {
+    const allowance = await GraphToken.allowance(AllocationExchange.address, Staking.address)
+    expect(allowance).eq(hre.ethers.constants.MaxUint256)
+  })
+})
diff --git a/e2e/deployment/init/gns.test.ts b/e2e/deployment/init/gns.test.ts
@@ -0,0 +1,13 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+
+describe('GNS initialization', () => {
+  const {
+    contracts: { GNS, GraphToken, Curation },
+  } = hre.graph()
+
+  it('should allow Curation contract to spend MAX_UINT256 tokens on GNS behalf', async function () {
+    const allowance = await GraphToken.allowance(GNS.address, Curation.address)
+    expect(allowance).eq(hre.ethers.constants.MaxUint256)
+  })
+})
diff --git a/e2e/deployment/init/graphToken.test.ts b/e2e/deployment/init/graphToken.test.ts
@@ -0,0 +1,16 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+import { getItemValue } from '../../../cli/config'
+
+describe('GraphToken initialization', () => {
+  const {
+    graphConfig,
+    contracts: { GraphToken },
+  } = hre.graph()
+
+  it('total supply should match "initialSupply" on the config file', async function () {
+    const value = await GraphToken.totalSupply()
+    const expected = getItemValue(graphConfig, 'contracts/GraphToken/init/initialSupply')
+    hre.network.config.chainId === 1337 ? expect(value).eq(expected) : expect(value).gte(expected)
+  })
+})
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -28,7 +28,7 @@ const SKIP_LOAD = process.env.SKIP_LOAD === 'true'
 
 function loadTasks() {
   require('./tasks/gre.ts')
-  ;['contracts', 'misc', 'deployment', 'actions', 'verify'].forEach((folder) => {
+  ;['contracts', 'misc', 'deployment', 'actions', 'verify', 'e2e'].forEach((folder) => {
     const tasksPath = path.join(__dirname, 'tasks', folder)
     fs.readdirSync(tasksPath)
       .filter((pth) => pth.includes('.ts'))
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "@typechain/hardhat": "^2.0.0",
     "@types/bs58": "^4.0.1",
     "@types/dotenv": "^8.2.0",
+    "@types/glob": "^7.2.0",
     "@types/inquirer": "^7.3.1",
     "@types/minimist": "^1.2.1",
     "@types/mocha": "^8.2.2",
@@ -49,6 +50,7 @@
     "eslint-plugin-prettier": "^3.4.0",
     "ethereum-waffle": "^3.3.0",
     "form-data": "^4.0.0",
+    "glob": "^8.0.3",
     "graphql-tag": "^2.12.4",
     "hardhat": "^2.9.5",
     "hardhat-abi-exporter": "^2.2.0",
diff --git a/scripts/e2e b/scripts/e2e
@@ -24,7 +24,7 @@ npx hardhat migrate:unpause --network localhost
 
 ### Test
 # Run tests using the localhost evm instance and the localhost graph config
-GRAPH_CONFIG='config/graph.localhost.yml' npx hardhat test e2e/**/*.ts --network localhost
+npx hardhat e2e --network localhost --graph-config config/graph.localhost.yml
 
 
 ### Cleanup
diff --git a/tasks/e2e/e2e.ts b/tasks/e2e/e2e.ts
@@ -0,0 +1,48 @@
+import { task } from 'hardhat/config'
+import { HardhatRuntimeEnvironment, TaskArguments } from 'hardhat/types'
+import { TASK_TEST } from 'hardhat/builtin-tasks/task-names'
+import glob from 'glob'
+import { cliOpts } from '../../cli/defaults'
+
+const CONFIG_TESTS = 'e2e/deployment/config/*.test.ts'
+const INIT_TESTS = 'e2e/deployment/init/*.test.ts'
+
+// Built-in test task doesn't support our arguments
+// we can pass them to GRE via env vars
+const setGraphEnvVars = async (args: TaskArguments) => {
+  process.env.GRAPH_CONFIG = args.graphConfig
+  process.env.ADDRESS_BOOK = args.addressBook
+}
+
+task('e2e', 'Run all e2e tests')
+  .addParam('graphConfig', cliOpts.graphConfig.description, cliOpts.graphConfig.default)
+  .addParam('addressBook', cliOpts.addressBook.description, cliOpts.addressBook.default)
+  .setAction(async (args, hre: HardhatRuntimeEnvironment) => {
+    const files = [...new glob.GlobSync(CONFIG_TESTS).found, ...new glob.GlobSync(INIT_TESTS).found]
+    setGraphEnvVars(args)
+    await hre.run(TASK_TEST, {
+      testFiles: files,
+    })
+  })
+
+task('e2e:config', 'Run deployment configuration e2e tests')
+  .addParam('graphConfig', cliOpts.graphConfig.description, cliOpts.graphConfig.default)
+  .addParam('addressBook', cliOpts.addressBook.description, cliOpts.addressBook.default)
+  .setAction(async (args, hre: HardhatRuntimeEnvironment) => {
+    const files = new glob.GlobSync(CONFIG_TESTS).found
+    setGraphEnvVars(args)
+    await hre.run(TASK_TEST, {
+      testFiles: files,
+    })
+  })
+
+task('e2e:init', 'Run deployment initialization e2e tests')
+  .addParam('graphConfig', cliOpts.graphConfig.description, cliOpts.graphConfig.default)
+  .addParam('addressBook', cliOpts.addressBook.description, cliOpts.addressBook.default)
+  .setAction(async (args, hre: HardhatRuntimeEnvironment) => {
+    const files = new glob.GlobSync(INIT_TESTS).found
+    setGraphEnvVars(args)
+    await hre.run(TASK_TEST, {
+      testFiles: files,
+    })
+  })
diff --git a/yarn.lock b/yarn.lock
