Merge branch 'master' into updateReadmeBrowser

holgerd77 · web-flow · commit ada597a66499 · 2019-12-23T17:59:50.000+01:00
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
@@ -1,4 +1,4 @@
-name: 'Pull Request Labeler'
+name: 'PR Labeler'
 on:
   - pull_request
 
diff --git a/.github/workflows/vm-coverage.yml b/.github/workflows/vm-coverage.yml
@@ -1,4 +1,4 @@
-name: vm-coverage
+name: 'VM Coverage'
 on: [push, pull_request]
 jobs:
   coverage:
@@ -21,9 +21,8 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
 
       - run: npm run coverage
-      - run: npm run coveralls
 
-      - name: Post coverage data to coveralls.io for analysis
+      - name: Post coverage data to Coveralls
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/vm-lint.yml b/.github/workflows/vm-lint.yml
@@ -1,4 +1,4 @@
-name: vm-lint
+name: 'VM Lint'
 on: [push, pull_request]
 jobs:
   lint:
diff --git a/.github/workflows/vm-nightly-test.yml b/.github/workflows/vm-nightly-test.yml
@@ -1,4 +1,4 @@
-name: vm-nightly-test # without caching
+name: 'VM Nightly Test' # without caching
 on:
   schedule:
     - cron: '0 0 * * *' # once a day at midnight
@@ -9,55 +9,47 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 8.x
-
       - uses: actions/checkout@v1
-
       - run: npm install
-
-      - run: npm run testAPI
+      - run: npm run test:API
         env:
           CI: true
-
-      - run: npm run testAPI:browser
+      - run: npm run test:API:browser
         env:
           CI: true
 
   test-state:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        hardfork: ['Byzantium', 'Constantinople', 'Petersburg', 'Istanbul']
-
     steps:
       - uses: actions/setup-node@v1
         with:
           node-version: 8.x
-
       - uses: actions/checkout@v1
-
       - run: npm install
-
-      - name: Run ${{ matrix.hardfork }} state tests
-        run: npm run ${{ format('testState{0}', matrix.hardfork) }}
+      - run: npm run test:state:allForks
         env:
           CI: true
 
   test-blockchain:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        hardfork: ['', 'Petersburg']
-
     steps:
       - uses: actions/setup-node@v1
         with:
           node-version: 8.x
-
       - uses: actions/checkout@v1
-
       - run: npm install
+      - run: npm run test:blockchain
+        env:
+          CI: true
 
-      - name: Run ${{ matrix.hardfork }} blockchain state tests
-        run: npm run ${{ format('testBlockchain{0}', matrix.hardfork) }}
+  slow-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 8.x
+      - uses: actions/checkout@v1
+      - run: npm install
+      - run: npm run test:state:slow
         env:
           CI: true
diff --git a/.github/workflows/vm-test.yml b/.github/workflows/vm-test.yml
@@ -1,4 +1,4 @@
-name: vm-test
+name: 'VM Test'
 on: [push, pull_request]
 jobs:
   test-api:
@@ -20,20 +20,16 @@ jobs:
       - run: npm install
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
 
-      - run: npm run testAPI
+      - run: npm run test:API
         env:
           CI: true
 
-      - run: npm run testAPI:browser
+      - run: npm run test:API:browser
         env:
           CI: true
 
   test-state:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        hardfork: ['Byzantium', 'Constantinople', 'Petersburg', 'Istanbul']
-
     steps:
       - uses: actions/setup-node@v1
         with:
@@ -51,17 +47,12 @@ jobs:
       - run: npm install
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
 
-      - name: Run ${{ matrix.hardfork }} state tests
-        run: npm run ${{ format('testState{0}', matrix.hardfork) }}
+      - run: npm run test:state:allForks
         env:
           CI: true
 
   test-blockchain:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        hardfork: ['', 'Petersburg']
-
     steps:
       - uses: actions/setup-node@v1
         with:
@@ -79,7 +70,6 @@ jobs:
       - run: npm install
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
 
-      - name: Run ${{ matrix.hardfork }} blockchain state tests
-        run: npm run ${{ format('testBlockchain{0}', matrix.hardfork) }}
+      - run: npm run test:blockchain
         env:
           CI: true
diff --git a/developer.md b/developer.md
@@ -4,49 +4,61 @@
 
 ### Running Tests
 
-Tests can be found in the `tests` directory, with `FORK_CONFIG` set in `tests/tester.js`. There are test runners for [State tests](http://www.ethdocs.org/en/latest/contracts-and-transactions/ethereum-tests/state_tests/index.html) and [Blockchain tests](http://www.ethdocs.org/en/latest/contracts-and-transactions/ethereum-tests/blockchain_tests/index.html). VM tests are disabled since Frontier gas costs are not supported any more. Tests are then executed by the [ethereumjs-testing](https://github.com/ethereumjs/ethereumjs-testing) utility library using the official client-independent [Ethereum tests](https://github.com/ethereum/tests).
+Tests can be found in the `tests` directory. There are test runners for [State tests](http://www.ethdocs.org/en/latest/contracts-and-transactions/ethereum-tests/state_tests/index.html) and [Blockchain tests](http://www.ethdocs.org/en/latest/contracts-and-transactions/ethereum-tests/blockchain_tests/index.html). VM tests are disabled since Frontier gas costs are not supported any more. Tests are then executed by the [ethereumjs-testing](https://github.com/ethereumjs/ethereumjs-testing) utility library using the official client-independent [Ethereum tests](https://github.com/ethereum/tests).
 
-For a wider picture about how to use tests to implement EIPs you can have a look at this [reddit post](https://www.reddit.com/r/ethereum/comments/6kc5g3/ethereumjs_team_is_seeking_contributors/)
-or the associated YouTube video introduction to [core development with Ethereumjs-vm](https://www.youtube.com/watch?v=L0BVDl6HZzk&feature=youtu.be).
+For a wider picture about how to use tests to implement EIPs you can have a look at this [Reddit post](https://www.reddit.com/r/ethereum/comments/6kc5g3/ethereumjs_team_is_seeking_contributors/)
+or the associated YouTube video introduction to [Core Development with Ethereumjs-vm](https://www.youtube.com/watch?v=L0BVDl6HZzk).
 
 #### Running different Test Types
 
 Running the State tests:
 
-`node ./tests/tester -s`
+`node ./tests/tester --state`
 
 Running the Blockchain tests:
 
-`node ./tests/tester -b`
+`node ./tests/tester --blockchain`
 
-State tests and Blockchain tests can also be run against the `dist` folder (default: `lib`):
+Tests run against source by default. They can be run with the `--dist` flag:
 
-`node ./tests/tester -b --dist`
+`npm run build:dist && node ./tests/tester --state --dist`
+
+See `package.json` for all the scripts in the `test:` namespace, such as `npm run test:state` which would execute the above.
+
+Use `--fork` to pass in the desired hardfork:
+
+`node ./tests/tester --state --fork='Constantinople'`
+
+or
+
+`npm run test:state -- --fork='Constantinople'`
+
+By default it is set to use the latest hardfork (`FORK_CONFIG` in `tests/tester.js`).
 
 State tests run significantly faster than Blockchain tests, so it is often a good choice to start fixing State tests.
 
 #### Running Specific Tests
 
 Running all the blockchain tests in a file:
 
-`node ./tests/tester -b --file='randomStatetest303'`
+`node ./tests/tester --blockchain --file='randomStatetest303'`
 
 Running tests from a specific directory:
 
-`node ./tests/tester -b --dir='bcBlockGasLimitTest'`
+`node ./tests/tester --blockchain --dir='bcBlockGasLimitTest'`
 
 Running a specific state test case:
 
-`node ./tests/tester -s --test='stackOverflow'`
+`node ./tests/tester --state --test='stackOverflow'`
 
 Only run test cases with selected `data`, `gas` and/or `value` values (see
 [attribute description](http://ethereum-tests.readthedocs.io/en/latest/test_types/state_tests.html) in
 test docs), provided by the index of the array element in the test `transaction` section:
 
-`node tests/tester -s --test='CreateCollisionToEmpty' --data=0 --gas=1 --value=0`
+`node ./tests/tester --state --test='CreateCollisionToEmpty' --data=0 --gas=1 --value=0`
 
 Run a state test from a specified source file not under the `tests` directory:
-`node ./tests/tester -s --customStateTest='{path_to_file}'`
+`node ./tests/tester --state --customStateTest='{path_to_file}'`
 
 #### Running tests with a reporter/formatter
 
@@ -58,7 +70,7 @@ To pipe the results of the API tests through `tap-spec`:
 
 To pipe the results of tests run with a node command through `tap-spec`:
 
-`npm run formatTest -- -t "./tests/tester -b --dir='bcBlockGasLimitTest'"`
+`npm run formatTest -- -t "./tests/tester --blockchain --dir='bcBlockGasLimitTest'"`
 
 The `-with` flag allows the specification of a formatter of your choosing:
 
@@ -72,18 +84,18 @@ can be found in `tests/tester.js`. By default tests from all skip lists are omit
 
 You can change this behaviour with:
 
-`node tests/tester -s --skip=BROKEN,PERMANENT`
+`node ./tests/tester --state --skip=BROKEN,PERMANENT`
 
 to skip only the `BROKEN` and `PERMANENT` tests and include the `SLOW` tests.
 There are also the keywords `NONE` or `ALL` for convenience.
 
 It is also possible to only run the tests from the skip lists:
 
-`node tests/tester -s --runSkipped=SLOW`
+`node ./tests/tester --state --runSkipped=SLOW`
 
 ### CI Test Integration
 
-Tests are run on [Actions](https://github.com/ethereumjs/ethereumjs-vm/actions) on every PR, configuration can be found in `.github/workflows`.
+Tests and checks are run in CI using [Github Actions](https://github.com/ethereumjs/ethereumjs-vm/actions). The configuration can be found in `.github/workflows`.
 
 ### Debugging
 
@@ -93,7 +105,7 @@ For state tests you can use the `--jsontrace` flag to output opcode trace inform
 
 Blockchain tests support `--debug` to verify the postState:
 
-`node ./tests/tester -b --debug --test='ZeroValue_SELFDESTRUCT_ToOneStorageKey_OOGRevert_d0g0v0_EIP158'`
+`node ./tests/tester --blockchain --debug --test='ZeroValue_SELFDESTRUCT_ToOneStorageKey_OOGRevert_d0g0v0_EIP158'`
 
 All/most State tests are replicated as Blockchain tests in a `GeneralStateTests` [sub directory](https://github.com/ethereum/tests/tree/develop/BlockchainTests/GeneralStateTests) in the Ethereum tests repo, so for debugging single test cases the Blockchain test version of the State test can be used.
 
@@ -125,8 +137,8 @@ An extremely rich and powerful toolbox is the [evmlab](https://github.com/holima
 
 ## Profiling
 
-[Clinic](https://github.com/nearform/node-clinic) Allows profiling the VM in the node environment. It supports various profiling methods, among them is [flame](https://github.com/nearform/node-clinic-flame) which can be used for generating flamegraphs to highlight bottlenecks and hot paths. As an example, to generate a flamegraph for the VM blockchain tests, you can run:
+[Clinic](https://github.com/nearform/node-clinic) allows profiling the VM in the node environment. It supports various profiling methods, among them is [flame](https://github.com/nearform/node-clinic-flame) which can be used for generating flamegraphs to highlight bottlenecks and hot paths. As an example, to generate a flamegraph for the VM blockchain tests, you can run:
 
 ```sh
-NODE_OPTIONS="--max-old-space-size=4096" clinic flame -- node ./tests/tester.js -b --excludeDir='GeneralStateTests'
+NODE_OPTIONS="--max-old-space-size=4096" clinic flame -- node ./tests/tester.js --blockchain --excludeDir='GeneralStateTests'
 ```
diff --git a/package.json b/package.json
@@ -10,21 +10,18 @@
   "scripts": {
     "build:dist": "ethereumjs-config-build",
     "prepublishOnly": "npm run lint && npm run build:dist && npm run testBuildIntegrity",
-    "coverage": "nyc npm run coverageTests && nyc report --reporter=text-lcov > .nyc_output/lcov.info",
-    "coverageTests": "npm run build:dist && tape './tests/api/**/*.js' ./tests/tester.js -s --dist",
+    "coverage": "nyc npm run coverage:test && nyc report --reporter=text-lcov > .nyc_output/lcov.info",
+    "coverage:test": "npm run build:dist && tape './tests/api/**/*.js' ./tests/tester.js --state --dist",
     "coveralls": "npm run coverage && if [ -n \"$COVERALLS_REPO_TOKEN\" ]; then coveralls <.nyc_output/lcov.info; fi",
     "docs:build": "typedoc lib",
-    "testVM": "node ./tests/tester -v",
-    "testStateByzantium": "npm run build:dist && node ./tests/tester -s --fork='Byzantium' --dist",
-    "testStateConstantinople": "npm run build:dist && node ./tests/tester -s --fork='Constantinople' --dist",
-    "testStatePetersburg": "npm run build:dist && node ./tests/tester -s --fork='Petersburg' --dist",
-    "testStateIstanbul": "npm run build:dist && node ./tests/tester -s --fork='Istanbul' --dist",
-    "testBuildIntegrity": "npm run build:dist && node ./tests/tester -s --dist --test='stackOverflow'",
-    "testBlockchain": "npm run build:dist && node --stack-size=1500 ./tests/tester -b --fork='Istanbul' --dist --excludeDir='GeneralStateTests'",
-    "testBlockchainPetersburg": "npm run build:dist && node --stack-size=1500 ./tests/tester -b --fork='Petersburg' --dist --excludeDir='GeneralStateTests'",
-    "testBlockchainGeneralStateTests": "npm run build:dist && node --stack-size=1500 ./tests/tester -b --dist --dir='GeneralStateTests'",
-    "testAPI": "npm run build:dist && tape './tests/api/**/*.js'",
-    "testAPI:browser": "npm run build:dist && karma start karma.conf.js",
+    "test:vm": "node ./tests/tester --vm",
+    "test:state": "npm run build:dist && node ./tests/tester --state --dist",
+    "test:state:allForks": "npm run test:state -- --fork=Byzantium && npm run test:state -- --fork=Constantinople && npm run test:state -- --fork=Petersburg && npm run test:state -- --fork=Istanbul",
+    "test:state:slow": "npm run test:state -- --runSkipped=slow",
+    "test:buildIntegrity": "npm run test:state -- --test='stackOverflow'",
+    "test:blockchain": "npm run build:dist && node --stack-size=1500 ./tests/tester --blockchain --dist",
+    "test:API": "npm run build:dist && tape './tests/api/**/*.js'",
+    "test:API:browser": "npm run build:dist && karma start karma.conf.js",
     "test": "echo \"[INFO] Generic test cmd not used. See package.json for more specific test run cmds.\"",
     "tslint": "ethereumjs-config-tslint",
     "tslint:fix": "ethereumjs-config-tslint-fix",
diff --git a/tests/tester.js b/tests/tester.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: 'Pull Request Labeler'`
	`1`	`+name: 'PR Labeler'`
`2`	`2`	`on:`
`3`	`3`	`- pull_request`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: vm-lint`
	`1`	`+name: 'VM Lint'`
`2`	`2`	`on: [push, pull_request]`
`3`	`3`	`jobs:`
`4`	`4`	`lint:`