From 1807c3eb99dc29a816814ecdf9d3a9dcff63bc5c Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Tue, 21 Sep 2021 17:05:51 +0530 Subject: [PATCH 1/9] show hh logs for EVM revert --- libs/remix-tests/src/testRunner.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/libs/remix-tests/src/testRunner.ts b/libs/remix-tests/src/testRunner.ts index dca4a5f748..c3b59480d0 100644 --- a/libs/remix-tests/src/testRunner.ts +++ b/libs/remix-tests/src/testRunner.ts @@ -232,6 +232,7 @@ export function runTest (testName: string, testObject: any, contractDetails: Com testCallback(undefined, resp) async.eachOfLimit(runList, 1, function (func, index, next) { let sender: string | null = null + let hhLogs if (func.signature) { sender = getOverridedSender(contractDetails.userdoc, func.signature, contractDetails.evm.methodIdentifiers) if (opts.accounts && sender) { @@ -293,7 +294,6 @@ export function runTest (testName: string, testObject: any, contractDetails: Com sendParams.gas = 10000000 * 8 method.send(sendParams).on('receipt', async (receipt) => { try { - let hhLogs if (web3.eth && web3.eth.getHHLogsForTx) hhLogs = await web3.eth.getHHLogsForTx(receipt.transactionHash) const time: number = (Date.now() - startTime) / 1000.0 const assertionEventHashes = assertionEvents.map(e => Web3.utils.sha3(e.name + '(' + e.params.join() + ')')) @@ -366,7 +366,7 @@ export function runTest (testName: string, testObject: any, contractDetails: Com console.error(err) return next(err) } - }).on('error', function (err: Error) { + }).on('error', async (err: Error) => { const time: number = (Date.now() - startTime) / 1000.0 const resp: TestResultInterface = { type: 'testFailure', @@ -377,6 +377,11 @@ export function runTest (testName: string, testObject: any, contractDetails: Com context: testName, web3 } + if (err.message.includes('Transaction has been reverted by the EVM')) { + const txHash = JSON.parse(err.message.replace('Transaction has been reverted by the EVM:', '')).transactionHash + if (web3.eth && web3.eth.getHHLogsForTx) hhLogs = await web3.eth.getHHLogsForTx(txHash) + if (hhLogs) resp.hhLogs = hhLogs + } testCallback(undefined, resp) failureNum += 1 timePassed += time From bebbb8d01a2c0d1a1ba243d4c7480ec335fce5ff Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Wed, 22 Sep 2021 00:03:02 +0530 Subject: [PATCH 2/9] e2e tests added --- .../src/tests/solidityUnittests.spec.ts | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts index 326b88b020..84061517fa 100644 --- a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts +++ b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts @@ -207,6 +207,23 @@ module.exports = { .removeFile('tests/hhLogs_test.sol', 'workspace_new') }, + 'Solidity Unit tests with hardhat console log for EVM revert': function (browser: NightwatchBrowser) { + browser + .waitForElementPresent('*[data-id="verticalIconsKindfilePanel"]') + .addFile('tests/ballotFailedLog_test.sol', sources[0]['tests/ballotFailedLog_test.sol']) + .clickLaunchIcon('solidityUnitTesting') + .waitForElementVisible('*[id="singleTesttests/4_Ballot_test.sol"]', 60000) + .click('*[id="singleTesttests/4_Ballot_test.sol"]') + .click('#runTestsTabRunAction') + .pause(2000) + .waitForElementVisible('*[data-id="testTabSolidityUnitTestsOutputheader"]', 120000) + .waitForElementContainsText('#solidityUnittestsOutput', 'tests/ballotFailedLog_test.sol', 60000) + .assert.containsText('#journal > div:nth-child(6) > span > div', 'Check winning proposal:') + .assert.containsText('#journal > div:nth-child(6) > span > div', 'Inside checkWinningProposal') + .openFile('tests/ballotFailedLog_test.sol') + .removeFile('tests/ballotFailedLog_test.sol', 'workspace_new') + }, + 'Debug failed test using debugger': function (browser: NightwatchBrowser) { browser .waitForElementPresent('*[data-id="verticalIconsKindfilePanel"]') @@ -483,6 +500,31 @@ const sources = [ } }` }, + 'tests/ballotFailedLog_test.sol': { + content: `// SPDX-License-Identifier: GPL-3.0 + + pragma solidity >=0.7.0 <0.9.0; + import "remix_tests.sol"; // this import is automatically injected by Remix. + import "../contracts/3_Ballot.sol"; + + import "hardhat/console.sol"; + + contract BallotTest { + + bytes32[] proposalNames; + + Ballot ballotToTest; + function beforeAll () public { + proposalNames.push(bytes32("candidate1")); + ballotToTest = new Ballot(proposalNames); + } + + function checkWinningProposal () public { + console.log("Inside checkWinningProposal"); + ballotToTest.vote(1); // This will revert the transaction + } + }` + }, 'tests/hhLogs_test.sol': { content: `// SPDX-License-Identifier: GPL-3.0 From 5f8640e440768e8e0afe699737275ad67e1862f9 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Wed, 22 Sep 2021 16:08:57 +0530 Subject: [PATCH 3/9] type for error passed --- apps/remix-ide/src/app/tabs/test-tab.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/remix-ide/src/app/tabs/test-tab.js b/apps/remix-ide/src/app/tabs/test-tab.js index afa3d1bc1c..559d5428ca 100644 --- a/apps/remix-ide/src/app/tabs/test-tab.js +++ b/apps/remix-ide/src/app/tabs/test-tab.js @@ -380,9 +380,9 @@ module.exports = class TestTab extends ViewPlugin { this.setHeader(false) } if (_errors && _errors.errors) { - _errors.errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity })) + _errors.errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity, errorType: err.type})) } else if (_errors && Array.isArray(_errors) && (_errors[0].message || _errors[0].formattedMessage)) { - _errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity })) + _errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity, errorType: err.type })) } else if (_errors && !_errors.errors && !Array.isArray(_errors)) { // To track error like this: https://github.com/ethereum/remix/pull/1438 this.renderer.error(_errors.formattedMessage || _errors.message, this.testsOutput, { type: 'error' }) From dd271ec4847da921318f5e2a3efd537eb82a9cba Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Wed, 22 Sep 2021 16:21:34 +0530 Subject: [PATCH 4/9] linting fix --- apps/remix-ide/src/app/tabs/test-tab.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/remix-ide/src/app/tabs/test-tab.js b/apps/remix-ide/src/app/tabs/test-tab.js index 559d5428ca..a316756c4f 100644 --- a/apps/remix-ide/src/app/tabs/test-tab.js +++ b/apps/remix-ide/src/app/tabs/test-tab.js @@ -380,7 +380,7 @@ module.exports = class TestTab extends ViewPlugin { this.setHeader(false) } if (_errors && _errors.errors) { - _errors.errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity, errorType: err.type})) + _errors.errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity, errorType: err.type })) } else if (_errors && Array.isArray(_errors) && (_errors[0].message || _errors[0].formattedMessage)) { _errors.forEach((err) => this.renderer.error(err.formattedMessage || err.message, this.testsOutput, { type: err.severity, errorType: err.type })) } else if (_errors && !_errors.errors && !Array.isArray(_errors)) { From df34c5a446a1daaaee2c45b54ae44465adbbde17 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Wed, 22 Sep 2021 17:17:57 +0530 Subject: [PATCH 5/9] error disappearing fixed --- apps/remix-ide/src/app/tabs/test-tab.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/apps/remix-ide/src/app/tabs/test-tab.js b/apps/remix-ide/src/app/tabs/test-tab.js index a316756c4f..277abab11d 100644 --- a/apps/remix-ide/src/app/tabs/test-tab.js +++ b/apps/remix-ide/src/app/tabs/test-tab.js @@ -44,6 +44,7 @@ module.exports = class TestTab extends ViewPlugin { this.offsetToLineColumnConverter = offsetToLineColumnConverter this.allFilesInvolved = [] this.isDebugging = false + this.currentErrors = [] appManager.event.on('activate', (name) => { if (name === 'solidity') this.updateRunAction() @@ -117,6 +118,14 @@ module.exports = class TestTab extends ViewPlugin { } async updateForNewCurrent (file) { + // Ensure that when someone clicks on compilation error and that opens a new file + // Test result, which is compilation error in this case, is not cleared + if (this.currentErrors) { + if (Array.isArray(this.currentErrors) && this.currentErrors.length > 0) { + const errFiles = this.currentErrors.map(err => { if (err.sourceLocation && err.sourceLocation.file) return err.sourceLocation.file }) + if (errFiles.includes(file)) return + } else if (this.currentErrors.sourceLocation && this.currentErrors.sourceLocation.file && this.currentErrors.sourceLocation.file === file) return + } // if current file is changed while debugging and one of the files imported in test file are opened // do not clear the test results in SUT plugin if (this.isDebugging && this.allFilesInvolved.includes(file)) return @@ -377,6 +386,7 @@ module.exports = class TestTab extends ViewPlugin { this.testsOutput.hidden = false if (!result && (_errors && (_errors.errors || (Array.isArray(_errors) && (_errors[0].message || _errors[0].formattedMessage))))) { this.testCallback({ type: 'contract', filename }) + this.currentErrors = _errors.errors this.setHeader(false) } if (_errors && _errors.errors) { From 37cbff80804ba966a2e28b489795a26c4600586c Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Thu, 23 Sep 2021 14:06:47 +0530 Subject: [PATCH 6/9] e2e tests update for failed compilation --- .../src/tests/solidityUnittests.spec.ts | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts index 84061517fa..09788a88e1 100644 --- a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts +++ b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts @@ -93,8 +93,7 @@ module.exports = { 'Should fail on compilation': function (browser: NightwatchBrowser) { browser.waitForElementPresent('*[data-id="verticalIconsKindfilePanel"]') .addFile('tests/compilationError_test.sol', sources[0]['compilationError_test.sol']) - .clickLaunchIcon('filePanel') - .openFile('tests/compilationError_test.sol') + .click('div[title="default_workspace/tests/compilationError_test.sol"] span[class="close"]') .clickLaunchIcon('solidityUnitTesting') .pause(2000) .click('*[data-id="testTabCheckAllTests"]') @@ -102,6 +101,17 @@ module.exports = { .scrollAndClick('*[data-id="testTabRunTestsTabRunAction"]') .waitForElementContainsText('*[data-id="testTabSolidityUnitTestsOutput"]', 'SyntaxError: No visibility specified', 120000) .waitForElementContainsText('*[data-id="testTabTestsExecutionStoppedError"]', 'The test execution has been stopped because of error(s) in your test file', 120000) + .click('*[data-id="tests/compilationError_test.sol"]') + .getEditorValue((content) => { + browser.assert.ok(content.indexOf(` + contract failOnCompilation { + fallback() { + + } + }`) !== -1, + 'current displayed content is not from the compilationError_test source code') + }) + .pause(20000) }, 'Should fail on deploy': function (browser: NightwatchBrowser) { From 727315fae50d5b3e459fcd8fb34241d24c21c7a1 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Thu, 23 Sep 2021 14:46:15 +0530 Subject: [PATCH 7/9] final e2e tests for compilation error check --- .../src/tests/solidityUnittests.spec.ts | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts index 09788a88e1..7c5e9322aa 100644 --- a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts +++ b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts @@ -90,7 +90,7 @@ module.exports = { .waitForElementContainsText('*[data-id="testTabTestsExecutionStopped"]', 'The test execution has been stopped', 60000) }, - 'Should fail on compilation': function (browser: NightwatchBrowser) { + 'Should fail on compilation, open file on error click, not disappear error': function (browser: NightwatchBrowser) { browser.waitForElementPresent('*[data-id="verticalIconsKindfilePanel"]') .addFile('tests/compilationError_test.sol', sources[0]['compilationError_test.sol']) .click('div[title="default_workspace/tests/compilationError_test.sol"] span[class="close"]') @@ -102,16 +102,9 @@ module.exports = { .waitForElementContainsText('*[data-id="testTabSolidityUnitTestsOutput"]', 'SyntaxError: No visibility specified', 120000) .waitForElementContainsText('*[data-id="testTabTestsExecutionStoppedError"]', 'The test execution has been stopped because of error(s) in your test file', 120000) .click('*[data-id="tests/compilationError_test.sol"]') - .getEditorValue((content) => { - browser.assert.ok(content.indexOf(` - contract failOnCompilation { - fallback() { - - } - }`) !== -1, - 'current displayed content is not from the compilationError_test source code') - }) - .pause(20000) + .pause(1000) + .getEditorValue((content) => browser.assert.ok(content.indexOf(`contract failOnCompilation {`) !== -1)) + .verify.elementPresent('*[data-id="tests/compilationError_test.sol"]') }, 'Should fail on deploy': function (browser: NightwatchBrowser) { @@ -451,7 +444,7 @@ const sources = [ }, 'compilationError_test.sol': { content: ` - pragma solidity ^0.7.0; + pragma solidity ^0.8.0; contract failOnCompilation { fallback() { From 68c1e709e774a68435ca473657245916d0a1f311 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Thu, 23 Sep 2021 15:20:50 +0530 Subject: [PATCH 8/9] linting fix --- apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts index 7c5e9322aa..59f8b8d050 100644 --- a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts +++ b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts @@ -103,7 +103,7 @@ module.exports = { .waitForElementContainsText('*[data-id="testTabTestsExecutionStoppedError"]', 'The test execution has been stopped because of error(s) in your test file', 120000) .click('*[data-id="tests/compilationError_test.sol"]') .pause(1000) - .getEditorValue((content) => browser.assert.ok(content.indexOf(`contract failOnCompilation {`) !== -1)) + .getEditorValue((content) => browser.assert.ok(content.indexOf('contract failOnCompilation {') !== -1)) .verify.elementPresent('*[data-id="tests/compilationError_test.sol"]') }, From ef17ba298162b63a18984b8b936e8edd9936cd50 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Fri, 24 Sep 2021 00:19:14 +0530 Subject: [PATCH 9/9] comment added --- apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts index 59f8b8d050..da986f4898 100644 --- a/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts +++ b/apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts @@ -104,6 +104,8 @@ module.exports = { .click('*[data-id="tests/compilationError_test.sol"]') .pause(1000) .getEditorValue((content) => browser.assert.ok(content.indexOf('contract failOnCompilation {') !== -1)) + // Verify that compilation error is still present after a file is opened + // usually, tests result is cleared on opening a new file .verify.elementPresent('*[data-id="tests/compilationError_test.sol"]') },