this.discardHighlight()}
- >
-
- ✓ ${result.value}
- ${debugBtn}
-
-
this.highlightLocation(result.location, runningTests, result.filename)}
- >
-
- ✘ ${result.value}
- ${debugBtn}
-
-
Error Message:
-
"${result.errMsg}"
-
this.highlightLocation(result.location, runningTests, result.filename)}
- >
-
- ✘ ${result.value}
- ${debugBtn}
-
-
Error Message:
-
"${result.errMsg}"
-
Assertion:
-
-
Expected value should be
-
${method}
-
${preposition} ${expected}
-
-
Received value:
-
${result.returned}
-
Skipping the remaining tests of the function.
-
`
- this.testsExecutionStopped = yo`
`
- this.testsExecutionStoppedError = yo`
`
- this.uiPathList = yo`
`
- this.inputPath = yo`
this.handleTestDirInput(e)}
- onchange=${async (e) => this.handleEnter(e)}
- />`
-
- this.createTestFolder = yo`
-
- `
+ this.renderComponent()
+ return this.element
+ }
- const availablePaths = yo`
-
-
- ${this.inputPath}
- ${this.createTestFolder}
- ${this.uiPathList}
-
-
- `
- this.updateDirList('/')
- this.testsExecutionStopped.hidden = true
- this.testsExecutionStoppedError.hidden = true
- this.resultStatistics = this.createResultLabel()
- this.resultStatistics.hidden = true
- const el = yo`
-
-
-
Test your smart contract in Solidity.
-
Select directory to load and generate test files.
-
- ${availablePaths}
-
-
-
- ${this.updateGenerateFileAction()}
- ${this.infoButton()}
-
-
- ${this.updateRunAction()}
- ${this.updateStopAction()}
-
- ${this.selectAll()}
- ${this.updateTestFileList()}
-
- ${this.resultStatistics}
- ${this.testsExecutionStopped}
- ${this.testsExecutionStoppedError}
-
- ${this.testsOutput}
-
-
- `
- this._view.el = el
- this.testTabLogic.setCurrentPath(this.defaultPath)
- this.updateForNewCurrent(this.fileManager.currentFile())
- return el
+ renderComponent (testDirPath) {
+ ReactDOM.render(
+
+ , this.element)
}
}
diff --git a/apps/remix-ide/src/app/tabs/testTab/testTab.js b/apps/remix-ide/src/app/tabs/testTab/testTab.js
deleted file mode 100644
index 93cb49516b..0000000000
--- a/apps/remix-ide/src/app/tabs/testTab/testTab.js
+++ /dev/null
@@ -1,135 +0,0 @@
-const helper = require('../../../lib/helper.js')
-const modalDialogCustom = require('../../ui/modal-dialog-custom')
-const remixPath = require('path')
-
-class TestTabLogic {
- constructor (fileManager) {
- this.fileManager = fileManager
- this.currentPath = '/tests'
- }
-
- setCurrentPath (path) {
- if (path.indexOf('/') === 0) return
- this.currentPath = helper.removeMultipleSlashes(helper.removeTrailingSlashes(path))
- }
-
- generateTestFolder (path) {
- // Todo move this check to File Manager after refactoring
- // Checking to ignore the value which contains only whitespaces
- if (!path || !(/\S/.test(path))) return
- path = helper.removeMultipleSlashes(path)
- const fileProvider = this.fileManager.fileProviderOf(path.split('/')[0])
- fileProvider.exists(path).then(res => {
- if (!res) fileProvider.createDir(path)
- })
- }
-
- async pathExists (path) {
- // Checking to ignore the value which contains only whitespaces
- if (!path || !(/\S/.test(path))) return
- const fileProvider = this.fileManager.fileProviderOf(path.split('/')[0])
- const res = await fileProvider.exists(path, (e, res) => { return res })
- return res
- }
-
- generateTestFile () {
- let fileName = this.fileManager.currentFile()
- const hasCurrent = !!fileName && this.fileManager.currentFile().split('.').pop().toLowerCase() === 'sol'
- if (!hasCurrent) fileName = this.currentPath + '/newFile.sol'
- const fileProvider = this.fileManager.fileProviderOf(this.currentPath)
- if (!fileProvider) return
- const splittedFileName = fileName.split('/')
- const fileNameToImport = (!hasCurrent) ? fileName : this.currentPath + '/' + splittedFileName[splittedFileName.length - 1]
- helper.createNonClashingNameWithPrefix(fileNameToImport, fileProvider, '_test', (error, newFile) => {
- if (error) return modalDialogCustom.alert('Failed to create file. ' + newFile + ' ' + error)
- if (!fileProvider.set(newFile, this.generateTestContractSample(hasCurrent, fileName))) return modalDialogCustom.alert('Failed to create test file ' + newFile)
- this.fileManager.open(newFile)
- this.fileManager.syncEditor(newFile)
- })
- }
-
- dirList (path) {
- return this.fileManager.dirList(path)
- }
-
- isRemixDActive () {
- return this.fileManager.isRemixDActive()
- }
-
- async getTests (cb) {
- if (!this.currentPath) return cb(null, [])
- const provider = this.fileManager.fileProviderOf(this.currentPath)
- if (!provider) return cb(null, [])
- const tests = []
- let files = []
- try {
- if (await this.fileManager.exists(this.currentPath)) files = await this.fileManager.readdir(this.currentPath)
- } catch (e) {
- cb(e.message)
- }
- for (var file in files) {
- const filepath = provider && provider.type ? provider.type + '/' + file : file
- if (/.(_test.sol)$/.exec(file)) tests.push(filepath)
- }
- cb(null, tests, this.currentPath)
- }
-
- // @todo(#2758): If currently selected file is compiled and compilation result is available,
- // 'contractName' should be
+ '_testSuite'
- generateTestContractSample (hasCurrent, fileToImport, contractName = 'testSuite') {
- let relative = remixPath.relative(this.currentPath, remixPath.dirname(fileToImport))
- if (relative === '') relative = '.'
- const comment = hasCurrent ? `import "${relative}/${remixPath.basename(fileToImport)}";` : '// '
- return `// SPDX-License-Identifier: GPL-3.0
-
-pragma solidity >=0.4.22 <0.9.0;
-
-// This import is automatically injected by Remix
-import "remix_tests.sol";
-
-// This import is required to use custom transaction context
-// Although it may fail compilation in 'Solidity Compiler' plugin
-// But it will work fine in 'Solidity Unit Testing' plugin
-import "remix_accounts.sol";
-${comment}
-
-// File name has to end with '_test.sol', this file can contain more than one testSuite contracts
-contract ${contractName} {
-
- /// 'beforeAll' runs before all other tests
- /// More special functions are: 'beforeEach', 'beforeAll', 'afterEach' & 'afterAll'
- function beforeAll() public {
- //
- Assert.equal(uint(1), uint(1), "1 should be equal to 1");
- }
-
- function checkSuccess() public {
- // Use 'Assert' methods: https://remix-ide.readthedocs.io/en/latest/assert_library.html
- Assert.ok(2 == 2, 'should be true');
- Assert.greaterThan(uint(2), uint(1), "2 should be greater than to 1");
- Assert.lesserThan(uint(2), uint(3), "2 should be lesser than to 3");
- }
-
- function checkSuccess2() public pure returns (bool) {
- // Use the return value (true or false) to test the contract
- return true;
- }
-
- function checkFailure() public {
- Assert.notEqual(uint(1), uint(1), "1 should not be equal to 1");
- }
-
- /// Custom Transaction Context: https://remix-ide.readthedocs.io/en/latest/unittesting.html#customization
- /// #sender: account-1
- /// #value: 100
- function checkSenderAndValue() public payable {
- // account index varies 0-9, value is in wei
- Assert.equal(msg.sender, TestsAccounts.getAccount(1), "Invalid sender");
- Assert.equal(msg.value, 100, "Invalid value");
- }
-}
-`
- }
-}
-
-module.exports = TestTabLogic
diff --git a/libs/remix-ui/solidity-unit-testing/.babelrc b/libs/remix-ui/solidity-unit-testing/.babelrc
new file mode 100644
index 0000000000..ccae900be4
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/.babelrc
@@ -0,0 +1,12 @@
+{
+ "presets": [
+ [
+ "@nrwl/react/babel",
+ {
+ "runtime": "automatic",
+ "useBuiltIns": "usage"
+ }
+ ]
+ ],
+ "plugins": []
+}
diff --git a/libs/remix-ui/solidity-unit-testing/.eslintrc.json b/libs/remix-ui/solidity-unit-testing/.eslintrc.json
new file mode 100644
index 0000000000..5e100bf955
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/.eslintrc.json
@@ -0,0 +1,21 @@
+{
+ "extends": ["plugin:@nrwl/nx/react", "../../../.eslintrc.json"],
+ "ignorePatterns": ["!**/*"],
+ "rules": {
+ "@typescript-eslint/no-explicit-any": "off"
+ },
+ "overrides": [
+ {
+ "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+ "rules": {}
+ },
+ {
+ "files": ["*.ts", "*.tsx"],
+ "rules": {}
+ },
+ {
+ "files": ["*.js", "*.jsx"],
+ "rules": {}
+ }
+ ]
+}
diff --git a/libs/remix-ui/solidity-unit-testing/README.md b/libs/remix-ui/solidity-unit-testing/README.md
new file mode 100644
index 0000000000..d10d541404
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/README.md
@@ -0,0 +1,7 @@
+# remix-ui-solidity-unit-testing
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test remix-ui-solidity-unit-testing` to execute the unit tests via [Jest](https://jestjs.io).
diff --git a/libs/remix-ui/solidity-unit-testing/src/index.ts b/libs/remix-ui/solidity-unit-testing/src/index.ts
new file mode 100644
index 0000000000..ad00e8d3b4
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/src/index.ts
@@ -0,0 +1,2 @@
+export * from './lib/solidity-unit-testing'
+export * from './lib/logic/testTabLogic'
diff --git a/libs/remix-ui/solidity-unit-testing/src/lib/css/style.css b/libs/remix-ui/solidity-unit-testing/src/lib/css/style.css
new file mode 100644
index 0000000000..f6d05f2150
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/src/lib/css/style.css
@@ -0,0 +1,45 @@
+
+ .infoBox {
+ margin: 5%;
+ }
+ .testList {
+ line-height: 2em;
+ display: flex;
+ flex-direction: column;
+ margin: 5%;
+ max-height: 300px;
+ overflow-y: auto;
+
+ }
+ .container {
+ margin: 2%;
+ padding-bottom: 5%;
+ max-height: 300px;
+ overflow-y: auto;
+ }
+ .summaryTitle {
+ font-weight: bold;
+ }
+ .testPass {
+ }
+ .testLog {
+ margin-bottom: 1%;
+ border-radius: 4px;
+ padding: 1% 1% 1% 5%;
+ }
+ .title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-bottom: 1em;
+ }
+ .label {
+ display: flex;
+ align-items: center;
+ white-space: nowrap;
+ }
+ .labelOnBtn {
+ border: hidden;
+ }
+ .inputFolder {
+ width: 80%;
+ }
\ No newline at end of file
diff --git a/libs/remix-ui/solidity-unit-testing/src/lib/logic/testTabLogic.ts b/libs/remix-ui/solidity-unit-testing/src/lib/logic/testTabLogic.ts
new file mode 100644
index 0000000000..80a65d5f8f
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/src/lib/logic/testTabLogic.ts
@@ -0,0 +1,137 @@
+import remixPath from 'path'
+
+export class TestTabLogic {
+
+ fileManager
+ currentPath
+ helper
+ constructor (fileManager: any, helper: any) {
+ this.fileManager = fileManager
+ this.helper = helper
+ this.currentPath = '/tests'
+ }
+
+ setCurrentPath (path: string) {
+ if (path.indexOf('/') === 0) return
+ this.currentPath = this.helper.removeMultipleSlashes(this.helper.removeTrailingSlashes(path))
+ }
+
+ generateTestFolder (path:string) {
+ // Todo move this check to File Manager after refactoring
+ // Checking to ignore the value which contains only whitespaces
+ if (!path || !(/\S/.test(path))) return
+ path = this.helper.removeMultipleSlashes(path)
+ const fileProvider = this.fileManager.fileProviderOf(path.split('/')[0])
+ fileProvider.exists(path).then((res: any) => {
+ if (!res) fileProvider.createDir(path)
+ })
+ }
+
+ async pathExists (path: string) {
+ // Checking to ignore the value which contains only whitespaces
+ if (!path || !(/\S/.test(path))) return
+ const fileProvider = this.fileManager.fileProviderOf(path.split('/')[0])
+ const res = await fileProvider.exists(path, (e: any, res: any) => { return res })
+ return res
+ }
+
+ generateTestFile (errorCb: any) {
+ let fileName = this.fileManager.currentFile()
+ const hasCurrent = !!fileName && this.fileManager.currentFile().split('.').pop().toLowerCase() === 'sol'
+ if (!hasCurrent) fileName = this.currentPath + '/newFile.sol'
+ const fileProvider = this.fileManager.fileProviderOf(this.currentPath)
+ if (!fileProvider) return
+ const splittedFileName = fileName.split('/')
+ const fileNameToImport = (!hasCurrent) ? fileName : this.currentPath + '/' + splittedFileName[splittedFileName.length - 1]
+ this.helper.createNonClashingNameWithPrefix(fileNameToImport, fileProvider, '_test', (error: any, newFile: any) => {
+ if (error) return errorCb('Failed to create file. ' + newFile + ' ' + error)
+ const isFileCreated = fileProvider.set(newFile, this.generateTestContractSample(hasCurrent, fileName))
+ if (!isFileCreated) return errorCb('Failed to create test file ' + newFile)
+ this.fileManager.open(newFile)
+ this.fileManager.syncEditor(newFile)
+ })
+ }
+
+ dirList (path:string) {
+ return this.fileManager.dirList(path)
+ }
+
+ isRemixDActive () {
+ return this.fileManager.isRemixDActive()
+ }
+
+ async getTests (cb: any) {
+ if (!this.currentPath) return cb(null, [])
+ const provider = this.fileManager.fileProviderOf(this.currentPath)
+ if (!provider) return cb(null, [])
+ const tests = []
+ let files = []
+ try {
+ if (await this.fileManager.exists(this.currentPath)) files = await this.fileManager.readdir(this.currentPath)
+ } catch (e: any) {
+ cb(e.message)
+ }
+ for (const file in files) {
+ const filepath = provider && provider.type ? provider.type + '/' + file : file
+ if (/.(_test.sol)$/.exec(file)) tests.push(filepath)
+ }
+ cb(null, tests, this.currentPath)
+ }
+
+ // @todo(#2758): If currently selected file is compiled and compilation result is available,
+ // 'contractName' should be + '_testSuite'
+ generateTestContractSample (hasCurrent: any, fileToImport: any, contractName = 'testSuite') {
+ let relative = remixPath.relative(this.currentPath, remixPath.dirname(fileToImport))
+ if (relative === '') relative = '.'
+ const comment = hasCurrent ? `import "${relative}/${remixPath.basename(fileToImport)}";` : '// '
+ return `// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity >=0.4.22 <0.9.0;
+
+// This import is automatically injected by Remix
+import "remix_tests.sol";
+
+// This import is required to use custom transaction context
+// Although it may fail compilation in 'Solidity Compiler' plugin
+// But it will work fine in 'Solidity Unit Testing' plugin
+import "remix_accounts.sol";
+${comment}
+
+// File name has to end with '_test.sol', this file can contain more than one testSuite contracts
+contract ${contractName} {
+
+ /// 'beforeAll' runs before all other tests
+ /// More special functions are: 'beforeEach', 'beforeAll', 'afterEach' & 'afterAll'
+ function beforeAll() public {
+ //
+ Assert.equal(uint(1), uint(1), "1 should be equal to 1");
+ }
+
+ function checkSuccess() public {
+ // Use 'Assert' methods: https://remix-ide.readthedocs.io/en/latest/assert_library.html
+ Assert.ok(2 == 2, 'should be true');
+ Assert.greaterThan(uint(2), uint(1), "2 should be greater than to 1");
+ Assert.lesserThan(uint(2), uint(3), "2 should be lesser than to 3");
+ }
+
+ function checkSuccess2() public pure returns (bool) {
+ // Use the return value (true or false) to test the contract
+ return true;
+ }
+
+ function checkFailure() public {
+ Assert.notEqual(uint(1), uint(1), "1 should not be equal to 1");
+ }
+
+ /// Custom Transaction Context: https://remix-ide.readthedocs.io/en/latest/unittesting.html#customization
+ /// #sender: account-1
+ /// #value: 100
+ function checkSenderAndValue() public payable {
+ // account index varies 0-9, value is in wei
+ Assert.equal(msg.sender, TestsAccounts.getAccount(1), "Invalid sender");
+ Assert.equal(msg.value, 100, "Invalid value");
+ }
+}
+ `
+ }
+}
diff --git a/libs/remix-ui/solidity-unit-testing/src/lib/solidity-unit-testing.tsx b/libs/remix-ui/solidity-unit-testing/src/lib/solidity-unit-testing.tsx
new file mode 100644
index 0000000000..97deaec103
--- /dev/null
+++ b/libs/remix-ui/solidity-unit-testing/src/lib/solidity-unit-testing.tsx
@@ -0,0 +1,734 @@
+import React, { useState, useRef, useEffect } from 'react' // eslint-disable-line
+import { eachOfSeries } from 'async' // eslint-disable-line
+import { canUseWorker, urlFromVersion } from '@remix-project/remix-solidity'
+import { Renderer } from '@remix-ui/renderer' // eslint-disable-line
+import { Toaster } from '@remix-ui/toaster' // eslint-disable-line
+import { format } from 'util'
+import './css/style.css'
+
+const _paq = (window as any)._paq = (window as any)._paq || [] // eslint-disable-line
+
+/* eslint-disable-next-line */
+export interface SolidityUnitTestingProps { }
+
+interface TestObject {
+ fileName: string
+ checked: boolean
+}
+
+export const SolidityUnitTesting = (props: Record) => {
+
+ const { helper, testTab, initialPath } = props
+ const { testTabLogic } = testTab
+
+ const [defaultPath, setDefaultPath] = useState('tests')
+ const [toasterMsg, setToasterMsg] = useState('')
+
+ const [disableCreateButton, setDisableCreateButton] = useState(true)
+ const [disableGenerateButton, setDisableGenerateButton] = useState(false)
+ const [disableStopButton, setDisableStopButton] = useState(true)
+ const [disableRunButton, setDisableRunButton] = useState(false)
+ const [runButtonTitle, setRunButtonTitle] = useState('Run tests')
+ const [stopButtonLabel, setStopButtonLabel] = useState('Stop')
+
+ const [checkSelectAll, setCheckSelectAll] = useState(true)
+ const [testsOutput, setTestsOutput] = useState([])
+
+ const [testsExecutionStoppedHidden, setTestsExecutionStoppedHidden] = useState(true)
+ const [progressBarHidden, setProgressBarHidden] = useState(true)
+ const [testsExecutionStoppedErrorHidden, setTestsExecutionStoppedErrorHidden] = useState(true)
+
+ let [testFiles, setTestFiles] = useState([]) // eslint-disable-line
+ const [pathOptions, setPathOptions] = useState([''])
+
+ const [inputPathValue, setInputPathValue] = useState('tests')
+
+ let [readyTestsNumber, setReadyTestsNumber] = useState(0) // eslint-disable-line
+ let [runningTestsNumber, setRunningTestsNumber] = useState(0) // eslint-disable-line
+
+ const hasBeenStopped = useRef(false)
+ const isDebugging = useRef(false)
+ const allTests: any = useRef([])
+ const selectedTests: any = useRef([])
+ const currentErrors: any = useRef([])
+
+
+ let areTestsRunning = false
+
+ let runningTestFileName: any
+ const filesContent: any = {}
+ const testsResultByFilename: Record = {}
+
+ const trimTestDirInput = (input: string) => {
+ if (input.includes('/')) return input.split('/').map(e => e.trim()).join('/')
+ else return input.trim()
+ }
+
+ const clearResults = () => {
+ setProgressBarHidden(true)
+ testTab.call('editor', 'clearAnnotations')
+ setTestsOutput([])
+ setTestsExecutionStoppedHidden(true)
+ setTestsExecutionStoppedErrorHidden(true)
+ }
+
+ const updateForNewCurrent = async (file = null) => {
+ // 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 (currentErrors.current) {
+ if (Array.isArray(currentErrors.current) && currentErrors.current.length > 0) {
+ const errFiles = currentErrors.current.map((err:any) => { if (err.sourceLocation && err.sourceLocation.file) return err.sourceLocation.file }) // eslint-disable-line
+ if (errFiles.includes(file)) return
+ } else if (currentErrors.current.sourceLocation && currentErrors.current.sourceLocation.file && currentErrors.current.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 (isDebugging.current && testTab.allFilesInvolved.includes(file)) return
+ allTests.current = []
+ updateTestFileList()
+ clearResults()
+ try {
+ testTabLogic.getTests(async (error: any, tests: any) => {
+ if (error) return setToasterMsg(error)
+ allTests.current = tests
+ selectedTests.current = [...allTests.current]
+ updateTestFileList()
+ if (!areTestsRunning) await updateRunAction(file)
+ })
+ } catch (e) {
+ console.log(e)
+ }
+ }
+
+ /**
+ * Changes the current path of Unit Testing Plugin
+ * @param path - the path from where UT plugin takes _test.sol files to run
+ */
+ const setCurrentPath = async (path: string) => {
+ testTabLogic.setCurrentPath(path)
+ setInputPathValue(path)
+ updateDirList(path)
+ await updateForNewCurrent()
+ }
+
+ useEffect(() => {
+ if (initialPath) setCurrentPath(initialPath)
+ }, [initialPath]) // eslint-disable-line react-hooks/exhaustive-deps
+
+ useEffect(() => {
+ updateDirList('/')
+ updateForNewCurrent()
+
+ testTab.on('filePanel', 'newTestFileCreated', async (file: string) => {
+ try {
+ testTabLogic.getTests((error: any, tests: any) => {
+ if (error) return setToasterMsg(error)
+ allTests.current = tests
+ selectedTests.current = [...allTests.current]
+ updateTestFileList()
+ })
+ } catch (e) {
+ console.log(e)
+ allTests.current.push(file)
+ selectedTests.current.push(file)
+ }
+ })
+
+ testTab.on('filePanel', 'setWorkspace', async () => {
+ setCurrentPath(defaultPath)
+ })
+
+ testTab.fileManager.events.on('noFileSelected', () => { }) // eslint-disable-line
+ testTab.fileManager.events.on('currentFileChanged', (file: any, provider: any) => updateForNewCurrent(file))
+
+ }, []) // eslint-disable-line
+
+ const updateDirList = (path: string) => {
+ testTabLogic.dirList(path).then((options: any) => {
+ setPathOptions(options)
+ })
+ }
+
+ const handleTestDirInput = async (e: any) => {
+ let testDirInput = trimTestDirInput(e.target.value)
+ testDirInput = helper.removeMultipleSlashes(testDirInput)
+ if (testDirInput !== '/') testDirInput = helper.removeTrailingSlashes(testDirInput)
+ setInputPathValue(testDirInput)
+ if (e.key === 'Enter') {
+ if (await testTabLogic.pathExists(testDirInput)) {
+ testTabLogic.setCurrentPath(testDirInput)
+ updateForNewCurrent()
+ return
+ }
+ }
+ if (testDirInput) {
+ if (testDirInput.endsWith('/') && testDirInput !== '/') {
+ testDirInput = helper.removeTrailingSlashes(testDirInput)
+ if (testTabLogic.currentPath === testDirInput.substr(0, testDirInput.length - 1)) {
+ setDisableCreateButton(true)
+ setDisableGenerateButton(true)
+ }
+ updateDirList(testDirInput)
+ } else {
+ // If there is no matching folder in the workspace with entered text, enable Create button
+ if (await testTabLogic.pathExists(testDirInput)) {
+ setDisableCreateButton(true)
+ setDisableGenerateButton(false)
+ testTabLogic.setCurrentPath(testDirInput)
+ updateForNewCurrent()
+ } else {
+ // Enable Create button
+ setDisableCreateButton(false)
+ // Disable Generate button because dir does not exist
+ setDisableGenerateButton(true)
+ }
+ }
+ } else {
+ updateDirList('/')
+ }
+ }
+
+ const handleEnter = async (e: any) => {
+ let inputPath = e.target.value
+ inputPath = helper.removeMultipleSlashes(trimTestDirInput(inputPath))
+ setInputPathValue(inputPath)
+ if (disableCreateButton) {
+ if (await testTabLogic.pathExists(inputPath)) {
+ testTabLogic.setCurrentPath(inputPath)
+ updateForNewCurrent()
+ }
+ }
+ }
+
+ const handleCreateFolder = async () => {
+ let inputPath = trimTestDirInput(inputPathValue)
+ let path = helper.removeMultipleSlashes(inputPath)
+ if (path !== '/') path = helper.removeTrailingSlashes(path)
+ if (inputPath === '') inputPath = defaultPath
+ setInputPathValue(path)
+ testTabLogic.generateTestFolder(inputPath)
+ setDisableCreateButton(true)
+ setDisableGenerateButton(false)
+ testTabLogic.setCurrentPath(inputPath)
+ await updateRunAction()
+ updateForNewCurrent()
+ pathOptions.push(inputPath)
+ setPathOptions(pathOptions)
+ }
+
+ const cleanFileName = (fileName: any, testSuite: any) => {
+ return fileName ? fileName.replace(/\//g, '_').replace(/\./g, '_') + testSuite : fileName
+ }
+
+ const startDebug = async (txHash: any, web3: any) => {
+ isDebugging.current = true
+ if (!await testTab.appManager.isActive('debugger')) await testTab.appManager.activatePlugin('debugger')
+ testTab.call('menuicons', 'select', 'debugger')
+ testTab.call('debugger', 'debug', txHash, web3)
+ }
+
+ const printHHLogs = (logsArr: any, testName: any) => {
+ let finalLogs = `${testName}:\n`
+ for (const log of logsArr) {
+ let formattedLog
+ // Hardhat implements the same formatting options that can be found in Node.js' console.log,
+ // which in turn uses util.format: https://nodejs.org/dist/latest-v12.x/docs/api/util.html#util_util_format_format_args
+ // For example: console.log("Name: %s, Age: %d", remix, 6) will log 'Name: remix, Age: 6'
+ // We check first arg to determine if 'util.format' is needed
+ if (typeof log[0] === 'string' && (log[0].includes('%s') || log[0].includes('%d'))) {
+ formattedLog = format(log[0], ...log.slice(1))
+ } else {
+ formattedLog = log.join(' ')
+ }
+ finalLogs = finalLogs + ' ' + formattedLog + '\n'
+ }
+ _paq.push(['trackEvent', 'solidityUnitTesting', 'hardhat', 'console.log'])
+ testTab.call('terminal', 'log', { type: 'info', value: finalLogs })
+ }
+
+ const discardHighlight = async () => {
+ await testTab.call('editor', 'discardHighlight')
+ }
+
+ const highlightLocation = async (location: string, fileName: string) => {
+ if (location) {
+ const split = location.split(':')
+ const file = split[2]
+ const parsedLocation = {
+ start: parseInt(split[0]),
+ length: parseInt(split[1])
+ }
+ const locationToHighlight = testTab.offsetToLineColumnConverter.offsetToLineColumnWithContent(
+ parsedLocation,
+ parseInt(file),
+ filesContent[fileName].content
+ )
+ await testTab.call('editor', 'discardHighlight')
+ await testTab.call('editor', 'highlight', locationToHighlight, fileName, '', { focus: true })
+ }
+ }
+
+ const renderContract = (filename: any, contract: any, index: number, withoutLabel = false) => {
+ if (withoutLabel) {
+ const contractCard: any = (
+
+ {contract ? contract : ''} ({filename})
+
+ )
+ setTestsOutput(prevCards => ([...prevCards, contractCard]))
+ return
+ }
+ let label
+ if (index > -1) {
+ const className = "alert-danger d-inline-block mb-1 mr-1 p-1 failed_" + runningTestFileName
+ label = (
+ FAIL
+
)
+ } else {
+ const className = "alert-success d-inline-block mb-1 mr-1 p-1 passed_" + runningTestFileName
+ label = (
+ PASS
+
)
+ }
+ // show contract and file name with label
+ const ContractCard: any = (
+
+ {label}{contract} ({filename})
+
+ )
+ setTestsOutput(prevCards => {
+ const index = prevCards.findIndex((card: any) => card.props.id === runningTestFileName)
+ prevCards[index] = ContractCard
+ return prevCards
+ })
+ }
+
+ const renderTests = (tests: any, contract: any, filename: any) => {
+ const index = tests.findIndex((test: any) => test.type === 'testFailure')
+ // show filename and contract
+ renderContract(filename, contract, index)
+ // show tests
+ for (const test of tests) {
+ if (!test.rendered) {
+ let debugBtn
+ if (test.debugTxHash) {
+ const { web3, debugTxHash } = test
+ debugBtn = (
+ startDebug(debugTxHash, web3)}>
+
+
+ )
+ }
+ if (test.type === 'testPass') {
+ if (test.hhLogs && test.hhLogs.length) printHHLogs(test.hhLogs, test.value)
+ const testPassCard: any = (
+ discardHighlight()}
+ >
+
+ ✓ {test.value}
+ {debugBtn}
+
+
highlightLocation(test.location, test.filename)}
+ >
+
+ ✘ {test.value}
+ {debugBtn}
+
+
Error Message:
+
"{test.errMsg}"
+
highlightLocation(test.location, test.filename)}
+ >
+
+ ✘ {test.value}
+ {debugBtn}
+
+
Error Message:
+
"{test.errMsg}"
+
Assertion:
+
+
Expected value should be
+
{method}
+
{preposition} {expected}
+
+
Received value:
+
{test.returned}
+
Skipping the remaining tests of the function.
+
+ Result for {testSummary.filename}
+ Passed: {testSummary.passed}
+ Failed: {testSummary.failed}
+ Time Taken: {testSummary.timeTaken}s
+
)
+ setTestsOutput(prevCards => ([...prevCards, summaryCard]))
+ fileTestsResult['summary']['rendered'] = true
+ }
+ }
+ }
+
+ const testCallback = (result: any) => {
+ if (result.filename) {
+ if (!testsResultByFilename[result.filename]) {
+ testsResultByFilename[result.filename] = {}
+ testsResultByFilename[result.filename]['summary'] = {}
+ }
+ if (result.type === 'contract') {
+ testsResultByFilename[result.filename][result.value] = {}
+ testsResultByFilename[result.filename][result.value] = []
+ } else {
+ // Set that this test is not rendered on UI
+ result.rendered = false
+ testsResultByFilename[result.filename][result.context].push(result)
+ }
+ showTestsResult()
+ }
+ }
+
+ const resultsCallback = (_err: any, result: any, cb: any) => {
+ // total stats for the test
+ // result.passingNum
+ // result.failureNum
+ // result.timePassed
+ cb()
+ }
+
+ const updateFinalResult = (_errors: any, result: any, filename: any) => {
+ ++readyTestsNumber
+ setReadyTestsNumber(readyTestsNumber)
+ if (!result && (_errors && (_errors.errors || (Array.isArray(_errors) && (_errors[0].message || _errors[0].formattedMessage))))) {
+ // show only file name
+ renderContract(filename, null, -1, true)
+ currentErrors.current = _errors.errors
+ }
+ if (result) {
+ const totalTime = parseFloat(result.totalTime).toFixed(2)
+ const testsSummary = { filename, passed: result.totalPassing, failed: result.totalFailing, timeTaken: totalTime, rendered: false }
+ testsResultByFilename[filename]['summary'] = testsSummary
+ showTestsResult()
+ } else if (_errors) {
+ if (!testsResultByFilename[filename]) {
+ testsResultByFilename[filename] = {}
+ }
+ testsResultByFilename[filename]['errors'] = _errors
+ setTestsExecutionStoppedErrorHidden(false)
+ showTestsResult()
+ }
+
+ if (hasBeenStopped.current && (readyTestsNumber !== runningTestsNumber)) {
+ // if all tests has been through before stopping no need to print this.
+ setTestsExecutionStoppedHidden(false)
+ }
+ if (_errors || hasBeenStopped.current || readyTestsNumber === runningTestsNumber) {
+ // All tests are ready or the operation has been canceled or there was a compilation error in one of the test files.
+ setDisableStopButton(true)
+ setStopButtonLabel('Stop')
+ if (selectedTests.current?.length !== 0) {
+ setDisableRunButton(false)
+ }
+ areTestsRunning = false
+ }
+ }
+
+ const runTest = (testFilePath: any, callback: any) => {
+ isDebugging.current = false
+ if (hasBeenStopped.current) {
+ updateFinalResult(null, null, null)
+ return
+ }
+ testTab.fileManager.readFile(testFilePath).then((content: any) => {
+ const runningTests: any = {}
+ runningTests[testFilePath] = { content }
+ filesContent[testFilePath] = { content }
+ const { currentVersion, evmVersion, optimize, runs, isUrl } = testTab.compileTab.getCurrentCompilerConfig()
+ const currentCompilerUrl = isUrl ? currentVersion : urlFromVersion(currentVersion)
+ const compilerConfig = {
+ currentCompilerUrl,
+ evmVersion,
+ optimize,
+ usingWorker: canUseWorker(currentVersion),
+ runs
+ }
+ const deployCb = async (file: any, contractAddress: any) => {
+ const compilerData = await testTab.call('compilerArtefacts', 'getCompilerAbstract', file)
+ await testTab.call('compilerArtefacts', 'addResolvedContract', contractAddress, compilerData)
+ }
+ testTab.testRunner.runTestSources(
+ runningTests,
+ compilerConfig,
+ (result: any) => testCallback(result),
+ (_err: any, result: any, cb: any) => resultsCallback(_err, result, cb),
+ deployCb,
+ (error: any, result: any) => {
+ updateFinalResult(error, result, testFilePath)
+ callback(error)
+ }, (url: any, cb: any) => {
+ return testTab.contentImport.resolveAndSave(url).then((result: any) => cb(null, result)).catch((error: any) => cb(error.message))
+ }, { testFilePath }
+ )
+ }).catch((error: any) => {
+ console.log(error)
+ if (error) return // eslint-disable-line
+ })
+ }
+
+ const runTests = () => {
+ areTestsRunning = true
+ hasBeenStopped.current = false
+ readyTestsNumber = 0
+ setReadyTestsNumber(readyTestsNumber)
+ runningTestsNumber = selectedTests.current.length
+ setRunningTestsNumber(runningTestsNumber)
+ setDisableStopButton(false)
+ clearResults()
+ setProgressBarHidden(false)
+ const tests = selectedTests.current
+ if (!tests || !tests.length) return
+ else setProgressBarHidden(false)
+ _paq.push(['trackEvent', 'solidityUnitTesting', 'runTests'])
+ eachOfSeries(tests, (value: any, key: any, callback: any) => {
+ if (hasBeenStopped.current) return
+ runTest(value, callback)
+ })
+ }
+
+ const updateRunAction = async (currentFile: any = null) => {
+ const isSolidityActive = await testTab.appManager.isActive('solidity')
+ if (!isSolidityActive || !selectedTests.current?.length) {
+ // setDisableRunButton(true)
+ if (!currentFile || (currentFile && currentFile.split('.').pop().toLowerCase() !== 'sol')) {
+ setRunButtonTitle('No solidity file selected')
+ } else {
+ setRunButtonTitle('The "Solidity Plugin" should be activated')
+ }
+ }
+ }
+
+ const stopTests = () => {
+ hasBeenStopped.current = true
+ setStopButtonLabel('Stopping')
+ setDisableStopButton(true)
+ setDisableRunButton(true)
+ }
+
+ const getCurrentSelectedTests = () => {
+ const selectedTestsList: TestObject[] = testFiles.filter(testFileObj => testFileObj.checked)
+ return selectedTestsList.map(testFileObj => testFileObj.fileName)
+ }
+
+ const toggleCheckbox = (eChecked: any, index: any) => {
+ testFiles[index].checked = eChecked
+ setTestFiles(testFiles)
+ selectedTests.current = getCurrentSelectedTests()
+ if (eChecked) {
+ setCheckSelectAll(true)
+ setDisableRunButton(false)
+ if ((readyTestsNumber === runningTestsNumber || hasBeenStopped.current) && stopButtonLabel.trim() === 'Stop') {
+ setRunButtonTitle('Run tests')
+ }
+ } else if (!selectedTests.current.length) {
+ setCheckSelectAll(false)
+ setDisableRunButton(true)
+ setRunButtonTitle('No test file selected')
+ } else setCheckSelectAll(false)
+ }
+
+ const checkAll = (event: any) => {
+ testFiles.forEach((testFileObj) => testFileObj.checked = event.target.checked)
+ setTestFiles(testFiles)
+ setCheckSelectAll(event.target.checked)
+ if (event.target.checked) {
+ selectedTests.current = getCurrentSelectedTests()
+ setDisableRunButton(false)
+ } else {
+ selectedTests.current = []
+ setDisableRunButton(true)
+ }
+ }
+
+ const updateTestFileList = () => {
+ if (allTests.current?.length) {
+ testFiles = allTests.current.map((testFile: any) => { return { 'fileName': testFile, 'checked': true } })
+ setCheckSelectAll(true)
+ }
+ else
+ testFiles = []
+ setTestFiles(testFiles)
+ }
+
+ return (
+
+
+
+
Test your smart contract in Solidity.
+
Select directory to load and generate test files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ { }} // eslint-disable-line
+ />
+
+
+
{testFiles?.length ? testFiles.map((testFileObj: any, index) => {
+ const elemId = `singleTest${testFileObj.fileName}`
+ return (
+
+ toggleCheckbox(e.target.checked, index)} type="checkbox" checked={testFileObj.checked} />
+
+
+ )
+ })
+ : "No test file available"}
+
+ Progress: {readyTestsNumber} finished (of {runningTestsNumber})
+
+
+
+
{testsOutput}
+
+