test: add e2e test

.github/workflows/e2e.yaml

@@ -0,0 +1,108 @@
+name: E2E Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: restore dependencies
+        uses: actions/cache@v3
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+
+      - name: start nexus web web
+        id: startWeb
+        if: success() || failure()
+        run: |
+          cd /home/runner/work/nexus/nexus/e2e/packages/nexus-web
+          npm i
+          npm run start > node.log 2>&1 &
+
+      - name: test
+        id: test
+        if: success() || failure()
+        run: |
+          cd /home/runner/work/nexus/nexus/e2e/packages/e2e
+          npm i
+          npm run build
+          xvfb-run --auto-servernum npm run jest
+      - name: make update file  dir
+        if: success() || failure()
+        run: |
+          mkdir /home/runner/work/nexus/nexus/reportAndNexus
+      - name: cp nexus file to update file
+        if: success() || failure()
+        run: |
+          tar -zcvf /home/runner/work/nexus/nexus/reportAndNexus/build.tar.gz /home/runner/work/nexus/nexus/packages/extension-chrome/build
+
+      - name: package report
+        id: package
+        if: success() || failure()
+        run: |
+          tar -zcvf /home/runner/work/nexus/nexus/reportAndNexus/allure-results.tar.gz  /home/runner/work/nexus/nexus/e2e/packages/e2e/allure-results
+
+      - name: Publish e2e test report and nexus build
+        if: success() || failure()
+        uses: actions/upload-artifact@v2
+        with:
+          name: jfoa-build-reports-${{ runner.os }}
+          path: /home/runner/work/nexus/nexus/reportAndNexus
+
+      - name: cp report
+        id: cp-report
+        if: success() || failure()
+        run: |
+          cd /home/runner/work/nexus/nexus
+          cp -r /home/runner/work/nexus/nexus/e2e/packages/e2e/allure-results .
+
+      - name: Get Allure history
+        uses: actions/checkout@v2
+        if: always()
+        continue-on-error: true
+        with:
+          ref: gh-pages
+          repository: gpBlockchain/nexus-e2e-report
+          path: gh-pages
+
+      - name: Allure Report action from marketplace
+        uses: simple-elf/allure-report-action@master
+        if: always()
+        #id: allure-report
+        with:
+          allure_results: /home/runner/work/nexus/nexus/allure-results
+          github_repo: gpBlockchain/nexus-e2e-report
+          github_repo_owner: ${{ github.repository_owner }}
+          gh_pages: gh-pages
+          #allure_report: allure-report
+          allure_history: allure-history
+          keep_reports: 20
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        if: always()
+        with:
+          token: ${{ secrets.PERSON_TOKEN }}
+          folder: allure-history # The folder the action should deploy.
+          repository-name: gpBlockchain/nexus-e2e-report
+          branch: gh-pages
+
+      - name: Cat report Link
+        if: always()
+        run: |
+          cat allure-history/index.html

e2e/packages/e2e/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+# editorconfig-tools is unable to ignore longs strings or urls
+max_line_length = off

e2e/packages/e2e/.eslintignore

@@ -0,0 +1 @@
+build

e2e/packages/e2e/.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+  root: true,
+  extends: ['react-app'],
+  parserOptions: {
+    ecmaVersion: 2020,
+    project: ['tsconfig.json', 'tsconfig.test.json'],
+    sourceType: 'module',
+  },
+  rules: {
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        varsIgnorePattern: '^_',
+        argsIgnorePattern: '^_',
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: '*.{ts,tsx}',
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'error',
+        '@typescript-eslint/explicit-module-boundary-types': 'error',
+        '@typescript-eslint/no-floating-promises': 'error',
+        'no-console': 'warn',
+        '@typescript-eslint/no-throw-literal': 'error',
+      },
+    },
+  ],
+};

e2e/packages/e2e/.prettierignore

@@ -0,0 +1,4 @@
+lumos
+
+# auto generated
+docs/rpc.md

e2e/packages/e2e/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "arrowParens": "always"
+}

e2e/packages/e2e/README.md

@@ -0,0 +1,140 @@
+# e2e
+
+E2E testing for dApps using playwright + Nexus
+
+## Usage
+
+open `nexus` extension page, connect web with `nexus`
+
+```javascript
+const nexusExtensionPath = './build';
+const browser = await launchWithNexus({ nexusPath: nexusExtensionPath });
+const nexusWallet = await setUpNexus(browser, { mock: true });
+const page = await browser.newPage();
+await page.goto('https://nexus-e2e.vercel.app/', {});
+await page.click('#connectButton');
+await nexusWallet.connect();
+```
+
+nexus methods
+
+```javascript
+export type NexusLaunchOptions = {
+  nexusPath: string,
+  playwrightOptions?: playWrightLaunchOpt,
+};
+
+export type NexusSetUpOptions = {
+  mock?: boolean,
+  userName: string,
+  passwd: string,
+  seed?: string,
+};
+
+export type AddNetworkOpt = {
+  name: string,
+  url: string,
+};
+export type PopupPageHelper = {
+  getNewPage: () => Promise<Page>,
+  queryWhitelist: () => Promise<string[]>,
+  removeWhitelistBySearch: (search: string) => void,
+  queryNetworkList: () => Promise<string[]>,
+  addNetwork: (addNetworkOpt: AddNetworkOpt) => void,
+  removeNetworkByName: (name: string) => void,
+  changeNetworkByName: (name: string) => void,
+  queryConnected: () => Promise<boolean>,
+  queryNickName: () => Promise<string>,
+};
+
+export type WalletManagerHelper = {
+  getNewPage: () => Promise<Page>,
+  importWallet: (page: Page, userName: string, mnemonic: string, password: string) => void,
+  createANewWallet: (page: Page, userName: string, password: string) => Promise<string>,
+};
+export type NexusWallet = {
+  popup: PopupPageHelper,
+  approve: (passwd: string) => void,
+  connect: () => void,
+  cancel: () => void,
+  walletManager: WalletManagerHelper,
+  getNotificationPage: () => Promise<Page>,
+  close: () => void,
+};
+```
+
+## Run E2E Test
+
+run test after [start nexus-e2e-web](../nexus-web/README.md)
+
+#### start nexus web
+
+```shell
+cd e2e/packages/nexus-web
+npm i
+npm run start
+```
+
+# build nexus
+
+```shell
+cd e2e/packages/e2e
+npm i
+npm run build
+```
+
+# run test
+
+```shell
+npm run jest
+
+```
+
+### notice
+
+After executing the test case, the browser will save persistent data in the `e2e/packages/e2e/tmp` directory.
+
+# cat local allure reporter after test
+
+```
+cd e2e/packages/e2e
+allure serve allure-results
+```
+
+# CI Logic
+
+ci file: e2e.yaml
+
+Execution Steps:
+
+- Start nexus-web test site.
+- Compile nexus plugin wallet.
+- Run test cases.
+- Push the report to nexus-e2e-reporter.
+
+Execution Time:
+
+- pull_request
+- merge_request
+
+Environment Variable:
+
+- PERSON_TOKEN (Personal Access Token (PAT))
+
+### How to add Personal Access Token
+
+##### generate Personal Access Token
+
+- click: https://github.com/settings/tokens
+
+![img.png](imgs/img.png)
+
+- Add PAT(Personal Access Token) to Repository Secrets
+
+![img.png](imgs/img1.png)
+
+### View the test report
+
+![img.png](imgs/img_1.png)
+![img.png](imgs/img_2.png)
+![img.png](imgs/img_3.png)

e2e/packages/e2e/__tests__/config/config.ts

@@ -0,0 +1,10 @@
+export const MNEMONIC = 'abandon ability able about above absent absorb abstract absurd abuse access accident';
+export const USER_NAME = 'xm';
+export const PASS_WORD = '1231231231231';
+// export const NEXUS_WEB_URL = "https://nexus-e2e.vercel.app/"
+export const NEXUS_WEB_URL = 'http://localhost:3000/';
+export const NEXUS_WEB_LOCAL_URL = 'http://localhost:3000/';
+export const FULL_OWNERSHIP = 'fullOwnership';
+export const RULE_BASED_OWNERSHIP = 'ruleBasedOwnership';
+export const CKB_RPC = 'https://testnet.ckbapp.dev';
+export const NEXUS_BUILD_PATH = './build';

e2e/packages/e2e/__tests__/env.test.ts

@@ -0,0 +1,7 @@
+import { setCommitHashToReport } from './util';
+
+describe('get Env', function () {
+  it('get nexus version', async () => {
+    await setCommitHashToReport();
+  });
+});