From 68e14308726227d949853d2acab593d035f55013 Mon Sep 17 00:00:00 2001 From: panwentao Date: Fri, 17 Nov 2023 10:02:21 +0800 Subject: [PATCH] m_env: Add environment management function * Add environment management function Signed-off-by: panwentao --- README.md | 9 + src/oebuild/app/conf/plugins.yaml | 3 + src/oebuild/app/plugins/m_env/m_env.py | 329 +++++++++++++++++++++++++ 3 files changed, 341 insertions(+) create mode 100644 src/oebuild/app/plugins/m_env/m_env.py diff --git a/README.md b/README.md index 05dfb7e..3db4bfd 100644 --- a/README.md +++ b/README.md @@ -286,6 +286,15 @@ oebuild bitbake -h 由于oebuild二进制包存放在gitee仓库中，因此oebuild在升级时会先克隆最新的二进制仓到用户根目录，并以一个随机文件名命名，然后执行`sudo pip install `来完成升级，在这之中会要求用户输入root密码，在完成升级后会自动删除oebuild二进制包 +##### oebuild menv +``` +oebuild menv [-d setup_file_directory] [-f sdk_file_path] +``` +setup_file_directory: 表示已经解压完成的对应sdk产生的setup文件夹。此文件夹中有且只能有一个setup文件 + +sdk_file_path： 对应sdk文件路径,需要指定到sdk文件名。会在当前工作目录下产生一个sdk_info_当前时间戳的文件夹， +用于存放对应的setup_file等文件。 + ##### oebuild runqemu qemu 仿真命令，通过该命令可以在本地实现qemu仿真，该功能运行依赖qemuboot.conf，如果用户不指定或创建，oebuild会根据相关参数自动创建，该文件中记录有qemu启动相关参数，用户可以手动进行修改，如果在当下目录中有多个qemuboot.conf，则会给出选择交互由用户进行选择 diff --git a/src/oebuild/app/conf/plugins.yaml b/src/oebuild/app/conf/plugins.yaml index 64c0311..b44665a 100644 --- a/src/oebuild/app/conf/plugins.yaml +++ b/src/oebuild/app/conf/plugins.yaml @@ -20,3 +20,6 @@ plugins: - name: runqemu class: RunQemu path: plugins/run_qemu/run_qemu.py +- name: menv + class: Menv + path: plugins/m_env/m_env.py diff --git a/src/oebuild/app/plugins/m_env/m_env.py b/src/oebuild/app/plugins/m_env/m_env.py new file mode 100644 index 0000000..02831d6 --- /dev/null +++ b/src/oebuild/app/plugins/m_env/m_env.py @@ -0,0 +1,329 @@ +''' +Copyright (c) 2023 openEuler Embedded +oebuild 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. +''' + +import argparse +import fcntl +import logging +import pty +import re +import struct +import subprocess +import sys +import termios +import textwrap + +from oebuild import util +from oebuild.command import OebuildCommand +from oebuild.configure import Configure +from oebuild.util import * + +logger = logging.getLogger() + + +class Menv(OebuildCommand): + + def __init__(self): + self.configure = Configure() + self.oebuild_env_path = os.path.expanduser('~') + '/.local/oebuild_env/' + self.oebuild_env_yaml_path = pathlib.Path(os.path.join(self.oebuild_env_path, 'oebuild_env.yaml')) + self.oebuild_env_command = ['list', 'create', 'active', 'remove'] + super().__init__( + 'menv', + 'Development Environment Management', + description=textwrap.dedent('''This is an environment management function that allows you to configure + the environment through SDK files or unzipped setup files, and you can view, delete, and activate the + corresponding environment. These operations will not have any impact on your current machine''' + )) + + def do_add_parser(self, parser_adder) -> argparse.ArgumentParser: + parser = self._parser( + parser_adder, + usage=''' + %(prog)s [create list remove activation][command] + create: [-d -f] Create an environment -n env_name + list: View existing environment + remove: -n Delete specified environment + active: -n Active specified environment +''') + + parser.add_argument('-d', '--directory', dest='directory', + help=''' + this param is build directory + ''' + ) + + parser.add_argument('-f', '--file', dest='file', + help=''' + this param is build file + ''' + ) + + parser.add_argument('-n', '--env_name', dest='env_name', + help=''' + this param is env_name + ''' + ) + + # Secondary command + return parser + + def do_run(self, args: argparse.Namespace, unknown=None): + # perpare parse help command + if unknown[0] not in self.oebuild_env_command or (len(set(unknown[1:]).intersection( + {'-d', '-f', '-n'})) == 0 and unknown[0] != 'list'): + unknown = ['-h'] + else: + command = unknown[0] + unknown = unknown[1:] + + if self.pre_parse_help(args, unknown): + return + args = args.parse_args(unknown) + + if command == 'create': + if not args.env_name: + print('Please enter the correct command: oebuild menv create [-d -f] Create an environment -n env_name') + return + # Check if the file path exists + if args.directory and os.path.isdir(args.directory): + setup_file_path = os.path.abspath(args.directory) + sdk_name = args.env_name if args.env_name else args.directory.split('/')[-1] + self.create_or_update_env_yaml(sdk_name, args.directory) + print(f' Created Environment successfully \n {sdk_name.ljust(30)}{setup_file_path}') + return + + # Creating an environment + elif args.file and os.path.exists(args.file): + sdk_name = args.env_name if args.env_name else args.file.split('/')[-1].replace('.sh', '') + setup_file_path = self.oebuild_env_path + sdk_name + self.create_or_update_env_yaml(sdk_name, setup_file_path) + self.execute_sdk_file(args.file, setup_file_path) + print(f' Created Environment successfully \n {sdk_name.ljust(30)}{setup_file_path}') + return + else: + print('The path is invalid, please check the path ') + elif command == 'active': + # Activate Environment + if args.env_name: + return self.activate_environment(args.env_name) + else: + print('Please enter the correct command: oebuild menv active -n env_name') + + elif command == 'list': + env_dict = util.read_yaml(self.oebuild_env_yaml_path) + if env_dict and 'env_config' in env_dict: + self.view_environment(None, env_dict) + else: + print('No environment has been created yet') + return + + # delete environment + elif command == 'remove': + if args.env_name: + return self.delete_environment(args.env_name) + else: + print('Please enter the correct command: oebuild menv remove -n env_name') + + def execute_setup_directory(self, setup_file_path, env_name): + """ + Prepare the environment using the parsed SDK folder provided + Args: + setup_file_path: Resolve completed sdk folder path + env_name: environment name + + Returns: results of execution + + """ + file_list = str(os.listdir(setup_file_path)) + # number of setup_file + setup_num = len(re.findall('environment-setup', file_list)) + # Determine the number of setup_files + if setup_num == 1: + try: + # Determine if the path ends with / + setup_file_path = setup_file_path if setup_file_path.endswith('/') else setup_file_path + '/' + # Convert relative path to absolute path + file_path = setup_file_path + re.search('environment-setup.*?(?=\')', file_list).group() + absolute_file_path = os.path.abspath(file_path) + # Splice Execution Command + shell_command = '. ' + absolute_file_path + + print(shell_command) + print('setup_file matching successful') + subprocess.check_output(rf'''cp ~/.bashrc ~/.bashrc_back''', shell=True) + # Obtain the current terminal height and length + terminal_info = fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, "1234") + rows_and_cloumns = struct.unpack('HH', terminal_info) + rows_command = f'stty rows {rows_and_cloumns[0]} columns {rows_and_cloumns[1]}' + subprocess.check_output(rf'''sed -i '$a\{rows_command}' ~/.bashrc''', shell=True) + # Add the command to execute the setup file in the .bashrc file in the working directory + subprocess.check_output(rf'''sed -i '$a\{shell_command}' ~/.bashrc''', shell=True) + # Replace Console Prompt + subprocess.check_output(rf'''sed -i 's/\$ /({env_name})>>>>> /g' ~/.bashrc''', shell=True) + subprocess.check_output(rf'''sed -i '$a\mv ~/.bashrc_back ~/.bashrc -f' ~/.bashrc''', shell=True) + # Add prompt words + separator = "====================================================" + prompt_one = "Your environment is ready" + prompt_two = "Please proceed with the subsequent operations here" + wrap = '\\n###!###\\n' + prompt_words = separator + wrap + prompt_one + wrap + prompt_two + wrap + separator + subprocess.check_output(rf'''sed -i '$a\echo "{prompt_words}"' ~/.bashrc''', shell=True) + pty.spawn("/bin/bash") + except Exception as c_e: + print(c_e) + print('Please provide the valid folder path') + logger.error(c_e) + return False + return True + elif setup_num == 0: + print('not setup_file, please check your directory') + return False + else: + print('Illegal path, only one environment setup file allowed') + return False + + def execute_sdk_file(self, sdk_file, setup_file_path): + """ + Execute the SDK file, produce the setup folder, and then execute the corresponding method for the setup file + Args: + sdk_file: SDK file path + setup_file_path: setup file path + + Returns: results of execution + + """ + try: + if os.path.isdir(setup_file_path): + print(f'The setup file folder already exists.path is {setup_file_path}') + else: + print('Extracting sdk...............') + subprocess.check_output(f'sh {sdk_file} -d {setup_file_path} -y', shell=True) + subprocess.check_output(f'chmod -R 755 {setup_file_path}', shell=True) + except Exception as c_e: + print('Please provide the valid folder path') + logger.error(c_e) + + def create_or_update_env_yaml(self, env_name, setup_file_path): + """ + + Args: + env_name: + setup_file_path: + + Returns: + + """ + if not os.path.exists(self.oebuild_env_yaml_path.absolute()): + if not os.path.exists(os.path.dirname(self.oebuild_env_yaml_path.absolute())): + os.makedirs(os.path.dirname(self.oebuild_env_yaml_path.absolute())) + os.mknod(self.oebuild_env_yaml_path) + env_dict = util.read_yaml(self.oebuild_env_yaml_path) + if env_dict and 'env_config' in env_dict: + env_list = self.input_or_update_dict(env_name, setup_file_path, env_dict['env_config']) + env_dict['env_config'] = env_list + util.write_yaml(self.oebuild_env_yaml_path, env_dict) + return + + env_dict = {'env_config': [{'env_name': env_name, 'env_value': setup_file_path}]} + util.write_yaml(self.oebuild_env_yaml_path, env_dict) + + def input_or_update_dict(self, env_name, env_value, env_list): + """ + Modify or insert environmental data + Args: + env_name: Environment Name + env_value: Setup file file path + env_list: Environment + + Returns: new Environment + + """ + insert_flag = True + for env_data in env_list: + if 'env_name' not in env_data: + print('env_name not exits') + return + if env_data['env_name'] == env_name: + while True: + user_input = input( + "Do you want to overwrite the path of the original environment configuration(Y/N)") + if user_input.lower() == 'y': + env_data['env_value'] = env_value + break + elif user_input.lower() == 'n': + return [] + insert_flag = False + if insert_flag: + env_list.append({'env_name': env_name, 'env_value': env_value}) + return env_list + + def activate_environment(self, env_name): + env_dict = util.read_yaml(self.oebuild_env_yaml_path) + if env_dict and 'env_config' in env_dict: + setup_file_path = self.view_environment(env_name, env_dict) + if setup_file_path: + return self.execute_setup_directory(setup_file_path, env_name) + else: + print('The environment does not exist') + return + + def view_environment(self, env_name, env_dict): + """ + View the environment, if env_ If name exists, it is necessary to find the corresponding + environment's setup file + Args: + env_name: environment name + env_dict: environment yaml + Returns: + + """ + print("""# oebuild environment:\n#""") + for env_data in env_dict['env_config']: + if env_name and env_data['env_name'] == env_name: + return env_data['env_value'] + print(env_data['env_name'].ljust(30) + env_data['env_value']) + + return + + def delete_environment(self, env_name): + """ + delete your environment + Args: + env_name: The environment you want to delete + + Returns: + + """ + env_dict = util.read_yaml(self.oebuild_env_yaml_path) + if env_dict and 'env_config' in env_dict: + env_list = [] + for env_data in env_dict['env_config']: + + if env_data['env_name'] != env_name: + env_list.append(env_data) + elif '/.local/oebuild_env/' in env_data['env_value']: + try: + subprocess.check_output(f'rm -rf {env_data["env_value"]}', shell=True) + except Exception as r_e: + print('Fail deleted') + print(r_e) + logger.error(r_e) + return + + if len(env_list) == len(env_dict['env_config']): + print('The environment does not exist, please check the input') + return + else: + env_dict['env_config'] = env_list + util.write_yaml(self.oebuild_env_yaml_path, env_dict) + print('Successfully deleted') + return -- Gitee