Re: [RFC] UnitTestFrameworkPkg cmocka submodule alternatives

["Michael D Kinney" <michael.d.kinney@intel.com>]

Hello,

There have been a few suggestions to create a mirror of cmocka in TianoCore
org in GitHub.

I have found a GitHub action that can do a repo sync.

    https://github.com/marketplace/actions/github-repo-sync

I have created a temporary mirror of cmocka in my personal GitHub area that
uses this GitHub action to sync all branches and all tags once a day.

    https://github.com/mdkinney/mirror-cmocka

Here is the GitHub workflow file.  It must be in the default branch for the
repo using a branch name that is not present in the repo being mirrored.
In this case, I used a branch name of 'repo-sync'.

    https://github.com/mdkinney/mirror-cmocka/blob/repo-sync/.github/workflows/repo-sync.yml

Please provide feedback on this approach.  If we like this approach, then
I suggest we create a new repo in TianoCore called edk2-cmocka that is a 
mirror that is synced once a day and we update the cmocka submodule in the
edk2 repo to use edk2-cmocka.

Best regards,

Mike

> -----Original Message-----
> From: Kinney, Michael D <michael.d.kinney@intel.com>
> Sent: Wednesday, December 16, 2020 10:46 AM
> To: rfc@edk2.groups.io; devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>; 'Bret Barkelew'
> <Bret.Barkelew@microsoft.com>
> Subject: [RFC] UnitTestFrameworkPkg cmocka submodule alternatives
> 
> Hello,
> 
> We have had at least three incidents in the last year where the link to the
> cmocka submodule in the UnitTestFrameworkPkg has not been available, and this
> impacted the EDK II CI system.  The following submodule link is the one that
> is not reliable:
> 
> 	https://git.cryptomilk.org/projects/cmocka.git
> 
> We have identified two potential mirrors of this repo:
> 
> 	https://github.com/neverware-mirrors/cmocka.git
> 	https://gitlab.com/cmocka/cmocka.git
> 
> The following patch provided a temporary fix for the EDK II CI agents, but
> does not help other consumers of the edk2 repository.
> 
> 	https://github.com/tianocore/edk2/commit/be746104d1766a8c363e74d6063144657820d688
> 
> I have seen one suggestion that TianoCore create its own
> mirror of cmocka.  This does require monitoring and maintenance
> by the  TianoCore community.  I would prefer to use a well
> maintained mirror in github as long as we do not observe any
> issues with the support of that mirror.
> 
> I propose we update the submodule in the UnitTestFrameworkPkg
> to use the https://github.com/neverware-mirrors/cmocka.git mirror.
> By using a mirror in github, we remove one external dependency.
> 
> Please provide feedback and comments on this proposal.  If there
> are no objections, then we will proceed with a patch review for
> this update.
> 
> Thanks,
> 
> Mike