e2e tests config

protofire · Oct 24, 2023 · d23396e · d23396e
1 parent 9971cca
commit d23396e
Show file tree

Hide file tree

Showing 18 changed files with 124 additions and 90 deletions.
diff --git a/...utofix/contracts/00-generic/.solhint.json → e2e/08-autofix/commands/.solhint.json b/...utofix/contracts/00-generic/.solhint.json → e2e/08-autofix/commands/.solhint.json
diff --git a/e2e/08-autofix/contracts/00-generic/Foo1.sol → e2e/08-autofix/commands/Foo1.sol b/e2e/08-autofix/contracts/00-generic/Foo1.sol → e2e/08-autofix/commands/Foo1.sol
diff --git a/...fix/contracts/00-generic/Foo1AfterFix.sol → e2e/08-autofix/commands/Foo1AfterFix.sol b/...fix/contracts/00-generic/Foo1AfterFix.sol → e2e/08-autofix/commands/Foo1AfterFix.sol
diff --git a/...ix/contracts/00-generic/Foo1BeforeFix.sol → e2e/08-autofix/commands/Foo1BeforeFix.sol b/...ix/contracts/00-generic/Foo1BeforeFix.sol → e2e/08-autofix/commands/Foo1BeforeFix.sol
diff --git a/...ix/contracts/explicit-types/.solhint.json → e2e/08-autofix/explicit-types/.solhint.json b/...ix/contracts/explicit-types/.solhint.json → e2e/08-autofix/explicit-types/.solhint.json
diff --git a/...autofix/contracts/explicit-types/Foo1.sol → e2e/08-autofix/explicit-types/Foo1.sol b/...autofix/contracts/explicit-types/Foo1.sol → e2e/08-autofix/explicit-types/Foo1.sol
diff --git a/...contracts/explicit-types/Foo1AfterFix.sol → ...8-autofix/explicit-types/Foo1AfterFix.sol b/...contracts/explicit-types/Foo1AfterFix.sol → ...8-autofix/explicit-types/Foo1AfterFix.sol
diff --git a/...ontracts/explicit-types/Foo1BeforeFix.sol → ...-autofix/explicit-types/Foo1BeforeFix.sol b/...ontracts/explicit-types/Foo1BeforeFix.sol → ...-autofix/explicit-types/Foo1BeforeFix.sol
diff --git a/...utofix/contracts/no-console/.solhint.json → e2e/08-autofix/no-console/.solhint.json b/...utofix/contracts/no-console/.solhint.json → e2e/08-autofix/no-console/.solhint.json
diff --git a/e2e/08-autofix/contracts/no-console/Foo1.sol → e2e/08-autofix/no-console/Foo1.sol b/e2e/08-autofix/contracts/no-console/Foo1.sol → e2e/08-autofix/no-console/Foo1.sol
diff --git a/...fix/contracts/no-console/Foo1AfterFix.sol → e2e/08-autofix/no-console/Foo1AfterFix.sol b/...fix/contracts/no-console/Foo1AfterFix.sol → e2e/08-autofix/no-console/Foo1AfterFix.sol
diff --git a/...ix/contracts/no-console/Foo1BeforeFix.sol → e2e/08-autofix/no-console/Foo1BeforeFix.sol b/...ix/contracts/no-console/Foo1BeforeFix.sol → e2e/08-autofix/no-console/Foo1BeforeFix.sol
diff --git a/...cts/private-vars-underscore/.solhint.json → ...fix/private-vars-underscore/.solhint.json b/...cts/private-vars-underscore/.solhint.json → ...fix/private-vars-underscore/.solhint.json
diff --git a/...ontracts/private-vars-underscore/Foo1.sol → ...-autofix/private-vars-underscore/Foo1.sol b/...ontracts/private-vars-underscore/Foo1.sol → ...-autofix/private-vars-underscore/Foo1.sol
diff --git a/.../private-vars-underscore/Foo1AfterFix.sol → .../private-vars-underscore/Foo1AfterFix.sol b/.../private-vars-underscore/Foo1AfterFix.sol → .../private-vars-underscore/Foo1AfterFix.sol
diff --git a/...private-vars-underscore/Foo1BeforeFix.sol → ...private-vars-underscore/Foo1BeforeFix.sol b/...private-vars-underscore/Foo1BeforeFix.sol → ...private-vars-underscore/Foo1BeforeFix.sol
diff --git a/e2e/autofix-test.js b/e2e/autofix-test.js
@@ -8,11 +8,17 @@ const spawnSync = require('spawn-sync')
 
 const E2E = true
 
-function retrieveParams() {
+let params
+let currentConfig
+let currentFile
+let beforeFixFile
+let afterFixFile
+
+function retrieveParams(subpath) {
   if (E2E) {
-    return { command: 'solhint', param1: '' }
+    return { command: 'solhint', param1: '', path: '', subpath }
   } else {
-    return { command: 'node', param1: 'solhint' }
+    return { command: 'node', param1: 'solhint', path: 'e2e/08-autofix/', subpath }
   }
 }
 
@@ -24,11 +30,17 @@ function compareTextFiles(file1Path, file2Path) {
 }
 
 function copyFile(sourcePath, destinationPath) {
-  // Read the content from the source file
-  const content = fs.readFileSync(sourcePath)
+  // // Read the content from the source file
+  // const content = fs.readFileSync(sourcePath)
+
+  // // Write the content to the destination file, overwriting it if it exists
+  // fs.writeFileSync(destinationPath, content)
+
+  console.log('sourcePath :>> ', sourcePath)
+  console.log('destinationPath :>> ', destinationPath)
+  const { code } = shell.cp(sourcePath, destinationPath)
+  console.log('code :>> ', code)
 
-  // Write the content to the destination file, overwriting it if it exists
-  fs.writeFileSync(destinationPath, content)
 }
 
 function useFixture(dir) {
@@ -56,33 +68,29 @@ describe('e2e', function () {
     }
 
     describe('autofix command line options', () => {
-      const commands = retrieveParams()
-      let PATH = 'e2e/08-autofix/'
-      let SUBPATH = 'contracts/00-generic/'
-      let sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-      let currentFile = `${PATH}${SUBPATH}Foo1.sol`
+      before(function () {
+        params = retrieveParams('commands/')
+        currentConfig = `${params.path}${params.subpath}.solhint.json`
+        currentFile = `${params.path}${params.subpath}Foo1.sol`
+        beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
+        afterFixFile = `${params.path}${params.subpath}Foo1AfterFix.sol`
+      })
 
       describe('--fix without noPrompt', () => {
         after(function () {
-          copyFile(sourceFilePath, currentFile)
+          copyFile(beforeFixFile, currentFile)
         })
 
-        it('should terminate with --fix and user choose NOT to continue', () => {
+        it('pwd and ls', () => {
+          shell.exec(`pwd`)
 
-          shell.exec(
-            `pwd`
-          )
+          shell.exec(`ls`)
+        })
 
+        it('should terminate with --fix and user choose NOT to continue', () => {
           const solhintProcess = spawnSync(
-            `${commands.command}`,
-            [
-              `${commands.param1}`,
-              '-c',
-              `${PATH}${SUBPATH}.solhint.json`,
-              `${PATH}${SUBPATH}Foo1.sol`,
-              '--fix',
-              '--disc',
-            ],
+            `${params.command}`,
+            [`${params.param1}`, '-c', currentConfig, currentFile, '--fix', '--disc'],
             {
               input: 'n\n', // Provide 'n' as input
             }
@@ -92,23 +100,18 @@ describe('e2e', function () {
           expect(solhintProcess.stdout.toString().includes('Process terminated by user'))
         })
 
-        it('should fix with --fix and user choose YES to continue', () => {
-          sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-          currentFile = `${PATH}${SUBPATH}Foo1.sol`
+        it('should compare Foo1 file with template beforeFix file and they should match 1', () => {
+          result = compareTextFiles(currentFile, beforeFixFile)
+          expect(result).to.be.true
+        })
 
-          result = compareTextFiles(sourceFilePath, `${PATH}${SUBPATH}Foo1.sol`)
+        it('should fix with --fix and user choose YES to continue', () => {
+          result = compareTextFiles(beforeFixFile, currentFile)
           expect(result).to.be.true
 
           const solhintProcess = spawnSync(
-            `${commands.command}`,
-            [
-              `${commands.param1}`,
-              '-c',
-              `${PATH}${SUBPATH}.solhint.json`,
-              currentFile,
-              '--fix',
-              '--disc',
-            ],
+            `${params.command}`,
+            [`${params.param1}`, '-c', currentConfig, currentFile, '--fix', '--disc'],
             {
               input: 'y\n', // Provide 'y' as input
             }
@@ -119,24 +122,24 @@ describe('e2e', function () {
         })
 
         it('should compare resulted file with template file and they should match 1', () => {
-          result = compareTextFiles(currentFile, `${PATH}${SUBPATH}Foo1AfterFix.sol`)
+          result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
         })
       })
 
       describe('--fix with noPrompt', () => {
         after(function () {
-          copyFile(sourceFilePath, currentFile)
+          copyFile(beforeFixFile, currentFile)
         })
-        it('should fix file when noPrompt', () => {
-          sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-          currentFile = `${PATH}${SUBPATH}Foo1.sol`
 
-          result = compareTextFiles(sourceFilePath, `${PATH}${SUBPATH}Foo1.sol`)
+        it('should compare Foo1 file with template beforeFix file and they should match 2', () => {
+          result = compareTextFiles(currentFile, beforeFixFile)
           expect(result).to.be.true
+        })
 
+        it('should fix file when noPrompt', () => {
           const { code, stdout } = shell.exec(
-            `${commands.command} ${commands.param1} -c ${PATH}${SUBPATH}.solhint.json ${currentFile} --fix --disc --noPrompt`
+            `${params.command} ${params.param1} -c ${currentConfig} ${currentFile} --fix --disc --noPrompt`
           )
 
           expect(code).to.equal(1)
@@ -146,33 +149,34 @@ describe('e2e', function () {
           expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
         })
 
-        it('files should match', () => {
-          result = compareTextFiles(currentFile, `${PATH}${SUBPATH}Foo1AfterFix.sol`)
+        it('should compare resulted file with template file and they should match 2', () => {
+          result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
         })
       })
-
     })
 
     describe('autofix rule: explicit-types', () => {
       describe('--fix with noPrompt', () => {
-        const commands = retrieveParams()
-        let PATH = 'e2e/08-autofix/'
-        let SUBPATH = 'contracts/explicit-types/'
-        let sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-        let currentFile = `${PATH}${SUBPATH}Foo1.sol`
+        before(function () {
+          params = retrieveParams('explicit-types/')
+          currentConfig = `${params.path}${params.subpath}.solhint.json`
+          currentFile = `${params.path}${params.subpath}Foo1.sol`
+          beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
+          afterFixFile = `${params.path}${params.subpath}Foo1AfterFix.sol`
+        })
         after(function () {
-          copyFile(sourceFilePath, currentFile)
+          copyFile(beforeFixFile, currentFile)
         })
-        it('should fix file when noPrompt', () => {
-          sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-          currentFile = `${PATH}${SUBPATH}Foo1.sol`
 
-          result = compareTextFiles(sourceFilePath, `${PATH}${SUBPATH}Foo1.sol`)
+        it('should compare Foo1 file with template beforeFix file and they should match 3', () => {
+          result = compareTextFiles(currentFile, beforeFixFile)
           expect(result).to.be.true
+        })
 
+        it('should fix file when noPrompt', () => {
           const { code, stdout } = shell.exec(
-            `${commands.command} ${commands.param1} -c ${PATH}${SUBPATH}.solhint.json ${currentFile} --fix --disc --noPrompt`
+            `${params.command} ${params.param1} -c ${currentConfig} ${currentFile} --fix --disc --noPrompt`
           )
 
           expect(code).to.equal(1)
@@ -182,32 +186,57 @@ describe('e2e', function () {
           expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
         })
 
-        it('files should match', () => {
-          result = compareTextFiles(currentFile, `${PATH}${SUBPATH}Foo1AfterFix.sol`)
+        it('should compare resulted file with template file and they should match 3', () => {
+          result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
         })
       })
     })
 
-    describe('autofix rule: no-console', () => {
+    describe.only('autofix rule: no-console', () => {
       describe('--fix with noPrompt', () => {
-        const commands = retrieveParams()
-        let PATH = 'e2e/08-autofix/'
-        let SUBPATH = 'contracts/no-console/'
-        let sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-        let currentFile = `${PATH}${SUBPATH}Foo1.sol`
+        before(function () {
+          params = retrieveParams('no-console/')
+          currentConfig = `${params.path}${params.subpath}.solhint.json`
+          currentFile = `${params.path}${params.subpath}Foo1.sol`
+          beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
+          afterFixFile = `${params.path}${params.subpath}Foo1AfterFix.sol`
+        })
         after(function () {
-          copyFile(sourceFilePath, currentFile)
+          copyFile(beforeFixFile, currentFile)
         })
-        it('should fix file when noPrompt', () => {
-          sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-          currentFile = `${PATH}${SUBPATH}Foo1.sol`
 
-          result = compareTextFiles(sourceFilePath, `${PATH}${SUBPATH}Foo1.sol`)
+        it.only('should compare Foo1 file with template beforeFix file and they should match 3', () => {
+          let stdout
+
+          console.log('beforeFixFile :>> ', beforeFixFile)
+          console.log('currentFile   :>> ', currentFile)
+
+          stdout = shell.pwd()
+          console.log('pwd: ', stdout)
+
+          stdout = shell.ls(stdout)
+          console.log('ls: ', stdout)
+
+
+          shell.cd('no-console/')
+          stdout = shell.pwd()
+          console.log('pwd no-console: ', stdout)
+
+          stdout = shell.ls(stdout)
+          console.log('ls no-console: ', stdout)
+
+
+        })
+
+        it('should compare Foo1 file with template beforeFix file and they should match 4', () => {
+          result = compareTextFiles(currentFile, beforeFixFile)
           expect(result).to.be.true
+        })
 
+        it('should fix file when noPrompt', () => {
           const { code, stdout } = shell.exec(
-            `${commands.command} ${commands.param1} -c ${PATH}${SUBPATH}.solhint.json ${currentFile} --fix --disc --noPrompt`
+            `${params.command} ${params.param1} -c ${currentConfig} ${currentFile} --fix --disc --noPrompt`
           )
 
           expect(code).to.equal(1)
@@ -217,32 +246,34 @@ describe('e2e', function () {
           expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
         })
 
-        it('files should match', () => {
-          result = compareTextFiles(currentFile, `${PATH}${SUBPATH}Foo1AfterFix.sol`)
+        it('should compare resulted file with template file and they should match 4', () => {
+          result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
         })
       })
     })
 
     describe('autofix rule: private-vars-leading-underscore', () => {
       describe('--fix with noPrompt', () => {
-        const commands = retrieveParams()
-        let PATH = 'e2e/08-autofix/'
-        let SUBPATH = 'contracts/private-vars-underscore/'
-        let sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-        let currentFile = `${PATH}${SUBPATH}Foo1.sol`
+        before(function () {
+          params = retrieveParams('private-vars-underscore/')
+          currentConfig = `${params.path}${params.subpath}.solhint.json`
+          currentFile = `${params.path}${params.subpath}Foo1.sol`
+          beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
+          afterFixFile = `${params.path}${params.subpath}Foo1AfterFix.sol`
+        })
         after(function () {
-          copyFile(sourceFilePath, currentFile)
+          copyFile(beforeFixFile, currentFile)
         })
-        it('should fix file when noPrompt', () => {
-          sourceFilePath = `${PATH}${SUBPATH}Foo1BeforeFix.sol`
-          currentFile = `${PATH}${SUBPATH}Foo1.sol`
 
-          result = compareTextFiles(sourceFilePath, `${PATH}${SUBPATH}Foo1.sol`)
+        it('should compare Foo1 file with template beforeFix file and they should match 5', () => {
+          result = compareTextFiles(currentFile, beforeFixFile)
           expect(result).to.be.true
+        })
 
+        it('should fix file when noPrompt', () => {
           const { code, stdout } = shell.exec(
-            `${commands.command} ${commands.param1} -c ${PATH}${SUBPATH}.solhint.json ${currentFile} --fix --disc --noPrompt`
+            `${params.command} ${params.param1} -c ${currentConfig} ${currentFile} --fix --disc --noPrompt`
           )
 
           expect(code).to.equal(1)
@@ -252,11 +283,14 @@ describe('e2e', function () {
           expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
         })
 
-        it('files should match', () => {
-          result = compareTextFiles(currentFile, `${PATH}${SUBPATH}Foo1AfterFix.sol`)
+        it('should compare resulted file with template file and they should match 5', () => {
+          result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
         })
       })
     })
   })
 })
+
+// FALTA LA COMPARACION DEL FIX CON EL TEMPLATE FIX
+// FALTA LA PRUEBA DEL STORE TO FILE
diff --git a/e2e/package.json b/e2e/package.json
@@ -4,7 +4,7 @@
   "description": "E2E tests for solhint",
   "main": "index.js",
   "scripts": {
-    "test": "mocha test.js formatters-test.js autofix-test.js"    
+    "test": "mocha autofix-test.js"    
   },
   "author": "",
   "license": "MIT",