Introduces fast forwarding in L2 integration tests (#1343)

* Basic fast forwarding in L2 integration tests

* Replaced 'ignore' utils with fast forwarding in integration tests

* Clean install

* Undo changes to package lock file

* Pin ops version

* Avoid redundant heartbeats

* Fix and improve integration tests

* Add comment to test

* Update ops image

* Clear ops cache in CI

* Update watchers dep

* Hotfix for Optimism watchers

* Clean install

* Update to hardhat 2.3.x

* Clear ops tool cache

* Unpin ops

* Update ops cache

* Attach ops output

* Debugging Optimism messenger watchers

* Listen to interactions with messenger on blocks

* Keep withdraw tests open

* Implementing a completely patched ops watcher

* Tidy ups

* remove only in tests

* Disabled ops cache

* Restored ops caching

* Quiet

* Bugfix

* Debug optimism in l2 standalone integration tests

* Cleanups

Author: eternauta1337

.circleci/config.yml

@@ -55,22 +55,22 @@ jobs:
           at: .
       - restore_cache:
           keys:
-            - optimism-build
+            - v2-optimism-build-
       - run:
           name: Build docker containers if necessary
           command: |
             if [ ! -d ./optimism ]; then
-              npx hardhat ops --fresh --build --build-ops --optimism-path ./optimism
+              npx hardhat ops --fresh --build --build-ops
             fi;
       - save_cache:
-          key: optimism-build
+          key: v2-optimism-build-
           paths:
             - ./optimism
       - run:
           name: Start docker chains
           background: true
           command: |
-            npx hardhat ops --start --optimism-path ./optimism
+            npx hardhat ops --start
       - cmd-wait-for-port:
           port: 8545
       - cmd-wait-for-port:

.circleci/src/jobs/job-integration-tests.yml

@@ -7,22 +7,22 @@ steps:
       at: .
   - restore_cache:
       keys:
-        - optimism-build
+        - v2-optimism-build-{{ checksum "package-lock.json" }}
   - run:
       name: Build docker containers if necessary
       command: |
         if [ ! -d ./optimism ]; then
-          npx hardhat ops --fresh --build --build-ops --optimism-path ./optimism
+          npx hardhat ops --fresh --build --build-ops
         fi;
   - save_cache:
-      key: optimism-build
+      key: v2-optimism-build-{{ checksum "package-lock.json" }}
       paths:
         - ./optimism
   - run:
       name: Start docker chains
       background: true
       command: |
-        npx hardhat ops --start --optimism-path ./optimism
+        npx hardhat ops --start
   - cmd-wait-for-port:
       port: 8545
   - cmd-wait-for-port:

.gitignore

@@ -40,3 +40,5 @@ process.yml
 *.csv
 
 .db
+
+optimism

hardhat/tasks/task-ops.js

@@ -20,17 +20,23 @@ task('ops', 'Run Optimism chain')
 	.addFlag('start', 'Start the latest build')
 	.addFlag('stop', 'Stop optimism chain')
 	.addFlag('detached', 'Detach the chain from the console')
-	.addOptionalParam('optimismPath', 'Path to optmism repository folder', '~/optimism')
+	.addOptionalParam('optimismPath', 'Path to optmism repository folder', './optimism')
+	.addOptionalParam('optimismBranch', 'Branch to checkout', 'master')
 	.addOptionalParam(
 		'optimismCommit',
 		'Commit to checkout',
-		undefined // Define here to pin to that specific commit
+		'd9fd67d2502a590e116ffdb6c1c53003a045e318'
 	)
 	.setAction(async (taskArguments, hre, runSuper) => {
+		taskArguments.maxMemory = true;
+
 		const opsPath = taskArguments.optimismPath.replace('~', homedir);
+		const opsBranch = 'regenesis/0.4.0';
 		const opsCommit = taskArguments.optimismCommit;
 		const opsDetached = taskArguments.detached ? '-d' : '';
 
+		console.log(gray('optimism branch:', opsBranch));
+		console.log(gray('optimism commit:', opsCommit));
 		console.log(gray('optimism folder:', opsPath));
 
 		if (taskArguments.stop) {
@@ -55,14 +61,14 @@ task('ops', 'Run Optimism chain')
 				_fresh({ opsPath });
 			}
 
-			_build({ opsPath, opsCommit });
+			_build({ opsPath, opsCommit, opsBranch });
 		}
 
 		if (taskArguments.buildOps || (taskArguments.fresh && taskArguments.start)) {
 			console.log(yellow('building ops'));
 			if (!fs.existsSync(opsPath)) {
 				_fresh({ opsPath });
-				_build({ opsPath, opsCommit });
+				_build({ opsPath, opsCommit, opsBranch });
 			}
 			_buildOps({ opsPath });
 		}
@@ -76,10 +82,10 @@ task('ops', 'Run Optimism chain')
 
 			if (!fs.existsSync(opsPath)) {
 				_fresh({ opsPath });
-				_build({ opsPath, opsCommit });
+				_build({ opsPath, opsCommit, opsBranch });
 				_buildOps({ opsPath });
 			} else if (!_imagesExist()) {
-				_build({ opsPath, opsCommit });
+				_build({ opsPath, opsCommit, opsBranch });
 				_buildOps({ opsPath });
 			}
 			await _start({ opsPath, opsDetached });
@@ -135,11 +141,11 @@ function _fresh({ opsPath }) {
 	]);
 }
 
-function _build({ opsPath, opsCommit }) {
+function _build({ opsPath, opsCommit, opsBranch }) {
 	console.log(gray('  checkout commit:', opsCommit));
 	execa.sync('sh', ['-c', `cd ${opsPath} && git fetch `]);
-	execa.sync('sh', ['-c', `cd ${opsPath} && git checkout master `]);
-	execa.sync('sh', ['-c', `cd ${opsPath} && git pull origin master `]);
+	execa.sync('sh', ['-c', `cd ${opsPath} && git checkout ${opsBranch} `]);
+	execa.sync('sh', ['-c', `cd ${opsPath} && git pull origin ${opsBranch} `]);
 	if (opsCommit) {
 		execa.sync('sh', ['-c', `cd ${opsPath} && git checkout ${opsCommit}`]);
 	}

hardhat/tasks/task-test-integration.js

@@ -54,15 +54,18 @@ task('test:integration:l1', 'run isolated layer 1 production tests')
 	});
 
 task('test:integration:l2', 'run isolated layer 2 production tests')
+	.addFlag('debugOptimism', 'Debug Optimism activity')
 	.addFlag('compile', 'Compile an l2 instance before running the tests')
 	.addFlag('deploy', 'Deploy an l2 instance before running the tests')
 	.setAction(async (taskArguments, hre) => {
 		hre.config.paths.tests = './test/integration/l2/';
+		hre.config.debugOptimism = taskArguments.debugOptimism;
 
 		_commonIntegrationTestSettings({ hre, taskArguments });
 
 		const providerUrl = (hre.config.providerUrl = 'http://localhost');
-		const providerPort = (hre.config.providerPort = '8545');
+		hre.config.providerPortL1 = '9545';
+		const providerPortL2 = (hre.config.providerPortL2 = '8545');
 		const useOvm = true;
 		const buildPath = path.join(__dirname, '..', '..', `${BUILD_FOLDER}-ovm`);
 
@@ -74,7 +77,7 @@ task('test:integration:l2', 'run isolated layer 2 production tests')
 			await deployInstance({
 				useOvm,
 				providerUrl,
-				providerPort,
+				providerPort: providerPortL2,
 				buildPath,
 			});
 		}
@@ -83,10 +86,12 @@ task('test:integration:l2', 'run isolated layer 2 production tests')
 	});
 
 task('test:integration:dual', 'run integrated layer 1 and layer 2 production tests')
+	.addFlag('debugOptimism', 'Debug Optimism activity')
 	.addFlag('compile', 'Compile the l1 instance before running the tests')
 	.addFlag('deploy', 'Deploy the l1 instance before running the tests')
 	.setAction(async (taskArguments, hre) => {
 		hre.config.paths.tests = './test/integration/dual/';
+		hre.config.debugOptimism = taskArguments.debugOptimism;
 
 		_commonIntegrationTestSettings({ hre, taskArguments });
 
@@ -117,7 +122,12 @@ task('test:integration:dual', 'run integrated layer 1 and layer 2 production tes
 			});
 		}
 
-		await connectInstances({ providerUrl, providerPortL1, providerPortL2 });
+		await connectInstances({
+			providerUrl,
+			providerPortL1,
+			providerPortL2,
+			quiet: !taskArguments.debugOptimism,
+		});
 
 		await hre.run('test', taskArguments);
 	});