Add docs folder

This commit is contained in:
Takeshi Kimata
2024-05-12 11:52:59 +09:00
parent 83bf32f54d
commit af7cdb790e
31 changed files with 25598 additions and 0 deletions

View File

@@ -0,0 +1,8 @@
{
"label": "Architecuture",
"position": 2,
"link": {
"type": "generated-index",
"description": "Architecuture"
}
}

View File

@@ -0,0 +1,7 @@
---
sidebar_position: 3
---
# DataBase
![ER](./img/er.svg)

View File

@@ -0,0 +1,17 @@
---
sidebar_position: 2
---
## Functions
## MUST
- Test cases can be managed.
- Multiple people can operate/view apps for team development
## SHOULD
- Easily self host the application (docker?)
- Test case descriptions can be written in markdown.
- Import the results of automated testing tools (Vitest, Google Test...) and test them manually. Import the results of automated testing tools (Vitest, Google Test...) and integrate them with manual test results

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 63 KiB

File diff suppressed because one or more lines are too long

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

View File

@@ -0,0 +1,18 @@
---
sidebar_position: 1
---
# Architecture
Separate the front-end server that provides the UI and the API server that provides the API to make the system loosely coupled.
## Frontend
Create UI with React, Next.js.
## Backend(API server)
It does not generate any views, but only has API functions.
- DB access
- Authentication, authorization

View File

@@ -0,0 +1,36 @@
---
sidebar_position: 4
---
# Integration
We would like to be able to display results not only from manual test management, but also from automated test tools such as Vitest, Google Test, Selenium, etc.
Since the JUnit xml format is the de facto standard, we will import via the xml file. TestPlat itself should also be able to report manual test results in Junit XML format.
![integration](./img/integration.png)
```xml title="Junit xml"
<?xml version="1.0" encoding="UTF-8"?>
<testsuites time="15.682687">
<testsuite name="Tests.Registration" time="6.605871">
<testcase name="testCase1" classname="Tests.Registration" time="2.113871" />
<testcase name="testCase2" classname="Tests.Registration" time="1.051" />
<testcase name="testCase3" classname="Tests.Registration" time="3.441" />
</testsuite>
<testsuite name="Tests.Authentication" time="9.076816">
<testsuite name="Tests.Authentication.Login" time="4.356">
<testcase name="testCase4" classname="Tests.Authentication.Login" time="2.244" />
<testcase name="testCase5" classname="Tests.Authentication.Login" time="0.781" />
<testcase name="testCase6" classname="Tests.Authentication.Login" time="1.331" />
</testsuite>
<testcase name="testCase7" classname="Tests.Authentication" time="2.508" />
<testcase name="testCase8" classname="Tests.Authentication" time="1.230816" />
<testcase name="testCase9" classname="Tests.Authentication" time="0.982">
<failure message="Assertion error message" type="AssertionError">
<!-- Call stack printed here -->
</failure>
</testcase>
</testsuite>
</testsuites>
```

7
docs/docs/index.md Normal file
View File

@@ -0,0 +1,7 @@
---
sidebar_position: 1
---
# TestPlat
Open Source Test Case Management Web Application