| #!/usr/bin/env fuchsia-vendored-python | |
| # Copyright 2024 The Fuchsia Authors. All rights reserved. | |
| # Use of this source code is governed by a BSD-style license that can be | |
| # found in the LICENSE file. | |
| """Unit tests for compute_content_hash.py""" | |
| import os | |
| import tempfile | |
| import unittest | |
| from pathlib import Path | |
| from build.bazel.scripts import compute_content_hash as cch | |
| from build.bazel.scripts.git_test_utils import git_cmd, git_init | |
| def _setup_first_git_dir(git_dir: Path) -> tuple[str, str]: | |
| git_init(git_dir) | |
| (git_dir / "foo").write_text("1") | |
| git_cmd(git_dir, ["add", "foo"]) | |
| git_cmd(git_dir, ["commit", "-m", "first commit"]) | |
| first_commit = git_cmd(git_dir, ["rev-parse", "HEAD"]) | |
| (git_dir / "foo").write_text("2") | |
| git_cmd(git_dir, ["commit", "-am", "second commit"]) | |
| second_commit = git_cmd(git_dir, ["rev-parse", "HEAD"]) | |
| return (first_commit, second_commit) | |
| def _setup_second_git_dir(git_dir: Path, submodule_path: Path) -> str: | |
| git_init(git_dir) | |
| # Add a submodule. Using -c protocol.file.allow=always | |
| # is required to avoid an error message that says: | |
| # "fatal: transport 'file' not allowed". | |
| # See https://github.com/flatpak/flatpak-builder/issues/495#issuecomment-1297413908 | |
| git_cmd( | |
| git_dir, | |
| [ | |
| "-c", | |
| "init.defaultRefFormat=files", | |
| "-c", | |
| "protocol.file.allow=always", | |
| "submodule", | |
| "add", | |
| submodule_path, | |
| "sub1", | |
| ], | |
| ) | |
| git_cmd(git_dir, ["commit", "-m", "first commit"]) | |
| return git_cmd(git_dir, ["rev-parse", "HEAD"]) | |
| class ComputeContentHashTest(unittest.TestCase): | |
| def setUp(self) -> None: | |
| self._td = tempfile.TemporaryDirectory() | |
| # Resolve the directory so that symlinks in $TMPDIR do not affect | |
| # the expected input paths of symlink chains. | |
| self._dir = Path(self._td.name).resolve() | |
| self.datadir = self._dir / "data" | |
| self.datadir.mkdir(parents=True) | |
| (self.datadir / "README.txt").write_text("Example input file.\n") | |
| (self.datadir / "subdir").mkdir() | |
| (self.datadir / "subdir" / "data").write_text("42") | |
| (self.datadir / "data.link").symlink_to("subdir/data") | |
| self.prebuiltdir = self._dir / "cipd_prebuilt" | |
| self.prebuiltdir.mkdir() | |
| (self.prebuiltdir / ".versions").mkdir() | |
| (self.prebuiltdir / ".versions" / "bar.cipd_version").write_text( | |
| "version 1.0" | |
| ) | |
| def tearDown(self) -> None: | |
| self._td.cleanup() | |
| def _setup_git_repos(self) -> None: | |
| self.gitdir1 = self._dir / "git_project1" | |
| self.first_commit, self.second_commit = _setup_first_git_dir( | |
| self.gitdir1 | |
| ) | |
| self.gitdir2 = self._dir / "git_project2" | |
| self.first_commit2 = _setup_second_git_dir(self.gitdir2, self.gitdir1) | |
| def test_file_content_hash(self) -> None: | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.datadir / "README.txt") | |
| self.assertEqual( | |
| descriptor, "F49d18153ca1983adefbe9c3a2cb91676c73b1024" | |
| ) | |
| def test_symlink_content_hash(self) -> None: | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.datadir / "data.link") | |
| self.assertEqual(descriptor, "Ssubdir/data") | |
| def test_chained_symlink_content_hash(self) -> None: | |
| chained_link = self.datadir / "chained.link" | |
| chained_link.symlink_to("data.link") | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(chained_link) | |
| self.assertEqual(descriptor, "Sdata.link->subdir/data") | |
| self.assertEqual( | |
| fstate.get_input_file_paths(), | |
| {chained_link, self.datadir / "data.link"}, | |
| ) | |
| def test_chained_symlink_relative_path(self) -> None: | |
| # Relative source paths (e.g. rebased on the build directory) must | |
| # produce relative input paths for the intermediate links too. | |
| chained_link = self.datadir / "chained.link" | |
| chained_link.symlink_to("data.link") | |
| cwd = os.getcwd() | |
| os.chdir(self._dir) | |
| try: | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(Path("data/chained.link")) | |
| finally: | |
| os.chdir(cwd) | |
| self.assertEqual(descriptor, "Sdata.link->subdir/data") | |
| self.assertEqual( | |
| fstate.get_input_file_paths(), | |
| {Path("data/chained.link"), Path("data/data.link")}, | |
| ) | |
| def test_symlink_through_symlinked_directory(self) -> None: | |
| # Relative link targets containing '..' must be applied to the real | |
| # directory containing the link, not to the lexical path used to | |
| # reach it through a symlinked directory. | |
| real_dir = self.datadir / "a" / "real" | |
| real_dir.mkdir(parents=True) | |
| (self.datadir / "a" / "sibling.txt").write_text("real") | |
| (self.datadir / "sibling.txt").write_text("decoy") | |
| (real_dir / "link2").symlink_to("../sibling.txt") | |
| (real_dir / "link1").symlink_to("link2") | |
| (self.datadir / "dir_sym").symlink_to("a/real") | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path( | |
| self.datadir / "dir_sym" / "link1" | |
| ) | |
| self.assertEqual(descriptor, "Slink2->../sibling.txt") | |
| self.assertEqual( | |
| fstate.get_input_file_paths(), | |
| {self.datadir / "dir_sym" / "link1", real_dir / "link2"}, | |
| ) | |
| def test_absolute_symlink_content_hash(self) -> None: | |
| absolute_link = self.datadir / "absolute.link" | |
| absolute_link.symlink_to(self.datadir / "data.link") | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(absolute_link) | |
| self.assertEqual( | |
| descriptor, f"S{self.datadir / 'data.link'}->subdir/data" | |
| ) | |
| self.assertEqual( | |
| fstate.get_input_file_paths(), | |
| {absolute_link, self.datadir / "data.link"}, | |
| ) | |
| def test_directory_content_hash(self) -> None: | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.datadir) | |
| self.assertEqual( | |
| descriptor, | |
| """D | |
| README.txt F49d18153ca1983adefbe9c3a2cb91676c73b1024 | |
| data.link Ssubdir/data | |
| subdir/data F92cfceb39d57d914ed8b14d0e37643de0797ae56 | |
| """, | |
| ) | |
| def test_cipd_content_hash(self) -> None: | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.prebuiltdir) | |
| self.assertEqual( | |
| descriptor, | |
| """D | |
| .versions/bar.cipd_version F105a6be87e08ee0d67f397a498315de3afaba803 | |
| """, | |
| ) | |
| fstate = cch.FileState(cipd_names=["bar"]) | |
| descriptor = fstate.process_source_path(self.prebuiltdir) | |
| self.assertEqual( | |
| descriptor, "F105a6be87e08ee0d67f397a498315de3afaba803" | |
| ) | |
| def test_git_content_hash_no_submodules(self) -> None: | |
| self._setup_git_repos() | |
| # on branch on first git repository. | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.gitdir1) | |
| self.assertEqual(descriptor, "G" + self.second_commit) | |
| # detached HEAD on first git repository. | |
| git_cmd(self.gitdir1, ["checkout", self.first_commit]) | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.gitdir1) | |
| self.assertEqual(descriptor, "G" + self.first_commit) | |
| # on branch on second git repository + on branch in submodule | |
| fstate = cch.FileState() | |
| descriptor = fstate.process_source_path(self.gitdir2) | |
| self.assertEqual(descriptor, "G" + self.first_commit2) | |
| if __name__ == "__main__": | |
| unittest.main() |