Migrate subsection of vcstools' API for compatibility with bloom

[leander-dsouza]

Note

Please refer #751 for verifying integration with bloom.

Basic Info

Info	Please fill out this column
Ticket(s) this addresses	N/A
Primary OS tested on	Ubuntu
Is this a breaking change?	No
Does this PR contain AI generated software?	No

---

Description of contribution in a few bullet points

• This ports over four main functions from vcstools, namely export_repositories , checkout, get_vcs_client, and get_path for all the VCS clients.

• This is because these are the four prominent methods used in bloom as seen here.

  • checkout reference
  • export_repositories reference
  • get_vcs_client reference
  • get_path reference

• In addition, the corresponding integration tests have been added to both of these functions across svn, bzr, hg, and git clients.

• Breezy has been added to the CI for testing on macOS and Ubuntu.

• The integration can be safely verified in #751 at bloom. All the system and unit tests pass upon merge.

Description of how this change was tested

• Ran pytest locally to ensure all the unit and linting tests pass:

  pytest -s -v test

Signed-off-by: Leander Stephen Desouza [email protected]

[codecov-commenter]

Codecov Report

❌ Patch coverage is 37.50000% with 145 lines in your changes missing coverage. Please review.
✅ Project coverage is 28.13%. Comparing base (75727e7) to head (5b27149).

Files with missing lines	Patch %	Lines
vcs2l/clients/svn.py	9.83%	55 Missing ⚠️
vcs2l/clients/bzr.py	5.71%	33 Missing ⚠️
vcs2l/clients/git.py	51.61%	23 Missing and 7 partials ⚠️
vcs2l/clients/hg.py	65.95%	10 Missing and 6 partials ⚠️
vcs2l/clients/__init__.py	63.63%	4 Missing ⚠️
vcs2l/clients/vcs_base.py	50.00%	3 Missing ⚠️
vcs2l/clients/tar.py	60.00%	2 Missing ⚠️
vcs2l/clients/zip.py	60.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #43      +/-   ##
==========================================
+ Coverage   26.98%   28.13%   +1.14%     
==========================================
  Files          31       31              
  Lines        2238     2463     +225     
  Branches      392      436      +44     
==========================================
+ Hits          604      693      +89     
- Misses       1574     1698     +124     
- Partials       60       72      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[SuperJappie08]

@leander-dsouza, I noticed that some implementations of export_repository are prefixed with an underscore (_export_repository), is this intentional?

[nuclearsandwich]

It looks good but for the one comment about the git client which I believe can be simplified dramatically.

[nuclearsandwich]

if we have an exact version to provide as a commit-ish->tree-ish what is the requirement to use a temp directory. git-archive does not make any changes to the working directory. I have not gone spelunking in the history but I'm willing to hypothesize that this behavior is carried over from a vcs which does not support exporting archives of snapshots without checking them out first.

git archive --format=tar.gz --output={filepath} export_sha

[leander-dsouza]

Yes, you are correct, Steven.
I tried to replicate the archiving behaviour of the original implementation of the archiving process in vcstools

I have now simplified the implementation of this section, as git archive does not change the cwd.

[cottsay]

A handful of these are named _export_repository instead of export_repository. to match the API. Is that intentional?

[leander-dsouza]

I briefly remember selectively naming the export methods for this reason.
However, I cannot find these methods in the vcstools repository. Hence, I added a commit to standardise the export repository methods across all VCS clients.

[leander-dsouza]

@leander-dsouza, I noticed that some implementations of export_repository are prefixed with an underscore (_export_repository), is this intentional?

I remember drafting the export methods to match the vcstools repository. However, I think I was mistaken, and hence I added a commit to standardise all the export repository methods across all VCS clients.