1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
|
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "FileUtility.hpp"
#include <cstdlib>
#include <cstdio>
#include <ctime>
#include <vector>
#include <climits>
#include <cstring>
#if defined(WIN32)
#include <direct.h>
#define PATH_MAX _MAX_PATH
#define chdir _chdir
#define getcwd _getcwd
#define mkdir _mkdir
#else
#if !defined(PATH_MAX)
#define PATH_MAX 2000
#endif
#define DIR_MODE_BITS 509
#include <dirent.h>
#include <unistd.h>
extern "C" int mkdir(const char*, mode_t mode);
#endif
#if defined(XALAN_CLASSIC_IOSTREAMS)
#include <iostream.h>
#include <strstream.h>
#else
#include <iostream>
#include <strstream>
#endif
#if !defined(NDEBUG) && defined(_MSC_VER)
#include <crtdbg.h>
#endif
#include <xercesc/sax/SAXException.hpp>
#include <xalanc/PlatformSupport/DirectoryEnumerator.hpp>
#include <xalanc/PlatformSupport/DOMStringHelper.hpp>
#include <xalanc/PlatformSupport/XalanOutputStreamPrintWriter.hpp>
#include <xalanc/PlatformSupport/XalanFileOutputStream.hpp>
#include <xalanc/XMLSupport/FormatterToXML.hpp>
#include <xalanc/XMLSupport/FormatterTreeWalker.hpp>
#include <xalanc/XalanSourceTree/XalanSourceTreeDOMSupport.hpp>
#include <xalanc/XalanSourceTree/XalanSourceTreeParserLiaison.hpp>
#include <xalanc/XalanSourceTree/XalanSourceTreeDocument.hpp>
#include <xalanc/XSLT/StylesheetRoot.hpp>
#include <xalanc/XalanTransformer/XalanCompiledStylesheet.hpp>
#include <xalanc/XalanTransformer/XalanTransformer.hpp>
#include "XMLFileReporter.hpp"
XALAN_CPP_NAMESPACE_BEGIN
const char* const xalanNodeTypes[] =
{
"UNKNOWN_NODE",
"ELEMENT_NODE",
"ATTRIBUTE_NODE",
"TEXT_NODE",
"CDATA_SECTION_NODE",
"ENTITY_REFERENCE_NODE",
"ENTITY_NODE",
"PROCESSING_INSTRUCTION_NODE",
"COMMENT_NODE",
"DOCUMENT_NODE",
"DOCUMENT_TYPE_NODE",
"DOCUMENT_FRAGMENT_NODE",
"NOTATION_NODE"
};
XALAN_USING_STD(cerr)
XALAN_USING_STD(cout)
XALAN_USING_STD(endl)
const XalanDOMString FileUtility::s_emptyString;
FileUtility::reportStruct::reportStruct() :
theDrive(),
testOrFile(),
xmlFileURL(),
xslFileURL(),
xmlFormat(),
msg(0),
currentNode(),
actual(),
expected(),
pass(0),
fail(0),
nogold(0)
{
}
void
FileUtility::reportStruct::reset()
{
clear(testOrFile);
msg = "";
clear(currentNode);
clear(actual);
clear(expected);
}
FileUtility::cmdParams::cmdParams() :
help(),
base(),
output(),
gold(),
sub(),
source(0),
skip(false),
iters(0)
{
}
const char*
FileUtility::cmdParams::getHelpMessage()
{
help << '\0';
const char* const data = help.str();
#if defined(HPUX)
help.rdbuf() -> freeze(false);
#else
help.freeze(false);
#endif
return data;
}
FileUtility::FileUtility() :
data(),
args()
{
cout << endl
<< "Using Xalan version "
<< XALAN_FULLVERSIONDOT
<< endl
<< "Using Xerces version "
<< XERCES_FULLVERSIONDOT
<< endl
<< endl;
}
#if !defined(WIN32)
XalanDOMString
FileUtility::getDrive()
{
return XalanDOMString();
}
#else
XalanDOMString
FileUtility::getDrive()
{
const char temp[] =
{
char(_getdrive() + 'A' - 1),
':',
'\0'
};
return XalanDOMString(temp, sizeof(temp) - 1);
}
#endif
bool
FileUtility::getParams(
int argc,
char* argv[],
const char* outDir,
bool fsetGold)
{
bool fSuccess = true; // Used to continue argument loop
bool fsetOut = true; // Set default output directory, set to false if data is provided
args.skip = true; // Default values for performance testing parameters.
args.iters = 3;
// Insure that required "-base" argument is there.
//
if (argc == 1 || argv[1][0] == '-')
{
cout << args.getHelpMessage();
return false;
}
else
{
if (checkDir(XalanDOMString(argv[1])))
{
assign(args.base, XalanDOMString(argv[1]));
}
else
{
cout << endl << "Given base directory \"" << argv[1] << "\" does not exist" << endl;
cout << args.getHelpMessage();
return false;
}
}
// Get the rest of the arguments.
//
for (int i = 2; i < argc && fSuccess == true; ++i)
{
if(!stricmp("-out", argv[i]))
{
++i;
if(i < argc && argv[i][0] != '-')
{
assign(args.output, XalanDOMString(argv[i]));
append(args.output, s_pathSep);
checkAndCreateDir(args.output);
fsetOut = false;
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else if(!stricmp("-gold", argv[i]))
{
++i;
if(i < argc && argv[i][0] != '-')
{
assign(args.gold, XalanDOMString(argv[i]));
if ( !checkDir(args.gold) )
{
cout << "Given Gold dir - " << c_str(TranscodeToLocalCodePage(args.gold)) << " - does not exist" << endl;
fSuccess = false;
}
append(args.gold, s_pathSep);
fsetGold = false;
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else if(!stricmp("-source", argv[i]))
{
++i;
if(i < argc && argv[i][0] != '-')
{
if (stricmp(argv[i],"XPL") == 0)
{
args.source = 1;
outDir = "DOM-XALAN";
}
else if (stricmp(argv[i], "DOM") == 0)
{
args.source = 2;
outDir = "DOM-XERCES";
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else if(!stricmp("-sub", argv[i]))
{
++i;
if(i < argc && argv[i][0] != '-')
{
assign(args.sub, XalanDOMString(argv[i]));
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else if(!stricmp("-i", argv[i]))
{
args.skip = false;
}
else if(!stricmp("-iter", argv[i]))
{
++i;
// Make sure number is there and is greater then zero
if(i < argc && atol(argv[i]) > 0)
{
args.iters = atol(argv[i]);
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
}
else
{
cout << args.getHelpMessage();
fSuccess = false;
}
} // End of for-loop
// Do we need to set the default output directory??
//
if (fsetOut)
{
unsigned int ii = lastIndexOf(args.base,charAt(s_pathSep,0));
if (ii < length(args.base))
{
args.output.assign(args.base, 0, ii + 1);
}
append(args.output,XalanDOMString(outDir));
checkAndCreateDir(args.output);
append(args.output,s_pathSep);
}
// Do we need to set the default gold directory??
//
if (fsetGold)
{
args.gold = args.base;
append(args.gold,XalanDOMString("-gold"));
if ( !checkDir(args.gold) )
{
cout << "Assumed Gold dir - " << c_str(TranscodeToLocalCodePage(args.gold)) << " - does not exist" << endl;
fSuccess = false;
}
append(args.gold,s_pathSep);
}
// Add the path seperator to the end of the base directory
// here after we've finished using it for all directory creation.
//
append(args.base,s_pathSep);
return fSuccess;
}
// This routine retrieves test file names from specified directories.
// Inputs: baseDir: typically "conf" or "perf"
// relDir: sub-directory to search.
//
// Notes: It builds the searchSpecification by concatenating all the
// necessary components.
//
FileUtility::FileNameVectorType
FileUtility::getTestFileNames(
const XalanDOMString& baseDir,
const XalanDOMString& relDir,
bool useDirPrefix)
{
const XalanDOMString searchSuffix(XALAN_STATIC_UCODE_STRING("*.xsl"));
XalanDOMString searchSpecification;
// Allow directory search w/o mandating files start with directory name. Required for files
// garnered from XSLTMARK performance directory exm.
if (useDirPrefix)
{
assign(searchSpecification, baseDir + relDir + s_pathSep + relDir + searchSuffix);
}
else
{
assign(searchSpecification, baseDir + relDir + s_pathSep + searchSuffix);
}
DirectoryEnumeratorFunctor<FileNameVectorType, XalanDOMString> theEnumerator;
FileNameVectorType theFiles;
theEnumerator(searchSpecification, theFiles);
return theFiles;
}
/* This routine retrieves all sub-directories from the specified directories.
// Inputs: rootDirectory: typically "conf" or "perf"
//
// Notes: The searchSpecification in this case is just "*".
// */
FileUtility::FileNameVectorType
FileUtility::getDirectoryNames(const XalanDOMString& rootDirectory)
{
const XalanDOMString dirSpec(XALAN_STATIC_UCODE_STRING("*"));
DirectoryEnumeratorFunctor<FileNameVectorType, XalanDOMString, DirectoryFilterPredicate> theEnumerator;
FileNameVectorType theFiles;
theEnumerator(XalanDOMString(rootDirectory), XalanDOMString(dirSpec), theFiles);
return theFiles;
}
bool FileUtility::checkDir(const XalanDOMString& directory )
{
char buffer[PATH_MAX];
getcwd(buffer, PATH_MAX);
bool fResult = false;
if ( !chdir(c_str(TranscodeToLocalCodePage(directory))) )
{
fResult = true;
}
chdir(buffer);
return fResult;
}
void FileUtility::checkAndCreateDir(const XalanDOMString& directory)
{
char buffer[PATH_MAX];
getcwd(buffer, PATH_MAX);
if ( (chdir(c_str(TranscodeToLocalCodePage(directory)))) )
{
//cout << "Couldn't change to " << directory << ", will create it." << endl;
#if defined(WIN32)
if ( !mkdir(c_str(TranscodeToLocalCodePage(directory))))
#else
if ( !mkdir(c_str(TranscodeToLocalCodePage(directory)), DIR_MODE_BITS))
#endif
{
cout << directory << " created." << endl;
}
else
{
cout << directory << " NOT created." << endl;
}
}
chdir(buffer);
}
/* This routine generates file names based on the provide suffix
// Inputs: theXMLFileName: typically "conf" or "perf"
// suffix: typically "xsl" or "out".
//
// Notes:
*/
XalanDOMString
FileUtility::generateFileName(
const XalanDOMString& theXMLFileName,
const char* suffix,
bool* status)
{
XalanDOMString targetFile;
int thePeriodIndex = -1;
const int theLength = length(theXMLFileName);
for (int i = theLength - 1; i > 0; i--)
{
if (charAt(theXMLFileName, i) == XalanUnicode::charFullStop)
{
thePeriodIndex = i; // charFullStop is the dot (x2E)
break;
}
}
if (thePeriodIndex != -1)
{
targetFile.assign(theXMLFileName, 0, thePeriodIndex + 1);
targetFile += XalanDOMString(suffix);
}
// Check the .xml file exists.
if (!strcmp(suffix,"xml"))
{
FILE* fileHandle = fopen(c_str(TranscodeToLocalCodePage(targetFile)), "r");
if (fileHandle == 0)
{
cout << "TEST ERROR: File Missing: " << targetFile << endl;
if (status != 0)
{
*status = false;
}
}
else
{
fclose(fileHandle);
}
}
return targetFile;
}
/* This routine generates a Unique Runid.
// Inputs: None
//
// Notes: The format is mmddhhmm. For example
// 03151046 is "Mar 15 10:46"
*/
XalanDOMString
FileUtility::generateUniqRunid()
{
#if defined(XALAN_STRICT_ANSI_HEADERS)
using std::tm;
using std::time;
using std::localtime;
using std::strftime;
#endif
struct tm *newtime;
time_t long_time;
char tmpbuf[10];
time( &long_time ); /* Get time as long integer. */
newtime = localtime( &long_time ); /* Convert to local time. */
strftime( tmpbuf, 10,"%m%d%H%M",newtime );
return XalanDOMString(tmpbuf);
}
// This routine gets Xerces Version number. It's used to put the Xerces Version
// into the output xml results file as an attribute of 'PerfData' element.
// Inputs: None
//
XalanDOMString
FileUtility::getXercesVersion()
{
return XalanDOMString(gXercesFullVersionStr);
}
/* This routine creates a FormatterToXML FormatterListener. This is used to format
// the output DOM so a comparision can be done with the expected GOLD file.
// Inputs: None
//
*/
FormatterListener*
FileUtility::getXMLFormatter(
PrintWriter& resultWriter,
int indentAmount,
const XalanDOMString& mimeEncoding,
const StylesheetRoot* stylesheet)
{
XalanDOMString version;
bool outputIndent= 0;
XalanDOMString mediatype;
XalanDOMString doctypeSystem;
XalanDOMString doctypePublic;
XalanDOMString standalone;
if (stylesheet != 0)
{
version = stylesheet->getOutputVersion();
mediatype = stylesheet->getOutputMediaType();
doctypeSystem = stylesheet->getOutputDoctypeSystem();
doctypePublic = stylesheet->getOutputDoctypePublic();
standalone = stylesheet->getOutputStandalone();
outputIndent = stylesheet->getOutputIndent();
}
return new FormatterToXML(
resultWriter,
version,
outputIndent,
indentAmount,
mimeEncoding,
mediatype,
doctypeSystem,
doctypePublic,
true, // xmlDecl
standalone);
}
/* This routine is used to compares the results of a transform and report the results.
// When a failure is detected the 'data' structure used to report detailed info about
// a failure is filled in.
// Inputs:
// goldFile - Name of gold file
// outputFile - Name of result file.
// logfile - Name of log file reporter.
//
// Returns:
// Void
*/
void
FileUtility::checkResults(
const XalanDOMString& outputFile,
const XalanDOMString& goldFile,
XMLFileReporter& logfile)
{
int ambgFlag = data.nogold; // get the current number of tests w/o gold files.
// Compare the results, report success if compareSerializedResults returns true.
if(compareSerializedResults(outputFile, goldFile))
{
cout << "Passed: " << data.testOrFile << endl;
logfile.logCheckPass(data.testOrFile);
data.pass += 1;
}
else
{
typedef XMLFileReporter::Hashtable Hashtable;
// if the compairson fails gather up the failure data and determine if it failed
// due to bad output or missing Gold file. Lastly, log the failure.
Hashtable attrs;
Hashtable actexp;
reportError();
attrs.insert(Hashtable::value_type(XalanDOMString("reason"), XalanDOMString(data.msg)));
attrs.insert(Hashtable::value_type(XalanDOMString("atNode"), data.currentNode));
actexp.insert(Hashtable::value_type(XalanDOMString("exp"), data.expected));
actexp.insert(Hashtable::value_type(XalanDOMString("act"), data.actual));
actexp.insert(Hashtable::value_type(XalanDOMString("xsl"), data.xslFileURL));
actexp.insert(Hashtable::value_type(XalanDOMString("xml"), data.xmlFileURL));
actexp.insert(Hashtable::value_type(XalanDOMString("result"), outputFile));
actexp.insert(Hashtable::value_type(XalanDOMString("gold"), goldFile));
if (ambgFlag < data.nogold)
{
logfile.logCheckAmbiguous(data.testOrFile);
}
else
{
logfile.logCheckFail(data.testOrFile, attrs, actexp);
}
}
}
void
FileUtility::checkAPIResults(
const XalanDOMString& actual,
const XalanDOMString& expected,
const char* msg,
XMLFileReporter& logfile,
const XalanDOMString& outputFile,
const XalanDOMString& goldFile,
bool containsOnly)
{
if(actual == expected ||
(containsOnly == true && indexOf(actual, expected) != XalanDOMString::npos))
{
data.pass += 1;
cout << "Passed: " << data.testOrFile << endl;
logfile.logCheckPass(data.testOrFile);
}
else
{ data.actual = actual;
data.expected = expected;
data.currentNode = "API Test";
data.msg = msg;
data.fail += 1;
reportError();
typedef XMLFileReporter::Hashtable Hashtable;
Hashtable actexp;
actexp.insert(Hashtable::value_type(XalanDOMString("exp"), expected));
actexp.insert(Hashtable::value_type(XalanDOMString("act"), actual));
actexp.insert(Hashtable::value_type(XalanDOMString("xsl"), data.xslFileURL));
actexp.insert(Hashtable::value_type(XalanDOMString("xml"), data.xmlFileURL));
actexp.insert(Hashtable::value_type(XalanDOMString("result"), outputFile));
actexp.insert(Hashtable::value_type(XalanDOMString("gold"), goldFile));
// Todo: Need to determine if I should check for missing gold in these cases.
logfile.logCheckFail(data.testOrFile, actexp);
}
}
/* This routine compares the results of a transform with the gold file.
// It in turn call the domCompare routine to do the actual comparision.
// Inputs:
// gold - Dom tree for the expected results
// doc - Dom tree created during transformation
// filename - Current filename
//
// Returns:
// Void
//
*/
void
FileUtility::checkDOMResults(
const XalanDOMString& theOutputFile,
const XalanCompiledStylesheet* compiledSS,
const XalanSourceTreeDocument* dom,
const XSLTInputSource& goldInputSource,
XMLFileReporter& logfile)
{
const int ambgFlag = data.nogold;
const XalanDOMString mimeEncoding("");
XalanFileOutputStream myOutput(theOutputFile);
XalanOutputStreamPrintWriter myResultWriter(myOutput);
FormatterListener* const theFormatter =
getXMLFormatter(
myResultWriter,
0,
mimeEncoding,
compiledSS->getStylesheetRoot());
FormatterTreeWalker theTreeWalker(*theFormatter);
theTreeWalker.traverse(dom);
delete theFormatter;
XalanSourceTreeDOMSupport domSupport;
XalanSourceTreeParserLiaison parserLiaison(domSupport);
domSupport.setParserLiaison(&parserLiaison);
const XalanDocument* const goldDom =
parserLiaison.parseXMLStream(goldInputSource);
if(domCompare(*goldDom, *dom))
{
cout << "Passed: " << data.testOrFile << endl;
logfile.logCheckPass(data.testOrFile);
data.pass += 1;
}
else
{
typedef XMLFileReporter::Hashtable Hashtable;
// if the compairson fails gather up the failure data and determine if it failed
// due to bad output or missing Gold file. Lastly, log the failure.
Hashtable attrs;
Hashtable actexp;
reportError();
attrs.insert(Hashtable::value_type(XalanDOMString("reason"), XalanDOMString(data.msg)));
attrs.insert(Hashtable::value_type(XalanDOMString("atNode"), data.currentNode));
actexp.insert(Hashtable::value_type(XalanDOMString("exp"), data.expected));
actexp.insert(Hashtable::value_type(XalanDOMString("act"), data.actual));
if (ambgFlag < data.nogold)
{
logfile.logCheckAmbiguous(data.testOrFile);
}
else
{
logfile.logCheckFail(data.testOrFile, attrs, actexp);
}
}
}
/* This routine takes the result file and gold file and parses them.
// If either of the files fails to parse and a SAXException is throw,
// then the files are compared using a char by char file compare,
// otherwise the domCompare routine is used.
// Inputs:
// outputFile: Name of result file
// goldFile: Name of gold file
//
// Returns:
// True or False
//
*/
bool
FileUtility::compareSerializedResults(
const XalanDOMString& outputFile,
const XalanDOMString& goldFile)
{
const XSLTInputSource resultInputSource(outputFile);
const XSLTInputSource goldInputSource(goldFile);
XalanSourceTreeDOMSupport domSupport;
XalanSourceTreeParserLiaison parserLiaison(domSupport);
domSupport.setParserLiaison(&parserLiaison);
try
{
const XalanDocument* const transformDom =
parserLiaison.parseXMLStream(resultInputSource);
assert(transformDom != 0);
const XalanDocument* const goldDom =
parserLiaison.parseXMLStream(goldInputSource);
assert(goldDom != 0);
return domCompare(*goldDom, *transformDom);
}
// This exception is being reported prior to this Catch, however, however, I clarify that it's a SAX exception.
// It's a good indication that the Gold file is not a valid XML. When this happens the transform result needs
// to be compared with the Gold, with a character by character basis, not via the DOM compair.
catch (const XERCES_CPP_NAMESPACE_QUALIFIER SAXException&)
{
cout << "SAXException: Using fileCompare to check output.\n";
return fileCompare(c_str(TranscodeToLocalCodePage(goldFile)), c_str(TranscodeToLocalCodePage(outputFile)));
}
}
static void
replaceNonAsciiCharacters(
char* theBuffer,
char theReplacementChar)
{
while(*theBuffer)
{
if (unsigned(*theBuffer) > 127)
{
*theBuffer = theReplacementChar;
}
++theBuffer;
}
}
/* This routine is used to compare the results against the gold when one or both of
// fails to parse without throwing a SAXException. When a failure is detected the 'data'
// structure used to report detailed info about a failure is filled in.
// Inputs:
// outputFile: Name of result file
// goldFile: Name of gold file
//
// Returns:
// True or False
//
*/
bool
FileUtility::fileCompare(
const char* goldFile,
const char* outputFile)
{
const unsigned long maxBuffer = 132;
char rline[maxBuffer] = {'0'}; // declare buffers to hold single line from file
char gline[maxBuffer] = {'0'};
char temp[10]; // buffer to hold line number
char lineNum = 1;
// Set fail data incase there are i/o problems with the files to compare.
data.expected = XalanDOMString(" ");
data.actual = XalanDOMString(" ");
data.currentNode = XalanDOMString("Line: 0");
// Attempt to open the files.
FILE* const result = fopen(outputFile, "r");
FILE* const gold = fopen(goldFile, "r");
// If the result file fails to open report this as a failure.
if (!result)
{
data.msg = "No Result (Transform failed)";
data.fail += 1;
return false;
}
// If the gold file fails to open report this as ambiguous.
if (!gold)
{
data.msg = "No Gold file";
data.nogold += 1;
return false;
}
// Start file comparison, line by line..
while(!feof(result) && !feof(gold))
{
fgets(gline, sizeof(gline), gold );
fgets(rline, sizeof(rline), result );
sprintf(temp,"%d",lineNum);
if (ferror(gold) || ferror(result))
{
data.msg = "Read Error - Gold/Result file";
data.currentNode = XalanDOMString("Line: ") + XalanDOMString(temp);
return false;
}
// Compare the lines character by charcter ....
unsigned int i = 0;
while(i < strlen(gline))
{
if (gline[i] == rline[i])
{
i++;
}
else
{ // If there is a mismatch collect up the fail data and return false. To ensure that
// the results can be seen in the browser enclose the actual/expected in CDATA Sections.
// Replace any non-ASCII characters. Otherwise, we would have to encode them
// in UTF-8, which is a huge pain.
replaceNonAsciiCharacters(gline, '?');
replaceNonAsciiCharacters(rline, '?');
data.msg = "Text based comparison failure";
data.expected = XalanDOMString("<![CDATA[") + XalanDOMString(gline) + XalanDOMString("]]>");
data.actual = XalanDOMString("<![CDATA[") + XalanDOMString(rline) + XalanDOMString("]]>");
data.currentNode = XalanDOMString("Line: ") + XalanDOMString(temp);
data.fail += 1;
return false;
}
}
lineNum += 1;
}
return true;
}
/* This routine performs a DOM Comparision.
// Inputs:
// gold - Dom tree for the expected results
// doc - Dom tree created during transformation
// filename - Current filename
//
// Returns:
// True or False
//
*/
bool
FileUtility::domCompare(
const XalanNode& gold,
const XalanNode& doc)
{
const XalanNode::NodeType docNodeType = doc.getNodeType();
const XalanNode::NodeType goldNodeType = gold.getNodeType();
const XalanDOMString& docNodeName = doc.getNodeName();
if (goldNodeType != docNodeType)
{
collectData("NodeType mismatch.",
docNodeName,
XalanDOMString(xalanNodeTypes[docNodeType]),
XalanDOMString(xalanNodeTypes[goldNodeType]));
return false;
}
switch (goldNodeType)
{
case XalanNode::ELEMENT_NODE: // ATTRIBUTE_NODEs are processed with diffElement().
{
if (diffElement(gold, doc) == false)
{
return false;
}
}
break;
case XalanNode::CDATA_SECTION_NODE:
case XalanNode::TEXT_NODE:
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
//debugNodeData(docNodeName, docNodeValue);
if(goldNodeValue != docNodeValue)
{
collectData("Text node mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
break;
case XalanNode::PROCESSING_INSTRUCTION_NODE:
{
const XalanDOMString& goldNodeName = gold.getNodeName();
if (goldNodeName != docNodeName)
{
collectData("processing-instruction target mismatch. ",
docNodeName,
goldNodeName,
docNodeName);
return false;
}
else
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
if (goldNodeValue != docNodeValue)
{
collectData("processing-instruction data mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
}
break;
case XalanNode::COMMENT_NODE:
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
if (goldNodeValue != docNodeValue)
{
collectData("comment data mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
break;
case XalanNode::DOCUMENT_NODE:
{
//debugNodeData(docNodeName);
const XalanNode *goldNextNode;
const XalanNode *domNextNode;
goldNextNode = gold.getFirstChild();
domNextNode = doc.getFirstChild();
if (0 != goldNextNode)
{
if(domCompare(*goldNextNode,*domNextNode) == false)
{
return false;
}
}
}
break;
case XalanNode::ENTITY_REFERENCE_NODE:
case XalanNode::ENTITY_NODE:
case XalanNode::DOCUMENT_TYPE_NODE:
case XalanNode::DOCUMENT_FRAGMENT_NODE:
case XalanNode::NOTATION_NODE:
default:
cerr << "Unexpected node type: " << goldNodeType << endl;
return false;
}
// Need to process siblings. Children are processed in diffElement, since
// only they can have children in the XPath data model.
const XalanNode* const goldNextNode = gold.getNextSibling();
const XalanNode* const domNextNode = doc.getNextSibling();
if (0 != goldNextNode)
{
if (0 != domNextNode)
{
if (domCompare(*goldNextNode, *domNextNode) == false)
{
return false;
}
}
else
{
collectData("Missing sibling node. ",
docNodeName,
goldNextNode->getNodeName(),
goldNextNode->getNodeName());
return false;
}
}
else if (0 != domNextNode)
{
collectData("Extra sibling node. ",
docNodeName,
domNextNode->getNodeName(),
domNextNode->getNodeName());
return false;
}
return true;
}
bool
FileUtility::domCompare(
const XalanDocument& gold,
const XalanDocument& doc)
{
const XalanNode* theGoldPos = &gold;
const XalanNode* theDocPos = &doc;
bool fEqual = true;
do
{
fEqual = diffNode(theGoldPos, theDocPos);
if (fEqual == true)
{
assert(theGoldPos != 0 && theDocPos != 0);
const XalanNode* nextGoldNode = theGoldPos->getFirstChild();
const XalanNode* nextDocNode = theDocPos->getFirstChild();
bool fBreak = false;
while(
nextGoldNode == 0 &&
nextDocNode == 0 &&
fBreak == false)
{
// Move to the next sibling of each node,
// since we would get here only if both have
// no children.
nextGoldNode = theGoldPos->getNextSibling();
nextDocNode = theDocPos->getNextSibling();
// If there is no next sibling, move up to the
// parent. If one, but not both, has a sibling,
// we'll end up back at the top of the do/while
// loop and the difference will be reported.
if(0 == nextGoldNode && 0 == nextDocNode)
{
theGoldPos = theGoldPos->getParentNode();
theDocPos = theDocPos->getParentNode();
// If the parent is null, then we've reached
// the end of the document. Note that if we
// got here, then there must also be a parent
// node in the document we're verifying, so we
// could simply assert that theDocPos is either
// null if theGoldPos is null, or it is not-null
// if theGoldPos is not-null.
if(0 == theGoldPos)
{
nextGoldNode = theGoldPos;
fBreak = true;
}
if(0 == theDocPos)
{
nextDocNode = theDocPos;
fBreak = true;
}
}
}
theGoldPos = nextGoldNode;
theDocPos = nextDocNode;
}
} while((theGoldPos != 0 || theDocPos != 0) && fEqual == true);
return fEqual;
}
bool
FileUtility::diffNode(
const XalanNode& gold,
const XalanNode& doc)
{
const XalanNode::NodeType docNodeType = doc.getNodeType();
const XalanNode::NodeType goldNodeType = gold.getNodeType();
const XalanDOMString& docNodeName = doc.getNodeName();
if (goldNodeType != docNodeType)
{
collectData("NodeType mismatch.",
docNodeName,
XalanDOMString(xalanNodeTypes[docNodeType]),
XalanDOMString(xalanNodeTypes[goldNodeType]));
return false;
}
switch (goldNodeType)
{
case XalanNode::ELEMENT_NODE: // ATTRIBUTE_NODEs are processed with diffElement().
return diffElement2(gold, doc);
break;
case XalanNode::CDATA_SECTION_NODE:
case XalanNode::TEXT_NODE:
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
//debugNodeData(docNodeName, docNodeValue);
if(goldNodeValue != docNodeValue)
{
collectData("Text node mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
break;
case XalanNode::PROCESSING_INSTRUCTION_NODE:
{
const XalanDOMString& goldNodeName = gold.getNodeName();
if (goldNodeName != docNodeName)
{
collectData("processing-instruction target mismatch. ",
docNodeName,
goldNodeName,
docNodeName);
return false;
}
else
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
if (goldNodeValue != docNodeValue)
{
collectData("processing-instruction data mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
}
break;
case XalanNode::COMMENT_NODE:
{
const XalanDOMString& docNodeValue = doc.getNodeValue();
const XalanDOMString& goldNodeValue = gold.getNodeValue();
if (goldNodeValue != docNodeValue)
{
collectData("comment data mismatch. ",
docNodeName,
goldNodeValue,
docNodeValue);
return false;
}
}
break;
case XalanNode::DOCUMENT_NODE:
break;
case XalanNode::ENTITY_REFERENCE_NODE:
case XalanNode::ENTITY_NODE:
case XalanNode::DOCUMENT_TYPE_NODE:
case XalanNode::DOCUMENT_FRAGMENT_NODE:
case XalanNode::NOTATION_NODE:
default:
cerr << "Unexpected node type: " << goldNodeType << endl;
return false;
}
return true;
}
bool
FileUtility::diffNode(
const XalanNode* gold,
const XalanNode* doc)
{
if (gold != 0 && doc != 0)
{
return diffNode(*gold, *doc);
}
else if (gold != 0)
{
const XalanNode* const parent =
gold->getParentNode();
collectData(
"Missing sibling node. ",
parent == 0 ? s_emptyString : parent->getNodeName(),
s_emptyString,
gold->getNodeName());
return false;
}
else
{
assert(doc != 0 && gold == 0);
const XalanNode* const parent =
doc->getParentNode();
collectData(
"Extra sibling node. ",
parent == 0 ? s_emptyString : parent->getNodeName(),
doc->getNodeName(),
s_emptyString);
return false;
}
}
/* This routine compares two element nodes.
// Inputs:
// gold - Dom tree for the expected results
// doc - Dom tree created during transformation
// filename - Current filenam
//
// Returns:
// True or False
//
*/
bool
FileUtility::diffElement(
const XalanNode& gold,
const XalanNode& doc)
{
assert(gold.getNodeType() == XalanNode::ELEMENT_NODE);
assert(gold.getNodeType() == XalanNode::ELEMENT_NODE);
const XalanDOMString& docNodeName = doc.getNodeName();
const XalanDOMString& goldNodeName = gold.getNodeName();
const XalanDOMString& docNsUri = doc.getNamespaceURI();
const XalanDOMString& goldNsUri = gold.getNamespaceURI();
//debugNodeData(docNodeName);
// This essentially checks 2 things, that the prefix and localname are the
// same. So specific checks of these items are not necessary.
if (goldNodeName != docNodeName)
{
collectData("Element mismatch. ",
docNodeName,
goldNodeName,
docNodeName);
return false;
}
if ( goldNsUri != docNsUri)
{
collectData("Element NamespaceURI mismatch. ",
docNodeName,
goldNsUri,
docNsUri);
return false;
}
// Get Attributes for each Element Node.
const XalanNamedNodeMap* const goldAttrs = gold.getAttributes();
const XalanNamedNodeMap* const docAttrs = doc.getAttributes();
// Get number of Attributes
const unsigned int numGoldAttr = goldAttrs->getLength();
const unsigned int numDomAttr = docAttrs ->getLength();
/*
// This needs to be uncommented if 'compare.exe' is to work.
// If this is the 'root' element strip off the xmlns:xml namespace attribute,
// that is lurking around on the gold file, but not the dom. This is necessary
// only for the 'compare' test, that uses a pure DOM, that has not been serialized.
//if (goldNodeName == XalanDOMString("root"))
{
numGoldAttr -= 1;
XalanNode *gXMLAttr = goldAttrs->item(1);
}
*/
// Check that each Element has same number of Attributes. If they don't report error
if ( numGoldAttr == numDomAttr )
{
// Compare Attributes one at a time.
//for (int i=1; i < numGoldAttr; i++) // To be used with 'compare'
for (unsigned int i = 0; i < numGoldAttr; ++i)
{
// Attribute order is irrelvant, so comparision is base on Attribute name.
const XalanNode* const gAttr = goldAttrs->item(i);
const XalanDOMString& goldAttrName = gAttr->getNodeName();
const XalanNode* const dAttr = docAttrs->getNamedItem(goldAttrName);
if (dAttr != 0)
{
if( ! (diffAttr(gAttr, dAttr)) )
return false;
}
else
{
collectData("Element missing named Attribute. ",
docNodeName,
goldAttrName,
XalanDOMString("NOTHING"));
return false;
}
}
}
else
{
char buf1[2], buf2[2];
sprintf(buf1, "%u", numGoldAttr);
sprintf(buf2, "%u", numDomAttr);
collectData("Wrong number of attributes. ",
docNodeName,
XalanDOMString(buf1),
XalanDOMString(buf2));
return false;
}
const XalanNode* goldNextNode = gold.getFirstChild();
const XalanNode* domNextNode = doc.getFirstChild();
if (0 != goldNextNode)
{
if (0 != domNextNode)
{
if ( ! domCompare(*goldNextNode, *domNextNode) )
return false;
}
else
{
collectData("Element missing ChildNode. ",
docNodeName,
XalanDOMString(goldNextNode->getNodeName()),
XalanDOMString("NOTHING"));
return false;
}
}
else if (domNextNode != 0)
{
// The result doc has additional Children. If the additional node is a text node
// then gather up the text and print it out.
if ( domNextNode->getNodeType() == XalanNode::TEXT_NODE)
{
collectData("Result has additional Child node: ",
docNodeName,
XalanDOMString("NOTHING"),
XalanDOMString(domNextNode->getNodeName()) + XalanDOMString(" \"") +
XalanDOMString(domNextNode->getNodeValue()) + XalanDOMString("\""));
}
// Additional node is NOT text, so just print it's Name.
else
{
collectData("Result has additional Child node: ",
docNodeName,
XalanDOMString("NOTHING"),
XalanDOMString(domNextNode->getNodeName()));
}
return false;
}
return true;
}
bool
FileUtility::diffElement2(
const XalanNode& gold,
const XalanNode& doc)
{
assert(gold.getNodeType() == XalanNode::ELEMENT_NODE);
assert(gold.getNodeType() == XalanNode::ELEMENT_NODE);
const XalanDOMString& docNodeName = doc.getNodeName();
const XalanDOMString& goldNodeName = gold.getNodeName();
const XalanDOMString& docNsUri = doc.getNamespaceURI();
const XalanDOMString& goldNsUri = gold.getNamespaceURI();
//debugNodeData(docNodeName);
// This essentially checks 2 things, that the prefix and localname are the
// same. So specific checks of these items are not necessary.
if (goldNodeName != docNodeName)
{
collectData("Element mismatch. ",
docNodeName,
goldNodeName,
docNodeName);
return false;
}
if ( goldNsUri != docNsUri)
{
collectData("Element NamespaceURI mismatch. ",
docNodeName,
goldNsUri,
docNsUri);
return false;
}
// Get Attributes for each Element Node.
const XalanNamedNodeMap* const goldAttrs = gold.getAttributes();
assert(goldAttrs != 0);
const XalanNamedNodeMap* const docAttrs = doc.getAttributes();
assert(docAttrs != 0);
// Get number of Attributes
const unsigned int numGoldAttr = goldAttrs->getLength();
const unsigned int numDomAttr = docAttrs ->getLength();
// Check that each Element has same number of Attributes. If they don't report error
if ( numGoldAttr == numDomAttr )
{
// Compare Attributes one at a time.
//for (int i=1; i < numGoldAttr; i++) // To be used with 'compare'
for (unsigned int i = 0; i < numGoldAttr; ++i)
{
// Attribute order is irrelvant, so comparision is base on Attribute name.
const XalanNode* const gAttr = goldAttrs->item(i);
const XalanDOMString& goldAttrName = gAttr->getNodeName();
const XalanNode* const dAttr = docAttrs->getNamedItem(goldAttrName);
if (dAttr != 0)
{
if( ! (diffAttr(gAttr, dAttr)) )
return false;
}
else
{
collectData("Element missing named Attribute. ",
docNodeName,
goldAttrName,
XalanDOMString("NOTHING"));
return false;
}
}
}
else
{
char buf1[2], buf2[2];
sprintf(buf1, "%u", numGoldAttr);
sprintf(buf2, "%u", numDomAttr);
collectData("Wrong number of attributes. ",
docNodeName,
XalanDOMString(buf1),
XalanDOMString(buf2));
return false;
}
return true;
}
/* This routine compares two attribute nodes.
// Inputs:
// gAttr - attribute from Gold dom tree
// dAttr - attribute from Dom tree created during transformation
// fileName - Current filenam
//
// Returns:
// True or False
//
*/
bool FileUtility::diffAttr(const XalanNode* gAttr, const XalanNode* dAttr)
{
const XalanDOMString& docAttrName = dAttr->getNodeName();
//debugAttributeData(goldAttrName);
const XalanDOMString& goldAttrValue = gAttr->getNodeValue();
const XalanDOMString& docAttrValue = dAttr->getNodeValue();
if (goldAttrValue != docAttrValue)
{
collectData(
"Attribute Value mismatch. ",
docAttrName,
goldAttrValue,
docAttrValue);
return false;
}
const XalanDOMString& goldAttrNsUri = gAttr->getNamespaceURI();
const XalanDOMString& docAttrNsUri = dAttr->getNamespaceURI();
if (goldAttrNsUri != docAttrNsUri)
{
collectData(
"Attribute NamespaceURI mismatch. ",
docAttrName,
goldAttrNsUri,
docAttrNsUri);
return false;
}
return true;
}
/* This routine reports DOM comparison errors.
// Inputs:
// file - Name of current file
// node - Current node that fails
// msg - Failure message
//
*/
void
FileUtility::reportError()
{
cout << endl
<< "* Failed "
<< data.testOrFile
<< " Error: "
<< data.msg
<< endl
<< " "
<< "Processing Node: "
<< data.currentNode
<< endl
<< " Expected: "
<< data.expected
<< endl
<< " Actual: "
<< data.actual
<< endl
<< endl;
}
#if !defined(NDEBUG)
void
FileUtility::debugNodeData(const XalanDOMString& value) const
{
cout << "Node is: " << c_str(TranscodeToLocalCodePage(value)) << endl;
}
void
FileUtility::debugNodeData(
const XalanDOMString& node,
const XalanDOMString& value) const
{
cout << "Node is: " << c_str(TranscodeToLocalCodePage(node)) << " "
<< "Value is: \"" << c_str(TranscodeToLocalCodePage(value)) << "\"\n";
}
void
FileUtility::debugAttributeData(const XalanDOMString& value) const
{
cout << "Attribute is: " << c_str(TranscodeToLocalCodePage(value)) << endl;
}
#endif
/* This routine collects up data pertinent to a dom comparison failure.
// Inputs:
// errmsg: Reason for the failure.
// currentnode: Node in the dom tree where the mismatch occured
// expdata: Expected data based on the Gold file.
// actdata: Actual data returned in the result file.
// Returns: Void
*/
void
FileUtility::collectData(
const char* errmsg,
const XalanDOMString& currentnode,
const XalanDOMString& expdata,
const XalanDOMString& actdata)
{
data.msg = errmsg;
data.currentNode = currentnode;
data.expected = expdata;
data.actual = actdata;
data.fail += 1;
}
/* Routine prints the result to the console, as well as adds summary info into the logfile.
// Inputs:
// logfile: Current log file
// runid: Unique runid
// Returns: Void
*/
void
FileUtility::reportPassFail(
XMLFileReporter& logfile,
const XalanDOMString& runid)
{
typedef XMLFileReporter::Hashtable Hashtable;
Hashtable runResults;
char temp[5];
// Create entrys that contain runid, xerces version, and numbers for Pass, Fail and No Gold.
runResults.insert(Hashtable::value_type(XalanDOMString("UniqRunid"), runid));
runResults.insert(Hashtable::value_type(XalanDOMString("Xerces-Version "), getXercesVersion()));
runResults.insert(Hashtable::value_type(XalanDOMString("BaseDrive "), XalanDOMString(getDrive())));
runResults.insert(Hashtable::value_type(XalanDOMString("TestBase "), XalanDOMString(args.base)));
runResults.insert(Hashtable::value_type(XalanDOMString("xmlFormat "), data.xmlFormat));
sprintf(temp, "%ld", args.iters);
runResults.insert(Hashtable::value_type(XalanDOMString("Iters "), XalanDOMString(temp)));
sprintf(temp, "%d", data.pass);
runResults.insert(Hashtable::value_type(XalanDOMString("Passed"), XalanDOMString(temp)));
sprintf(temp, "%d", data.fail);
runResults.insert(Hashtable::value_type(XalanDOMString("Failed"), XalanDOMString(temp)));
sprintf(temp, "%d", data.nogold);
runResults.insert(Hashtable::value_type(XalanDOMString("No_Gold_Files"), XalanDOMString(temp)));
logfile.logElementWAttrs(10, "RunResults", runResults, "xxx");
cout << "\nPassed " << data.pass;
cout << "\nFailed " << data.fail;
cout << "\nMissing Gold " << data.nogold << endl;
}
/* Routine runs a stylesheet on the log file and displays the results in HTML.
// Inputs:
// xalan: An instance of the transformer
// resultsFile: logfile
// Returns: Void
*/
void
FileUtility::analyzeResults(XalanTransformer& xalan, const XalanDOMString& resultsFile)
{
XalanDOMString paramValue;
bool fileStatus;
// Pass the results .xml file as a parameter to the stylesheet. It must be wrapped in single
// quotes so that it is not considered an expression.
//
assign(paramValue, XalanDOMString("'"));
append(paramValue, resultsFile);
append(paramValue, XalanDOMString("'"));
// Set the parameter
//
xalan.setStylesheetParam(XalanDOMString("testfile"), paramValue);
// Generate the input and output file names.
//
const XalanDOMString theHTMLFile = generateFileName(resultsFile,"html", &fileStatus);
const XalanDOMString theStylesheet = args.base + XalanDOMString("cconf.xsl");
const XalanDOMString theXMLSource = args.base + XalanDOMString("cconf.xml");
// Check that we can find the stylesheet to analyze the results.
//
FILE* fileHandle = fopen(c_str(TranscodeToLocalCodePage(theStylesheet)), "r");
if (fileHandle == 0)
{
cout << "ANALYSIS ERROR: File Missing: " << c_str(TranscodeToLocalCodePage(theStylesheet)) << endl;
return;
}
else
{
fclose(fileHandle);
}
// Create the InputSources and ResultTarget.
const XSLTInputSource xslInputSource(theStylesheet);
const XSLTInputSource xmlInputSource(theXMLSource);
const XSLTResultTarget resultFile(theHTMLFile);
// Do the transform, display the output HTML, or report any failure.
const int result = xalan.transform(xmlInputSource, xslInputSource, resultFile);
if (result == 0)
{
system(c_str(TranscodeToLocalCodePage(theHTMLFile)));
}
else
{
cout << "Analysis failed due to following error: "
<< xalan.getLastError()
<< endl;
}
}
static XalanDOMString s_staticXmlSuffix;
static XalanDOMString s_staticPathSep;
const XalanDOMString& FileUtility::s_xmlSuffix = s_staticXmlSuffix;
const XalanDOMString& FileUtility::s_pathSep = s_staticPathSep;
void
FileUtility::initialize()
{
s_staticXmlSuffix = XALAN_STATIC_UCODE_STRING(".xml");
#if defined(WIN32)
s_staticPathSep = XALAN_STATIC_UCODE_STRING("\\");
#else
s_staticPathSep = XALAN_STATIC_UCODE_STRING("/");
#endif
}
void
FileUtility::terminate()
{
releaseMemory(s_staticXmlSuffix);
releaseMemory(s_staticPathSep);
}
XALAN_CPP_NAMESPACE_END
|