Megatest: Diff

Differences From Artifact [2f3ab9d0a7]:

File docs/manual/megatest_manual.html — part of check-in [36aa2d76fe] at 2016-12-12 14:11:33 on branch trunk — Added info to docs re. scriptinc. (user: mrwellan, size: 66763) [annotate] [blame] [check-ins using] [more...]

To Artifact [3a05c4c8b7]:

File docs/manual/megatest_manual.html — part of check-in [b8cc18503a] at 2020-10-27 22:43:47 on branch v1.65 — Updated ezsteps propagation and documentation (user: matt, size: 112964) [annotate] [blame] [check-ins using]

1 2 3 4 5 6 7 8 9 10 11 12	1 2 3 4 5 6 7 8 9 10 11 12	- +	<!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> ~~<meta name="generator" content="AsciiDoc ~~8.6.7~~">~~ <meta name="generator" content="AsciiDoc 9.0.0rc1"> <title>The Megatest Users Manual</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends / / Default font. */ body { font-family: Georgia,serif;
︙
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99	82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105	- + + + + + + +	ul, ol, li > p { margin-top: 0; } ul > li { color: #aaa; } ul > li > * { color: black; } ~~pre {~~ .monospaced, code, pre { font-family: "Courier New", Courier, monospace; font-size: inherit; color: navy; padding: 0; margin: 0; } pre { white-space: pre-wrap; } #author { color: #527bbd; font-weight: bold; font-size: 1.1em; } #email {
︙
214 215 216 217 218 219 220 ~~221~~ 222 223 224 225 226 227 228	220 221 222 223 224 225 226 227 228 229 230 231 232 233 234	- +	div.exampleblock > div.content { border-left: 3px solid #dddddd; padding-left: 0.5em; } div.imageblock div.content { padding-left: 0; } ~~span.image img { border-style: none; }~~ span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl { margin-top: 0.8em; margin-bottom: 0.8em; } dt {
︙
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	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	- - - - - - - + - - - - - -	/* * xhtml11 specific * * / ~~~~tt {~~ ~~font-family: "Courier New", Courier, monospace;~~ ~~font-size: inherit;~~ ~~color: navy;~~ }~~ div.tableblock { margin-top: 1.0em; margin-bottom: 1.5em; } div.tableblock > table { border: 3px solid #527bbd; } thead, p.table.header { font-weight: bold; color: #527bbd; } p.table { margin-top: 0; } ~~/ Because the table frame attribute is overriden by CSS in most browsers. /~~ / Because the table frame attribute is overridden by CSS in most browsers. / div.tableblock > table[frame="void"] { border-style: none; } div.tableblock > table[frame="hsides"] { border-left-style: none; border-right-style: none; } div.tableblock > table[frame="vsides"] { border-top-style: none; border-bottom-style: none; } / * html5 specific * * */ ~~~~.monospaced {~~ ~~font-family: "Courier New", Courier, monospace;~~ ~~font-size: inherit;~~ ~~color: navy;~~ }~~ table.tableblock { margin-top: 1.0em; margin-bottom: 1.5em; } thead, p.tableblock.header { font-weight: bold; color: #527bbd;
︙
534 535 536 537 538 539 540 541 542 543 544 545 546 547	528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543	+ +	body.manpage div.sectionbody { margin-left: 3em; } @media print { body.manpage div#toc { display: none; } } @media screen { body { max-width: 50em; /* approximately 80 characters wide */ margin-left: 16em; } #toc {
︙
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	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	- - + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - - + + + + + + + - - - + + + - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + - - + + - + + + + + - - - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - + + + + + + - - + + + + + + + + - - + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + - + + + + + + + + + + + - + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + +	</script> </head> <body class="book"> <div id="header"> <h1>The Megatest Users Manual</h1> <span id="author">Matt Welland</span><br> <span id="email" class="monospaced"><<a href="mailto:matt@kiatoa.com">matt@kiatoa.com</a>></span><br> ~~<span id="revnumber">version 1.0,</span> <span id="revdate">~~April~~ 2012</span>~~ <span id="revnumber">version 1.5,</span> <span id="revdate">June 2020</span> <div id="toc"> <div id="toctitle">Table of Contents</div> <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript> </div> </div> <div id="content"> <div class="sect1"> <h2 id="_preface">Preface</h2> <div class="sectionbody"> <div class="paragraph"><p>This book is organised as three sub-books; getting started, writing tests and reference.</p></div> <div class="listingblock"> <div class="title">License</div> <div class="content monospaced"> <pre> Copyright 2006-2020, Matthew Welland. This document is part of Megatest. Megatest is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Megatest is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Megatest. If not, see <http://www.gnu.org/licenses/>.</pre> </div></div> </div> </div> <div class="sect1"> <h2 id="_why_megatest">Why Megatest?</h2> <div class="sectionbody"> <div class="paragraph"><p>The Megatest project was started for two reasons, the first was an immediate and pressing need for a generalized tool to manage a suite of regression tests and the second was the fact that ~~the author~~ had ~~written or~~ maintained several such tools at different companies over th~~e years and it seemed a good thing to have~~ a single open source ~~tool, flexible enough to meet the needs~~ of any team doing continuous ~~integrating and or running a complex~~ suite of tests for release qualif~~ica~~t~~ion~~.</p></div> of regression tests and the second was the fact that I had written or maintained several such tools at different companies over the years. I thought a single open source tool, flexible enough to meet the needs of any team doing continuous integration and or running a complex suite of tests for release qualification would solve some problems for me and for others.</p></div> <div class="literalblock"> <div class="content monospaced"> <pre>-- Matt Welland, original author of the Megatest tool suite.</pre> </div></div> </div> </div> <div class="sect1"> <h2 id="_megatest_design_philosophy">Megatest Design Philosophy</h2> <div class="sectionbody"> <div class="paragraph"><p>Megatest is intended to provide the minimum needed ~~resources to make~~ writing a suite of tests and tasks for implementing ~~continuous build~~ for software, design engineering or process control (via ~~owlfs for~~ example) without being specialized for any specific problem space. Megatest in of itself does not know what constitutes a PASS or ~~FAIL~~ of a test or task. In most cases megatest is best used in ~~conjunction with~~ logpro or a similar tool to parse, analyze and decide <div class="paragraph"><p>Megatest is a distributed system intended to provide the minimum needed resources to make writing a suite of tests and tasks for implementing continuous build for software, design engineering or process control (via owlfs for example) without being specialized for any specific problem space. Megatest in of itself does not know what constitutes a PASS or FAIL of a test or task. In most cases megatest is best used in conjunction with logpro or a similar tool to parse, analyze and decide on the test outcome.</p></div> ~~on the test outcome.</p></div>~~ <div class="ulist"><ul> <li> <p> ~~Self-checking -~~Rep~~eatable stri~~ve for directed or~~ self-checking ~~test~~ as opposed to delta ~~based~~ tests~~ Self-checking - make it as easy as possible to write self-checking tests (as opposed to using deltas, i.e. tests that compare with a previous measurement to deterine PASS/FAIL). </p> </li> <li> <p> ~~Traceable - environment variables, host OS and other possibly ~~influential~~ variables ~~are captured and kept recorded~~.~~ Traceable - environment variables, host OS and other possibly influential variables are captured and kept recorded. </p> </li> <li> <p> Immutable - once a test is run it cannot be easily overwritten or modified accidentally. </p> </li> <li> <p> Repeatable - test results can be recreated in the future using all the original variables. </p> </li> <li> <p> ~~Immutable - once this test is run it cannot be easily overwritten or~~ ~~accidentally modified.~~ ~~</p>~~ ~~</li>~~ ~~<li>~~ ~~<p>~~ ~~Repeatable - this test result can be recreated in the future~~ ~~</p>~~ ~~</li>~~ ~~<li>~~ ~~<p>~~ Relocatable - the testsuite or automation area can be checked out ~~and the tests run anywhere~~ Relocatable - the testsuite or automation area can be checked out and the tests run anywhere in the disk hierarchy. </p> </li> <li> <p> ~~Encapsulated - the tests run in self-contained directories and all ~~inputs~~ and outputs to the process can be found in the run areas.~~ Encapsulated - the tests run in self-contained directories and all inputs and outputs to the process can be found in the run areas. </p> </li> <li> <p> ~~Deployable - a~~nyone on the~~ tea~~m, at~~ an~~y site, at any time~~ can run th~~e flow~~~~ Deployable - a testsuite is self-contained and can be bundled with a software project and easily used by others with little to no setup burden. </p> </li> </ul></div> </div> </div> <div class="sect1"> <h2 id="_megatest_architecture">Megatest Architecture</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_data_separation">Data separation</h3> <div class="paragraph"><p>All data to specify the tests and configure the system is stored in plain text files. All system state is stored in an sqlite3 ~~datab~~ase. Tests are launched using the launching system available for ~~the~~ distributed compute platform in use. A template script is provided plain text config files. All system state is stored in an sqlite3 database.</p></div> </div> <div class="sect2"> <h3 id="_distributed_compute">Distributed Compute</h3> <div class="paragraph"><p>Tests are launched using the launching system available for the distributed compute platform in use. A template script is provided which can launch jobs on local and remote Linux hosts. Currently megatest uses the network filesystem to call home to your master ~~sqlite3 database.~~</p></~~d~~iv>~~~~ sqlite3 database. Megatest has been used with the Intel Netbatch and lsf (also known as openlava) batch systems and it should be straightforward to use it with other similar systems.</p></div> </div> </div> </div> <div class="sect1"> <h2 id="_overview">Overview</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_stand_alone_megatest_area">Stand-alone Megatest Area</h3> <div class="paragraph"><p>A single, stand-alone, Megatest based testsuite or "area" is sufficient for most validation, automation and build problems.</p></div> <div class="imageblock"> <div class="content"> <img src="megatest-stand-alone-area.png" alt="Static"> </div> </div> <div class="paragraph"><p>Megatest is designed as a distributed or decoupled system. This means you can run the areas stand-alone with no additional infrastructure. I.e. there are no databases, web servers or other centralized resources needed. However as your needs grow you can integrate multiple areas into a bigger system.</p></div> <div class="sect3"> <h4 id="_component_descriptions">Component Descriptions</h4> <div class="olist arabic"><ol class="arabic"> <li> <p> Multi-area dashboard and xterm. A gui (the dashboard) is usually the best option for controlling and launching runs but all operations can also be done from the commandline. Note: The not yet released multi-area dashboard replaces the old dashboard for browsing and controlling runs but for managing a single area the old dashboard works very well. </p> </li> <li> <p> Area/testsuite. This is your testsuite or automation definition and consists of the information in megatest.config, runconfigs.config and your testconfigs along with any custom scripting that can’t be done with the native Megatest features. </p> </li> <li> <p> If your testsuite or build automation is too large to run on a single instance you can distribute your jobs into a compute server pool. The only current requirements are password-less ssh access and a network filesystem. </p> </li> </ol></div> </div> </div> <div class="sect2"> <h3 id="_full_system_architecture">Full System Architecture</h3> <div class="imageblock"> <div class="content"> <img src="megatest-system-architecture.png" alt="Static"> </div> </div> </div> </div> </div> <div class="sect1"> <h2 id="_road_map">Road Map</h2> <div class="sectionbody"> ~~<div class="paragraph"><p>Note 1: This road-map is still evolving and subject to change without notice.</p>~~</div> <div class="sect2"> <h3 id="_~~architecture~~_refa~~ctor~~">~~Architecture~~ R~~efactor~~</h3> <div class="sect3"> <~~h4 id="_goals">Goals</h4~~> </div> </div> <div class="sect1"> <h2 id="_todo_road_map">TODO / Road Map</h2> <div class="sectionbody"> <div class="paragraph"><p>Note: This road-map is a wish list and not a formal plan. Items are in rough priority but are subject to change. Development is driven by user requests, developer "itch" and bug reports. Please contact <a href="mailto:matt@kiatoa.com">matt@kiatoa.com</a> with requests or bug reports. Requests from inside Intel generally take priority.</p></div> <div class="paragraph"><p>Dashboard and runs</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Multi-area dashboard view </p> </li> </ol></div> <div class="paragraph"><p>Tests Support</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> ~~~~Reduce load on the file system. Sqlite3 files on network filesystem can be~~ ~~a bur~~den.~~ Add variable $MT_RUNPATH = $MT_LINKTREE/$MT_TARGET/$MT_RUNNAME </p> </li> <li> <p> Improve [script], especially indent handling </p> </li> </ol></div> <div class="paragraph"><p>Scalability</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Overflow database methodology - combine the best of the v1.63 multi-db approach and the current db-in-tmp approach (currently slowness can be seen when number of tests in a db goes over 50-100k, with the overflow db it will be able to handle 1000’s of runs with 50-100k tests per run). High priority - goal is to complete this by 20Q3. </p> </li> </ol></div> <div class="paragraph"><p>Mtutils/CI</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Enable mtutil calls from dashboard (for remote control) </p> </li> <li> <p> ~~Reduce number of servers and frequency of start/stop. This is mostly an~~ ~~issue of clutter but also a reduction in "moving parts".~~ Logs browser (esp. for surfacing mtutil related activities) </p> </li> <li> <p> ~~~~Coalesce activities to a single home host where possible. Give the user~~ ~~feedback~~ that ~~they have~~ started ~~the dashboard on a host other than th~~e~~ Embed ftfplan for distributed automation, completed activities trigger QA runs which trigger deployment etc. </p> </li> <li> <p> Jenkins junit XML support [DONE] </p> </li> <li> <p> Add output flushing in teamcity support </p> </li> </ol></div> <div class="paragraph"><p>Build system</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> ./configure ⇒ ubuntu, sles11, sles12, rh7 [WIP] </p> </li> <li> <p> Switch to using simple runs query everywhere </p> </li> <li> <p> Add end_time to runs and add a rollup call that sets state, status and end_time ~~home host.~~ </p> </li> </ol></div> <div class="paragraph"><p>Code refactoring/quality/performance</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> ~~Redu~~ce ~~number of~~ process~~es involved in~~ managin~~g running tests.~~ Switch to scsh-process pipeline management for job execution/control </p> </li> <li> <p> Use call-with-environment-variables where possible. </p> </li> </ol></div> <div class="paragraph"><p>Migration to inmem db and or overflow db</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Re-work the dbstruct data structure? </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> [ run-id.db inmemdb last-mod last-read last-sync inuse ] </p> </li> </ol></div> </li> </ol></div> <div class="paragraph"><p>Some ideas for Megatest 2.0</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Aggressive megatest.config and runconfig.config caching. </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> Cache the configs in $MT_RUNPATH </p> </li> <li> <p> Following invocations of –run, -rerun* will calculate the new config but only overwrite the cached file IF changed </p> </li> </ol></div> </li> <li> <p> If the cached file changes ALL existing tests go from COMPLETED → STALE, I’m not sure what to do about RUNNING tests </p> </li> <li> <p> !VARS in runconfigs are not exported to the environment. They are accessed via rget as if the ! was not there. </p> </li> <li> <p> Per test copy commands (example is incomplete). </p> </li> ~~</div> <div class="~~sect3~~">~~ </ol></div> <div class="listingblock"> ~~<h4 id="_changes_needed">Changes Needed</h4>~~ <div class="content monospaced"> <pre>[testcopy] %/iind% unison SRC DEST % cp –r SRC DEST</pre> </div></div> <div class="paragraph"><p>Add ability to move runs to other Areas (overlaps with overflow db system)</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> ~~~~ACID compliant db wi~~ll ~~be on /tmp and~~ syn~~ced to~~ megatest.db ~~with~~ a ~~fiv~~e ~~seco~~nd ~~max~~ d~~elay~~.~~ allow shrinking megatest.db data by moving runs to an alternate Megatest area with same keys. </p> </li> <li> <p> add param -destination [area\|path]. when specified runs are copied to new area and removed from local db. </p> </li> <li> <p> ~~Rea~~d/wri~~te~~s to db for processes on homehost will go direct to /tmp~~ megatest.db ~~file.~~~~ the data move would involve these steps </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> copy the run data to destination area megatest.db </p> </li> <li> <p> ~~Read/wites fron non-homehost processes will go through one server. Bulk~~ re~~ads (e.g. for~~ dashboard or list-r~~uns) will be cached o~~n ~~the current host~~ ~~in /tmp and synced from the h~~ome ~~mega~~te~~st.db~~ in the ~~testsu~~i~~te area.~~ mark the run records as deleted, do not remove the run data on disk </p> </li> </ol></div> </li> <li> <p> accessing the data would be by running dashboard in the satellite area </p> </li> <li> <p> future versions of Megatest dashboard should support displaying areas in a merged way. </p> </li> <li> <p> some new controls would be supported in the config </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> [setup] ⇒ allow-runs [no\|yes] ⇐= used to disallow runs </p> </li> <li> <p> [setup] ⇒ auto-migrate=[areaname\|path] ⇐= used to automatically migrate data to a satellite area. </p> </li> </ol></div> </li> </ol></div> <div class="paragraph"><p>Eliminate ties to homehost (part of overflow db system)</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Server creates captain pkt </p> </li> <li> <p> ~~Db syncs~~ re~~ly o~~n the ~~target db file timestame minus some margin.~~ Create a lock in the db </p> </li> <li> <p> ~~Since bulk reads do not use the server we can switch to simple RPC for the~~ ~~network transport.~~ Relinquish db when done </p> </li> </ol></div> <div class="paragraph"><p>Tasks - better management of run manager processes etc.</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> adjutant queries tasks table for next action <span class="red">[Migrate into mtutil]</span> </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> Task table used for tracking runner process <span class="red">[Replaced by mtutil]</span> </p> </li> <li> <p> Task table used for jobs to run <span class="red">[Replaced by mtutil]</span> </p> </li> <li> <p> Task table used for queueing runner actions (remove runs, cleanRunExecute, etc) <span class="red">[Replaced by mtutil</span>] </p> </li> </ol></div> </li> <li> <p> ~~Tes~~t ru~~nning~~ manager ~~process extended to manage multiple running tests.~~ adjutant (server/task dispatch/execution manager) </p> </li> </ol></div> <div class="paragraph"><p>Stale propagation</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Mark dependent tests for clean/rerun -rerun-downstream ~~</~~div~~> </div> <div class="s~~ect2"~~> ~~<h3~~ ~~id="_cur~~rent~~_items">Current Items</h3>~~ <div class="~~sect3~~">~~ </p> </li> <li> <p> On run start check for defunct tests in RUNNING, LAUNCHED or REMOTEHOSTSTART and correct or notify </p> </li> <li> <p> Fix: refresh of gui sometimes fails on last item (race condition?) </p> </li> </ol></div> <div class="paragraph"><p>Bin list</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Rerun step and or subsequent steps from gui [DONE?] </p> </li> <li> <p> Refresh test area files from gui </p> </li> <li> <p> Clean and re-run button </p> </li> <li> <p> Clean up STATE and STATUS handling. </p> <div class="olist loweralpha"><ol class="loweralpha"> ~~~~<h4 id="_ww05_migrate_to_inmem_db">ww05 - migrate to inmem-db</h4>~~ <div ~~class="olist arabic"><ol class="arabic"~~>~~ <li> <p> Dashboard and Test control panel are reverse order - choose and fix </p> </li> <li> <p> Move seldom used states and status to drop down selector </p> </li> </ol></div> </li> <li> <p> ~~Switch to inmem db with fast sync to on disk db’s [DONE]~~ Access test control panel when clicking on Run Summary tests </p> </li> <li> <p> Feature: -generate-index-tree </p> </li> <li> <p> Change specifing of state and status to use STATE1/STATUS1,STATE2/STATUS2 </p> </li> <li> <p> ~~Serv~~er polls tasks t~~able for next ~~action~~~~ rest api available for use with Perl, Ruby etc. scripts </p> </li> <li> <p> megatest.config setup entries for: </p> <div class="olist loweralpha"><ol class="loweralpha"> <li> <p> ~~Ta~~sk table used for track~~ing ru~~nner process [DONE]~~~~ run launching (e.g. /bin/sh %CMD% > /dev/null) </p> </li> <li> <p> browser "konqueror %FNAME% </p> </li> </ol></div> </li> <li> <p> refdb: Add export of csv, json and sexp </p> </li> <li> <p> Convert to using call-with-environment-variables where possible. Should allow handling of parallel runs in same process. </p> </li> <li> <p> Re-work text interface wizards. Several bugs on record. Possibly convert to gui based. </p> </li> <li> <p> Add to testconfig requirements section; launchlimiter scriptname, calls scriptname to check if ok to launch test </p> </li> <li> <p> Refactor Run Summary view, currently very clumsy </p> </li> <li> <p> Add option to show steps in Run Summary view </p> </li> <li> <p> Refactor guis for resizeablity </p> </li> <li> <p> ~~Task table use~~d f~~or job~~s to ~~run~~ Add filters to Run Summary view and Run Control view </p> </li> <li> <p> ~~Task table used for queueing runner actions (remove runs, cleanRunExecute, etc)~~ Add to megatest.config or testconfig; rerunok STATE/STATUS,STATE/STATUS… </p> </li> <li> <p> Launch gates for diskspace; /path/one>1G,/path/two>200M,/tmp>5G,#{scheme <strong>toppath</strong>}>1G ~~</~~ol></div~~>~~ </p> </li> <li> <p> Tool tips </p> </li> <li> <p> Filters on Run Summary, Summary and Run Control panel </p> </li> <li> <p> Built in log viewer (partially implemented) </p> </li> <li> <p> Refactor the test control panel Help and documentation </p> </li> <li> <p> Complete the user manual (I’ve been working on this lately). </p> </li> <li> <p> Online help in the gui Streamlined install </p> </li> <li> <p> Deployed or static build </p> </li> <li> <p> Added option to compile IUP (needed for VMs) </p> </li> <li> <p> Server side run launching </p> </li> <li> <p> Wizards for creating tests, regression areas (current ones are text only and limited). </p> </li> <li> <p> Fully functional built in web service (currently you can browse runs but it is very simplistic). </p> </li> <li> <p> Gui panels for editing megatest.config and runconfigs.config </p> </li> <li> <p> Fully isolated tests (no use of NFS to see regression area files) </p> </li> <li> <p> Windows version </p> </li> </ol></div> ~~<div class="paragraph"><p>shifting, note that the preceding blank line is needed.</p></div>~~ ~~</div>~~ ~~</div>~~ </div> </div> <div class="sect1"> <h2 id="_installation">Installation</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_dependencies">Dependencies</h3> <div class="paragraph"><p>Chicken scheme and a number of "eggs" are required for building Megatest. See the script installall.sh in the utils directory of the source distribution for an automated way to install everything needed for building Megatest on Linux.</p></div> <div class="paragraph"><p>Megatest. In the v1.66 and beyond assistance to create the build system is built into the Makefile.</p></div> <div class="listingblock"> <div class="title">Installation steps (overview)</div> <div class="content monospaced"> <pre>./configure make chicken setup.sh make -j install</pre> </div></div> <div class="paragraph"><p>Or install the needed build system manually:</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Chicken scheme from <a href="http://call-cc.org">http://call-cc.org</a> </p> </li> <li> <p> IUP from <a href="http://webserver2.tecgraf.puc-rio.br/iup/">http://webserver2.tecgraf.puc-rio.br/iup/</a> </p> </li> <li> <p> CD from <a href="http://webserver2.tecgraf.puc-rio.br/cd/">http://webserver2.tecgraf.puc-rio.br/cd/</a> </p> </li> <li> <p> IM from <a href="https://webserver2.tecgraf.puc-rio.br/im/">https://webserver2.tecgraf.puc-rio.br/im/</a> </p> </li> <li> <p> ffcall from <a href="http://webserver2.tecgraf.puc-rio.br/iup/">http://webserver2.tecgraf.puc-rio.br/iup/</a> </p> </li> <li> <p> Nanomsg from <a href="https://nanomsg.org/">https://nanomsg.org/</a> (NOTE: Plan is to eliminate nanomsg dependency). </p> </li> <li> <p> Needed eggs (look at the eggs lists in the Makefile) </p> </li> </ol></div> <div class="paragraph"><p>Then follow these steps:</p></div> <div class="listingblock"> <div class="title">Installation steps (self-built chicken scheme build system)</div> <div class="content monospaced"> <pre>./configure make -j install</pre> </div></div> </div> </div> </div> <div class="sect1"> <h2 id="_getting_started">Getting Started</h2> <div class="sectionbody"> ~~<div class="~~open~~block">~~ <div class="listingblock"> <div class="title">Getting started with Megatest</div> ~~<div class="content"> <~~div class="paragraph"><p~~>Creating a testsuite or flow and your first test or task.</p~~></div~~>~~ <div class="content monospaced"> <pre>Creating a testsuite or flow and your first test or task.</pre> </div></div> <div class="paragraph"><p>After installing Megatest you can create a flow or testsuite and add some tests using the helpers. Here is a quickstart sequence to get you up and running your first automated testsuite.</p></div> <div class="sect2"> <h3 id="_creating_a_megatest_area">Creating a Megatest Area</h3> <div class="sect3">
︙
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111	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	+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +	<div class="listingblock"> <div class="title">Starting dashboard</div> <div class="content monospaced"> <pre>dashboard -rows 24</pre> </div></div> </div> </div> </div> <div class="sect1"> <h2 id="_study_plan">Study Plan</h2> <div class="sectionbody"> <div class="paragraph"><p>Megatest is an extensive program with a lot to learn. Following are some paths through the material to smooth the learning path.</p></div> <div class="sect2"> <h3 id="_basic_concepts_suggest_you_pick_these_up_on_the_way">Basic Concepts (suggest you pick these up on the way)</h3> <div class="ulist"><ul> <li> <p> Components of automation; run, test, iteration </p> </li> <li> <p> Selectors; target, runname, and testpatt </p> </li> </ul></div> </div> <div class="sect2"> <h3 id="_running_testsuites_or_automation">Running Testsuites or Automation</h3> <div class="ulist"><ul> <li> <p> Using the dashboard gui (recommended) </p> <div class="ulist"><ul> <li> <p> Using the "Runs" panel. </p> </li> <li> <p> Using the "Run Control" panel. </p> </li> <li> <p> Using a test control panel </p> </li> <li> <p> The Right Mouse Button menu </p> </li> <li> <p> Debug features </p> <div class="ulist"><ul> <li> <p> xterm </p> <div class="ulist"><ul> <li> <p> pstree </p> </li> <li> <p> log files; mt_copy.log, mt_launch.log </p> </li> <li> <p> variables; megatest.csh, megatest.sh </p> </li> <li> <p> testconfig dump, *testconfig </p> </li> </ul></div> </li> <li> <p> State/status buttons </p> </li> <li> <p> Run, Clean, KillReq </p> </li> <li> <p> ReRunClean </p> </li> </ul></div> </li> </ul></div> </li> <li> <p> Using the command line </p> <div class="ulist"><ul> <li> <p> Getting help; megatest -h, megatest -manual </p> </li> <li> <p> Starting runs; megatest -run </p> <div class="ulist"><ul> <li> <p> Selection controls; -target, -runname and -testpatt </p> </li> </ul></div> </li> </ul></div> </li> </ul></div> </div> <div class="sect2"> <h3 id="_writing_tests_and_flows">Writing Tests and Flows</h3> <div class="ulist"><ul> <li> <p> environment variables (table 5) </p> </li> <li> <p> tests/<em>testname</em>/testconfig <a href="megatest_manual.html#_the_testconfig_file">testconfig details</a> </p> <div class="ulist"><ul> <li> <p> ezsteps and logpro section </p> </li> <li> <p> iteration (one test applied to many inputs), items, itemstable <a href="megatest_manual.html#_iteration">test iteration</a> </p> </li> <li> <p> dependencies, waiton, itemmatch, itemwait <a href="megatest_manual.html#_requirements_section">test requirements</a> </p> </li> <li> <p> miscellaneous; mode toplevel, runtimelim, skip on file, no file, script or on running, waiver propagation </p> </li> </ul></div> </li> <li> <p> megatest areas </p> <div class="ulist"><ul> <li> <p> megatest.config </p> </li> <li> <p> runconfigs.config </p> </li> <li> <p> config language features; include, shell, system, scheme, rp\|realpath, getenv, get, rget, scriptinc <a href="megatest.html#_config_file_helpers">config file helpers</a> </p> </li> </ul></div> </li> </ul></div> </div> <div class="sect2"> <h3 id="_advanced_topics">Advanced Topics</h3> <div class="ulist"><ul> <li> <p> Removing and keeping runs selectively <a href="megatest_manual.html#_managing_old_runs">managing runs</a> </p> </li> <li> <p> Subruns <a href="megatest_manual.html#_nested_runs">nested runs</a> </p> </li> <li> <p> Config file features <a href="megatest_manual.html#_config_file_helpers">config file features</a> </p> </li> <li> <p> HTML output with -generate-html </p> </li> <li> <p> Triggers, post run, state/status </p> </li> <li> <p> MTLOWESTLOAD </p> </li> <li> <p> flexilauncher </p> </li> <li> <p> env delta and testconfig </p> </li> <li> <p> capturing test data, extracting values from logpro and using them for pass/fail </p> </li> <li> <p> mtutil, postgres connection, packets for cross-site/cross-user control (e.g. mcrun). </p> </li> </ul></div> </div> <div class="sect2"> <h3 id="_maintenance_and_troubleshooting">Maintenance and Troubleshooting</h3> <div class="ulist"><ul> <li> <p> cleanup-db, database structure of Megatest 1.6x </p> </li> <li> <p> archiving </p> </li> <li> <p> homehost management </p> </li> <li> <p> show-runconfig </p> </li> <li> <p> show-config </p> </li> <li> <p> show with -debug 0,9 </p> </li> <li> <p> load management </p> </li> </ul></div> </div> </div> </div> <div class="sect1"> <h2 id="_writing_tests">Writing Tests</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_creating_a_new_test">Creating a new Test</h3> <div class="paragraph"><p>The following steps will add a test "yourtestname" to your testsuite. This assumes
︙
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201	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	+ + + + + + + + + + + + + + + +	<div class="paragraph"><p>Hint: You can browse the archive using bup commands directly.</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>bup -d /path/to/bup/archive ftp</pre> </div></div> </div> </div> </div> <div class="sect2"> <h3 id="_pass_data_from_test_to_test">Pass Data from Test to Test</h3> <div class="listingblock"> <div class="title">To save the data call archive save within your test:</div> <div class="content monospaced"> <pre>megatest -archive save</pre> </div></div> <div class="listingblock"> <div class="title">To retrieve the data call archive get using patterns as needed</div> <div class="content monospaced"> <pre># Put the retrieved data into /tmp DESTPATH=/tmp/$USER/$MT_TARGET/$MT_RUN_NAME/$MT_TESTNAME/$MT_ITEMPATH/my_data mkdir -p $DESTPATH megatest -archive get -runname % -dest $DESTPATH</pre> </div></div> </div> <div class="sect2"> <h3 id="_submit_jobs_to_host_types_based_on_test_name">Submit jobs to Host Types based on Test Name</h3> <div class="listingblock"> <div class="title">In megatest.config</div> <div class="content monospaced"> <pre>[host-types]
︙
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 ~~1336~~ 1337 1338 1339 1340 1341 1342 1343	2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218	+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +	</div></div> </div> </div> </div> <div class="sect1"> <h2 id="_reference">Reference</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_megatest_use_modes">Megatest Use Modes</h3> <table class="tableblock frame-topbot grid-all" style=" width:80%; "> <caption class="title">Table 2. Base commands</caption> <col style="width:20%;"> <col style="width:40%;"> <col style="width:40%;"> <thead> <tr> <th class="tableblock halign-center valign-top" >Use case </th> <th class="tableblock halign-left valign-top" > Megatest command </th> <th class="tableblock halign-left valign-top" > mtutil</th> </tr> </thead> <tbody> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">Start from scratch</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-rerun-all</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">restart</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">Rerun non-good completed</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-rerun-clean</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">rerunclean</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">Rerun all non-good and not completed yet</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-set-state-status KILLREQ; -rerun-</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">clean</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">killrerun</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Continue run</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-run</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">resume</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Remove run</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-remove-runs</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">clean</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Lock run</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-lock</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">lock</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Unlock run</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-unlock</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">unlock</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">killrun</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">-set-state-status KILLREQ; -kill-run</p></td> </tr> </tbody> </table> </div> <div class="sect2"> <h3 id="_config_file_helpers">Config File Helpers</h3> <div class="paragraph"><p>Various helpers for more advanced config files.</p></div> <table class="tableblock frame-topbot grid-all" style=" width:80%; "> ~~<caption class="title">Table 2. Helpers</caption>~~ <caption class="title">Table 3. Helpers</caption> <col style="width:14%;"> <col style="width:28%;"> <col style="width:28%;"> <col style="width:28%;"> <thead> <tr> <th class="tableblock halign-center valign-top" >Helper </th>
︙
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	2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382	- - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + - + + + + + - - - - + + + + -	<div class="listingblock"> <div class="content monospaced"> <pre>[items] A a b c B d e f</pre> </div></div> <div class="paragraph"><p>Then the config file would effectively appear to contain an items section exactly like the output from the script. This is ~~extremely~~ useful when ~~dynamically~~ creating items, itemstables and other config structures. You can ~~see the~~ expansion of the call by looking in the cached files (look in your ~~linktree~~ for megatest.config and runconfigs.config cache files and in your ~~test run~~ areas for the expanded and cached testconfig).</p></div> <div class="sect3"> <h4 id="_disk_space_checks">Disk Space Checks</h4> exactly like the output from the script. This is useful when dynamically creating items, itemstables and other config structures. You can see the expansion of the call by looking in the cached files (look in your linktree for megatest.config and runconfigs.config cache files and in your test run areas for the expanded and cached testconfig).</p></div> <div class="paragraph"><p>Wildcards and regexes in Targets</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[a/2/b] VAR1 VAL1 [a/%/b] VAR1 VAL2</pre> </div></div> <div class="paragraph"><p>Will result in:</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[a/2/b] VAR1 VAL2</pre> </div></div> <div class="paragraph"><p>Can use either wildcard of "%" or a regular expression:</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[/abc.*def/]</pre> </div></div> </div> <div class="sect2"> <h3 id="_disk_space_checks">Disk Space Checks</h3> <div class="paragraph"><p>Some parameters you can put in the [setup] section of megatest.config:</p></div> <div class="listingblock"> <div class="content monospaced"> <pre># minimum space required in a run disk minspace 10000000 # minimum space required in dbdir: dbdir-space-required 100000 # script that takes path as parameter and returns number of bytes available: free-space-script check-space.sh</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_trim_trailing_spaces">Trim trailing spaces</h4>~~ <div class="sect2"> <h3 id="_trim_trailing_spaces">Trim trailing spaces</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> <img src="/usr/images/icons/note.png" alt="Note"> </td> <td class="content">As of Megatest version v1.6548 trim-trailing-spaces defaults to yes.</td> </tr></table> </div> <div class="listingblock"> <div class="content monospaced"> ~~<pre>[configf:settings trim-trailing-spaces ~~yes]</pre>~~~~ <pre>[configf:settings trim-trailing-spaces no] # \|<== next line padded with spaces to here DEFAULT_INDENT [configf:settings trim-trailing-spaces no]</pre> </div></div> <div class="paragraph"><p>The variable DEFAULT_INDENT would be a string of 3 spaces</p></div> </div> <div class="sect3"> <h4 id="_job_submission_control">Job Submission Control</h4> <div class="sect4"> <h5 id="_submit_jobs_to_host_types_based_on_test_name_2">Submit jobs to Host Types based on Test Name</h5> <div class="sect2"> <h3 id="_job_submission_control">Job Submission Control</h3> <div class="sect3"> <h4 id="_submit_jobs_to_host_types_based_on_test_name_2">Submit jobs to Host Types based on Test Name</h4> <div class="listingblock"> <div class="title">In megatest.config</div> <div class="content monospaced"> <pre>[host-types] general nbfake remote bsub [launchers] runfirst/sum% remote % general [jobtools] launcher bsub # if defined and not "no" flexi-launcher will bypass launcher unless # there is no host-type match. flexi-launcher yes</pre> </div></div> ~~</div>~~ <div class="sect4"> <h5 id="_host_types">host-types</h5> <div class="paragraph"><p>List of host types and the commandline to run a job on that host type.</p></div> <div class="listingblock"> <div class="title">host-type ⇒ launch command</div> <div class="content monospaced"> <pre>general nbfake</pre>
︙
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510	2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441	+ + + + + + + + + + + + + + + + + + + + + + + +	<div class="paragraph"><p>Attempt to rerun tests in "STUCK/DEAD", "n/a", "ZERO_ITEMS" states.</p></div> <div class="listingblock"> <div class="title">In megatest.config</div> <div class="content monospaced"> <pre>[setup] reruns 5</pre> </div></div> <div class="paragraph"><p>Replace the default blacklisted environment variables with user supplied list.</p></div> <div class="paragraph"><p>Default list: USER HOME DISPLAY LS_COLORS XKEYSYMDB EDITOR MAKEFLAGS MAKEF MAKEOVERRIDES</p></div> <div class="paragraph"><div class="title">Add a "bad" variable "PROMPT" to the variables that will be commented out</div><p>in the megatest.sh and megatest.csh files:</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[setup] blacklistvars USER HOME DISPLAY LS_COLORS XKEYSYMDB EDITOR MAKEFLAGS PROMPT</pre> </div></div> </div> <div class="sect4"> <h5 id="_run_time_limit">Run time limit</h5> <div class="listingblock"> <div class="content monospaced"> <pre>[setup] # this will automatically kill the test if it runs for more than 1h 2m and 3s runtimelim 1h 2m 3s</pre> </div></div> </div> <div class="sect4"> <h5 id="_post_run_hook">Post Run Hook</h5> <div class="paragraph"><p>This runs script to-run.sh after all tests have been completed. It is not necessary to use -run-wait as each test will check for other running tests on completion and if there are none it will call the post run hook.</p></div> <div class="paragraph"><p>Note that the output from the script call will be placed in a log file in the logs directory with a file name derived by replacing / with _ in post-hook-<target>-<runname>.log.</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[runs] post-hook /path/to/script/to-run.sh</pre> </div></div> </div> </div> </div> <div class="sect2"> <h3 id="_tests_browser_view">Tests browser view</h3> <div class="paragraph"><p>The tests browser (see the Run Control tab on the dashboard) has two views for displaying the tests.</p></div> <div class="olist arabic"><ol class="arabic">
︙
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	2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538	+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - -	<div class="paragraph"><p>The default is the graphviz based tree but if your tests don’t view well in that mode then use "nodot" to turn it off.</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[setup] nodot</pre> </div></div> </div> <div class="sect2"> <h3 id="_capturing_test_data">Capturing Test Data</h3> <div class="paragraph"><p>In a test you can capture arbitrary variables and roll them up in the megatest database for viewing on the dashboard or web app.</p></div> <div class="listingblock"> <div class="title">In a test as a script</div> <div class="content monospaced"> <pre>$MT_MEGATEST -load-test-data << EOF foo,bar, 1.2, 1.9, > foo,rab, 1.0e9, 10e9, 1e9 foo,bla, 1.2, 1.9, < foo,bal, 1.2, 1.2, < , ,Check for overload foo,alb, 1.2, 1.2, <= , Amps,This is the high power circuit test foo,abl, 1.2, 1.3, 0.1 foo,bra, 1.2, pass, silly stuff faz,bar, 10, 8mA, , ,"this is a comment" EOF</pre> </div></div> <div class="paragraph"><p>Alternatively you can use logpro triggers to capture values and inject them into megatest using the -set-values mechanism:</p></div> <div class="listingblock"> <div class="title">Megatest help related to -set-values</div> <div class="content monospaced"> <pre>Test data capture -set-values : update or set values in the testdata table :category : set the category field (optional) :variable : set the variable name (optional) :value : value measured (required) :expected : value expected (required) :tol : \|value-expect\| <= tol (required, can be <, >, >=, <= or number) :units : name of the units for value, expected_value etc. (optional)</pre> </div></div> </div> <div class="sect2"> <h3 id="_dashboard_settings">Dashboard settings</h3> <div class="listingblock"> <div class="title">Runs tab buttons, font and size</div> <div class="content monospaced"> <pre>[dashboard] btn-height x14 btn-fontsz 10 cell-width 60</pre> </div></div> </div> <div class="sect2"> <h3 id="_database_settings">Database settings</h3> <table class="tableblock frame-topbot grid-all" style=" width:70%; "> ~~<caption class="title">Table 3. Database config settings in [setup] section of megatest.config</caption>~~ <caption class="title">Table 4. Database config settings in [setup] section of megatest.config</caption> <col style="width:14%;"> <col style="width:28%;"> <col style="width:28%;"> <col style="width:28%;"> <thead> <tr> <th class="tableblock halign-center valign-top" >Var </th> <th class="tableblock halign-left valign-top" > Purpose </th> <th class="tableblock halign-left valign-top" > Valid values </th> <th class="tableblock halign-left valign-top" > Comments</th> </tr> </thead> <tbody> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">delay-on-busy</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Prevent concurrent access issues</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">yes\|no or not defined</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Default=no, may help on some network file systems, may slow things down also.</p></td> </tr> <tr> ~~<td class="tableblock halign-center valign-top" ><p class="tableblock">daemonize</p></td>~~ ~~<td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Daemonize the server on start</p></td>~~ ~~<td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">yes\|no or not defined</p></td>~~ ~~<td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Default=no</p></td>~~ ~~</tr>~~ ~~<tr>~~ <td class="tableblock halign-center valign-top" ><p class="tableblock">faststart</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">All direct file access to sqlite db files</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">yes\|no or not defined</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">Default=yes, suggest no for central automated systems and yes for interactive use</p></td> </tr> <tr> <td class="tableblock halign-center valign-top" ><p class="tableblock">homehost</p></td>
︙
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	2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689	+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + +	<div class="paragraph"><p>The runscript method is a brute force way to run scripts where the user is responsible for setting STATE and STATUS</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>runscript main.csh</pre> </div></div> </div> </div> <div class="sect2"> <h3 id="_iteration">Iteration</h3> <div class="listingblock"> <div class="title">Sections for iteration</div> <div class="content monospaced"> <pre># full combinations [items] A x y B 1 2 # Yields: x/1 x/2 y/1 y/2 # tabled [itemstable] A x y B 1 2 # Yields x/1 y/2</pre> </div></div> <div class="listingblock"> <div class="title">Or use files</div> <div class="content monospaced"> <pre>[itemopts] slash path/to/file/with/items # or space path/to/file/with/items</pre> </div></div> <div class="listingblock"> <div class="title">File format for / delimited</div> <div class="content monospaced"> <pre>key1/key2/key3 val1/val2/val2 ...</pre> </div></div> <div class="listingblock"> <div class="title">File format for space delimited</div> <div class="content monospaced"> <pre>key1 key2 key3 val1 val2 val2 ...</pre> </div></div> </div> <div class="sect2"> <h3 id="_requirements_section">Requirements section</h3> <div class="listingblock"> <div class="title">Header</div> <div class="content monospaced"> <pre>[requirements]</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_wait_on_other_tests">Wait on Other Tests</h4>~~ <div class="sect2"> <h3 id="_wait_on_other_tests">Wait on Other Tests</h3> <div class="listingblock"> <div class="content monospaced"> <pre># A normal waiton waits for the prior tests to be COMPLETED # and PASS, CHECK or WAIVED waiton test1 test2</pre> </div></div> <div class="admonitionblock"> <table><tr> <td class="icon"> <img src="/usr/images/icons/note.png" alt="Note"> </td> <td class="content">Dynamic waiton lists must be capable of being calculated at the beginning of a run. This is because Megatest walks the tree of waitons to create the list of tests to execute.</td> </tr></table> </div> <div class="listingblock"> <div class="title">This works</div> <div class="content monospaced"> <pre>waiton [system somescript.sh]</pre> </div></div> <div class="listingblock"> <div class="title">This does NOT work (the full context for the test is not available so #{shell …} is NOT enabled to evaluate.</div> <div class="content monospaced"> <pre>waiton #{shell somescript.sh}</pre> </div></div> <div class="listingblock"> <div class="title">This does NOT work</div> <div class="content monospaced"> <pre>waiton [system somescript_that_depends_on_a_prior_test.sh]</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_mode">Mode</h4>~~ <div class="sect2"> <h3 id="_mode">Mode</h3> <div class="paragraph"><p>The default (i.e. if mode is not specified) is normal. All pre-dependent tests must be COMPLETED and PASS, CHECK or WAIVED before the test will start</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[requirements] mode normal</pre> </div></div>
︙
1673 1674 1675 1676 1677 1678 1679 ~~1680~~ 1681 1682 1683 1684 1685 1686 1687	2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712	-	"itemmatch" are synonyms.</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[requirements] mode itemmatch</pre> </div></div> </div> ~~</div>~~ <div class="sect2"> <h3 id="_overriding_enviroment_variables">Overriding Enviroment Variables</h3> <div class="paragraph"><p>Override variables before starting the test. Can include files (perhaps generated by megatest -envdelta or similar).</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[pre-launch-env-vars] VAR1 value1
︙
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	2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292	+ - - - - + + + + + + + + + + + - + - + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + + + + + - - + + + + - - - - - - - - - + + - - - - - - - - - - - - - - - - - + + - + - + - - + - - - + - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + - - + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +	</div> <div class="sect2"> <h3 id="_itemmap_handling">Itemmap Handling</h3> <div class="paragraph"><p>For cases were the dependent test has a similar but not identical itempath to the downstream test an itemmap can allow for itemmatch mode</p></div> <div class="listingblock"> <div class="title">example for removing part of itemmap for waiton test (eg: item <span class="monospaced">foo-x/bar</span> depends on waiton’s item <span class="monospaced">y/bar</span>)</div> <div class="content monospaced"> <pre>[requirements] ~~mode item~~match~~ itemmap .x/ y/ # ## pattern replacement notes~~ mode itemwait # itemmap <item pattern for this test> <item replacement pattern for waiton test> itemmap .x/ y/</pre> </div></div> <div class="listingblock"> <div class="title">example for removing part of itemmap for waiton test (eg: item <span class="monospaced">foo/bar/baz</span> in this test depends on waiton’s item <span class="monospaced">baz</span>)</div> <div class="content monospaced"> <pre># ## pattern replacement notes # # ## Example # ## Remove everything up to the last / [requirements] mode itemwait # itemmap <item pattern for this test> <nothing here indicates removal> ~~itemmap ./~~ itemmap ./</pre> # </div></div> <div class="listingblock"> <div class="title">example replacing part of itemmap for (eg: item <span class="monospaced">foo/1234</span> will imply waiton’s item <span class="monospaced">bar/1234</span>)</div> <div class="content monospaced"> <pre># # ## Example # ## Replace foo/ with bar/ [requirements] mode itemwait # itemmap <item pattern for this test> <item replacement pattern for waiton test> ~~itemmap foo/ bar/ # multi-line; matches are applied in the listed order~~ itemmap foo/ bar/</pre> </div></div> <div class="listingblock"> <div class="title">example for backreference (eg: item <span class="monospaced">foo23/thud</span> will imply waiton’s item <span class="monospaced">num-23/bar/thud</span></div> <div class="content monospaced"> <pre># # ## Example # ## can use \{number} in replacement pattern to backreference a (capture) from matching pattern similar to sed or perl [requirements] mode itemwait # itemmap <item pattern for this test> <item replacement pattern for waiton test> itemmap foo(\d+)/ num-\1/bar/</pre> </div></div> <div class="listingblock"> <div class="title">example multiple itemmaps</div> <div class="content monospaced"> <pre># multi-line; matches are applied in the listed order # The following would map: # a123b321 to b321fooa123 then to 321fooa123p # [requirements] itemmap (a\d+)(b\d+) \2foo\1 b(.) \1p</pre> </div></div> </div> <div class="sect3"> <h4 id="_complex_mappings">Complex mapping~~s</h4~~> <div class="paragraph"><p>Complex mappings can be handled with the [itemmap] section</p></div> <div class="~~image~~block"> <div class="content"> <~~img src="complex-~~itemmap~~.png" alt="complex-itemmap.png">~~ </div> <div class="sect2"> <h3 id="_complex_mapping">Complex mapping</h3> <div class="paragraph"><p>Complex mappings can be handled with a separate [itemmap] section (instead if an itemmap line in the [requirements] section)</p></div> <div class="paragraph"><p>Each line in an itemmap section starts with a waiton test name followed by an itemmap expression</p></div> <div class="listingblock"> <div class="title">eg: The following causes waiton test A item <span class="monospaced">bar/1234</span> to run when our test’s <span class="monospaced">foo/1234</span> item is requested as well as causing waiton test B’s <span class="monospaced">blah</span> item to run when our test’s <span class="monospaced">stuff/blah</span> item is requested</div> <div class="content monospaced"> <pre>[itemmap] A foo/ bar/ B stuff/</pre> </div></div> </div> ~~<div class="~~paragraph~~"~~><p>Example:</p></div~~> <div class="o~~list arabic"><ol class="arabic~~">~~ <div class="sect2"> <h3 id="_complex_mapping_example">Complex mapping example</h3> <div class="imageblock"> <div class="content"> ~~~~<li>~~ ~~<p>~~ ~~Request to run D/1/res~~ ~~</p>~~ ~~</li>~~ ~~<li>~~ ~~<p>~~ Meg~~ate~~s~~t uses ru~~le ~~"(\d+)/res" → "\1/aa" to create~~ item ~~C/1/aa fr~~om ~~D/1/res~~ </p>~~ <img src="complex-itemmap.png" alt="complex-itemmap.png"> </div> ~~</li>~~ ~~<li>~~ ~~<p>~~ ~~Full list to be run is now: D/1/res, C/1/aa~~ ~~</p>~~ ~~</li>~~ ~~<li>~~ ~~<p>~~ ~~Megatest uses rule "(\d+)/aa" → "aa/\1" to create item A/aa/1~~ ~~</p>~~ ~~</li>~~ ~~<li>~~ ~~<p>~~ ~~Full list to be run is now: D/1/res, C/1/aa, A/aa/1~~ ~~</p>~~ ~~</li>~~ ~~</ol>~~</div> </div> <div class="paragraph"><p>We accomplish this by configuring the testconfigs of our tests C D and E as follows:</p></div> <div class="listingblock"> ~~<div class="title">Testconfig for Test C</div>~~ <div class="title">Testconfig for Test E has</div> <div class="content monospaced"> <pre>[requirements] ~~waiton ~~A B~~~~ waiton C ~~[itemmap]~~ itemmap (\d+)/res \1/bb</pre> ~~A (\d+)/aa aa/\1~~ ~~B (\d+)/bb</pre>~~ </div></div> <div class="listingblock"> ~~<div class="title">Testconfig for Test D</div>~~ <div class="title">Testconfig for Test D has</div> <div class="content monospaced"> <pre>[requirements] waiton C itemmap (\d+)/res \1/aa</pre> </div></div> <div class="listingblock"> ~~<div class="title">Testconfig for Test E</div>~~ <div class="title">Testconfig for Test C has</div> <div class="content monospaced"> <pre>[requirements] ~~waiton C itemmap ~~(\d+)/res \1/bb</pre>~~~~ waiton A B [itemmap] A (\d+)/aa aa/\1 B (\d+)/bb bb/\1</pre> </div></div> <div class="listingblock"> <div class="title">Testconfigs for Test B and Test A have no waiton or itemmap configured</div> <div class="content monospaced"> <pre></pre> </div></div> <div class="olist arabic"><div class="title">Walk through one item — we want the following to happen for testpatt <span class="monospaced">D/1/res</span> (see blue boxes in complex itemmaping figure above):</div><ol class="arabic"> <li> <p> eg from command line <span class="monospaced">megatest -run -testpatt D/1/res -target mytarget -runname myrunname</span> </p> </li> <li> <p> Full list to be run is now: <span class="monospaced">D/1/res</span> </p> </li> <li> <p> Test D has a waiton - test C. Test D’s itemmap rule <span class="monospaced">itemmap (\d+)/res \1/aa</span> → causes <span class="monospaced">C/1/aa</span> to run before <span class="monospaced">D/1/res</span> </p> </li> <li> <p> Full list to be run is now: <span class="monospaced">D/1/res</span>, <span class="monospaced">C/1/aa</span> </p> </li> <li> <p> Test C was a waiton - test A. Test C’s rule <span class="monospaced">A (\d+)/aa aa/\1</span> → causes <span class="monospaced">A/aa/1</span> to run before <span class="monospaced">C/1/aa</span> </p> </li> <li> <p> Full list to be run is now: <span class="monospaced">D/1/res</span>, <span class="monospaced">C/1/aa</span>, <span class="monospaced">A/aa/1</span> </p> </li> <li> <p> Test A has no waitons. All waitons of all tests in full list have been processed. Full list is finalized. </p> </li> </ol></div> </div> ~~<div class="sect3"> <h4 id="_dynamic_flow_dependency_tree">Dynamic Flow Dependency Tree</h4>~~ <div class="sect2"> <h3 id="_itemstable">itemstable</h3> <div class="paragraph"><p>An alternative to defining items is the itemstable section. This lets you define the itempath in a table format rather than specifying components and relying on getting all permutations of those components.</p></div> </div> <div class="sect2"> <h3 id="_dynamic_flow_dependency_tree">Dynamic Flow Dependency Tree</h3> <div class="listingblock"> <div class="title">Autogeneration waiton list for dynamic flow dependency trees</div> <div class="content monospaced"> <pre>[requirements] # With a toplevel test you may wish to generate your list # of tests to run dynamically # waiton #{shell get-valid-tests-to-run.sh}</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_run_time_limit_2">Run time limit</h4>~~ <div class="sect2"> <h3 id="_run_time_limit_2">Run time limit</h3> <div class="listingblock"> <div class="content monospaced"> <pre>[requirements] runtimelim 1h 2m 3s # this will automatically kill the test if it runs for more than 1h 2m and 3s</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_skip">Skip</h4>~~ <div class="sect2"> <h3 id="_skip">Skip</h3> <div class="paragraph"><p>A test with a skip section will conditional skip running.</p></div> <div class="listingblock"> <div class="title">Skip section example</div> <div class="content monospaced"> <pre>[skip] prevrunning x # rundelay 30m 15s</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_skip_on_still_running_tests">Skip on Still-running Tests</h4>~~ <div class="sect2"> <h3 id="_skip_on_still_running_tests">Skip on Still-running Tests</h3> <div class="listingblock"> <div class="content monospaced"> <pre># NB// If the prevrunning line exists with any* value the test will # automatically SKIP if the same-named test is currently RUNNING. The # "x" can be any string. Comment out the prevrunning line to turn off # skip. [skip] prevrunning x</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_skip_if_a_file_exists">Skip if a File Exists</h4>~~ <div class="sect2"> <h3 id="_skip_if_a_file_exists">Skip if a File Exists</h3> <div class="listingblock"> <div class="content monospaced"> <pre>[skip] fileexists /path/to/a/file # skip if /path/to/a/file exists</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_skip_if_test_ran_more_recently_than_specified_time">Skip if test ran more recently than specified time</h4>~~ <div class="sect2"> <h3 id="_skip_if_a_file_does_not_exist">Skip if a File Does not Exist</h3> <div class="listingblock"> <div class="content monospaced"> <pre>[skip] filenotexists /path/to/a/file # skip if /path/to/a/file does not exist</pre> </div></div> </div> <div class="sect2"> <h3 id="_skip_if_a_script_completes_with_0_status">Skip if a script completes with 0 status</h3> <div class="listingblock"> <div class="content monospaced"> <pre>[skip] script /path/to/a/script # skip if /path/to/a/script completes with 0 status</pre> </div></div> </div> <div class="sect2"> <h3 id="_skip_if_test_ran_more_recently_than_specified_time">Skip if test ran more recently than specified time</h3> <div class="listingblock"> <div class="title">Skip if this test has been run in the past fifteen minutes and 15 seconds.</div> <div class="content monospaced"> <pre>[skip] rundelay 15m 15s</pre> </div></div> </div> ~~<div class="sect3"> <h4 id="_disks">Disks</h4>~~ <div class="sect2"> <h3 id="_disks">Disks</h3> <div class="paragraph"><p>A disks section in testconfig will override the disks section in megatest.config. This can be used to allocate disks on a per-test or per item basis.</p></div> </div> <div class="sect3"> <h4 id="_controlled_waiver_propagation">Controlled waiver propagation</h4> <div class="paragraph"><p>If test is FAIL and previous test in run with same MT_TARGET is WAIVED ~~then apply the following rules from the testconfig:~~ ~~If a waiver check is specified in~~ the testconfig apply the check and if it passes then set this FAIL to ~~WAIVED</p></div>~~ <div class="paragraph"><p>Waiver check has two parts, 1) a list of waiver, rulename, ~~filepatterns and 2) the rulename script spec (note that "diff" and "logpro" are predefined)</p></div>~~ <div class="sect2"> <h3 id="_controlled_waiver_propagation">Controlled waiver propagation</h3> <div class="paragraph"><p>If test is FAIL and previous test in run with same MT_TARGET is WAIVED or if the test/itempath is listed under the matching target in the waivers roll forward file (see below for file spec) then apply the following rules from the testconfig: If a waiver check is specified in the testconfig apply the check and if it passes then set this FAIL to WAIVED</p></div> <div class="paragraph"><p>Waiver check has two parts, 1) a list of waiver, rulename, filepatterns and 2) the rulename script spec (note that "diff" and "logpro" are predefined)</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>###### EXAMPLE FROM testconfig ######### # matching file(s) will be diff'd with previous run and logpro applied # if PASS or WARN result from logpro then WAIVER state is set # [waivers] # logpro_file rulename input_glob waiver_1 logpro lookittmp.log [waiver_rules] # This builtin rule is the default if there is no <waivername>.logpro file # diff diff %file1% %file2% # This builtin rule is applied if a <waivername>.logpro file exists # logpro diff %file1% %file2% \| logpro %waivername%.logpro %waivername%.html</pre> </div></div> <div class="sect3"> <h4 id="_waiver_roll_forward_files">Waiver roll-forward files</h4> <div class="paragraph"><p>To transfer waivers from one Megatest area to another it is possible to dump waivers into a file and reference that file in another area.</p></div> <div class="listingblock"> <div class="title">Dumping the waivers</div> <div class="content monospaced"> <pre>megatest -list-waivers -runname %-a > mywaivers.dat</pre> </div></div> <div class="listingblock"> <div class="title">Referencing the saved waivers</div> <div class="content monospaced"> <pre># In megatest.config, all files listed will be loaded - recomended to use # variables to select directorys to minimize what gets loaded. [setup] waivers-dirs /path/to/waiver/files /another/path/to/waiver/files</pre> </div></div> <div class="listingblock"> <div class="title">Waiver files format</div> <div class="content monospaced"> <pre>[the/target/here] # comments are fine testname1/itempath A comment about why it was waived testname2 A comment for a non-itemized test</pre> </div></div> </div> </div> <div class="sect2"> <h3 id="_ezsteps">Ezsteps</h3> <div class="paragraph"><p>Ezsteps is the recommended way to implement tests and automation in Megatest.</p></div> <div class="admonitionblock"> <table><tr> <td class="icon"> <img src="/usr/images/icons/note.png" alt="Note"> </td> <td class="content">Each ezstep must be a single line. Use the [scripts] mechanism to create multiline scripts (see example below).</td> </tr></table> </div> <div class="listingblock"> <div class="title">Example ezsteps with logpro rules</div> <div class="content monospaced"> <pre>[ezsteps] lookittmp ls /tmp [logpro] lookittmp ;; Note: config file format supports multi-line entries where leading whitespace is removed from each line ;; a blank line indicates the end of the block of text (expect:required in "LogFileBody" > 0 "A file name that should never exist!" #/This is a awfully stupid file name that should never be found in the temp dir/)</pre> </div></div> <div class="sect3"> <h4 id="_automatic_environment_propagation_with_ezsteps">Automatic environment propagation with Ezsteps</h4> <div class="paragraph"><p>Turn on ezpropvars or simply give your step name an extension of .sh or .csh. The environment variables will be propagated.</p></div> <div class="admonitionblock"> <table><tr> <td class="icon"> <img src="/usr/images/icons/note.png" alt="Note"> </td> <td class="content">aliases and variables with strange whitespace or characters will not propagate correctly. Put in a ticket on the <a href="http://www.kiatoa.com/fossils/megatest">http://www.kiatoa.com/fossils/megatest</a> site if you need support for a specific strange character combination.</td> </tr></table> </div> <div class="listingblock"> <div class="title">Turn on auto propagate for bash</div> <div class="content monospaced"> <pre>[setup] ezpropvars sh /bin/bash</pre> </div></div> <div class="listingblock"> <div class="title">Turn on auto propagate for csh</div> <div class="content monospaced"> <pre>[setup] ezpropvars csh /bin/csh</pre> </div></div> <div class="listingblock"> <div class="title">Example of auto propagation using extensions</div> <div class="content monospaced"> <pre>[ezsteps] step1.sh export SOMEVAR=$(ps -def \| wc -l);ls /tmp # The next step will get the value of $SOMEVAR from step1.sh step2.sh echo $SOMEVAR</pre> </div></div> <div class="listingblock"> <div class="title">Example of multi-line script</div> <div class="content monospaced"> <pre>[scripts] tarresults tar cfvz $DEST/srcdir1.tar.gz srcdir1 tar cfvz $DEST/srcdir2.tar.gz srcdir2 ~~<div class="paragraph"><p>To transfer the environment to the next step you can do the following:</p></div>~~ [setup] ezpropvars sh [ezsteps] step1 DEST=/tmp/targz;source tarresults</pre> </div></div> <div class="paragraph"><p>The above example will result in files; tarresults and ez_step1 being created in the test dir.</p></div> </div> </div> <div class="sect2"> <h3 id="_scripts">Scripts</h3> <div class="listingblock"> <div class="title">Specifying scripts inline (best used for only simple scripts)</div> <div class="content monospaced"> <pre>[scripts] loaddb #!/bin/bash sqlite3 $1 <<EOF .mode tabs .import $2 data .q EOF</pre> </div></div> <div class="paragraph"><p>The above snippet results in the creation of an executable script called "loaddb" in the test directory. NOTE: every line in the script must be prefixed with the exact same number of spaces. Lines beginning with a # will not work as expected. Currently you cannot indent intermediate lines.</p></div> <div class="listingblock"> <div class="title">Full example with ezsteps, logpro rules, scripts etc.</div> <div class="content monospaced"> <pre># You can include a common file # [include #{getenv MT_RUN_AREA_HOME}/global-testconfig.inc] ~~<pre>$MT_MEGATEST -env2file .ezsteps/${stepname}</pre>~~ # Use "var" for a scratch pad # [var] dumpsql select * from data; sepstr ..................................... # NOT IMPLEMENTED YET! # [ezsteps-addendum] prescript something.sh postscript something2.sh # Add additional steps here. Format is "stepname script" [ezsteps] importdb loaddb prod.db prod.sql dumpprod dumpdata prod.db "#{get var dumpsql}" diff (echo "prod#{get var sepstr}test";diff --side-by-side \ dumpprod.log reference.log ;echo DIFFDONE) [scripts] loaddb #!/bin/bash sqlite3 $1 <<EOF .mode tabs .import $2 data .q EOF dumpdata #!/bin/bash sqlite3 $1 <<EOF .separator , $2 .q EOF # Test requirements are specified here [requirements] waiton setup priority 0 # Iteration for your test is controlled by the items section # The complicated if is needed to allow processing of the config for the dashboard when there are no actual runs. [items] THINGNAME [system generatethings.sh \| sort -u] # Logpro rules for each step can be captured here in the testconfig # note: The ;; after the stepname and the leading whitespace are required # [logpro] inputdb ;; (expect:ignore in "LogFileBody" < 99 "Ignore error in comments" #/^\/\/.error/) (expect:warning in "LogFileBody" = 0 "Any warning" #/warn/) (expect:required in "LogFileBody" > 0 "Some data found" #/^[a-z]{3,4}[0-9]+_r./) diff ;; (expect:ignore in "LogFileBody" < 99 "Ignore error in comments" #/^\/\/.error/) (expect:warning in "LogFileBody" = 0 "Any warning" #/warn/) (expect:error in "LogFileBody" = 0 "< or > indicate missing entry" (list #/(<\|>)/ #/error/i)) (expect:error in "LogFileBody" = 0 "Difference in data" (list #/\s+\\|\s+/ #/error/i)) (expect:required in "LogFileBody" > 0 "DIFFDONE Marker found" #/DIFFDONE/) (expect:required in "LogFileBody" > 0 "Some things found" #/^[a-z]{3,4}[0-9]+_r./) # NOT IMPLEMENTED YET! # ## Also: enhance logpro to take list of command files: file1,file2... [waivers] createprod{target=%78/%/%/%} ;; (disable:required "DIFFDONE Marker found") (disable:error "Some error") (expect:waive in "LogFileBody" < 99 "Waive if failed due to version" #/\w+3\.6.*/) # test_meta is a section for storing additional data on your test [test_meta] author matt owner matt description Compare things tags tagone,tagtwo reviewed never</pre> </div></div> </div> <div class="sect2"> <h3 id="_triggers">Triggers</h3> ~~<div class="paragraph"><p>In your testconfig triggers can be specified</p></div>~~ <div class="paragraph"><p>In your testconfig or megatest.config triggers can be specified</p></div> <div class="listingblock"> <div class="title">Triggers spec</div> <div class="content monospaced"> <pre>[triggers] # Call script running.sh when test goes to state=RUNNING, status=PASS RUNNING/PASS running.sh # Call script running.sh any time state goes to RUNNING RUNNING/ running.sh # Call script onpass.sh any time status goes to PASS PASS/ onpass.sh</pre> </div></div> ~~<div class="paragraph"><p>Scripts called will have; test-id test-rundir trigger, added to the commandline.</p></div>~~ <div class="paragraph"><p>Scripts called will have; test-id test-rundir trigger test-name item-path state status event-time, added to the commandline.</p></div> <div class="paragraph"><p>HINT</p></div> <div class="paragraph"><p>To start an xterm (useful for debugging), use a command line like the following:</p></div> <div class="listingblock"> <div class="title">Start an xterm using a trigger for test completed.</div> <div class="content monospaced"> <pre>[triggers] COMPLETED/ xterm -e bash -s --</pre> </div></div> <div class="admonitionblock"> <table><tr> <td class="icon"> ~~<img src="/~~nfs/pdx/disks/ice.disk.002/icfadm/pkgs/asciidoc/8.6.7~~/images/icons/note.png" alt="Note">~~ <img src="/usr/images/icons/note.png" alt="Note"> </td> ~~<td class="content">There is a trailing space after the --</td>~~ <td class="content">There is a trailing space after the double-dash</td> </tr></table> </div> <div class="paragraph"><p>There are a number of environment variables available to the trigger script but since triggers can be called in various contexts not all variables are available at all times. The trigger script should check for the variable and fail gracefully if it doesn’t exist.</p></div> <table class="tableblock frame-topbot grid-all" style=" width:90%; "> <caption class="title">Table 5. Environment variables visible to the trigger script</caption> <col style="width:50%;"> <col style="width:50%;"> <thead> <tr> <th class="tableblock halign-left valign-top" > Variable </th> <th class="tableblock halign-left valign-top" > Purpose</th> </tr> </thead> <tbody> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_TEST_RUN_DIR</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The directory where Megatest ran this test</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_CMDINFO</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">Encoded command data for the test</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_DEBUG_MODE</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">Used to pass the debug mode to nested calls to Megatest</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_RUN_AREA_HOME</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">Megatest home area</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_TESTSUITENAME</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The name of this testsuite or area</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_TEST_NAME</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The name of this test</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_ITEM_INFO</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The variable and values for the test item</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_MEGATEST</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">Which Megatest binary is being used by this area</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_TARGET</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The target variable values, separated by <em>/</em></p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_LINKTREE</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The base of the link tree where all run tests can be found</p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_ITEMPATH</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The values of the item path variables, separated by <em>/</em></p></td> </tr> <tr> <td class="tableblock halign-left valign-top" ><p class="tableblock">MT_RUNNAME</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock">The name of the run</p></td> </tr> </tbody> </table> </div> <div class="sect2"> <h3 id="_override_the_toplevel_html_file">Override the Toplevel HTML File</h3> <div class="paragraph"><p>Megatest generates a simple html file summary for top level tests of iterated tests. The generation can be overridden. NOTE: the output of the script is captured from stdout to create the html.</p></div> <div class="listingblock">
︙
1959 1960 1961 1962 1963 1964 1965 ~~1966~~ 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 ~~1987~~ 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 ~~2000 2001 2002~~ 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 ~~2016~~ 2017 2018 2019 2020 2021 2022 2023	3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467	- + - + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +	# Within the archive the data is structured like this: # <target>/<runname>/<test>/ archive0 /mfs/myarchive-data/adisk1</pre> </div></div> </div> </div> <div class="sect1"> ~~<h2 id="_~~handling_~~environment_variables">~~Handling~~ Environment Variables</h2>~~ <h2 id="_environment_variables">Environment Variables</h2> <div class="sectionbody"> <div class="paragraph"><p>It is often necessary to capture and or manipulate environment variables. Megatest has some facilities built in to help.</p></div> <div class="sect2"> <h3 id="_capture_variables">Capture variables</h3> <div class="listingblock"> <div class="title">Commands</div> <div class="content monospaced"> <pre># capture the current enviroment into a db called envdat.db under # the context "before" megatest -envcap before # capture the current environment into a db called startup.db with # context "after" megatest -envcap after startup.db # write the diff from before to after megatest -envdelta before-after -dumpmode bash</pre> </div></div> <div class="paragraph"><p>Dump modes include bash, csh and config. You can include config data ~~into megatest.config or runconfigs.config.~~</p></d~~iv>~~ into megatest.config, runconfigs.config and testconfig files. This is useful for capturing a complex environment in a special-purpose test and then utilizing that environment in downstream tests.</p></div> <div class="listingblock"> <div class="title">Example of generating and using config data</div> <div class="content monospaced"> <pre>megatest -envcap original # do some stuff here megatest -envcap munged megatest -envdelta original-munged -dumpmode ini -o modified.config</pre> </div></div> <div class="paragraph"><p>Then in runconfigs.config</p></div> <div class="listingblock"> <div class="title">Example of using modified.config in a testconfig</div> <div class="content monospaced"> ~~~~<pre>cat testconfig~~ [pre-launch-env-vars]~~ <pre>[pre-launch-env-vars] [include modified.config]</pre> </div></div> </div> </div> </div> <div class="sect1"> <h2 id="_managing_old_runs">Managing Old Runs</h2> <div class="sectionbody"> <div class="paragraph"><p>It is often desired to keep some older runs around but this must be balanced with the costs of disk space.</p></div> <div class="olist arabic"><ol class="arabic"> <li> <p> Use -remove-keep </p> </li> <li> <p> Use -archive (can also be done from the -remove-keep interface) </p> </li> <li> <p> use -remove-runs with -keep-records </p> </li> </ol></div> <div class="listingblock"> <div class="title">For each target, remove all runs but the most recent 3 if they are over 1 week old</div> <div class="content monospaced"> <pre># use -precmd 'sleep 5;nbfake' to limit overloading the host computer but to allow the removes to run in parallel. megatest -actions print,remove-runs -remove-keep 3 -target %/%/%/% -runname % -age 1w -precmd 'sleep 5;nbfake'"</pre> </div></div> </div> </div> <div class="sect1"> <h2 id="_nested_runs">Nested Runs</h2> <div class="sectionbody"> <div class="paragraph"><p>A Megatest test can run a full Megatest run in either the same Megatest area or in another area. This is a powerful way of chaining complex suites of tests and or actions.</p></div> <div class="paragraph"><p>If you are not using the current area you can use ezsteps to retrieve and setup the sub-Megatest run area.</p></div> <div class="paragraph"><p>In the testconfig:</p></div> <div class="listingblock"> <div class="content monospaced"> <pre>[subrun] # Required: wait for the run or just launch it # if no then the run will be an automatic PASS irrespective of the actual result run-wait yes\|no # Optional: where to execute the run. Default is the current runarea run-area /some/path/to/megatest/area # Optional: method to use to determine pass/fail status of the run # auto (default) - roll up the net state/status of the sub-run # logpro - use the provided logpro rules, happens automatically if there is a logpro section # passfail auto\|logpro # Example of logpro: passfail logpro # Optional: logpro ;; if this section exists then logpro is used to determine pass/fail (expect:required in "LogFileBody" >= 1 "At least one pass" #/PASS/) (expect:error in "LogFileBody" = 0 "No FAILs allowed" #/FAIL/) # Optional: target translator, default is to use the parent target target #{shell somescript.sh} # Optional: runname translator/generator, default is to use the parent runname run-name #{somescript.sh} # Optional: testpatt spec, default is to first look for TESTPATT spec from runconfigs unless there is a contour spec test-patt %/item1,test2 # Optional: contour spec, use the named contour from the megatest.config contour spec contour contourname ### NOTE: Not implemented yet! Let us know if you need this feature. # Optional: mode-patt, use this spec for testpatt from runconfigs mode-patt TESTPATT # Optional: tag-expr, use this tag-expr to select tests tag-expr quick # Optional: (not yet implemented, remove-runs is always propagated at this time), propagate these actions from the parent # test # Note// default is % for all propagate remove-runs archive ...</pre> </div></div> </div> </div> <div class="sect1"> <h2 id="_programming_api">Programming API</h2> <div class="sectionbody"> <div class="paragraph"><p>These routines can be called from the megatest repl.</p></div> <table class="tableblock frame-topbot grid-all" style=" width:70%; "> ~~<caption class="title">Table 4. API Keys Related Calls</caption>~~ <caption class="title">Table 6. API Keys Related Calls</caption> <col style="width:14%;"> <col style="width:28%;"> <col style="width:28%;"> <col style="width:28%;"> <thead> <tr> <th class="tableblock halign-center valign-top" >API Call </th>
︙
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 ~~2059~~ 2060 2061 2062 2063 2064 2065 2066 ~~2067 2068~~ 2069 2070 2071 2072	3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555	+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + +	<td class="tableblock halign-left valign-top" ><p class="tableblock monospaced"></p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced">( key1 key2 … )</p></td> <td class="tableblock halign-left valign-top" ><p class="tableblock monospaced"></p></td> </tr> </tbody> </table> </div> </div> <div class="sect1"> <h2 id="_test_plan">Test Plan</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_tests">Tests</h3> <div class="paragraph"><p>itemwait\|33</p></div> <div class="paragraph"><p>rerun-downstream-item\|20</p></div> <div class="paragraph"><p>rerunclean\|20</p></div> <div class="paragraph"><p>fullrun\|18</p></div> <div class="paragraph"><p>goodtests\|18</p></div> <div class="paragraph"><p>kill-rerun\|17</p></div> <div class="paragraph"><p>items-runconfigvars\|16</p></div> <div class="paragraph"><p>ro_test\|16</p></div> <div class="paragraph"><p>runconfig-tests\|16</p></div> <div class="paragraph"><p>env-pollution\|13</p></div> <div class="paragraph"><p>itemmap\|11</p></div> <div class="paragraph"><p>testpatt_envvar\|10</p></div> <div class="paragraph"><p>toprun\|10</p></div> <div class="paragraph"><p>chained-waiton\|8</p></div> <div class="paragraph"><p>skip-on-fileexists\|8</p></div> <div class="paragraph"><p>killrun_preqfail\|7</p></div> <div class="paragraph"><p>subrun\|6</p></div> <div class="paragraph"><p>dependencies\|5</p></div> <div class="paragraph"><p>itemwait-simple\|4</p></div> <div class="paragraph"><p>rollup\|4</p></div> <div class="paragraph"><p>end-of-run\|3</p></div> <div class="paragraph"><p>killrun\|3</p></div> <div class="paragraph"><p>listener\|3</p></div> <div class="paragraph"><p>test2\|3</p></div> <div class="paragraph"><p>testpatt\|3</p></div> <div class="paragraph"><p>env-pollution-usecacheno\|2</p></div> <div class="paragraph"><p>set-values\|2 envvars\|1 listruns-tests\|1 subrun-usecases\|1</p></div> </div> </div> </div> <div class="sect1"> <h2 id="_megatest_internals">Megatest Internals</h2> <div class="sectionbody"> <div class="imageblock graphviz"> <div class="content"> <img src="server.png" alt="server.png"> </div> </div> </div> </div> <div class="sect1"> ~~<h2 id="_~~example_~~index">~~Example~~ Index</h2>~~ <h2 id="_index">Index</h2> <div class="sectionbody"> </div> </div> </div> <div id="footnotes"><hr></div> <div id="footer"> <div id="footer-text"> ~~Version 1.0<br> Last updated ~~2016-12-12 13:03:08 PST~~~~ Version 1.5<br> Last updated 2020-10-11 21:26:10 MST </div> </div> </body> </html>