Skip to content

Commit

Permalink
Merge pull request #196 from AElfProject/chore/initial-component-testing
Browse files Browse the repository at this point in the history
Chore/initial component testing
  • Loading branch information
aelf-lxy authored Nov 25, 2024
2 parents 1143bc4 + d78e818 commit 606551b
Show file tree
Hide file tree
Showing 22 changed files with 610 additions and 143 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

strategy:
matrix:
package: [utils, base, react]
package: [utils, base, react, bridge]

steps:
- name: Checkout repository
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-badge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
package: [utils, base, react]
package: [utils, base, react, bridge]
steps:
- name: Run frontend CI
uses: AElfProject/[email protected]
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
| --- | --- | --- |
| @aelf-web-login/utils | ![GitHub Workflow Test Status](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/AElfProject/aelf-web-login/feature/badge-json/master-utils-test-results.json) | [![Coverage](https://aelfproject.github.io/aelf-web-login/coverage-utils/badge.svg)](https://github.com/AElfProject/aelf-web-login/actions) |
| @aelf-web-login/base | ![GitHub Workflow Test Status](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/AElfProject/aelf-web-login/feature/badge-json/master-base-test-results.json) | [![Coverage](https://aelfproject.github.io/aelf-web-login/coverage-base/badge.svg)](https://github.com/AElfProject/aelf-web-login/actions) |
| @aelf-web-login/bridge | ![GitHub Workflow Test Status](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/AElfProject/aelf-web-login/feature/badge-json/master-bridge-test-results.json) | [![Coverage](https://aelfproject.github.io/aelf-web-login/coverage-bridge/badge.svg)](https://github.com/AElfProject/aelf-web-login/actions) |
| @aelf-web-login/react | ![GitHub Workflow Test Status](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/AElfProject/aelf-web-login/feature/badge-json/master-react-test-results.json) | [![Coverage](https://aelfproject.github.io/aelf-web-login/coverage-react/badge.svg)](https://github.com/AElfProject/aelf-web-login/actions) |

# Install
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@
"eslint-plugin-unused-imports": "^3.0.0",
"father": "^4.3.8",
"husky": "^8.0.3",
"jest-canvas-mock": "^2.5.2",
"jest-transform-stub": "^2.0.0",
"jsdom": "^23.0.1",
"lint-staged": "^15.2.0",
"prettier": "^3.1.1",
Expand Down
3 changes: 3 additions & 0 deletions packages/bridge/coverage/coverage-summary.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{"total": {"lines":{"total":22,"covered":20,"skipped":0,"pct":90.9},"statements":{"total":27,"covered":22,"skipped":0,"pct":81.48},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"branches":{"total":5,"covered":5,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
,"/Users/aelf/Documents/Projects/aelf/aelf-web-login/packages/bridge/src/utils.ts": {"lines":{"total":22,"covered":20,"skipped":0,"pct":90.9},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":27,"covered":22,"skipped":0,"pct":81.48},"branches":{"total":5,"covered":5,"skipped":0,"pct":100}}
}
13 changes: 13 additions & 0 deletions packages/bridge/jest-report.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="jest tests" tests="4" failures="0" errors="0" time="0.919">
<testsuite name="getCaContractBase()" errors="0" failures="0" skipped="0" timestamp="2024-11-25T04:09:22" time="0.576" tests="4">
<testcase classname="getCaContractBase() should throw error about chain is not running" name="getCaContractBase() should throw error about chain is not running" time="0.002">
</testcase>
<testcase classname="getCaContractBase() should get back contract base" name="getCaContractBase() should get back contract base" time="0.001">
</testcase>
<testcase classname="getIsManagerReadOnly() should throw error about chain is not running" name="getIsManagerReadOnly() should throw error about chain is not running" time="0">
</testcase>
<testcase classname="getIsManagerReadOnly() should return false" name="getIsManagerReadOnly() should return false" time="0.004">
</testcase>
</testsuite>
</testsuites>
206 changes: 206 additions & 0 deletions packages/bridge/jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-nocheck skip tsc for jest
/**
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/configuration
*/

import { compilerOptions } from '../../tsconfig.base.json';
import path from 'path';
const config = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/46/f0k6l2594mg21yh77r2msl8w0000gn/T/jest_dx",

// Automatically clear mock calls, instances, contexts and results before every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
collectCoverage: true,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,

// The directory where Jest should output its coverage files
coverageDirectory: 'coverage',

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// Indicates which provider should be used to instrument code for coverage
// coverageProvider: "babel",

// A list of reporter names that Jest uses when writing coverage reports
coverageReporters: ['json-summary', 'text'],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": false
// },

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: 'babel-jest',

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
reporters: [
'default',
[
'jest-junit',
{
outputDirectory: '.',
outputName: 'jest-report.xml',
},
],
],

// Automatically reset mock state before every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state and implementation before every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: './',

// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test

// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
// testMatch: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: undefined,

// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",

// A map from regular expressions to paths to transformers
transform: {
'^.+\\.(t|j)sx?$': '@swc/jest',
},
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
transformIgnorePatterns: [
'.pnpm/node_modules/(?!((jest-)?react-native(-.*)?|@react-native(-community)?|victory(-.*)?|uuid)|react-navigation|@shopify/react-native-skia|@react-navigation/.*/)',
],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
roots: ['<rootDir>'],
testEnvironment: 'jsdom',
setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
modulePaths: ['./', compilerOptions.baseUrl],
moduleDirectories: ['node_modules', 'src'],
moduleNameMapper: {
'\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|css|less|scss|sass)$':
'jest-transform-stub',
...Object.keys(compilerOptions.paths).reduce(
(prev, k) => ({
...prev,
[k]: path.resolve(__dirname, `../../${compilerOptions.paths[k][0]}`),
}),
{},
),
},
};

export default config;
23 changes: 23 additions & 0 deletions packages/bridge/jest.setup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { type TChainId } from '@aelf-web-login/wallet-adapter-base';
import '@testing-library/jest-dom';
jest.mock('@aelf-web-login/wallet-adapter-portkey-aa', () => ({
PortkeyAAWallet: jest.fn(),
}));
jest.mock('@portkey/did-ui-react', () => ({
getChainInfo: (c: TChainId) => (!c ? null : {}),
did: {
didWallet: {
managementAccount: {
privateKey: '',
},
},
},
}));
jest.mock('lottie-web');
jest.mock('@portkey/utils');
import 'jest-canvas-mock';
global.fetch = require('node-fetch');
import { TextEncoder, TextDecoder } from 'util';
global.TextEncoder = TextEncoder;
// @ts-expect-error TextDecoder
global.TextDecoder = TextDecoder;
13 changes: 10 additions & 3 deletions packages/bridge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,31 @@
],
"scripts": {
"dev": "father dev",
"build": "father build"
"build": "father build",
"test": "NODE_OPTIONS='$NODE_OPTIONS --experimental-vm-modules' jest",
"test:dev": "pnpm test -- --watch",
"test:coverage": "pnpm test -- --coverage",
"test:debug": "pnpm test -- --detectOpenHandles"
},
"dependencies": {
"@aelf-web-login/wallet-adapter-base": "workspace:*",
"@portkey/services": "^2.15.9",
"@portkey/contracts": "^2.15.9",
"@portkey/services": "^2.15.9",
"@reduxjs/toolkit": "^2.2.3",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@portkey/types": "^2.15.9",
"@portkey/did-ui-react": "^2.15.9",
"@portkey/types": "^2.15.9",
"@portkey/utils": "^2.15.9",
"@swc/core": "^1.9.3",
"@swc/jest": "^0.2.37",
"@types/react": "^18.3.1",
"@types/react-dom": "^18.3.0",
"antd": "4.24.14",
"father": "^4.3.8",
"jest": "^29.7.0",
"typescript": "^5.3.3"
},
"peerDependencies": {
Expand Down
48 changes: 48 additions & 0 deletions packages/bridge/src/__tests__/utils.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { type TChainId } from '@aelf-web-login/wallet-adapter-base';
import { getCaContractBase, getIsManagerReadOnly } from '../utils';
import { getContractBasic } from '@portkey/contracts';

afterEach(() => {
jest.unmock('@portkey/contracts');
});
jest.mock('@portkey/contracts', () => ({
getContractBasic: jest.fn(),
}));

describe('getCaContractBase()', () => {
it('should throw error about chain is not running', async () => {
const chainId = null;
try {
await getCaContractBase(chainId as unknown as TChainId);
} catch (error) {
expect(error).toBeInstanceOf(Error);
expect(error).toHaveProperty('message', `Chain is not running: ${chainId}`);
}
});
it('should get back contract base', async () => {
const chainId: TChainId = 'tDVW';
const mockContractBase = {
chainId,
address: '',
};
(getContractBasic as jest.Mock).mockImplementation(() => mockContractBase);
const contractBase = await getCaContractBase(chainId);
expect(contractBase).toMatchObject(mockContractBase);
});
});

describe('getIsManagerReadOnly()', () => {
it('should throw error about chain is not running', async () => {
const chainId = null;
try {
await getIsManagerReadOnly(chainId as unknown as TChainId);
} catch (error) {
expect(error).toBeInstanceOf(Error);
expect(error).toHaveProperty('message', `Chain is not running: ${chainId}`);
}
});
it('should return false', async () => {
const r = await getIsManagerReadOnly('tDVV');
expect(r).toBeFalsy();
});
});
6 changes: 2 additions & 4 deletions packages/bridge/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const EE = new EventEmitter();
export const SET_GUARDIAN_APPROVAL_MODAL = 'SET_GUARDIAN_APPROVAL_MODAL';
export const SET_GUARDIAN_APPROVAL_PAYLOAD = 'SET_GUARDIAN_APPROVAL_PAYLOAD';

const getCaContractBase = async (chainId: TChainId) => {
export const getCaContractBase = async (chainId: TChainId) => {
const chainInfo = await getChainInfo(chainId);
if (!chainInfo) {
throw new Error(`Chain is not running: ${chainId}`);
Expand All @@ -21,7 +21,7 @@ const getCaContractBase = async (chainId: TChainId) => {
return caContract;
};

const getIsManagerReadOnly = async (chainId: TChainId, caHash = '', manager = '') => {
export const getIsManagerReadOnly = async (chainId: TChainId, caHash = '', manager = '') => {
const caIns = await getCaContractBase(chainId);
try {
const rs = await caIns.callViewMethod('IsManagerReadOnly', {
Expand All @@ -35,5 +35,3 @@ const getIsManagerReadOnly = async (chainId: TChainId, caHash = '', manager = ''
return false;
}
};

export { getIsManagerReadOnly };
1 change: 0 additions & 1 deletion packages/react/empty.js

This file was deleted.

Loading

0 comments on commit 606551b

Please sign in to comment.