16 Star 29 Fork 116

openEuler / openEuler-Advisor

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
MulanPSL-2.0

openEuler-Advisor

1. Introduction

openEuler-Advisor aims to provide automatic inspection and suggestions on routine work of the openEuler artifact repository.

Important directories and scripts in the current project:

(1) upstream-info: This directory contains upstream information of the software components in the artifact repository of openEuler.

(2) advisors: This directory provides some automation scripts, including:

2.1. oa_upgradable.py: a Python script based on upstream-info, which is used to query the upstream community version information and the recommended version of a software package.

2.2. simple_update_robot.py: a Python script used to automatically upgrade software packages in src-openeuler, including downloading a source package of the recommended version, modifying the spec file, compiling the OBS locally, and creating PRs and issues.

2.3. check_missing_file.py: a Python script used to inspect each repository in src-openeuler. If the spec file does not exist in a repository, you can directly create one.

2.4. check_source_url.py: a Python script used to check the source address of each software package in src-openeuler. If the address is invalid or incorrect, an issue is automatically created to notify address modification.

2.5. create_repo.py and create_repo_with_srpm: Python scripts that provide the function of creating repositories in batches.

2.6. which_archived.py: a script used to check whether the upstream community of the software in the artifact repository has been archived so that the maintenance team can adjust the package maintenance policy in a timely manner.

2.7. check_repeated_repo.py: a script used to check for duplicate software packages in src-openeuler.

2.8. psrtool.py: a script used to query the SIG to which a software package belongs and the list of software packages managed by a SIG.

2.9. tc_reminder.py: a script used to automatically create prompt information for TC members in openEuler.

2.10. review_tool.py: a script used to generate the code review list of RPs in a specified software repository PR to standardize the PR review process.

2.11. issue_report.py: a tool for automatically generating issue and CVE management tables (CSV files) and result reports (Markdown files). It provides the function of generating issue and CVE lists based on the openEuler version.

(3) prow: This directory stores the script for connecting to the CI/CD framework PROW.

2. Follow-up Plan

  1. The @solarhu team is developing a tool to query the dependencies of all components in openEuler.

  2. Optimize the simple_update_robot.py script to improve the automatic upgrade processing capability.

  3. Optimize upstream-info to cover all software in the openEuler artifact repository, and integrate all YAML files in the openEuler community into upstream-info for unified management.

  4. Optimize the upstream community code management protocol supported by oa_upgradable.py and add the support from fossil.

3. Tool Instructions

3.1 YAML File Specifications

The name of the YAML file in each src-openEuler repository must be the same as the repository name. For example, the name of the YAML file stored in the glibc repository is glibc.yaml, and the file is stored in the root directory of the repository. In a YAML file, only the version_control, src_repo, tag_prefix, and separator fields need to be manually set. Other fields are automatically generated.

3.1.1 Description of the Fields in the YAML File

1. version_control

Version control protocol used by the upstream repository. Currently, svn, git, hg, github, gnome, metacpan, pypi are supported.

2. src_repo

Actual address of the upstream repository. You can use version_control and src_repo to download the corresponding code.

3. tag_prefix

Version prefix in the tag of the upstream repository. If the git protocol is used, you can run the git tag command to display all tags. If the tag provided by the upstream is v1_0_1, tag_prefix must be set to ^v. The correct version information can be obtained by matching tag_prefix.

4. separator

Version separator in the tag. If the tag is v1_0_1 and separator is set to _, the correct version number 1.0.1 can be obtained by parsing the code.

3.1.2. Requirements and Examples of the Fields

1. src_repo
  1. If version_control is set to svn, src_repo requires a complete SVN repository address. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/amanda.yaml.

  2. If version_control is set to git, src_repo requires a complete GIT repository address. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/mdadm.yaml.

  3. If version_control is set to hg, src_repo requires a complete HG repository address. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/nginx.yaml.

  4. If version_control is set to github, src_repo requires only proj/repo and does not require a complete URL. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/asciidoc.yaml.

  5. If version_control is set to gnome, src_repo requires only $proj and does not require a complete URL. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/gnome-terminal.yaml. Note that many projects on gitlab.gnome.org require access permissions, which cannot be used as the upstream code repositories.

  6. If version_control is set to metacpan, src_repo requires only $proj and does not require a complete URL. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/perl-Authen-SASL.yaml. Pay attention to the naming specifications on metacpan.

  7. If version_control is set to pypi, src_repo requires only $proj and does not require a complete URL. For the example, see https://gitee.com/openeuler/openEuler-Advisor/blob/master/upstream-info/python-apipkg. Pay attention to the naming rules on PyPI.

2. tag_prefix

The tag rule varies depending on the project. For example, if the tag is v1.1, set tag_prefix to ^v.

3. separator

The domain separator in the tag varies according to the project. Some projects use hyphens ("-") and some use underscores ("_"). The default value is period ("."). You are advised to add double quotation marks ("").

3.1.3 Method for Verifying the Upstream Code Repository Information of Open Source Software

1) Common methods for code configuration management

git, svn, and hg can obtain the code repository information without downloading the complete code repository. The method is as follows:

- git:

git ls-remote --tags $repo_url

- svn:

svn ls -v $repo_url/tags

- hg:

curl $repo_url/json-tags
2) Common methods to use code hosting websites

- GitHub

curl https://api.github.com/repos/$user/$repo/release

A list of complete release information in JSON format can be obtained. Not all projects support this function.

curl https://api.github.com/repos/$user/$repo/tags

A list of complete tag information in JSON format can be obtained. Not all projects support this function, and this information has been found to be wrong for some projects.

- metacpan

curl https://fastapi.metacpan.org/release/$repo

The latest version information in JSON format can be obtained.

- pypi

curl https://pypi.org/pypi/$repo/json

The information about the latest version of the project can be obtained.

  • Use of tag_prefix and tag_pattern

    The tag information of some software uses prefixes, such as release-1.2.3 or v1.2.3.

    If tag_prefix is set, the same prefix is deleted from all tag strings.

    For example, a piece of software has two tags: 1.2.3 and release-1.2.2. If tag_prefix is set to release-, the processed tags are 1.2.3 and 1.2.2.

    tag_pattern is used for more complex forms and is not recommended.

  • Use of separator

    If separator is set, a character can be replaced with a period (.).

    For some software, the separator for tag domain division is not period (.). In this case, you can set a separator to standardize the version tags.

    If the separator for tag domain division is period (.), setting separator does not affect the result.

3.2 Introduction to Advisors

3.2.1 Environment Configuration

a. Install necessary software packages.
 pip3 install python-rpm-spec (ver>=0.10)
 pip3 install PyYAML (ver>=5.3.1)
 pip3 install requests (ver>=2.24.0)
 yum install rpmdevtools (ver>=8.3)
 pip3 install beautifulsoup4 (ver>=4.9.3)
 yum install yum-utils (ver>=1.1.31)
 yum install libabigail (ver>=1.6)
b. Configure JSON files.
 Run the ~/.gitee_personal_token.json command to create a JSON file.
 JSON file format: {"user":"gitee_user_name","access_token":"token_password"}
	
 Entry for setting the Gitee token password: https://gitee.com/profile/personal_access_tokens
c. Configure the Gitee SSH.
 If Gitee SSH is not configured, see https://gitee.com/help/articles/4181.
d. Configure the OBS.
 If OBS is not configured, see https://www.openeuler.org/en/.
e. Configure the Python environment.
 To use this tool in the development state, configure the Python environment path: source ./develop_env.sh.	

3.2.2 Usage Description

a. simple_update_robot.py
Automatic upgrade of a single software package: python3 simple_update_robot.py -u pkg pkg_name branch_name [-n new_version]
Example: python3 simple_update_robot.py -u pkg snappy master
	
Manual upgrade of a single software package: python3 simple_update_robot.py pkg_name branch_name [-fc] [-d] [-s] [-n new_version] [-b] [-p]
Example: python3 simple_update_robot.py snappy openEuler-20.03-LTS -fc -d -s -n 1.8.1
	
Upgrade of a repository containing multiple software packages: python3 simple_update_robot.py -u repo repo_name branch_name
Example: python3 simple_update_robot.py -u repo src-openeuler master
	
Users can configure an automatic upgrade YAML file in the local working directory, for example, upgrade-example.yaml.
 repositories:

 - name: A-Tune
 - name: python-py
 - name: python-ply
   If you want to specify an upgrade version for some software packages, you can configure as follows:
    repositories:
 - name: A-Tune
   u_ver: x.y.z
 - name: python-py
 - name: python-ply
   Then use a tool to automatically upgrade upgrade-example: python3 simple_update_robot.py -u repo upgrade-example master.
b. oa_upgradable.py
Query the upstream community information and recommended version of the software package: python3 oa_upgradable.py pkg_name
Example: python3 oa_upgradable.py glibc
c. issue_report.py
Operating environment: Python 3.8 or later
 Tool use:
 
 ```bash
 python3 issue_report.py -milestone "openEuler 20.03-LTS" "openEuler 20.09" -branch "openEuler-21.03" "openEuler-20.09" -outpath /Users/lilu/Downloads 

Parameter description:

-milestone: milestone of the openEuler version. Multiple milestone names can be entered. For example, "openEuler-21.03" and "openEuler 21.03-RC1". -branch: branch name of the src-openEuler repositories. Multiple branch names can be entered. For example, "openEuler-21.03" and "openEuler-20.09". -outpath:path where the version management report and version release report are generated.


3.2.3 Advisors Consultant

If you have any other questions, send an email to licihua@huawei.com/zwfeng@huawei.com/shanshishi@huawei.com.

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

About

Collection of automation tools for easily maintaining openEuler expand collapse
Python and 3 more languages
MulanPSL-2.0
Cancel

Releases (4)

All

Contributors

All

Activities

Load More
can not load any more
1
https://gitee.com/openeuler/openEuler-Advisor.git
git@gitee.com:openeuler/openEuler-Advisor.git
openeuler
openEuler-Advisor
openEuler-Advisor
master

Search