Skip to content

Commit 521580b

Browse files
narrowizardnarrowizard
authored
docs(QA): add quality assurance domain and related CSV upload APIs (#803)
- Add new domain tables for quality assurance: qa_apis, qa_projects, qa_test_cases, and qa_test_case_executions - Update documentation to include new domain layer models and CSV upload APIs for QA data - Add sample CSV files and explanations for QA data import
1 parent 9442427 commit 521580b

File tree

2 files changed

+143
-2
lines changed

2 files changed

+143
-2
lines changed

‎docs/DataModels/DevLakeDomainLayerSchema.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -899,6 +899,61 @@ This table can support tag-based analysis, for instance, '_No. of bugs closed in
899899

900900
<br/>
901901

902+
### Domain 7 - Quality Assurance
903+
904+
#### qa_apis
905+
906+
This table stores information about APIs for quality assurance testing.
907+
908+
| **field** | **type** | **length** | **description** | **key** |
909+
|:--------------------|:-----------------------------|:-----------|:--------------------------------------------------------------------------------|:--------|
910+
| `id` | varchar | 500 | Unique identifier for the API | PK |
911+
| `name` | varchar | 255 | Name of the API | |
912+
| `path` | varchar | 255 | API endpoint path | |
913+
| `method` | varchar | 255 | HTTP method (GET, POST, PUT, DELETE, etc.) | |
914+
| `create_time` | timestamp with time zone | | When the API was created | |
915+
| `creator_id` | varchar | 255 | ID of the user who created the API | |
916+
| `qa_project_id` | varchar | 255 | ID of the QA project this API belongs to | |
917+
918+
#### qa_projects
919+
920+
This table stores information about quality assurance projects.
921+
922+
| **field** | **type** | **length** | **description** | **key** |
923+
|:---------------|:-----------------------------|:-----------|:-------------------------------------|:--------|
924+
| `id` | varchar | 500 | Unique identifier for the project | PK |
925+
| `name` | varchar | 255 | Name of the QA project | |
926+
927+
#### qa_test_cases
928+
929+
This table stores information about test cases in quality assurance.
930+
931+
| **field** | **type** | **length** | **description** | **key** |
932+
|:----------------|:-----------------------------|:-----------|:-------------------------------------|:--------|
933+
| `id` | varchar | 500 | Unique identifier for the test case | PK |
934+
| `name` | varchar | 255 | Name of the test case | |
935+
| `create_time` | timestamp with time zone | | When the test case was created | |
936+
| `creator_id` | varchar | 255 | ID of the user who created the case | |
937+
| `type` | varchar | 255 | Type of test case (api or functional)| |
938+
| `qa_api_id` | varchar | 255 | ID of the related API (required when type is api) | |
939+
| `qa_project_id` | varchar | 255 | ID of the QA project | |
940+
941+
#### qa_test_case_executions
942+
943+
This table stores information about test case executions in quality assurance.
944+
945+
| **field** | **type** | **length** | **description** | **key** |
946+
|:-------------------|:-----------------------------|:-----------|:-----------------------------------------|:--------|
947+
| `id` | varchar | 500 | Unique identifier for the execution | PK |
948+
| `qa_project_id` | varchar | 255 | ID of the QA project | |
949+
| `qa_test_case_id` | varchar | 255 | ID of the test case being executed | |
950+
| `create_time` | timestamp with time zone | | When the execution record was created | |
951+
| `start_time` | timestamp with time zone | | When the test execution started | |
952+
| `finish_time` | timestamp with time zone | | When the test execution finished | |
953+
| `creator_id` | varchar | 255 | ID of the user who executed the test | |
954+
| `status` | varchar | 255 | Execution status (PENDING, IN_PROGRESS, SUCCESS, FAILED) | |
955+
956+
902957
## Get Domain Layer Models in Developer Mode
903958

904959
When developing a new plugin, you need to refer to domain layer models, as all raw data should be transformed to domain layer data to provide standardized metrics across tools. Please use the following method to access the domain data models.

‎docs/Plugins/customize.md‎

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ description: >
1111
This plugin provides users the ability to:
1212
- Add/delete columns in domain layer tables
1313
- Insert values to certain columns with data extracted from some raw layer tables
14-
- Import data from CSV files(only `issues` and `issue_commits` two tables are supported)
14+
- Import data from CSV files(only `issues`, `issue_commits`, `qa_apis`, `qa_test_cases` and `qa_test_case_executions` tables are supported)
1515

1616
**NOTE:** The names of columns added via this plugin must start with the prefix `x_`
1717

18-
For now, only the following five types were supported:
18+
For now, only the following six types are supported:
1919
- varchar(255)
2020
- text
2121
- bigint
@@ -216,3 +216,89 @@ The following is an issue_commits.CSV file sample:
216216
|jira:JiraIssue:1:10159|d28785ff09229ac9e3c6734f0c97466ab00eb4da|
217217
|jira:JiraIssue:1:10202|0ab12c4d4064003602edceed900d1456b6209894|
218218
|jira:JiraIssue:1:10203|980e9fe7bc3e22a0409f7241a024eaf9c53680dd|
219+
220+
### Upload `qa_apis.csv` file
221+
222+
> POST /plugins/customize/csvfiles/qa_apis.csv
223+
224+
The HTTP `Content-Type` must be `multipart/form-data`, and the form should have three fields:
225+
226+
- `file`: The CSV file
227+
- `qaProjectId`: It will be used as qa_project_id for the imported data
228+
- `incremental`: Boolean value indicating whether this is an incremental update (true/false)
229+
230+
Upload a CSV file and import it to the `qa_apis` table via this API. The following fields are required:
231+
232+
| Field Name | Data Type | Description |
233+
|------------------|---------------|---------------------------------|
234+
| id | varchar(500) | Unique identifier for the API |
235+
| name | varchar(255) | API name |
236+
| path | varchar(255) | API path |
237+
| method | varchar(255) | HTTP method (GET, POST, etc.) |
238+
| create_time | timestamp | Creation timestamp |
239+
| creator_name | varchar(255) | Creator name (will create a record in accounts table and write creator_id to qa_apis table) |
240+
241+
#### qa_apis.csv sample:
242+
|id |name |path |method|create_time |creator_name|qa_project_id|
243+
|--------------------|--------------|------------------|------|-------------------------|------------|-------------|
244+
|qa:api:1:101 |Login API |/api/v1/login |POST |2025-07-01 10:00:00 |tester1 |project101 |
245+
|qa:api:1:102 |User Info API |/api/v1/user/{id} |GET |2025-07-01 11:30:00 |tester2 |project101 |
246+
|qa:api:1:103 |Logout API |/api/v1/logout |POST |NULL |tester1 |project102 |
247+
248+
### Upload `qa_test_cases.csv` file
249+
250+
> POST /plugins/customize/csvfiles/qa_test_cases.csv
251+
252+
The HTTP `Content-Type` must be `multipart/form-data`, and the form should have four fields:
253+
254+
- `file`: The CSV file
255+
- `qaProjectId`: (max length 500) Will be used as qa_project_id and will create/update a record in qa_projects table
256+
- `qaProjectName`: (max length 255) Will be written to the `name` field of qa_projects table. Together with qaProjectId, this will create a new record in qa_projects table if not exists.
257+
- `incremental`: Boolean value indicating whether this is an incremental update (true/false)
258+
259+
Upload a CSV file and import it to the `qa_test_cases` table via this API. The following fields are required:
260+
261+
| Field Name | Data Type | Description |
262+
|------------------|---------------|---------------------------------|
263+
| id | varchar(500) | Unique test case ID |
264+
| name | varchar(255) | Test case name |
265+
| create_time | timestamp | Creation timestamp |
266+
| creator_name | varchar(255) | Creator name (will create a record in accounts table and write creator_id to qa_test_cases table) |
267+
| type | varchar(255) | Test case type, api or functional |
268+
| qa_api_id | varchar(255) | Related API ID, if type is api |
269+
270+
#### qa_test_cases.csv sample:
271+
|id |name |create_time |creator_name|type |qa_api_id |qa_project_id|
272+
|--------------------|-------------------|-------------------------|------------|-------|---------------|-------------|
273+
|qa:case:1:201 |Login Test |2025-07-02 09:00:00 |tester1 |api |qa:api:1:101 |project101 |
274+
|qa:case:1:202 |User Profile Test |2025-07-02 10:30:00 |tester2 |api |qa:api:1:102 |project101 |
275+
|qa:case:1:203 |UI Navigation Test |2025-07-02 11:45:00 |tester3 |functional|NULL |project102 |
276+
277+
### Upload `qa_test_case_executions.csv` file
278+
279+
> POST /plugins/customize/csvfiles/qa_test_case_executions.csv
280+
281+
The HTTP `Content-Type` must be `multipart/form-data`, and the form should have three fields:
282+
283+
- `file`: The CSV file
284+
- `qaProjectId`: It will be used as qa_project_id for the imported data
285+
- `incremental`: Boolean value indicating whether this is an incremental update (true/false)
286+
287+
Upload a CSV file and import it to the `qa_test_case_executions` table via this API. The following fields are required:
288+
289+
| Field Name | Data Type | Description |
290+
|-----------------------|---------------|---------------------------------|
291+
| id | varchar(500) | Unique execution ID |
292+
| qa_test_case_id | varchar(255) | Related test case ID |
293+
| create_time | timestamp | Creation timestamp |
294+
| start_time | timestamp | Test execution start time |
295+
| finish_time | timestamp | Test execution finish time |
296+
| creator_name | varchar(255) | Creator name (will create a record in accounts table and write creator_id to qa_test_case_executions table) |
297+
| status | varchar(255) | Execution status (PENDING, IN_PROGRESS, SUCCESS, FAILED) |
298+
299+
#### qa_test_case_executions.csv sample:
300+
|id |qa_test_case_id |create_time |start_time |finish_time |creator_name|status |qa_project_id|
301+
|--------------------|-------------------|-------------------------|------------------------|------------------------|------------|----------|-------------|
302+
|qa:exec:1:301 |qa:case:1:201 |2025-07-03 14:00:00 |2025-07-03 14:05:00 |2025-07-03 14:15:00 |tester1 |SUCCESS |project101 |
303+
|qa:exec:1:302 |qa:case:1:202 |2025-07-03 15:30:00 |2025-07-03 15:35:00 |NULL |tester2 |IN_PROGRESS|project101 |
304+
|qa:exec:1:303 |qa:case:1:203 |2025-07-04 09:00:00 |NULL |NULL |tester3 |PENDING |project102 |

0 commit comments

Comments
 (0)