chore: init phoenix-regression-test with config submodules
This commit is contained in:
@@ -0,0 +1,6 @@
|
|||||||
|
[submodule "configs/config-fenghuang"]
|
||||||
|
path = configs/config-fenghuang
|
||||||
|
url = git@git.xnergy.tech:Xnergy-Firmware/config-fenghuang.git
|
||||||
|
[submodule "configs/config-garuda"]
|
||||||
|
path = configs/config-garuda
|
||||||
|
url = git@git.xnergy.tech:Xnergy-Firmware/config-garuda.git
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
# Phoenix Regression Test
|
||||||
|
|
||||||
|
## English
|
||||||
|
|
||||||
|
### Overview
|
||||||
|
<!-- TODO: brief project overview -->
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
<!-- TODO: what this regression test suite aims to achieve -->
|
||||||
|
|
||||||
|
### Scope
|
||||||
|
<!-- TODO: which product(s)/firmware version(s) this covers -->
|
||||||
|
|
||||||
|
### Test Equipment / Hardware-in-the-loop
|
||||||
|
- Modbus (data acquisition from DUT)
|
||||||
|
- Oscilloscope
|
||||||
|
- Electronic Load (Eload)
|
||||||
|
- AC Source
|
||||||
|
- Auto Jig (3-axis XYZ)
|
||||||
|
<!-- TODO: add more equipment as needed -->
|
||||||
|
|
||||||
|
### Test Cases
|
||||||
|
<!-- TODO: list of regression test cases -->
|
||||||
|
|
||||||
|
### Architecture
|
||||||
|
<!-- TODO: script/module structure, equipment abstraction layer, test runner, reporting -->
|
||||||
|
|
||||||
|
### Setup / Requirements
|
||||||
|
<!-- TODO: dependencies, drivers, connection setup -->
|
||||||
|
|
||||||
|
### Config sources (Modbus register maps)
|
||||||
|
Modbus register addresses are sourced from the following repos, included as **git submodules**:
|
||||||
|
- `configs/config-fenghuang` → `git@git.xnergy.tech:Xnergy-Firmware/config-fenghuang.git`
|
||||||
|
- `configs/config-garuda` → `git@git.xnergy.tech:Xnergy-Firmware/config-garuda.git`
|
||||||
|
|
||||||
|
First-time clone:
|
||||||
|
```
|
||||||
|
git clone --recurse-submodules <this-repo-url>
|
||||||
|
```
|
||||||
|
If already cloned without `--recurse-submodules`:
|
||||||
|
```
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
This repo has `submodule.recurse=true` set locally, so a plain `git pull` will also
|
||||||
|
update submodules to the commit already recorded in this repo. To pull in the
|
||||||
|
**latest** config.json from each source repo (bump the pinned commit):
|
||||||
|
```
|
||||||
|
git submodule update --remote configs/config-fenghuang
|
||||||
|
git submodule update --remote configs/config-garuda
|
||||||
|
git add configs/config-fenghuang configs/config-garuda
|
||||||
|
git commit -m "chore: bump config submodules"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
<!-- TODO: how to run the tests -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tiếng Việt
|
||||||
|
|
||||||
|
### Tổng quan
|
||||||
|
<!-- TODO: mô tả sơ lược về dự án -->
|
||||||
|
|
||||||
|
### Mục tiêu
|
||||||
|
<!-- TODO: mục tiêu của bộ regression test này -->
|
||||||
|
|
||||||
|
### Phạm vi
|
||||||
|
<!-- TODO: sản phẩm/phiên bản firmware nào được kiểm thử -->
|
||||||
|
|
||||||
|
### Thiết bị đo / Thiết bị phần cứng liên quan
|
||||||
|
- Modbus (thu thập dữ liệu từ DUT)
|
||||||
|
- Oscilloscope (máy hiện sóng)
|
||||||
|
- Eload (tải điện tử)
|
||||||
|
- AC Source (nguồn AC)
|
||||||
|
- Auto Jig 3 trục XYZ
|
||||||
|
<!-- TODO: bổ sung thêm thiết bị nếu cần -->
|
||||||
|
|
||||||
|
### Các bài test
|
||||||
|
<!-- TODO: danh sách các bài test regression -->
|
||||||
|
|
||||||
|
### Kiến trúc
|
||||||
|
<!-- TODO: cấu trúc script/module, lớp trừu tượng điều khiển thiết bị, bộ chạy test, báo cáo kết quả -->
|
||||||
|
|
||||||
|
### Cài đặt / Yêu cầu
|
||||||
|
<!-- TODO: thư viện phụ thuộc, driver, cách kết nối thiết bị -->
|
||||||
|
|
||||||
|
### Nguồn config (bảng địa chỉ Modbus)
|
||||||
|
Địa chỉ thanh ghi Modbus được lấy từ 2 repo sau, được đưa vào dưới dạng **git submodule**:
|
||||||
|
- `configs/config-fenghuang` → `git@git.xnergy.tech:Xnergy-Firmware/config-fenghuang.git`
|
||||||
|
- `configs/config-garuda` → `git@git.xnergy.tech:Xnergy-Firmware/config-garuda.git`
|
||||||
|
|
||||||
|
Clone lần đầu:
|
||||||
|
```
|
||||||
|
git clone --recurse-submodules <url-repo-nay>
|
||||||
|
```
|
||||||
|
Nếu đã clone mà quên `--recurse-submodules`:
|
||||||
|
```
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
Repo này đã bật `submodule.recurse=true` (cục bộ), nên chỉ cần `git pull` bình thường
|
||||||
|
cũng sẽ tự cập nhật submodule về đúng commit đã được ghim trong repo. Để lấy bản
|
||||||
|
**mới nhất** của config.json từ repo gốc (ghim lại commit mới):
|
||||||
|
```
|
||||||
|
git submodule update --remote configs/config-fenghuang
|
||||||
|
git submodule update --remote configs/config-garuda
|
||||||
|
git add configs/config-fenghuang configs/config-garuda
|
||||||
|
git commit -m "chore: bump config submodules"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Hướng dẫn sử dụng
|
||||||
|
<!-- TODO: cách chạy bộ test -->
|
||||||
Submodule
+1
Submodule configs/config-fenghuang added at 60856d1383
Submodule
+1
Submodule configs/config-garuda added at 48cc8e282b
Reference in New Issue
Block a user