December 2020 - Compass-ci - mailweb.openeuler.org

[PATCH compass-ci] doc/manual: rename write-PKGBUILD
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- doc/manual/{write-pkgbuild.en.md => write-PKGBUILD.en.md} | 0 .../manual/write-PKGBUILD.zh.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename doc/manual/{write-pkgbuild.en.md => write-PKGBUILD.en.md} (100%) rename "doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" => doc/manual/write-PKGBUILD.zh.md (100%) diff --git a/doc/manual/write-pkgbuild.en.md b/doc/manual/write-PKGBUILD.en.md similarity index 100% rename from doc/manual/write-pkgbuild.en.md rename to doc/manual/write-PKGBUILD.en.md diff --git "a/doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" b/doc/manual/write-PKGBUILD.zh.md similarity index 100% rename from "doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" rename to doc/manual/write-PKGBUILD.zh.md -- 2.23.0

1 0

[PATCH compass-ci] doc/manual: rename test-oss-project
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- ...-to-test-open-source-projects.en.md => test-oss-project.en.md} | 0 .../manual/test-oss-project.zh.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename doc/manual/{use-the-compass-ci-platform-to-test-open-source-projects.en.md => test-oss-project.en.md} (100%) rename "doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" => doc/manual/test-oss-project.zh.md (100%) diff --git a/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md b/doc/manual/test-oss-project.en.md similarity index 100% rename from doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md rename to doc/manual/test-oss-project.en.md diff --git "a/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" b/doc/manual/test-oss-project.zh.md similarity index 100% rename from "doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" rename to doc/manual/test-oss-project.zh.md -- 2.23.0

1 0

[PATCH compass-ci] doc: remove trailing white space
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- doc/mail-robot.md | 8 +-- doc/manual/apply-for-a-test-machine.en.md | 72 +++++++++---------- doc/manual/compare-test-results.en.md | 30 ++++---- doc/manual/submit-command-description.md | 60 ++++++++-------- ...75\344\273\244\350\257\246\350\247\243.md" | 24 +++---- ...latform-to-test-open-source-projects.en.md | 36 +++++----- doc/manual/write-pkgbuild.en.md | 14 ++-- ...00\346\272\220\351\241\271\347\233\256.md" | 14 ++-- ...13\350\257\225\347\273\223\346\236\234.md" | 28 ++++---- ...67\346\265\213\350\257\225\346\234\272.md" | 40 +++++------ ...75\225\347\274\226\345\206\231PKGBUILD.md" | 10 +-- doc/send-mail.md | 2 +- 12 files changed, 169 insertions(+), 169 deletions(-) diff --git a/doc/mail-robot.md b/doc/mail-robot.md index ec1a866..06e4e87 100644 --- a/doc/mail-robot.md +++ b/doc/mail-robot.md @@ -22,13 +22,13 @@ mail content my oss commit: https://github.com/torvalds/aalinux/commit/7be74942f184fdfba34ddd19a0d995de… attahcment ssh pub_key - + ## steps overview 1. mail-robot monitor_new_email - the monitor will listen to the mailbox for new email files - handle_new_email: + handle_new_email: read email file content apply_account invoke AssignAccount for new account @@ -51,7 +51,7 @@ attahcment clone the repo and check the commit - non_gitee_commit(url) check the commit with curl - + parse_pub_key check whether there has an attachment file to the email file attachment: @@ -88,7 +88,7 @@ attahcment - build success email - build failed email send mail - + 3. continue the monitor continue to monitor the mailbox for new email file cycle run step 1 and 2 if matched email files diff --git a/doc/manual/apply-for-a-test-machine.en.md b/doc/manual/apply-for-a-test-machine.en.md index 14dd064..e177269 100644 --- a/doc/manual/apply-for-a-test-machine.en.md +++ b/doc/manual/apply-for-a-test-machine.en.md @@ -9,7 +9,7 @@ Ensure that you have performed the following operations according to the [apply- # Applying for a Test Machine (VM) 1. Generate a local RSA private-public key pair. - + ```shell hi684@account-vm ~% ssh-keygen -t rsa Generating public/private rsa key pair. @@ -42,9 +42,9 @@ Ensure that you have performed the following operations according to the [apply- ``` 2. Select the YAML file as required. - + A **lkp-tests** folder is stored in each user directory `/home/${USER}`. - + ```shell hi684@account-vm ~% cd lkp-tests/jobs hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* @@ -54,7 +54,7 @@ Ensure that you have performed the following operations according to the [apply- ``` 3. Submit the YAML file and connect to the test machine (VM). - + ```shell hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=vm-2p8g borrow-1h.yaml submit borrow-1h.yaml, got job_id=z9.170593 @@ -70,12 +70,12 @@ Ensure that you have performed the following operations according to the [apply- Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts Warning: Permanently added '[172.168.131.2]:51840' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - - + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - + System information as of time: Thu Nov 26 06:44:18 CST 2020 - + System load: 0.83 Processes: 107 Memory used: 6.1% @@ -83,16 +83,16 @@ Ensure that you have performed the following operations according to the [apply- Usage On: 89% IP address: 172.18.156.13 Users online: 1 - - - + + + root@vm-2p8g ~# ``` - + For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. 4. Return the test machine (VM) after use. - + ```shell root@vm-2p8g ~# reboot Connection to 172.168.131.2 closed by remote host. @@ -103,7 +103,7 @@ Ensure that you have performed the following operations according to the [apply- # Applying for a Test Machine (Physical Machine) 1. Generate a local RSA private-public key pair. - + ```shell hi684@account-vm ~% ssh-keygen -t rsa Generating public/private rsa key pair. @@ -136,9 +136,9 @@ Ensure that you have performed the following operations according to the [apply- ``` 2. Select the YAML file as required. - + A **lkp-tests** folder is stored in each user directory `/home/${USER}`. - + ```shell hi684@account-vm ~% cd lkp-tests/jobs hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* @@ -148,7 +148,7 @@ Ensure that you have performed the following operations according to the [apply- ``` 3. Submit the YAML file and connect to the test machine (physical machine). - + ```shell hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=taishan200-2280-2s64p-256g borrow-1h.yaml submit borrow-1h.yaml, got job_id=z9.170594 @@ -164,12 +164,12 @@ Ensure that you have performed the following operations according to the [apply- Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts Warning: Permanently added '[172.168.131.2]:50420' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - - + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - + System information as of time: Thu Nov 26 14:51:59 CST 2020 - + System load: 1.31 Processes: 1020 Memory used: 5.1% @@ -177,16 +177,16 @@ Ensure that you have performed the following operations according to the [apply- Usage On: 3% IP address: 172.168.178.48 Users online: 1 - - - + + + root@taishan200-2280-2s64p-256g--a5 ~# ``` - + For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. 4. Return the test machine (physical machine) after use. - + ```shell root@taishan200-2280-2s64p-256g--a5 ~# reboot Connection to 172.168.131.2 closed by remote host. @@ -197,12 +197,12 @@ Ensure that you have performed the following operations according to the [apply- # FAQ * How Do I Change the Duration of Keeping the Test Machine when Applying for It? - + ```shell hi684@account-vm ~/lkp-tests/jobs% cat borrow-1h.yaml suite: borrow testcase: borrow - + pub_key: <%= begin File.read("#{ENV['HOME']}/.ssh/id_rsa.pub").chomp @@ -222,24 +222,24 @@ Ensure that you have performed the following operations according to the [apply- ``` * Guide to the **submit** Command - + Reference: [submit Command Description.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/m… * What Are the testbox Options? - + For details about the testbox options, visit https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts. - + > ![](./../public_sys-resources/icon-note.gif) **Note** > - > VM testbox: vm-xxx + > VM testbox: vm-xxx > > PM testbox: taishan200-2280-xxx - + > ![](./../public_sys-resources/icon-notice.gif) **Notice** - > + > > - If the testbox of a physical machine ends with `--axx`, a physical machine is specified. If a task is already in the task queue of the physical machine, the borrow task you submitted will not be processed until the previous task in the queue is completed. > - If the testbox of a physical machine does not end with `-axx`, no physical machine is specified. In this case, the borrow task you submitted will be immediately allocated to idle physical machines in the cluster for execution. - + * How Do I Borrow the Specified Operating System? - + For details about the supported `os`, `os_arch`, and `os_version`, see [os-os\_verison-os\_arch.md](https://gitee.com/wu_fengguang/compass-ci/blob/…. diff --git a/doc/manual/compare-test-results.en.md b/doc/manual/compare-test-results.en.md index 5a5dd22..61c4256 100644 --- a/doc/manual/compare-test-results.en.md +++ b/doc/manual/compare-test-results.en.md @@ -20,29 +20,29 @@ The Compare feature is used to analyze the results of different jobs, show the p ## example: filter: suite = iperf dimension: os_version - + result: os=openeuler/os_arch=aarch64/pp.iperf.protocol=tcp/pp.iperf.runtime=20/tbox_group=vm-2p8g # other test conditions keep same - 20.09 20.03 metric + 20.09 20.03 metric -------------------- ------------------------------ ------------------------------ - fails:runs change fails:runs - | | | - 3:3 -100.0% 0:3 last_state.exit_fail - 3:3 -100.0% 0:3 last_state.is_incomplete_run + fails:runs change fails:runs + | | | + 3:3 -100.0% 0:3 last_state.exit_fail + 3:3 -100.0% 0:3 last_state.is_incomplete_run 3:3 -100.0% 0:3 last_state.test.iperf.exit_code.127 - 3:3 -100.0% 0:3 stderr.perf_command_failed + 3:3 -100.0% 0:3 stderr.perf_command_failed - 20.09 20.03 metric + 20.09 20.03 metric -------------------- ------------------------------ ------------------------------ - %stddev change %stddev - \ | \ - 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps - 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps - 94.82 -44.0% 53.10 boot-time.boot - 123.11 -58.4% 51.19 boot-time.idle - 0.00 0 4.87 boot-time.kernel_boot + %stddev change %stddev + \ | \ + 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps + 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps + 94.82 -44.0% 53.10 boot-time.boot + 123.11 -58.4% 51.19 boot-time.idle + 0.00 0 4.87 boot-time.kernel_boot 4165.50 ± 12% -99.9% 5.00 interrupts.38:GICv3.36.Level.virtio0 diff --git a/doc/manual/submit-command-description.md b/doc/manual/submit-command-description.md index 4ea431c..2748fbe 100644 --- a/doc/manual/submit-command-description.md +++ b/doc/manual/submit-command-description.md @@ -74,9 +74,9 @@ total 120K ``` > ![](./../public_sys-resources/icon-note.gif) **Note** -> +> > Use the equal sign (=) to update the fields in the YAML file. The priority of the ***=*** varies with its position in the command line. -> +> > * In the **submit iperf.yaml testbox=vm-2p8g** command, the **=** is defined after the YAML file. As a result, the priority of the **=** is higher than that of the YAML file. **testbox=vm-2p8g** overrides the **testbox** field defined in the YAML file. > * In the **submit testbox=vm-2p8g iperf.yaml** command, the **=** is defined before the YAML file. As a result, the priority of **=** is lower than that of the YAML file. **testbox=vm-2p8g** does not override the **testbox** field defined in the YAML file. A value is assigned only when the YAML file does not contain the **testbox** field. @@ -99,46 +99,46 @@ options: ``` * **Usage of -s** - + You can use the **-s'KEY:VALUE'** parameter to update the key-value pair to the submitted task. An example is shown in the following figure: - + ``` submit -s 'testbox: vm-2p8g' iperf.yaml ``` - + * If the **iperf.yaml** file does not contain **testbox: vm-2p8g**, the field will be added to the submitted task. * If the **iperf.yaml** file contains the **testbox** field but the value is not **vm-2p8g**, the value of **testbox** in the submitted task will be updated as **vm-2p8g**. * **Usage of -o** - + You can run the **-o DIR** command to save the generated YAML file to the specified directory **DIR**. An example is shown in the following figure: - + ``` submit -o ~/iperf.yaml ``` - + After the command is executed, the YAML file that has been processed by the **submit** command is generated in the specified directory. * **Usage of -a** - + If the **lkp-tests** on the client is changed in the test case, you need to use the **-a** option for adaptation. Synchronize the modification made in the **lkp-tests** on the client to the server, and generate a customized test script on the test machine. An example is shown in the following figure: - + ``` submit -a iperf.yaml ``` * **Usage of -m** - + You can use the **-m** parameter to enable the task monitoring function and print the status information during the task execution on the console. In this way, you can monitor the execution process of the test task in real time. An example is shown in the following figure: - + ``` submit -m iperf.yaml ``` - + The following information is displayed on the console: - + ```shell - hi8109@account-vm ~% submit -m iperf.yaml + hi8109@account-vm ~% submit -m iperf.yaml submit iperf.yaml, got job_id=z9.173923 query=>{"job_id":["z9.173923"]} connect to ws://172.168.131.2:11310/filter @@ -158,19 +158,19 @@ options: ``` * **Usage of -c** - + The **-c** parameter must be used together with the **-m** parameter to implement the automatic login function in the task of applying for a device. - + An example is shown in the following figure: - + ``` submit -m -c borrow-1h.yaml ``` - + After submitting a task of applying for a device, you will receive the returned login information, such as `ssh ip -p port`. After adding the **-c** parameter, you can log in to the executor without manually entering the SSH login command. - + The following information is displayed on the console: - + ```shell hi8109@account-vm ~% submit -m -c borrow-1h.yaml submit borrow-1h.yaml, got job_id=z9.173925 @@ -186,12 +186,12 @@ options: Host 172.168.131.2 not found in /home/hi8109/.ssh/known_hosts Warning: Permanently added '[172.168.131.2]:50200' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - - + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - + System information as of time: Mon Nov 30 12:32:04 CST 2020 - + System load: 0.50 Processes: 105 Memory used: 6.1% @@ -199,10 +199,10 @@ options: Usage On: 89% IP address: 172.17.0.1 Users online: 1 - - - - root@vm-2p8g ~# + + + + root@vm-2p8g ~# ``` - + You log in to the executor successfully. diff --git "a/doc/manual/submit\345\221\275\344\273\244\350\257\246\350\247\243.md" "b/doc/manual/submit\345\221\275\344\273\244\350\257\246\350\247\243.md" index 66d8cc4..540d91f 100644 --- "a/doc/manual/submit\345\221\275\344\273\244\350\257\246\350\247\243.md" +++ "b/doc/manual/submit\345\221\275\344\273\244\350\257\246\350\247\243.md" @@ -73,7 +73,7 @@ total 120K -rw-r--r--. 1 root root 74 2020-11-02 14:54 vm-snb-i386 ``` ->![](./../public_sys-resources/icon-note.gif) **说明：** +>![](./../public_sys-resources/icon-note.gif) **说明：** > >使用 "=" 更新 yaml 中的字段，"=" 在命令行中的位置不同优先级不同：. > * submit iperf.yaml testbox=vm-2p8g 命令中 "=" 定义在 yaml 文件之后，则 "=" 的优先级高于 yaml 文件,testbox=vm-2p8g 会覆盖 yaml 文件中已经定义的 testbox 字段。 @@ -105,7 +105,7 @@ options: ``` submit -s 'testbox: vm-2p8g' iperf.yaml ``` - + * 如果 iperf.yaml 中不存在 testbox：vm-2p8g ，最终提交的任务将会加上该信息。 * 如果 iperf.yaml 中存在 testbox 字段，但是值不为 vm-2p8g ，最终提交的任务中 testbox 的值将会被替换为vm-2p8g。 @@ -119,12 +119,12 @@ options: ``` 运行命令之后会在指定目录生成经过 submit 处理过的 yaml 文件。 - + * **-a的用法** 如果你的测试用例对客户端的lkp-tests 做了更改，需要使用 -a 选项来适配。将客户端的 lkp-tests 下做的更改，同步到服务端，并在测试机上生成你的测试脚本。示例命令如下： - + ``` submit -a iperf.yaml ``` @@ -139,15 +139,15 @@ options: 使用 -m 参数可以启动任务监控功能，并将任务执行过程中的各种状态信息打印到控制台上，方便用户实时监控测试任务的执行过程。示例命令如下： - + ``` submit -m iperf.yaml ``` - + 控制台显示如下： - + ```shell - hi8109@account-vm ~% submit -m iperf.yaml + hi8109@account-vm ~% submit -m iperf.yaml submit iperf.yaml, got job_id=z9.173923 query=>{"job_id":["z9.173923"]} connect to ws://172.168.131.2:11310/filter @@ -171,14 +171,14 @@ options: -c 参数需要搭配 -m 参数来使用，可以使申请设备的任务实现自动登入功能。示例命令如下： - + ``` submit -m -c borrow-1h.yaml ``` 当我们提交一个申请设备的任务后，会获取到返回的登陆信息，如 `ssh ip -p port`，添加 -c 参数之后不需要我们手动输入 ssh 登陆命令来进入执行机。控制台显示如下： - + ```shell hi8109@account-vm ~% submit -m -c borrow-1h.yaml submit borrow-1h.yaml, got job_id=z9.173925 @@ -195,7 +195,7 @@ options: Warning: Permanently added '[172.168.131.2]:50200' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 System information as of time: Mon Nov 30 12:32:04 CST 2020 @@ -210,7 +210,7 @@ options: - root@vm-2p8g ~# + root@vm-2p8g ~# ``` 已经成功登陆执行机。 diff --git a/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md b/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md index 7a38e5e..066c597 100644 --- a/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md +++ b/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md @@ -11,34 +11,34 @@ Perform the following steps to add the information of the code repository to be ![](./../pictures/fork_blacklight.png) 2. Run the following command to create a file path named with the repository name and its initial letter: - + ``` mkdir -p b/backlight ``` 3. Run the following command to create the **backlight** file in the directory: - + ``` cd b/backlight touch backlight ``` 4. Run the following command to write the URL of the **backlight** repository to the **backlight** file: - + ``` vim backlight ``` - + The format is as follows: - + ``` --- url: - https://github.com/baskerville/backlight ``` - + > ![](./../public_sys-resources/icon-notice.gif) **Note** - > + > > You can refer to the existing file format in the **upstream-repos** repository. Ensure that the formats are consistent. 5. Run the **Pull Request** command to submit the new **backlight** file to the **backlight** repository. @@ -46,26 +46,26 @@ Perform the following steps to add the information of the code repository to be ### Submitting the Test Task to the Compass-CI Platform 1. Prepare a test case. - + You can compile and add a test case to the **lkp-tests** repository, or directly use the existing test cases in the **jobs** directory of the **lkp-tests** repository (https://gitee.com/wu_fengguang/lkp-tests). - - * Use the test cases that have been adapted in the repository. - + + * Use the test cases that have been adapted in the repository. + Use the test cases in the **lkp-tests** repository that meet the requirements. The **iperf.yaml** file is used as an example. The **iperf.yaml** file is a test case that has been adapted. It is stored in the **jobs** directory of the **lkp-tests** repository, and contains some basic test parameters. - + * Compile a test case and add it to the repository. - + For details, see [How To Add Test Cases](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add-testcas…. - + 2. Configure the **auto\_submit.yaml** file and submit the test task. - + You only need to add the following configuration information to the **sbin/auto\_submit.yaml** file in the **compass-ci** repository: - + ``` b/backlight/backlight: - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml ``` - + Submit the modified **auto\_submit.yaml** file to the **compass-ci** repository using Pull Request. Then you can use the Compass-CI platform to test your project. - + For details about how to set parameters in the **auto\_submit.yaml** file, see https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job. diff --git a/doc/manual/write-pkgbuild.en.md b/doc/manual/write-pkgbuild.en.md index 7969b71..c0c25e9 100644 --- a/doc/manual/write-pkgbuild.en.md +++ b/doc/manual/write-pkgbuild.en.md @@ -18,35 +18,35 @@ PKGBUILD includes variables and functions. ## Defining a Function -- package function +- package function Mandatory. It is used for installing files to the directory that will be the root directory of the build package. -- prepare function +- prepare function Optional. It is used for executing the operation of building source code. -- build function +- build function Optional. It is used for compiling and/or building source code. -- check function +- check function Optional. It is used for running the test suite of the program package. > ![](./../public_sys-resources/icon-notice.gif) **Notice** -> +> > **srcdir** is the directory for extracting or copying source files. All packaging functions run in the **srcdir** directory. **pkgdir** is the root directory for building software packages and is used only in the package function. # How do i write PKGBUILD? 1. Read official documents: - + - [PKGBUILD(5) Manual Page](https://www.archlinux.org/pacman/PKGBUILD.5.html) - [pkgbuild demo](https://git.archlinux.org/pacman.git/plain/proto/PKGBUILD.proto) 2. Create **PKGBUILD** file with vim or other editor. The following is an example of the **PKGBUILD** file: - + ```shell pkgname=zstd pkgver=1.4.4 diff --git "a/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" "b/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" index cbbcaef..aa2cd15 100644 --- "a/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" +++ "b/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" @@ -15,13 +15,13 @@ ``` mkdir -p b/backlight ``` - + 3. 执行以下命令，在该目录下新建同名文件 backlight。 ``` cd b/backlight touch backlight ``` - + 4. 执行以下命令，将 backlight 仓库 url 信息写入 backlight 文件。 ``` @@ -34,11 +34,11 @@ url: - https://github.com/baskerville/backlight ``` - - >![](./../public_sys-resources/icon-notice.gif) **注意：** + + >![](./../public_sys-resources/icon-notice.gif) **注意：** > >可参考 upstream-repos 仓库中已有文件格式,请保持格式一致。 - + 5. 通过 Pull Request 命令将新增的 backlight 文件提交到 blacklight 仓库。 @@ -56,7 +56,7 @@ 请参考：[如何添加测试用例](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add… ) -2. 配置 auto_submit.yaml 文件，提交测试任务 +2. 配置 auto_submit.yaml 文件，提交测试任务你只需要在 compass-ci 仓库下面的 sbin/auto_submit.yaml 文件中添加配置信息，如： ``` @@ -64,5 +64,5 @@ - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml ``` 通过 Pull Request 的方式将修改好的 auto_submit.yaml 文件提交到 compass-ci 仓库，就可以使用 compass-ci 测试你的项目了。 - + auto_submit.yaml 文件的参数配置请参考 https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job 。 diff --git "a/doc/manual/\345\246\202\344\275\225\346\257\224\350\276\203\346\265\213\350\257\225\347\273\223\346\236\234.md" "b/doc/manual/\345\246\202\344\275\225\346\257\224\350\276\203\346\265\213\350\257\225\347\273\223\346\236\234.md" index a7348d8..1b43d6b 100644 --- "a/doc/manual/\345\246\202\344\275\225\346\257\224\350\276\203\346\265\213\350\257\225\347\273\223\346\236\234.md" +++ "b/doc/manual/\345\246\202\344\275\225\346\257\224\350\276\203\346\265\213\350\257\225\347\273\223\346\236\234.md" @@ -26,24 +26,24 @@ os=openeuler/os_arch=aarch64/pp.iperf.protocol=tcp/pp.iperf.runtime=20/tbox_group=vm-2p8g # other test conditions keep same - 20.09 20.03 metric + 20.09 20.03 metric -------------------- ------------------------------ ------------------------------ - fails:runs change fails:runs - | | | - 3:3 -100.0% 0:3 last_state.exit_fail - 3:3 -100.0% 0:3 last_state.is_incomplete_run + fails:runs change fails:runs + | | | + 3:3 -100.0% 0:3 last_state.exit_fail + 3:3 -100.0% 0:3 last_state.is_incomplete_run 3:3 -100.0% 0:3 last_state.test.iperf.exit_code.127 - 3:3 -100.0% 0:3 stderr.perf_command_failed + 3:3 -100.0% 0:3 stderr.perf_command_failed - 20.09 20.03 metric + 20.09 20.03 metric -------------------- ------------------------------ ------------------------------ - %stddev change %stddev - \ | \ - 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps - 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps - 94.82 -44.0% 53.10 boot-time.boot - 123.11 -58.4% 51.19 boot-time.idle - 0.00 0 4.87 boot-time.kernel_boot + %stddev change %stddev + \ | \ + 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps + 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps + 94.82 -44.0% 53.10 boot-time.boot + 123.11 -58.4% 51.19 boot-time.idle + 0.00 0 4.87 boot-time.kernel_boot 4165.50 ± 12% -99.9% 5.00 interrupts.38:GICv3.36.Level.virtio0 diff --git "a/doc/manual/\345\246\202\344\275\225\347\224\263\350\257\267\346\265\213\350\257\225\346\234\272.md" "b/doc/manual/\345\246\202\344\275\225\347\224\263\350\257\267\346\265\213\350\257\225\346\234\272.md" index dac74b6..04be9cf 100644 --- "a/doc/manual/\345\246\202\344\275\225\347\224\263\350\257\267\346\265\213\350\257\225\346\234\272.md" +++ "b/doc/manual/\345\246\202\344\275\225\347\224\263\350\257\267\346\265\213\350\257\225\346\234\272.md" @@ -70,12 +70,12 @@ Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts Warning: Permanently added '[172.168.131.2]:51840' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - - + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - + System information as of time: Thu Nov 26 06:44:18 CST 2020 - + System load: 0.83 Processes: 107 Memory used: 6.1% @@ -83,9 +83,9 @@ Usage On: 89% IP address: 172.18.156.13 Users online: 1 - - - + + + root@vm-2p8g ~# ``` @@ -166,12 +166,12 @@ Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts Warning: Permanently added '[172.168.131.2]:50420' (ECDSA) to the list of known hosts. Last login: Wed Sep 23 11:10:58 2020 - - + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - + System information as of time: Thu Nov 26 14:51:59 CST 2020 - + System load: 1.31 Processes: 1020 Memory used: 5.1% @@ -179,12 +179,12 @@ Usage On: 3% IP address: 172.168.178.48 Users online: 1 - - - + + + root@taishan200-2280-2s64p-256g--a5 ~# ``` - + 更多关于`submit命令如何使用`、`testbox都有什么可选项`、`如何borrow指定的操作系统`，请参见文章末尾FAQ。 4. 使用完毕退还测试机（物理机） @@ -233,14 +233,14 @@ testbox可选项请参考：https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts - >![](./../public_sys-resources/icon-note.gif) **说明：** + >![](./../public_sys-resources/icon-note.gif) **说明：** > > 虚拟机的testbox : vm-xxx > 物理机的testbox : taishan200-2280-xxx - - - - >![](./../public_sys-resources/icon-notice.gif) **注意：** + + + + >![](./../public_sys-resources/icon-notice.gif) **注意：** > - 物理机的testbox若选择以`--axx`结尾的，则表示指定到了具体的某一个物理机。若此物理机任务队列中已经有任务在排队，则需要等待队列中前面的任务执行完毕后，才会轮到你提交的borrow任务。 > - 物理机的testbox若不选择以`-axx`结尾的，表示不指定具体的某一个物理机。则此时集群中的空闲物理机会即时被分配执行你的borrow任务。 diff --git "a/doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" "b/doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" index 66a1833..414bfdc 100644 --- "a/doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" +++ "b/doc/manual/\345\246\202\344\275\225\347\274\226\345\206\231PKGBUILD.md" @@ -27,7 +27,7 @@ PKGBUILD包含两部分内容：变量和函数。 - check函数定义可选的check函数，用于运行程序包的测试套件。 ->![](./../public_sys-resources/icon-notice.gif) **注意：** +>![](./../public_sys-resources/icon-notice.gif) **注意：** > > srcdir 是提取或复制源文件的目录，所有打包功能都在 srcdir 目录内部运行；pkgdir 是构建软件包的根目录，仅在 package 函数中使用。 @@ -36,7 +36,7 @@ PKGBUILD包含两部分内容：变量和函数。 1. 执行如下命令创建PKGBUILD，文件名必须以“PKGBUILD”命名。 - + ```shell touch PKGBUILD ``` @@ -55,18 +55,18 @@ PKGBUILD包含两部分内容：变量和函数。 makedepends=('git') source=('git://github.com/facebook/zstd.git#branch=dev') md5sums=('SKIP') - + pkgver() { cd "$srcdir/$pkgname" git describe --long --tags | sed 's/$[^-]*-g$/r\1/;s/-/./g;s/^v//g' } - + build() { cd "$srcdir/$pkgname" make make -C contrib/pzstd } - + package() { cd "$srcdir/$pkgname" make PREFIX="/usr" DESTDIR="$pkgdir/" install diff --git a/doc/send-mail.md b/doc/send-mail.md index 34672de..f503a08 100644 --- a/doc/send-mail.md +++ b/doc/send-mail.md @@ -58,7 +58,7 @@ The service is used to send mails with formatted mail data data = " To: test_email(a)163.com Subject: test mail 10 - + test msg 1010 " -- 2.23.0

1 0

[PATCH compass-ci] doc/manual: remove CRLF
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- doc/manual/apply-for-a-test-machine.en.md | 490 +++++++++--------- doc/manual/compare-test-results.en.md | 96 ++-- doc/manual/submit-command-description.md | 416 +++++++-------- ...latform-to-test-open-source-projects.en.md | 142 ++--- doc/manual/view-task-results.en.md | 46 +- ...00\346\272\220\351\241\271\347\233\256.md" | 136 ++--- 6 files changed, 663 insertions(+), 663 deletions(-) diff --git a/doc/manual/apply-for-a-test-machine.en.md b/doc/manual/apply-for-a-test-machine.en.md index 33ef47f..14dd064 100644 --- a/doc/manual/apply-for-a-test-machine.en.md +++ b/doc/manual/apply-for-a-test-machine.en.md @@ -1,245 +1,245 @@ -# Prerequisites - -Ensure that you have performed the following operations according to the [apply-for-an-account.md](https://gitee.com/wu_fengguang/compass-ci/blob/mas…: - -- Send an email to apply for an account. -- Receive an email from compass-ci(a)qq.com. -- Configure the local environment. - -# Applying for a Test Machine (VM) - -1. Generate a local RSA private-public key pair. - - ```shell - hi684@account-vm ~% ssh-keygen -t rsa - Generating public/private rsa key pair. - Enter file in which to save the key (/home/hi684/.ssh/id_rsa): - Created directory '/home/hi684/.ssh'. - Enter passphrase (empty for no passphrase): - Enter same passphrase again: - Your identification has been saved in /home/hi684/.ssh/id_rsa. - Your public key has been saved in /home/hi684/.ssh/id_rsa.pub. - The key fingerprint is: - SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx hi684@account-vm - The key's randomart image is: - +---[RSA 2048]----+ - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - +----[SHA256]-----+ - hi684@account-vm ~% ls -hla .ssh - total 16K - drwx------. 2 hi684 hi684 4.0K Nov 26 16:37 . - drwx------. 7 hi684 hi684 4.0K Nov 26 16:37 .. - -rw-------. 1 hi684 hi684 1.8K Nov 26 16:37 id_rsa - -rw-r--r--. 1 hi684 hi684 398 Nov 26 16:37 id_rsa.pub - ``` - -2. Select the YAML file as required. - - A **lkp-tests** folder is stored in each user directory `/home/${USER}`. - - ```shell - hi684@account-vm ~% cd lkp-tests/jobs - hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* - -rw-r--r--. 1 root root 53 Nov 2 14:54 borrow-10d.yaml - -rw-r--r--. 1 root root 64 Nov 2 14:54 borrow-1d.yaml - -rw-r--r--. 1 root root 235 Nov 19 15:27 borrow-1h.yaml - ``` - -3. Submit the YAML file and connect to the test machine (VM). - - ```shell - hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=vm-2p8g borrow-1h.yaml - submit borrow-1h.yaml, got job_id=z9.170593 - query=>{"job_id":["z9.170593"]} - connect to ws://172.168.131.2:11310/filter - {"job_id":"z9.170593","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-26/vm-2p8g/openeuler-20.03-aarch64/3600/z9.170593"} - {"job_id": "z9.170593", "result_root": "/srv/result/borrow/2020-11-26/vm-2p8g/openeuler-20.03-aarch64/3600/z9.170593", "job_state": "set result root"} - {"job_id": "z9.170593", "job_state": "boot"} - {"job_id": "z9.170593", "job_state": "download"} - {"time":"2020-11-26 14:45:06","mac":"0a-1f-0d-3c-91-5c","ip":"172.18.156.13","job_id":"z9.170593","state":"running","testbox":"vm-2p8g.taishan200-2280-2s64p-256g--a38-12"} - {"job_state":"running","job_id":"z9.170593"} - {"job_id": "z9.170593", "state": "set ssh port", "ssh_port": "51840", "tbox_name": "vm-2p8g.taishan200-2280-2s64p-256g--a38-12"} - Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts - Warning: Permanently added '[172.168.131.2]:51840' (ECDSA) to the list of known hosts. - Last login: Wed Sep 23 11:10:58 2020 - - - Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - - System information as of time: Thu Nov 26 06:44:18 CST 2020 - - System load: 0.83 - Processes: 107 - Memory used: 6.1% - Swap used: 0.0% - Usage On: 89% - IP address: 172.18.156.13 - Users online: 1 - - - - root@vm-2p8g ~# - ``` - - For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. - -4. Return the test machine (VM) after use. - - ```shell - root@vm-2p8g ~# reboot - Connection to 172.168.131.2 closed by remote host. - Connection to 172.168.131.2 closed. - hi684@account-vm ~/lkp-tests/jobs% - ``` - -# Applying for a Test Machine (Physical Machine) - -1. Generate a local RSA private-public key pair. - - ```shell - hi684@account-vm ~% ssh-keygen -t rsa - Generating public/private rsa key pair. - Enter file in which to save the key (/home/hi684/.ssh/id_rsa): - Created directory '/home/hi684/.ssh'. - Enter passphrase (empty for no passphrase): - Enter same passphrase again: - Your identification has been saved in /home/hi684/.ssh/id_rsa. - Your public key has been saved in /home/hi684/.ssh/id_rsa.pub. - The key fingerprint is: - SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx hi684@account-vm - The key's randomart image is: - +---[RSA 2048]----+ - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - |xxxxxxxxxxxxxxxxx| - +----[SHA256]-----+ - hi684@account-vm ~% ls -hla .ssh - total 16K - drwx------. 2 hi684 hi684 4.0K Nov 26 16:37 . - drwx------. 7 hi684 hi684 4.0K Nov 26 16:37 .. - -rw-------. 1 hi684 hi684 1.8K Nov 26 16:37 id_rsa - -rw-r--r--. 1 hi684 hi684 398 Nov 26 16:37 id_rsa.pub - ``` - -2. Select the YAML file as required. - - A **lkp-tests** folder is stored in each user directory `/home/${USER}`. - - ```shell - hi684@account-vm ~% cd lkp-tests/jobs - hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* - -rw-r--r--. 1 root root 53 Nov 2 14:54 borrow-10d.yaml - -rw-r--r--. 1 root root 64 Nov 2 14:54 borrow-1d.yaml - -rw-r--r--. 1 root root 235 Nov 19 15:27 borrow-1h.yaml - ``` - -3. Submit the YAML file and connect to the test machine (physical machine). - - ```shell - hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=taishan200-2280-2s64p-256g borrow-1h.yaml - submit borrow-1h.yaml, got job_id=z9.170594 - query=>{"job_id":["z9.170594"]} - connect to ws://172.168.131.2:11310/filter - {"job_id":"z9.170594","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-26/taishan200-2280-2s64p-256g/openeuler-20.03-aarch64/3600/z9.170594"} - {"job_id": "z9.170594", "result_root": "/srv/result/borrow/2020-11-26/taishan200-2280-2s64p-256g/openeuler-20.03-aarch64/3600/z9.170594", "job_state": "set result root"} - {"job_id": "z9.170594", "job_state": "boot"} - {"job_id": "z9.170594", "job_state": "download"} - {"time":"2020-11-26 14:51:56","mac":"84-46-fe-26-d3-47","ip":"172.168.178.48","job_id":"z9.170594","state":"running","testbox":"taishan200-2280-2s64p-256g--a5"} - {"job_state":"running","job_id":"z9.170594"} - {"job_id": "z9.170594", "state": "set ssh port", "ssh_port": "50420", "tbox_name": "taishan200-2280-2s64p-256g--a5"} - Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts - Warning: Permanently added '[172.168.131.2]:50420' (ECDSA) to the list of known hosts. - Last login: Wed Sep 23 11:10:58 2020 - - - Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - - System information as of time: Thu Nov 26 14:51:59 CST 2020 - - System load: 1.31 - Processes: 1020 - Memory used: 5.1% - Swap used: 0.0% - Usage On: 3% - IP address: 172.168.178.48 - Users online: 1 - - - - root@taishan200-2280-2s64p-256g--a5 ~# - ``` - - For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. - -4. Return the test machine (physical machine) after use. - - ```shell - root@taishan200-2280-2s64p-256g--a5 ~# reboot - Connection to 172.168.131.2 closed by remote host. - Connection to 172.168.131.2 closed. - hi684@account-vm ~/lkp-tests/jobs% - ``` - -# FAQ - -* How Do I Change the Duration of Keeping the Test Machine when Applying for It? - - ```shell - hi684@account-vm ~/lkp-tests/jobs% cat borrow-1h.yaml - suite: borrow - testcase: borrow - - pub_key: <%= - begin - File.read("#{ENV['HOME']}/.ssh/id_rsa.pub").chomp - rescue - nil - end - %> - sshd: - # sleep at the bottom - sleep: 1h - hi684@account-vm ~/lkp-tests/jobs% grep sleep: borrow-1h.yaml - sleep: 1h - # Use the VIM editor to change the value of the sleep field. - hi684@account-vm ~/lkp-tests/jobs% vim borrow-1h.yaml - # After changing the value, submit the request again. - hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=vm-2p8g borrow-1h.yaml - ``` - -* Guide to the **submit** Command - - Reference: [submit Command Description.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/m… - -* What Are the testbox Options? - - For details about the testbox options, visit https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts. - - > ![](./../public_sys-resources/icon-note.gif) **Note** - > - > VM testbox: vm-xxx - > - > PM testbox: taishan200-2280-xxx - - > ![](./../public_sys-resources/icon-notice.gif) **Notice** - > -> - If the testbox of a physical machine ends with `--axx`, a physical machine is specified. If a task is already in the task queue of the physical machine, the borrow task you submitted will not be processed until the previous task in the queue is completed. - > - If the testbox of a physical machine does not end with `-axx`, no physical machine is specified. In this case, the borrow task you submitted will be immediately allocated to idle physical machines in the cluster for execution. - -* How Do I Borrow the Specified Operating System? - - For details about the supported `os`, `os_arch`, and `os_version`, see [os-os\_verison-os\_arch.md](https://gitee.com/wu_fengguang/compass-ci/blob/…. \ No newline at end of file +# Prerequisites + +Ensure that you have performed the following operations according to the [apply-for-an-account.md](https://gitee.com/wu_fengguang/compass-ci/blob/mas…: + +- Send an email to apply for an account. +- Receive an email from compass-ci(a)qq.com. +- Configure the local environment. + +# Applying for a Test Machine (VM) + +1. Generate a local RSA private-public key pair. + + ```shell + hi684@account-vm ~% ssh-keygen -t rsa + Generating public/private rsa key pair. + Enter file in which to save the key (/home/hi684/.ssh/id_rsa): + Created directory '/home/hi684/.ssh'. + Enter passphrase (empty for no passphrase): + Enter same passphrase again: + Your identification has been saved in /home/hi684/.ssh/id_rsa. + Your public key has been saved in /home/hi684/.ssh/id_rsa.pub. + The key fingerprint is: + SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx hi684@account-vm + The key's randomart image is: + +---[RSA 2048]----+ + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + +----[SHA256]-----+ + hi684@account-vm ~% ls -hla .ssh + total 16K + drwx------. 2 hi684 hi684 4.0K Nov 26 16:37 . + drwx------. 7 hi684 hi684 4.0K Nov 26 16:37 .. + -rw-------. 1 hi684 hi684 1.8K Nov 26 16:37 id_rsa + -rw-r--r--. 1 hi684 hi684 398 Nov 26 16:37 id_rsa.pub + ``` + +2. Select the YAML file as required. + + A **lkp-tests** folder is stored in each user directory `/home/${USER}`. + + ```shell + hi684@account-vm ~% cd lkp-tests/jobs + hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* + -rw-r--r--. 1 root root 53 Nov 2 14:54 borrow-10d.yaml + -rw-r--r--. 1 root root 64 Nov 2 14:54 borrow-1d.yaml + -rw-r--r--. 1 root root 235 Nov 19 15:27 borrow-1h.yaml + ``` + +3. Submit the YAML file and connect to the test machine (VM). + + ```shell + hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=vm-2p8g borrow-1h.yaml + submit borrow-1h.yaml, got job_id=z9.170593 + query=>{"job_id":["z9.170593"]} + connect to ws://172.168.131.2:11310/filter + {"job_id":"z9.170593","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-26/vm-2p8g/openeuler-20.03-aarch64/3600/z9.170593"} + {"job_id": "z9.170593", "result_root": "/srv/result/borrow/2020-11-26/vm-2p8g/openeuler-20.03-aarch64/3600/z9.170593", "job_state": "set result root"} + {"job_id": "z9.170593", "job_state": "boot"} + {"job_id": "z9.170593", "job_state": "download"} + {"time":"2020-11-26 14:45:06","mac":"0a-1f-0d-3c-91-5c","ip":"172.18.156.13","job_id":"z9.170593","state":"running","testbox":"vm-2p8g.taishan200-2280-2s64p-256g--a38-12"} + {"job_state":"running","job_id":"z9.170593"} + {"job_id": "z9.170593", "state": "set ssh port", "ssh_port": "51840", "tbox_name": "vm-2p8g.taishan200-2280-2s64p-256g--a38-12"} + Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts + Warning: Permanently added '[172.168.131.2]:51840' (ECDSA) to the list of known hosts. + Last login: Wed Sep 23 11:10:58 2020 + + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 + + System information as of time: Thu Nov 26 06:44:18 CST 2020 + + System load: 0.83 + Processes: 107 + Memory used: 6.1% + Swap used: 0.0% + Usage On: 89% + IP address: 172.18.156.13 + Users online: 1 + + + + root@vm-2p8g ~# + ``` + + For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. + +4. Return the test machine (VM) after use. + + ```shell + root@vm-2p8g ~# reboot + Connection to 172.168.131.2 closed by remote host. + Connection to 172.168.131.2 closed. + hi684@account-vm ~/lkp-tests/jobs% + ``` + +# Applying for a Test Machine (Physical Machine) + +1. Generate a local RSA private-public key pair. + + ```shell + hi684@account-vm ~% ssh-keygen -t rsa + Generating public/private rsa key pair. + Enter file in which to save the key (/home/hi684/.ssh/id_rsa): + Created directory '/home/hi684/.ssh'. + Enter passphrase (empty for no passphrase): + Enter same passphrase again: + Your identification has been saved in /home/hi684/.ssh/id_rsa. + Your public key has been saved in /home/hi684/.ssh/id_rsa.pub. + The key fingerprint is: + SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx hi684@account-vm + The key's randomart image is: + +---[RSA 2048]----+ + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + |xxxxxxxxxxxxxxxxx| + +----[SHA256]-----+ + hi684@account-vm ~% ls -hla .ssh + total 16K + drwx------. 2 hi684 hi684 4.0K Nov 26 16:37 . + drwx------. 7 hi684 hi684 4.0K Nov 26 16:37 .. + -rw-------. 1 hi684 hi684 1.8K Nov 26 16:37 id_rsa + -rw-r--r--. 1 hi684 hi684 398 Nov 26 16:37 id_rsa.pub + ``` + +2. Select the YAML file as required. + + A **lkp-tests** folder is stored in each user directory `/home/${USER}`. + + ```shell + hi684@account-vm ~% cd lkp-tests/jobs + hi684@account-vm ~/lkp-tests/jobs% ls -hl borrow-* + -rw-r--r--. 1 root root 53 Nov 2 14:54 borrow-10d.yaml + -rw-r--r--. 1 root root 64 Nov 2 14:54 borrow-1d.yaml + -rw-r--r--. 1 root root 235 Nov 19 15:27 borrow-1h.yaml + ``` + +3. Submit the YAML file and connect to the test machine (physical machine). + + ```shell + hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=taishan200-2280-2s64p-256g borrow-1h.yaml + submit borrow-1h.yaml, got job_id=z9.170594 + query=>{"job_id":["z9.170594"]} + connect to ws://172.168.131.2:11310/filter + {"job_id":"z9.170594","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-26/taishan200-2280-2s64p-256g/openeuler-20.03-aarch64/3600/z9.170594"} + {"job_id": "z9.170594", "result_root": "/srv/result/borrow/2020-11-26/taishan200-2280-2s64p-256g/openeuler-20.03-aarch64/3600/z9.170594", "job_state": "set result root"} + {"job_id": "z9.170594", "job_state": "boot"} + {"job_id": "z9.170594", "job_state": "download"} + {"time":"2020-11-26 14:51:56","mac":"84-46-fe-26-d3-47","ip":"172.168.178.48","job_id":"z9.170594","state":"running","testbox":"taishan200-2280-2s64p-256g--a5"} + {"job_state":"running","job_id":"z9.170594"} + {"job_id": "z9.170594", "state": "set ssh port", "ssh_port": "50420", "tbox_name": "taishan200-2280-2s64p-256g--a5"} + Host 172.168.131.2 not found in /home/hi684/.ssh/known_hosts + Warning: Permanently added '[172.168.131.2]:50420' (ECDSA) to the list of known hosts. + Last login: Wed Sep 23 11:10:58 2020 + + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 + + System information as of time: Thu Nov 26 14:51:59 CST 2020 + + System load: 1.31 + Processes: 1020 + Memory used: 5.1% + Swap used: 0.0% + Usage On: 3% + IP address: 172.168.178.48 + Users online: 1 + + + + root@taishan200-2280-2s64p-256g--a5 ~# + ``` + + For more information about how to use the **submit** command, testbox options, and how to borrow the specified operating system, see the FAQ at the end of this document. + +4. Return the test machine (physical machine) after use. + + ```shell + root@taishan200-2280-2s64p-256g--a5 ~# reboot + Connection to 172.168.131.2 closed by remote host. + Connection to 172.168.131.2 closed. + hi684@account-vm ~/lkp-tests/jobs% + ``` + +# FAQ + +* How Do I Change the Duration of Keeping the Test Machine when Applying for It? + + ```shell + hi684@account-vm ~/lkp-tests/jobs% cat borrow-1h.yaml + suite: borrow + testcase: borrow + + pub_key: <%= + begin + File.read("#{ENV['HOME']}/.ssh/id_rsa.pub").chomp + rescue + nil + end + %> + sshd: + # sleep at the bottom + sleep: 1h + hi684@account-vm ~/lkp-tests/jobs% grep sleep: borrow-1h.yaml + sleep: 1h + # Use the VIM editor to change the value of the sleep field. + hi684@account-vm ~/lkp-tests/jobs% vim borrow-1h.yaml + # After changing the value, submit the request again. + hi684@account-vm ~/lkp-tests/jobs% submit -c -m testbox=vm-2p8g borrow-1h.yaml + ``` + +* Guide to the **submit** Command + + Reference: [submit Command Description.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/m… + +* What Are the testbox Options? + + For details about the testbox options, visit https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts. + + > ![](./../public_sys-resources/icon-note.gif) **Note** + > + > VM testbox: vm-xxx + > + > PM testbox: taishan200-2280-xxx + + > ![](./../public_sys-resources/icon-notice.gif) **Notice** + > +> - If the testbox of a physical machine ends with `--axx`, a physical machine is specified. If a task is already in the task queue of the physical machine, the borrow task you submitted will not be processed until the previous task in the queue is completed. + > - If the testbox of a physical machine does not end with `-axx`, no physical machine is specified. In this case, the borrow task you submitted will be immediately allocated to idle physical machines in the cluster for execution. + +* How Do I Borrow the Specified Operating System? + + For details about the supported `os`, `os_arch`, and `os_version`, see [os-os\_verison-os\_arch.md](https://gitee.com/wu_fengguang/compass-ci/blob/…. diff --git a/doc/manual/compare-test-results.en.md b/doc/manual/compare-test-results.en.md index 8a7e5f7..5a5dd22 100644 --- a/doc/manual/compare-test-results.en.md +++ b/doc/manual/compare-test-results.en.md @@ -1,48 +1,48 @@ -# How Do I Compare Test Results? -The Compare feature is used to analyze the results of different jobs, show the performance waves and changes under different influencing factors, for users to analyze performance influencing factor. - -## url: https://compass-ci.openeuler.org/compare - -## options directions -### filters: - - suite: iperf, netperf, mysql, ... - - OS: openeuler 20.03, centos 7.6, ... - - os_arch: aarch64, x86 - - tbox_group: vm-2p8g, taishan200-2880-2s48p-256g, ... - we can combine the above options arbitrarily to limit compare scope. - choose at least one option as filter. - -### dimension - Dimension can select: os, os_version, os_arch, suite, tbox_group. - Within filter, we will compare all different job result by dimension - and keep other test conditions are same. - -## example: - filter: suite = iperf - dimension: os_version - - result: - os=openeuler/os_arch=aarch64/pp.iperf.protocol=tcp/pp.iperf.runtime=20/tbox_group=vm-2p8g # other test conditions keep same - - - 20.09 20.03 metric - -------------------- ------------------------------ ------------------------------ - fails:runs change fails:runs - | | | - 3:3 -100.0% 0:3 last_state.exit_fail - 3:3 -100.0% 0:3 last_state.is_incomplete_run - 3:3 -100.0% 0:3 last_state.test.iperf.exit_code.127 - 3:3 -100.0% 0:3 stderr.perf_command_failed - - - - 20.09 20.03 metric - -------------------- ------------------------------ ------------------------------ - %stddev change %stddev - \ | \ - 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps - 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps - 94.82 -44.0% 53.10 boot-time.boot - 123.11 -58.4% 51.19 boot-time.idle - 0.00 0 4.87 boot-time.kernel_boot - 4165.50 ± 12% -99.9% 5.00 interrupts.38:GICv3.36.Level.virtio0 \ No newline at end of file +# How Do I Compare Test Results? +The Compare feature is used to analyze the results of different jobs, show the performance waves and changes under different influencing factors, for users to analyze performance influencing factor. + +## url: https://compass-ci.openeuler.org/compare + +## options directions +### filters: + - suite: iperf, netperf, mysql, ... + - OS: openeuler 20.03, centos 7.6, ... + - os_arch: aarch64, x86 + - tbox_group: vm-2p8g, taishan200-2880-2s48p-256g, ... + we can combine the above options arbitrarily to limit compare scope. + choose at least one option as filter. + +### dimension + Dimension can select: os, os_version, os_arch, suite, tbox_group. + Within filter, we will compare all different job result by dimension + and keep other test conditions are same. + +## example: + filter: suite = iperf + dimension: os_version + + result: + os=openeuler/os_arch=aarch64/pp.iperf.protocol=tcp/pp.iperf.runtime=20/tbox_group=vm-2p8g # other test conditions keep same + + + 20.09 20.03 metric + -------------------- ------------------------------ ------------------------------ + fails:runs change fails:runs + | | | + 3:3 -100.0% 0:3 last_state.exit_fail + 3:3 -100.0% 0:3 last_state.is_incomplete_run + 3:3 -100.0% 0:3 last_state.test.iperf.exit_code.127 + 3:3 -100.0% 0:3 stderr.perf_command_failed + + + + 20.09 20.03 metric + -------------------- ------------------------------ ------------------------------ + %stddev change %stddev + \ | \ + 4.461021e+10 ± 6% -17.4% 3.686392e+10 ± 12% iperf.tcp.receiver.bps + 4.461112e+10 ± 6% -17.4% 3.686935e+10 ± 12% iperf.tcp.sender.bps + 94.82 -44.0% 53.10 boot-time.boot + 123.11 -58.4% 51.19 boot-time.idle + 0.00 0 4.87 boot-time.kernel_boot + 4165.50 ± 12% -99.9% 5.00 interrupts.38:GICv3.36.Level.virtio0 diff --git a/doc/manual/submit-command-description.md b/doc/manual/submit-command-description.md index b0faf99..4ea431c 100644 --- a/doc/manual/submit-command-description.md +++ b/doc/manual/submit-command-description.md @@ -1,208 +1,208 @@ -# submit Command Description - -### Prerequisites - -The Compass-CI client has been installed. For details, see [Installing the Local Compass-CI Client](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/本地…. - -### Purpose - -You can run the **submit** command to submit a test task. This command provides multiple options to help you submit tasks more flexibly. You can enter the **submit** command in the command line to view the help information and use the command flexibly as required. - -### Basic Usage - -The test task is submitted in a YAML file. You need to prepare the YAML file of the test task. This document uses **iperf.yaml** as an example. Run the following command to submit a test task: - -``` -submit iperf.yaml -``` - -The following message is displayed: - -```shell -hi8109@account-vm ~% submit iperf.yaml -submit iperf.yaml, got job_id=z9.173924 -``` - -The **testbox** field has been added to the **iperf.yaml** file shown in this document. If the YAML file does not contain this field, an error is reported: - -```shell -hi8109@account-vm ~% submit iperf.yaml -submit iperf.yaml failed, got job_id=0, error: Missing required job key: 'testbox' -``` - -You can add the **testbox** field to the YAML file or run the following command: - -``` -submit iperf.yaml testbox=vm-2p8g -``` - -The value of the **testbox** field specifies the required test machine. You can run the `ls` command to view the available test machines in the `lkp-tests/hosts` path, as shown in the following figure: - -```shell -hi8109@account-vm ~/lkp-tests/hosts% ll -total 120K --rw-r--r--. 1 root root 76 2020-11-02 14:54 vm-snb --rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p8g --rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p4g --rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p1g --rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-1p1g --rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p8g --rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p4g --rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p1g --rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-1p1g --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p8g-pxe --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p8g --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p4g-pxe --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p4g --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p1g-pxe --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p1g --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-1p1g-pxe --rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-1p1g --rw-r--r--. 1 root root 14 2020-11-02 14:54 taishan200-2280-2s64p-256g --rw-r--r--. 1 root root 497 2020-11-02 14:54 lkp-skl-d01 --rw-r--r--. 1 root root 574 2020-11-02 14:54 lkp-ivb-d04 --rw-r--r--. 1 root root 606 2020-11-02 14:54 lkp-ivb-d02 --rw-r--r--. 1 root root 384 2020-11-02 14:54 lkp-ivb-d01 --rw-r--r--. 1 root root 388 2020-11-02 14:54 lkp-hsw-d01 --rw-r--r--. 1 root root 385 2020-11-02 14:54 lkp-bdw-de1 --rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-8g --rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-4g --rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-2g --rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-1g --rw-r--r--. 1 root root 13 2020-11-02 14:54 2288hv5-2s64p --rw-r--r--. 1 root root 74 2020-11-02 14:54 vm-snb-i386 -``` - -> ![](./../public_sys-resources/icon-note.gif) **Note** -> -> Use the equal sign (=) to update the fields in the YAML file. The priority of the ***=*** varies with its position in the command line. -> -> * In the **submit iperf.yaml testbox=vm-2p8g** command, the **=** is defined after the YAML file. As a result, the priority of the **=** is higher than that of the YAML file. **testbox=vm-2p8g** overrides the **testbox** field defined in the YAML file. -> * In the **submit testbox=vm-2p8g iperf.yaml** command, the **=** is defined before the YAML file. As a result, the priority of **=** is lower than that of the YAML file. **testbox=vm-2p8g** does not override the **testbox** field defined in the YAML file. A value is assigned only when the YAML file does not contain the **testbox** field. - -### Advanced Usage - -The following figure shows the options of the **submit** command: - -```shell -hi8109@account-vm ~% submit -Usage: submit [options] job1.yaml job2.yaml ... - submit test jobs to the scheduler - -options: - -s, --set 'KEY: VALUE' add YAML hash to job - -o, --output DIR save job yaml to DIR/ - -a, --auto-define-files auto add define_files - -c, --connect auto connect to the host - -m, --monitor monitor job status: use -m 'KEY: VALUE' to add rule - --my-queue add to my queue -``` - -* **Usage of -s** - - You can use the **-s'KEY:VALUE'** parameter to update the key-value pair to the submitted task. An example is shown in the following figure: - - ``` - submit -s 'testbox: vm-2p8g' iperf.yaml - ``` - - * If the **iperf.yaml** file does not contain **testbox: vm-2p8g**, the field will be added to the submitted task. - * If the **iperf.yaml** file contains the **testbox** field but the value is not **vm-2p8g**, the value of **testbox** in the submitted task will be updated as **vm-2p8g**. - -* **Usage of -o** - - You can run the **-o DIR** command to save the generated YAML file to the specified directory **DIR**. An example is shown in the following figure: - - ``` - submit -o ~/iperf.yaml - ``` - - After the command is executed, the YAML file that has been processed by the **submit** command is generated in the specified directory. - -* **Usage of -a** - - If the **lkp-tests** on the client is changed in the test case, you need to use the **-a** option for adaptation. Synchronize the modification made in the **lkp-tests** on the client to the server, and generate a customized test script on the test machine. An example is shown in the following figure: - - ``` - submit -a iperf.yaml - ``` - -* **Usage of -m** - - You can use the **-m** parameter to enable the task monitoring function and print the status information during the task execution on the console. In this way, you can monitor the execution process of the test task in real time. An example is shown in the following figure: - - ``` - submit -m iperf.yaml - ``` - - The following information is displayed on the console: - - ```shell - hi8109@account-vm ~% submit -m iperf.yaml - submit iperf.yaml, got job_id=z9.173923 - query=>{"job_id":["z9.173923"]} - connect to ws://172.168.131.2:11310/filter - {"job_id":"z9.173923","message":"","job_state":"submit","result_root":"/srv/result/iperf/2020-11-30/vm-2p8g/openeuler-20.03-aarch6 - {"job_id": "z9.173923", "result_root": "/srv/result/iperf/2020-11-30/vm-2p8g/openeuler-20.03-aarch64/tcp-30/z9.173923", "job_state - {"job_id": "z9.173923", "job_state": "boot"} - {"job_id": "z9.173923", "job_state": "download"} - {"time":"2020-11-30 20:28:16","mac":"0a-f5-9f-83-62-ea","ip":"172.18.192.21","job_id":"z9.173923","state":"running","testbox":"vm- - {"job_state":"running","job_id":"z9.173923"} - {"job_state":"post_run","job_id":"z9.173923"} - {"start_time":"2020-11-30 12:25:15","end_time":"2020-11-30 12:25:45","loadavg":"1.12 0.38 0.14 1/105 1956","job_id":"z9.173923"} - {"job_state":"finished","job_id":"z9.173923"} - {"job_id": "z9.173923", "job_state": "complete"} - {"time":"2020-11-30 20:28:54","mac":"0a-f5-9f-83-62-ea","ip":"172.18.192.21","job_id":"z9.173923","state":"rebooting","testbox":"v - {"job_id": "z9.173923", "job_state": "extract_finished"} - connection closed: normal - ``` - -* **Usage of -c** - - The **-c** parameter must be used together with the **-m** parameter to implement the automatic login function in the task of applying for a device. - - An example is shown in the following figure: - - ``` - submit -m -c borrow-1h.yaml - ``` - - After submitting a task of applying for a device, you will receive the returned login information, such as `ssh ip -p port`. After adding the **-c** parameter, you can log in to the executor without manually entering the SSH login command. - - The following information is displayed on the console: - - ```shell - hi8109@account-vm ~% submit -m -c borrow-1h.yaml - submit borrow-1h.yaml, got job_id=z9.173925 - query=>{"job_id":["z9.173925"]} - connect to ws://172.168.131.2:11310/filter - {"job_id":"z9.173925","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-30/vm-2p8g/openeuler-20.03-aarch - {"job_id": "z9.173925", "result_root": "/srv/result/borrow/2020-11-30/vm-2p8g/openeuler-20.03-aarch64/3600/z9.173925", "job_state" - {"job_id": "z9.173925", "job_state": "boot"} - {"job_id": "z9.173925", "job_state": "download"} - {"time":"2020-11-30 20:35:04","mac":"0a-24-5d-c8-aa-d0","ip":"172.18.101.4","job_id":"z9.173925","state":"running","testbox":"vm-2 - {"job_state":"running","job_id":"z9.173925"} - {"job_id": "z9.173925", "state": "set ssh port", "ssh_port": "50200", "tbox_name": "vm-2p8g.taishan200-2280-2s48p-256g--a52-7"} - Host 172.168.131.2 not found in /home/hi8109/.ssh/known_hosts - Warning: Permanently added '[172.168.131.2]:50200' (ECDSA) to the list of known hosts. - Last login: Wed Sep 23 11:10:58 2020 - - - Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 - - System information as of time: Mon Nov 30 12:32:04 CST 2020 - - System load: 0.50 - Processes: 105 - Memory used: 6.1% - Swap used: 0.0% - Usage On: 89% - IP address: 172.17.0.1 - Users online: 1 - - - - root@vm-2p8g ~# - ``` - - You log in to the executor successfully. \ No newline at end of file +# submit Command Description + +### Prerequisites + +The Compass-CI client has been installed. For details, see [Installing the Local Compass-CI Client](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/本地…. + +### Purpose + +You can run the **submit** command to submit a test task. This command provides multiple options to help you submit tasks more flexibly. You can enter the **submit** command in the command line to view the help information and use the command flexibly as required. + +### Basic Usage + +The test task is submitted in a YAML file. You need to prepare the YAML file of the test task. This document uses **iperf.yaml** as an example. Run the following command to submit a test task: + +``` +submit iperf.yaml +``` + +The following message is displayed: + +```shell +hi8109@account-vm ~% submit iperf.yaml +submit iperf.yaml, got job_id=z9.173924 +``` + +The **testbox** field has been added to the **iperf.yaml** file shown in this document. If the YAML file does not contain this field, an error is reported: + +```shell +hi8109@account-vm ~% submit iperf.yaml +submit iperf.yaml failed, got job_id=0, error: Missing required job key: 'testbox' +``` + +You can add the **testbox** field to the YAML file or run the following command: + +``` +submit iperf.yaml testbox=vm-2p8g +``` + +The value of the **testbox** field specifies the required test machine. You can run the `ls` command to view the available test machines in the `lkp-tests/hosts` path, as shown in the following figure: + +```shell +hi8109@account-vm ~/lkp-tests/hosts% ll +total 120K +-rw-r--r--. 1 root root 76 2020-11-02 14:54 vm-snb +-rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p8g +-rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p4g +-rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-2p1g +-rw-r--r--. 1 root root 64 2020-11-02 14:54 vm-pxe-hi1620-1p1g +-rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p8g +-rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p4g +-rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-2p1g +-rw-r--r--. 1 root root 75 2020-11-02 14:54 vm-hi1620-1p1g +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p8g-pxe +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p8g +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p4g-pxe +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p4g +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p1g-pxe +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-2p1g +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-1p1g-pxe +-rw-r--r--. 1 root root 61 2020-11-02 14:54 vm-1p1g +-rw-r--r--. 1 root root 14 2020-11-02 14:54 taishan200-2280-2s64p-256g +-rw-r--r--. 1 root root 497 2020-11-02 14:54 lkp-skl-d01 +-rw-r--r--. 1 root root 574 2020-11-02 14:54 lkp-ivb-d04 +-rw-r--r--. 1 root root 606 2020-11-02 14:54 lkp-ivb-d02 +-rw-r--r--. 1 root root 384 2020-11-02 14:54 lkp-ivb-d01 +-rw-r--r--. 1 root root 388 2020-11-02 14:54 lkp-hsw-d01 +-rw-r--r--. 1 root root 385 2020-11-02 14:54 lkp-bdw-de1 +-rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-8g +-rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-4g +-rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-2g +-rw-r--r--. 1 root root 11 2020-11-02 14:54 dc-1g +-rw-r--r--. 1 root root 13 2020-11-02 14:54 2288hv5-2s64p +-rw-r--r--. 1 root root 74 2020-11-02 14:54 vm-snb-i386 +``` + +> ![](./../public_sys-resources/icon-note.gif) **Note** +> +> Use the equal sign (=) to update the fields in the YAML file. The priority of the ***=*** varies with its position in the command line. +> +> * In the **submit iperf.yaml testbox=vm-2p8g** command, the **=** is defined after the YAML file. As a result, the priority of the **=** is higher than that of the YAML file. **testbox=vm-2p8g** overrides the **testbox** field defined in the YAML file. +> * In the **submit testbox=vm-2p8g iperf.yaml** command, the **=** is defined before the YAML file. As a result, the priority of **=** is lower than that of the YAML file. **testbox=vm-2p8g** does not override the **testbox** field defined in the YAML file. A value is assigned only when the YAML file does not contain the **testbox** field. + +### Advanced Usage + +The following figure shows the options of the **submit** command: + +```shell +hi8109@account-vm ~% submit +Usage: submit [options] job1.yaml job2.yaml ... + submit test jobs to the scheduler + +options: + -s, --set 'KEY: VALUE' add YAML hash to job + -o, --output DIR save job yaml to DIR/ + -a, --auto-define-files auto add define_files + -c, --connect auto connect to the host + -m, --monitor monitor job status: use -m 'KEY: VALUE' to add rule + --my-queue add to my queue +``` + +* **Usage of -s** + + You can use the **-s'KEY:VALUE'** parameter to update the key-value pair to the submitted task. An example is shown in the following figure: + + ``` + submit -s 'testbox: vm-2p8g' iperf.yaml + ``` + + * If the **iperf.yaml** file does not contain **testbox: vm-2p8g**, the field will be added to the submitted task. + * If the **iperf.yaml** file contains the **testbox** field but the value is not **vm-2p8g**, the value of **testbox** in the submitted task will be updated as **vm-2p8g**. + +* **Usage of -o** + + You can run the **-o DIR** command to save the generated YAML file to the specified directory **DIR**. An example is shown in the following figure: + + ``` + submit -o ~/iperf.yaml + ``` + + After the command is executed, the YAML file that has been processed by the **submit** command is generated in the specified directory. + +* **Usage of -a** + + If the **lkp-tests** on the client is changed in the test case, you need to use the **-a** option for adaptation. Synchronize the modification made in the **lkp-tests** on the client to the server, and generate a customized test script on the test machine. An example is shown in the following figure: + + ``` + submit -a iperf.yaml + ``` + +* **Usage of -m** + + You can use the **-m** parameter to enable the task monitoring function and print the status information during the task execution on the console. In this way, you can monitor the execution process of the test task in real time. An example is shown in the following figure: + + ``` + submit -m iperf.yaml + ``` + + The following information is displayed on the console: + + ```shell + hi8109@account-vm ~% submit -m iperf.yaml + submit iperf.yaml, got job_id=z9.173923 + query=>{"job_id":["z9.173923"]} + connect to ws://172.168.131.2:11310/filter + {"job_id":"z9.173923","message":"","job_state":"submit","result_root":"/srv/result/iperf/2020-11-30/vm-2p8g/openeuler-20.03-aarch6 + {"job_id": "z9.173923", "result_root": "/srv/result/iperf/2020-11-30/vm-2p8g/openeuler-20.03-aarch64/tcp-30/z9.173923", "job_state + {"job_id": "z9.173923", "job_state": "boot"} + {"job_id": "z9.173923", "job_state": "download"} + {"time":"2020-11-30 20:28:16","mac":"0a-f5-9f-83-62-ea","ip":"172.18.192.21","job_id":"z9.173923","state":"running","testbox":"vm- + {"job_state":"running","job_id":"z9.173923"} + {"job_state":"post_run","job_id":"z9.173923"} + {"start_time":"2020-11-30 12:25:15","end_time":"2020-11-30 12:25:45","loadavg":"1.12 0.38 0.14 1/105 1956","job_id":"z9.173923"} + {"job_state":"finished","job_id":"z9.173923"} + {"job_id": "z9.173923", "job_state": "complete"} + {"time":"2020-11-30 20:28:54","mac":"0a-f5-9f-83-62-ea","ip":"172.18.192.21","job_id":"z9.173923","state":"rebooting","testbox":"v + {"job_id": "z9.173923", "job_state": "extract_finished"} + connection closed: normal + ``` + +* **Usage of -c** + + The **-c** parameter must be used together with the **-m** parameter to implement the automatic login function in the task of applying for a device. + + An example is shown in the following figure: + + ``` + submit -m -c borrow-1h.yaml + ``` + + After submitting a task of applying for a device, you will receive the returned login information, such as `ssh ip -p port`. After adding the **-c** parameter, you can log in to the executor without manually entering the SSH login command. + + The following information is displayed on the console: + + ```shell + hi8109@account-vm ~% submit -m -c borrow-1h.yaml + submit borrow-1h.yaml, got job_id=z9.173925 + query=>{"job_id":["z9.173925"]} + connect to ws://172.168.131.2:11310/filter + {"job_id":"z9.173925","message":"","job_state":"submit","result_root":"/srv/result/borrow/2020-11-30/vm-2p8g/openeuler-20.03-aarch + {"job_id": "z9.173925", "result_root": "/srv/result/borrow/2020-11-30/vm-2p8g/openeuler-20.03-aarch64/3600/z9.173925", "job_state" + {"job_id": "z9.173925", "job_state": "boot"} + {"job_id": "z9.173925", "job_state": "download"} + {"time":"2020-11-30 20:35:04","mac":"0a-24-5d-c8-aa-d0","ip":"172.18.101.4","job_id":"z9.173925","state":"running","testbox":"vm-2 + {"job_state":"running","job_id":"z9.173925"} + {"job_id": "z9.173925", "state": "set ssh port", "ssh_port": "50200", "tbox_name": "vm-2p8g.taishan200-2280-2s48p-256g--a52-7"} + Host 172.168.131.2 not found in /home/hi8109/.ssh/known_hosts + Warning: Permanently added '[172.168.131.2]:50200' (ECDSA) to the list of known hosts. + Last login: Wed Sep 23 11:10:58 2020 + + + Welcome to 4.19.90-2003.4.0.0036.oe1.aarch64 + + System information as of time: Mon Nov 30 12:32:04 CST 2020 + + System load: 0.50 + Processes: 105 + Memory used: 6.1% + Swap used: 0.0% + Usage On: 89% + IP address: 172.17.0.1 + Users online: 1 + + + + root@vm-2p8g ~# + ``` + + You log in to the executor successfully. diff --git a/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md b/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md index bb0af45..7a38e5e 100644 --- a/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md +++ b/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md @@ -1,71 +1,71 @@ -# How DO I Use the Compass-CI Platform to Test Open Source Projects? - -This document describes how to use the Compass-CI platform to test open source projects. - -### Adding the URL of the Repository to Be Tested to the upstream-repos Repository - -Perform the following steps to add the information of the code repository to be tested to the **upstream-repos** repository (https://gitee.com/wu_fengguang/upstream-repos) in YAML format: - -1. Fork the code repository to be tested and clone it to the local host. This document uses the **backlight** repository (https://github.com/baskerville/backlight) as an example. - -![](./../pictures/fork_blacklight.png) - -2. Run the following command to create a file path named with the repository name and its initial letter: - - ``` - mkdir -p b/backlight - ``` - -3. Run the following command to create the **backlight** file in the directory: - - ``` - cd b/backlight - touch backlight - ``` - -4. Run the following command to write the URL of the **backlight** repository to the **backlight** file: - - ``` - vim backlight - ``` - - The format is as follows: - - ``` - --- - url: - - https://github.com/baskerville/backlight - ``` - - > ![](./../public_sys-resources/icon-notice.gif) **Note** - > - > You can refer to the existing file format in the **upstream-repos** repository. Ensure that the formats are consistent. - -5. Run the **Pull Request** command to submit the new **backlight** file to the **backlight** repository. - -### Submitting the Test Task to the Compass-CI Platform - -1. Prepare a test case. - - You can compile and add a test case to the **lkp-tests** repository, or directly use the existing test cases in the **jobs** directory of the **lkp-tests** repository (https://gitee.com/wu_fengguang/lkp-tests). - - * Use the test cases that have been adapted in the repository. - - Use the test cases in the **lkp-tests** repository that meet the requirements. The **iperf.yaml** file is used as an example. The **iperf.yaml** file is a test case that has been adapted. It is stored in the **jobs** directory of the **lkp-tests** repository, and contains some basic test parameters. - - * Compile a test case and add it to the repository. - - For details, see [How To Add Test Cases](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add-testcas…. - -2. Configure the **auto\_submit.yaml** file and submit the test task. - - You only need to add the following configuration information to the **sbin/auto\_submit.yaml** file in the **compass-ci** repository: - - ``` - b/backlight/backlight: - - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml - ``` - - Submit the modified **auto\_submit.yaml** file to the **compass-ci** repository using Pull Request. Then you can use the Compass-CI platform to test your project. - - For details about how to set parameters in the **auto\_submit.yaml** file, see https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job. \ No newline at end of file +# How DO I Use the Compass-CI Platform to Test Open Source Projects? + +This document describes how to use the Compass-CI platform to test open source projects. + +### Adding the URL of the Repository to Be Tested to the upstream-repos Repository + +Perform the following steps to add the information of the code repository to be tested to the **upstream-repos** repository (https://gitee.com/wu_fengguang/upstream-repos) in YAML format: + +1. Fork the code repository to be tested and clone it to the local host. This document uses the **backlight** repository (https://github.com/baskerville/backlight) as an example. + +![](./../pictures/fork_blacklight.png) + +2. Run the following command to create a file path named with the repository name and its initial letter: + + ``` + mkdir -p b/backlight + ``` + +3. Run the following command to create the **backlight** file in the directory: + + ``` + cd b/backlight + touch backlight + ``` + +4. Run the following command to write the URL of the **backlight** repository to the **backlight** file: + + ``` + vim backlight + ``` + + The format is as follows: + + ``` + --- + url: + - https://github.com/baskerville/backlight + ``` + + > ![](./../public_sys-resources/icon-notice.gif) **Note** + > + > You can refer to the existing file format in the **upstream-repos** repository. Ensure that the formats are consistent. + +5. Run the **Pull Request** command to submit the new **backlight** file to the **backlight** repository. + +### Submitting the Test Task to the Compass-CI Platform + +1. Prepare a test case. + + You can compile and add a test case to the **lkp-tests** repository, or directly use the existing test cases in the **jobs** directory of the **lkp-tests** repository (https://gitee.com/wu_fengguang/lkp-tests). + + * Use the test cases that have been adapted in the repository. + + Use the test cases in the **lkp-tests** repository that meet the requirements. The **iperf.yaml** file is used as an example. The **iperf.yaml** file is a test case that has been adapted. It is stored in the **jobs** directory of the **lkp-tests** repository, and contains some basic test parameters. + + * Compile a test case and add it to the repository. + + For details, see [How To Add Test Cases](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add-testcas…. + +2. Configure the **auto\_submit.yaml** file and submit the test task. + + You only need to add the following configuration information to the **sbin/auto\_submit.yaml** file in the **compass-ci** repository: + + ``` + b/backlight/backlight: + - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml + ``` + + Submit the modified **auto\_submit.yaml** file to the **compass-ci** repository using Pull Request. Then you can use the Compass-CI platform to test your project. + + For details about how to set parameters in the **auto\_submit.yaml** file, see https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job. diff --git a/doc/manual/view-task-results.en.md b/doc/manual/view-task-results.en.md index bd266df..427f74c 100644 --- a/doc/manual/view-task-results.en.md +++ b/doc/manual/view-task-results.en.md @@ -1,23 +1,23 @@ -# How Do I View Task Results? - -After a test case is executed, you can log in to the https://compass-ci.openeuler.org/jobs to view the execution result. - -You can find the task on the website using the suite defined during task submission or the ID returned after the task is submitted, and click the **job\_state** column corresponding to the task to view the task result. - -![](./../pictures/jobs.png) - -## Result Files - -**job.yaml File** - -Some fields in the **job.yaml** file are submitted by users, and other fields in the file are automatically added by the platform based on the submitted jobs. This file contains all the parameters required for the test task. - -**output File** - -The **output** file records the execution process of a test case. The **check\_exit\_code** status code is usually displayed at the end of the file. If the status code is not 0, the test case is incorrect. - -**stats.json** - -After a test case is executed, a file with the same name as that of the test case is generated. The file records the test commands and standardized output results. Compass-CI parses these files and generates a file with the file name extension **.json**. - -The **stats.json** file incorporates all JSON files. The key results of all test commands are included in this file for subsequent comparison and analysis. \ No newline at end of file +# How Do I View Task Results? + +After a test case is executed, you can log in to the https://compass-ci.openeuler.org/jobs to view the execution result. + +You can find the task on the website using the suite defined during task submission or the ID returned after the task is submitted, and click the **job\_state** column corresponding to the task to view the task result. + +![](./../pictures/jobs.png) + +## Result Files + +**job.yaml File** + +Some fields in the **job.yaml** file are submitted by users, and other fields in the file are automatically added by the platform based on the submitted jobs. This file contains all the parameters required for the test task. + +**output File** + +The **output** file records the execution process of a test case. The **check\_exit\_code** status code is usually displayed at the end of the file. If the status code is not 0, the test case is incorrect. + +**stats.json** + +After a test case is executed, a file with the same name as that of the test case is generated. The file records the test commands and standardized output results. Compass-CI parses these files and generates a file with the file name extension **.json**. + +The **stats.json** file incorporates all JSON files. The key results of all test commands are included in this file for subsequent comparison and analysis. diff --git "a/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" "b/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" index e73b9f9..cbbcaef 100644 --- "a/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" +++ "b/doc/manual/\345\246\202\344\275\225\344\275\277\347\224\250compass-ci\346\265\213\350\257\225\345\274\200\346\272\220\351\241\271\347\233\256.md" @@ -1,68 +1,68 @@ -# 使用 compass-ci 平台测试开源项目 - -本文介绍了使用 compass-ci 平台测试开源项目的操作。 - -### 添加待测试仓库 URL 到 upstream-repos 仓库 - -执行以下步骤，将想要测试的代码仓信息以 yaml 文件的方式添加到 upstream-repos 仓库（https://gitee.com/wu_fengguang/upstream-repos ）。 - -1. Fork 要测试的代码仓库并 git clone 到本地，本文以 blacklight 仓库（https://github.com/baskerville/backlight ）为例说明。 - -![](./../pictures/fork_blacklight.png) - -2. 执行以下命令，以首字母和仓库名创建文件路径。 - - ``` - mkdir -p b/backlight - ``` - -3. 执行以下命令，在该目录下新建同名文件 backlight。 - ``` - cd b/backlight - touch backlight - ``` - -4. 执行以下命令，将 backlight 仓库 url 信息写入 backlight 文件。 - - ``` - vim backlight - ``` - 内容格式为 - - ``` - --- - url: - - https://github.com/baskerville/backlight - ``` - - >![](./../public_sys-resources/icon-notice.gif) **注意：** - > - >可参考 upstream-repos 仓库中已有文件格式,请保持格式一致。 - -5. 通过 Pull Request 命令将新增的 backlight 文件提交到 blacklight 仓库。 - - -### 提交测试任务到 compass-ci 平台 - -1. 准备测试用例 - - 测试用例可以自己编写并添加到 lkp-tests 仓库，也可以直接使用 lkp-tests 仓库（https://gitee.com/wu_fengguang/lkp-tests ）的 jobs 目录下已有的测试用例。 - - * 使用仓库中已经适配好的测试用例 - 如果 lkp-tests 仓库中正好有你想要的测试用例，你可以直接使用。以 iperf.yaml 文件为例说明如下： - iperf.yaml 是一个已经适配好的测试用例，它位于 lkp-tests 仓库的 jobs 目录下，其中有一些基本的测试参数。 - - * 编写测试用例并添加到仓库 - - 请参考：[如何添加测试用例](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add… ) - -2. 配置 auto_submit.yaml 文件，提交测试任务 - - 你只需要在 compass-ci 仓库下面的 sbin/auto_submit.yaml 文件中添加配置信息，如： - ``` - b/backlight/backlight: - - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml - ``` - 通过 Pull Request 的方式将修改好的 auto_submit.yaml 文件提交到 compass-ci 仓库，就可以使用 compass-ci 测试你的项目了。 - - auto_submit.yaml 文件的参数配置请参考 https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job 。 +# 使用 compass-ci 平台测试开源项目 + +本文介绍了使用 compass-ci 平台测试开源项目的操作。 + +### 添加待测试仓库 URL 到 upstream-repos 仓库 + +执行以下步骤，将想要测试的代码仓信息以 yaml 文件的方式添加到 upstream-repos 仓库（https://gitee.com/wu_fengguang/upstream-repos ）。 + +1. Fork 要测试的代码仓库并 git clone 到本地，本文以 blacklight 仓库（https://github.com/baskerville/backlight ）为例说明。 + +![](./../pictures/fork_blacklight.png) + +2. 执行以下命令，以首字母和仓库名创建文件路径。 + + ``` + mkdir -p b/backlight + ``` + +3. 执行以下命令，在该目录下新建同名文件 backlight。 + ``` + cd b/backlight + touch backlight + ``` + +4. 执行以下命令，将 backlight 仓库 url 信息写入 backlight 文件。 + + ``` + vim backlight + ``` + 内容格式为 + + ``` + --- + url: + - https://github.com/baskerville/backlight + ``` + + >![](./../public_sys-resources/icon-notice.gif) **注意：** + > + >可参考 upstream-repos 仓库中已有文件格式,请保持格式一致。 + +5. 通过 Pull Request 命令将新增的 backlight 文件提交到 blacklight 仓库。 + + +### 提交测试任务到 compass-ci 平台 + +1. 准备测试用例 + + 测试用例可以自己编写并添加到 lkp-tests 仓库，也可以直接使用 lkp-tests 仓库（https://gitee.com/wu_fengguang/lkp-tests ）的 jobs 目录下已有的测试用例。 + + * 使用仓库中已经适配好的测试用例 + 如果 lkp-tests 仓库中正好有你想要的测试用例，你可以直接使用。以 iperf.yaml 文件为例说明如下： + iperf.yaml 是一个已经适配好的测试用例，它位于 lkp-tests 仓库的 jobs 目录下，其中有一些基本的测试参数。 + + * 编写测试用例并添加到仓库 + + 请参考：[如何添加测试用例](https://gitee.com/wu_fengguang/lkp-tests/blob/master/doc/add… ) + +2. 配置 auto_submit.yaml 文件，提交测试任务 + + 你只需要在 compass-ci 仓库下面的 sbin/auto_submit.yaml 文件中添加配置信息，如： + ``` + b/backlight/backlight: + - testbox=vm-2p8g os=openEuler os_version=20.03 os_mount=initramfs os_arch=aarch64 iperf.yaml + ``` + 通过 Pull Request 的方式将修改好的 auto_submit.yaml 文件提交到 compass-ci 仓库，就可以使用 compass-ci 测试你的项目了。 + + auto_submit.yaml 文件的参数配置请参考 https://gitee.com/wu_fengguang/compass-ci/tree/master/doc/job 。 -- 2.23.0

1 0

[PATCH compass-ci 2/2] scheduler: subqueue: submit job to subqueue
by Ren Wen 10 Dec '20

10 Dec '20

Submit the job to subqueue which related to the user, to resolve the problem that every user's job should be consumed. For example, if one user submits 1000+ jobs to queue 'vm-2p8g', another submits 1 job, it's too long time to wait to consume another's job. Signed-off-by: Ren Wen <15991987063(a)163.com> --- src/lib/job.cr | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/lib/job.cr b/src/lib/job.cr index a4345e0..225f9c1 100644 --- a/src/lib/job.cr +++ b/src/lib/job.cr @@ -152,6 +152,7 @@ class Job set_lkp_server() set_sshr_info() set_queue() + set_sub_queue() end private def set_kernel @@ -257,6 +258,11 @@ class Job end end + private def set_sub_queue + # queue: vm-2p8g.zs:zs@mail.com + self["queue"] = "#{self["queue"]}.#{self["my_name"]}:#{self["my_email"]}" + end + # if not assign tbox_group, set it to a match result from testbox # ?if job special testbox, should we just set tbox_group=textbox private def update_tbox_group_from_testbox -- 2.23.0

2 2

[PATCH compass-ci 2/2] doc/manual: fix PKGBUILD doc
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- ...le-pkgbuild.en.md => write-pkgbuild.en.md} | 164 +++++++++--------- 1 file changed, 79 insertions(+), 85 deletions(-) rename doc/manual/{compile-pkgbuild.en.md => write-pkgbuild.en.md} (61%) diff --git a/doc/manual/compile-pkgbuild.en.md b/doc/manual/write-pkgbuild.en.md similarity index 61% rename from doc/manual/compile-pkgbuild.en.md rename to doc/manual/write-pkgbuild.en.md index 097e0b8..7969b71 100644 --- a/doc/manual/compile-pkgbuild.en.md +++ b/doc/manual/write-pkgbuild.en.md @@ -1,85 +1,79 @@ -# PKGBUILD - -A PKGBUILD is a shell script. makepkg uses the instructions contained in PKGBUILD to generate a software package that incorporates binary files and installation instructions. - -# What Does PKGBUILD Include? - -PKGBUILD includes variables and functions. - -## Defining a Variable - -- pkgname: Mandatory. It indicates the name of a software package. -- pkgver: Mandatory. It indicates the version of a software package. -- pkgrel: Mandatory. It indicates the release number of a software package. -- arch: Mandatory. It indicates the architecture sequence of a software package. -- depends: Optional. It indicates the name of the dependency package required for running a software test. -- makedepends: Optional. It indicates the list of files required for building a software package. -- source: Optional. It indicates the MD5 hash value of each source file to verify the integrity of the source file during the build process. - -## Defining a Function - -- package function - - Mandatory. It is used for installing files to the directory that will be the root directory of the build package. - -- prepare function - - Optional. It is used for executing the operation of building source code. - -- build function - - Optional. It is used for compiling and/or building source code. - -- check function - - Optional. It is used for running the test suite of the program package. - -> ![](./../public_sys-resources/icon-notice.gif) **Notice** -> -> **srcdir** is the directory for extracting or copying source files. All packaging functions run in the **srcdir** directory. **pkgdir** is the root directory for building software packages and is used only in the package function. - -# How Do I Compile PKGBUILD? - -1. Run the following command to create a PKGBUILD. The file name must be **PKGBUILD**. - - ```shell - touch PKGBUILD - ``` - -2. Use the vim editor to open the **PKGBUILD** file and compile it. The following is an example of the **PKGBUILD** file: - - ```shell - pkgname=zstd - pkgver=1.4.4 - pkgrel=2 - arch=('i686' 'x86_64' 'aarch64') - url='https://github.com/facebook/zstd' - license=('custom:BSD3' 'GPL2') - depends=('xz' 'zlib' 'lz4') - makedepends=('git') - source=('git://github.com/facebook/zstd.git#branch=dev') - md5sums=('SKIP') - - pkgver() { - cd "$srcdir/$pkgname" - git describe --long --tags | sed 's/$[^-]*-g$/r\1/;s/-/./g;s/^v//g' - } - - build() { - cd "$srcdir/$pkgname" - make - make -C contrib/pzstd - } - - package() { - cd "$srcdir/$pkgname" - make PREFIX="/usr" DESTDIR="$pkgdir/" install - install -D -m755 contrib/pzstd/pzstd "$pkgdir/usr/bin/pzstd" - install -D -m644 LICENSE "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE" - } - ``` - -# Reference - -- [PKGBUILD(5) Manual Page](https://www.archlinux.org/pacman/PKGBUILD.5.html) -- [pkgbuild demo](https://git.archlinux.org/pacman.git/plain/proto/PKGBUILD.proto) \ No newline at end of file +# PKGBUILD + +A PKGBUILD is a shell script. makepkg uses the instructions contained in PKGBUILD to generate a software package that incorporates binary files and installation instructions. + +# What Does PKGBUILD Include? + +PKGBUILD includes variables and functions. + +## Defining a Variable + +- pkgname: Mandatory. It indicates the name of a software package. +- pkgver: Mandatory. It indicates the version of a software package. +- pkgrel: Mandatory. It indicates the release number of a software package. +- arch: Mandatory. It indicates the architecture sequence of a software package. +- depends: Optional. It indicates the name of the dependency package required for running a software test. +- makedepends: Optional. It indicates the list of files required for building a software package. +- source: Optional. It indicates the MD5 hash value of each source file to verify the integrity of the source file during the build process. + +## Defining a Function + +- package function + + Mandatory. It is used for installing files to the directory that will be the root directory of the build package. + +- prepare function + + Optional. It is used for executing the operation of building source code. + +- build function + + Optional. It is used for compiling and/or building source code. + +- check function + + Optional. It is used for running the test suite of the program package. + +> ![](./../public_sys-resources/icon-notice.gif) **Notice** +> +> **srcdir** is the directory for extracting or copying source files. All packaging functions run in the **srcdir** directory. **pkgdir** is the root directory for building software packages and is used only in the package function. + +# How do i write PKGBUILD? + +1. Read official documents: + +- [PKGBUILD(5) Manual Page](https://www.archlinux.org/pacman/PKGBUILD.5.html) +- [pkgbuild demo](https://git.archlinux.org/pacman.git/plain/proto/PKGBUILD.proto) + +2. Create **PKGBUILD** file with vim or other editor. The following is an example of the **PKGBUILD** file: + +```shell +pkgname=zstd +pkgver=1.4.4 +pkgrel=2 +arch=('i686' 'x86_64' 'aarch64') +url='https://github.com/facebook/zstd' +license=('custom:BSD3' 'GPL2') +depends=('xz' 'zlib' 'lz4') +makedepends=('git') +source=('git://github.com/facebook/zstd.git#branch=dev') +md5sums=('SKIP') + +pkgver() { + cd "$srcdir/$pkgname" + git describe --long --tags | sed 's/$[^-]*-g$/r\1/;s/-/./g;s/^v//g' +} + +build() { + cd "$srcdir/$pkgname" + make + make -C contrib/pzstd +} + +package() { + cd "$srcdir/$pkgname" + make PREFIX="/usr" DESTDIR="$pkgdir/" install + install -D -m755 contrib/pzstd/pzstd "$pkgdir/usr/bin/pzstd" + install -D -m644 LICENSE "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE" +} +``` -- 2.23.0

1 0

[PATCH compass-ci 1/2] doc/manual: rename English manual files
by Wu Fengguang 10 Dec '20

10 Dec '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- ...apply-for-a-test-machine.md => apply-for-a-test-machine.en.md} | 0 ...ow-do-i-compare-test-results.md => compare-test-results.en.md} | 0 .../{how-do-i-compile-pkgbuild.md => compile-pkgbuild.en.md} | 0 ...se-the-compass-ci-platform-to-test-open-source-projects.en.md} | 0 .../{how-do-i-view-task-results.md => view-task-results.en.md} | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename doc/manual/{how-do-i-apply-for-a-test-machine.md => apply-for-a-test-machine.en.md} (100%) rename doc/manual/{how-do-i-compare-test-results.md => compare-test-results.en.md} (100%) rename doc/manual/{how-do-i-compile-pkgbuild.md => compile-pkgbuild.en.md} (100%) rename doc/manual/{how-do-i-use-the-compass-ci-platform-to-test-open-source-projects.md => use-the-compass-ci-platform-to-test-open-source-projects.en.md} (100%) rename doc/manual/{how-do-i-view-task-results.md => view-task-results.en.md} (100%) diff --git a/doc/manual/how-do-i-apply-for-a-test-machine.md b/doc/manual/apply-for-a-test-machine.en.md similarity index 100% rename from doc/manual/how-do-i-apply-for-a-test-machine.md rename to doc/manual/apply-for-a-test-machine.en.md diff --git a/doc/manual/how-do-i-compare-test-results.md b/doc/manual/compare-test-results.en.md similarity index 100% rename from doc/manual/how-do-i-compare-test-results.md rename to doc/manual/compare-test-results.en.md diff --git a/doc/manual/how-do-i-compile-pkgbuild.md b/doc/manual/compile-pkgbuild.en.md similarity index 100% rename from doc/manual/how-do-i-compile-pkgbuild.md rename to doc/manual/compile-pkgbuild.en.md diff --git a/doc/manual/how-do-i-use-the-compass-ci-platform-to-test-open-source-projects.md b/doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md similarity index 100% rename from doc/manual/how-do-i-use-the-compass-ci-platform-to-test-open-source-projects.md rename to doc/manual/use-the-compass-ci-platform-to-test-open-source-projects.en.md diff --git a/doc/manual/how-do-i-view-task-results.md b/doc/manual/view-task-results.en.md similarity index 100% rename from doc/manual/how-do-i-view-task-results.md rename to doc/manual/view-task-results.en.md -- 2.23.0

1 0

[PATCH v2 compass-ci] container: remains format consistent
by Liu Yinsi 10 Dec '20

10 Dec '20

keep start script content format consistent with others, looks more suitable. Signed-off-by: Liu Yinsi <liuyinsi(a)163.com> --- container/git-daemon/start | 12 +++++++++++- container/redis/start | 13 ++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/container/git-daemon/start b/container/git-daemon/start index 5b4c90b..72330aa 100755 --- a/container/git-daemon/start +++ b/container/git-daemon/start @@ -6,8 +6,18 @@ docker_rm git-daemon -docker run --restart=always -d -p 9418:9418 -v /srv/git:/git -v /etc/localtime:/etc/localtime:ro --name git-daemon apline311:git-daemon +cmd=( + docker run + --restart=always + --name git-daemon + -d + -p 9418:9418 + -v /srv/git:/git + -v /etc/localtime:/etc/localtime:ro + apline311:git-daemon +) +"${cmd[@]}" # test diff --git a/container/redis/start b/container/redis/start index 827ad0b..34266a0 100755 --- a/container/redis/start +++ b/container/redis/start @@ -10,7 +10,18 @@ docker_rm redis507s01 -docker run --restart=always -d -p 6379:6379 -v /srv/redis/alpine/server01:/srv/redis -v /etc/localtime:/etc/localtime:ro --name redis507s01 redis507n:alpine311 +cmd=( + docker run + --restart=always + --name redis507s01 + -d + -p 6379:6379 + -v /srv/redis/alpine/server01:/srv/redis + -v /etc/localtime:/etc/localtime:ro + redis507n:alpine311 +) + +"${cmd[@]}" # test echo you can use cmd: redis-cli to start a redis client -- 2.23.0

1 0

[PATCH v2 compass-ci] keep curl command silent mode and show error
by Liu Yinsi 10 Dec '20

10 Dec '20

change that to '-sS' will silent output but the error info Signed-off-by: Liu Yinsi <liuyinsi(a)163.com> --- container/logging-es/start | 2 +- sbin/es-accounts-mapping.sh | 4 ++-- sbin/es-jobs-mapping.sh | 6 +++--- sbin/es-regression-mapping.sh | 4 ++-- sbin/es-repo-mapping.sh | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/container/logging-es/start b/container/logging-es/start index 25ed36b..66464e6 100755 --- a/container/logging-es/start +++ b/container/logging-es/start @@ -23,7 +23,7 @@ cmd=( echo "Please wait 60s for setting index" sleep 60 -curl -H "Content-Type: application/json" -XPUT "localhost:9202/_settings" -d ' +curl -sSH "Content-Type: application/json" -XPUT "localhost:9202/_settings" -d ' { "index": { "refresh_interval": "120s", diff --git a/sbin/es-accounts-mapping.sh b/sbin/es-accounts-mapping.sh index 635f4fc..d5566dc 100755 --- a/sbin/es-accounts-mapping.sh +++ b/sbin/es-accounts-mapping.sh @@ -3,14 +3,14 @@ # Copyright (c) 2020 Huawei Technologies Co., Ltd. All rights reserved. # check whether accounts index has created -status_code=$(curl -sIL -w "%{http_code}\\n" -o /dev/null http://localhost:9200/accounts) +status_code=$(curl -sSIL -w "%{http_code}\\n" -o /dev/null http://localhost:9200/accounts) if [ "$status_code" -eq 200 ] then echo "accounts index has been created, exit." else echo "begin create index." - curl -H 'Content-Type: Application/json' -XPUT 'http://localhost:9200/accounts' -d '{ + curl -sSH 'Content-Type: Application/json' -XPUT 'http://localhost:9200/accounts' -d '{ "mappings": { "_doc": { "dynamic": false, diff --git a/sbin/es-jobs-mapping.sh b/sbin/es-jobs-mapping.sh index 52517b9..5cb9b9c 100755 --- a/sbin/es-jobs-mapping.sh +++ b/sbin/es-jobs-mapping.sh @@ -28,14 +28,14 @@ then fi # Determine whether jobs index has created -status_code=$(curl -sIL -w "%{http_code}\n" -o /dev/null http://localhost:9200/jobs) +status_code=$(curl -sSIL -w "%{http_code}\n" -o /dev/null http://localhost:9200/jobs) if [ $status_code -eq 200 ] then echo "jobs index has create, exit." else echo "jobs index not exists, begin create index." - curl -H 'Content-Type: Application/json' -XPUT 'http://localhost:9200/jobs' -d '{ + curl -sSH 'Content-Type: Application/json' -XPUT 'http://localhost:9200/jobs' -d '{ "mappings": { "_doc": { "dynamic": false, @@ -164,7 +164,7 @@ else echo "create jobs index failed." else echo "set index.mapping.total_fields.limit: 10000" - curl -XPUT 127.0.0.1:9200/jobs/_settings -H 'Content-Type: application/json' \ + curl -sS -XPUT 127.0.0.1:9200/jobs/_settings -H 'Content-Type: application/json' \ -d '{"index.mapping.total_fields.limit": 10000}' fi fi diff --git a/sbin/es-regression-mapping.sh b/sbin/es-regression-mapping.sh index 7ef19cd..8e04bdb 100755 --- a/sbin/es-regression-mapping.sh +++ b/sbin/es-regression-mapping.sh @@ -1,14 +1,14 @@ #!/bin/sh # check whether regression index has created -status_code=$(curl -sIL -w "%{http_code}\\n" -o /dev/null http://localhost:9200/regression) +status_code=$(curl -sSIL -w "%{http_code}\\n" -o /dev/null http://localhost:9200/regression) if [ "$status_code" -eq 200 ] then echo "regression index has been created, exit." else echo "begin create index." - curl -H 'Content-Type: Application/json' -XPUT 'http://localhost:9200/regression' -d '{ + curl -sSH 'Content-Type: Application/json' -XPUT 'http://localhost:9200/regression' -d '{ "mappings": { "_doc": { "dynamic": false, diff --git a/sbin/es-repo-mapping.sh b/sbin/es-repo-mapping.sh index 4605051..17f0986 100755 --- a/sbin/es-repo-mapping.sh +++ b/sbin/es-repo-mapping.sh @@ -3,12 +3,12 @@ # Copyright (c) 2020 Huawei Technologies Co., Ltd. All rights reserved. # Check if "repo" index already exists. -status_code=$(curl -sIL -w "%{http_code}\n" -o /dev/null http://localhost:9200/repo) +status_code=$(curl -sSIL -w "%{http_code}\n" -o /dev/null http://localhost:9200/repo) [ $status_code -eq 200 ] && echo '"repo" index already exists.' && exit # Create "repo" index. echo 'Start to create "repo" index.' -curl -H 'Content-Type: Application/json' -XPUT 'http://localhost:9200/repo' -d ' +curl -sSH 'Content-Type: Application/json' -XPUT 'http://localhost:9200/repo' -d ' { "mappings": { "_doc": { -- 2.23.0

1 0

[PATCH v3 lkp-tests] lkp-tests/tests: add rpmbuild-pkg to build RPM
by Zhang Yale 10 Dec '20

10 Dec '20

Signed-off-by: Zhang Yale <ylzhangah(a)qq.com> --- tests/rpmbuild-pkg | 67 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100755 tests/rpmbuild-pkg diff --git a/tests/rpmbuild-pkg b/tests/rpmbuild-pkg new file mode 100755 index 00000000..8726543e --- /dev/null +++ b/tests/rpmbuild-pkg @@ -0,0 +1,67 @@ +#!/bin/bash +# - rpm_repo + +. $LKP_SRC/lib/debug.sh +. $LKP_SRC/lib/upload.sh + +check_vars() +{ + [ -n "$rpm_repo" ] || die "rpm_repo is empty" +} + +init_dir() +{ + benchmark=${rpm_repo##*/} + RPM_MNT=/initrd/rpmbuild-pkg + mkdir -p "$RPM_MNT" + pack_to=${os_mount}/${os}/${os_arch}/${os_version}/${benchmark} + sync_dest="$RPM_MNT/$pack_to" + rpmdev-setuptree # generate workspace in ${HOME} +} + +get_pkgfile() +{ + curl -sS -H 'Content-Type: Application/json' -XPOST "$LKP_SERVER"':8100/git_command' \ + -d '{"git_repo": "'${rpm_repo}'", "git_command": ["git-show", "HEAD:'$1'"]}' -o "${2}" +} + +request_pkg() +{ + filelist=$(curl -sS -H 'Content-Type: Application/json' -XPOST "$LKP_SERVER"':8100/git_command' \ + -d '{"git_repo": "'${rpm_repo}'", "git_command": ["git-ls-files", "."]}') + local dir="SOURCES" + for pkgfile in ${filelist[*]} + do + echo $pkgfile | egrep "\.spec$" && { + dir="SPECS" + } + get_pkgfile "$pkgfile" "${HOME}/rpmbuild/${dir}/$pkgfile" + done +} + +rpmbuild_pkg() +{ + spec_dir=${HOME}/rpmbuild/SPECS/$benchmark.spec + # sed -i 's/^$Source[^ ]*:[ \t]*$https/\1http/g' `grep http -rl $benchmark.spec` + # Install build depends + yum-builddep -y $spec_dir + # Download tar.gz to default path ${HOME}/rpmbuild/SOURCE + spectool -g -R $spec_dir + # Building rpm or srpm packages + rpmbuild -ba $spec_dir +} + +upload_pkg() +{ + #rpm package will be generated in "${HOME}/rpmbuild/SRPMS" and "${HOME}/rpmbuild/RPMS" + for file in $(find ${HOME}/rpmbuild/ -type f -name "*.rpm") + do + upload_one_curl ${file} ${sync_dest} + done +} + +check_vars +init_dir +request_pkg +rpmbuild_pkg +upload_pkg -- 2.23.0

2 2

2025

2024

2023

2022

2021

2020

Compass-ci December 2020