openubmc-bingo 0.6.45__py3-none-any.whl → 0.6.99__py3-none-any.whl

bmcgo/functional/check.py

@@ -49,7 +49,6 @@ _PACKAGE_INFO_HELP = """
     b. 文本格式
         package/version@user/channel
 """
-MODEL_CHOICES = ["all", "mds", "resource_tree", "csr", "interface_mapping"]
 
 
 def if_available(bconfig: BmcgoConfig):
@@ -57,34 +56,21 @@ def if_available(bconfig: BmcgoConfig):
 
 
 class BmcgoCommand:
+    MODEL_CHOICES = ["all", "mds", "resource_tree", "csr", "interface_mapping"]
+    BOARD_NAME_DEFAULT = misc.boardname_default()
+
     def __init__(self, bconfig: BmcgoConfig, *args):
         self.bconfig = bconfig
-        parser = argparse.ArgumentParser(prog=f"{misc.tool_name()} check", description="语法正确性与模型一致性检查", add_help=True,
-            formatter_class=argparse.RawTextHelpFormatter)
-        parser.add_argument("-b", "--board_name",
-                            help="指定单板获取配套全量源码，可选值为build/product目录下的单板名\n默认：" + misc.boardname_default(),
-                            default=misc.boardname_default())
-        parser.add_argument("--stage", help="包类型，可选值为：rc(预发布包), stable(发布包)\n默认: stable", default="stable")
-        parser.add_argument("-r", "--remote")
-        parser.add_argument("-m", "--model", help=f"检查的模型，可选值为: {', '.join(MODEL_CHOICES)}\n默认: all",
-                            choices=MODEL_CHOICES, default="all")
+
+        parser = self._create_parser()
         parsed_args, _ = parser.parse_known_args(*args)
-        self.board_name = parsed_args.board_name
-        self.stage = parsed_args.stage
-        self.remote = parsed_args.remote
-        self.model = parsed_args.model
-        self.community_issues = set()
-        self.service_dict = {}
-        self.packages = {}
-        self.repo_brance = Repo(cwd).active_branch.name
-        self.repo_name = "manifest"
-        self.disabled = False
-        self.studio_dir = "/usr/share/bmc_studio/server"
-        self.studio_path = "/usr/share/bmc_studio/server/bmcstudio"
+        self._init_common_attributes(parsed_args)
+        self._init_specific_attributes(parsed_args)
+
         # 初始化fetch命令对象
         if self.bconfig.manifest:
             self.fetch_agent = FetchAgent(self.bconfig, *args)
-    
+
     @staticmethod
     def check_overdue(issue: dict):
         data = issue.get("deadline")
@@ -97,7 +83,7 @@ class BmcgoCommand:
         except Exception as e:
             log.warning("日期 %s 解析失败：%s", data, e)
             return False
-    
+
     @staticmethod
     def process_issues_group(issues, prefix, add_message=""):
         result = ""
@@ -111,9 +97,8 @@ class BmcgoCommand:
             if add_message:
                 result = f"{result}\n{add_message}\n"
         return result
-    
-    @staticmethod
-    def filter_output():
+
+    def filter_output(self):
         output_path = os.path.join(os.environ["HOME"], "bmc_studio", "var", "data", "cli_data", "issues.json")
         try:
             with open(output_path, "r") as output_fp:
@@ -124,6 +109,8 @@ class BmcgoCommand:
         ci_enabled_issues = []
         disabled_issues = []
         for item in items:
+            if not self._filter_issue(item):
+                continue
             rule = item.get("rule")
             filepath = item.get("filepath")
             ci_enabled = item.get("ciEnabled")
@@ -153,30 +140,27 @@ class BmcgoCommand:
             self.packages[comp_name] = package
 
     def run(self):
-        service_path = os.path.join(cwd, "mds", "service.json")
-        if self.bconfig.manifest is None:
-            if not os.path.isfile(service_path):
-                raise RuntimeError("mds/service.json 文件不存在")
-            with open(service_path, "r") as service_fp:
-                self.service_dict = json.load(service_fp)
-            if "name" not in self.service_dict:
-                raise RuntimeError("mds/service.json 文件中缺少 name 配置")
-            self.repo_name = self.service_dict.get("name")
-            self.find_component_packages()
+        self._check_repo_config()
+        self._before_run()
+
         if self.disabled:
             log.info("%s 仓库没有开启语法正确性和模型一致性检查", self.repo_name)
             return 0
+
         with tempfile.TemporaryDirectory(prefix="dependencies_repo_") as tempdir:
             if self.bconfig.manifest:
                 self.fetch_agent.code_path = tempdir
                 self.fetch_agent.run()
             elif self.packages:
                 FetchComponentCode(self.packages, tempdir, self.remote, include_open_source=False).run()
-            cmd = [self.studio_path, "check", "--repo", cwd, "--dependencies", tempdir, "--model", self.model]
-            if self.bconfig.manifest:
-                cmd.append("--manifest")
-                cmd.append("true")
+            cmd = self._get_studio_command(tempdir)
+
+            # 额外加入仓颉runtime的依赖库
+            insert_path = '/usr/share/bmc_studio/server'
             os.chdir(self.studio_dir)
+            cur_path = os.environ.get('LD_LIBRARY_PATH', '')
+            new_path = f"{insert_path}:{cur_path}"
+            os.environ['LD_LIBRARY_PATH'] = new_path
             Helper.run(cmd, stdout=subprocess.DEVNULL)
             os.chdir(cwd)
         error, warning = self.filter_output()
@@ -186,4 +170,64 @@ class BmcgoCommand:
             return -1
         log.warning(warning)
         log.success("语法正确性和模型一致性检查通过\n")
-        return 0
+        return 0
+
+    def _init_common_attributes(self, parsed_args):
+        self.board_name = parsed_args.board_name
+        self.stage = parsed_args.stage
+        self.remote = parsed_args.remote
+        self.model = parsed_args.model
+        self.community_issues = set()
+        self.service_dict = {}
+        self.packages = {}
+        self.repo_branch = Repo(cwd).active_branch.name
+        self.repo_name = "manifest"
+        self.disabled = False
+        self.studio_dir = "/usr/share/bmc_studio/server"
+        self.studio_path = "/usr/share/bmc_studio/server/bmcstudio"
+
+    def _init_specific_attributes(self, parsed_args):
+        """初始化子类特有属性，由子类自行实现"""
+        pass
+
+    def _check_repo_config(self):
+        service_path = os.path.join(cwd, "mds", "service.json")
+        if self.bconfig.manifest is None:
+            if not os.path.isfile(service_path):
+                raise RuntimeError("mds/service.json 文件不存在")
+            with open(service_path, "r") as service_fp:
+                self.service_dict = json.load(service_fp)
+            if "name" not in self.service_dict:
+                raise RuntimeError("mds/service.json 文件中缺少 name 配置")
+            self.repo_name = self.service_dict.get("name")
+            self.find_component_packages()
+
+
+    def _get_studio_command(self, tempdir: str):
+        cmd = [self.studio_path, "check", "--repo", cwd, "--dependencies", tempdir, "--model", self.model]
+        if self.bconfig.manifest:
+            cmd.extend(["--manifest", "true"])
+            cmd.extend(["--board", self.board_name])
+        return cmd
+
+    def _filter_issue(self, item):
+        """过滤，由子类实现"""
+        _ = self
+        return True
+
+    def _before_run(self):
+        """主流程中的钩子函数, 由子类实现"""
+        pass
+
+    def _create_parser(self):
+        """命令参数，子类可重写"""
+        parser = argparse.ArgumentParser(prog=f"{misc.tool_name()} check", description="语法正确性与模型一致性检查", add_help=True,
+            formatter_class=argparse.RawTextHelpFormatter)
+        parser.add_argument("-b", "--board_name",
+                            help="指定单板获取配套全量源码，可选值为build/product目录下的单板名\n默认：" + self.BOARD_NAME_DEFAULT,
+                            default=self.BOARD_NAME_DEFAULT)
+        parser.add_argument("--stage", help="包类型，可选值为：rc(预发布包), stable(发布包)\n默认: stable", default="stable")
+        parser.add_argument("-r", "--remote")
+        parser.add_argument("-m", "--model", help=f"检查的模型，可选值为: {', '.join(self.MODEL_CHOICES)}\n默认: all",
+                            choices=self.MODEL_CHOICES, default="all")
+        return parser

bmcgo/functional/conan_index_build.py

@@ -234,7 +234,7 @@ class BmcgoCommand:
 
         dt_stat = os.environ.get("BMCGO_DT_RUN", "off")
         show_log = True if dt_stat == "off" else False
-        pkg = self.name + "/" + self.version + "@" + self.user + "/" + self.channel
+        pkg = packake_name + "/" + self.version + "@" + self.user + "/" + self.channel
         append_cmd = f"-r {self.remote}" if self.remote else ""
         cmd = "conan create . {} -pr={} -pr:b profile.dt.ini {} {} -tf None {}".format(
             pkg, self.profile, setting, append_cmd, options

bmcgo/functional/config.py

@@ -23,11 +23,12 @@ from bmcgo.bmcgo_config import BmcgoConfig
 
 tool = Tools("config")
 log = tool.log
+TOOLNAME = misc.tool_name()
 
 command_info: misc.CommandInfo = misc.CommandInfo(
     group=misc.GRP_MISC,
     name="config",
-    description=["bingo参数配置"],
+    description=[f"{TOOLNAME}参数配置"],
     hidden=False
 )
 
@@ -39,19 +40,19 @@ def if_available(bconfig: BmcgoConfig):
 _CONFIGS = {
     misc.ENV_CONST: {
         misc.HTTP_PROXY_CONST: {
-            misc.DESCRIPTION: "bingo 使用的 http_proxy 环境变量",
+            misc.DESCRIPTION: f"{TOOLNAME} 使用的 http_proxy 环境变量",
             misc.PATTERN: r"^((https?://)?[a-zA-Z0-9.]+:[0-9]+)?$"
         },
         misc.HTTPS_PROXY_CONST: {
-            misc.DESCRIPTION: "bingo 使用的 https_proxy 环境变量",
+            misc.DESCRIPTION: f"{TOOLNAME} 使用的 https_proxy 环境变量",
             misc.PATTERN: r"^((https?://)?[a-zA-Z0-9.]+:[0-9]+)?$"
         },
         misc.FTP_PROXY_CONST: {
-            misc.DESCRIPTION: "bingo 使用的 ftp_proxy 环境变量",
+            misc.DESCRIPTION: f"{TOOLNAME} 使用的 ftp_proxy 环境变量",
             misc.PATTERN: r"^((https?://)?[a-zA-Z0-9.]+:[0-9]+)?$"
         },
         misc.NO_PROXY_CONST: {
-            misc.DESCRIPTION: "bingo 使用的 no_proxy 环境变量"
+            misc.DESCRIPTION: f"{TOOLNAME} 使用的 no_proxy 环境变量"
         },
         misc.TIMESTAMP_SIGN_SERVER: {
             misc.DESCRIPTION: "用于 jar 文件签名的时间戳签名服务器环境变量",
@@ -64,6 +65,9 @@ _CONFIGS = {
         misc.JSON_CHECKER: {
             misc.DESCRIPTION: "检查 json 文件的工具"
         },
+        misc.HPM_SIGNER: {
+            misc.DESCRIPTION: "HPM 重签名工具"
+        },
         misc.CUSTOM_PLUGINS: {
             misc.DESCRIPTION: f"设置插件地址，默认 {Path(misc.DEFAULT_PLUGINS_PATH).resolve()}"
         }
@@ -98,27 +102,27 @@ _DESCRIPTION = f"""
 2. 全局配置文件: ~/.bmcgo/config
 3. 本地配置文件: .bmcgo/config
 {gen_conf_str()}
-- 通过 bingo config 设置的环境变量(env.x)会写入到环境变量配置文件中。
+- 通过 {TOOLNAME} config 设置的环境变量(env.x)会写入到环境变量配置文件中。
 指令参考:
 1. 配置全局参数:
-    bingo config env.{misc.HTTP_PROXY_CONST}=http://proxy.example.com:8080
+    {TOOLNAME} config env.{misc.HTTP_PROXY_CONST}=http://proxy.example.com:8080
 2. 配置本地参数:
-    bingo config --local env.{misc.HTTP_PROXY_CONST}=http://proxy.example.com:8080
+    {TOOLNAME} config --local env.{misc.HTTP_PROXY_CONST}=http://proxy.example.com:8080
 3. 查看生效配置:
-    bingo config -l
+    {TOOLNAME} config -l
 4. 取消全局参数配置:
-    bingo config --unset env.{misc.HTTP_PROXY_CONST}
+    {TOOLNAME} config --unset env.{misc.HTTP_PROXY_CONST}
 5. 取消本地参数配置:
-    bingo config --local --unset env.{misc.HTTP_PROXY_CONST}
+    {TOOLNAME} config --local --unset env.{misc.HTTP_PROXY_CONST}
 6. 设置时间戳签名服务器:
-    bingo config env.{misc.TIMESTAMP_SIGN_SERVER}=http://url.example.com
+    {TOOLNAME} config env.{misc.TIMESTAMP_SIGN_SERVER}=http://url.example.com
 7. 设置 JarSigner HTTP 代理主机:
-    bingo config env.{misc.JARSIGNER_HTTP_PROXY}=http://proxy.example.com:8080
+    {TOOLNAME} config env.{misc.JARSIGNER_HTTP_PROXY}=http://proxy.example.com:8080
 8. 设置部署配置: 
-    格式: bingo config deploy-<host>.<port|username|password>=<value>. host 既可以是主机名也可以是域名或 IP
-    bingo config deploy-192.168.1.1.port=443
-    bingo config deploy-192.168.1.1.username=UserName
-    bingo config deploy-192.168.1.1.password=Password
+    格式: {TOOLNAME} config deploy-<host>.<port|username|password>=<value>. host 既可以是主机名也可以是域名或 IP
+    {TOOLNAME} config deploy-192.168.1.1.port=443
+    {TOOLNAME} config deploy-192.168.1.1.username=UserName
+    {TOOLNAME} config deploy-192.168.1.1.password=Password
 """
 
 
@@ -134,7 +138,7 @@ def save_config_file(config, config_path):
 class BmcgoCommand:
     def __init__(self, bconfig: BmcgoConfig, *args):
         self.parser = argparse.ArgumentParser(
-            prog="bingo参数配置",
+            prog=f"{TOOLNAME}参数配置",
             description=_DESCRIPTION,
             add_help=True,
             formatter_class=argparse.RawTextHelpFormatter

bmcgo/functional/csr_build.py

@@ -160,8 +160,36 @@ command_info: CommandInfo = CommandInfo(
 class BmcgoCommand:
     def __init__(self, bconfig: BmcgoConfig, *args):
         self.bconfig = bconfig
+        parser = self.get_arg_parser()
+        parsed_args, _ = parser.parse_known_args(*args)
+        self.csr_path = os.path.realpath(parsed_args.path)
+        self.single = parsed_args.single
+        self.oem_path = parsed_args.oem
+        self.output_path = os.path.realpath(parsed_args.output_path)
+        self.json = parsed_args.json
+        self.bin = parsed_args.bin
+        self.hpm = parsed_args.hpm
+        self.all = parsed_args.all
+        self.tar = parsed_args.tar
+        self.frud = parsed_args.frud
+        self.max_size_map = parsed_args.max_config
+        self.uid = parsed_args.uid
+        # 保留原始参数集，用于重写初始化函数扩展参数解析
+        self.parsed_args = parsed_args
+        self.work_dir = None
+        self.target_dir = None
+        self.eeprom_sign_strategy = None
+        self.hpm_sign_strategy = None
+        self.tmp_dir = None
+        self.merger = Merger(self.output_path)
+
+    @staticmethod
+    def get_arg_parser():
+        '''
+        参数解析类扩展点，可重写此方法扩展自定义参数
+        '''
         parser = argparse.ArgumentParser(
-            prog="bingo build_csr",
+            prog=f"{misc.tool_name()} build_csr",
             description="csr出包，支持单个CSR和批量CSR出包",
             add_help=True,
             formatter_class=argparse.RawTextHelpFormatter,
@@ -189,25 +217,7 @@ class BmcgoCommand:
             help="eeprom大小限制的json配置文件路径，无配置时默认限制为32k",
             default=EEPROM_SIZE_LIMIT_CONFIG
         )
-        parsed_args, _ = parser.parse_known_args(*args)
-        self.csr_path = os.path.realpath(parsed_args.path)
-        self.single = parsed_args.single
-        self.oem_path = parsed_args.oem
-        self.output_path = os.path.realpath(parsed_args.output_path)
-        self.json = parsed_args.json
-        self.bin = parsed_args.bin
-        self.hpm = parsed_args.hpm
-        self.all = parsed_args.all
-        self.tar = parsed_args.tar
-        self.frud = parsed_args.frud
-        self.max_size_map = parsed_args.max_config
-        self.uid = parsed_args.uid
-        self.work_dir = None
-        self.target_dir = None
-        self.eeprom_sign_strategy = None
-        self.hpm_sign_strategy = None
-        self.tmp_dir = None
-        self.merger = Merger(self.output_path)
+        return parser
 
     @staticmethod
     def get_oem_data(dir_path: str, comp_name: str):
@@ -269,7 +279,7 @@ class BmcgoCommand:
         self.get_hpm_sign_strategy()
     
     def make_sr_binary(self, options: SrMakeOptions, hpm_temp_dir: str, max_size: int):
-        eeprom_build_controller = EepromBuild(self.bconfig, options, self.work_dir, self.eeprom_sign_strategy)
+        eeprom_build_controller = self._get_eeprom_builder(options)
         eeprom_data = eeprom_build_controller.build_eeprom()
         if len(eeprom_data) > max_size * 1024 - 40:
             raise errors.BmcGoException(f"Eeprom二进制文件大小超过限制: {options.comp_name}")
@@ -293,6 +303,8 @@ class BmcgoCommand:
         with open(binary_files[0], 'wb') as f:
             f.write(eeprom_data)
         for binary_file in binary_files[1:]:
+            if binary_file == binary_files[0]:
+                continue
             shutil.copy(binary_files[0], binary_file)
 
     def run(self):
@@ -325,12 +337,11 @@ class BmcgoCommand:
                     hpm_file = os.path.join(self.target_dir, f"{sr_make_options_list[0].comp_name}.hpm")
                 else:
                     hpm_file = os.path.join(self.target_dir, f"CSR-{get_timestamp()}.hpm")
-                params = (self.bconfig, hpm_file, self.work_dir, self.hpm_sign_strategy)
-                hpm_package = HpmBuild(*params)
+                hpm_package = self._get_hpm_builder(hpm_file)
                 log.info("开始执行hpm包构建任务...")
                 hpm_package.run()
             if self.single or self.frud or self.tar:
-                output_file = os.path.join(self.output_path, f"bingo-{get_timestamp()}.tar.gz")
+                output_file = os.path.join(self.output_path, f"{misc.tool_name()}-{get_timestamp()}.tar.gz")
                 tar_command = ['tar', '-czf', output_file, "-C", self.target_dir, "."]
                 try:
                     result = subprocess.run(tar_command, check=True)
@@ -340,12 +351,11 @@ class BmcgoCommand:
             else:
                 output_hpm_file = os.path.join(self.output_path, os.path.basename(hpm_file))
                 shutil.copy(hpm_file, output_hpm_file)
+                log.info(f"成功创建hpm包{os.path.basename(output_hpm_file)}")
             log.info("构建成功!")
         finally:
-            if os.path.exists(self.work_dir):
-                shutil.rmtree(self.work_dir)
-            if os.path.exists(self.tmp_dir):
-                shutil.rmtree(self.tmp_dir)
+            shutil.rmtree(self.work_dir, ignore_errors=True)
+            shutil.rmtree(self.tmp_dir, ignore_errors=True)
 
     def check_args(self):
         has_single_need_arg = self.bin or self.json or self.hpm or self.all
@@ -442,6 +452,19 @@ class BmcgoCommand:
         else:
             return False
 
+    def _get_hpm_builder(self, hpm_file: str):
+        '''
+        Hpm包构造器扩展点
+        '''
+        params = (self.bconfig, hpm_file, self.work_dir, self.hpm_sign_strategy)
+        return HpmBuild(*params)
+
+    def _get_eeprom_builder(self, option: SrMakeOptions):
+        '''
+        Eeprom内容构造器扩展点
+        '''
+        return EepromBuild(self.bconfig, option, self.work_dir, self.eeprom_sign_strategy)
+
 
 class EepromBuild:
     def __init__(self, bconfig, options, work_dir, strategy):
@@ -623,7 +646,7 @@ class EepromBuild:
     # 创建数字签名域数据
     def sign_eeprom(self, un_sign_data: bytearray):
         if self.strategy == SignatureTypeEnum.DEFAULT:
-            return self.get_eeprom_default_sign()
+            return self._get_eeprom_default_sign(un_sign_data)
         elif not (self.strategy == SignatureTypeEnum.SERVER_SIGN or
                   self.strategy == SignatureTypeEnum.SELF_SIGN):
             raise errors.BmcGoException("Invalid signing strategy.")
@@ -642,9 +665,6 @@ class EepromBuild:
             if os.path.exists(tmp_sign_path):
                 shutil.rmtree(tmp_sign_path)
             return self.build_sign(sign_data)
-    
-    def get_eeprom_default_sign(self):
-        return bytearray(self.sign_len)
 
     def get_eeprom_self_sign(self, un_sign_data):
         signing_key = self.load_key()
@@ -765,6 +785,9 @@ class EepromBuild:
         # 12. CRC32 校验和（4字节）
         eeprom_header_buf.put_uint32(self.get_crc32_check_sum(eeprom_header_buf.array()))
         return eeprom_header_buf.array()   
+        
+    def _get_eeprom_default_sign(self, _):
+        return bytearray(self.sign_len)
 
 
 class EepromHeader:
@@ -814,6 +837,7 @@ class HpmBuild:
 
     @staticmethod
     def sign_hpm_default():
+        log.info("未配置签名策略，跳过hpm包签名...")
         cms_file = os.path.realpath("image.filelist.cms")
         tool.pipe_command([f"echo 'cms placeholder'"], out_file=cms_file)
         crl_file = os.path.realpath("crldata.crl")
@@ -852,14 +876,13 @@ class HpmBuild:
     # 对hpm包进行签名
     def sign_hpm(self):
         if self.strategy == SignatureTypeEnum.DEFAULT:
-            log.info("未配置签名策略，跳过hpm包签名...")
             self.sign_hpm_default()
         elif self.strategy == SignatureTypeEnum.SELF_SIGN or\
                 self.strategy == SignatureTypeEnum.SERVER_SIGN:
             # 生成.filelist文件
             tool.run_command(f"cms_sign_hpm.sh 1 {self.hpm_name}", command_echo=False)
             shutil.copy("devkit.filelist", "image.filelist")
-            SignGenerator(self.bconfig, self.strategy, "image.filelist").sign_generate()
+            self._get_generator().sign_generate()
         else:
             raise errors.BmcGoException("Invalid signing strategy.")
 
@@ -879,6 +902,12 @@ class HpmBuild:
         self.sign_hpm()
         self.rebuild_hpm()
 
+    def _get_generator(self):
+        '''
+        签名工具扩展点
+        '''
+        return SignGenerator(self.bconfig, self.strategy, "image.filelist")
+
 
 class SignGenerator:
     def __init__(self, bconfig: BmcgoConfig, sign_strategy: str, unsigned_file: str):

bmcgo/functional/deploy.py

@@ -185,7 +185,8 @@ class UpgradeTask(Process):
 class BmcgoCommand:
     def __init__(self, bconfig: BmcgoConfig, *args):
         self.bconfig = bconfig
-        parser = argparse.ArgumentParser(prog="bingo deploy", description="BMC产品包部署升级，待部署主机配置由bmcgo config命令管理",
+        self.config_name = ".openUBMC_config.yml"
+        parser = argparse.ArgumentParser(prog="bingo deploy", description="BMC产品包部署升级，待部署主机配置由bingo config命令管理",
                                          add_help=True, formatter_class=argparse.RawTextHelpFormatter)
         parser.add_argument("-f", "--filename", help="待部署的文件", required=True)
         parsed_args = parser.parse_args(*args)
@@ -230,9 +231,9 @@ class BmcgoCommand:
     def _read_yml_hosts(self):
         tasks: list[UpgradeTask] = []
         cur_dir = os.getcwd()
-        log.info("从当前路径开始向上递归查找.openUBMC_config.yml文件")
+        log.info(f"从当前路径开始向上递归查找 {self.config_name} 文件")
         while cur_dir != "/":
-            cfg_file = os.path.join(cur_dir, ".openUBMC_config.yml")
+            cfg_file = os.path.join(cur_dir, self.config_name)
             if not os.path.isfile(cfg_file):
                 cur_dir = os.path.dirname(cur_dir)
                 continue