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
|
// Copyright 2018 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Test wrapper implementation for Windows.
// Design:
// https://github.com/laszlocsomor/proposals/blob/win-test-runner/designs/2018-07-18-windows-native-test-runner.md
#include "tools/test/windows/tw.h"
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
#include <errno.h>
#include <limits.h> // INT_MAX
#include <lmcons.h> // UNLEN
#include <string.h>
#include <sys/types.h>
#include <wchar.h>
#include <algorithm>
#include <cstdio>
#include <fstream>
#include <functional>
#include <iomanip>
#include <memory>
#include <sstream>
#include <string>
#include <vector>
#include "src/main/cpp/util/file_platform.h"
#include "src/main/cpp/util/path_platform.h"
#include "src/main/cpp/util/strings.h"
#include "src/main/native/windows/file.h"
#include "src/main/native/windows/process.h"
#include "src/main/native/windows/util.h"
#include "third_party/ijar/common.h"
#include "third_party/ijar/platform_utils.h"
#include "third_party/ijar/zip.h"
#include "tools/cpp/runfiles/runfiles.h"
namespace bazel {
namespace tools {
namespace test_wrapper {
namespace {
class Defer {
public:
explicit Defer(std::function<void()> f) : f_(f) {}
~Defer() { f_(); }
void DoNow() {
f_();
f_ = kEmpty;
}
private:
std::function<void()> f_;
static const std::function<void()> kEmpty;
};
const std::function<void()> Defer::kEmpty = []() {};
// Streams data from an input to two outputs.
// Inspired by tee(1) in the GNU coreutils.
class TeeImpl : Tee {
public:
// Creates a background thread to stream data from `input` to the two outputs.
// The thread terminates when ReadFile fails on the input (e.g. the input is
// the reading end of a pipe and the writing end is closed) or when WriteFile
// fails on one of the outputs (e.g. the same output handle is closed
// elsewhere).
static bool Create(bazel::windows::AutoHandle* input,
bazel::windows::AutoHandle* output1,
bazel::windows::AutoHandle* output2,
std::unique_ptr<Tee>* result);
private:
static DWORD WINAPI ThreadFunc(LPVOID lpParam);
TeeImpl(bazel::windows::AutoHandle* input,
bazel::windows::AutoHandle* output1,
bazel::windows::AutoHandle* output2)
: input_(input), output1_(output1), output2_(output2) {}
TeeImpl(const TeeImpl&) = delete;
TeeImpl& operator=(const TeeImpl&) = delete;
bool MainFunc() const;
bazel::windows::AutoHandle input_;
bazel::windows::AutoHandle output1_;
bazel::windows::AutoHandle output2_;
};
// Buffered input stream (based on a Windows HANDLE) with peek-ahead support.
//
// This class uses two consecutive "pages" where it buffers data from the
// underlying HANDLE (wrapped in an AutoHandle). Both pages are always loaded
// with data until there's no more data to read.
//
// The "active" page is the one where the read cursor is pointing. The other
// page is the next one to be read once the client moves the read cursor beyond
// the end of the active page.
//
// The client advances the read cursor with Advance(). When the cursor reaches
// the end of the active page, the other page becomes the active one (whose data
// is already buffered), and the old active page is loaded with new data from
// the underlying file.
class IFStreamImpl : IFStream {
public:
// Creates a new IFStream.
//
// If successful, then takes ownership of the HANDLE in 'handle', and returns
// a new IFStream pointer. Otherwise leaves 'handle' alone and returns
// nullptr.
static IFStream* Create(HANDLE handle, DWORD page_size = 0x100000 /* 1 MB */);
int Get() override;
DWORD Peek(DWORD n, uint8_t* out) const override;
private:
HANDLE handle_;
const std::unique_ptr<uint8_t[]> pages_;
const DWORD page_size_;
DWORD pos_, end_, next_size_;
IFStreamImpl(HANDLE handle, std::unique_ptr<uint8_t[]>&& pages, DWORD n,
DWORD page_size)
: handle_(handle),
pages_(std::move(pages)),
page_size_(page_size),
pos_(0),
end_(n < page_size ? n : page_size),
next_size_(n < page_size
? 0
: (n < page_size * 2 ? n - page_size : page_size)) {}
};
// A lightweight path abstraction that stores a Unicode Windows path.
//
// The class allows extracting the underlying path as a (immutable) string so
// it's easy to pass the path to WinAPI functions, but the class does not allow
// mutating the unterlying path so it's safe to pass around Path objects.
class Path {
public:
Path() {}
Path(const Path& other) : path_(other.path_) {}
Path(Path&& other) : path_(std::move(other.path_)) {}
Path& operator=(const Path& other) = default;
const std::wstring& Get() const { return path_; }
bool Set(const std::wstring& path);
// Makes this path absolute.
// Returns true if the path was changed (i.e. was not absolute before).
// Returns false and has no effect if this path was empty or already absolute.
bool Absolutize(const Path& cwd);
Path Dirname() const;
private:
std::wstring path_;
};
struct UndeclaredOutputs {
Path root;
Path zip;
Path manifest;
Path annotations;
Path annotations_dir;
};
struct Duration {
static constexpr int kMax = INT_MAX;
int seconds;
bool FromString(const wchar_t* str);
};
enum class MainType { kTestWrapperMain, kXmlWriterMain };
enum class DeleteAfterwards { kEnabled, kDisabled };
void WriteStdout(const std::string& s) {
DWORD written;
WriteFile(GetStdHandle(STD_OUTPUT_HANDLE), s.c_str(), s.size(), &written,
nullptr);
}
void LogError(const int line) {
std::stringstream ss;
ss << "ERROR(" << __FILE__ << ":" << line << ")" << std::endl;
WriteStdout(ss.str());
}
void LogError(const int line, const std::string& msg) {
std::stringstream ss;
ss << "ERROR(" << __FILE__ << ":" << line << ") " << msg << std::endl;
WriteStdout(ss.str());
}
void LogError(const int line, const std::wstring& msg) {
std::string acp_msg;
if (blaze_util::WcsToAcp(msg, &acp_msg)) {
LogError(line, acp_msg);
}
}
void LogErrorWithValue(const int line, const std::string& msg, DWORD value) {
std::stringstream ss;
ss << "value: " << value << " (0x";
ss.setf(std::ios_base::hex, std::ios_base::basefield);
ss << std::setw(8) << std::setfill('0') << value << "): ";
ss.setf(std::ios_base::dec, std::ios_base::basefield);
ss << msg;
LogError(line, ss.str());
}
void LogErrorWithValue(const int line, const std::wstring& msg, DWORD value) {
std::string acp_msg;
if (blaze_util::WcsToAcp(msg, &acp_msg)) {
LogErrorWithValue(line, acp_msg, value);
}
}
void LogErrorWithArg(const int line, const std::string& msg,
const std::string& arg) {
std::stringstream ss;
ss << msg << " (arg: " << arg << ")";
LogError(line, ss.str());
}
void LogErrorWithArg(const int line, const std::string& msg,
const std::wstring& arg) {
std::string acp_arg;
if (blaze_util::WcsToAcp(arg, &acp_arg)) {
LogErrorWithArg(line, msg, acp_arg);
}
}
void LogErrorWithArg2(const int line, const std::string& msg,
const std::string& arg1, const std::string& arg2) {
std::stringstream ss;
ss << msg << " (arg1: " << arg1 << ", arg2: " << arg2 << ")";
LogError(line, ss.str());
}
void LogErrorWithArg2(const int line, const std::string& msg,
const std::wstring& arg1, const std::wstring& arg2) {
std::string acp_arg1, acp_arg2;
if (blaze_util::WcsToAcp(arg1, &acp_arg1) &&
blaze_util::WcsToAcp(arg2, &acp_arg2)) {
LogErrorWithArg2(line, msg, acp_arg1, acp_arg2);
}
}
void LogErrorWithArgAndValue(const int line, const std::string& msg,
const std::string& arg, DWORD value) {
std::stringstream ss;
ss << "value: " << value << " (0x";
ss.setf(std::ios_base::hex, std::ios_base::basefield);
ss << std::setw(8) << std::setfill('0') << value << "), arg: ";
ss.setf(std::ios_base::dec, std::ios_base::basefield);
ss << arg << ": " << msg;
LogError(line, ss.str());
}
void LogErrorWithArgAndValue(const int line, const std::string& msg,
const std::wstring& arg, DWORD value) {
std::string acp_arg;
if (blaze_util::WcsToAcp(arg, &acp_arg)) {
LogErrorWithArgAndValue(line, msg, acp_arg, value);
}
}
std::wstring AddUncPrefixMaybe(const Path& p) {
return bazel::windows::AddUncPrefixMaybe(p.Get());
}
std::wstring RemoveUncPrefixMaybe(const Path& p) {
return bazel::windows::RemoveUncPrefixMaybe(p.Get());
}
inline bool CreateDirectories(const Path& path) {
blaze_util::MakeDirectoriesW(AddUncPrefixMaybe(path), 0777);
return true;
}
inline bool ToInt(const wchar_t* s, int* result) {
return std::swscanf(s, L"%d", result) == 1;
}
bool WcsToAcp(const std::wstring& wcs, std::string* acp) {
uint32_t err;
if (!blaze_util::WcsToAcp(wcs, acp, &err)) {
LogErrorWithArgAndValue(__LINE__, "Failed to convert string", wcs, err);
return false;
}
return true;
}
// Converts a Windows-style path to a mixed (Unix-Windows) style.
// The path is mixed-style because it is a Windows path (begins with a drive
// letter) but uses forward slashes as directory separators.
// We must export envvars as mixed style path because some tools confuse the
// backslashes in Windows paths for Unix-style escape characters.
std::wstring AsMixedPath(const std::wstring& path) {
std::wstring value = path;
std::replace(value.begin(), value.end(), L'\\', L'/');
return value;
}
bool IsReadableFile(const Path& p) {
HANDLE h =
CreateFileW(AddUncPrefixMaybe(p).c_str(), GENERIC_READ,
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
if (h == INVALID_HANDLE_VALUE) {
return false;
}
CloseHandle(h);
return true;
}
// Gets an environment variable's value.
// Returns:
// - true, if the envvar is defined and successfully fetched, or it's empty or
// undefined
// - false, if some error occurred
bool GetEnv(const wchar_t* name, std::wstring* result) {
static constexpr size_t kSmallBuf = MAX_PATH;
WCHAR value[kSmallBuf];
DWORD size = GetEnvironmentVariableW(name, value, kSmallBuf);
DWORD err = GetLastError();
if (size == 0 && err == ERROR_ENVVAR_NOT_FOUND) {
result->clear();
return true;
} else if (0 < size && size < kSmallBuf) {
*result = value;
return true;
} else if (size >= kSmallBuf) {
std::unique_ptr<WCHAR[]> value_big(new WCHAR[size]);
GetEnvironmentVariableW(name, value_big.get(), size);
*result = value_big.get();
return true;
} else {
LogErrorWithArgAndValue(__LINE__, "Failed to read envvar", name, err);
return false;
}
}
// Gets an environment variable's value as a Path.
// Returns:
// - true, if the envvar is defined and successfully fetched, or it's empty or
// undefined
// - false, if some error occurred
bool GetPathEnv(const wchar_t* name, Path* result) {
std::wstring value;
if (!GetEnv(name, &value)) {
LogError(__LINE__, name);
return false;
}
return result->Set(value);
}
// Gets an environment variable's value as integer and as the original string.
// Returns:
// - true, if the envvar is defined and successfully fetched, or it's empty or
// undefined (in that case 'as_int' will be 0 and 'as_wstr' empty)
// - false, if ToInt cannot parse the string to an int, or some error occurred
bool GetIntEnv(const wchar_t* name, std::wstring* as_wstr, int* as_int) {
*as_int = 0;
if (!GetEnv(name, as_wstr) ||
(!as_wstr->empty() && !ToInt(as_wstr->c_str(), as_int))) {
LogError(__LINE__, name);
return false;
}
return true;
}
bool SetEnv(const wchar_t* name, const std::wstring& value) {
if (SetEnvironmentVariableW(name, value.c_str()) != 0) {
return true;
} else {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Failed to set envvar", name, err);
return false;
}
}
bool SetPathEnv(const wchar_t* name, const Path& path) {
return SetEnv(name, AsMixedPath(path.Get()));
}
bool UnsetEnv(const wchar_t* name) {
if (SetEnvironmentVariableW(name, nullptr) != 0) {
return true;
} else {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Failed to unset envvar", name, err);
return false;
}
}
bool AddCurrentDirectoryToPATH() {
std::wstring path;
return GetEnv(L"PATH", &path) && SetEnv(L"PATH", L".;" + path);
}
bool GetCwd(Path* result) {
static constexpr size_t kSmallBuf = MAX_PATH;
WCHAR value[kSmallBuf];
DWORD size = GetCurrentDirectoryW(kSmallBuf, value);
DWORD err = GetLastError();
if (size > 0 && size < kSmallBuf) {
return result->Set(value);
} else if (size >= kSmallBuf) {
std::unique_ptr<WCHAR[]> value_big(new WCHAR[size]);
GetCurrentDirectoryW(size, value_big.get());
return result->Set(value_big.get());
} else {
LogErrorWithValue(__LINE__, "Failed to get current directory", err);
return false;
}
}
bool ChdirToRunfiles(const Path& abs_exec_root, const Path& abs_test_srcdir) {
Path dir = abs_test_srcdir;
std::wstring preserve_cwd;
if (!GetEnv(L"RUNTEST_PRESERVE_CWD", &preserve_cwd)) {
return false;
}
if (preserve_cwd.empty()) {
std::wstring workspace;
if (!GetEnv(L"TEST_WORKSPACE", &workspace)) {
return false;
}
if (!workspace.empty()) {
Path joined;
if (!joined.Set(dir.Get() + L"\\" + workspace)) {
LogErrorWithArg2(__LINE__, "Could not join paths", dir.Get(),
workspace);
return false;
}
dir = joined;
}
} else {
dir = abs_exec_root;
}
dir.Absolutize(abs_exec_root);
// Non-sandboxed commands run in the exec_root, where they have access to the
// entire source tree. By chdir'ing to the runfiles root, tests only have
// direct access to their runfiles tree (if it exists), i.e. to their declared
// dependencies.
std::wstring coverage_dir;
if (!GetEnv(L"COVERAGE_DIR", &coverage_dir) || coverage_dir.empty()) {
if (!SetCurrentDirectoryW(dir.Get().c_str())) {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Could not chdir", dir.Get(), err);
return false;
}
}
return true;
}
// Set USER as required by the Bazel Test Encyclopedia.
bool ExportUserName() {
std::wstring value;
if (!GetEnv(L"USER", &value)) {
return false;
}
if (!value.empty()) {
// Respect the value passed by Bazel via --test_env.
return true;
}
WCHAR buffer[UNLEN + 1];
DWORD len = UNLEN + 1;
if (GetUserNameW(buffer, &len) == 0) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "Failed to query user name", err);
return false;
}
return SetEnv(L"USER", buffer);
}
// Gets a path envvar, and re-exports it as an absolute path.
// Returns:
// - true, if the envvar was defined, and was already absolute or was
// successfully absolutized and re-exported
// - false, if the envvar was undefined or empty, or it could not be absolutized
// or re-exported
bool ExportAbsolutePathEnv(const wchar_t* envvar, const Path& cwd,
Path* result) {
if (!GetPathEnv(envvar, result)) {
LogErrorWithArg(__LINE__, "Failed to get envvar", envvar);
return false;
}
if (result->Get().empty()) {
LogErrorWithArg(__LINE__, "Envvar was empty", envvar);
return false;
}
if (result->Absolutize(cwd) && !SetPathEnv(envvar, *result)) {
LogErrorWithArg2(__LINE__, "Failed to set absolutized envvar", envvar,
result->Get());
return false;
}
return true;
}
// Set TEST_SRCDIR as required by the Bazel Test Encyclopedia.
bool ExportSrcPath(const Path& cwd, Path* result) {
if (!ExportAbsolutePathEnv(L"TEST_SRCDIR", cwd, result)) {
LogError(__LINE__, "Failed to export TEST_SRCDIR");
return false;
}
return true;
}
// Set TEST_TMPDIR as required by the Bazel Test Encyclopedia.
bool ExportTmpPath(const Path& cwd, Path* result) {
if (!ExportAbsolutePathEnv(L"TEST_TMPDIR", cwd, result)) {
LogError(__LINE__, "Failed to export TEST_TMPDIR");
return false;
}
// Create the test temp directory, which may not exist on the remote host when
// doing a remote build.
return CreateDirectories(*result);
}
// Set HOME as required by the Bazel Test Encyclopedia.
bool ExportHome(const Path& test_tmpdir) {
Path home;
if (!GetPathEnv(L"HOME", &home)) {
return false;
}
if (blaze_util::IsAbsolute(home.Get())) {
// Respect the user-defined HOME in case they set passed it with
// --test_env=HOME or --test_env=HOME=C:\\foo
return true;
} else {
// Set TEST_TMPDIR as required by the Bazel Test Encyclopedia.
return SetPathEnv(L"HOME", test_tmpdir);
}
}
bool ExportRunfiles(const Path& cwd, const Path& test_srcdir) {
Path runfiles_dir;
if (!GetPathEnv(L"RUNFILES_DIR", &runfiles_dir) ||
(runfiles_dir.Absolutize(cwd) &&
!SetPathEnv(L"RUNFILES_DIR", runfiles_dir))) {
return false;
}
// TODO(ulfjack): Standardize on RUNFILES_DIR and remove the
// {JAVA,PYTHON}_RUNFILES vars.
Path java_rf, py_rf;
if (!GetPathEnv(L"JAVA_RUNFILES", &java_rf) ||
(java_rf.Absolutize(cwd) && !SetPathEnv(L"JAVA_RUNFILES", java_rf)) ||
!GetPathEnv(L"PYTHON_RUNFILES", &py_rf) ||
(py_rf.Absolutize(cwd) && !SetPathEnv(L"PYTHON_RUNFILES", py_rf))) {
return false;
}
std::wstring mf_only_str;
int mf_only_value = 0;
if (!GetIntEnv(L"RUNFILES_MANIFEST_ONLY", &mf_only_str, &mf_only_value)) {
return false;
}
if (mf_only_value == 1) {
// If RUNFILES_MANIFEST_ONLY is set to 1 then test programs should use the
// manifest file to find their runfiles.
Path runfiles_mf;
if (!runfiles_mf.Set(test_srcdir.Get() + L"\\MANIFEST") ||
(IsReadableFile(runfiles_mf) &&
!SetPathEnv(L"RUNFILES_MANIFEST_FILE", runfiles_mf))) {
return false;
}
}
return true;
}
bool ExportShardStatusFile(const Path& cwd) {
Path status_file;
if (!GetPathEnv(L"TEST_SHARD_STATUS_FILE", &status_file) ||
(!status_file.Get().empty() && status_file.Absolutize(cwd) &&
!SetPathEnv(L"TEST_SHARD_STATUS_FILE", status_file))) {
return false;
}
return status_file.Get().empty() ||
// The test shard status file is only set for sharded tests.
CreateDirectories(status_file.Dirname());
}
bool ExportGtestVariables(const Path& test_tmpdir) {
// # Tell googletest about Bazel sharding.
std::wstring total_shards_str;
int total_shards_value = 0;
if (!GetIntEnv(L"TEST_TOTAL_SHARDS", &total_shards_str,
&total_shards_value)) {
return false;
}
if (total_shards_value > 0) {
std::wstring shard_index;
if (!GetEnv(L"TEST_SHARD_INDEX", &shard_index) ||
!SetEnv(L"GTEST_SHARD_INDEX", shard_index) ||
!SetEnv(L"GTEST_TOTAL_SHARDS", total_shards_str)) {
return false;
}
}
return SetPathEnv(L"GTEST_TMP_DIR", test_tmpdir);
}
bool ExportMiscEnvvars(const Path& cwd) {
for (const wchar_t* name :
{L"TEST_INFRASTRUCTURE_FAILURE_FILE", L"TEST_LOGSPLITTER_OUTPUT_FILE",
L"TEST_PREMATURE_EXIT_FILE", L"TEST_UNUSED_RUNFILES_LOG_FILE",
L"TEST_WARNINGS_OUTPUT_FILE"}) {
Path value;
if (!GetPathEnv(name, &value) ||
(value.Absolutize(cwd) && !SetPathEnv(name, value))) {
return false;
}
}
return true;
}
bool _GetFileListRelativeTo(const std::wstring& unc_root,
const std::wstring& subdir, int depth_limit,
std::vector<FileInfo>* result) {
const std::wstring full_subdir =
unc_root + (subdir.empty() ? L"" : (L"\\" + subdir)) + L"\\*";
WIN32_FIND_DATAW info;
HANDLE handle = FindFirstFileW(full_subdir.c_str(), &info);
if (handle == INVALID_HANDLE_VALUE) {
DWORD err = GetLastError();
if (err == ERROR_FILE_NOT_FOUND) {
// No files found, nothing to do.
return true;
}
LogErrorWithArgAndValue(__LINE__, "Failed to list directory contents",
full_subdir, err);
return false;
}
Defer close_handle([handle]() { FindClose(handle); });
static const std::wstring kDot(1, L'.');
static const std::wstring kDotDot(2, L'.');
std::vector<std::wstring> subdirectories;
while (true) {
if (kDot != info.cFileName && kDotDot != info.cFileName) {
std::wstring rel_path =
subdir.empty() ? info.cFileName : (subdir + L"\\" + info.cFileName);
if (info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
if (depth_limit != 0) {
// depth_limit is negative ==> unlimited depth
// depth_limit is zero ==> do not recurse further
// depth_limit is positive ==> recurse further
subdirectories.push_back(rel_path);
}
result->push_back(FileInfo(rel_path));
} else {
if (info.nFileSizeHigh > 0 || info.nFileSizeLow > INT_MAX) {
// devtools_ijar::Stat::total_size is declared as `int`, so the file
// size limit is INT_MAX. Additionally we limit the files to be below
// 4 GiB, not only because int is typically 4 bytes long, but also
// because such huge files are unreasonably large as an undeclared
// output.
LogErrorWithArgAndValue(__LINE__, "File is too large to archive",
rel_path, 0);
return false;
}
result->push_back(FileInfo(rel_path,
// File size is already validated to be
// smaller than min(INT_MAX, 4 GiB)
static_cast<int>(info.nFileSizeLow)));
}
}
if (FindNextFileW(handle, &info) == 0) {
DWORD err = GetLastError();
if (err == ERROR_NO_MORE_FILES) {
break;
}
LogErrorWithArgAndValue(__LINE__,
"Failed to get next element in directory",
unc_root + L"\\" + subdir, err);
return false;
}
}
close_handle.DoNow();
if (depth_limit != 0) {
// depth_limit is negative ==> unlimited depth
// depth_limit is zero ==> do not recurse further
// depth_limit is positive ==> recurse further
for (const auto& s : subdirectories) {
if (!_GetFileListRelativeTo(
unc_root, s, depth_limit > 0 ? depth_limit - 1 : depth_limit,
result)) {
return false;
}
}
}
return true;
}
bool GetFileListRelativeTo(const Path& root, std::vector<FileInfo>* result,
int depth_limit = -1) {
if (!blaze_util::IsAbsolute(root.Get())) {
LogError(__LINE__, "Root should be absolute");
return false;
}
return _GetFileListRelativeTo(AddUncPrefixMaybe(root), std::wstring(),
depth_limit, result);
}
bool ToZipEntryPaths(const Path& root, const std::vector<FileInfo>& files,
ZipEntryPaths* result) {
std::string acp_root;
if (!WcsToAcp(AsMixedPath(RemoveUncPrefixMaybe(root)), &acp_root)) {
LogErrorWithArg(__LINE__, "Failed to convert path", root.Get());
return false;
}
// Convert all UTF-16 paths to ANSI paths.
std::vector<std::string> acp_file_list;
acp_file_list.reserve(files.size());
for (const auto& e : files) {
std::string acp_path;
if (!WcsToAcp(AsMixedPath(e.RelativePath()), &acp_path)) {
LogErrorWithArg(__LINE__, "Failed to convert path", e.RelativePath());
return false;
}
if (e.IsDirectory()) {
acp_path += "/";
}
acp_file_list.push_back(acp_path);
}
result->Create(acp_root, acp_file_list);
return true;
}
bool CreateZipBuilder(const Path& zip, const ZipEntryPaths& entry_paths,
std::unique_ptr<devtools_ijar::ZipBuilder>* result) {
const devtools_ijar::u8 estimated_size =
devtools_ijar::ZipBuilder::EstimateSize(entry_paths.AbsPathPtrs(),
entry_paths.EntryPathPtrs(),
entry_paths.Size());
if (estimated_size == 0) {
LogError(__LINE__, "Failed to estimate zip size");
return false;
}
std::string acp_zip;
if (!WcsToAcp(zip.Get(), &acp_zip)) {
LogErrorWithArg(__LINE__, "Failed to convert path", zip.Get());
return false;
}
result->reset(
devtools_ijar::ZipBuilder::Create(acp_zip.c_str(), estimated_size));
if (result->get() == nullptr) {
LogErrorWithValue(__LINE__, "Failed to create zip builder", errno);
return false;
}
return true;
}
bool OpenFileForWriting(const Path& path, bazel::windows::AutoHandle* result) {
HANDLE h = CreateFileW(AddUncPrefixMaybe(path).c_str(), GENERIC_WRITE,
FILE_SHARE_READ | FILE_SHARE_DELETE, nullptr,
CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
if (h == INVALID_HANDLE_VALUE) {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Failed to open file", path.Get(), err);
return false;
}
*result = h;
return true;
}
bool OpenExistingFileForRead(const Path& abs_path,
bazel::windows::AutoHandle* result) {
HANDLE h =
CreateFileW(AddUncPrefixMaybe(abs_path).c_str(), GENERIC_READ,
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
if (h == INVALID_HANDLE_VALUE) {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Failed to open file", abs_path.Get(),
err);
return false;
}
*result = h;
return true;
}
bool CreateEmptyFile(const Path& path) {
bazel::windows::AutoHandle handle;
return OpenFileForWriting(path, &handle);
}
bool ReadFromFile(HANDLE handle, uint8_t* dest, DWORD max_read) {
if (max_read == 0) {
return true;
}
DWORD total_read = 0;
DWORD read = 0;
do {
if (!ReadFile(handle, dest + total_read, max_read - total_read, &read,
nullptr)) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "Failed to read file", err);
return false;
}
total_read += read;
} while (read > 0 && total_read < max_read);
return true;
}
bool WriteToFile(HANDLE output, const void* buffer, const size_t size) {
// Write `size` many bytes to the output file.
DWORD total_written = 0;
while (total_written < size) {
DWORD written;
if (!WriteFile(output, static_cast<const uint8_t*>(buffer) + total_written,
size - total_written, &written, nullptr)) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "Failed to write file", err);
return false;
}
total_written += written;
}
return true;
}
bool AppendFileTo(const Path& file, const size_t total_size, HANDLE output) {
bazel::windows::AutoHandle input;
if (!OpenExistingFileForRead(file, &input)) {
LogErrorWithArg(__LINE__, "Failed to open file for reading", file.Get());
return false;
}
const size_t buf_size = std::min<size_t>(total_size, /* 10 MB */ 10000000);
std::unique_ptr<uint8_t[]> buffer(new uint8_t[buf_size]);
while (true) {
// Read at most `buf_size` many bytes from the input file.
DWORD read = 0;
if (!ReadFile(input, buffer.get(), buf_size, &read, nullptr)) {
DWORD err = GetLastError();
LogErrorWithArgAndValue(__LINE__, "Failed to read file", file.Get(), err);
return false;
}
if (read == 0) {
// Reached end of input file.
return true;
}
if (!WriteToFile(output, buffer.get(), read)) {
LogErrorWithArg(__LINE__, "Failed to write contents from file",
file.Get());
return false;
}
}
return true;
}
// Returns the MIME type of the file name.
// If the MIME type is unknown or an error occurs, the method returns
// "application/octet-stream".
std::string GetMimeType(const std::string& filename) {
static constexpr char* kDefaultMimeType = "application/octet-stream";
std::string::size_type pos = filename.find_last_of('.');
if (pos == std::string::npos) {
return kDefaultMimeType;
}
char data[1000];
DWORD data_size = 1000 * sizeof(char);
if (RegGetValueA(HKEY_CLASSES_ROOT, filename.c_str() + pos, "Content Type",
RRF_RT_REG_SZ, nullptr, data, &data_size) == ERROR_SUCCESS) {
return data;
}
// The file extension is unknown, or it does not have a "Content Type" value,
// or the value is too long. We don't care; just return the default.
return kDefaultMimeType;
}
bool CreateUndeclaredOutputsManifestContent(const std::vector<FileInfo>& files,
std::string* result) {
std::stringstream stm;
for (const auto& e : files) {
if (!e.IsDirectory()) {
// For each file, write a tab-separated line to the manifest with name
// (relative to TEST_UNDECLARED_OUTPUTS_DIR), size, and mime type.
// Example:
// foo.txt<TAB>9<TAB>text/plain
// bar/baz<TAB>2944<TAB>application/octet-stream
std::string acp_path;
if (!WcsToAcp(AsMixedPath(e.RelativePath()), &acp_path)) {
return false;
}
stm << acp_path << "\t" << e.Size() << "\t" << GetMimeType(acp_path)
<< "\n";
}
}
*result = stm.str();
return true;
}
bool CreateUndeclaredOutputsManifest(const std::vector<FileInfo>& files,
const Path& output) {
std::string content;
if (!CreateUndeclaredOutputsManifestContent(files, &content)) {
LogErrorWithArg(__LINE__, "Failed to create manifest content for file",
output.Get());
return false;
}
bazel::windows::AutoHandle handle;
if (!OpenFileForWriting(output, &handle)) {
LogErrorWithArg(__LINE__, "Failed to open file for writing", output.Get());
return false;
}
if (!WriteToFile(handle, content.c_str(), content.size())) {
LogErrorWithArg(__LINE__, "Failed to write file", output.Get());
return false;
}
return true;
}
bool ExportXmlPath(const Path& cwd, Path* test_outerr, Path* xml_log) {
if (!GetPathEnv(L"XML_OUTPUT_FILE", xml_log)) {
LogError(__LINE__);
return false;
}
xml_log->Absolutize(cwd);
if (!test_outerr->Set(xml_log->Get() + L".log")) {
LogError(__LINE__);
return false;
}
std::wstring unix_result = AsMixedPath(xml_log->Get());
return SetEnv(L"XML_OUTPUT_FILE", unix_result) &&
// TODO(ulfjack): Update Gunit to accept XML_OUTPUT_FILE and drop the
// GUNIT_OUTPUT env variable.
SetEnv(L"GUNIT_OUTPUT", L"xml:" + unix_result) &&
CreateDirectories(xml_log->Dirname()) && CreateEmptyFile(*test_outerr);
}
devtools_ijar::u4 GetZipAttr(const FileInfo& info) {
// We use these hard-coded Unix permission masks because they are:
// - stable, so the zip file is deterministic
// - useful, because stat_to_zipattr expects a mode_t
static constexpr mode_t kDirectoryMode = 040750; // drwxr-x--- (directory)
static constexpr mode_t kFileMode = 0100640; // -rw-r----- (regular file)
devtools_ijar::Stat file_stat;
file_stat.total_size = info.Size();
file_stat.is_directory = info.IsDirectory();
file_stat.file_mode = info.IsDirectory() ? kDirectoryMode : kFileMode;
return devtools_ijar::stat_to_zipattr(file_stat);
}
bool GetZipEntryPtr(devtools_ijar::ZipBuilder* zip_builder,
const char* entry_name, const devtools_ijar::u4 attr,
devtools_ijar::u1** result) {
*result = zip_builder->NewFile(entry_name, attr);
if (*result == nullptr) {
LogErrorWithArg2(__LINE__, "Failed to add new zip entry for file",
entry_name, zip_builder->GetError());
return false;
}
return true;
}
bool CreateZip(const Path& root, const std::vector<FileInfo>& files,
const Path& abs_zip) {
bool restore_oem_api = false;
if (!AreFileApisANSI()) {
// devtools_ijar::ZipBuilder uses the ANSI file APIs so we must set the
// active code page to ANSI.
SetFileApisToANSI();
restore_oem_api = true;
}
Defer restore_file_apis([restore_oem_api]() {
if (restore_oem_api) {
SetFileApisToOEM();
}
});
ZipEntryPaths zip_entry_paths;
if (!ToZipEntryPaths(root, files, &zip_entry_paths)) {
LogError(__LINE__, "Failed to create zip entry paths");
return false;
}
std::unique_ptr<devtools_ijar::ZipBuilder> zip_builder;
if (!CreateZipBuilder(abs_zip, zip_entry_paths, &zip_builder)) {
LogError(__LINE__, "Failed to create zip builder");
return false;
}
for (size_t i = 0; i < files.size(); ++i) {
bazel::windows::AutoHandle handle;
Path path;
if (!path.Set(root.Get() + L"\\" + files[i].RelativePath()) ||
(!files[i].IsDirectory() && !OpenExistingFileForRead(path, &handle))) {
LogErrorWithArg(__LINE__, "Failed to open file for reading", path.Get());
return false;
}
devtools_ijar::u1* dest;
if (!GetZipEntryPtr(zip_builder.get(), zip_entry_paths.EntryPathPtrs()[i],
GetZipAttr(files[i]), &dest) ||
(!files[i].IsDirectory() &&
!ReadFromFile(handle, dest, files[i].Size()))) {
LogErrorWithArg(__LINE__, "Failed to dump file into zip", path.Get());
return false;
}
if (zip_builder->FinishFile(files[i].Size(), /* compress */ false,
/* compute_crc */ true) == -1) {
LogErrorWithArg(__LINE__, "Failed to finish writing file to zip",
path.Get());
return false;
}
}
if (zip_builder->Finish() == -1) {
LogErrorWithArg(__LINE__, "Failed to add file to zip",
zip_builder->GetError());
return false;
}
return true;
}
bool GetAndUnexportUndeclaredOutputsEnvvars(const Path& cwd,
UndeclaredOutputs* result) {
// The test may only see TEST_UNDECLARED_OUTPUTS_DIR and
// TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR, so keep those but unexport others.
if (!GetPathEnv(L"TEST_UNDECLARED_OUTPUTS_ZIP", &(result->zip)) ||
!UnsetEnv(L"TEST_UNDECLARED_OUTPUTS_ZIP") ||
!GetPathEnv(L"TEST_UNDECLARED_OUTPUTS_MANIFEST", &(result->manifest)) ||
!UnsetEnv(L"TEST_UNDECLARED_OUTPUTS_MANIFEST") ||
!GetPathEnv(L"TEST_UNDECLARED_OUTPUTS_ANNOTATIONS",
&(result->annotations)) ||
!UnsetEnv(L"TEST_UNDECLARED_OUTPUTS_ANNOTATIONS") ||
!GetPathEnv(L"TEST_UNDECLARED_OUTPUTS_DIR", &(result->root)) ||
!GetPathEnv(L"TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR",
&(result->annotations_dir))) {
return false;
}
result->root.Absolutize(cwd);
result->annotations_dir.Absolutize(cwd);
result->zip.Absolutize(cwd);
result->manifest.Absolutize(cwd);
result->annotations.Absolutize(cwd);
return SetPathEnv(L"TEST_UNDECLARED_OUTPUTS_DIR", result->root) &&
SetPathEnv(L"TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR",
result->annotations_dir) &&
CreateDirectories(result->root) &&
CreateDirectories(result->annotations_dir);
}
bool PrintTestLogStartMarker() {
std::wstring test_target;
std::string acp_test_target;
if (!GetEnv(L"TEST_TARGET", &test_target) ||
!WcsToAcp(test_target, &acp_test_target)) {
return false;
}
std::stringstream ss;
if (test_target.empty()) {
// According to the Bazel Test Encyclopedia, setting TEST_TARGET is
// optional.
ss << "Executing tests from unknown target\n";
} else {
ss << "Executing tests from " << acp_test_target << "\n";
}
// This header marks where --test_output=streamed will start being printed.
ss << "---------------------------------------------------------------------"
"--------\n";
WriteStdout(ss.str());
return true;
}
inline bool GetWorkspaceName(std::wstring* result) {
return GetEnv(L"TEST_WORKSPACE", result) && !result->empty();
}
inline void ComputeRunfilePath(const std::wstring& test_workspace,
std::wstring* s) {
if (s->size() >= 2 && (*s)[0] == L'.' && (*s)[1] == L'/') {
s->erase(0, 2);
}
if (s->find(L"external/") == 0) {
s->erase(0, 9);
} else {
*s = test_workspace + L"/" + *s;
}
}
bool FindTestBinary(const Path& argv0, const Path& cwd, std::wstring test_path,
const Path& abs_test_srcdir, Path* result) {
if (!blaze_util::IsAbsolute(test_path)) {
std::string argv0_acp;
if (!WcsToAcp(argv0.Get(), &argv0_acp)) {
LogErrorWithArg(__LINE__, "Failed to convert path", argv0.Get());
return false;
}
std::string error;
std::unique_ptr<bazel::tools::cpp::runfiles::Runfiles> runfiles(
bazel::tools::cpp::runfiles::Runfiles::Create(argv0_acp, &error));
if (runfiles == nullptr) {
LogError(__LINE__, "Failed to load runfiles");
return false;
}
std::wstring workspace;
if (!GetEnv(L"TEST_WORKSPACE", &workspace) || workspace.empty()) {
LogError(__LINE__, "Failed to read %TEST_WORKSPACE%");
return false;
}
ComputeRunfilePath(workspace, &test_path);
Path test_bin_in_runfiles;
if (!test_bin_in_runfiles.Set(abs_test_srcdir.Get() + L"\\" + test_path)) {
LogErrorWithArg2(__LINE__, "Could not join paths", abs_test_srcdir.Get(),
test_path);
return false;
}
std::wstring mf_only_str;
int mf_only_value = 0;
if (!GetIntEnv(L"RUNFILES_MANIFEST_ONLY", &mf_only_str, &mf_only_value)) {
return false;
}
// If runfiles is enabled on Windows, we use the test binary in the runfiles
// tree, which is consistent with the behavior on Linux and macOS.
// Otherwise, we use Rlocation function to find the actual test binary
// location.
if (mf_only_value != 1 && IsReadableFile(test_bin_in_runfiles)) {
test_path = test_bin_in_runfiles.Get();
} else {
std::string utf8_test_path;
uint32_t err;
if (!blaze_util::WcsToUtf8(test_path, &utf8_test_path, &err)) {
LogErrorWithArgAndValue(__LINE__, "Failed to convert string to UTF-8",
test_path, err);
return false;
}
std::string rloc = runfiles->Rlocation(utf8_test_path);
if (!blaze_util::Utf8ToWcs(rloc, &test_path, &err)) {
LogErrorWithArgAndValue(__LINE__, "Failed to convert string",
utf8_test_path, err);
}
}
}
if (!result->Set(test_path)) {
LogErrorWithArg(__LINE__, "Failed to set path", test_path);
return false;
}
(void)result->Absolutize(cwd);
return true;
}
bool CreateCommandLine(const Path& path, const std::wstring& args,
std::unique_ptr<WCHAR[]>* result) {
// kMaxCmdline value: see lpCommandLine parameter of CreateProcessW.
static constexpr size_t kMaxCmdline = 32767;
if (path.Get().size() + args.size() > kMaxCmdline) {
LogErrorWithValue(__LINE__, L"Command is too long",
path.Get().size() + args.size());
return false;
}
// Add an extra character for the final null-terminator.
result->reset(new WCHAR[path.Get().size() + args.size() + 1]);
wcsncpy(result->get(), path.Get().c_str(), path.Get().size());
wcsncpy(result->get() + path.Get().size(), args.c_str(), args.size() + 1);
return true;
}
bool StartSubprocess(const Path& path, const std::wstring& args,
const Path& outerr, std::unique_ptr<Tee>* tee,
LARGE_INTEGER* start_time,
bazel::windows::WaitableProcess* process) {
SECURITY_ATTRIBUTES inheritable_handle_sa = {sizeof(SECURITY_ATTRIBUTES),
nullptr, TRUE};
// Create a pipe to stream the output of the subprocess to this process.
// The subprocess inherits two copies of the writing end (one for stdout, one
// for stderr). This process closes its copies of the handles.
// This process keeps the reading end and streams data from the pipe to the
// test log and to stdout.
HANDLE pipe_read_h, pipe_write_h;
if (!CreatePipe(&pipe_read_h, &pipe_write_h, &inheritable_handle_sa, 0)) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "CreatePipe", err);
return false;
}
bazel::windows::AutoHandle pipe_read(pipe_read_h), pipe_write(pipe_write_h);
// Duplicate the write end of the pipe.
// The original will be connected to the stdout of the process, the duplicate
// to stderr.
HANDLE pipe_write_dup_h;
if (!DuplicateHandle(GetCurrentProcess(), pipe_write, GetCurrentProcess(),
&pipe_write_dup_h, 0, TRUE, DUPLICATE_SAME_ACCESS)) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "DuplicateHandle", err);
return false;
}
bazel::windows::AutoHandle pipe_write_dup(pipe_write_dup_h);
// Open a readonly handle to NUL. The subprocess inherits this handle that's
// connected to its stdin.
bazel::windows::AutoHandle devnull_read(CreateFileW(
L"NUL", GENERIC_READ,
FILE_SHARE_WRITE | FILE_SHARE_READ | FILE_SHARE_DELETE,
&inheritable_handle_sa, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr));
if (devnull_read == INVALID_HANDLE_VALUE) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "CreateFileW", err);
return false;
}
// Open a handle to the test log file. The "tee" thread will write everything
// into it that the subprocess writes to the pipe.
bazel::windows::AutoHandle test_outerr;
if (!OpenFileForWriting(outerr, &test_outerr)) {
LogErrorWithArg(__LINE__, "Failed to open file for writing", outerr.Get());
return false;
}
// Duplicate stdout's handle, and pass it to the tee thread, who will own it
// and close it in the end.
HANDLE stdout_dup_h;
if (!DuplicateHandle(GetCurrentProcess(), GetStdHandle(STD_OUTPUT_HANDLE),
GetCurrentProcess(), &stdout_dup_h, 0, FALSE,
DUPLICATE_SAME_ACCESS)) {
DWORD err = GetLastError();
LogErrorWithValue(__LINE__, "DuplicateHandle", err);
return false;
}
bazel::windows::AutoHandle stdout_dup(stdout_dup_h);
// Create the tee thread, and transfer ownerships of the `pipe_read`,
// `test_outerr`, and `stdout_dup` handles.
if (!TeeImpl::Create(&pipe_read, &test_outerr, &stdout_dup, tee)) {
LogError(__LINE__);
return false;
}
std::wstring werror;
if (!process->Create(path.Get(), args, nullptr, L"", devnull_read, pipe_write,
pipe_write_dup, start_time, &werror)) {
LogError(__LINE__, werror);
return false;
}
return true;
}
bool ArchiveUndeclaredOutputs(const UndeclaredOutputs& undecl) {
if (undecl.root.Get().empty()) {
// TEST_UNDECLARED_OUTPUTS_DIR was undefined, there's nothing to archive.
return true;
}
std::vector<FileInfo> files;
return GetFileListRelativeTo(undecl.root, &files) &&
(files.empty() ||
(CreateZip(undecl.root, files, undecl.zip) &&
CreateUndeclaredOutputsManifest(files, undecl.manifest)));
}
// Creates the Undeclared Outputs Annotations file.
//
// This file is a concatenation of every *.part file directly under
// `undecl_annot_dir`. The file is written to `output`.
bool CreateUndeclaredOutputsAnnotations(const Path& undecl_annot_dir,
const Path& output) {
if (undecl_annot_dir.Get().empty()) {
// The directory's environment variable
// (TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR) was probably undefined, nothing
// to do.
return true;
}
std::vector<FileInfo> files;
if (!GetFileListRelativeTo(undecl_annot_dir, &files, 0)) {
LogErrorWithArg(__LINE__, "Failed to get directory contents",
undecl_annot_dir.Get());
return false;
}
// There are no *.part files under `undecl_annot_dir`, nothing to do.
if (files.empty()) {
return true;
}
bazel::windows::AutoHandle handle;
if (!OpenFileForWriting(output, &handle)) {
LogErrorWithArg(__LINE__, "Failed to open file for writing", output.Get());
return false;
}
for (const auto& e : files) {
if (!e.IsDirectory() &&
e.RelativePath().rfind(L".part") == e.RelativePath().size() - 5) {
// Only consume "*.part" files.
Path path;
if (!path.Set(undecl_annot_dir.Get() + L"\\" + e.RelativePath()) ||
!AppendFileTo(path, e.Size(), handle)) {
LogErrorWithArg2(__LINE__, "Failed to append file to another",
path.Get(), output.Get());
return false;
}
}
}
return true;
}
bool ParseArgs(int argc, wchar_t** argv, Path* out_argv0,
std::wstring* out_test_path_arg, std::wstring* out_args) {
if (!out_argv0->Set(argv[0])) {
return false;
}
argc--;
argv++;
if (argc < 1) {
LogError(__LINE__, "Usage: $0 <test_path> [test_args...]");
return false;
}
*out_test_path_arg = argv[0];
std::wstringstream stm;
for (int i = 1; i < argc; i++) {
stm << L' ' << bazel::windows::WindowsEscapeArg(argv[i]);
}
*out_args = stm.str();
return true;
}
bool ParseXmlWriterArgs(int argc, wchar_t** argv, const Path& cwd,
Path* out_test_log, Path* out_xml_log,
Duration* out_duration, int* out_exit_code) {
if (argc < 5) {
LogError(__LINE__,
"Usage: $0 <test_output_path> <xml_log_path>"
" <duration_in_seconds> <exit_code>");
return false;
}
if (!out_test_log->Set(argv[1]) || out_test_log->Get().empty()) {
LogErrorWithArg(__LINE__, "Failed to parse test log path argument",
argv[1]);
return false;
}
out_test_log->Absolutize(cwd);
if (!out_xml_log->Set(argv[2]) || out_xml_log->Get().empty()) {
LogErrorWithArg(__LINE__, "Failed to parse XML log path argument", argv[2]);
return false;
}
out_xml_log->Absolutize(cwd);
if (!out_duration->FromString(argv[3])) {
LogErrorWithArg(__LINE__, "Failed to parse test duration argument",
argv[3]);
return false;
}
if (!ToInt(argv[4], out_exit_code)) {
LogErrorWithArg(__LINE__, "Failed to parse exit code argument", argv[4]);
return false;
}
return true;
}
bool TeeImpl::Create(bazel::windows::AutoHandle* input,
bazel::windows::AutoHandle* output1,
bazel::windows::AutoHandle* output2,
std::unique_ptr<Tee>* result) {
std::unique_ptr<TeeImpl> tee(new TeeImpl(input, output1, output2));
bazel::windows::AutoHandle thread(
CreateThread(nullptr, 0, ThreadFunc, tee.get(), 0, nullptr));
if (!thread.IsValid()) {
return false;
}
result->reset(tee.release());
return true;
}
DWORD WINAPI TeeImpl::ThreadFunc(LPVOID lpParam) {
return reinterpret_cast<TeeImpl*>(lpParam)->MainFunc() ? 0 : 1;
}
bool TeeImpl::MainFunc() const {
static constexpr size_t kBufferSize = 0x10000;
DWORD read;
uint8_t content[kBufferSize];
while (ReadFile(input_, content, kBufferSize, &read, nullptr)) {
DWORD written;
if (read > 0 && (!WriteFile(output1_, content, read, &written, nullptr) ||
!WriteFile(output2_, content, read, &written, nullptr))) {
return false;
}
}
return true;
}
int RunSubprocess(const Path& test_path, const std::wstring& args,
const Path& test_outerr, Duration* test_duration) {
std::unique_ptr<Tee> tee;
bazel::windows::WaitableProcess process;
LARGE_INTEGER start, end, freq;
if (!StartSubprocess(test_path, args, test_outerr, &tee, &start, &process)) {
LogErrorWithArg(__LINE__, "Failed to start test process", test_path.Get());
return 1;
}
std::wstring werror;
int wait_res = process.WaitFor(-1, &end, &werror);
if (wait_res != bazel::windows::WaitableProcess::kWaitSuccess) {
LogErrorWithValue(__LINE__, werror, wait_res);
return 1;
}
werror.clear();
int result = process.GetExitCode(&werror);
if (!werror.empty()) {
LogError(__LINE__, werror);
return 1;
}
QueryPerformanceFrequency(&freq);
end.QuadPart -= start.QuadPart;
decltype(LARGE_INTEGER::QuadPart) seconds;
// Compute the number of seconds the test ran for.
seconds = end.QuadPart / freq.QuadPart;
// Check the remainder: if it's at least 0.5 seconds, round up.
if ((end.QuadPart - seconds * freq.QuadPart) * 2 >= freq.QuadPart) {
seconds += 1;
}
test_duration->seconds =
(seconds > Duration::kMax) ? Duration::kMax : seconds;
return result;
}
// Replace invalid XML characters and locate invalid CDATA sequences.
//
// The legal Unicode code points and ranges are U+0009, U+000A, U+000D,
// U+0020..U+D7FF, U+E000..U+FFFD, and U+10000..U+10FFFF.
//
// Assuming the input is UTF-8 encoded, that translates to the following
// regexps:
// [\x9\xa\xd\x20-\x7f] <--- (9,A,D,20-7F)
// [\xc0-\xdf][\x80-\xbf] <--- (0080-07FF)
// [\xe0-\xec][\x80-\xbf][\x80-\xbf] <--- (0800-CFFF)
// [\xed][\x80-\x9f][\x80-\xbf] <--- (D000-D7FF)
// [\xee][\x80-\xbf][\x80-\xbf] <--- (E000-EFFF)
// [\xef][\x80-\xbe][\x80-\xbf] <--- (F000-FFEF)
// [\xef][\xbf][\x80-\xbd] <--- (FFF0-FFFD)
// [\xf0-\xf7][\x80-\xbf][\x80-\xbf][\x80-\xbf] <--- (010000-10FFFF)
//
// (See https://github.com/bazelbuild/bazel/issues/4691#issuecomment-408089257)
//
// Every octet-sequence matching one of these regexps will be left alone, all
// other octet-sequences will be replaced by '?' characters.
bool CdataEscape(IFStream* in, std::basic_ostream<char>* out) {
int c0 = in->Get();
uint8_t p[3];
for (; c0 < 256; c0 = in->Get()) {
if (c0 == ']' && in->Peek(2, p) == 2 && p[0] == ']' && p[1] == '>') {
*out << "]]>]]<![CDATA[>";
if (!out->good()) {
return false;
}
(void)in->Get();
(void)in->Get();
} else if (c0 == 0x9 || c0 == 0xA || c0 == 0xD ||
(c0 >= 0x20 && c0 <= 0x7F)) {
// Matched legal single-octet sequence.
*out << (char)c0;
if (!out->good()) {
return false;
}
} else if (c0 >= 0xC0 && c0 <= 0xDF && in->Peek(1, p) == 1 &&
p[0] >= 0x80 && p[0] <= 0xBF) {
// Matched legal double-octet sequence. Skip the next octet.
*out << (char)c0 << (char)p[0];
if (!out->good()) {
return false;
}
(void)in->Get();
} else if (in->Peek(2, p) == 2 &&
((c0 >= 0xE0 && c0 <= 0xEC && p[0] >= 0x80 && p[0] <= 0xBF &&
p[1] >= 0x80 && p[1] <= 0xBF) ||
(c0 == 0xED && p[0] >= 0x80 && p[0] <= 0x9F && p[1] >= 0x80 &&
p[1] <= 0xBF) ||
(c0 == 0xEE && p[0] >= 0x80 && p[0] <= 0xBF && p[1] >= 0x80 &&
p[1] <= 0xBF) ||
(c0 == 0xEF && p[0] >= 0x80 && p[0] <= 0xBE && p[1] >= 0x80 &&
p[1] <= 0xBF) ||
(c0 == 0xEF && p[0] == 0xBF && p[1] >= 0x80 && p[1] <= 0xBD))) {
// Matched legal triple-octet sequence. Skip the next two octets.
*out << (char)c0 << (char)p[0] << (char)p[1];
if (!out->good()) {
return false;
}
(void)in->Get();
(void)in->Get();
} else if (in->Peek(3, p) == 3 && c0 >= 0xF0 && c0 <= 0xF7 &&
p[0] >= 0x80 && p[0] <= 0xBF && p[1] >= 0x80 && p[1] <= 0xBF &&
p[2] >= 0x80 && p[2] <= 0xBF) {
// Matched legal quadruple-octet sequence. Skip the next three octets.
*out << (char)c0 << (char)p[0] << (char)p[1] << (char)p[2];
if (!out->good()) {
return false;
}
(void)in->Get();
(void)in->Get();
(void)in->Get();
} else {
// Illegal octet; replace.
*out << (char)'?';
if (!out->good()) {
return false;
}
}
}
return c0 == IFStream::kIFStreamErrorEOF;
}
bool GetTestName(std::wstring* result) {
if (!GetEnv(L"TEST_BINARY", result) || result->empty()) {
LogError(__LINE__, L"Failed to get test name");
return false;
}
if (result->size() >= 2 && (*result)[0] == '.' && (*result)[1] == '/') {
result->erase(0, 2);
}
// Ensure that test shards have unique names in the xml output, by including
// the shard index in the test name.
std::wstring total_shards_str;
int total_shards = 0, shard_index = 0;
if (!GetIntEnv(L"TEST_TOTAL_SHARDS", &total_shards_str, &total_shards)) {
LogError(__LINE__);
return false;
}
if (total_shards > 0) {
std::wstring shard_index_str;
if (!GetIntEnv(L"TEST_SHARD_INDEX", &shard_index_str, &shard_index) ||
shard_index_str.empty()) {
LogError(__LINE__);
return false;
}
std::wstringstream stm;
stm << *result << L"_shard_" << (shard_index + 1) << L"/"
<< total_shards_str;
*result = stm.str();
}
return true;
}
std::string CreateErrorTag(int exit_code) {
if (exit_code != 0) {
std::stringstream ss;
ss << "<error message=\"exited with error code " << exit_code
<< "\"></error>";
return ss.str();
} else {
return std::string();
}
}
bool ShouldCreateXml(const Path& xml_log, const MainType main_type,
bool* result) {
*result = true;
// If running from the xml generator binary, we should always create the xml
// file.
if (main_type == MainType::kXmlWriterMain) {
return true;
}
DWORD attr = GetFileAttributesW(AddUncPrefixMaybe(xml_log).c_str());
if (attr != INVALID_FILE_ATTRIBUTES) {
// The XML file already exists, maybe the test framework wrote it.
// Leave the file alone.
*result = false;
return true;
}
std::wstring split_xml_generation;
if (!GetEnv(L"EXPERIMENTAL_SPLIT_XML_GENERATION", &split_xml_generation)) {
LogError(__LINE__, "Failed to get %EXPERIMENTAL_SPLIT_XML_GENERATION%");
return false;
}
if (split_xml_generation == L"1") {
// Bazel generates the test xml as a separate action, so we don't have to
// create it.
*result = false;
}
return true;
}
bool CreateXmlLog(const Path& output, const Path& test_outerr,
const Duration duration, const int exit_code,
const DeleteAfterwards delete_afterwards,
const MainType main_type) {
bool should_create_xml;
if (!ShouldCreateXml(output, main_type, &should_create_xml)) {
LogErrorWithArg(__LINE__, "Failed to decide if XML log is needed",
output.Get());
return false;
}
if (!should_create_xml) {
return true;
}
Defer delete_test_outerr([test_outerr, delete_afterwards]() {
// Delete the test's outerr file after we have the XML file.
// We don't care if this succeeds or not, because the outerr file is not a
// declared output.
if (delete_afterwards == DeleteAfterwards::kEnabled) {
DeleteFileW(test_outerr.Get().c_str());
}
});
std::wstring test_name;
int errors = (exit_code == 0) ? 0 : 1;
std::string error_msg = CreateErrorTag(exit_code);
if (!GetTestName(&test_name)) {
LogError(__LINE__);
return false;
}
std::string acp_test_name;
if (!WcsToAcp(test_name, &acp_test_name)) {
LogError(__LINE__, test_name.c_str());
return false;
}
bazel::windows::AutoHandle test_log;
if (!OpenExistingFileForRead(test_outerr, &test_log)) {
LogError(__LINE__, test_outerr.Get().c_str());
return false;
}
std::unique_ptr<IFStream> istm(IFStreamImpl::Create(test_log));
if (istm == nullptr) {
LogError(__LINE__, test_outerr.Get().c_str());
return false;
}
std::ofstream ostm(
AddUncPrefixMaybe(output).c_str(),
std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
if (!ostm.is_open() || !ostm.good()) {
LogError(__LINE__, output.Get().c_str());
return false;
}
// Create XML file stub.
ostm << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
"<testsuites>\n"
"<testsuite name=\""
<< acp_test_name << "\" tests=\"1\" failures=\"0\" errors=\"" << errors
<< "\">\n"
"<testcase name=\""
<< acp_test_name << "\" status=\"run\" duration=\"" << duration.seconds
<< "\" time=\"" << duration.seconds << "\">" << error_msg
<< "</testcase>\n"
"<system-out><![CDATA[";
if (!ostm.good()) {
LogError(__LINE__, output.Get().c_str());
return false;
}
// Encode test log to make it embeddable in CDATA.
if (!CdataEscape(istm.get(), &ostm)) {
LogError(__LINE__, output.Get().c_str());
return false;
}
// Append CDATA end and closing tags.
ostm << "]]></system-out>\n</testsuite>\n</testsuites>\n";
if (!ostm.good()) {
LogError(__LINE__, output.Get().c_str());
return false;
}
return true;
}
bool Duration::FromString(const wchar_t* str) {
int result;
if (!ToInt(str, &result)) {
LogErrorWithArg(__LINE__, "Failed to parse int from string", str);
return false;
}
this->seconds = result;
return true;
}
bool Path::Set(const std::wstring& path) {
std::wstring result;
std::string error;
if (!blaze_util::AsWindowsPath(path, &result, &error)) {
LogError(__LINE__, error);
return false;
}
path_ = result;
return true;
}
bool Path::Absolutize(const Path& cwd) {
if (!path_.empty() && !blaze_util::IsAbsolute(path_)) {
// Both paths are normalized, but this->path_ may begin with ".."s so we
// must normalize after joining.
// We wouldn't need full normalization, just normlize at the joined edges,
// but let's keep the code simple and normalize fully. (AsWindowsPath in
// Set normalizes.)
return Set(cwd.path_ + L"\\" + path_);
} else {
return false;
}
}
Path Path::Dirname() const {
Path result;
result.path_ = blaze_util::SplitPathW(path_).first;
return result;
}
IFStream* IFStreamImpl::Create(HANDLE handle, DWORD page_size) {
std::unique_ptr<uint8_t[]> data(new uint8_t[page_size * 2]);
DWORD read;
if (!ReadFile(handle, data.get(), page_size * 2, &read, nullptr)) {
DWORD err = GetLastError();
if (err == ERROR_BROKEN_PIPE) {
read = 0;
} else {
LogErrorWithValue(__LINE__, "Failed to read from file", err);
return nullptr;
}
}
return new IFStreamImpl(handle, std::move(data), read, page_size);
}
int IFStreamImpl::Get() {
if (pos_ == end_) {
return kIFStreamErrorEOF;
}
int result = pages_[pos_];
if (pos_ + 1 < end_) {
pos_++;
return result;
}
// Overwrite the *active* page: we are about to move off of it.
DWORD offs = (pos_ < page_size_) ? 0 : page_size_;
DWORD read;
if (!ReadFile(handle_, pages_.get() + offs, page_size_, &read, nullptr)) {
DWORD err = GetLastError();
if (err == ERROR_BROKEN_PIPE) {
// The stream is reading from a pipe, and there's no more data.
} else {
LogErrorWithValue(__LINE__, "Failed to read from file", err);
return kIFStreamErrorIO;
}
}
pos_ = (pos_ < page_size_) ? page_size_ : 0;
end_ = pos_ + next_size_;
next_size_ = read;
return result;
}
DWORD IFStreamImpl::Peek(DWORD n, uint8_t* out) const {
if (pos_ == end_) {
return 0;
}
DWORD n1 = end_ - pos_;
if (n1 > n) {
n1 = n; // all 'n' bytes are on the current page
}
memcpy(out, pages_.get() + pos_, n1);
if (n1 == n) {
return n;
}
DWORD offs = (pos_ < page_size_) ? page_size_ : 0;
DWORD n2 = n - n1; // how much is left to read
if (n2 > next_size_) {
n2 = next_size_; // read no more than the other page's size
}
memcpy(out + n1, pages_.get() + offs, n2);
return n1 + n2;
}
} // namespace
void ZipEntryPaths::Create(const std::string& root,
const std::vector<std::string>& relative_paths) {
size_ = relative_paths.size();
size_t total_size = 0;
for (const auto& e : relative_paths) {
// Increase total size for absolute paths by <root> + "/" + <path> +
// null-terminator.
total_size += root.size() + 1 + e.size() + 1;
}
// Store all absolute paths in one continuous char array.
abs_paths_.reset(new char[total_size]);
// Store pointers in two arrays. The pointers point into `abs_path`.
// We'll pass these paths to devtools_ijar::ZipBuilder::EstimateSize that
// expects an array of char pointers. The last element must be NULL, so
// allocate one extra pointer.
abs_path_ptrs_.reset(new char*[relative_paths.size() + 1]);
entry_path_ptrs_.reset(new char*[relative_paths.size() + 1]);
char* p = abs_paths_.get();
// Create all full paths (root + '/' + relative_paths[i] + '\0').
//
// If `root` is "c:/foo", then store the following:
//
// - Store each absolute path consecutively in `abs_paths_` (via `p`).
// Store paths with forward slashes and not backslashes, because we use them
// as zip entry paths, as well as paths we open with CreateFileA (which can
// convert these paths internally to Windows-style).
// Example: "c:/foo/bar.txt\0c:/foo/sub/baz.txt\0"
//
// - Store pointers in `abs_path_ptrs_`, pointing to the start of each
// string inside `abs_paths_`.
// Example: "c:/foo/bar.txt\0c:/foo/sub/baz.txt\0"
// ^ here ^ here
//
// - Store pointers in `entry_path_ptrs_`, pointing to the start of each
// zip entry path inside `abs_paths_`, which is the part of each path
// that's relative to `root`.
// Example: "c:/foo/bar.txt\0c:/foo/sub/baz.txt\0"
// ^ here ^ here
//
// - Because the ZipBuilder requires that the file paths and zip entry paths
// are null-terminated arrays, we insert an extra null at their ends.
for (size_t i = 0; i < relative_paths.size(); ++i) {
abs_path_ptrs_.get()[i] = p;
strncpy(p, root.c_str(), root.size());
p += root.size();
*p++ = '/';
entry_path_ptrs_.get()[i] = p;
strncpy(p, relative_paths[i].c_str(), relative_paths[i].size() + 1);
p += relative_paths[i].size() + 1;
}
abs_path_ptrs_.get()[relative_paths.size()] = nullptr;
entry_path_ptrs_.get()[relative_paths.size()] = nullptr;
}
int TestWrapperMain(int argc, wchar_t** argv) {
Path argv0;
std::wstring test_path_arg;
Path test_path, exec_root, srcdir, tmpdir, test_outerr, xml_log;
UndeclaredOutputs undecl;
std::wstring args;
if (!AddCurrentDirectoryToPATH() ||
!ParseArgs(argc, argv, &argv0, &test_path_arg, &args) ||
!PrintTestLogStartMarker() || !GetCwd(&exec_root) || !ExportUserName() ||
!ExportSrcPath(exec_root, &srcdir) ||
!FindTestBinary(argv0, exec_root, test_path_arg, srcdir, &test_path) ||
!ChdirToRunfiles(exec_root, srcdir) ||
!ExportTmpPath(exec_root, &tmpdir) || !ExportHome(tmpdir) ||
!ExportRunfiles(exec_root, srcdir) || !ExportShardStatusFile(exec_root) ||
!ExportGtestVariables(tmpdir) || !ExportMiscEnvvars(exec_root) ||
!ExportXmlPath(exec_root, &test_outerr, &xml_log) ||
!GetAndUnexportUndeclaredOutputsEnvvars(exec_root, &undecl)) {
return 1;
}
Duration test_duration;
int result = RunSubprocess(test_path, args, test_outerr, &test_duration);
if (!CreateXmlLog(xml_log, test_outerr, test_duration, result,
DeleteAfterwards::kEnabled, MainType::kTestWrapperMain) ||
!ArchiveUndeclaredOutputs(undecl) ||
!CreateUndeclaredOutputsAnnotations(undecl.annotations_dir,
undecl.annotations)) {
return 1;
}
return result;
}
int XmlWriterMain(int argc, wchar_t** argv) {
Path cwd, test_outerr, test_xml_log;
Duration duration;
int exit_code = 0;
if (!GetCwd(&cwd) ||
!ParseXmlWriterArgs(argc, argv, cwd, &test_outerr, &test_xml_log,
&duration, &exit_code) ||
!CreateXmlLog(test_xml_log, test_outerr, duration, exit_code,
DeleteAfterwards::kDisabled, MainType::kXmlWriterMain)) {
return 1;
}
return 0;
}
namespace testing {
bool TestOnly_GetEnv(const wchar_t* name, std::wstring* result) {
return GetEnv(name, result);
}
bool TestOnly_GetFileListRelativeTo(const std::wstring& abs_root,
std::vector<FileInfo>* result,
int depth_limit) {
Path root;
return blaze_util::IsAbsolute(abs_root) && root.Set(abs_root) &&
GetFileListRelativeTo(root, result, depth_limit);
}
bool TestOnly_ToZipEntryPaths(const std::wstring& abs_root,
const std::vector<FileInfo>& files,
ZipEntryPaths* result) {
Path root;
return blaze_util::IsAbsolute(abs_root) && root.Set(abs_root) &&
ToZipEntryPaths(root, files, result);
}
bool TestOnly_CreateZip(const std::wstring& abs_root,
const std::vector<FileInfo>& files,
const std::wstring& abs_zip) {
Path root, zip;
return blaze_util::IsAbsolute(abs_root) && root.Set(abs_root) &&
blaze_util::IsAbsolute(abs_zip) && zip.Set(abs_zip) &&
CreateZip(root, files, zip);
}
std::string TestOnly_GetMimeType(const std::string& filename) {
return GetMimeType(filename);
}
bool TestOnly_CreateUndeclaredOutputsManifest(
const std::vector<FileInfo>& files, std::string* result) {
return CreateUndeclaredOutputsManifestContent(files, result);
}
bool TestOnly_CreateUndeclaredOutputsAnnotations(
const std::wstring& abs_root, const std::wstring& abs_output) {
Path root, output;
return blaze_util::IsAbsolute(abs_root) && root.Set(abs_root) &&
blaze_util::IsAbsolute(abs_output) && output.Set(abs_output) &&
CreateUndeclaredOutputsAnnotations(root, output);
}
bool TestOnly_AsMixedPath(const std::wstring& path, std::string* result) {
Path p;
return p.Set(path) && WcsToAcp(AsMixedPath(RemoveUncPrefixMaybe(p)), result);
}
bool TestOnly_CreateTee(bazel::windows::AutoHandle* input,
bazel::windows::AutoHandle* output1,
bazel::windows::AutoHandle* output2,
std::unique_ptr<Tee>* result) {
return TeeImpl::Create(input, output1, output2, result);
}
bool TestOnly_CdataEncode(IFStream* in_stm, std::basic_ostream<char>* out_stm) {
return CdataEscape(in_stm, out_stm);
}
IFStream* TestOnly_CreateIFStream(HANDLE handle, DWORD page_size) {
return IFStreamImpl::Create(handle, page_size);
}
} // namespace testing
} // namespace test_wrapper
} // namespace tools
} // namespace bazel
|