From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mx.groups.io with SMTP id smtpd.web11.1430.1589217503734754489 for ; Mon, 11 May 2020 10:18:24 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.31, mailfrom: ashley.e.desimone@intel.com) IronPort-SDR: KvEChzfrz4bzxHMXJ+3JC1Bp8YjvVEfFsZtAm/PLR5Poezs7JCgi243kjXb3miPBe9LerxjSC/ 87ZOp3pdI1+w== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 May 2020 10:18:23 -0700 IronPort-SDR: YOk9Rk+PoyKeafJGonpzAfkkst8DA18edIOS0LWqh+ydAZCQRNWKyjj4o+zYwWVD4ixOjfKiMQ C2pGGIw9jD6Q== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.73,380,1583222400"; d="scan'208";a="250615449" Received: from aedesimo-desk.amr.corp.intel.com ([10.212.18.220]) by orsmga007.jf.intel.com with ESMTP; 11 May 2020 10:18:22 -0700 From: "Ashley E Desimone" To: devel@edk2.groups.io Cc: Nate DeSimone , Puja Pandya , Erik Bjorge , Bret Barkelew , Prince Agyeman Subject: [edk2-staging/EdkRepo] [PATCH V2] EdkRepo: Add the manifest-repos command Date: Mon, 11 May 2020 10:18:20 -0700 Message-Id: <20200511171820.16088-1-ashley.e.desimone@intel.com> X-Mailer: git-send-email 2.16.2.windows.1 Add the manifest_repos_command to list, add, or remove manifest repositories in the ekdrepo_user.cfg Signed-off-by: Ashley E Desimone Cc: Nate DeSimone Cc: Puja Pandya Cc: Erik Bjorge Cc: Bret Barkelew Cc: Prince Agyeman --- edkrepo/commands/arguments/manifest_repo_args.py | 22 +++++ edkrepo/commands/humble/manifest_repos_humble.py | 20 +++++ edkrepo/commands/manifest_repos_command.py | 107 +++++++++++++++++++++++ 3 files changed, 149 insertions(+) create mode 100644 edkrepo/commands/arguments/manifest_repo_args.py create mode 100644 edkrepo/commands/humble/manifest_repos_humble.py create mode 100644 edkrepo/commands/manifest_repos_command.py diff --git a/edkrepo/commands/arguments/manifest_repo_args.py b/edkrepo/commands/arguments/manifest_repo_args.py new file mode 100644 index 0000000..5792a4d --- /dev/null +++ b/edkrepo/commands/arguments/manifest_repo_args.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python3 +# +## @file +# manifest_repo_args.py +# +# Copyright (c) 2020, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +''' Contains the help and description strings for arguments in the +manifest_repo command meta data. +''' + +COMMAND_DESCRIPTION = 'Lists, adds or removes a manifest repository.' +LIST_HELP = 'List all available manifest repositories.' +ADD_HELP = 'Add a manifest repository.' +REMOVE_HELP = 'Remove a manifest repository.' +NAME_HELP = 'The name of a manifest repository to add/remove. Required with Add or Remove flags.' +URL_HELP = 'The URL of a manifest repository to add. Required with Add flag.' +LOCAL_PATH_HELP = 'The local path that a manifest is stored at in the edkrepo global data directory. Required with Add flag.' +BRANCH_HELP = 'The branch of a manifest repository to use. Required with Add flag.' +ACTION_HELP = 'Which action "list", "add", "remove" to take' diff --git a/edkrepo/commands/humble/manifest_repos_humble.py b/edkrepo/commands/humble/manifest_repos_humble.py new file mode 100644 index 0000000..7dc8bfe --- /dev/null +++ b/edkrepo/commands/humble/manifest_repos_humble.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python3 +# +## @file +# manifest_repos_humble.py +# +# Copyright (c) 2020, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +''' +Contains user visible strings printed by the manifest_repos command. +''' + +CFG_LIST_ENTRY = 'Config File: edkrepo.cfg Manifest Repository Name: {}' +USER_CFG_LIST_ENTRY = 'Config File: edkrepo_user.cfg Manifest Repository Name: {}' +NAME_REQUIRED = 'The "name" argument is required to add/remove a manifest repository' +ADD_REQUIRED = 'The "name", "url", "branch" and "local-path" arguments are required to add a manifest repository' +CANNOT_REMOVE_CFG = 'Manifest repositories cannot be removed from the edkrepo.cfg file.' +REMOVE_NOT_EXIST = 'The selected manifest repository does note exist in the edkrepo_user.cfg file.' +ALREADY_EXISTS = 'A manifest repository already exists with name: {}' diff --git a/edkrepo/commands/manifest_repos_command.py b/edkrepo/commands/manifest_repos_command.py new file mode 100644 index 0000000..b817662 --- /dev/null +++ b/edkrepo/commands/manifest_repos_command.py @@ -0,0 +1,107 @@ +#!/usr/bin/env python3 +# +## @file +# manifest_repos_command.py +# +# Copyright (c) 2020, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +import configparser + +from edkrepo.commands.edkrepo_command import EdkrepoCommand +import edkrepo.commands.arguments.manifest_repo_args as arguments +import edkrepo.commands.humble.manifest_repos_humble as humble +from edkrepo.common.edkrepo_exception import EdkrepoInvalidParametersException +from edkrepo.common.workspace_maintenance.manifest_repos_maintenance import list_available_manifest_repos + + + + +class ManifestRepos(EdkrepoCommand): + def __init__(self): + super().__init__() + + def get_metadata(self): + metadata = {} + metadata['name'] = 'manifest-repos' + metadata['help-text'] = arguments.COMMAND_DESCRIPTION + args = [] + metadata['arguments'] = args + args.append({'choice': 'list', + 'parent': 'action', + 'help-text': arguments.LIST_HELP}) + args.append({'choice': 'add', + 'parent': 'action', + 'help-text': arguments.ADD_HELP}) + args.append({'choice': 'remove', + 'parent': 'action', + 'help-text': arguments.REMOVE_HELP}) + args.append({'name': 'action', + 'positional': True, + 'position': 0, + 'required': True, + 'choices': True, + 'help-text': arguments.ACTION_HELP}) + args.append({'name': 'name', + 'positional': True, + 'required': False, + 'position': 1, + 'nargs' : 1, + 'help-text': arguments.NAME_HELP}) + args.append({'name': 'branch', + 'positional': True, + 'required': False, + 'position': 3, + 'nargs' : 1, + 'help-text': arguments.BRANCH_HELP}) + args.append({'name': 'url', + 'positional': True, + 'required': False, + 'position': 2, + 'nargs' : 1, + 'help-text': arguments.URL_HELP}) + args.append({'name': 'path', + 'positional': True, + 'required': False, + 'position': 4, + 'nargs' : 1, + 'help-text': arguments.LOCAL_PATH_HELP}) + return metadata + + def run_command(self, args, config): + cfg_repos, user_cfg_repos, conflicts = list_available_manifest_repos(config['cfg_file'], config['user_cfg_file']) + + if args.action == 'list': + for repo in cfg_repos: + print(humble.CFG_LIST_ENTRY.format(repo)) + for repo in user_cfg_repos: + print(humble.USER_CFG_LIST_ENTRY.format(repo)) + + elif (args.action == ('add' or 'remove')) and not args.name: + raise EdkrepoInvalidParametersException(humble.NAME_REQUIRED) + elif args.action == 'add' and not (args.branch or args.url or args.local_path): + raise EdkrepoInvalidParametersException(humble.ADD_REQUIRED) + elif args.action == 'remove' and args.name and args.name in cfg_repos: + raise EdkrepoInvalidParametersException(humble.CANNOT_REMOVE_CFG) + elif args.action =='remove' and args.name not in config['user_cfg_file'].manifest_repo_list: + raise EdkrepoInvalidParametersException(humble.REMOVE_NOT_EXIST) + elif args.action == 'add' and (args.name in cfg_repos or args.name in user_cfg_repos): + raise EdkrepoInvalidParametersException(humble.ALREADY_EXISTS.format(args.name)) + + user_cfg_file_path = config['user_cfg_file'].cfg_filename + + if args.action == 'add' or 'remove': + user_cfg_file = configparser.ConfigParser(allow_no_value=True) + user_cfg_file.read(user_cfg_file_path) + if args.action == 'add': + user_cfg_file.set('manifest-repos', args.name, None) + user_cfg_file.add_section(args.name) + user_cfg_file.set(args.name, 'URL', args.url) + user_cfg_file.set(args.name, 'Branch', args.branch) + user_cfg_file.set(args.name, 'LocalPath', args.path) + if args.action == 'remove': + user_cfg_file.remove_option('manifest-repos', args.name) + user_cfg_file.remove_section(args.name) + with open(user_cfg_file_path, 'w') as cfg_stream: + user_cfg_file.write(cfg_stream) -- 2.16.2.windows.1