diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 84522597495fca0d4158a3b8bbb754e2d1f1030b..0000000000000000000000000000000000000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# package-reinforce-test - -#### Description -The repo contains test suites in order to improve test coverage for key packages - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_en.md b/README_en.md new file mode 100644 index 0000000000000000000000000000000000000000..e81e90ab0ffd89cc38346da40516df0232a5559b --- /dev/null +++ b/README_en.md @@ -0,0 +1,42 @@ +# package-reinforce-test + +## Description +This repository provides source code for enhanced testing on important software packages. + +## Software Architecture + +├── README_en.md +├── README.md +├── License +│ └── LICENSE +├── suite2cases +└── testcases + +## Instructions +As a community of integration, the openEuler community releases thousands of software packages. To ensure that the capabilities provided by each software package can be used by users, wider in-depth tests need to be performed in addition to the tests of upstream communities. Important software packages are selected for testing based on system impact and application scenarios. + +The testing procedure is as follows: + +- Analyze the functions, commands, parameters, and services provided by the software package, application scenarios, and system resources used by the software package. +- Design tests, such as function, performance, and reliability tests. +- Compile test code based on the test design. +- Submit the PR to the warehouse. +- Incorporated into PR by maintainer + +## Contribution +1. Fork this repository. +2. Define the mapping between test suites and test cases in a file in the **suite2cases** directory. +3. Compile test code and save it to the **testcases** directory. +4. Download the [mugen](https://gitee.com/openeuler/test-tools.git) test framework and debug the code. +5. Commit your code. +6. Create a Pull Request on Gitee. + + +#### Gitee Feature + +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/test-case-naming-and-coding-specifications.md b/test-case-naming-and-coding-specifications.md new file mode 100644 index 0000000000000000000000000000000000000000..bf4ef024e21d430f15f0cc8f0899402dbd5c10bc --- /dev/null +++ b/test-case-naming-and-coding-specifications.md @@ -0,0 +1,37 @@ +# Test Case Naming and Coding Specifications + +## Signing CLA + +You need to sign a [CLA](https://clasign.osinfra.cn/sign/Z2l0ZWUlMkZvcGVuZXVsZXI=) before making contributions. + +## Test Suite and Test Case Naming Specifications + +- Use the test object or test feature name as the test suite name. +- The test case name must be in the format of oe_test_{test function item description}_00X. +- Specify the [mapping](https://gitee.com/openeuler/test-tools/blob/master/mugen/suite2cases/testsuite) between test suites and test cases. + +## Test Case Coding Specifications + +1. Copyright and License Description + + 1. When writing test code, add a copyright statement to the code header to specify the copyright holder of the code (yourself or your employer). The copyright statement format can be: + + `Copyright (c) [Year] [name of copyright holder]` + + 2. Add a license statement to the code header to specify the license for the contributed code. You can select a license that is compatible with the project license (Mulan PSL v2). If you choose to use Mulan PSL v2, the license statement can be: + + ``` + This program is licensed under Mulan PSL v2. + You can use it according to the terms and conditions of the Mulan PSL v2. + http://license.coscl.org.cn/MulanPSL2 + THIS PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, + EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, + MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. + See the Mulan PSL v2 for more details. + ``` + +2. Compile test code by referring to [Test Case Template](https://gitee.com/openeuler/test-tools/tree/master/mugen/testcases/testsuite/oe_test_casename_01). + +3. Currently, shell and Python test cases are supported. + +