add more tests for auto-cache

Author: thorsten-klein

tests/test_project_caching.py

@@ -9,6 +9,7 @@
 from conftest import (
     GIT,
     add_commit,
+    chdir,
     cmd,
     create_branch,
     create_repo,
@@ -314,6 +315,104 @@ def test_update_auto_cache(tmpdir):
     assert bar_head_newer in rev_list(auto_cache_dir / "bar" / bar_hash)
 
 
+def test_update_auto_cache_robustness(tmpdir):
+    foo_remote = Path(tmpdir / 'remotes' / 'foo')
+    bar_remote = Path(tmpdir / 'remotes' / 'bar')
+    auto_cache_dir = Path(tmpdir / 'auto_cache_dir')
+
+    def create_foo_bar_commits():
+        add_commit(foo_remote, 'new commit')
+        add_commit(bar_remote, 'new commit')
+        foo_head = rev_parse(foo_remote, 'HEAD')
+        bar_head = rev_parse(bar_remote, 'HEAD')
+        return foo_head, bar_head
+
+    def setup_workspace_and_west_update(workspace, foo_head, bar_head):
+        setup_cache_workspace(
+            workspace,
+            foo_remote=foo_remote,
+            foo_head=foo_head,
+            bar_remote=bar_remote,
+            bar_head=bar_head,
+        )
+        with chdir(workspace):
+            stdout = cmd(['-v', 'update', '--auto-cache', auto_cache_dir])
+        return stdout
+
+    create_repo(foo_remote)
+    create_repo(bar_remote)
+    foo_commit1, bar_commit1 = create_foo_bar_commits()
+    foo_commit2, bar_commit2 = create_foo_bar_commits()
+
+    # run initial west update to setup auto-cache and get cache directories
+    setup_workspace_and_west_update(
+        tmpdir / 'workspace1',
+        foo_head=foo_commit1,
+        bar_head=bar_commit1,
+    )
+
+    # read the auto-cache hashes from foo and bar
+    (bar_hash,) = [p for p in (auto_cache_dir / 'bar').iterdir() if p.is_dir()]
+    auto_cache_dir_bar = auto_cache_dir / 'bar' / bar_hash
+    (foo_hash,) = [p for p in (auto_cache_dir / 'foo').iterdir() if p.is_dir()]
+    auto_cache_dir_foo = auto_cache_dir / 'foo' / foo_hash
+
+    # Imitate that foo remote is temporarily offline by moving it temporarily.
+    # Since foo and bar revisions are used which are already contained in the auto-cache,.
+    # west update should work with according messages as there is no need to update remotes.
+    foo_moved = Path(tmpdir / 'remotes' / 'foo.moved')
+    shutil.move(foo_remote, foo_moved)
+    stdout = setup_workspace_and_west_update(
+        tmpdir / 'workspace2',
+        foo_head=foo_commit2,
+        bar_head=bar_commit2,
+    )
+    shutil.move(foo_moved, foo_remote)
+    msgs = [
+        f"foo: remote (file://{foo_remote}) not reachable. Skip auto-cache update with remote.",
+        f"foo: cloning from {auto_cache_dir_foo}",
+        f"bar: auto-cache remote update is skipped as it already contains revision {bar_commit2}",
+        f"bar: cloning from {auto_cache_dir_bar}",
+    ]
+    for msg in msgs:
+        assert msg in stdout
+
+    # Make the auto-cache from bar corrupt by removing some refs
+    # Use new commits to enforce that the auto-cache tries to update with remote.
+    # west update should detect the corrupt auto-cache, reset it and re-create it
+    shutil.rmtree(auto_cache_dir_bar / 'refs')
+    foo_commit3, bar_commit3 = create_foo_bar_commits()
+    stdout = setup_workspace_and_west_update(
+        tmpdir / 'workspace3',
+        foo_head=foo_commit3,
+        bar_head=bar_commit3,
+    )
+    msgs = [
+        f"foo: update auto-cache ({auto_cache_dir_foo}) with remote",
+        f"foo: cloning from {auto_cache_dir_foo}",
+        f"bar: reset corrupt auto-cache {auto_cache_dir_bar}",
+        f'bar: create auto-cache for file://{bar_remote} in {auto_cache_dir_bar}',
+        f"bar: cloning from {auto_cache_dir_bar}",
+    ]
+    for msg in msgs:
+        assert msg in stdout
+
+    # Make bar auto-cache corrupt by changing the remote HEAD
+    # When trying to clone from this auto-cache, this would leads to git warning:
+    #    warning: remote HEAD refers to nonexistent ref, unable to checkout
+    # Use new commits to enforce that the auto-cache tries to update with remote.
+    # west update should detect the corrupt auto-cache, reset it and re-create it
+    Path(auto_cache_dir_bar / bar_hash / 'HEAD').write_text("ref: refs/heads/nonexistent-branch")
+    foo_commit4, bar_commit4 = create_foo_bar_commits()
+    stdout = setup_workspace_and_west_update(
+        tmpdir / 'workspace4',
+        foo_head=foo_commit4,
+        bar_head=bar_commit4,
+    )
+    for msg in msgs:
+        assert msg in stdout
+
+
 def test_update_caches_priorities(tmpdir):
     # Test that the correct cache is used if multiple caches are specified
     # e.g. if 'west update --name-cache X --path-cache Y --auto-cache Z'