Merge pull request #14 from ChainSafe/wyatt/init-blackbox-tests

Init Black Box Tests

Author: spacesailor24

.eslintignore

@@ -1,6 +1,8 @@
+lib
 dist
 jest.config.js
 webpack.config.js
 .eslintrc.js
 cypress
-cypress.config.js
+cypress.config.js
+test/black_box

.github/workflows/test.yml

@@ -33,10 +33,9 @@ jobs:
                   path: '/tmp/chainlink-plugin-${{ matrix.node }}.js.tar.gz'
             - uses: actions/cache/save@v3
               with:
-                path: |
-                    ~/.cache/Cypress
-                    node_modules
-                key: cypress-${{ runner.os }}-${{ hashFiles('yarn-lock.json') }}
+                  path: |
+                      ~/.cache/Cypress
+                  key: cypress-${{ runner.os }}-${{ hashFiles('yarn.lock') }}
     build-web:
         name: Build Webpack
         needs: build
@@ -95,19 +94,35 @@ jobs:
               if: matrix.browser == 'firefox'
             - uses: actions/download-artifact@v3
               with:
-                name: chainlink-plugin-16.js.tar.gz
-                path: /tmp
+                  name: chainlink-plugin-16.js.tar.gz
+                  path: /tmp
             - run: tar -xf /tmp/chainlink-plugin-16.js.tar.gz -C ./
             - uses: actions/cache@v2
               with:
-                path: |
-                    ~/.cache/Cypress
-                    node_modules
-                key: cypress-${{ runner.os }}-${{ hashFiles('yarn-lock.json') }}
+                  path: |
+                      ~/.cache/Cypress
+                  key: cypress-${{ runner.os }}-${{ hashFiles('yarn.lock') }}
             - run: corepack enable
             - name: Cypress run
               uses: cypress-io/github-action@v5
               with:
                   install: false
                   command: 'yarn run test:e2e:${{ matrix.browser }}'
                   cache-key: node-v16-on-${{ matrix.browser }}-hash-${{ hashFiles('yarn.lock') }}
+    black-box:
+        name: Black Box Tests
+        needs: build
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node:
+                    - 16
+        steps:
+            - uses: actions/download-artifact@v3
+              with:
+                  name: chainlink-plugin-${{ matrix.node }}.js.tar.gz
+                  path: /tmp
+            - run: tar -xf /tmp/chainlink-plugin-${{ matrix.node }}.js.tar.gz -C ./
+            - run: |
+                  yarn test:black-box
+              shell: bash

.gitignore

@@ -36,3 +36,4 @@ tsconfig.tsbuildinfo
 package-lock.json
 
 tmp/
+.npmrc

.prettierignore

@@ -31,6 +31,7 @@ REVISION
 
 # project specific paths
 coverage/
+lib/
 dist/
 tmp/
 browsertest.build/

cypress.config.js

@@ -8,7 +8,7 @@ const config = {
 			return require('./cypress/plugins/index.js')(on, config);
 		},
 		specPattern: 'test/e2e/**/**/*.test.ts',
-		excludeSpecPattern: ['**/contract_defaults_extra.test.ts'],
+		excludeSpecPattern: ['test/black_box/**'],
 	},
 };
 

cypress/webpack.config.js

@@ -1,6 +1,7 @@
 const webpack = require('webpack');
 
 module.exports = {
+	mode: 'development',
 	resolve: {
 		extensions: ['.ts', '.js'],
 	},

package.json

@@ -1,26 +1,32 @@
 {
 	"name": "@chainsafe/web3.js-chainlink-plugin",
-	"version": "0.1.0-alpha.0",
+	"version": "0.1.0",
 	"description": "A Web3.js 4.x Plugin for Interacting With Chainlink Smart Contracts",
-	"main": "dist/index.js",
+	"main": "lib/index.js",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/ChainSafe/web3.js-chainlink-plugin.git"
 	},
 	"author": "ChainSafe Systems",
 	"license": "LGPL-3.0",
 	"private": false,
+	"files": [
+		"lib/**/*"
+	],
 	"scripts": {
 		"build": "tsc --build",
-		"build:check": "node -e \"require('./dist')\"",
+		"build:check": "node -e \"require('./lib')\"",
 		"build:web": "npx webpack",
-		"clean": "rimraf dist",
+		"clean": "rimraf lib",
 		"format": "prettier --write '**/*'",
 		"lint": "eslint --ext .js,.ts .",
 		"lint:fix": "eslint --fix --ext .js,.ts .",
-		"prebuild": "rimraf dist",
+		"post-black-box": "./scripts/black_box_test_helpers.sh stop",
+		"pre-black-box": "./scripts/black_box_test_helpers.sh startBackgroundAndPublish",
+		"prebuild": "rimraf lib",
 		"prepare": "husky install",
 		"test": "jest --config=./test/unit/jest.config.js",
+		"test:black-box": "yarn pre-black-box && ./scripts/black_box_test_helpers.sh runTests",
 		"test:ci": "jest --coverage=true --coverage-reporters=json --verbose",
 		"test:coverage": "jest --config=./test/unit/jest.config.js --coverage=true --coverage-reporters=text",
 		"test:e2e:chrome": "npx cypress run --headless --browser chrome",
@@ -55,6 +61,7 @@
 		"jest": "^28.1.3",
 		"jest-extended": "^3.0.1",
 		"lint-staged": "^13.0.3",
+		"npm-auth-to-token": "^1.0.0",
 		"prettier": "^2.7.1",
 		"prettier-plugin-solidity": "^1.0.0-beta.24",
 		"process": "^0.11.10",

scripts/black_box_test_helpers.sh

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+
+ORIGARGS=("$@")
+
+helpFunction() {
+	echo "Usage: $0 [start|stop|startBackgroundAndPublish|runTests] [background]"
+	exit 1 # Exit script after printing help
+}
+
+start() {
+	. scripts/env.sh
+	if [[ ${ORIGARGS[1]} == "background" ]]; then
+        startBackground
+	else
+		echo "Starting verdaccio..."
+        docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
+	fi
+}
+
+startBackground() {
+    echo "Starting verdaccio in background..."
+    docker run -d --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
+}
+
+stop() {
+	echo "Stopping verdaccio ..."
+    docker ps -q --filter ancestor="verdaccio/verdaccio" | xargs -r docker stop
+}
+
+createVerdaccioNPMUser() {
+    curl -XPUT \
+        -H "Content-type: application/json" \
+        -d '{ "name": "test", "password": "test" }' \
+        'http://localhost:4873/-/user/org.couchdb.user:test'
+}
+
+loginNPMUser() {
+    npx npm-auth-to-token \
+        -u test \
+        -p test \
+        -e [email protected] \
+        -r http://localhost:4873
+}
+
+yarnPublish() {
+    yarn publish \
+        --new-version 9.9.9 \
+        --no-git-tag-version \
+        --tag blackbox \
+        --registry http://localhost:4873
+}
+
+publish() {
+    echo "Publishing to verdaccio ..."
+
+    npx wait-port -t 60000 4873
+
+    createVerdaccioNPMUser
+    loginNPMUser
+    yarn build
+    yarnPublish
+}
+
+startBackgroundAndPublish() {
+    startBackground && publish
+}
+
+runTests() {
+    cd test/black_box
+    yarn --update-checksums
+    yarn install
+    yarn test
+}
+
+case $1 in
+start) start ;;
+stop) stop ;;
+startBackgroundAndPublish) startBackgroundAndPublish ;;
+runTests) runTests ;;
+*) helpFunction ;; # Print helpFunction in case parameter is non-existent
+esac

test/black_box/.yarnrc

@@ -0,0 +1 @@
+registry "http://localhost:4873"

test/black_box/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+	preset: 'ts-jest',
+	testEnvironment: 'node',
+};

test/black_box/package.json

@@ -0,0 +1,20 @@
+{
+	"name": "web3.js_chainlink_plugin_black_box_tests",
+	"version": "1.0.0",
+	"main": "index.js",
+	"author": "ChainSafe Systems",
+	"license": "LGPL-3.0",
+	"scripts": {
+		"test": "jest"
+	},
+	"dependencies": {
+		"@chainsafe/web3.js-chainlink-plugin": "^9.9.9"
+	},
+	"devDependencies": {
+		"jest": "^28.1.3",
+		"ts-jest": "^28.0.7",
+		"web3": "^4.0.1-alpha.5",
+		"web3-core": "^4.0.1-alpha.5",
+		"web3-eth": "^4.0.1-alpha.5"
+	}
+}

test/black_box/test/chainlink_plugin.test.ts

@@ -0,0 +1,49 @@
+import Web3 from 'web3';
+import { Web3Context } from 'web3-core';
+import Web3Eth from 'web3-eth';
+
+// https://github.com/ChainSafe/web3.js-plugin-chainlink/issues/15
+// @ts-ignore
+import { ChainlinkPlugin, MainnetPriceFeeds } from '@chainsafe/web3.js-chainlink-plugin';
+
+describe('ChainlinkPlugin Tests', () => {
+	it('should register ChainlinkPlugin plugin on Web3Context instance', () => {
+		const web3Context = new Web3Context('http://127.0.0.1:8545');
+		web3Context.registerPlugin(new ChainlinkPlugin());
+		expect(web3Context.chainlink).toBeDefined();
+	});
+
+	it('should register ChainlinkPlugin plugin on Web3Eth instance', () => {
+		const web3Eth = new Web3Eth('http://127.0.0.1:8545');
+		web3Eth.registerPlugin(new ChainlinkPlugin());
+		expect(web3Eth.chainlink).toBeDefined();
+	});
+
+	describe('ChainlinkPlugin method tests', () => {
+		let web3Context: Web3;
+		let requestManagerSendSpy: jest.SpyInstance;
+
+		beforeAll(() => {
+			web3Context = new Web3('https://rpc.ankr.com/eth');
+			web3Context.registerPlugin(new ChainlinkPlugin());
+			requestManagerSendSpy = jest.spyOn(web3Context.chainlink.requestManager, 'send');
+		});
+
+		it('should call ChainlinkPlugin.getPrice with expected RPC object', async () => {
+			const result = await web3Context.chainlink.getPrice(MainnetPriceFeeds.LinkEth);
+			expect(Object.keys(result as object)).toEqual(
+				expect.arrayContaining([
+					'roundId',
+					'answer',
+					'startedAt',
+					'updatedAt',
+					'answeredInRound',
+				]),
+			);
+			expect(requestManagerSendSpy).toHaveBeenCalledWith({
+				method: 'eth_call',
+				params: [{ data: '0xfeaf968c', to: MainnetPriceFeeds.LinkEth }, 'latest'],
+			});
+		});
+	});
+});