1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import gzip
import json
import logging
import os
import os.path
import pprint
import re
import shutil
import sys
import tempfile
import time
import urllib.parse
from copy import deepcopy
from pathlib import Path
from statistics import median
# ruff linter deprecates Dict, List, Tuple required for Python 3.8 compatibility
from typing import Any, Callable, Dict, List, Literal, Tuple, Union, cast # noqa UP035
from xmlrpc.client import Fault
import bugzilla
import mozci.data
import requests
from bugzilla.bug import Bug
from failedplatform import FailedPlatform
from manifestparser import ManifestParser
from manifestparser.toml import (
add_skip_if,
alphabetize_toml_str,
sort_paths,
)
from mozci.push import Push
from mozci.task import Optional, TestTask
from mozci.util.taskcluster import get_task
from mozinfo.platforminfo import PlatformInfo
from taskcluster.exceptions import TaskclusterRestFailure
from wpt_path_utils import (
WPT_META0,
WPT_META0_CLASSIC,
parse_wpt_path,
)
from yaml import load
# Use faster LibYAML, if installed: https://pyyaml.org/wiki/PyYAMLDocumentation
try:
from yaml import CLoader as Loader
except ImportError:
from yaml import Loader
ArtifactList = List[Dict[Literal["name"], str]]
CreateBug = Optional[Callable[[], Bug]]
Extras = Dict[str, PlatformInfo]
FailedPlatforms = Dict[str, FailedPlatform]
GenBugComment = Tuple[CreateBug, str, bool, dict, str]
JSONType = Union[
None,
bool,
int,
float,
str,
List["JSONType"],
Dict[str, "JSONType"],
]
ListBug = List[Bug]
ListInt = List[int]
ListStr = List[str]
ManifestPaths = Dict[str, Dict[str, List[str]]]
OptBug = Optional[Bug]
OptDifferences = Optional[List[int]]
OptInt = Optional[int]
OptJs = Optional[Dict[str, bool]]
OptPlatformInfo = Optional[PlatformInfo]
OptStr = Optional[str]
OptTaskResult = Optional[Dict[str, Any]]
PlatformPermutations = Dict[
str, # Manifest
Dict[
str, # OS
Dict[
str, # OS Version
Dict[
str, # Processor
Dict[
str, # Build type
Dict[
str, # Test Variant
Dict[str, int], # {'pass': x, 'fail': y}
],
],
],
],
],
]
Runs = Dict[str, Dict[str, Any]]
Suggestion = Tuple[OptInt, OptStr, OptStr]
TaskIdOrPlatformInfo = Union[str, PlatformInfo]
Tasks = List[TestTask]
WptPaths = Tuple[OptStr, OptStr, OptStr, OptStr]
TASK_LOG = "live_backing.log"
TASK_ARTIFACT = "public/logs/" + TASK_LOG
ATTACHMENT_DESCRIPTION = "Compressed " + TASK_ARTIFACT + " for task "
ATTACHMENT_REGEX = (
r".*Created attachment ([0-9]+)\n.*"
+ ATTACHMENT_DESCRIPTION
+ "([A-Za-z0-9_-]+)\n.*"
)
BUGZILLA_AUTHENTICATION_HELP = "Must create a Bugzilla API key per https://github.com/mozilla/mozci-tools/blob/main/citools/test_triage_bug_filer.py"
CACHE_EXPIRY = 45 # days to expire entries in .skip_fails_cache
CACHE_DIR = ".skip_fails_cache"
MS_PER_MINUTE = 60 * 1000 # ms per minute
DEBUG_THRESHOLD = 40 * MS_PER_MINUTE # 40 minutes in ms
OPT_THRESHOLD = 20 * MS_PER_MINUTE # 20 minutes in ms
ANYJS = "anyjs"
CC = "classification"
DEF = "DEFAULT"
DIFFERENCE = "difference"
DURATIONS = "durations"
EQEQ = "=="
ERROR = "error"
FAIL = "FAIL"
FAILED_RUNS = "runs_failed"
FAILURE_RATIO = 0.4 # more than this fraction of failures will disable
INTERMITTENT_RATIO_REFTEST = 0.4 # reftest low frequency intermittent
FAILURE_RATIO_REFTEST = 0.8 # disable ratio for reftest (high freq intermittent)
GROUP = "group"
KIND = "kind"
LINENO = "lineno"
LL = "label"
MEDIAN_DURATION = "duration_median"
MINIMUM_RUNS = 3 # mininum number of runs to consider success/failure
MOCK_BUG_DEFAULTS = {"blocks": [], "comments": []}
MOCK_TASK_DEFAULTS = {"extra": {}, "failure_types": {}, "results": []}
MOCK_TASK_INITS = ["results"]
MODIFIERS = "modifiers"
NOTEQ = "!="
OPT = "opt"
PASS = "PASS"
PIXELS = "pixels"
PP = "path"
QUERY = "query"
RR = "result"
RUNS = "runs"
STATUS = "status"
SUBTEST = "subtest"
SUBTEST_REGEX = (
r"image comparison, max difference: ([0-9]+), number of differing pixels: ([0-9]+)"
)
SUM_BY_LABEL = "sum_by_label"
TEST = "test"
TEST_TYPES = [EQEQ, NOTEQ]
TOTAL_DURATION = "duration_total"
TOTAL_RUNS = "runs_total"
class Mock:
def __init__(self, data, defaults={}, inits=[]):
self._data = data
self._defaults = defaults
for name in inits:
values = self._data.get(name, []) # assume type is an array
values = [Mock(value, defaults, inits) for value in values]
self._data[name] = values
def __getattr__(self, name):
if name in self._data:
return self._data[name]
if name in self._defaults:
return self._defaults[name]
return ""
class Classification:
"Classification of the failure (not the task result)"
DISABLE_INTERMITTENT = "disable_intermittent" # reftest [40%, 80%)
DISABLE_FAILURE = "disable_failure" # reftest (80%,100%] failure
DISABLE_MANIFEST = "disable_manifest" # crash found
DISABLE_RECOMMENDED = "disable_recommended" # disable first failing path
DISABLE_TOO_LONG = "disable_too_long" # runtime threshold exceeded
INTERMITTENT = "intermittent"
SECONDARY = "secondary" # secondary failing path
SUCCESS = "success" # path always succeeds
UNKNOWN = "unknown"
class Kind:
"Kind of manifest"
LIST = "list"
TOML = "toml"
UNKNOWN = "unknown"
WPT = "wpt"
class Skipfails:
"mach manifest skip-fails implementation: Update manifests to skip failing tests"
REPO = "repo"
REVISION = "revision"
TREEHERDER = "treeherder.mozilla.org"
BUGZILLA_DISABLE = "disable"
BUGZILLA_SERVER = "bugzilla.allizom.org"
BUGZILLA_SERVER_DEFAULT = BUGZILLA_DISABLE
def __init__(
self,
command_context=None,
try_url="",
verbose=True,
bugzilla=None,
dry_run=False,
turbo=False,
implicit_vars=False,
new_version=None,
task_id=None,
user_agent=None,
clear_cache=None,
):
self.command_context = command_context
if self.command_context is not None:
self.topsrcdir = self.command_context.topsrcdir
else:
self.topsrcdir = Path(__file__).parent.parent
self.topsrcdir = os.path.normpath(self.topsrcdir)
if isinstance(try_url, list) and len(try_url) == 1:
self.try_url = try_url[0]
else:
self.try_url = try_url
self.implicit_vars = implicit_vars
self.new_version = new_version
self.verbose = verbose
self.turbo = turbo
self.edit_bugzilla = True
if bugzilla is None:
if "BUGZILLA" in os.environ:
self.bugzilla = os.environ["BUGZILLA"]
else:
self.bugzilla = Skipfails.BUGZILLA_SERVER_DEFAULT
else:
self.bugzilla = bugzilla
if self.bugzilla == Skipfails.BUGZILLA_DISABLE:
self.bugzilla = None # Bug filing disabled
self.edit_bugzilla = False
self.dry_run = dry_run
if self.dry_run:
self.edit_bugzilla = False
self.component = "skip-fails"
self._bzapi = None
self._attach_rx = None
self.variants = {}
self.tasks = {}
self.pp = None
self.headers = {} # for Treeherder requests
self.headers["Accept"] = "application/json"
self.headers["User-Agent"] = "treeherder-pyclient"
self.jobs_url = "https://treeherder.mozilla.org/api/jobs/"
self.push_ids = {}
self.job_ids = {}
self.extras: Extras = {}
self.bugs = [] # preloaded bugs, currently not an updated cache
self.error_summary = {}
self._subtest_rx = None
self.lmp = None
self.failure_types = None
self.task_id: OptStr = task_id
self.failed_platforms: FailedPlatforms = {}
self.platform_permutations: PlatformPermutations = {}
self.user_agent: OptStr = user_agent
self.clear_cache: OptStr = clear_cache
self.check_cache()
def check_cache(self) -> None:
"""
Will ensure that the cache directory is present
And will clear any entries based upon --clear-cache
Or revisions older than 45 days
"""
cache_dir = self.full_path(CACHE_DIR)
if not os.path.exists(cache_dir):
self.vinfo(f"creating cache directory: {cache_dir}")
os.mkdir(cache_dir)
return
self.vinfo(f"clearing cache for revisions older than {CACHE_EXPIRY} days")
expiry: float = CACHE_EXPIRY * 24 * 3600
for rev_dir in [e.name for e in os.scandir(cache_dir) if e.is_dir()]:
rev_path = os.path.join(cache_dir, rev_dir)
if (
self.clear_cache is not None
and (self.clear_cache == rev_dir or self.clear_cache == "all")
) or self.file_age(rev_path) > expiry:
self.vinfo(f"clearing revision: {rev_path}")
self.delete_dir(rev_path)
def cached_path(self, revision: str, filename: str) -> str:
"""Return full path for a cached filename for revision"""
cache_dir = self.full_path(CACHE_DIR)
return os.path.join(cache_dir, revision, filename)
def record_new_bug(self, revision: str, bugid: int) -> None:
"""Records this bug id in the cache of created bugs for this revision"""
new_bugs_path = self.cached_path(revision, "new-bugs.json")
new_bugs: ListInt = []
if os.path.exists(new_bugs_path):
self.vinfo(f"Reading cached new bugs for revision: {revision}")
new_bugs = self.read_json(new_bugs_path)
if bugid not in new_bugs:
new_bugs.append(bugid)
new_bugs.sort()
self.write_json(new_bugs_path, new_bugs)
def _initialize_bzapi(self):
"""Lazily initializes the Bugzilla API (returns True on success)"""
if self._bzapi is None and self.bugzilla is not None:
self._bzapi = bugzilla.Bugzilla(self.bugzilla)
self._attach_rx = re.compile(ATTACHMENT_REGEX, flags=re.M)
return self._bzapi is not None
def pprint(self, obj):
if self.pp is None:
self.pp = pprint.PrettyPrinter(indent=4, stream=sys.stderr)
self.pp.pprint(obj)
sys.stderr.flush()
def error(self, e):
if self.command_context is not None:
self.command_context.log(
logging.ERROR, self.component, {ERROR: str(e)}, "ERROR: {error}"
)
else:
print(f"ERROR: {e}", file=sys.stderr, flush=True)
def warning(self, e):
if self.command_context is not None:
self.command_context.log(
logging.WARNING, self.component, {ERROR: str(e)}, "WARNING: {error}"
)
else:
print(f"WARNING: {e}", file=sys.stderr, flush=True)
def info(self, e):
if self.command_context is not None:
self.command_context.log(
logging.INFO, self.component, {ERROR: str(e)}, "INFO: {error}"
)
else:
print(f"INFO: {e}", file=sys.stderr, flush=True)
def vinfo(self, e):
if self.verbose:
self.info(e)
def full_path(self, filename):
"""Returns full path for the relative filename"""
return os.path.join(self.topsrcdir, os.path.normpath(filename.split(":")[-1]))
def isdir(self, filename):
"""Returns True if filename is a directory"""
return os.path.isdir(self.full_path(filename))
def exists(self, filename):
"""Returns True if filename exists"""
return os.path.exists(self.full_path(filename))
def file_age(self, path: str) -> float:
"""Returns age of filename in seconds"""
stat: os.stat_result = os.stat(path)
mtime: float = stat.st_mtime
now: float = time.time()
age: float = now - mtime
return age
def delete_dir(self, path: str) -> None:
"""Recursively deletes dir at path"""
abs_path: str = os.path.abspath(path)
# Safety: prevent root or empty deletions
if abs_path in ("", os.path.sep):
raise ValueError(f"Refusing to delete unsafe path: {path}")
# Ensure path is inside topsrcdir
if not abs_path.startswith(self.topsrcdir + os.path.sep):
raise ValueError(
f"Refusing to delete: {path} is not inside {self.topsrcdir}"
)
if not os.path.exists(abs_path):
raise FileNotFoundError(f"Path does not exist: {abs_path}")
if not os.path.isdir(abs_path):
raise NotADirectoryError(f"Not a directory: {abs_path}")
shutil.rmtree(abs_path)
def run(
self,
meta_bug_id: OptInt = None,
save_tasks: OptStr = None,
use_tasks: OptStr = None,
save_failures: OptStr = None,
use_failures: OptStr = None,
max_failures: int = -1,
carryover_mode: bool = False,
failure_ratio: float = FAILURE_RATIO,
):
"Run skip-fails on try_url, return True on success"
if self.new_version is not None:
self.vinfo(
f"All skip-if conditions will use the --new-version {self.new_version}"
)
if carryover_mode:
self.edit_bugzilla = False
self.vinfo(
"Carryover mode ON: only platform match conditions considered, no bugs created or updated"
)
if self.bugzilla is None:
self.vinfo("Bugzilla has been disabled: bugs not created or updated.")
elif self.dry_run:
self.vinfo("Mode --dry-run: bugs not created or updated.")
elif meta_bug_id is None:
self.edit_bugzilla = False
self.vinfo("No --meta-bug-id specified: bugs not created or updated.")
else:
self.vinfo(f"meta-bug-id: {meta_bug_id}")
try_url = self.try_url
revision, repo = self.get_revision(try_url)
use_tasks_cached = self.cached_path(revision, "tasks.json")
use_failures_cached = self.cached_path(revision, "failures.json")
if use_tasks is None and os.path.exists(use_tasks_cached):
use_tasks = use_tasks_cached
if save_tasks is None and use_tasks != use_tasks_cached:
save_tasks = use_tasks_cached
if use_failures is None and os.path.exists(use_failures_cached):
use_failures = use_failures_cached
if save_failures is None and use_failures != use_failures_cached:
save_failures = use_failures_cached
if use_tasks is not None:
tasks = self.read_tasks(use_tasks)
self.vinfo(f"use tasks: {use_tasks}")
self.failure_types = None # do NOT cache failure_types
else:
tasks = self.get_tasks(revision, repo)
if len(tasks) > 0 and self.task_id is not None:
tasks = [t for t in tasks if t.id == self.task_id]
self.failure_types = {} # cache failure_types
if use_failures is not None:
failures = self.read_failures(use_failures)
self.vinfo(f"use failures: {use_failures}")
else:
failures = self.get_failures(tasks, failure_ratio)
if save_failures is not None:
self.write_json(save_failures, failures)
self.vinfo(f"save failures: {save_failures}")
if save_tasks is not None:
self.write_tasks(save_tasks, tasks)
self.vinfo(f"save tasks: {save_tasks}")
num_failures = 0
self.vinfo(
f"skip-fails assumes implicit-vars for reftest: {self.implicit_vars}"
)
for manifest in failures:
kind = failures[manifest][KIND]
if carryover_mode and kind != Kind.TOML: # not yet supported
self.info(
f'Not editing {kind} manifest in --carryover mode: "{manifest}"'
)
continue
for label in failures[manifest][LL]:
for path in failures[manifest][LL][label][PP]:
classification = failures[manifest][LL][label][PP][path][CC]
if classification.startswith("disable_") or (
self.turbo and classification == Classification.SECONDARY
):
anyjs = {} # anyjs alternate basename = False
differences = []
pixels = []
status = FAIL
lineno = failures[manifest][LL][label][PP][path].get(LINENO, 0)
runs: Runs = failures[manifest][LL][label][PP][path][RUNS]
# skip_failure only needs to run against one task for each path
first_task_id = next(iter(runs))
for task_id in runs:
if kind == Kind.TOML:
break
elif kind == Kind.LIST:
difference = runs[task_id].get(DIFFERENCE, 0)
if difference > 0:
differences.append(difference)
pixel = runs[task_id].get(PIXELS, 0)
if pixel > 0:
pixels.append(pixel)
status = runs[task_id].get(STATUS, FAIL)
elif kind == Kind.WPT:
filename = os.path.basename(path)
anyjs[filename] = False
if QUERY in runs[task_id]:
query = runs[task_id][QUERY]
anyjs[filename + query] = False
else:
query = None
if ANYJS in runs[task_id]:
any_filename = os.path.basename(
runs[task_id][ANYJS]
)
anyjs[any_filename] = False
if query is not None:
anyjs[any_filename + query] = False
self.skip_failure(
manifest,
kind,
path,
first_task_id,
None,
None,
False,
anyjs,
differences,
pixels,
lineno,
status,
label,
classification,
try_url,
revision,
repo,
meta_bug_id,
carryover_mode,
)
num_failures += 1
if max_failures >= 0 and num_failures >= max_failures:
self.warning(
f"max_failures={max_failures} threshold reached: stopping."
)
return True
return True
def get_revision(self, url):
parsed = urllib.parse.urlparse(url)
if parsed.scheme != "https":
raise ValueError("try_url scheme not https")
if parsed.netloc != Skipfails.TREEHERDER:
raise ValueError(f"try_url server not {Skipfails.TREEHERDER}")
if len(parsed.query) == 0:
raise ValueError("try_url query missing")
query = urllib.parse.parse_qs(parsed.query)
if Skipfails.REVISION not in query:
raise ValueError("try_url query missing revision")
revision = query[Skipfails.REVISION][0]
if Skipfails.REPO in query:
repo = query[Skipfails.REPO][0]
else:
repo = "try"
self.vinfo(f"considering {repo} revision={revision}")
return revision, repo
def get_tasks(self, revision, repo):
push = Push(revision, repo)
tasks = None
try:
tasks = push.tasks
except requests.exceptions.HTTPError:
n = len(mozci.data.handler.sources)
self.error("Error querying mozci, sources are:")
tcs = -1
for i in range(n):
source = mozci.data.handler.sources[i]
self.error(f" sources[{i}] is type {source.__class__.__name__}")
if source.__class__.__name__ == "TreeherderClientSource":
tcs = i
if tcs < 0:
raise PermissionError("Error querying mozci with default User-Agent")
msg = f'Error querying mozci with User-Agent: {mozci.data.handler.sources[tcs].session.headers["User-Agent"]}'
if self.user_agent is None:
raise PermissionError(msg)
else:
self.error(msg)
self.error(f"Re-try with User-Agent: {self.user_agent}")
mozci.data.handler.sources[tcs].session.headers = {
"User-Agent": self.user_agent
}
tasks = push.tasks
return tasks
def get_kind_manifest(self, manifest: str):
kind = Kind.UNKNOWN
if manifest.endswith(".ini"):
self.warning(f"cannot analyze skip-fails on INI manifests: {manifest}")
return (None, None)
elif manifest.endswith(".list"):
kind = Kind.LIST
elif manifest.endswith(".toml"):
kind = Kind.TOML
else:
kind = Kind.WPT
path, wpt_manifest, _query, _anyjs = self.wpt_paths(manifest)
if path is None or wpt_manifest is None: # not WPT
self.warning(
f"cannot analyze skip-fails on unknown manifest type: {manifest}"
)
return (None, None)
manifest = wpt_manifest
return (kind, manifest)
def get_task_config(self, task: TestTask):
if task.label is None:
self.warning(f"Cannot find task label for task: {task.id}")
return None
# strip chunk number - this finds failures across different chunks
try:
parts = task.label.split("-")
int(parts[-1])
return "-".join(parts[:-1])
except ValueError:
return task.label
def get_failures(
self,
tasks: Tasks,
failure_ratio: float = FAILURE_RATIO,
):
"""
find failures and create structure comprised of runs by path:
result:
* False (failed)
* True (passed)
classification: Classification
* unknown (default) < 3 runs
* intermittent (not enough failures)
* disable_recommended (enough repeated failures) >3 runs >= 4
* disable_manifest (disable DEFAULT if no other failures)
* secondary (not first failure in group)
* success
"""
failures = {}
manifest_paths: ManifestPaths = {}
manifest_ = {
KIND: Kind.UNKNOWN,
LL: {},
}
label_ = {
DURATIONS: {},
MEDIAN_DURATION: 0,
OPT: False,
PP: {},
SUM_BY_LABEL: {}, # All sums implicitly zero
TOTAL_DURATION: 0,
}
path_ = {
CC: Classification.UNKNOWN,
FAILED_RUNS: 0,
RUNS: {},
TOTAL_RUNS: 0,
}
run_ = {
RR: False,
}
for task in tasks: # add explicit failures
config = self.get_task_config(task)
if config is None:
continue
try:
if len(task.results) == 0:
continue # ignore aborted tasks
_fail_types = task.failure_types # call magic property once
if _fail_types is None:
continue
if self.failure_types is None:
self.failure_types = {}
# This remove known failures
failure_types = {}
failing_groups = [r.group for r in task.results if not r.ok]
for ft in _fail_types:
failtype = ft
kind, manifest = self.get_kind_manifest(ft)
if kind == Kind.WPT:
failtype = parse_wpt_path(ft)[0]
if [fg for fg in failing_groups if fg.endswith(failtype)]:
failure_types[ft] = _fail_types[ft]
self.failure_types[task.id] = failure_types
self.vinfo(f"Getting failure_types from task: {task.id}")
for raw_manifest in failure_types:
kind, manifest = self.get_kind_manifest(raw_manifest)
if kind is None or manifest is None:
continue
if kind != Kind.WPT:
if manifest not in failures:
failures[manifest] = deepcopy(manifest_)
failures[manifest][KIND] = kind
if task.label not in failures[manifest][LL]:
failures[manifest][LL][task.label] = deepcopy(label_)
if manifest not in manifest_paths:
manifest_paths[manifest] = {}
if config not in manifest_paths[manifest]:
manifest_paths[manifest][config] = []
for path_type in failure_types[raw_manifest]:
path, _type = path_type
query = None
anyjs = None
allpaths = []
if kind == Kind.WPT:
path, mmpath, query, anyjs = self.wpt_paths(path)
if path is None or mmpath is None:
self.warning(
f"non existant failure path: {path_type[0]}"
)
break
allpaths = [path]
manifest = os.path.dirname(mmpath)
if manifest not in manifest_paths:
# this can be a subdir, or translated path
manifest_paths[manifest] = {}
if config not in manifest_paths[manifest]:
manifest_paths[manifest][config] = []
if manifest not in failures:
failures[manifest] = deepcopy(manifest_)
failures[manifest][KIND] = kind
if task.label not in failures[manifest][LL]:
failures[manifest][LL][task.label] = deepcopy(label_)
elif kind == Kind.LIST:
words = path.split()
if len(words) != 3 or words[1] not in TEST_TYPES:
self.warning(f"reftest type not supported: {path}")
continue
allpaths = self.get_allpaths(task.id, manifest, path)
elif kind == Kind.TOML:
if path == manifest:
path = DEF # refers to the manifest itself
allpaths = [path]
for path in allpaths:
if path not in manifest_paths[manifest].get(config, []):
manifest_paths[manifest][config].append(path)
self.vinfo(
f"Getting failure info in manifest: {manifest}, path: {path}"
)
task_path_object = failures[manifest][LL][task.label][PP]
if path not in task_path_object:
task_path_object[path] = deepcopy(path_)
task_path = task_path_object[path]
if task.id not in task_path[RUNS]:
task_path[RUNS][task.id] = deepcopy(run_)
else:
continue
result = task.result == "passed"
task_path[RUNS][task.id][RR] = result
if query is not None:
task_path[RUNS][task.id][QUERY] = query
if anyjs is not None:
task_path[RUNS][task.id][ANYJS] = anyjs
task_path[TOTAL_RUNS] += 1
if not result:
task_path[FAILED_RUNS] += 1
if kind == Kind.LIST:
(
lineno,
difference,
pixels,
status,
) = self.get_lineno_difference_pixels_status(
task.id, manifest, path
)
if lineno > 0:
task_path[LINENO] = lineno
else:
self.vinfo(f"ERROR no lineno for {path}")
if status != FAIL:
task_path[RUNS][task.id][STATUS] = status
if status == FAIL and difference == 0 and pixels == 0:
# intermittent, not error
task_path[RUNS][task.id][RR] = True
task_path[FAILED_RUNS] -= 1
elif difference > 0:
task_path[RUNS][task.id][DIFFERENCE] = difference
if pixels > 0:
task_path[RUNS][task.id][PIXELS] = pixels
except AttributeError:
pass # self.warning(f"unknown attribute in task (#1): {ae}")
for task in tasks: # add results
config = self.get_task_config(task)
if config is None:
continue
try:
if len(task.results) == 0:
continue # ignore aborted tasks
if self.failure_types is None:
continue
self.vinfo(f"Getting results from task: {task.id}")
for result in task.results:
kind, manifest = self.get_kind_manifest(result.group)
if kind is None or manifest is None:
continue
if manifest not in manifest_paths:
continue
if config not in manifest_paths[manifest]:
continue
if manifest not in failures:
failures[manifest] = deepcopy(manifest_)
task_label_object = failures[manifest][LL]
if task.label not in task_label_object:
task_label_object[task.label] = deepcopy(label_)
task_label = task_label_object[task.label]
if task.id not in task_label[DURATIONS]:
# duration may be None !!!
task_label[DURATIONS][task.id] = result.duration or 0
if task_label[OPT] is None:
task_label[OPT] = self.get_opt_for_task(task.id)
for path in manifest_paths[manifest][config]: # all known paths
# path can be one of any paths that have failed for the manifest/config
# ensure the path is in the specific task failure data
if path not in [
path
for path, type in self.failure_types.get(task.id, {}).get(
manifest, [("", "")]
)
]:
result.ok = True
task_path_object = task_label[PP]
if path not in task_path_object:
task_path_object[path] = deepcopy(path_)
task_path = task_path_object[path]
if task.id not in task_path[RUNS]:
task_path[RUNS][task.id] = deepcopy(run_)
task_path[RUNS][task.id][RR] = result.ok
task_path[TOTAL_RUNS] += 1
if not result.ok:
task_path[FAILED_RUNS] += 1
if kind == Kind.LIST:
(
lineno,
difference,
pixels,
status,
) = self.get_lineno_difference_pixels_status(
task.id, manifest, path
)
if lineno > 0:
task_path[LINENO] = lineno
else:
self.vinfo(f"ERROR no lineno for {path}")
if status != FAIL:
task_path[RUNS][task.id][STATUS] = status
if (
status == FAIL
and difference == 0
and pixels == 0
and not result.ok
):
# intermittent, not error
task_path[RUNS][task.id][RR] = True
task_path[FAILED_RUNS] -= 1
if difference > 0:
task_path[RUNS][task.id][DIFFERENCE] = difference
if pixels > 0:
task_path[RUNS][task.id][PIXELS] = pixels
except AttributeError:
pass # self.warning(f"unknown attribute in task (#2): {ae}")
for manifest in failures: # determine classifications
kind = failures[manifest][KIND]
for label in failures[manifest][LL]:
task_label = failures[manifest][LL][label]
opt = task_label[OPT]
durations = [] # summarize durations
try:
first_task_id: str = next(iter(task_label.get(DURATIONS, {})))
except StopIteration:
continue
for task_id in task_label.get(DURATIONS, {}):
duration = task_label[DURATIONS][task_id]
durations.append(duration)
if len(durations) > 0:
total_duration = sum(durations)
median_duration = median(durations)
task_label[TOTAL_DURATION] = total_duration
task_label[MEDIAN_DURATION] = median_duration
if (opt and median_duration > OPT_THRESHOLD) or (
(not opt) and median_duration > DEBUG_THRESHOLD
):
if kind == Kind.TOML:
paths = [DEF]
else:
paths = task_label[PP].keys()
for path in paths:
task_path_object = task_label[PP]
if path not in task_path_object:
task_path_object[path] = deepcopy(path_)
task_path = task_path_object[path]
if first_task_id not in task_path[RUNS]:
task_path[RUNS][first_task_id] = deepcopy(run_)
task_path[RUNS][first_task_id][RR] = False
task_path[TOTAL_RUNS] += 1
task_path[FAILED_RUNS] += 1
task_path[CC] = Classification.DISABLE_TOO_LONG
primary = True # we have not seen the first failure
for path in sort_paths(task_label[PP]):
task_path = task_label[PP][path]
classification = task_path[CC]
if classification == Classification.UNKNOWN:
failed_runs = task_path[FAILED_RUNS]
total_runs = task_path[TOTAL_RUNS]
status = FAIL # default status, only one run could be PASS
for first_task_id in task_path[RUNS]:
status = task_path[RUNS][first_task_id].get(STATUS, status)
if kind == Kind.LIST:
ratio = INTERMITTENT_RATIO_REFTEST
else:
ratio = failure_ratio
if total_runs >= MINIMUM_RUNS:
if failed_runs / total_runs < ratio:
if failed_runs == 0:
classification = Classification.SUCCESS
else:
classification = Classification.INTERMITTENT
elif kind == Kind.LIST:
if failed_runs / total_runs < FAILURE_RATIO_REFTEST:
classification = Classification.DISABLE_INTERMITTENT
else:
classification = Classification.DISABLE_FAILURE
elif primary:
if path == DEF:
classification = Classification.DISABLE_MANIFEST
else:
classification = Classification.DISABLE_RECOMMENDED
primary = False
else:
classification = Classification.SECONDARY
elif self.task_id is not None:
classification = Classification.DISABLE_RECOMMENDED
task_path[CC] = classification
if classification not in task_label[SUM_BY_LABEL]:
task_label[SUM_BY_LABEL][classification] = 0
task_label[SUM_BY_LABEL][classification] += 1
return failures
def get_bug_by_id(self, id) -> OptBug:
"""Get bug by bug id"""
bug: OptBug = None
for b in self.bugs:
if b.id == id:
bug = b
break
if bug is None and self._initialize_bzapi():
bug = self._bzapi.getbug(id)
return bug
def get_bugs_by_summary(self, summary, meta_bug_id: OptInt = None) -> ListBug:
"""Get bug by bug summary"""
bugs: ListBug = []
for b in self.bugs:
if b.summary == summary:
bugs.append(b)
if len(bugs) == 0 and self.bugzilla is not None and self._initialize_bzapi():
query = self._bzapi.build_query(short_desc=summary)
query["include_fields"] = [
"id",
"product",
"component",
"status",
"resolution",
"summary",
"blocks",
]
try:
bugs = self._bzapi.query(query)
except requests.exceptions.HTTPError:
raise
if len(bugs) > 0 and meta_bug_id is not None:
# narrow results to those blocking meta_bug_id
i = 0
while i < len(bugs):
if meta_bug_id not in bugs[i].blocks:
del bugs[i]
else:
i += 1
return bugs
def create_bug(
self,
summary: str = "Bug short description",
description: str = "Bug description",
product: str = "Testing",
component: str = "General",
version: str = "unspecified",
bugtype: str = "task",
revision: OptStr = None,
) -> OptBug:
"""Create a bug"""
bug: OptBug = None
if self._initialize_bzapi():
if not self._bzapi.logged_in:
self.error(
"Must create a Bugzilla API key per https://github.com/mozilla/mozci-tools/blob/main/citools/test_triage_bug_filer.py"
)
raise PermissionError(f"Not authenticated for Bugzilla {self.bugzilla}")
createinfo = self._bzapi.build_createbug(
product=product,
component=component,
summary=summary,
version=version,
description=description,
)
createinfo["type"] = bugtype
bug = self._bzapi.createbug(createinfo)
if bug is not None:
self.vinfo(f'Created Bug {bug.id} {product}::{component} : "{summary}"')
self.record_new_bug(revision, bug.id)
return bug
def add_bug_comment(self, id: int, comment: str, meta_bug_id: OptInt = None):
"""Add a comment to an existing bug"""
if self._initialize_bzapi():
if not self._bzapi.logged_in:
self.error(BUGZILLA_AUTHENTICATION_HELP)
raise PermissionError("Not authenticated for Bugzilla")
if meta_bug_id is not None:
blocks_add = [meta_bug_id]
else:
blocks_add = None
updateinfo = self._bzapi.build_update(
comment=comment, blocks_add=blocks_add
)
self._bzapi.update_bugs([id], updateinfo)
def generate_bugzilla_comment(
self,
manifest: str,
kind: str,
path: str,
skip_if: str,
filename: str,
anyjs: OptJs,
lineno: OptInt,
label: OptStr,
classification: OptStr,
task_id: OptStr,
try_url: OptStr,
revision: OptStr,
repo: OptStr,
meta_bug_id: OptInt = None,
) -> GenBugComment:
"""
Will create a comment for the failure details provided as arguments.
Will determine if a bug exists already for this manifest and meta-bug-id.
If exactly one bug is found, then set
bugid
meta_bug_blocked
attachments (to determine if the task log is in the attachments)
else
set bugid to TBD
if we should edit_bugzilla (not --dry-run) then we return a lambda function
to lazily create a bug later
Returns a tuple with
create_bug_lambda -- lambda function to create a bug (or None)
bugid -- id of bug found, or TBD
meta_bug_blocked -- True if bug found and meta_bug_id is already blocked
attachments -- dictionary of attachments if bug found
comment -- comment to add to the bug (if we should edit_bugzilla)
"""
create_bug_lambda: CreateBug = None
bugid: str = "TBD"
meta_bug_blocked: bool = False
attachments: dict = {}
comment: str = ""
if classification == Classification.DISABLE_MANIFEST:
comment = "Disabled entire manifest due to crash result"
elif classification == Classification.DISABLE_TOO_LONG:
comment = "Disabled entire manifest due to excessive run time"
else:
comment = f'Disabled test due to failures in test file: "{filename}"'
if classification == Classification.SECONDARY:
comment += " (secondary)"
if kind != Kind.LIST:
self.vinfo(f"filename: {filename}")
if kind == Kind.WPT and anyjs is not None and len(anyjs) > 1:
comment += "\nAdditional WPT wildcard paths:"
for p in sorted(anyjs.keys()):
if p != filename:
comment += f'\n "{p}"'
if label is not None:
platform, testname = self.label_to_platform_testname(label)
if platform is not None:
comment += "\nCommand line to reproduce (experimental):\n"
comment += f" \"mach try fuzzy -q '{platform}' {testname}\""
if try_url is not None:
comment += f"\nTry URL = {try_url}"
if revision is not None:
comment += f"\nrevision = {revision}"
if repo is not None:
comment += f"\nrepo = {repo}"
if label is not None:
comment += f"\nlabel = {label}"
if task_id is not None:
comment += f"\ntask_id = {task_id}"
if kind != Kind.LIST:
if revision is not None and repo is not None:
push_id = self.get_push_id(revision, repo)
if push_id is not None:
comment += f"\npush_id = {push_id}"
job_id = self.get_job_id(push_id, task_id)
if job_id is not None:
comment += f"\njob_id = {job_id}"
(
line_number,
line,
log_url,
) = self.get_bug_suggestions(
repo, revision, job_id, path, anyjs
)
if log_url is not None:
comment += f"\nSpecifically see at line {line_number} in the attached log: {log_url}"
comment += f'\n\n "{line}"\n'
bug_summary = f"MANIFEST {manifest}"
bugs = self.get_bugs_by_summary(bug_summary, meta_bug_id)
if len(bugs) == 0:
description = (
f"This bug covers excluded failing tests in the MANIFEST {manifest}"
)
description += "\n(generated by `mach manifest skip-fails`)"
product, component = self.get_file_info(path)
if self.edit_bugzilla:
create_bug_lambda = cast(
CreateBug,
lambda: self.create_bug(
bug_summary,
description,
product,
component,
"unspecified",
"task",
revision,
),
)
elif len(bugs) == 1:
bugid = str(bugs[0].id)
product = bugs[0].product
component = bugs[0].component
self.vinfo(f'Found Bug {bugid} {product}::{component} "{bug_summary}"')
if meta_bug_id is not None:
if meta_bug_id in bugs[0].blocks:
self.vinfo(f" Bug {bugid} already blocks meta bug {meta_bug_id}")
meta_bug_blocked = True
comments = bugs[0].getcomments()
for i in range(len(comments)):
text = comments[i]["text"]
attach_rx = self._attach_rx
if attach_rx is not None:
m = attach_rx.findall(text)
if len(m) == 1:
a_task_id = m[0][1]
attachments[a_task_id] = m[0][0]
if a_task_id == task_id:
self.vinfo(
f" Bug {bugid} already has the compressed log attached for this task"
)
elif meta_bug_id is None:
raise Exception(f'More than one bug found for summary: "{bug_summary}"')
else:
raise Exception(
f'More than one bug found for summary: "{bug_summary}" for meta-bug-id: {meta_bug_id}'
)
if kind == Kind.LIST:
comment += f"\nfuzzy-if condition on line {lineno}: {skip_if}"
else:
comment += f"\nskip-if condition: {skip_if}"
return (create_bug_lambda, bugid, meta_bug_blocked, attachments, comment)
def resolve_failure_filename(self, path: str, kind: str, manifest: str) -> str:
filename = DEF
if kind == Kind.TOML:
filename = self.get_filename_in_manifest(manifest.split(":")[-1], path)
elif kind == Kind.WPT:
filename = os.path.basename(path)
elif kind == Kind.LIST:
filename = [
am
for am in self.error_summary.get(manifest, "")
if self.error_summary[manifest][am]["test"].endswith(path)
]
if filename:
filename = filename[0]
else:
filename = path
return filename
def resolve_failure_manifest(self, path: str, kind: str, manifest: str) -> str:
if kind == Kind.WPT:
_path, resolved_manifest, _query, _anyjs = self.wpt_paths(path)
if resolved_manifest:
return resolved_manifest
raise Exception(f"Could not resolve WPT manifest for path {path}")
return manifest
def skip_failure(
self,
manifest: str,
kind: str,
path: str,
task_id: OptStr,
platform_info: OptPlatformInfo = None,
bug_id: OptStr = None,
high_freq: bool = False,
anyjs: OptJs = None,
differences: OptDifferences = None,
pixels: OptDifferences = None,
lineno: OptInt = None,
status: OptStr = None,
label: OptStr = None,
classification: OptStr = None,
try_url: OptStr = None,
revision: OptStr = None,
repo: OptStr = None,
meta_bug_id: OptInt = None,
carryover_mode: bool = False,
):
"""
Skip a failure (for TOML, WPT and REFTEST manifests)
For wpt anyjs is a dictionary mapping from alternate basename to
a boolean (indicating if the basename has been handled in the manifest)
"""
path: str = path.split(":")[-1]
self.vinfo(f"\n\n===== Skip failure in manifest: {manifest} =====")
self.vinfo(f" path: {path}")
skip_if: OptStr
if task_id is None:
skip_if = "true"
else:
skip_if = self.task_to_skip_if(
manifest,
platform_info if platform_info is not None else task_id,
kind,
path,
high_freq,
)
if skip_if is None:
self.info("Not adding skip-if condition")
return
filename: str = self.resolve_failure_filename(path, kind, manifest)
manifest: str = self.resolve_failure_manifest(path, kind, manifest)
manifest_path: str = self.full_path(manifest)
manifest_str: str = ""
additional_comment: str = ""
meta_bug_blocked: bool = False
create_bug_lambda: CreateBug = None
carryover = False # this failure is not carried over from a previous skip-if (Bug 1971610)
if bug_id is None:
create_bug_lambda, bugid, meta_bug_blocked, attachments, comment = (
self.generate_bugzilla_comment(
manifest,
kind,
path,
skip_if,
filename,
anyjs,
lineno,
label,
classification,
task_id,
try_url,
revision,
repo,
meta_bug_id,
)
)
bug_reference: str = f"Bug {bugid}"
if classification == Classification.SECONDARY and kind != Kind.WPT:
bug_reference += " (secondary)"
else:
bug_reference = f"Bug {bug_id}"
if kind == Kind.WPT:
if carryover_mode: # not yet supported for WPT
self.info(
f'Not editing in --carryover mode: ["{filename}"] in manifest: "{manifest}"'
)
return
if os.path.exists(manifest_path):
manifest_str = open(manifest_path, encoding="utf-8").read()
else:
# ensure parent directories exist
os.makedirs(os.path.dirname(manifest_path), exist_ok=True)
if bug_id is None and create_bug_lambda is not None:
bug = create_bug_lambda()
if bug is not None:
bug_reference = f"Bug {bug.id}"
manifest_str, additional_comment = self.wpt_add_skip_if(
manifest_str, anyjs, skip_if, bug_reference
)
elif kind == Kind.TOML:
mp = ManifestParser(use_toml=True, document=True)
try:
mp.read(manifest_path)
except OSError:
raise Exception(f"Unable to find path: {manifest_path}")
document = mp.source_documents[manifest_path]
try:
additional_comment, carryover = add_skip_if(
document,
filename,
skip_if,
bug_reference,
create_bug_lambda,
carryover_mode,
)
except Exception:
# Note: this fails to find a comment at the desired index
# Note: manifestparser len(skip_if) yields: TypeError: object of type 'bool' has no len()
additional_comment = ""
carryover = False
if carryover_mode and not carryover:
self.info(
f'No --carryover in: ["{filename}"] in manifest: "{manifest}"'
)
return
manifest_str = alphabetize_toml_str(document)
elif kind == Kind.LIST:
if carryover_mode: # not yet supported for LIST
self.info(
f'Not editing in --carryover mode: ["{filename}"] in manifest: "{manifest}"'
)
return
if lineno == 0:
self.error(
f"cannot determine line to edit in manifest: {manifest_path}"
)
elif not os.path.exists(manifest_path):
self.error(f"manifest does not exist: {manifest_path}")
else:
manifest_str = open(manifest_path, encoding="utf-8").read()
if status == PASS:
self.info(f"Unexpected status: {status}")
if (
status == PASS
or classification == Classification.DISABLE_INTERMITTENT
):
zero = True # refest lower ranges should include zero
else:
zero = False
if bug_id is None and create_bug_lambda is not None:
bug = create_bug_lambda()
if bug is not None:
bug_reference = f"Bug {bug.id}"
manifest_str, additional_comment = self.reftest_add_fuzzy_if(
manifest_str,
filename,
skip_if,
differences,
pixels,
lineno,
zero,
bug_reference,
)
if not manifest_str and additional_comment:
self.warning(additional_comment)
if additional_comment:
comment += "\n" + additional_comment
if manifest_str:
if self.dry_run:
prefix = "Would have (--dry-run): "
else:
prefix = ""
fp = open(manifest_path, "w", encoding="utf-8", newline="\n")
fp.write(manifest_str)
fp.close()
self.info(f'{prefix}Edited ["{filename}"] in manifest: "{manifest}"')
if kind != Kind.LIST:
self.info(
f'{prefix}Added{" CARRYOVER" if carryover else ""} skip-if condition: "{skip_if}"'
)
if bug_id is None:
if self.bugzilla is None:
self.vinfo(
f"Bugzilla has been disabled: comment not added to Bug {bugid}:\n{comment}"
)
elif meta_bug_id is None:
self.vinfo(
f"No --meta-bug-id specified: comment not added to Bug {bugid}:\n{comment}"
)
elif self.dry_run:
self.vinfo(
f"Mode --dry-run: comment not added to Bug {bugid}:\n{comment}"
)
elif not carryover:
self.add_bug_comment(
bugid, comment, None if meta_bug_blocked else meta_bug_id
)
self.info(f"Added comment to Bug {bugid}:\n{comment}")
if meta_bug_id is not None:
self.info(f" Bug {bugid} blocks meta Bug: {meta_bug_id}")
if task_id is not None and task_id not in attachments:
self.add_attachment_log_for_task(bugid, task_id)
self.info("Added compressed log for this task")
else:
self.error(f'Error editing ["{filename}"] in manifest: "{manifest}"')
def get_variants(self):
"""Get mozinfo for each test variants"""
if len(self.variants) == 0:
variants_file = "taskcluster/test_configs/variants.yml"
variants_path = self.full_path(variants_file)
fp = open(variants_path, encoding="utf-8")
raw_variants = load(fp, Loader=Loader)
fp.close()
for k, v in raw_variants.items():
mozinfo = k
if "mozinfo" in v:
mozinfo = v["mozinfo"]
self.variants[k] = mozinfo
return self.variants
def get_task_details(self, task_id):
"""Download details for task task_id"""
if task_id in self.tasks: # if cached
task = self.tasks[task_id]
else:
self.vinfo(f"get_task_details for task: {task_id}")
try:
task = get_task(task_id)
except TaskclusterRestFailure:
self.warning(f"Task {task_id} no longer exists.")
return None
self.tasks[task_id] = task
return task
def get_extra(self, task_id):
"""Calculate extra for task task_id"""
if task_id in self.extras: # if cached
platform_info = self.extras[task_id]
else:
self.get_variants()
task = self.get_task_details(task_id) or {}
test_setting = task.get("extra", {}).get("test-setting", {})
platform = test_setting.get("platform", {})
platform_os = platform.get("os", {})
if self.new_version:
platform_os["version"] = self.new_version
if not test_setting:
return None
platform_info = PlatformInfo(test_setting)
self.extras[task_id] = platform_info
return platform_info
def get_opt_for_task(self, task_id):
extra = self.get_extra(task_id)
return extra.opt
def _fetch_platform_permutations(self):
self.info("Fetching platform permutations...")
import taskcluster
url: OptStr = None
index = taskcluster.Index(
{
"rootUrl": "https://firefox-ci-tc.services.mozilla.com",
}
)
route = "gecko.v2.mozilla-central.latest.source.test-info-all"
queue = taskcluster.Queue(
{
"rootUrl": "https://firefox-ci-tc.services.mozilla.com",
}
)
# Typing from findTask is wrong, so we need to convert to Any
result: OptTaskResult = index.findTask(route)
if result is not None:
task_id: str = result["taskId"]
result = queue.listLatestArtifacts(task_id)
if result is not None and task_id is not None:
artifact_list: ArtifactList = result["artifacts"]
for artifact in artifact_list:
artifact_name = artifact["name"]
if artifact_name.endswith("test-info-testrun-matrix.json"):
url = queue.buildUrl(
"getLatestArtifact", task_id, artifact_name
)
break
if url is not None:
response = requests.get(url, headers={"User-agent": "mach-test-info/1.0"})
self.platform_permutations = response.json()
else:
self.info("Failed fetching platform permutations...")
def _get_list_skip_if(self, platform_info: PlatformInfo):
aa = "&&"
nn = "!"
os = platform_info.os
build_type = platform_info.build_type
runtimes = platform_info.test_variant
skip_if = None
if os == "linux":
skip_if = "gtkWidget"
elif os == "win":
skip_if = "winWidget"
elif os == "mac":
skip_if = "cocoaWidget"
elif os == "android":
skip_if = "Android"
else:
self.error(f"cannot calculate skip-if for unknown OS: '{os}'")
if skip_if is not None:
ccov = "ccov" in build_type
asan = "asan" in build_type
tsan = "tsan" in build_type
optimized = (
(not platform_info.debug) and (not ccov) and (not asan) and (not tsan)
)
skip_if += aa
if optimized:
skip_if += "optimized"
elif platform_info.debug:
skip_if += "isDebugBuild"
elif ccov:
skip_if += "isCoverageBuild"
elif asan:
skip_if += "AddressSanitizer"
elif tsan:
skip_if += "ThreadSanitizer"
# See implicit VARIANT_DEFAULTS in
# https://searchfox.org/mozilla-central/source/layout/tools/reftest/manifest.sys.mjs#30
fission = "no-fission" not in runtimes
snapshot = "snapshot" in runtimes
swgl = "swgl" in runtimes
nogpu = "nogpu" in runtimes
if not self.implicit_vars and fission:
skip_if += aa + "fission"
elif not fission: # implicit default: fission
skip_if += aa + nn + "fission"
if platform_info.bits is not None:
if platform_info.bits == "32":
skip_if += aa + nn + "is64Bit" # override implicit is64Bit
elif not self.implicit_vars and os == "winWidget":
skip_if += aa + "is64Bit"
if not self.implicit_vars and not swgl:
skip_if += aa + nn + "swgl"
elif swgl: # implicit default: !swgl
skip_if += aa + "swgl"
if not self.implicit_vars and not nogpu:
skip_if += aa + nn + "nogpu"
elif nogpu: # implicit default: !swgl
skip_if += aa + "nogpu"
if os == "gtkWidget":
if not self.implicit_vars and not snapshot:
skip_if += aa + nn + "useDrawSnapshot"
elif snapshot: # implicit default: !useDrawSnapshot
skip_if += aa + "useDrawSnapshot"
return skip_if
def task_to_skip_if(
self,
manifest: str,
task: TaskIdOrPlatformInfo,
kind: str,
file_path: str,
high_freq: bool,
) -> OptStr:
"""Calculate the skip-if condition for failing task task_id"""
if isinstance(task, str):
self.info(f"Fetching task data for {task}")
extra = self.get_extra(task)
else:
extra = task
if kind == Kind.WPT:
qq = '"'
aa = " and "
else:
qq = "'"
aa = " && "
eq = " == "
skip_if = None
os = extra.os
os_version = extra.os_version
if os is not None:
if kind == Kind.LIST:
skip_if = self._get_list_skip_if(extra)
else:
skip_if = "os" + eq + qq + os + qq
if os_version is not None:
skip_if += aa + "os_version" + eq + qq + os_version + qq
arch = extra.arch
if arch is not None and skip_if is not None and kind != Kind.LIST:
skip_if += aa + "arch" + eq + qq + arch + qq
failure_key = os + os_version + arch + manifest + file_path
if self.failed_platforms.get(failure_key) is None:
if not self.platform_permutations:
self._fetch_platform_permutations()
permutations = (
self.platform_permutations.get(manifest, {})
.get(os, {})
.get(os_version, {})
.get(arch, None)
)
self.failed_platforms[failure_key] = FailedPlatform(
permutations, high_freq
)
build_types = extra.build_type
skip_cond = self.failed_platforms[failure_key].get_skip_string(
aa, build_types, extra.test_variant
)
if skip_cond is not None:
if kind == Kind.WPT:
# ensure ! -> 'not', primarily fission and e10s
skip_cond = skip_cond.replace("!", "not ")
skip_if += skip_cond
else:
skip_if = None
elif skip_if is None:
raise Exception(
f"Unable to calculate skip-if condition from manifest={manifest} and file={file_path}"
)
return skip_if
def get_file_info(self, path, product="Testing", component="General"):
"""
Get bugzilla product and component for the path.
Provide defaults (in case command_context is not defined
or there isn't file info available).
"""
if path != DEF and self.command_context is not None:
reader = self.command_context.mozbuild_reader(config_mode="empty")
info = reader.files_info([path])
try:
cp = info[path]["BUG_COMPONENT"]
except TypeError:
# TypeError: BugzillaComponent.__new__() missing 2 required positional arguments: 'product' and 'component'
pass
else:
product = cp.product
component = cp.component
return product, component
def get_filename_in_manifest(self, manifest: str, path: str) -> str:
"""return relative filename for path in manifest"""
filename = os.path.basename(path)
if filename == DEF:
return filename
manifest_dir = os.path.dirname(manifest)
i = 0
j = min(len(manifest_dir), len(path))
while i < j and manifest_dir[i] == path[i]:
i += 1
if i < len(manifest_dir):
for _ in range(manifest_dir.count("/", i) + 1):
filename = "../" + filename
elif i < len(path):
filename = path[i + 1 :]
return filename
def get_push_id(self, revision: str, repo: str):
"""Return the push_id for revision and repo (or None)"""
self.vinfo(f"Retrieving push_id for {repo} revision: {revision} ...")
if revision in self.push_ids: # if cached
push_id = self.push_ids[revision]
else:
push_id = None
push_url = f"https://treeherder.mozilla.org/api/project/{repo}/push/"
params = {}
params["full"] = "true"
params["count"] = 10
params["revision"] = revision
r = requests.get(push_url, headers=self.headers, params=params)
if r.status_code != 200:
self.warning(f"FAILED to query Treeherder = {r} for {r.url}")
else:
response = r.json()
if "results" in response:
results = response["results"]
if len(results) > 0:
r0 = results[0]
if "id" in r0:
push_id = r0["id"]
self.push_ids[revision] = push_id
return push_id
def get_job_id(self, push_id, task_id):
"""Return the job_id for push_id, task_id (or None)"""
self.vinfo(f"Retrieving job_id for push_id: {push_id}, task_id: {task_id} ...")
k = f"{push_id}:{task_id}"
if k in self.job_ids: # if cached
job_id = self.job_ids[k]
else:
job_id = None
params = {}
params["push_id"] = push_id
r = requests.get(self.jobs_url, headers=self.headers, params=params)
if r.status_code != 200:
self.warning(f"FAILED to query Treeherder = {r} for {r.url}")
else:
response = r.json()
if "results" in response:
results = response["results"]
if len(results) > 0:
for result in results:
if len(result) > 14:
if result[14] == task_id:
job_id = result[1]
break
self.job_ids[k] = job_id
return job_id
def cached_bug_suggestions(self, repo, revision, job_id) -> JSONType:
"""
Return the bug_suggestions JSON for the job_id
Use the cache, if present, else download from treeherder
"""
suggestions_path = self.cached_path(revision, f"suggest-{job_id}.json")
if os.path.exists(suggestions_path):
self.vinfo(
f"Reading cached bug_suggestions for {repo} revision: {revision} job_id: {job_id}"
)
suggestions = self.read_json(suggestions_path)
else:
suggestions_url = f"https://treeherder.mozilla.org/api/project/{repo}/jobs/{job_id}/bug_suggestions/"
self.vinfo(
f"Retrieving bug_suggestions for {repo} revision: {revision} job_id: {job_id}"
)
r = requests.get(suggestions_url, headers=self.headers)
if r.status_code != 200:
self.warning(f"FAILED to query Treeherder = {r} for {r.url}")
return None
suggestions = r.json()
self.write_json(suggestions_path, suggestions)
return suggestions
def get_bug_suggestions(
self, repo, revision, job_id, path, anyjs=None
) -> Suggestion:
"""
Return the (line_number, line, log_url)
for the given repo and job_id
"""
line_number: int = None
line: str = None
log_url: str = None
suggestions: JSONType = self.cached_bug_suggestions(repo, revision, job_id)
if suggestions is not None:
paths: ListStr = []
if anyjs is not None:
pathdir: str = os.path.dirname(path) + "/"
paths = [pathdir + f for f in anyjs.keys()]
else:
paths = [path]
if len(suggestions) > 0:
for sugg in suggestions:
for p in paths:
path_end = sugg.get("path_end", None)
# handles WPT short paths
if path_end is not None and p.endswith(path_end):
line_number = sugg["line_number"] + 1
line = sugg["search"]
log_url = f"https://treeherder.mozilla.org/logviewer?repo={repo}&job_id={job_id}&lineNumber={line_number}"
break
return (line_number, line, log_url)
def read_json(self, filename):
"""read data as JSON from filename"""
fp = open(filename, encoding="utf-8")
data = json.load(fp)
fp.close()
return data
def read_tasks(self, filename):
"""read tasks as JSON from filename"""
if not os.path.exists(filename):
msg = f"use-tasks JSON file does not exist: {filename}"
raise OSError(2, msg, filename)
tasks = self.read_json(filename)
tasks = [Mock(task, MOCK_TASK_DEFAULTS, MOCK_TASK_INITS) for task in tasks]
for task in tasks:
if len(task.extra) > 0: # pre-warm cache for extra information
platform_info = PlatformInfo()
extra: Any = task.extra
platform_info.from_dict(extra)
self.extras[task.id] = platform_info
return tasks
def read_failures(self, filename):
"""read failures as JSON from filename"""
if not os.path.exists(filename):
msg = f"use-failures JSON file does not exist: {filename}"
raise OSError(2, msg, filename)
failures = self.read_json(filename)
return failures
def read_bugs(self, filename):
"""read bugs as JSON from filename"""
if not os.path.exists(filename):
msg = f"bugs JSON file does not exist: {filename}"
raise OSError(2, msg, filename)
bugs = self.read_json(filename)
bugs = [Mock(bug, MOCK_BUG_DEFAULTS) for bug in bugs]
return bugs
def write_json(self, filename, data):
"""saves data as JSON to filename"""
# ensure that (at most ONE) parent dir exists
parent = os.path.dirname(filename)
grandparent = os.path.dirname(parent)
if not os.path.isdir(grandparent):
raise NotADirectoryError(
f"write_json: grand parent directory does not exist for: {filename}"
)
if not os.path.isdir(parent):
self.vinfo(f"write_json: creating parent directory for: {filename}")
os.mkdir(parent)
fp = open(filename, "w", encoding="utf-8")
json.dump(data, fp, indent=2, sort_keys=True)
fp.close()
def write_tasks(self, save_tasks, tasks):
"""saves tasks as JSON to save_tasks"""
jtasks = []
for task in tasks:
if not isinstance(task, TestTask):
continue
extras = self.get_extra(task.id)
if not extras:
continue
jtask = {}
jtask["id"] = task.id
jtask["label"] = task.label
jtask["duration"] = task.duration
jtask["result"] = task.result
jtask["state"] = task.state
jtask["extra"] = extras.to_dict()
jtags = {}
for k, v in task.tags.items():
if k == "createdForUser":
jtags[k] = "ci@mozilla.com"
else:
jtags[k] = v
jtask["tags"] = jtags
jtask["tier"] = task.tier
jtask["results"] = [
{"group": r.group, "ok": r.ok, "duration": r.duration}
for r in task.results
]
jtask["errors"] = None # Bug with task.errors property??
jft = {}
if self.failure_types is not None and task.id in self.failure_types:
failure_types = self.failure_types[task.id] # use cache
else:
try:
failure_types = task.failure_types
except requests.exceptions.HTTPError:
continue
except TaskclusterRestFailure:
continue
for k in failure_types:
jft[k] = [[f[0], f[1].value] for f in task.failure_types[k]]
jtask["failure_types"] = jft
jtasks.append(jtask)
self.write_json(save_tasks, jtasks)
def label_to_platform_testname(self, label: str):
"""convert from label to platform, testname for mach command line"""
platform = None
testname = None
platform_details = label.split("/")
if len(platform_details) == 2:
platform, details = platform_details
words = details.split("-")
if len(words) > 2:
platform += "/" + words.pop(0) # opt or debug
try:
_chunk = int(words[-1])
words.pop()
except ValueError:
pass
words.pop() # remove test suffix
testname = "-".join(words)
else:
platform = None
return platform, testname
def add_attachment_log_for_task(self, bugid: str, task_id: str):
"""Adds compressed log for this task to bugid"""
log_url = f"https://firefox-ci-tc.services.mozilla.com/api/queue/v1/task/{task_id}/artifacts/public/logs/live_backing.log"
r = requests.get(log_url, headers=self.headers)
if r.status_code != 200:
self.error(f"Unable to get log for task: {task_id}")
return
attach_fp = tempfile.NamedTemporaryFile()
fp = gzip.open(attach_fp, "wb")
fp.write(r.text.encode("utf-8"))
fp.close()
if self._initialize_bzapi():
description = ATTACHMENT_DESCRIPTION + task_id
file_name = TASK_LOG + ".gz"
comment = "Added compressed log"
content_type = "application/gzip"
try:
self._bzapi.attachfile(
[int(bugid)],
attach_fp.name,
description,
file_name=file_name,
comment=comment,
content_type=content_type,
is_private=False,
)
except Fault:
pass # Fault expected: Failed to fetch key 9372091 from network storage: The specified key does not exist.
def wpt_paths(self, shortpath: str) -> WptPaths:
"""
Analyzes the WPT short path for a test and returns
(path, manifest, query, anyjs) where
path is the relative path to the test file
manifest is the relative path to the file metadata
query is the test file query paramters (or None)
anyjs is the html test file as reported by mozci (or None)
"""
path, manifest, query, anyjs = parse_wpt_path(shortpath, self.isdir)
if manifest and manifest.startswith(WPT_META0):
manifest_classic = manifest.replace(WPT_META0, WPT_META0_CLASSIC, 1)
if self.exists(manifest_classic):
if self.exists(manifest):
self.warning(
f"Both classic {manifest_classic} and metadata {manifest} manifests exist"
)
else:
self.warning(
f"Using the classic {manifest_classic} manifest as the metadata manifest {manifest} does not exist"
)
manifest = manifest_classic
self.vinfo(f"wpt_paths::{path},{manifest}")
if path and not self.exists(path):
return (None, None, None, None)
return (path, manifest, query, anyjs)
def wpt_add_skip_if(self, manifest_str, anyjs, skip_if, bug_reference):
"""
Edits a WPT manifest string to add disabled condition
anyjs is a dictionary mapping from filename and any alternate basenames to
a boolean (indicating if the file has been handled in the manifest).
Returns additional_comment (if any)
"""
additional_comment = ""
disabled_key = False
disabled = " disabled:"
condition_start = " if "
condition = condition_start + skip_if + ": " + bug_reference
lines = manifest_str.splitlines()
section = None # name of the section
i = 0
n = len(lines)
while i < n:
line = lines[i]
if line.startswith("["):
if section is not None and not anyjs[section]: # not yet handled
if not disabled_key:
lines.insert(i, disabled)
i += 1
lines.insert(i, condition)
lines.insert(i + 1, "") # blank line after condition
i += 2
n += 2
anyjs[section] = True
section = line[1:-1]
if section and anyjs and section in anyjs and not anyjs[section]:
disabled_key = False
else:
section = None # ignore section we are not interested in
elif section is not None:
if line == disabled:
disabled_key = True
elif line.startswith(" ["):
if i > 0 and i - 1 < n and lines[i - 1] == "":
del lines[i - 1]
i -= 1
n -= 1
if not disabled_key:
lines.insert(i, disabled)
i += 1
n += 1
lines.insert(i, condition)
lines.insert(i + 1, "") # blank line after condition
i += 2
n += 2
anyjs[section] = True
section = None
elif line.startswith(" ") and not line.startswith(" "):
if disabled_key: # insert condition above new key
lines.insert(i, condition)
i += 1
n += 1
anyjs[section] = True
section = None
disabled_key = False
elif line.startswith(" "):
if disabled_key and line == condition:
anyjs[section] = True # condition already present
section = None
i += 1
if section is not None and not anyjs[section]: # not yet handled
if i > 0 and i - 1 < n and lines[i - 1] == "":
del lines[i - 1]
if not disabled_key:
lines.append(disabled)
i += 1
n += 1
lines.append(condition)
lines.append("") # blank line after condition
i += 2
n += 2
anyjs[section] = True
if anyjs:
for section in anyjs:
if not anyjs[section]:
if i > 0 and i - 1 < n and lines[i - 1] != "":
lines.append("") # blank line before condition
i += 1
n += 1
lines.append("[" + section + "]")
lines.append(disabled)
lines.append(condition)
lines.append("") # blank line after condition
i += 4
n += 4
manifest_str = "\n".join(lines) + "\n"
return manifest_str, additional_comment
def reftest_add_fuzzy_if(
self,
manifest_str,
filename,
fuzzy_if,
differences,
pixels,
lineno,
zero,
bug_reference,
):
"""
Edits a reftest manifest string to add disabled condition
"""
if self.lmp is None:
from parse_reftest import ListManifestParser
self.lmp = ListManifestParser(
self.implicit_vars, self.verbose, self.error, self.warning, self.info
)
manifest_str, additional_comment = self.lmp.reftest_add_fuzzy_if(
manifest_str,
filename,
fuzzy_if,
differences,
pixels,
lineno,
zero,
bug_reference,
)
return manifest_str, additional_comment
def get_lineno_difference_pixels_status(self, task_id, manifest, allmods):
"""
Returns
- lineno in manifest
- image comparison, max *difference*
- number of differing *pixels*
- status (PASS or FAIL)
as cached from reftest_errorsummary.log for a task
"""
manifest_obj = self.error_summary.get(manifest, {})
# allmods_obj: manifest_test_name: {test: allmods, error: ...}
allmods_obj = manifest_obj[
[am for am in manifest_obj if manifest_obj[am]["test"].endswith(allmods)][0]
]
lineno = allmods_obj.get(LINENO, 0)
runs_obj = allmods_obj.get(RUNS, {})
task_obj = runs_obj.get(task_id, {})
difference = task_obj.get(DIFFERENCE, 0)
pixels = task_obj.get(PIXELS, 0)
status = task_obj.get(STATUS, FAIL)
return lineno, difference, pixels, status
def reftest_find_lineno(self, manifest, modifiers, allmods):
"""
Return the line number with modifiers in manifest (else 0)
"""
lineno = 0
mods = []
prefs = []
for i in range(len(modifiers)):
if modifiers[i].find("pref(") >= 0 or modifiers[i].find("skip-if(") >= 0:
prefs.append(modifiers[i])
else:
mods.append(modifiers[i])
m = len(mods)
manifest_str = open(manifest, encoding="utf-8").read()
lines = manifest_str.splitlines()
defaults = []
found = False
alt_lineno = 0
for linenum in range(len(lines)):
line = lines[linenum]
if len(line) > 0 and line[0] == "#":
continue
comment_start = line.find(" #") # MUST NOT match anchors!
if comment_start > 0:
line = line[0:comment_start].strip()
words = line.split()
n = len(words)
if n > 1 and words[0] == "defaults":
defaults = words[1:].copy()
continue
line_defaults = defaults.copy()
i = 0
while i < n:
if words[i].find("pref(") >= 0 or words[i].find("skip-if(") >= 0:
line_defaults.append(words[i])
del words[i]
n -= 1
else:
i += 1
if (len(prefs) == 0 or prefs == line_defaults) and words == mods:
found = True
lineno = linenum + 1
break
elif m > 2 and n > 2:
if words[-3:] == mods[-3:]:
alt_lineno = linenum + 1
else:
bwords = [os.path.basename(f) for f in words[-2:]]
bmods = [os.path.basename(f) for f in mods[-2:]]
if bwords == bmods:
alt_lineno = linenum + 1
if not found:
if alt_lineno > 0:
lineno = alt_lineno
self.warning(
f"manifest '{manifest}' found lineno: {lineno}, but it does not contain all the prefs from modifiers,\nSEARCH: {allmods}\nFOUND : {lines[alt_lineno - 1]}"
)
else:
lineno = 0
self.error(
f"manifest '{manifest}' does not contain line with modifiers: {allmods}"
)
return lineno
def get_allpaths(self, task_id, manifest, path):
"""
Looks up the reftest_errorsummary.log for a task
and caches the details in self.error_summary by
task_id, manifest, allmods
where allmods is the concatenation of all modifiers
and the details include
- image comparison, max *difference*
- number of differing *pixels*
- status: unexpected PASS or FAIL
The list iof unique modifiers (allmods) for the given path are returned
"""
allpaths = []
words = path.split()
if len(words) != 3 or words[1] not in TEST_TYPES:
self.warning(
f"reftest_errorsummary.log for task: {task_id} has unsupported test type '{path}'"
)
return allpaths
if manifest in self.error_summary:
for allmods in self.error_summary[manifest]:
if self.error_summary[manifest][allmods][
TEST
] == path and task_id in self.error_summary[manifest][allmods].get(
RUNS, {}
):
allpaths.append(path)
if len(allpaths) > 0:
return allpaths # cached (including self tests)
error_url = f"https://firefox-ci-tc.services.mozilla.com/api/queue/v1/task/{task_id}/artifacts/public/test_info/reftest_errorsummary.log"
self.vinfo(f"Requesting reftest_errorsummary.log for task: {task_id}")
r = requests.get(error_url, headers=self.headers)
if r.status_code != 200:
self.error(f"Unable to get reftest_errorsummary.log for task: {task_id}")
return allpaths
for line in r.text.encode("utf-8").splitlines():
summary = json.loads(line)
group = summary.get(GROUP, "")
if not group or not os.path.exists(group): # not error line
continue
test = summary.get(TEST, None)
if test is None:
continue
if not MODIFIERS in summary:
self.warning(
f"reftest_errorsummary.log for task: {task_id} does not have modifiers for '{test}'"
)
continue
words = test.split()
if len(words) != 3 or words[1] not in TEST_TYPES:
self.warning(
f"reftest_errorsummary.log for task: {task_id} has unsupported test '{test}'"
)
continue
status = summary.get(STATUS, "")
if status not in [FAIL, PASS]:
self.warning(
f"reftest_errorsummary.log for task: {task_id} has unknown status: {status} for '{test}'"
)
continue
error = summary.get(SUBTEST, "")
mods = summary[MODIFIERS]
allmods = " ".join(mods)
if group not in self.error_summary:
self.error_summary[group] = {}
if allmods not in self.error_summary[group]:
self.error_summary[group][allmods] = {}
self.error_summary[group][allmods][TEST] = test
lineno = self.error_summary[group][allmods].get(LINENO, 0)
if lineno == 0:
lineno = self.reftest_find_lineno(group, mods, allmods)
if lineno > 0:
self.error_summary[group][allmods][LINENO] = lineno
if RUNS not in self.error_summary[group][allmods]:
self.error_summary[group][allmods][RUNS] = {}
if task_id not in self.error_summary[group][allmods][RUNS]:
self.error_summary[group][allmods][RUNS][task_id] = {}
self.error_summary[group][allmods][RUNS][task_id][ERROR] = error
if self._subtest_rx is None:
self._subtest_rx = re.compile(SUBTEST_REGEX)
m = self._subtest_rx.findall(error)
if len(m) == 1:
difference = int(m[0][0])
pixels = int(m[0][1])
else:
difference = 0
pixels = 0
if difference > 0:
self.error_summary[group][allmods][RUNS][task_id][
DIFFERENCE
] = difference
if pixels > 0:
self.error_summary[group][allmods][RUNS][task_id][PIXELS] = pixels
if status != FAIL:
self.error_summary[group][allmods][RUNS][task_id][STATUS] = status
if test == path:
allpaths.append(test)
return allpaths
|