Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: example add test case #303

Merged
merged 2 commits into from
Feb 1, 2024
Merged

feat: example add test case #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26984df
chore: example optimized code
ByteZhang1024 Jan 31, 2024
e8b056d
feat: example variant address、pubkey test
ByteZhang1024 Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...-examples/expo-example/src/components/BaseTestRunner/Context/TestRunnerVerifyProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ import { useCallback, useMemo, useState } from 'react';
import { createContext } from 'use-context-selector';
import { VerifyState } from '../types';

export type ItemVerifyState = { verify: VerifyState; error?: string };

export const TestRunnerVerifyContext = createContext<{
setItemVerifyState: (key: string, newState: { verify: VerifyState; error?: string }) => void;
itemVerifyState: { [key: string]: { verify: VerifyState; error?: string } };
itemVerifyState: { [key: string]: ItemVerifyState };
clearItemVerifyState: () => void;
}>({
setItemVerifyState: () => {},
Expand Down
90 changes: 90 additions & 0 deletions packages/connect-examples/expo-example/src/components/BaseTestRunner/useExportReport.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import { useEffect, useState } from 'react';
import { useContextSelector } from 'use-context-selector';
import { TestRunnerContext } from './Context/TestRunnerProvider';
import { ItemVerifyState, TestRunnerVerifyContext } from './Context/TestRunnerVerifyProvider';
import { TestCaseDataWithKey } from './types';
import { getDeviceInfo } from './utils';
import { downloadFile } from '../../utils/downloadUtils';

export default function useExportReport<T>({
fileName = 'TestReport',
reportTitle = 'Test Report',
customReport,
}: {
fileName: string;
reportTitle: string;
customReport: (
items: TestCaseDataWithKey<T>[],
itemVerifyState: { [key: string]: ItemVerifyState }
) => Promise<string[]>;
}) {
const runnerInfo = useContextSelector(TestRunnerContext, v => v);
const runnerVerify = useContextSelector(TestRunnerVerifyContext, v => v);

const [showExportReport, setShowExportReport] = useState(false);

useEffect(() => {
setShowExportReport(!!runnerInfo.runnerDone);
}, [runnerInfo.runnerDone]);

const exportReport = async () => {
const {
runnerTestCaseTitle,
timestampBeginTest,
timestampEndTest,
itemValues,
runningDeviceFeatures,
} = runnerInfo;

const { itemVerifyState } = runnerVerify;

if (!itemVerifyState) return;
if (!timestampBeginTest) return;
if (!timestampEndTest) return;
if (!runningDeviceFeatures) return;

const beginTime = new Date(timestampBeginTest).toLocaleString();
const endTime = new Date(timestampEndTest).toLocaleString();

const allSuccess = itemValues.every(item => {
const caseItem = item as TestCaseDataWithKey<T>;
const { $key } = caseItem;
const state = itemVerifyState?.[$key].verify;
return state === 'success';
});

const markdown = [];
markdown.push(`# ${reportTitle} (${runnerTestCaseTitle})`);
markdown.push(`Status: ${allSuccess ? 'Success' : 'Fail'}\n`);
markdown.push(`Begin Time: ${beginTime}\n`);
markdown.push(`End Time: ${endTime}\n`);
markdown.push(``);

markdown.push(`## Device Info`);
const deviceInfo = getDeviceInfo(runningDeviceFeatures);
markdown.push(`| Key | Value |`);
markdown.push(`| --- | --- |`);
Object.keys(deviceInfo).forEach(key => {
// @ts-expect-error
const value = deviceInfo[key];
if (value) {
markdown.push(`| ${key} | ${value} |`);
}
});
markdown.push(``);

const custom = await customReport(itemValues, itemVerifyState);
markdown.push(...custom);

const testCaseTitle = runnerTestCaseTitle?.replace(/-/g, '_');
const formatTime = new Date(timestampBeginTest).getTime();
const downloadFileName = `${fileName}(${testCaseTitle})${formatTime}.md`;

downloadFile(downloadFileName, markdown.join('\n').toString());
};

return {
showExportReport,
exportReport,
};
}
141 changes: 54 additions & 87 deletions packages/connect-examples/expo-example/src/testTools/addressTest/TestBatchAddress.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
import { useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { Button, Text, View } from 'react-native';
import { CoreMessage, UI_EVENT, UI_REQUEST, UI_RESPONSE } from '@onekeyfe/hd-core';
import { Picker } from '@react-native-picker/picker';

import { useContextSelector } from 'use-context-selector';
import { batchTestCases } from './data';
import { TestRunnerView } from '../../components/BaseTestRunner/TestRunnerView';
import { AddressBatchTestCase } from './types';
import { TestCaseDataWithKey } from '../../components/BaseTestRunner/types';

import passphraseTestCase from './data/count24_two/passphrase_empty';
import { fullPath, replaceTemplate } from './data/utils';
import { useRunnerTest } from '../../components/BaseTestRunner/useRunnerTest';
import { TestRunnerContext } from '../../components/BaseTestRunner/Context/TestRunnerProvider';
import { TestRunnerVerifyContext } from '../../components/BaseTestRunner/Context/TestRunnerVerifyProvider';
import { getDeviceInfo } from '../../components/BaseTestRunner/utils';
import { downloadFile } from '../../utils/downloadUtils';
import useExportReport from '../../components/BaseTestRunner/useExportReport';

type TestCaseDataType = AddressBatchTestCase['data'][0];
type ResultViewProps = { item: TestCaseDataWithKey<TestCaseDataType> };
Expand All @@ -37,94 +33,51 @@ function ResultView({ item }: ResultViewProps) {
}

function ExportReportView() {
const runnerInfo = useContextSelector(TestRunnerContext, v => v);
const runnerVerify = useContextSelector(TestRunnerVerifyContext, v => v);

const exportReport = () => {
const {
runnerTestCaseTitle,
timestampBeginTest,
timestampEndTest,
itemValues,
runningDeviceFeatures,
} = runnerInfo;

const { itemVerifyState } = runnerVerify;

if (!itemVerifyState) return;
if (!timestampBeginTest) return;
if (!timestampEndTest) return;
if (!runningDeviceFeatures) return;

const beginTime = new Date(timestampBeginTest).toLocaleString();
const endTime = new Date(timestampEndTest).toLocaleString();

const allSuccess = itemValues.every(item => {
const caseItem = item as TestCaseDataWithKey<TestCaseDataType>;
const { $key } = caseItem;
const state = itemVerifyState?.[$key].verify;
return state === 'success';
});

const markdown = [];
markdown.push(`# Batch Address Test Report (${runnerTestCaseTitle})`);
markdown.push(`Status: ${allSuccess ? 'Success' : 'Fail'}\n`);
markdown.push(`Begin Time: ${beginTime}\n`);
markdown.push(`End Time: ${endTime}\n`);
markdown.push(``);

markdown.push(`## Device Info`);
const deviceInfo = getDeviceInfo(runningDeviceFeatures);
markdown.push(`| Key | Value |`);
markdown.push(`| --- | --- |`);
Object.keys(deviceInfo).forEach(key => {
// @ts-expect-error
const value = deviceInfo[key];
if (value) {
markdown.push(`| ${key} | ${value} |`);
}
});
markdown.push(``);

markdown.push(`## Test Case`);
markdown.push(`| State | Title | Address |`);
markdown.push(`| --- | --- | --- |`);
itemValues.forEach(item => {
const caseItem = item as TestCaseDataWithKey<TestCaseDataType>;
const { result, $key } = caseItem;
const title = caseItem?.name || caseItem?.title || caseItem?.method;
const state = itemVerifyState?.[$key].verify;

const runnerResult =
state === 'fail' ? itemVerifyState?.[$key].error : JSON.stringify(result);
markdown.push(`| ${state} | ${title} | ${runnerResult} |`);
});

const testCaseTitle = runnerTestCaseTitle?.replace(/-/g, '_');
const formatTime = new Date(timestampBeginTest).toLocaleString().replace(/[-: ]/g, '_');
const fileName = `BatchAddressTestReport(${testCaseTitle})${formatTime}.md`;
const { showExportReport, exportReport } = useExportReport<TestCaseDataType>({
fileName: 'BatchAddressTestReport',
reportTitle: 'Batch Address Test Report',
customReport: (items, itemVerifyState) => {
const markdown: string[] = [];

markdown.push(`## Test Case`);
markdown.push(`| State | Title | Address |`);
markdown.push(`| --- | --- | --- |`);
items.forEach(item => {
const caseItem = item;
const { result, $key } = caseItem;
const title = caseItem?.name || caseItem?.title || caseItem?.method;
const state = itemVerifyState?.[$key].verify;

const runnerResult =
state === 'fail' ? itemVerifyState?.[$key].error : JSON.stringify(result);
markdown.push(`| ${state} | ${title} | ${runnerResult} |`);
});

downloadFile(fileName, markdown.join('\n').toString());
};
return Promise.resolve(markdown);
},
});

if (runnerInfo.runnerDone) {
if (showExportReport) {
return <Button title="Export Report" onPress={exportReport} />;
}

return null;
}

function ExecuteView() {
function ExecuteView({ batchTestCases }: { batchTestCases: AddressBatchTestCase[] }) {
const [testCaseList, setTestCaseList] = useState<string[]>([]);
const [currentTestCase, setCurrentTestCase] = useState<AddressBatchTestCase>();

const [testDescription, setTestDescription] = useState<string>();
const [passphrase, setPassphrase] = useState<string>();

function findTestCase(name: string) {
const testCase = batchTestCases.find(testCase => testCase.name === name);
return testCase;
}
const findTestCase = useCallback(
(name: string) => {
const testCase = batchTestCases.find(testCase => testCase.name === name);
return testCase;
},
[batchTestCases]
);

useEffect(() => {
const testCaseList: string[] = [];
Expand All @@ -133,7 +86,7 @@ function ExecuteView() {
});
setTestCaseList(testCaseList);
setCurrentTestCase(findTestCase(testCaseList[0]));
}, []);
}, [batchTestCases, findTestCase]);

useEffect(() => {
const testCase = currentTestCase;
Expand Down Expand Up @@ -272,7 +225,7 @@ function ExecuteView() {
address[verifyField] !== item.result[key][verifyField]
) {
// @ts-expect-error
error += `actual: ${address[verifyField]}, expected: ${item.result[key][verifyField]}\n`;
error += `(${key}) actual: ${address[verifyField]}, expected: ${item.result[key][verifyField]}\n`;
}
}
}
Expand Down Expand Up @@ -312,17 +265,31 @@ function ExecuteView() {
</View>
</>
),
[beginTest, currentTestCase, passphrase, stopTest, testCaseList, testDescription]
[
beginTest,
currentTestCase?.name,
findTestCase,
passphrase,
stopTest,
testCaseList,
testDescription,
]
);

return contentMemo;
}

export function TestBatchAddress() {
export function TestBatchAddress({
title,
testCases,
}: {
title: string;
testCases: AddressBatchTestCase[];
}) {
return (
<TestRunnerView<AddressBatchTestCase['data']>
title="Batch Address Test"
renderExecuteView={() => <ExecuteView />}
title={title}
renderExecuteView={() => <ExecuteView batchTestCases={testCases} />}
renderResultView={item => <ResultView item={item} />}
/>
);
Expand Down
Loading
Loading