Merge branch 'master' into remixd_terminal

apps/debugger/src/app/debugger-api.ts

@@ -4,6 +4,9 @@ import { CompilationOutput, Sources } from '@remix-ui/debugger-ui'
 import type { CompilationResult } from '@remix-project/remix-solidity-ts'
 
 export const DebuggerApiMixin = (Base) => class extends Base {
+
+  initialWeb3
+
   initDebuggerApi () {
     this.debugHash = null
         
@@ -16,6 +19,8 @@ export const DebuggerApiMixin = (Base) => class extends Base {
       }
     }
     this._web3 = new Web3(this.web3Provider)
+    // this._web3 can be overwritten and reset to initial value in 'debug' method
+    this.initialWeb3 = this._web3
     remixDebug.init.extendWeb3(this._web3)
 
     this.offsetToLineColumnConverter = {
@@ -123,7 +128,9 @@ export const DebuggerApiMixin = (Base) => class extends Base {
 
   debug (hash, web3?) {
     this.debugHash = hash
-    if (web3) remixDebug.init.extendWeb3(web3)
+    if (web3) this._web3 = web3
+    else this._web3 = this.initialWeb3
+    remixDebug.init.extendWeb3(this._web3)
     if (this.onDebugRequestedListener) this.onDebugRequestedListener(hash, web3)
   }
 

apps/remix-ide-e2e/src/tests/solidityUnittests.spec.ts

@@ -232,7 +232,7 @@ module.exports = {
       .removeFile('tests/ballotFailedLog_test.sol', 'workspace_new')
   },
 
-  'Debug failed test using debugger': function (browser: NightwatchBrowser) {
+  'Debug tests using debugger': function (browser: NightwatchBrowser) {
     browser
       .waitForElementPresent('*[data-id="verticalIconsKindfilePanel"]')
       .addFile('tests/ballotFailedDebug_test.sol', sources[0]['tests/ballotFailedDebug_test.sol'])
@@ -242,20 +242,50 @@ module.exports = {
       .click('#runTestsTabRunAction')
       .waitForElementVisible('*[data-id="testTabSolidityUnitTestsOutputheader"]', 120000)
       .waitForElementContainsText('#solidityUnittestsOutput', 'tests/ballotFailedDebug_test.sol', 60000)
-      .waitForElementContainsText('#solidityUnittestsOutput', '✘ Check winning proposal', 60000)
+      .waitForElementContainsText('#solidityUnittestsOutput', '✘ Check winning proposal failed', 60000)
+      .waitForElementContainsText('#solidityUnittestsOutput', '✓ Check winning proposal passed', 60000)
+      .waitForElementContainsText('#solidityUnittestsOutput', '✘ Check winning proposal again', 60000)
       .waitForElementContainsText('#solidityUnittestsOutput', '✓ Check winnin proposal with return value', 60000)
-      .click('.fa-bug')
+      .click('#Check_winning_proposal_failed')
       .waitForElementContainsText('*[data-id="sidePanelSwapitTitle"]', 'DEBUGGER', 60000)
-      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposal()', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalFailed()', 60000)
       .click('*[data-id="dropdownPanelSolidityLocals"]')
       .waitForElementContainsText('*[data-id="solidityLocals"]', 'no locals', 60000)
       // eslint-disable-next-line dot-notation
-      .execute(function () { document.getElementById('slider')['value'] = '235' }) // It only moves slider to 235 but vm traces are not updated
+      .execute(function () { document.getElementById('slider')['value'] = '315' }) // It only moves slider to 315 but vm traces are not updated
       .setValue('*[data-id="slider"]', new Array(1).fill(browser.Keys.RIGHT_ARROW))
-      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposal()', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalFailed()', 60000)
       .waitForElementContainsText('*[data-id="functionPanel"]', 'vote(proposal)', 60000)
-      .pause(2000)
+      .pause(1000)
       .checkVariableDebug('soliditylocals', locals)
+      .clickLaunchIcon('solidityUnitTesting')
+      .scrollAndClick('#Check_winning_proposal_passed')
+      .waitForElementContainsText('*[data-id="sidePanelSwapitTitle"]', 'DEBUGGER', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalPassed()', 60000)
+      // eslint-disable-next-line dot-notation
+      .execute(function () { document.getElementById('slider')['value'] = '1450' })
+      .setValue('*[data-id="slider"]', new Array(1).fill(browser.Keys.RIGHT_ARROW))
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'equal(a, b, message)', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalPassed()', 60000)
+      .pause(1000)
+      .clickLaunchIcon('solidityUnitTesting')
+      .scrollAndClick('#Check_winning_proposal_again')
+      .waitForElementContainsText('*[data-id="sidePanelSwapitTitle"]', 'DEBUGGER', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalAgain()', 60000)
+      // eslint-disable-next-line dot-notation
+      .execute(function () { document.getElementById('slider')['value'] = '1150' })
+      .setValue('*[data-id="slider"]', new Array(1).fill(browser.Keys.RIGHT_ARROW))
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'equal(a, b, message)', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinningProposalAgain()', 60000)
+      .pause(1000)
+      .clickLaunchIcon('solidityUnitTesting')
+      .scrollAndClick('#Check_winnin_proposal_with_return_value')
+      .waitForElementContainsText('*[data-id="sidePanelSwapitTitle"]', 'DEBUGGER', 60000)
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinninProposalWithReturnValue()', 60000)
+      // eslint-disable-next-line dot-notation
+      .execute(function () { document.getElementById('slider')['value'] = '320' })
+      .setValue('*[data-id="slider"]', new Array(1).fill(browser.Keys.RIGHT_ARROW))
+      .waitForElementContainsText('*[data-id="functionPanel"]', 'checkWinninProposalWithReturnValue()', 60000)
       .clickLaunchIcon('filePanel')
       .pause(2000)
       .openFile('tests/ballotFailedDebug_test.sol')
@@ -461,7 +491,7 @@ const sources = [
     },
     'tests/deployError_test.sol': {
       content: `
-      pragma solidity ^0.7.0;
+      pragma solidity ^0.8.0;
 
       contract failingDeploy {
           constructor() {
@@ -472,7 +502,7 @@ const sources = [
     },
     'tests/methodFailure_test.sol': {
       content: `
-      pragma solidity ^0.7.0;
+      pragma solidity ^0.8.0;
 
       contract methodfailure {
         function add(uint a, uint b) public {
@@ -499,11 +529,20 @@ const sources = [
               ballotToTest = new Ballot(proposalNames);
           }
           
-          function checkWinningProposal () public {
-              ballotToTest.vote(1); // This will revert the transaction
+          function checkWinningProposalFailed () public {
+              ballotToTest.vote(1);
+              Assert.equal(ballotToTest.winningProposal(), uint(0), "proposal at index 0 should be the winning proposal");
+          }
+          
+          function checkWinningProposalPassed () public {
+              ballotToTest.vote(0);
               Assert.equal(ballotToTest.winningProposal(), uint(0), "proposal at index 0 should be the winning proposal");
           }
           
+          function checkWinningProposalAgain () public {
+              Assert.equal(ballotToTest.winningProposal(), uint(1), "proposal at index 0 should be the winning proposal");
+          }
+          
           function checkWinninProposalWithReturnValue () public view returns (bool) {
               return ballotToTest.winningProposal() == 0;
           }

apps/remix-ide/src/app/tabs/test-tab.js

@@ -247,6 +247,14 @@ module.exports = class TestTab extends ViewPlugin {
 
   testCallback (result, runningTests) {
     this.testsOutput.hidden = false
+    let debugBtn = yo``
+    if ((result.type === 'testPass' || result.type === 'testFailure') && result.debugTxHash) {
+      const { web3, debugTxHash } = result
+      debugBtn = yo`<div id=${result.value.replaceAll(' ', '_')} class="btn border btn btn-sm ml-1" title="Start debugging" onclick=${() => this.startDebug(debugTxHash, web3)}>
+        <i class="fas fa-bug"></i>
+      </div>`
+      debugBtn.style.cursor = 'pointer'
+    }
     if (result.type === 'contract') {
       this.testSuite = result.value
       if (this.testSuites) {
@@ -268,29 +276,18 @@ module.exports = class TestTab extends ViewPlugin {
         <div
           id="${this.runningTestFileName}"
           data-id="testTabSolidityUnitTestsOutputheader"
-          class="${css.testPass} ${css.testLog} bg-light mb-2 text-success border-0"
+          class="${css.testPass} ${css.testLog} bg-light mb-2 px-2 text-success border-0"
           onclick=${() => this.discardHighlight()}
         >
-          ✓ ${result.value}
+          <div class="d-flex my-1 align-items-start justify-content-between">
+            <span style="margin-block: auto" > ✓ ${result.value}</span>
+            ${debugBtn}
+          </div>
         </div>
       `)
     } else if (result.type === 'testFailure') {
       if (result.hhLogs && result.hhLogs.length) this.printHHLogs(result.hhLogs, result.value)
       if (!result.assertMethod) {
-        let debugBtn = yo``
-        if (result.errMsg.includes('Transaction has been reverted by the EVM')) {
-          const txHash = JSON.parse(result.errMsg.replace('Transaction has been reverted by the EVM:', '')).transactionHash
-          const { web3 } = result
-          debugBtn = yo`<div
-            class="btn border btn btn-sm ml-1"
-            title="Start debugging"
-            onclick=${() => this.startDebug(txHash, web3)}
-          >
-            <i class="fas fa-bug"></i>
-          </div>`
-          debugBtn.style.visibility = 'visible'
-          debugBtn.style.cursor = 'pointer'
-        } else debugBtn.style.visibility = 'hidden'
         this.testsOutput.appendChild(yo`
         <div
           class="bg-light mb-2 px-2 ${css.testLog} d-flex flex-column text-danger border-0"
@@ -315,7 +312,10 @@ module.exports = class TestTab extends ViewPlugin {
             id="UTContext${result.context}"
             onclick=${() => this.highlightLocation(result.location, runningTests, result.filename)}
           >
+            <div class="d-flex my-1 align-items-start justify-content-between">  
               <span> ✘ ${result.value}</span>
+              ${debugBtn}
+            </div> 
             <span class="text-dark">Error Message:</span>
             <span class="pb-2 text-break">"${result.errMsg}"</span>
             <span class="text-dark">Assertion:</span>
@@ -499,7 +499,7 @@ module.exports = class TestTab extends ViewPlugin {
         usingWorker: canUseWorker(currentVersion),
         runs
       }
-      this.testRunner.runTestSources(runningTest, compilerConfig, () => {}, () => {}, (error, result) => {
+      this.testRunner.runTestSources(runningTest, compilerConfig, () => {}, () => {}, null, (error, result) => {
         if (error) return reject(error)
         resolve(result)
       }, (url, cb) => {
@@ -527,17 +527,22 @@ module.exports = class TestTab extends ViewPlugin {
         usingWorker: canUseWorker(currentVersion),
         runs
       }
+      const deployCb = async (file, contractAddress) => {
+        const compilerData = await this.call('compilerArtefacts', 'getCompilerAbstract', file)
+        await this.call('compilerArtefacts', 'addResolvedContract', contractAddress, compilerData)
+      }
       this.testRunner.runTestSources(
         runningTests,
         compilerConfig,
         (result) => this.testCallback(result, runningTests),
         (_err, result, cb) => this.resultsCallback(_err, result, cb),
+        deployCb,
         (error, result) => {
           this.updateFinalResult(error, result, testFilePath)
           callback(error)
         }, (url, cb) => {
           return this.contentImport.resolveAndSave(url).then((result) => cb(null, result)).catch((error) => cb(error.message))
-        }
+        }, { testFilePath }
       )
     }).catch((error) => {
       if (error) return // eslint-disable-line

libs/remix-core-plugin/src/lib/compiler-artefacts.ts

@@ -4,7 +4,7 @@ import { CompilerAbstract } from '@remix-project/remix-solidity'
 
 const profile = {
   name: 'compilerArtefacts',
-  methods: ['get', 'addResolvedContract'],
+  methods: ['get', 'addResolvedContract', 'getCompilerAbstract'],
   events: [],
   version: '0.0.1'
 }

libs/remix-tests/src/compiler.ts

@@ -171,8 +171,9 @@ export function compileFileOrFiles (filename: string, isDirectory: boolean, opts
  * @param cb Callback
  */
 export function compileContractSources (sources: SrcIfc, compilerConfig: CompilerConfiguration, importFileCb: any, opts: any, cb): void {
-  let compiler, filepath: string
+  let compiler
   const accounts: string[] = opts.accounts || []
+  const filepath = opts.testFilePath || ''
   // Iterate over sources keys. Inject test libraries. Inject test library import statements.
   if (!('remix_tests.sol' in sources) && !('tests.sol' in sources)) {
     sources['tests.sol'] = { content: require('../sol/tests.sol.js') }

libs/remix-tests/src/deployer.ts

@@ -11,7 +11,7 @@ import { compilationInterface } from './types'
  * @param callback Callback
  */
 
-export function deployAll (compileResult: compilationInterface, web3: Web3, withDoubleGas: boolean, callback) {
+export function deployAll (compileResult: compilationInterface, web3: Web3, withDoubleGas: boolean, deployCb, callback) {
   const compiledObject = {}
   const contracts = {}
   let accounts: string[] = []
@@ -70,7 +70,7 @@ export function deployAll (compileResult: compilationInterface, web3: Web3, with
           deployObject.send({
             from: accounts[0],
             gas: gas
-          }).on('receipt', function (receipt) {
+          }).on('receipt', async function (receipt) {
             contractObject.options.address = receipt.contractAddress
             contractObject.options.from = accounts[0]
             contractObject.options.gas = 5000 * 1000
@@ -79,6 +79,7 @@ export function deployAll (compileResult: compilationInterface, web3: Web3, with
             contracts[contractName] = contractObject
             contracts[contractName].filename = filename
 
+            if (deployCb) await deployCb(filename, receipt.contractAddress)
             callback(null, { receipt: { contractAddress: receipt.contractAddress } }) // TODO this will only work with JavaScriptV VM
           }).on('error', function (err) {
             console.error(err)

libs/remix-tests/src/runTestFiles.ts

@@ -61,13 +61,13 @@ export function runTestFiles (filepath: string, isDirectory: boolean, web3: Web3
       for (const filename in asts) {
         if (filename.endsWith('_test.sol')) { sourceASTs[filename] = asts[filename].ast }
       }
-      deployAll(compilationResult, web3, false, (err, contracts) => {
+      deployAll(compilationResult, web3, false, null, (err, contracts) => {
         if (err) {
           // If contract deployment fails because of 'Out of Gas' error, try again with double gas
           // This is temporary, should be removed when remix-tests will have a dedicated UI to
           // accept deployment params from UI
           if (err.message.includes('The contract code couldn\'t be stored, please check your gas limit')) {
-            deployAll(compilationResult, web3, true, (error, contracts) => {
+            deployAll(compilationResult, web3, true, null, (error, contracts) => {
               if (error) next([{ message: 'contract deployment failed after trying twice: ' + error.message, severity: 'error' }]) // IDE expects errors in array
               else next(null, compilationResult, contracts)
             })

libs/remix-tests/src/runTestSources.ts

@@ -39,7 +39,7 @@ export class UnitTestRunner {
    * @param importFileCb Import file callback
    * @param opts Options
    */
-  async runTestSources (contractSources: SrcIfc, compilerConfig: CompilerConfiguration, testCallback, resultCallback, finalCallback: any, importFileCb, opts: Options) {
+  async runTestSources (contractSources: SrcIfc, compilerConfig: CompilerConfiguration, testCallback, resultCallback, deployCb:any, finalCallback: any, importFileCb, opts: Options) {
     opts = opts || {}
     const sourceASTs: any = {}
     const web3 = opts.web3 || await this.createWeb3Provider()
@@ -53,19 +53,19 @@ export class UnitTestRunner {
         })
       },
       (next) => {
-        compileContractSources(contractSources, compilerConfig, importFileCb, { accounts, event: this.event }, next)
+        compileContractSources(contractSources, compilerConfig, importFileCb, { accounts, testFilePath: opts.testFilePath, event: this.event }, next)
       },
       function deployAllContracts (compilationResult: compilationInterface, asts: ASTInterface, next) {
         for (const filename in asts) {
           if (filename.endsWith('_test.sol')) { sourceASTs[filename] = asts[filename].ast }
         }
-        deployAll(compilationResult, web3, false, (err, contracts) => {
+        deployAll(compilationResult, web3, false, deployCb, (err, contracts) => {
           if (err) {
             // If contract deployment fails because of 'Out of Gas' error, try again with double gas
             // This is temporary, should be removed when remix-tests will have a dedicated UI to
             // accept deployment params from UI
             if (err.message.includes('The contract code couldn\'t be stored, please check your gas limit')) {
-              deployAll(compilationResult, web3, true, (error, contracts) => {
+              deployAll(compilationResult, web3, true, deployCb, (error, contracts) => {
                 if (error) next([{ message: 'contract deployment failed after trying twice: ' + error.message, severity: 'error' }]) // IDE expects errors in array
                 else next(null, compilationResult, contracts)
               })

libs/remix-tests/src/testRunner.ts

@@ -244,6 +244,7 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
     if (func.inputs && func.inputs.length > 0) { return resultsCallback(new Error(`Method '${func.name}' can not have parameters inside a test contract`), { passingNum, failureNum, timePassed }) }
     const method = testObject.methods[func.name].apply(testObject.methods[func.name], [])
     const startTime = Date.now()
+    let debugTxHash:string
     if (func.constant) {
       sendParams = {}
       const tagTimestamp = 'remix_tests_tag' + Date.now()
@@ -253,13 +254,16 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
         let tagTxHash
         if (web3.eth && web3.eth.getHashFromTagBySimulator) tagTxHash = await web3.eth.getHashFromTagBySimulator(tagTimestamp)
         if (web3.eth && web3.eth.getHHLogsForTx) hhLogs = await web3.eth.getHHLogsForTx(tagTxHash)
+        debugTxHash = tagTxHash
         if (result) {
           const resp: TestResultInterface = {
             type: 'testPass',
             value: changeCase.sentenceCase(func.name),
             filename: testObject.filename,
             time: time,
-            context: testName
+            context: testName,
+            web3,
+            debugTxHash
           }
           if (hhLogs && hhLogs.length) resp.hhLogs = hhLogs
           testCallback(undefined, resp)
@@ -272,7 +276,9 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
             filename: testObject.filename,
             time: time,
             errMsg: 'function returned false',
-            context: testName
+            context: testName,
+            web3,
+            debugTxHash
           }
           if (hhLogs && hhLogs.length) resp.hhLogs = hhLogs
           testCallback(undefined, resp)
@@ -293,6 +299,7 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
       sendParams.gas = 10000000 * 8
       method.send(sendParams).on('receipt', async (receipt) => {
         try {
+          debugTxHash = receipt.transactionHash
           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() + ')'))
@@ -322,7 +329,8 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
                     returned: testEvent[3],
                     expected: testEvent[4],
                     location,
-                    web3
+                    web3,
+                    debugTxHash
                   }
                   if (hhLogs && hhLogs.length) resp.hhLogs = hhLogs
                   testCallback(undefined, resp)
@@ -341,7 +349,9 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
               value: changeCase.sentenceCase(func.name),
               filename: testObject.filename,
               time: time,
-              context: testName
+              context: testName,
+              web3,
+              debugTxHash
             }
             if (hhLogs && hhLogs.length) resp.hhLogs = hhLogs
             testCallback(undefined, resp)
@@ -380,6 +390,7 @@ export function runTest (testName: string, testObject: any, contractDetails: Com
           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 && hhLogs.length) resp.hhLogs = hhLogs
+          resp.debugTxHash = txHash
         }
         testCallback(undefined, resp)
         failureNum += 1

libs/remix-tests/src/types.ts

@@ -38,6 +38,7 @@ export interface TestResultInterface {
   location?: string
   hhLogs?: []
   web3?: any
+  debugTxHash?: string
 }
 export interface TestCbInterface {
   (error: Error | null | undefined, result: TestResultInterface) : void;
@@ -48,6 +49,7 @@ export interface ResultCbInterface {
 
 export interface Options {
   accounts?: string[] | null,
+  testFilePath?: string
   web3?: any
 }