Re: [edk2-staging/EdkRepo] [PATCH 3/7] EdkRepo: Add optional field to edkrepo_manifst to track the source manifest repo

["Nate DeSimone" <nathaniel.l.desimone@intel.com>]

Hi Ashley,

Please see comments inline.

Thanks,
Nate

> -----Original Message-----
> From: Desimone, Ashley E <ashley.e.desimone@intel.com>
> Sent: Tuesday, April 28, 2020 2:57 PM
> To: devel@edk2.groups.io
> Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Pandya, Puja
> <puja.pandya@intel.com>; Bjorge, Erik C <erik.c.bjorge@intel.com>; Bret
> Barkelew <Bret.Barkelew@microsoft.com>; Agyeman, Prince
> <prince.agyeman@intel.com>
> Subject: [edk2-staging/EdkRepo] [PATCH 3/7] EdkRepo: Add optional field to
> edkrepo_manifst to track the source manifest repo
> 
> Add the SourceManifestRepository to the edkrepo manfiest general config
> for use by edkrepo to track the source manifest repository for the
> workspace.
> 
> Signed-off-by: Ashley E Desimone <ashley.e.desimone@intel.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Cc: Puja Pandya <puja.pandya@intel.com>
> Cc: Erik Bjorge <erik.c.bjorge@intel.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Cc: Prince Agyeman <prince.agyeman@intel.com>
> ---
>  edkrepo_manifest_parser/edk_manifest.py | 26
> ++++++++++++++++++++++++--
>  1 file changed, 24 insertions(+), 2 deletions(-)
> 
> diff --git a/edkrepo_manifest_parser/edk_manifest.py
> b/edkrepo_manifest_parser/edk_manifest.py
> index 080448f..dcf9c29 100644
> --- a/edkrepo_manifest_parser/edk_manifest.py
> +++ b/edkrepo_manifest_parser/edk_manifest.py
> @@ -21,7 +21,7 @@ import copy
>  # All the namedtuple data structures that consumers of this module will
> need.
>  #
>  ProjectInfo = namedtuple('ProjectInfo', ['codename', 'description',
> 'dev_leads', 'reviewers', 'org', 'short_name']) -GeneralConfig =
> namedtuple('GeneralConfig', ['default_combo', 'current_combo',
> 'pin_path'])
> +GeneralConfig = namedtuple('GeneralConfig', ['default_combo',
> +'current_combo', 'pin_path', 'source_man_repo'])

The variable name "source_man_repo" is a bit confusing. My initial thought when I saw that name was that it was something about documentation. Could you please rename to "source_manifest_repo"?

>  RemoteRepo = namedtuple('RemoteRepo', ['name', 'url'])  RepoHook =
> namedtuple('RepoHook', ['source', 'dest_path', 'dest_file', 'remote_url'])
> Combination = namedtuple('Combination', ['name', 'description']) @@ -406,6
> +406,24 @@ class ManifestXml(BaseXmlHelper):
>          self._tree.write(filename)
>          self.__general_config.current_combo = combo_name
> 
> +    def write_source_manifest_repo(self, manifest_repo, filename=None):
> +        '''
> +        Writes the name of the source manifest repository to the
> +        general config sections of the manifest file.
> +        '''
> +        if filename is None:
> +            filename = self._fileref
> +        subroot = self._tree.find('GeneralConfig')
> +        if subroot is None:
> +            raise KeyError(GENERAL_CONFIG_MISSING_ERROR)
> +
> +        element = subroot.find('SourceManifestRepository')
> +        if element is None:
> +            element = ET.SubElement(subroot, 'SourceManifestRepository')
> +        element.attrib['manifest_repo'] = manifest_repo
> +        self._tree.write(filename)
> +        self.__general_config.source_man_repo = manifest_repo
> +
>      def generate_pin_xml(self, description, combo_name, repo_source_list,
> filename=None):
> 
>          pin_tree = ET.ElementTree(ET.Element('Pin')) @@ -605,10 +623,14 @@
> class _GeneralConfig():
>              self.curr_combo =
> element.find('CurrentClonedCombo').attrib['combination']
>          except:
>              self.curr_combo = None
> +        try:
> +            self.source_man_repo =
> element.find('SourceManifestRepository').attrib['manifest_repo']
> +        except:
> +            self.source_man_repo = None
> 
>      @property
>      def tuple(self):
> -        return GeneralConfig(self.default_combo, self.curr_combo,
> self.pin_path)
> +        return GeneralConfig(self.default_combo, self.curr_combo,
> + self.pin_path, self.source_man_repo)
> 
>  class _RemoteRepo():
>      def __init__(self, element):
> --
> 2.16.2.windows.1