Skip to content

Commit

Permalink
Fix caching for repos without remotes (#194)
Browse files Browse the repository at this point in the history
* Fix caching for repos without remotes

* snake_case!

* Added tests for Versioned.get_remote (old and new versions)

* Removed old_get_remote()
  • Loading branch information
lakesare committed Jul 1, 2021
1 parent 5a9312d commit 7e8635e
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 12 deletions.
24 changes: 16 additions & 8 deletions sciunit/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,22 +211,30 @@ def get_version(self, cached: bool = True) -> str:

version = property(get_version)

def get_remote(self, remote: str = "origin") -> Remote:
def get_remote(self, remote_name: str = "origin", **kwargs) -> Remote:
"""Get a git remote object for this instance.
Args:
remote (str, optional): The remote Git repo. Defaults to 'origin'.
remote_name (str, optional): The remote Git repo. Defaults to 'origin'.
Returns:
Remote: The git remote object for this instance.
"""
repo = self.get_repo()
if repo is not None:
remotes = {r.name: r for r in repo.remotes}
r = repo.remotes[0] if remote not in remotes else remotes[remote]
repo = kwargs["repo"] if "repo" in kwargs else self.get_repo()

if repo is None:
return None

if len(repo.remotes) == 0:
return None

matching = [r for r in repo.remotes if r.name == remote_name]
if (len(matching) > 0):
# => Remote with remote_name
return matching[0]
else:
r = None
return r
# => just any first Remote
return repo.remotes[0]

def get_remote_url(self, remote: str = "origin", cached: bool = True) -> str:
"""Get a git remote URL for this instance.
Expand Down
38 changes: 34 additions & 4 deletions sciunit/unit_test/base_tests.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
import unittest

from pathlib import Path

tmp_folder_path = Path(__file__).parent / "delete_after_tests"

class BaseCase(unittest.TestCase):
"""Unit tests for config files"""

@classmethod
def setUpClass(cls):
Path(tmp_folder_path).mkdir(parents=True, exist_ok=True)

@classmethod
def tearDownClass(cls):
import shutil
if tmp_folder_path.exists() and tmp_folder_path.is_dir():
shutil.rmtree(tmp_folder_path)

def test_deep_exclude(self):
from sciunit.base import deep_exclude

Expand All @@ -30,15 +43,32 @@ def test_SciUnit(self):

def test_Versioned(self):
from git import Repo

from sciunit.base import Versioned

ver = Versioned()
self.assertEqual("origin", str(ver.get_remote("I am not a remote")))
self.assertEqual("origin", str(ver.get_remote()))

# Testing .get_remote()
# 1. Checking our sciunit .git repo
# (to make sure .get_remote() works with real repos too!)
self.assertEqual("origin", ver.get_remote("I am not a remote").name)
self.assertEqual("origin", ver.get_remote().name)
# 2. Checking NO .git repo
self.assertEqual(None, ver.get_remote(repo=None))
# 3. Checking a .git repo without remotes
git_repo = Repo.init(tmp_folder_path / "git_repo")
self.assertEqual(None, ver.get_remote(repo=git_repo))
# 4. Checking a .git repo with remotes
origin = git_repo.create_remote("origin", "https://origin.com")
beta = git_repo.create_remote('beta', "https://beta.com")
self.assertEqual(origin, ver.get_remote(repo=git_repo))
self.assertEqual(origin, ver.get_remote("not a remote", repo=git_repo))
self.assertEqual(beta, ver.get_remote("beta", repo=git_repo))

# Testing .get_repo()
self.assertIsInstance(ver.get_repo(), Repo)
self.assertIsInstance(ver.get_remote_url("I am not a remote"), str)

# Testing .get_remote_url()
self.assertIsInstance(ver.get_remote_url("I am not a remote"), str)

if __name__ == "__main__":
unittest.main()

0 comments on commit 7e8635e

Please sign in to comment.