2 Star 0 Fork 7

zhengyaohui / oecp

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-1.0

0. 工具说明

社区网站发布通过OSV认证的厂商及版本号,对外价值 — 确保根生态一致性,核心特性继承,生态可复用;对内价值 — 反生态分裂识别,保障技术路线演进,OSV认证方案:聚焦openEuler内核和基础包,约束伙伴二次发行版生态核心特性不丢失,关键配置不更改

Compatible全量换标版本(暂不对外公布)

在Compatible 深度基础上,软件包版本、特性、配置、补丁全部保持一致,主要更换了发型版版本信息,与openEuler 仓库100%复用。

Compatible深度:主力行业场景生态复用(对外公布,通用OSV)

在Compatible 基础基础上,检测生态复用,扩展竞争力特性(etmem、热升级、isulad)继承检测;扩展标准包到L2包一致性,主流行业应用生态复用度90%。检查发行版是否结合社区选包策略及软件包等级策略,检查L1、L2软件包版本、打包方式、接口一致性,实现扩展仓库openEuler系共享、共用。

Compatible基础:特性/配置继承 (对外公布,企业OSV)

主要检测openEuler 技术路线,是否有反分裂行为,核心包L1(内核、glibc)及包管理体系一致性,KABI白名单,架构特性(如鲲鹏/X86特性)使能,性能优化配置。检查发行版是否技术路线一致,是否有反分裂行为,核心包一致性,如支持鲲鹏补丁、X86补丁、isulad、热升级等特性合入,充分发挥openEuler竞争力特性。

检查项

序号 检查
1 软件包检测
2 接口检测
3 特性检测
4 配置检测
5 补丁检测(需要依赖源码)

验证项

序号 验证项 测试
1 兼容性测试 安装、卸载、命令、服务
2 基础性能测试 基础benchmark 测试
3 特性测试 特性功能验证
4 功能测试 基础AT测试

1. 运行环境

1.1. oecp运行环境依赖组件

组件 组件描述 可获得性
python3 python3.7.9及以上 可先通过yum list命令查看,如果没有该版本需要下载安装
sqlite v3.7.17 及以上版本 系统自带
abidiff 1.6.0 挂载openEuler20.03-LTS-SP2的yum源之后,yum install libabigail
japi-compliance-checker 2.4 https://github.com/lvc/japi-compliance-checker

1.2. oecp理论运行资源

在运行oecp分析之前,确保虚拟机或物理机的运行规格大于等于2U8G,运行前建议重启虚拟机,保证空闲内存足够,建议oecp所在目录空闲磁盘至少保留20GB(具体以实际扫描rpm包数量为准)

任务分析项 CPU资源消耗 运行耗时 输出件大小
比较两个iso镜像所有比较计划 2核心,峰值100% 20~60分钟 程序正常结束,百兆级别,具体大小和比较的镜像差异有关
比较两个iso镜像所有比较计划 16核心,峰值100% 10~60分钟 程序正常结束,百兆级别,具体大小和比较的镜像差异有关

1.3. oecp网络需求

除了相关组件安装,oecp可完全离线运行,无需连接网络

2. 软件目录结构

主目录 二级目录 三级目录 描述
cli.py 命令启动脚本
requirement 工具依赖清单
README.md 用户指导手册
test 测试脚本夹
doc 设计文档文件夹
oecpimg 存放文档图片
oecp-dev-1.0.md 设计文档
oecp-module-dev-1.0.md 模块设计文档
oecp
main 主模块
factory.py 工厂方法,生产ISO、REPO等比较对象
directory.py 目录级别对象、ISO对象、REPO对象
repository.py 仓库级别对象
mapping 二进制包和源码包映射
category.py 软件包、二进制包等级
plan.py 比较计划
executor 比较模块
base.py 比较器基类
abi.py 比较abi
jabi.py 比较jar abi
list.py 比较文件列表、包列表
null.py 空比较,当比较计划项只需要dumper时使用
nvs.py 符号、版本、名称比较器
plain.py 文件比较
dumper dumper模块
base.py dumper基类
abi.py 动态库abi
config.py rpm包的配置文件
extract.py 提取rpm包内容
filelist.py 文件列表
jabi.py jar包abi
kabi.py 内核abi
kconfig.py 内核配置
null.py 当比较计划项只需要执行比较时使用
packagelist.py ISO中包列表
provides.py rpm包提供的符号
requires.py rpm包依赖的符号
result 结果模块
compare_result.py 保存结果对象
constants.py 比较类型、比较结果宏
export.py 导出比较结果到csv文件
test_result.py 导出compass-ci比较的结果
proxy 第三方代理模块
rpm_proxy.py rpm包常用方法
proxy/requests_proxy.py requests功能封装下载功能
utils 工具模块
utils/logger.py 日志
utils/misc.py 常用工具
utils/shell.py shell命令
utils/unit_convert.py 单位转换
conf 配置模块
category 包等级配置
performance compass-ci性能测试
plan 比较计划
logger.conf 日志配置

3. 主要功能介绍

oecp工具适用于比较两个ISO镜像之间的差别,具体比较项有:

1)仓库rpm的packagelist(两个仓库包名、版本号、release号比较),对应报告比较类型如下:

  • rpm package name
  • rpm filelist

2)abi(库文件接口)、jabi(java接口)、config(rpm包内配置文件差异)、kabi(内核abi)、kconfig(内核配置文件),对应报告比较类型如下:

  • rpm abi
  • rpm jabi
  • rpm config
  • rpm kabi
  • rpm kconfig

3)provides(rpm的provides)、requires(rpm的依赖)等, 对应报告比较类型如下:

  • rpm provides
  • rpm requires

4)unixbench, lmbench, mysql性能测试,对应报告比较类型如下:

  • performacne

5)服务命令起停测试,对应报告比较类型如下:

  • rpm test

4. oecp下载安装与部署

install abidiff (centos): ''' yum install -y epel-release yum install -y libabigail '''

install japi: ''' git clone https://github.com/lvc/japi-compliance-checker cd japi-compliance-checker sudo make install prefix=/usr '''

install oecp: ''' git clone https://gitee.com/lovelijunyi/oecp cd oecp pip3 install -r requirement '''

5. oecp使用

使用前,安装python依赖库 pip3 install -r requirement

python3 cli.py [-h] [-n PARALLEL] [-w WORK_DIR] [-p PLAN_PATH] [-c CATEGORY_PATH] [-b PERF_BASELINE_FILE] [-a {x86_64,aarch64}] [-f OUTPUT_FORMAT] [-o OUTPUT_FILE] file1 file2

  • 位置参数(必选)

    • file 指定两个比较的iso文件
  • 可选参数

    • -n, --parallel 指定进程池并发数量,默认cpu核数

    • -w, --work-dir 指定工作路径,默认路径为/tmp/oecp

    • -p, --plan 指定比较计划,默认为oecp/conf/plan/all.json

    • -c, --category 指定包级别信息,默认为oecp/conf/category/category.json

    • -b, --baseline 指定基线文件,默认为oecp/conf/performance/openEuler-20.03-LTS-aarch64-dvd.iso.performance.json

    • -f, --format 指定输出格式,默认为csv

    • -o, --output 指定输出结果路径,默认为/tmp/oecp

  • 举例

    • python3 cli.py /root/openEuler-20.03-LTS-aarch64-dvd.iso /root/openEuler-20.03-LTS-SP1-aarch64-dvd.iso
  • 比较计划说明

    • all.json 涵盖下面所有配置项的比较

    以下比较项只作为调试用,无法单独进行比较生成结果,请注意

    • abi.json 比较rpm包中so库文件的abi接口,需依赖RPMExtractDumper(提取解压rpm的dumper类)
    • config_file.json 比较rpm包中配置文件内容的差异,需依赖RPMExtractDumper(提取解压rpm的dumper类)
    • filelist.json 比较rpm包文件列表差异,可通过rpm -pql ${rpm_path}命令获取rpm文件列表
    • jabi.json 比较rpm中jar包的java接口,需依赖RPMExtractDumper(提取解压rpm的dumper类)
    • kabi.json 比较内核rpm包的abi接口,需依赖RPMExtractDumper(提取解压rpm的dumper类) 默认白名单为aarch64,如需要比较x86需要更换"white_list": "kabi_whitelist/x86_64"
    • kconfig.json 比较内核配置文件,需依赖RPMExtractDumper(提取解压rpm的dumper类)
    • package_list.json 比较两个rpm集合包名称、版本、发行版本的差异
    • provides_requires.json 比较rpm的provides和requires差异,可通过rpm -pq --provides/requires ${rpm_path}查询

6. 软件卸载与环境清理

7. 常见问题与处理

木兰宽松许可证, 第1版 木兰宽松许可证, 第1版 2019年8月 http://license.coscl.org.cn/MulanPSL 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第1版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的一方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括仅因您或他人修改“贡献”或其他结合而将必然会侵犯到的专利权利要求。如您或您的“关联实体”直接或间接地(包括通过代理、专利被许可人或受让人),就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 条款结束。 如何将木兰宽松许可证,第1版,应用到您的软件 如果您希望将木兰宽松许可证,第1版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL 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 v1 for more details. Mulan Permissive Software License,Version 1 Mulan Permissive Software License,Version 1 (Mulan PSL v1) August 2019 http://license.coscl.org.cn/MulanPSL Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v1 (this License) with following terms and conditions: 0. Definition Software means the program and related documents which are comprised of those Contribution and licensed 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, or are controlled by, or are under common control with a party to 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. Contribution means the copyrightable work licensed by a particular Contributor under this License. 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, excluding of any patent claims solely be infringed by your or others’ modification or other combinations. If you or your Affiliates directly or indirectly (including through an agent, patent licensee or assignee), 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. End of the Terms and Conditions How to apply the Mulan Permissive Software License,Version 1 (Mulan PSL v1) to your software To apply the Mulan PSL v1 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) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL 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 v1 for more details.

简介

暂无描述 展开 收起
MulanPSL-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/zhengyaohui/oecp.git
git@gitee.com:zhengyaohui/oecp.git
zhengyaohui
oecp
oecp
master

搜索帮助