#
# Copyright (C) 2023 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Unit tests for fileutils."""
import contextlib
from pathlib
import Path
from tempfile
import TemporaryDirectory
import unittest
import fileutils
import metadata_pb2
UNFORMATTED_BP_FILE =
"""\
cc_library_shared {
name:
"test",
srcs: [
"source2.c",
"source1.c",
],
cflags: [
"-Wno-error=ignored-attributes",
"-Wall",
"-Werror"],
}
"""
FORMATTED_BP_FILE =
"""\
cc_library_shared {
name:
"test",
srcs: [
"source2.c",
"source1.c",
],
cflags: [
"-Wno-error=ignored-attributes",
"-Wall",
"-Werror",
],
}
"""
class ResolveCommandLinePathsTest(unittest.TestCase):
"""Unit tests for resolve_command_line_paths."""
def test_empty_paths(self) ->
None:
"""Tests that an empty argument returns an empty list."""
self.assertListEqual([], fileutils.resolve_command_line_paths([]))
def test_absolute_paths(self) ->
None:
"""Tests that absolute paths are resolved correctly."""
with TemporaryDirectory()
as temp_dir_str:
temp_dir = Path(temp_dir_str)
a = temp_dir /
"a"
b = temp_dir /
"external" /
"b"
a.mkdir()
b.mkdir(parents=
True)
self.assertListEqual(
[a, b],
fileutils.resolve_command_line_paths(
[str(a), str(b),
"/does/not/exist"]
),
)
def test_relative_paths(self) ->
None:
"""Tests that relative paths are resolved correctly."""
with TemporaryDirectory()
as temp_dir_str:
# Make this absolute so the CWD change later doesn't break it.
temp_dir = Path(temp_dir_str).resolve()
external = temp_dir /
"external"
external.mkdir()
a = external /
"a"
a.mkdir()
working_dir = temp_dir /
"cwd"
working_dir.mkdir()
b = working_dir /
"b"
b.mkdir()
with contextlib.chdir(working_dir):
self.assertListEqual(
[a, working_dir, b],
fileutils.resolve_command_line_paths(
[
# These will all be resolved as absolute paths and returned.
"../external/a",
".",
"b",
# This one doesn't exist. It will be pruned from the result.
"c",
]
),
)
class FindTreeContainingTest(unittest.TestCase):
"""Unit tests for find_tree_containing."""
def setUp(self) ->
None:
self._temp_dir = TemporaryDirectory()
self.temp_dir = Path(self._temp_dir.name)
self.repo_tree = self.temp_dir /
"tree"
(self.repo_tree /
".repo").mkdir(parents=
True)
def tearDown(self) ->
None:
self._temp_dir.cleanup()
def test_cwd_is_in_tree(self) ->
None:
"""Tests that the root is found when the CWD is in the same tree."""
(self.repo_tree /
"external/a").mkdir(parents=
True)
(self.repo_tree /
"external/b").mkdir(parents=
True)
with contextlib.chdir(self.repo_tree /
"external/a"):
self.assertEqual(
fileutils.find_tree_containing(self.repo_tree /
"external/b"),
self.repo_tree,
)
def test_cwd_is_in_other_tree(self) ->
None:
"""Tests that the root is found when the CWD is in another tree."""
tree_a = self.temp_dir /
"a"
(tree_a /
".repo").mkdir(parents=
True)
(tree_a /
"external/a").mkdir(parents=
True)
tree_b = self.temp_dir /
"b"
(tree_b /
".repo").mkdir(parents=
True)
(tree_b /
"external/b").mkdir(parents=
True)
with contextlib.chdir(tree_a /
"external/a"):
self.assertEqual(
fileutils.find_tree_containing(tree_b /
"external/b"), tree_b
)
def test_no_root(self) ->
None:
"""Tests that an error is raised when no tree is found."""
with self.assertRaises(FileNotFoundError):
fileutils.find_tree_containing(self.temp_dir)
class BpfmtTest(unittest.TestCase):
"""Unit tests for bpfmt."""
def setUp(self) ->
None:
self._temp_dir = TemporaryDirectory()
self.temp_dir = Path(self._temp_dir.name)
(self.temp_dir /
"Android.bp").write_text(UNFORMATTED_BP_FILE)
def tearDown(self) ->
None:
self._temp_dir.cleanup()
def test_unformatted_bpfmt(self) ->
None:
"""Tests that bpfmt formats the bp file."""
results = fileutils.bpfmt(self.temp_dir, [
'Android.bp'])
content = (self.temp_dir /
"Android.bp").read_text()
if results:
self.assertEqual(content, FORMATTED_BP_FILE)
class MoveGitClosestVersionTest(unittest.TestCase):
def test_non_git_identifier_unchanged(self):
identifier = metadata_pb2.Identifier(type=
"Archive", version=
"1.0.0")
metadata = metadata_pb2.MetaData(
third_party=metadata_pb2.ThirdPartyMetaData(identifier=[identifier])
)
fileutils.move_git_closest_version(metadata)
self.assertEqual(metadata.third_party.identifier[
0], identifier)
def test_git_identifier_no_closest_version_unchanged(self):
identifier = metadata_pb2.Identifier(type=
"Git", version=
"sha")
metadata = metadata_pb2.MetaData(
third_party=metadata_pb2.ThirdPartyMetaData(identifier=[identifier])
)
fileutils.move_git_closest_version(metadata)
self.assertEqual(metadata.third_party.identifier[
0], identifier)
def test_git_identifier_with_closest_version_is_moved(self):
identifier = metadata_pb2.Identifier(
type=
"Git", version=
"sha", closest_version=
"1.2.3"
)
metadata = metadata_pb2.MetaData(
third_party=metadata_pb2.ThirdPartyMetaData(identifier=[identifier])
)
fileutils.move_git_closest_version(metadata)
self.assertEqual(metadata.third_party.identifier[
0].version,
"1.2.3")
self.assertFalse(
metadata.third_party.identifier[
0].HasField(
"closest_version")
)
if __name__ ==
"__main__":
unittest.main(verbosity=
2)
