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
|
// file : bbot/worker.cxx -*- C++ -*-
// license : TBC; see accompanying LICENSE file
#ifndef _WIN32
# include <signal.h> // signal()
#else
# include <libbutl/win32-utility.hxx>
#endif
#include <map>
#include <regex>
#include <cstring> // strchr()
#include <sstream>
#include <iostream>
#include <algorithm> // find()
#include <libbutl/b.mxx>
#include <libbutl/pager.mxx>
#include <libbutl/utility.mxx> // to_utf8()
#include <libbutl/filesystem.mxx>
#include <libbutl/string-parser.mxx>
#include <libbbot/manifest.hxx>
#include <bbot/types.hxx>
#include <bbot/utility.hxx>
#include <bbot/diagnostics.hxx>
#include <bbot/bootstrap-manifest.hxx>
#include <bbot/worker/worker-options.hxx>
using namespace butl;
using namespace bbot;
using std::cout;
using std::endl;
namespace bbot
{
int
main (int argc, char* argv[]);
static int
build (size_t argc, const char* argv[]);
process_path argv0;
worker_options ops;
dir_path env_dir;
const size_t tftp_timeout (10); // 10 seconds.
const size_t tftp_retries (3); // Task request retries (see startup()).
}
static dir_path
current_directory ()
try
{
return dir_path::current_directory ();
}
catch (const system_error& e)
{
fail << "unable to obtain current directory: " << e << endf;
}
static dir_path
change_wd (tracer& t, string* log, const dir_path& d, bool create = false)
try
{
if (create)
{
if (verb >= 3)
t << "mkdir -p " << d;
if (log != nullptr)
*log += "mkdir -p " + d.representation () + '\n';
try_mkdir_p (d);
}
dir_path r (current_directory ());
if (verb >= 3)
t << "cd " << d;
if (log != nullptr)
*log += "cd " + d.representation () + '\n';
dir_path::current_directory (d);
return r;
}
catch (const system_error& e)
{
fail << "unable to change current directory to " << d << ": " << e << endf;
}
using std::regex;
namespace regex_constants = std::regex_constants;
using regexes = vector<regex>;
// Run a named command. Name is used for logging and diagnostics only. Match
// lines read from the command's stderr against the regular expressions and
// return the warning result status (instead of success) in case of a match.
//
template <typename... A>
static result_status
run_cmd (tracer& t,
string& log, const regexes& warn_detect,
const string& name,
const process_env& pe,
A&&... a)
{
try
{
// Trace and log the command line.
//
auto cmdc = [&t, &log] (const char* c[], size_t n)
{
t (c, n);
std::ostringstream os;
process::print (os, c, n);
log += os.str ();
log += '\n';
};
fdpipe pipe (fdopen_pipe ()); // Text mode seems appropriate.
process pr (
process_start_callback (cmdc,
fdopen_null (), // Never reads from stdin.
2, // 1>&2
pipe,
pe,
forward<A> (a)...));
pipe.out.close ();
result_status r (result_status::success);
// UTF-8-sanitize and log the diagnostics. Also print the raw diagnostics
// to stderr at verbosity level 3 or higher.
//
auto add = [&log, &t] (string&& s, bool trace = true)
{
if (verb >= 3)
{
if (trace)
t << s;
else
text << s;
}
to_utf8 (s, '?');
log += s;
log += '\n';
};
{
ifdstream is (move (pipe.in), fdstream_mode::skip); // Skip on exception.
for (string l; is.peek () != ifdstream::traits_type::eof (); )
{
getline (is, l);
// Match the log line with the warning-detecting regular expressions
// until the first match.
//
if (r != result_status::warning)
{
for (const regex& re: warn_detect)
{
// Only examine the first 512 bytes. Long lines (e.g., linker
// command lines) could trigger implementation-specific limitations
// (like stack overflow). Plus, it is a performance concern.
//
if (regex_search (l.begin (),
l.size () < 512 ? l.end () : l.begin () + 512,
re))
{
r = result_status::warning;
break;
}
}
}
add (move (l), false /* trace */);
}
}
if (pr.wait ())
return r;
const process_exit& e (*pr.exit);
add (name + " " + to_string (e));
return e.normal () ? result_status::error : result_status::abnormal;
}
catch (const process_error& e)
{
fail << "unable to execute " << name << ": " << e << endf;
}
catch (const io_error& e)
{
fail << "unable to read " << name << " diagnostics: " << e << endf;
}
}
template <typename V, typename... A>
static result_status
run_bpkg (const V& envvars,
tracer& t,
string& log, const regexes& warn_detect,
const char* verbosity,
const string& cmd, A&&... a)
{
return run_cmd (t,
log, warn_detect,
"bpkg " + cmd,
process_env ("bpkg", envvars),
verbosity, cmd, forward<A> (a)...);
}
template <typename... A>
static result_status
run_bpkg (tracer& t,
string& log, const regexes& warn_detect,
const char* verbosity,
const string& cmd, A&&... a)
{
const char* const* envvars (nullptr);
return run_bpkg (envvars,
t,
log, warn_detect,
verbosity, cmd, forward<A> (a)...);
}
template <typename V, typename... A>
static result_status
run_b (const V& envvars,
tracer& t,
string& log, const regexes& warn_detect,
const char* verbosity,
const strings& buildspecs, A&&... a)
{
string name ("b");
for (const string& s: buildspecs)
{
if (!name.empty ())
name += ' ';
name += s;
}
return run_cmd (t,
log, warn_detect,
name,
process_env ("b", envvars),
verbosity, buildspecs, forward<A> (a)...);
}
template <typename V, typename... A>
static result_status
run_b (const V& envvars,
tracer& t,
string& log, const regexes& warn_detect,
const char* verbosity,
const string& buildspec, A&&... a)
{
return run_cmd (t,
log, warn_detect,
"b " + buildspec,
process_env ("b", envvars),
verbosity, buildspec, forward<A> (a)...);
}
template <typename... A>
static result_status
run_b (tracer& t,
string& log, const regexes& warn_detect,
const char* verbosity,
const string& buildspec, A&&... a)
{
const char* const* envvars (nullptr);
return run_b (envvars,
t,
log, warn_detect,
verbosity, buildspec, forward<A> (a)...);
}
static int bbot::
build (size_t argc, const char* argv[])
{
using namespace bpkg;
using string_parser::unquote;
tracer trace ("build");
// Our overall plan is as follows:
//
// 1. Parse the task manifest (it should be in CWD).
//
// 2. Run bpkg to create the configuration, add the repository, and
// configure, build, test, optionally install, test installed and
// uninstall the package all while saving the logs in the result manifest.
//
// 3. Upload the result manifest.
//
// Note also that we are being "watched" by the startup version of us which
// will upload an appropriate result in case we exit with an error. So here
// for abnormal situations (like a failure to parse the manifest), we just
// fail.
//
task_manifest tm (
parse_manifest<task_manifest> (path ("task.manifest"), "task"));
result_manifest rm {
tm.name,
tm.version,
result_status::success,
operation_results {}
};
// Reserve storage large enough to hold all the potential operation results
// without reallocations. Note that this is not an optimization but is
// required to make sure that element references are not invalidated when
// new results are added.
//
size_t max_results (6);
rm.results.reserve (max_results);
auto add_result = [&rm, max_results] (string o) -> operation_result&
{
assert (rm.results.size () < max_results);
rm.results.push_back (
operation_result {move (o), result_status::success, ""});
return rm.results.back ();
};
// Note that we don't consider the build system module configuring and
// testing during the "pre-step" as separate operations and share the
// operation logs with the "main" configure and test steps (see below).
// Thus, we save pointers to the added result objects for the subsequent
// use.
//
operation_result* configure_result (nullptr);
operation_result* test_result (nullptr);
dir_path rwd; // Root working directory.
for (;;) // The "breakout" loop.
{
// Regular expressions that detect different forms of build2 toolchain
// warnings. Accidently (or not), they also cover GCC and Clang warnings
// (for the English locale).
//
// The expressions will be matched multiple times, so let's make the
// matching faster, with the potential cost of making regular expressions
// creation slower.
//
regex::flag_type f (regex_constants::optimize); // ECMAScript is implied.
regexes wre {
regex ("^warning: ", f),
regex ("^.+: warning: ", f)};
for (const string& re: tm.unquoted_warning_regex ())
wre.emplace_back (re, f);
// Step IDs.
//
enum class step_id
{
bpkg_configure_create,
bpkg_configure_add,
bpkg_configure_fetch,
bpkg_configure_build,
bpkg_update_update,
bpkg_test_test,
bpkg_install_install,
b_test_installed_create,
b_test_installed_configure,
b_test_installed_test,
bpkg_test_installed_create,
bpkg_uninstall_uninstall
};
const strings step_id_str {
"bpkg.configure.create",
"bpkg.configure.add",
"bpkg.configure.fetch",
"bpkg.configure.build",
"bpkg.update.update",
"bpkg.test.test",
"bpkg.install.install",
"b.test-installed.create",
"b.test-installed.configure",
"b.test-installed.test",
"bpkg.test-installed.create",
"bpkg.uninstall.uninstall"};
// Split the argument into prefix (empty if not present) and unquoted
// value. Return nullopt if the prefix is invalid.
//
auto parse_arg =
[&step_id_str] (const string& a) -> optional<pair<string, string>>
{
size_t p (a.find_first_of (":=\"'"));
if (p == string::npos || a[p] != ':') // No prefix.
return make_pair (string (), unquote (a));
for (const string& id: step_id_str)
{
if (a.compare (0, p, id, 0, p) == 0 &&
(id.size () == p || (id.size () > p && id[p] == '.')))
return make_pair (a.substr (0, p), unquote (a.substr (p + 1)));
}
return nullopt; // Prefix is invalid.
};
// Enter split arguments into a map. Those without a prefix are
// entered for the *.create steps.
//
auto add_arg = [] (std::multimap<string, string>& args,
pair<string, string>&& a)
{
if (!a.first.empty ())
args.emplace (move (a));
else
{
args.emplace ("bpkg.configure.create", a.second);
args.emplace ("b.test-installed.create", a.second);
args.emplace ("bpkg.test-installed.create", move (a.second));
}
};
// Parse configuration arguments. Report failures to the bbot controller.
//
std::multimap<string, string> config_args;
for (const string& c: tm.config)
{
optional<pair<string, string>> v (parse_arg (c));
if (!v)
{
rm.status |= result_status::abort;
l3 ([&]{trace << "invalid configuration argument prefix in "
<< "'" << c << "'";});
break;
}
if (v->second[0] != '-' && v->second.find ('=') == string::npos)
{
rm.status |= result_status::abort;
l3 ([&]{trace << "invalid configuration argument '" << c << "'";});
break;
}
add_arg (config_args, move (*v));
}
if (!rm.status)
break;
// Parse environment arguments.
//
std::multimap<string, string> modules;
std::multimap<string, string> env_args;
for (size_t i (1); i != argc; ++i)
{
const char* a (argv[i]);
optional<pair<string, string>> v (parse_arg (a));
if (!v)
fail << "invalid environment argument prefix in '" << a << "'";
bool mod (v->second[0] != '-' && v->second.find ('=') == string::npos);
if (mod && !v->first.empty () &&
v->first != "bpkg.configure.create" &&
v->first != "b.test-installed.create")
fail << "invalid module prefix in '" << a << "'";
add_arg (mod ? modules : env_args, move (*v));
}
// Return command arguments for the specified step id. Arguments with more
// specific prefixes come last.
//
auto step_args = [&step_id_str] (const std::multimap<string, string>& args,
step_id step) -> strings
{
strings r;
const string& s (step_id_str[static_cast<size_t> (step)]);
for (size_t n (0);; ++n)
{
n = s.find ('.', n);
auto range (
args.equal_range (n == string::npos ? s : string (s, 0, n)));
for (auto i (range.first); i != range.second; ++i)
r.emplace_back (i->second);
if (n == string::npos)
break;
}
return r;
};
// Search for config.install.root variable. If it is present and has a
// non-empty value, then test the package installation and uninstall. Note
// that passing [null] value would be meaningless, so we don't recognize it
// as a special one. While at it, cache the bpkg.configure.create args for
// later use.
//
dir_path install_root;
strings cargs (step_args (config_args, step_id::bpkg_configure_create));
{
size_t n (19);
auto space = [] (char c) {return c == ' ' || c == '\t';};
for (const string& s: reverse_iterate (cargs))
{
if (s.compare (0, n, "config.install.root") == 0 &&
(s[n] == '=' || space (s[n])))
{
while (space (s[n])) ++n; // Skip spaces.
if (s[n] == '=') ++n; // Skip the equal sign.
while (space (s[n])) ++n; // Skip spaces.
// Note that the config.install.root variable value may
// potentially be quoted.
//
install_root = dir_path (unquote (string (s, n, s.size () - n)));
break;
}
}
}
// bpkg-rep-fetch trust options.
//
cstrings trust_ops;
{
const char* t ("--trust-no");
for (const string& fp: tm.trust)
{
if (fp == "yes")
t = "--trust-yes";
else
{
trust_ops.push_back ("--trust");
trust_ops.push_back (fp.c_str ());
}
}
trust_ops.push_back (t);
}
const string& pkg (tm.name.string ());
const version& ver (tm.version);
const string repo (tm.repository.string ());
const dir_path pkg_dir (pkg + '-' + ver.string ());
// Specify the revision explicitly for the bpkg-build command not to end
// up with a race condition building the latest revision rather than the
// zero revision.
//
const string pkg_rev (pkg +
'/' +
version (ver.epoch,
ver.upstream,
ver.release,
ver.effective_revision (),
ver.iteration).string ());
// Query the project's build system information with `b info`.
//
auto prj_info = [&trace] (const dir_path& d, const char* what)
{
// Note that the `b info` diagnostics won't be copied into any of the
// build logs. This is fine as this is likely to be an infrastructure
// problem, given that the project distribution has been successfully
// created. It's actually not quite clear which log this diagnostics
// could go into.
//
try
{
return b_info (d, verb, trace);
}
catch (const b_error& e)
{
if (e.normal ())
throw failed (); // Assume the build2 process issued diagnostics.
fail << "unable to query " << what << ' ' << d << " info: " << e
<< endf;
}
};
b_project_info prj; // Package project information.
// If this is a build system module, perform a "pre-step" by building it
// in a separate configuration reproducing the one used to build build2
// itself. Note that the configuration and the environment options and
// variables are not passed to commands that may affect this
// configuration.
//
bool module (pkg.compare (0, 10, "libbuild2-") == 0);
dir_path module_dir ("build-module");
rwd = current_directory ();
if (module)
{
// Configure.
//
{
operation_result& r (add_result ("configure"));
configure_result = &r;
// Noop, just for the log record.
//
change_wd (trace, &r.log, rwd);
// b create(<dir>) config.config.load=~build2
//
// Note also that we suppress warnings about unused config.* values,
// such CLI configuration.
//
// What if a module wants to use CLI? The current thinking is that we
// will be "whitelisting" base (i.e., those that can plausibly be used
// by multiple modules) libraries and tools for use by build system
// modules. So if and when we whitelist CLI, we will add it here, next
// to cc.
//
r.status |= run_b (
trace, r.log, wre,
"-V",
"create(" + module_dir.representation () + ",cc)",
"config.config.load=~build2",
"config.config.persist+='config.*'@unused=drop");
if (!r.status)
break;
change_wd (trace, &r.log, module_dir);
// bpkg create --existing
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"create",
"--existing");
if (!r.status)
break;
// bpkg add <env-config-args> <config-args> <repository-url>
//
// bpkg.configure.add
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"add",
step_args (env_args, step_id::bpkg_configure_add),
step_args (config_args, step_id::bpkg_configure_add),
repo);
if (!r.status)
break;
// bpkg fetch <env-config-args> <config-args> <trust-options>
//
// bpkg.configure.fetch
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"fetch",
step_args (env_args, step_id::bpkg_configure_fetch),
step_args (config_args, step_id::bpkg_configure_fetch),
trust_ops);
if (!r.status)
break;
// bpkg build --configure-only <package-name>/<package-version>
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"build",
"--configure-only",
"--yes",
pkg_rev);
if (!r.status)
break;
rm.status |= r.status;
}
// Update.
//
{
operation_result& r (add_result ("update"));
// Noop, just for the log record to reduce the potential confusion for
// the combined log reader due to the configure operation log sharing
// (see above for details).
//
change_wd (trace, &r.log, current_directory ());
// bpkg update <package-name>
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"update",
pkg);
if (!r.status)
break;
rm.status |= r.status;
}
// Run the package internal tests if the test operation is supported by
// the project.
//
prj = prj_info (pkg_dir, "project");
if (find (prj.operations.begin (), prj.operations.end (), "test") !=
prj.operations.end ())
{
operation_result& r (add_result ("test"));
test_result = &r;
// Use --package-cwd to help ported to build2 third-party packages a
// bit (see bpkg-pkg-test(1) for details).
//
// bpkg test <package-name>
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"test",
"--package-cwd",
pkg);
if (!r.status)
break;
rm.status |= r.status;
}
}
// The "main" step.
//
// Configure.
//
dir_path build_dir ("build"); // Configuration directory name.
dir_path pkg_config (rwd / (module ? module_dir : build_dir));
{
operation_result& r (configure_result != nullptr
? *configure_result
: add_result ("configure"));
change_wd (trace, &r.log, rwd);
// bpkg create <env-modules> <env-config-args> <config-args>
//
// bpkg.configure.create
//
{
// If the package is a build system module, then make sure it is
// importable in this configuration.
//
string import (module
? ("config.import." + tm.name.variable () + "=" +
module_dir.string ())
: "");
r.status |= run_bpkg (
trace, r.log, wre,
"-V",
"create",
"-d", build_dir.string (),
"--wipe",
step_args (modules, step_id::bpkg_configure_create),
step_args (env_args, step_id::bpkg_configure_create),
cargs,
import.empty () ? nullptr : import.c_str ());
if (!r.status)
break;
}
change_wd (trace, &r.log, build_dir);
// bpkg add <env-config-args> <config-args> <repository-url>
//
// bpkg.configure.add
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"add",
step_args (env_args, step_id::bpkg_configure_add),
step_args (config_args, step_id::bpkg_configure_add),
repo);
if (!r.status)
break;
// bpkg fetch <env-config-args> <config-args> <trust-options>
//
// bpkg.configure.fetch
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"fetch",
step_args (env_args, step_id::bpkg_configure_fetch),
step_args (config_args, step_id::bpkg_configure_fetch),
trust_ops);
if (!r.status)
break;
// bpkg build --configure-only <env-config-args> <config-args>
// <package-name>/<package-version>
//
// bpkg.configure.build
//
if (!module) // Note: the module is already built in the pre-step.
{
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"build",
"--configure-only",
"--yes",
step_args (env_args, step_id::bpkg_configure_build),
step_args (config_args, step_id::bpkg_configure_build),
"--",
pkg_rev);
if (!r.status)
break;
}
rm.status |= r.status;
}
// Update.
//
if (!module) // Note: the module is already built in the pre-step.
{
operation_result& r (add_result ("update"));
// bpkg update <env-config-args> <config-args> <package-name>
//
// bpkg.update.update
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"update",
step_args (env_args, step_id::bpkg_update_update),
step_args (config_args, step_id::bpkg_update_update),
pkg);
if (!r.status)
break;
rm.status |= r.status;
}
// Run the package internal tests if the test operation is supported by
// the project, except for the build system module which is taken care of
// in the pre-step.
//
bool internal_tests;
if (module)
internal_tests = false;
else
{
prj = prj_info (pkg_dir, "project");
internal_tests = find (prj.operations.begin (),
prj.operations.end (),
"test") != prj.operations.end ();
}
// Parse the package manifest.
//
// Note that being unable to parse the package manifest is likely to be an
// infrastructure problem, given that the package has been successfully
// configured.
//
path mf (pkg_config / pkg_dir / "manifest");
package_manifest pm (parse_manifest<package_manifest> (mf, "package"));
// Run the package external tests if any of the tests, examples, or
// benchmarks manifest values are specified.
//
// Note that we assume that these packages belong to the dependent
// package's repository or its complement repositories, recursively. Thus,
// we test them in the configuration used to build the dependent package
// (except for the build system module).
//
bool external_tests (!pm.tests.empty () ||
!pm.examples.empty () ||
!pm.benchmarks.empty ());
// Configure, update, and test packages in the bpkg configuration in the
// current working directory. Optionally set the environment variables for
// bpkg processes. Return true if all operations for all packages succeed.
//
auto test = [&trace, &wre, &step_args, &config_args, &env_args]
(const small_vector<dependency, 1>& pkgs,
operation_result& r,
const small_vector<string, 1>& envvars = {})
{
for (const dependency& d: pkgs)
{
const string& pkg (d.name.string ());
// Configure.
//
// bpkg build --configure-only <env-config-args> <config-args>
// '<package-name>[ <version-constraint>]'
//
// bpkg.configure.build
//
r.status |= run_bpkg (
envvars,
trace, r.log, wre,
"-v",
"build",
"--configure-only",
"--yes",
step_args (env_args, step_id::bpkg_configure_build),
step_args (config_args, step_id::bpkg_configure_build),
"--",
d.string ());
if (!r.status)
return false;
// Update.
//
// bpkg update <env-config-args> <config-args> <package-name>
//
// bpkg.update.update
//
r.status |= run_bpkg (
envvars,
trace, r.log, wre,
"-v",
"update",
step_args (env_args, step_id::bpkg_update_update),
step_args (config_args, step_id::bpkg_update_update),
pkg);
if (!r.status)
return false;
// Test.
//
// Note that we assume that the package supports the test operation
// since this is its main purpose.
//
// bpkg test <env-config-args> <config-args> <package-name>
//
// bpkg.test.test
//
r.status |= run_bpkg (
envvars,
trace, r.log, wre,
"-v",
"test",
"--package-cwd", // See above for details.
step_args (env_args, step_id::bpkg_test_test),
step_args (config_args, step_id::bpkg_test_test),
pkg);
if (!r.status)
return false;
}
return true;
};
if (internal_tests || external_tests)
{
operation_result& r (test_result != nullptr
? *test_result
: add_result ("test"));
// Run internal tests.
//
if (internal_tests)
{
// bpkg test <env-config-args> <config-args> <package-name>
//
// bpkg.test.test
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"test",
"--package-cwd", // See above for details.
step_args (env_args, step_id::bpkg_test_test),
step_args (config_args, step_id::bpkg_test_test),
pkg);
if (!r.status)
break;
}
// Run external tests.
//
if (external_tests)
{
if (!test (pm.tests, r) ||
!test (pm.examples, r) ||
!test (pm.benchmarks, r))
break;
}
rm.status |= r.status;
}
// Install the package, optionally test the installation and uninstall
// afterwards.
//
// These operations are triggered by presence of config.install.root
// configuration variable having a non-empty value for
// bpkg.configure.create step.
//
if (install_root.empty ())
break;
// Now the overall plan is as follows:
//
// 1. Install the package.
//
// 2. If the package has subprojects that support the test operation, then
// configure, build, and test them out of the source tree against the
// installed package.
//
// 3. If any of the tests, examples, or benchmarks packages are specified,
// then configure, build, and test them in a separate bpkg
// configuration against the installed package.
//
// 4. Uninstall the package.
//
// Install.
//
{
operation_result& r (add_result ("install"));
change_wd (trace, &r.log, pkg_config);
// bpkg install <env-config-args> <config-args> <package-name>
//
// bpkg.install.install
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"install",
step_args (env_args, step_id::bpkg_install_install),
step_args (config_args, step_id::bpkg_install_install),
pkg);
if (!r.status)
break;
rm.status |= r.status;
}
// Test installed.
//
// Make sure that the installed package executables are properly imported
// when configuring and running tests, unless we are testing the build
// system module (that supposedly doesn't install any executables).
//
small_vector<string, 1> envvars;
dir_paths subprj_dirs; // "Testable" package subprojects.
// We expect the build system modules to not have any testable subprojects
// but to have external tests package instead.
//
if (module)
internal_tests = false;
else
{
// Note that we add the $config.install.root/bin directory at the
// beginning of the PATH environment variable value, so the installed
// executables are found first.
//
string paths ("PATH=" + (install_root / "bin").string ());
if (optional<string> s = getenv ("PATH"))
{
paths += path::traits_type::path_separator;
paths += *s;
}
envvars.push_back (move (paths));
// Collect the "testable" subprojects.
//
for (const b_project_info::subproject& sp: prj.subprojects)
{
// Retrieve the subproject information similar to how we've done it
// for the package.
//
b_project_info si (prj_info (pkg_dir / sp.path, "subproject"));
const strings& ops (si.operations);
if (find (ops.begin (), ops.end (), "test") != ops.end ())
subprj_dirs.push_back (sp.path);
}
// If there are any "testable" subprojects, then configure them
// (sequentially) and test/build in parallel afterwards.
//
internal_tests = !subprj_dirs.empty ();
}
if (internal_tests || external_tests)
{
operation_result& r (add_result ("test-installed"));
change_wd (trace, &r.log, rwd);
// Run internal tests.
//
if (internal_tests)
{
string mods; // build2 create meta-operation parameters.
for (const string& m: step_args (modules,
step_id::b_test_installed_create))
{
mods += mods.empty () ? ", " : " ";
mods += m;
}
// b create(<dir>, <env-modules>) <env-config-args> <config-args>
//
// b.test-installed.create
//
// Amalgamation directory that will contain configuration subdirectory
// for package tests out of source tree build.
//
dir_path out_dir ("build-installed");
r.status |= run_b (
trace, r.log, wre,
"-V",
"create('" + out_dir.representation () + "'" + mods + ")",
step_args (env_args, step_id::b_test_installed_create),
step_args (config_args, step_id::b_test_installed_create));
if (!r.status)
break;
// Configure subprojects and create buildspecs for their testing.
//
strings test_specs;
for (const dir_path& d: subprj_dirs)
{
// b configure(<subprj-src-dir>@<subprj-out-dir>) <env-config-args>
// <config-args>
//
// b.test-installed.configure
//
dir_path subprj_src_dir (build_dir / pkg_dir / d);
dir_path subprj_out_dir (out_dir / d);
r.status |= run_b (
envvars,
trace, r.log, wre,
"-v",
"configure('" +
subprj_src_dir.representation () + "'@'" +
subprj_out_dir.representation () + "')",
step_args (env_args, step_id::b_test_installed_configure),
step_args (config_args, step_id::b_test_installed_configure));
if (!r.status)
break;
test_specs.push_back (
"test('" + subprj_out_dir.representation () + "')");
}
if (!r.status)
break;
// Build/test subprojects.
//
// b test(<subprj-out-dir>)... <env-config-args> <config-args>
//
// b.test-installed.test
//
r.status |= run_b (
envvars,
trace, r.log, wre,
"-v",
test_specs,
step_args (env_args, step_id::b_test_installed_test),
step_args (config_args, step_id::b_test_installed_test));
if (!r.status)
break;
}
// Run external tests.
//
if (external_tests)
{
// Configure.
//
// bpkg create <env-modules> <env-config-args> <config-args>
//
// bpkg.test-installed.create
//
dir_path config_dir ("build-installed-bpkg");
r.status |= run_bpkg (
trace, r.log, wre,
"-V",
"create",
"-d", config_dir.string (),
"--wipe",
step_args (modules, step_id::bpkg_test_installed_create),
step_args (env_args, step_id::bpkg_test_installed_create),
step_args (config_args, step_id::bpkg_test_installed_create));
if (!r.status)
break;
change_wd (trace, &r.log, config_dir);
// bpkg add <env-config-args> <config-args> <repository-url>
//
// bpkg.configure.add
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"add",
step_args (env_args, step_id::bpkg_configure_add),
step_args (config_args, step_id::bpkg_configure_add),
repo);
if (!r.status)
break;
// bpkg fetch <env-config-args> <config-args> <trust-options>
//
// bpkg.configure.fetch
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"fetch",
step_args (env_args, step_id::bpkg_configure_fetch),
step_args (config_args, step_id::bpkg_configure_fetch),
trust_ops);
if (!r.status)
break;
// Build/test.
//
if (!test (pm.tests, r, envvars) ||
!test (pm.examples, r, envvars) ||
!test (pm.benchmarks, r, envvars))
break;
}
rm.status |= r.status;
}
// Uninstall.
//
{
operation_result& r (add_result ("uninstall"));
change_wd (trace, &r.log, pkg_config);
// bpkg uninstall <env-config-args> <config-args> <package-name>
//
// bpkg.uninstall.uninstall
//
r.status |= run_bpkg (
trace, r.log, wre,
"-v",
"uninstall",
step_args (env_args, step_id::bpkg_uninstall_uninstall),
step_args (config_args, step_id::bpkg_uninstall_uninstall),
pkg);
if (!r.status)
break;
rm.status |= r.status;
}
break;
}
if (!rm.results.empty ())
{
rm.status |= rm.results.back ().status; // Merge last in case of a break.
// Also merge statuses of the configure and test operations, which logs
// can potentially be shared across multiple steps and which results may
// not be the last in the list.
//
if (configure_result != nullptr)
rm.status |= configure_result->status;
if (test_result != nullptr)
rm.status |= test_result->status;
}
else
assert (rm.status == result_status::abort);
if (!rwd.empty ())
change_wd (trace, nullptr /* log */, rwd);
// Upload the result.
//
const string url ("tftp://" + ops.tftp_host () + "/result.manifest");
try
{
tftp_curl c (trace,
path ("-"),
nullfd,
curl::put,
url,
"--max-time", tftp_timeout);
serialize_manifest (rm, c.out, url, "result");
c.out.close ();
if (!c.wait ())
throw_generic_error (EIO);
}
catch (const system_error& e)
{
fail << "unable to upload result manifest to " << url << ": " << e;
}
// We use exit code 2 to signal abnormal termination but where we managed
// to upload the result manifest. See startup() for details.
//
return rm.status != result_status::abnormal ? 0 : 2;
}
static int
startup ()
{
tracer trace ("startup");
// Our overall plan is as follows:
//
// 1. Download the task manifest into the build directory (CWD).
//
// 2. Parse it and get the target.
//
// 3. Find the environment setup executable for this target.
//
// 4. Execute the environment setup executable.
//
// 5. If the environment setup executable fails, then upload the (failed)
// result ourselves.
//
const string url ("tftp://" + ops.tftp_host () + "/task.manifest");
const path mf ("task.manifest");
// If we fail, try to upload the result manifest (abnormal termination). The
// idea is that the machine gets suspended and we can investigate what's
// going on by logging in and examining the diagnostics (e.g., via
// journalctl, etc).
//
task_manifest tm;
try
{
// Download the task.
//
// We are downloading from our host so there shouldn't normally be any
// connectivity issues. Unless, of course, we are on Windows where all
// kinds of flakiness is business as usual. Note that having a long enough
// timeout is not enough: if we try to connect before the network is up,
// we will keep waiting forever, even after it is up. So we have to
// timeout and try again. This is also pretty bad (unlike, say during
// bootstrap which doesn't happen very often) since we are wasting the
// machine time. So we are going to log it as a warning and not merely a
// trace since if this is a common occurrence, then something has to be
// done about it.
//
for (size_t retry (1);; ++retry)
{
try
{
tftp_curl c (trace,
nullfd,
mf,
curl::get,
url,
"--max-time", tftp_timeout);
if (!c.wait ())
throw_generic_error (EIO);
break;
}
catch (const system_error& e)
{
bool bail (retry > tftp_retries);
diag_record dr (bail ? error : warn);
dr << "unable to download task manifest from " << url << " on "
<< retry << " try: " << e;
if (bail)
throw failed ();
}
}
// Parse it.
//
tm = parse_manifest<task_manifest> (mf, "task");
// Find the environment setup executable.
//
// While the executable path contains a directory (so the PATH search does
// not apply) we still use process::path_search() to automatically handle
// appending platform-specific executable extensions (.exe/.bat, etc).
//
process_path pp;
if (tm.environment)
{
try
{
pp = process::try_path_search (env_dir / *tm.environment,
false /* init */);
}
catch (const invalid_path& e)
{
fail << "invalid environment name '" << e.path << "': " << e;
}
if (pp.empty ())
fail << "no environment setup executable in " << env_dir << " "
<< "for environment name '" << *tm.environment << "'";
}
else
{
pp = process::try_path_search (env_dir / "default", false /* init */);
if (pp.empty ())
fail << "no default environment setup executable in " << env_dir;
}
// Run it.
//
strings os;
if (ops.systemd_daemon ())
os.push_back ("--systemd-daemon");
if (ops.verbose_specified ())
{
os.push_back ("--verbose");
os.push_back (to_string (ops.verbose ()));
}
if (ops.tftp_host_specified ())
{
os.push_back ("--tftp-host");
os.push_back (ops.tftp_host ());
}
// Note that we use the effective (absolute) path instead of recall since
// we may have changed the CWD.
//
// Exit code 2 signals abnormal termination but where the worker uploaded
// the result itself.
//
string tg (tm.target.string ());
switch (run_exit (trace, pp, tg, argv0.effect_string (), os))
{
case 2: return 1;
case 0: return 0;
default: fail << "process " << pp << " exited with non-zero code" << endf;
}
}
catch (const failed&)
{
// If we failed before being able to parse the task manifest, use the
// "unknown" values for the package name and version.
//
result_manifest rm {
tm.name.empty () ? bpkg::package_name ("unknown") : tm.name,
tm.version.empty () ? bpkg::version ("0") : tm.version,
result_status::abnormal,
operation_results {}
};
try
{
tftp_curl c (trace,
path ("-"),
nullfd,
curl::put,
url,
"--max-time", tftp_timeout);
serialize_manifest (rm, c.out, url, "result");
c.out.close ();
if (!c.wait ())
throw_generic_error (EIO);
}
catch (const system_error& e)
{
fail << "unable to upload result manifest to " << url << ": " << e;
}
return 1;
}
}
static int
bootstrap ()
{
bootstrap_manifest bm {
bootstrap_manifest::versions_type {
{"bbot", standard_version (BBOT_VERSION_STR)},
{"libbbot", standard_version (LIBBBOT_VERSION_STR)},
{"libbpkg", standard_version (LIBBPKG_VERSION_STR)},
{"libbutl", standard_version (LIBBUTL_VERSION_STR)}
}
};
serialize_manifest (bm, cout, "stdout", "bootstrap");
return 0;
}
int bbot::
main (int argc, char* argv[])
try
{
tracer trace ("main");
// This is a little hack to make our baseutils for Windows work when called
// with absolute path. In a nutshell, MSYS2's exec*p() doesn't search in the
// parent's executable directory, only in PATH. And since we are running
// without a shell (that would read /etc/profile which sets PATH to some
// sensible values), we are only getting Win32 PATH values. And MSYS2 /bin
// is not one of them. So what we are going to do is add /bin at the end of
// PATH (which will be passed as is by the MSYS2 machinery). This will make
// MSYS2 search in /bin (where our baseutils live). And for everyone else
// this should be harmless since it is not a valid Win32 path.
//
#ifdef _WIN32
{
string mp;
if (optional<string> p = getenv ("PATH"))
{
mp = move (*p);
mp += ';';
}
mp += "/bin";
setenv ("PATH", mp);
}
#endif
// On POSIX ignore SIGPIPE which is signaled to a pipe-writing process if
// the pipe reading end is closed. Note that by default this signal
// terminates a process. Also note that there is no way to disable this
// behavior on a file descriptor basis or for the write() function call.
//
// On Windows disable displaying error reporting dialog box. Note that the
// error mode is inherited by child processes.
//
#ifndef _WIN32
if (signal (SIGPIPE, SIG_IGN) == SIG_ERR)
fail << "unable to ignore broken pipe (SIGPIPE) signal: "
<< system_error (errno, std::generic_category ()); // Sanitize.
#else
SetErrorMode (SetErrorMode (0) | // Returns the current mode.
SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX);
#endif
cli::argv_scanner scan (argc, argv, true);
ops.parse (scan);
verb = ops.verbose ();
// @@ systemd 231 added JOURNAL_STREAM environment variable which allows
// detecting if stderr is connected to the journal.
//
if (ops.systemd_daemon ())
systemd_diagnostics (false);
// Version.
//
if (ops.version ())
{
cout << "bbot-worker " << BBOT_VERSION_ID << endl
<< "libbbot " << LIBBBOT_VERSION_ID << endl
<< "libbpkg " << LIBBPKG_VERSION_ID << endl
<< "libbutl " << LIBBUTL_VERSION_ID << endl
<< "Copyright (c) " << BBOT_COPYRIGHT << "." << endl
<< "TBC; All rights reserved" << endl;
return 0;
}
// Help.
//
if (ops.help ())
{
pager p ("bbot-worker help", false);
print_bbot_worker_usage (p.stream ());
// If the pager failed, assume it has issued some diagnostics.
//
return p.wait () ? 0 : 1;
}
// Figure out our mode.
//
if (ops.bootstrap () && ops.startup ())
fail << "--bootstrap and --startup are mutually exclusive";
enum class mode {boot, start, build} m (mode::build);
if (ops.bootstrap ()) m = mode::boot;
if (ops.startup ()) m = mode::start;
if (ops.systemd_daemon ())
{
info << "bbot worker " << BBOT_VERSION_ID;
}
// Figure out our path (used for re-exec).
//
argv0 = process::path_search (argv[0], true);
// Sort out the build directory.
//
if (ops.build_specified ())
change_wd (trace,
nullptr /* log */,
ops.build (),
true /* create */);
// Sort out the environment directory.
//
try
{
env_dir = ops.environments_specified ()
? ops.environments ()
: dir_path::home_directory ();
if (!dir_exists (env_dir))
throw_generic_error (ENOENT);
}
catch (const system_error& e)
{
fail << "invalid environment directory: " << e;
}
int r (1);
switch (m)
{
case mode::boot: r = bootstrap (); break;
case mode::start: r = startup (); break;
case mode::build: r = build (static_cast<size_t> (argc),
const_cast<const char**> (argv)); break;
}
return r;
}
catch (const failed&)
{
return 1; // Diagnostics has already been issued.
}
catch (const cli::exception& e)
{
error << e;
return 1;
}
int
main (int argc, char* argv[])
{
return bbot::main (argc, argv);
}
|