Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 1 | # Copyright (C) 2019 The Android Open Source Project |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
| 15 | """Unittests for the manifest_xml.py module.""" |
| 16 | |
Mike Frysinger | d925459 | 2020-02-19 22:36:26 -0500 | [diff] [blame] | 17 | import os |
Raman Tenneti | 080877e | 2021-03-09 15:19:06 -0800 | [diff] [blame] | 18 | import platform |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 19 | import re |
Mike Frysinger | 8c1e9cb | 2020-09-06 14:53:18 -0400 | [diff] [blame] | 20 | import shutil |
| 21 | import tempfile |
Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 22 | import unittest |
Mike Frysinger | bb8ee7f | 2020-02-22 05:30:12 -0500 | [diff] [blame] | 23 | import xml.dom.minidom |
Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 24 | |
| 25 | import error |
| 26 | import manifest_xml |
| 27 | |
| 28 | |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 29 | # Invalid paths that we don't want in the filesystem. |
| 30 | INVALID_FS_PATHS = ( |
| 31 | '', |
| 32 | '.', |
| 33 | '..', |
| 34 | '../', |
| 35 | './', |
Mike Frysinger | 0458faa | 2021-03-10 23:35:44 -0500 | [diff] [blame] | 36 | './/', |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 37 | 'foo/', |
| 38 | './foo', |
| 39 | '../foo', |
| 40 | 'foo/./bar', |
| 41 | 'foo/../../bar', |
| 42 | '/foo', |
| 43 | './../foo', |
| 44 | '.git/foo', |
| 45 | # Check case folding. |
| 46 | '.GIT/foo', |
| 47 | 'blah/.git/foo', |
| 48 | '.repo/foo', |
| 49 | '.repoconfig', |
| 50 | # Block ~ due to 8.3 filenames on Windows filesystems. |
| 51 | '~', |
| 52 | 'foo~', |
| 53 | 'blah/foo~', |
| 54 | # Block Unicode characters that get normalized out by filesystems. |
| 55 | u'foo\u200Cbar', |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 56 | # Block newlines. |
| 57 | 'f\n/bar', |
| 58 | 'f\r/bar', |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 59 | ) |
| 60 | |
| 61 | # Make sure platforms that use path separators (e.g. Windows) are also |
| 62 | # rejected properly. |
| 63 | if os.path.sep != '/': |
| 64 | INVALID_FS_PATHS += tuple(x.replace('/', os.path.sep) for x in INVALID_FS_PATHS) |
| 65 | |
| 66 | |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 67 | def sort_attributes(manifest): |
| 68 | """Sort the attributes of all elements alphabetically. |
| 69 | |
| 70 | This is needed because different versions of the toxml() function from |
| 71 | xml.dom.minidom outputs the attributes of elements in different orders. |
| 72 | Before Python 3.8 they were output alphabetically, later versions preserve |
| 73 | the order specified by the user. |
| 74 | |
| 75 | Args: |
| 76 | manifest: String containing an XML manifest. |
| 77 | |
| 78 | Returns: |
| 79 | The XML manifest with the attributes of all elements sorted alphabetically. |
| 80 | """ |
| 81 | new_manifest = '' |
| 82 | # This will find every element in the XML manifest, whether they have |
| 83 | # attributes or not. This simplifies recreating the manifest below. |
| 84 | matches = re.findall(r'(<[/?]?[a-z-]+\s*)((?:\S+?="[^"]+"\s*?)*)(\s*[/?]?>)', manifest) |
| 85 | for head, attrs, tail in matches: |
| 86 | m = re.findall(r'\S+?="[^"]+"', attrs) |
| 87 | new_manifest += head + ' '.join(sorted(m)) + tail |
| 88 | return new_manifest |
| 89 | |
| 90 | |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 91 | class ManifestParseTestCase(unittest.TestCase): |
| 92 | """TestCase for parsing manifests.""" |
| 93 | |
| 94 | def setUp(self): |
| 95 | self.tempdir = tempfile.mkdtemp(prefix='repo_tests') |
| 96 | self.repodir = os.path.join(self.tempdir, '.repo') |
| 97 | self.manifest_dir = os.path.join(self.repodir, 'manifests') |
| 98 | self.manifest_file = os.path.join( |
| 99 | self.repodir, manifest_xml.MANIFEST_FILE_NAME) |
| 100 | self.local_manifest_dir = os.path.join( |
| 101 | self.repodir, manifest_xml.LOCAL_MANIFESTS_DIR_NAME) |
| 102 | os.mkdir(self.repodir) |
| 103 | os.mkdir(self.manifest_dir) |
| 104 | |
| 105 | # The manifest parsing really wants a git repo currently. |
| 106 | gitdir = os.path.join(self.repodir, 'manifests.git') |
| 107 | os.mkdir(gitdir) |
| 108 | with open(os.path.join(gitdir, 'config'), 'w') as fp: |
| 109 | fp.write("""[remote "origin"] |
| 110 | url = https://localhost:0/manifest |
| 111 | """) |
| 112 | |
| 113 | def tearDown(self): |
| 114 | shutil.rmtree(self.tempdir, ignore_errors=True) |
| 115 | |
| 116 | def getXmlManifest(self, data): |
| 117 | """Helper to initialize a manifest for testing.""" |
| 118 | with open(self.manifest_file, 'w') as fp: |
| 119 | fp.write(data) |
| 120 | return manifest_xml.XmlManifest(self.repodir, self.manifest_file) |
| 121 | |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 122 | @staticmethod |
| 123 | def encodeXmlAttr(attr): |
| 124 | """Encode |attr| using XML escape rules.""" |
| 125 | return attr.replace('\r', '
').replace('\n', '
') |
| 126 | |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 127 | |
Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 128 | class ManifestValidateFilePaths(unittest.TestCase): |
| 129 | """Check _ValidateFilePaths helper. |
| 130 | |
| 131 | This doesn't access a real filesystem. |
| 132 | """ |
| 133 | |
| 134 | def check_both(self, *args): |
| 135 | manifest_xml.XmlManifest._ValidateFilePaths('copyfile', *args) |
| 136 | manifest_xml.XmlManifest._ValidateFilePaths('linkfile', *args) |
| 137 | |
| 138 | def test_normal_path(self): |
| 139 | """Make sure good paths are accepted.""" |
| 140 | self.check_both('foo', 'bar') |
| 141 | self.check_both('foo/bar', 'bar') |
| 142 | self.check_both('foo', 'bar/bar') |
| 143 | self.check_both('foo/bar', 'bar/bar') |
| 144 | |
| 145 | def test_symlink_targets(self): |
| 146 | """Some extra checks for symlinks.""" |
| 147 | def check(*args): |
| 148 | manifest_xml.XmlManifest._ValidateFilePaths('linkfile', *args) |
| 149 | |
| 150 | # We allow symlinks to end in a slash since we allow them to point to dirs |
| 151 | # in general. Technically the slash isn't necessary. |
| 152 | check('foo/', 'bar') |
Mike Frysinger | ae62541 | 2020-02-10 17:10:03 -0500 | [diff] [blame] | 153 | # We allow a single '.' to get a reference to the project itself. |
| 154 | check('.', 'bar') |
Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 155 | |
| 156 | def test_bad_paths(self): |
| 157 | """Make sure bad paths (src & dest) are rejected.""" |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 158 | for path in INVALID_FS_PATHS: |
Mike Frysinger | 04122b7 | 2019-07-31 23:32:58 -0400 | [diff] [blame] | 159 | self.assertRaises( |
| 160 | error.ManifestInvalidPathError, self.check_both, path, 'a') |
| 161 | self.assertRaises( |
| 162 | error.ManifestInvalidPathError, self.check_both, 'a', path) |
Mike Frysinger | bb8ee7f | 2020-02-22 05:30:12 -0500 | [diff] [blame] | 163 | |
| 164 | |
| 165 | class ValueTests(unittest.TestCase): |
| 166 | """Check utility parsing code.""" |
| 167 | |
| 168 | def _get_node(self, text): |
| 169 | return xml.dom.minidom.parseString(text).firstChild |
| 170 | |
| 171 | def test_bool_default(self): |
| 172 | """Check XmlBool default handling.""" |
| 173 | node = self._get_node('<node/>') |
| 174 | self.assertIsNone(manifest_xml.XmlBool(node, 'a')) |
| 175 | self.assertIsNone(manifest_xml.XmlBool(node, 'a', None)) |
| 176 | self.assertEqual(123, manifest_xml.XmlBool(node, 'a', 123)) |
| 177 | |
| 178 | node = self._get_node('<node a=""/>') |
| 179 | self.assertIsNone(manifest_xml.XmlBool(node, 'a')) |
| 180 | |
| 181 | def test_bool_invalid(self): |
| 182 | """Check XmlBool invalid handling.""" |
| 183 | node = self._get_node('<node a="moo"/>') |
| 184 | self.assertEqual(123, manifest_xml.XmlBool(node, 'a', 123)) |
| 185 | |
| 186 | def test_bool_true(self): |
| 187 | """Check XmlBool true values.""" |
| 188 | for value in ('yes', 'true', '1'): |
| 189 | node = self._get_node('<node a="%s"/>' % (value,)) |
| 190 | self.assertTrue(manifest_xml.XmlBool(node, 'a')) |
| 191 | |
| 192 | def test_bool_false(self): |
| 193 | """Check XmlBool false values.""" |
| 194 | for value in ('no', 'false', '0'): |
| 195 | node = self._get_node('<node a="%s"/>' % (value,)) |
| 196 | self.assertFalse(manifest_xml.XmlBool(node, 'a')) |
| 197 | |
| 198 | def test_int_default(self): |
| 199 | """Check XmlInt default handling.""" |
| 200 | node = self._get_node('<node/>') |
| 201 | self.assertIsNone(manifest_xml.XmlInt(node, 'a')) |
| 202 | self.assertIsNone(manifest_xml.XmlInt(node, 'a', None)) |
| 203 | self.assertEqual(123, manifest_xml.XmlInt(node, 'a', 123)) |
| 204 | |
| 205 | node = self._get_node('<node a=""/>') |
| 206 | self.assertIsNone(manifest_xml.XmlInt(node, 'a')) |
| 207 | |
| 208 | def test_int_good(self): |
| 209 | """Check XmlInt numeric handling.""" |
| 210 | for value in (-1, 0, 1, 50000): |
| 211 | node = self._get_node('<node a="%s"/>' % (value,)) |
| 212 | self.assertEqual(value, manifest_xml.XmlInt(node, 'a')) |
| 213 | |
| 214 | def test_int_invalid(self): |
| 215 | """Check XmlInt invalid handling.""" |
| 216 | with self.assertRaises(error.ManifestParseError): |
| 217 | node = self._get_node('<node a="xx"/>') |
| 218 | manifest_xml.XmlInt(node, 'a') |
Mike Frysinger | 8c1e9cb | 2020-09-06 14:53:18 -0400 | [diff] [blame] | 219 | |
| 220 | |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 221 | class XmlManifestTests(ManifestParseTestCase): |
Mike Frysinger | 8c1e9cb | 2020-09-06 14:53:18 -0400 | [diff] [blame] | 222 | """Check manifest processing.""" |
| 223 | |
Mike Frysinger | 8c1e9cb | 2020-09-06 14:53:18 -0400 | [diff] [blame] | 224 | def test_empty(self): |
| 225 | """Parse an 'empty' manifest file.""" |
| 226 | manifest = self.getXmlManifest( |
| 227 | '<?xml version="1.0" encoding="UTF-8"?>' |
| 228 | '<manifest></manifest>') |
| 229 | self.assertEqual(manifest.remotes, {}) |
| 230 | self.assertEqual(manifest.projects, []) |
| 231 | |
| 232 | def test_link(self): |
| 233 | """Verify Link handling with new names.""" |
| 234 | manifest = manifest_xml.XmlManifest(self.repodir, self.manifest_file) |
| 235 | with open(os.path.join(self.manifest_dir, 'foo.xml'), 'w') as fp: |
| 236 | fp.write('<manifest></manifest>') |
| 237 | manifest.Link('foo.xml') |
| 238 | with open(self.manifest_file) as fp: |
| 239 | self.assertIn('<include name="foo.xml" />', fp.read()) |
| 240 | |
| 241 | def test_toxml_empty(self): |
| 242 | """Verify the ToXml() helper.""" |
| 243 | manifest = self.getXmlManifest( |
| 244 | '<?xml version="1.0" encoding="UTF-8"?>' |
| 245 | '<manifest></manifest>') |
| 246 | self.assertEqual(manifest.ToXml().toxml(), '<?xml version="1.0" ?><manifest/>') |
| 247 | |
| 248 | def test_todict_empty(self): |
| 249 | """Verify the ToDict() helper.""" |
| 250 | manifest = self.getXmlManifest( |
| 251 | '<?xml version="1.0" encoding="UTF-8"?>' |
| 252 | '<manifest></manifest>') |
| 253 | self.assertEqual(manifest.ToDict(), {}) |
| 254 | |
Mike Frysinger | 51e39d5 | 2020-12-04 05:32:06 -0500 | [diff] [blame] | 255 | def test_repo_hooks(self): |
| 256 | """Check repo-hooks settings.""" |
| 257 | manifest = self.getXmlManifest(""" |
| 258 | <manifest> |
| 259 | <remote name="test-remote" fetch="http://localhost" /> |
| 260 | <default remote="test-remote" revision="refs/heads/main" /> |
| 261 | <project name="repohooks" path="src/repohooks"/> |
| 262 | <repo-hooks in-project="repohooks" enabled-list="a, b"/> |
| 263 | </manifest> |
| 264 | """) |
| 265 | self.assertEqual(manifest.repo_hooks_project.name, 'repohooks') |
| 266 | self.assertEqual(manifest.repo_hooks_project.enabled_repo_hooks, ['a', 'b']) |
| 267 | |
Raman Tenneti | 48b2d10 | 2021-01-11 12:18:47 -0800 | [diff] [blame] | 268 | def test_unknown_tags(self): |
| 269 | """Check superproject settings.""" |
| 270 | manifest = self.getXmlManifest(""" |
| 271 | <manifest> |
| 272 | <remote name="test-remote" fetch="http://localhost" /> |
| 273 | <default remote="test-remote" revision="refs/heads/main" /> |
| 274 | <superproject name="superproject"/> |
| 275 | <iankaz value="unknown (possible) future tags are ignored"/> |
| 276 | <x-custom-tag>X tags are always ignored</x-custom-tag> |
| 277 | </manifest> |
| 278 | """) |
| 279 | self.assertEqual(manifest.superproject['name'], 'superproject') |
| 280 | self.assertEqual(manifest.superproject['remote'].name, 'test-remote') |
| 281 | self.assertEqual( |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 282 | sort_attributes(manifest.ToXml().toxml()), |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 283 | '<?xml version="1.0" ?><manifest>' |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 284 | '<remote fetch="http://localhost" name="test-remote"/>' |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 285 | '<default remote="test-remote" revision="refs/heads/main"/>' |
| 286 | '<superproject name="superproject"/>' |
Raman Tenneti | 48b2d10 | 2021-01-11 12:18:47 -0800 | [diff] [blame] | 287 | '</manifest>') |
| 288 | |
Fredrik de Groot | 352c93b | 2020-10-06 12:55:14 +0200 | [diff] [blame] | 289 | |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 290 | class IncludeElementTests(ManifestParseTestCase): |
| 291 | """Tests for <include>.""" |
Raman Tenneti | b5c5a5e | 2021-02-06 09:44:15 -0800 | [diff] [blame] | 292 | |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 293 | def test_group_levels(self): |
Fredrik de Groot | 352c93b | 2020-10-06 12:55:14 +0200 | [diff] [blame] | 294 | root_m = os.path.join(self.manifest_dir, 'root.xml') |
| 295 | with open(root_m, 'w') as fp: |
| 296 | fp.write(""" |
| 297 | <manifest> |
| 298 | <remote name="test-remote" fetch="http://localhost" /> |
| 299 | <default remote="test-remote" revision="refs/heads/main" /> |
| 300 | <include name="level1.xml" groups="level1-group" /> |
| 301 | <project name="root-name1" path="root-path1" /> |
| 302 | <project name="root-name2" path="root-path2" groups="r2g1,r2g2" /> |
| 303 | </manifest> |
| 304 | """) |
| 305 | with open(os.path.join(self.manifest_dir, 'level1.xml'), 'w') as fp: |
| 306 | fp.write(""" |
| 307 | <manifest> |
| 308 | <include name="level2.xml" groups="level2-group" /> |
| 309 | <project name="level1-name1" path="level1-path1" /> |
| 310 | </manifest> |
| 311 | """) |
| 312 | with open(os.path.join(self.manifest_dir, 'level2.xml'), 'w') as fp: |
| 313 | fp.write(""" |
| 314 | <manifest> |
| 315 | <project name="level2-name1" path="level2-path1" groups="l2g1,l2g2" /> |
| 316 | </manifest> |
| 317 | """) |
| 318 | include_m = manifest_xml.XmlManifest(self.repodir, root_m) |
| 319 | for proj in include_m.projects: |
| 320 | if proj.name == 'root-name1': |
| 321 | # Check include group not set on root level proj. |
| 322 | self.assertNotIn('level1-group', proj.groups) |
| 323 | if proj.name == 'root-name2': |
| 324 | # Check root proj group not removed. |
| 325 | self.assertIn('r2g1', proj.groups) |
| 326 | if proj.name == 'level1-name1': |
| 327 | # Check level1 proj has inherited group level 1. |
| 328 | self.assertIn('level1-group', proj.groups) |
| 329 | if proj.name == 'level2-name1': |
| 330 | # Check level2 proj has inherited group levels 1 and 2. |
| 331 | self.assertIn('level1-group', proj.groups) |
| 332 | self.assertIn('level2-group', proj.groups) |
| 333 | # Check level2 proj group not removed. |
| 334 | self.assertIn('l2g1', proj.groups) |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 335 | |
Mike Frysinger | 5413397 | 2021-03-01 21:38:08 -0500 | [diff] [blame] | 336 | def test_allow_bad_name_from_user(self): |
| 337 | """Check handling of bad name attribute from the user's input.""" |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 338 | def parse(name): |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 339 | name = self.encodeXmlAttr(name) |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 340 | manifest = self.getXmlManifest(f""" |
| 341 | <manifest> |
| 342 | <remote name="default-remote" fetch="http://localhost" /> |
| 343 | <default remote="default-remote" revision="refs/heads/main" /> |
| 344 | <include name="{name}" /> |
| 345 | </manifest> |
| 346 | """) |
| 347 | # Force the manifest to be parsed. |
| 348 | manifest.ToXml() |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 349 | |
Mike Frysinger | 5413397 | 2021-03-01 21:38:08 -0500 | [diff] [blame] | 350 | # Setup target of the include. |
| 351 | target = os.path.join(self.tempdir, 'target.xml') |
| 352 | with open(target, 'w') as fp: |
| 353 | fp.write('<manifest></manifest>') |
| 354 | |
| 355 | # Include with absolute path. |
| 356 | parse(os.path.abspath(target)) |
| 357 | |
| 358 | # Include with relative path. |
| 359 | parse(os.path.relpath(target, self.manifest_dir)) |
| 360 | |
| 361 | def test_bad_name_checks(self): |
| 362 | """Check handling of bad name attribute.""" |
| 363 | def parse(name): |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 364 | name = self.encodeXmlAttr(name) |
Mike Frysinger | 5413397 | 2021-03-01 21:38:08 -0500 | [diff] [blame] | 365 | # Setup target of the include. |
| 366 | with open(os.path.join(self.manifest_dir, 'target.xml'), 'w') as fp: |
| 367 | fp.write(f'<manifest><include name="{name}"/></manifest>') |
| 368 | |
| 369 | manifest = self.getXmlManifest(""" |
| 370 | <manifest> |
| 371 | <remote name="default-remote" fetch="http://localhost" /> |
| 372 | <default remote="default-remote" revision="refs/heads/main" /> |
| 373 | <include name="target.xml" /> |
| 374 | </manifest> |
| 375 | """) |
| 376 | # Force the manifest to be parsed. |
| 377 | manifest.ToXml() |
| 378 | |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 379 | # Handle empty name explicitly because a different codepath rejects it. |
| 380 | with self.assertRaises(error.ManifestParseError): |
| 381 | parse('') |
| 382 | |
| 383 | for path in INVALID_FS_PATHS: |
| 384 | if not path: |
| 385 | continue |
| 386 | |
| 387 | with self.assertRaises(error.ManifestInvalidPathError): |
| 388 | parse(path) |
| 389 | |
| 390 | |
| 391 | class ProjectElementTests(ManifestParseTestCase): |
| 392 | """Tests for <project>.""" |
| 393 | |
| 394 | def test_group(self): |
| 395 | """Check project group settings.""" |
| 396 | manifest = self.getXmlManifest(""" |
| 397 | <manifest> |
| 398 | <remote name="test-remote" fetch="http://localhost" /> |
| 399 | <default remote="test-remote" revision="refs/heads/main" /> |
| 400 | <project name="test-name" path="test-path"/> |
| 401 | <project name="extras" path="path" groups="g1,g2,g1"/> |
| 402 | </manifest> |
| 403 | """) |
| 404 | self.assertEqual(len(manifest.projects), 2) |
| 405 | # Ordering isn't guaranteed. |
| 406 | result = { |
| 407 | manifest.projects[0].name: manifest.projects[0].groups, |
| 408 | manifest.projects[1].name: manifest.projects[1].groups, |
| 409 | } |
| 410 | project = manifest.projects[0] |
| 411 | self.assertCountEqual( |
| 412 | result['test-name'], |
| 413 | ['name:test-name', 'all', 'path:test-path']) |
| 414 | self.assertCountEqual( |
| 415 | result['extras'], |
| 416 | ['g1', 'g2', 'g1', 'name:extras', 'all', 'path:path']) |
Raman Tenneti | 080877e | 2021-03-09 15:19:06 -0800 | [diff] [blame] | 417 | groupstr = 'default,platform-' + platform.system().lower() |
| 418 | self.assertEqual(groupstr, manifest.GetGroupsStr()) |
| 419 | groupstr = 'g1,g2,g1' |
| 420 | manifest.manifestProject.config.SetString('manifest.groups', groupstr) |
| 421 | self.assertEqual(groupstr, manifest.GetGroupsStr()) |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 422 | |
| 423 | def test_set_revision_id(self): |
| 424 | """Check setting of project's revisionId.""" |
| 425 | manifest = self.getXmlManifest(""" |
| 426 | <manifest> |
| 427 | <remote name="default-remote" fetch="http://localhost" /> |
| 428 | <default remote="default-remote" revision="refs/heads/main" /> |
| 429 | <project name="test-name"/> |
| 430 | </manifest> |
| 431 | """) |
| 432 | self.assertEqual(len(manifest.projects), 1) |
| 433 | project = manifest.projects[0] |
| 434 | project.SetRevisionId('ABCDEF') |
| 435 | self.assertEqual( |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 436 | sort_attributes(manifest.ToXml().toxml()), |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 437 | '<?xml version="1.0" ?><manifest>' |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 438 | '<remote fetch="http://localhost" name="default-remote"/>' |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 439 | '<default remote="default-remote" revision="refs/heads/main"/>' |
Xin Li | 0e776a5 | 2021-06-29 21:42:34 +0000 | [diff] [blame] | 440 | '<project name="test-name" revision="ABCDEF" upstream="refs/heads/main"/>' |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 441 | '</manifest>') |
| 442 | |
| 443 | def test_trailing_slash(self): |
| 444 | """Check handling of trailing slashes in attributes.""" |
| 445 | def parse(name, path): |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 446 | name = self.encodeXmlAttr(name) |
| 447 | path = self.encodeXmlAttr(path) |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 448 | return self.getXmlManifest(f""" |
| 449 | <manifest> |
| 450 | <remote name="default-remote" fetch="http://localhost" /> |
| 451 | <default remote="default-remote" revision="refs/heads/main" /> |
| 452 | <project name="{name}" path="{path}" /> |
| 453 | </manifest> |
| 454 | """) |
| 455 | |
| 456 | manifest = parse('a/path/', 'foo') |
| 457 | self.assertEqual(manifest.projects[0].gitdir, |
| 458 | os.path.join(self.tempdir, '.repo/projects/foo.git')) |
| 459 | self.assertEqual(manifest.projects[0].objdir, |
| 460 | os.path.join(self.tempdir, '.repo/project-objects/a/path.git')) |
| 461 | |
| 462 | manifest = parse('a/path', 'foo/') |
| 463 | self.assertEqual(manifest.projects[0].gitdir, |
| 464 | os.path.join(self.tempdir, '.repo/projects/foo.git')) |
| 465 | self.assertEqual(manifest.projects[0].objdir, |
| 466 | os.path.join(self.tempdir, '.repo/project-objects/a/path.git')) |
| 467 | |
Mike Frysinger | 0458faa | 2021-03-10 23:35:44 -0500 | [diff] [blame] | 468 | manifest = parse('a/path', 'foo//////') |
| 469 | self.assertEqual(manifest.projects[0].gitdir, |
| 470 | os.path.join(self.tempdir, '.repo/projects/foo.git')) |
| 471 | self.assertEqual(manifest.projects[0].objdir, |
| 472 | os.path.join(self.tempdir, '.repo/project-objects/a/path.git')) |
| 473 | |
| 474 | def test_toplevel_path(self): |
| 475 | """Check handling of path=. specially.""" |
| 476 | def parse(name, path): |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 477 | name = self.encodeXmlAttr(name) |
| 478 | path = self.encodeXmlAttr(path) |
Mike Frysinger | 0458faa | 2021-03-10 23:35:44 -0500 | [diff] [blame] | 479 | return self.getXmlManifest(f""" |
| 480 | <manifest> |
| 481 | <remote name="default-remote" fetch="http://localhost" /> |
| 482 | <default remote="default-remote" revision="refs/heads/main" /> |
| 483 | <project name="{name}" path="{path}" /> |
| 484 | </manifest> |
| 485 | """) |
| 486 | |
| 487 | for path in ('.', './', './/', './//'): |
| 488 | manifest = parse('server/path', path) |
| 489 | self.assertEqual(manifest.projects[0].gitdir, |
| 490 | os.path.join(self.tempdir, '.repo/projects/..git')) |
| 491 | |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 492 | def test_bad_path_name_checks(self): |
| 493 | """Check handling of bad path & name attributes.""" |
| 494 | def parse(name, path): |
Mike Frysinger | f69c7ee | 2021-04-29 23:15:31 -0400 | [diff] [blame] | 495 | name = self.encodeXmlAttr(name) |
| 496 | path = self.encodeXmlAttr(path) |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 497 | manifest = self.getXmlManifest(f""" |
| 498 | <manifest> |
| 499 | <remote name="default-remote" fetch="http://localhost" /> |
| 500 | <default remote="default-remote" revision="refs/heads/main" /> |
| 501 | <project name="{name}" path="{path}" /> |
| 502 | </manifest> |
| 503 | """) |
| 504 | # Force the manifest to be parsed. |
| 505 | manifest.ToXml() |
| 506 | |
| 507 | # Verify the parser is valid by default to avoid buggy tests below. |
| 508 | parse('ok', 'ok') |
| 509 | |
| 510 | # Handle empty name explicitly because a different codepath rejects it. |
| 511 | # Empty path is OK because it defaults to the name field. |
| 512 | with self.assertRaises(error.ManifestParseError): |
| 513 | parse('', 'ok') |
| 514 | |
| 515 | for path in INVALID_FS_PATHS: |
| 516 | if not path or path.endswith('/'): |
| 517 | continue |
| 518 | |
| 519 | with self.assertRaises(error.ManifestInvalidPathError): |
| 520 | parse(path, 'ok') |
Mike Frysinger | 0458faa | 2021-03-10 23:35:44 -0500 | [diff] [blame] | 521 | |
| 522 | # We have a dedicated test for path=".". |
| 523 | if path not in {'.'}: |
| 524 | with self.assertRaises(error.ManifestInvalidPathError): |
| 525 | parse('ok', path) |
Mike Frysinger | a29424e | 2021-02-25 21:53:49 -0500 | [diff] [blame] | 526 | |
| 527 | |
| 528 | class SuperProjectElementTests(ManifestParseTestCase): |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 529 | """Tests for <superproject>.""" |
| 530 | |
| 531 | def test_superproject(self): |
| 532 | """Check superproject settings.""" |
| 533 | manifest = self.getXmlManifest(""" |
| 534 | <manifest> |
| 535 | <remote name="test-remote" fetch="http://localhost" /> |
| 536 | <default remote="test-remote" revision="refs/heads/main" /> |
| 537 | <superproject name="superproject"/> |
| 538 | </manifest> |
| 539 | """) |
| 540 | self.assertEqual(manifest.superproject['name'], 'superproject') |
| 541 | self.assertEqual(manifest.superproject['remote'].name, 'test-remote') |
| 542 | self.assertEqual(manifest.superproject['remote'].url, 'http://localhost/superproject') |
| 543 | self.assertEqual( |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 544 | sort_attributes(manifest.ToXml().toxml()), |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 545 | '<?xml version="1.0" ?><manifest>' |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 546 | '<remote fetch="http://localhost" name="test-remote"/>' |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 547 | '<default remote="test-remote" revision="refs/heads/main"/>' |
| 548 | '<superproject name="superproject"/>' |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 549 | '</manifest>') |
| 550 | |
| 551 | def test_remote(self): |
| 552 | """Check superproject settings with a remote.""" |
| 553 | manifest = self.getXmlManifest(""" |
| 554 | <manifest> |
| 555 | <remote name="default-remote" fetch="http://localhost" /> |
| 556 | <remote name="superproject-remote" fetch="http://localhost" /> |
| 557 | <default remote="default-remote" revision="refs/heads/main" /> |
| 558 | <superproject name="platform/superproject" remote="superproject-remote"/> |
| 559 | </manifest> |
| 560 | """) |
| 561 | self.assertEqual(manifest.superproject['name'], 'platform/superproject') |
| 562 | self.assertEqual(manifest.superproject['remote'].name, 'superproject-remote') |
| 563 | self.assertEqual(manifest.superproject['remote'].url, 'http://localhost/platform/superproject') |
| 564 | self.assertEqual( |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 565 | sort_attributes(manifest.ToXml().toxml()), |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 566 | '<?xml version="1.0" ?><manifest>' |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 567 | '<remote fetch="http://localhost" name="default-remote"/>' |
| 568 | '<remote fetch="http://localhost" name="superproject-remote"/>' |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 569 | '<default remote="default-remote" revision="refs/heads/main"/>' |
| 570 | '<superproject name="platform/superproject" remote="superproject-remote"/>' |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 571 | '</manifest>') |
| 572 | |
| 573 | def test_defalut_remote(self): |
| 574 | """Check superproject settings with a default remote.""" |
| 575 | manifest = self.getXmlManifest(""" |
| 576 | <manifest> |
| 577 | <remote name="default-remote" fetch="http://localhost" /> |
| 578 | <default remote="default-remote" revision="refs/heads/main" /> |
| 579 | <superproject name="superproject" remote="default-remote"/> |
| 580 | </manifest> |
| 581 | """) |
| 582 | self.assertEqual(manifest.superproject['name'], 'superproject') |
| 583 | self.assertEqual(manifest.superproject['remote'].name, 'default-remote') |
| 584 | self.assertEqual( |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 585 | sort_attributes(manifest.ToXml().toxml()), |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 586 | '<?xml version="1.0" ?><manifest>' |
Peter Kjellerstedt | 5d58c18 | 2021-04-12 21:16:36 +0200 | [diff] [blame] | 587 | '<remote fetch="http://localhost" name="default-remote"/>' |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 588 | '<default remote="default-remote" revision="refs/heads/main"/>' |
| 589 | '<superproject name="superproject"/>' |
Mike Frysinger | 37ac3d6 | 2021-02-25 04:54:56 -0500 | [diff] [blame] | 590 | '</manifest>') |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 591 | |
| 592 | |
| 593 | class ContactinfoElementTests(ManifestParseTestCase): |
| 594 | """Tests for <contactinfo>.""" |
| 595 | |
| 596 | def test_contactinfo(self): |
| 597 | """Check contactinfo settings.""" |
| 598 | bugurl = 'http://localhost/contactinfo' |
| 599 | manifest = self.getXmlManifest(f""" |
| 600 | <manifest> |
| 601 | <contactinfo bugurl="{bugurl}"/> |
| 602 | </manifest> |
| 603 | """) |
Raman Tenneti | 993af5e | 2021-05-12 12:00:31 -0700 | [diff] [blame] | 604 | self.assertEqual(manifest.contactinfo.bugurl, bugurl) |
Raman Tenneti | 1c3f57e | 2021-05-04 12:32:13 -0700 | [diff] [blame] | 605 | self.assertEqual( |
| 606 | manifest.ToXml().toxml(), |
Raman Tenneti | 2f8fdbe | 2021-05-04 18:54:52 -0700 | [diff] [blame] | 607 | '<?xml version="1.0" ?><manifest>' |
| 608 | f'<contactinfo bugurl="{bugurl}"/>' |
| 609 | '</manifest>') |
Jack Neus | 5ba2120 | 2021-06-09 15:21:25 +0000 | [diff] [blame] | 610 | |
| 611 | |
| 612 | class DefaultElementTests(ManifestParseTestCase): |
| 613 | """Tests for <default>.""" |
| 614 | |
| 615 | def test_default(self): |
| 616 | """Check default settings.""" |
| 617 | a = manifest_xml._Default() |
| 618 | a.revisionExpr = 'foo' |
| 619 | a.remote = manifest_xml._XmlRemote(name='remote') |
| 620 | b = manifest_xml._Default() |
| 621 | b.revisionExpr = 'bar' |
| 622 | self.assertEqual(a, a) |
| 623 | self.assertNotEqual(a, b) |
| 624 | self.assertNotEqual(b, a.remote) |
| 625 | self.assertNotEqual(a, 123) |
| 626 | self.assertNotEqual(a, None) |
| 627 | |
| 628 | |
| 629 | class RemoteElementTests(ManifestParseTestCase): |
| 630 | """Tests for <remote>.""" |
| 631 | |
| 632 | def test_remote(self): |
| 633 | """Check remote settings.""" |
| 634 | a = manifest_xml._XmlRemote(name='foo') |
| 635 | b = manifest_xml._XmlRemote(name='bar') |
| 636 | self.assertEqual(a, a) |
| 637 | self.assertNotEqual(a, b) |
| 638 | self.assertNotEqual(a, manifest_xml._Default()) |
| 639 | self.assertNotEqual(a, 123) |
| 640 | self.assertNotEqual(a, None) |
Michael Kelly | 06da998 | 2021-06-30 01:58:28 -0700 | [diff] [blame^] | 641 | |
| 642 | |
| 643 | class RemoveProjectElementTests(ManifestParseTestCase): |
| 644 | """Tests for <remove-project>.""" |
| 645 | |
| 646 | def test_remove_one_project(self): |
| 647 | manifest = self.getXmlManifest(""" |
| 648 | <manifest> |
| 649 | <remote name="default-remote" fetch="http://localhost" /> |
| 650 | <default remote="default-remote" revision="refs/heads/main" /> |
| 651 | <project name="myproject" /> |
| 652 | <remove-project name="myproject" /> |
| 653 | </manifest> |
| 654 | """) |
| 655 | self.assertEqual(manifest.projects, []) |
| 656 | |
| 657 | def test_remove_one_project_one_remains(self): |
| 658 | manifest = self.getXmlManifest(""" |
| 659 | <manifest> |
| 660 | <remote name="default-remote" fetch="http://localhost" /> |
| 661 | <default remote="default-remote" revision="refs/heads/main" /> |
| 662 | <project name="myproject" /> |
| 663 | <project name="yourproject" /> |
| 664 | <remove-project name="myproject" /> |
| 665 | </manifest> |
| 666 | """) |
| 667 | |
| 668 | self.assertEqual(len(manifest.projects), 1) |
| 669 | self.assertEqual(manifest.projects[0].name, 'yourproject') |
| 670 | |
| 671 | def test_remove_one_project_doesnt_exist(self): |
| 672 | with self.assertRaises(manifest_xml.ManifestParseError): |
| 673 | manifest = self.getXmlManifest(""" |
| 674 | <manifest> |
| 675 | <remote name="default-remote" fetch="http://localhost" /> |
| 676 | <default remote="default-remote" revision="refs/heads/main" /> |
| 677 | <remove-project name="myproject" /> |
| 678 | </manifest> |
| 679 | """) |
| 680 | manifest.projects |
| 681 | |
| 682 | def test_remove_one_optional_project_doesnt_exist(self): |
| 683 | manifest = self.getXmlManifest(""" |
| 684 | <manifest> |
| 685 | <remote name="default-remote" fetch="http://localhost" /> |
| 686 | <default remote="default-remote" revision="refs/heads/main" /> |
| 687 | <remove-project name="myproject" optional="true" /> |
| 688 | </manifest> |
| 689 | """) |
| 690 | self.assertEqual(manifest.projects, []) |