test_GSupport.cpp 32.6 KB
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
/***************************************************************************
 *                 test_GSupport.cpp - test support module                 *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2010-2018 by Juergen Knoedlseder                         *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  This program 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.                                    *
 *                                                                         *
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file test_GSupport.cpp
 * @brief Testing of support module
 * @author Juergen Knoedlseder
 */

/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cstdlib>     // getenv
#include <vector>
#include "GTools.hpp"
#include "test_GSupport.hpp"

/* __ Namespaces _________________________________________________________ */

/* __ Globals ____________________________________________________________ */

/* __ Debug definitions __________________________________________________ */

/* __ Constants __________________________________________________________ */
const std::string datadir  = std::getenv("TEST_DATA");
const std::string csv_file = datadir + "/csv.dat";


/***********************************************************************//**
 * @brief Set parameters and tests
 ***************************************************************************/
void TestGSupport::set(void){

    // Set test name
    name("GSupport");

    // Append tests
    append(static_cast<pfunction>(&TestGSupport::test_tools),
           "Test GTools");
    append(static_cast<pfunction>(&TestGSupport::test_expand_env),
           "Test Environment variable");
    append(static_cast<pfunction>(&TestGSupport::test_node_array),
           "Test GNodeArray");
    append(static_cast<pfunction>(&TestGSupport::test_bilinear),
           "Test GBilinear");
    append(static_cast<pfunction>(&TestGSupport::test_url_file),
           "Test GUrlFile");
    append(static_cast<pfunction>(&TestGSupport::test_url_string),
           "Test GUrlString");
    append(static_cast<pfunction>(&TestGSupport::test_filename),
           "Test GFilename");
    append(static_cast<pfunction>(&TestGSupport::test_csv),
           "Test GCsv");

    // Return
    return;
}


/***********************************************************************//**
 * @brief Clone test suite
 *
 * @return Pointer to deep copy of test suite.
 ***************************************************************************/
TestGSupport* TestGSupport::clone(void) const
{
    // Clone test suite
    return new TestGSupport(*this);
}


/***********************************************************************//**
 * @brief Test GTools
 *
 * Test the GTools functions
 ***************************************************************************/
void TestGSupport::test_tools(void)
{
    // Strip whitespace
    test_value(gammalib::strip_whitespace("  World  "), "World");
    test_value(gammalib::strip_whitespace("World  "), "World");
    test_value(gammalib::strip_whitespace("  World"), "World");

    // Strip characters
    test_value(gammalib::strip_chars("xxWorldyy", "xy"), "World");
    test_value(gammalib::strip_chars("Worldxy", "xy"), "World");
    test_value(gammalib::strip_chars("xxWorld", "x"), "World");

    // Right strip characters
    test_value(gammalib::rstrip_chars("xxWorldyy", "xy"), "xxWorld");
    test_value(gammalib::rstrip_chars("Worldxy", "xy"), "World");
    test_value(gammalib::rstrip_chars("xxWorld", "x"), "xxWorld");
    test_value(gammalib::rstrip_chars("0.0012300", "0"), "0.00123");

    // Replace segments
    test_value(gammalib::replace_segment("Wonderful","onder","ish"), "Wishful");
    test_value(gammalib::replace_segment("Wonderful","Wonder","X"), "Xful");
    test_value(gammalib::replace_segment("Wonderful","ful","X"), "WonderX");

    // Test noun number conversion
    test_value(gammalib::number("World", 0), "Worlds");
    test_value(gammalib::number("World", 1), "World");
    test_value(gammalib::number("World", 2), "Worlds");

    // Test XML to string conversion
    std::string s_in  = "Hallo World, you \"are\" my 'nice' <planet> & place";
    std::string s_ref = "Hallo World, you &quot;are&quot; my &apos;nice&apos;"
                        " &lt;planet&gt; &amp; place";
    std::string s_out;
    s_out = gammalib::str2xml(s_in);
    test_value(s_out, s_ref);
    s_out = gammalib::xml2str(s_out);
    test_value(s_out, s_in);

    // Test power law flux computations
    test_value(gammalib::plaw_energy_flux(2.0, 3.0, 2.5, -1.0), 2.5);
    test_value(gammalib::plaw_energy_flux(2.0, 3.0, 2.5, -2.5), 2.56453824468);
    test_value(gammalib::plaw_photon_flux(2.0, 3.0, 2.5, -1.0), 1.01366277027);
    test_value(gammalib::plaw_photon_flux(2.0, 3.0, 2.5, -2.5), 1.06136118604);

    // Create vector of strings
    std::vector<std::string> strings;
    strings.push_back("This");
    strings.push_back("is");
    strings.push_back("a");
    strings.push_back("vector");
    test_assert(gammalib::contains(strings, "a"), "\"a\" in vector");
    test_assert(gammalib::contains(strings, "vector"), "\"vector\" in vector");
    test_assert(!gammalib::contains(strings, "b"), "\"b\" not in vector");
    test_assert(!gammalib::contains(strings, "isavector"), "\"isavector\" not in vector");

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test expand_env function
 *
 * Test the environment variable expansion function.
 ***************************************************************************/
void TestGSupport::test_expand_env(void)
{

    // Declare strings that we use during the tests
    std::string s_in;
    std::string s_ref;
    std::string s_out;

    // Test 1: no environment variable
    s_in  = "This string has no environment variable.";
    s_ref = s_in;
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"no environment variable",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Get home environment variable
    std::string home(std::getenv("HOME"));

    // $ENV{HOME} environment variable within string
    s_in  = "My $ENV{HOME} is my castle.";
    s_ref = "My "+home+" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$ENV{HOME} environment variable within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // ${HOME} environment variable within string
    s_in  = "My ${HOME} is my castle.";
    s_ref = "My "+home+" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"${HOME} environment variable within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $HOME/path environment variable within string
    s_in  = "My $HOME/path is my castle.";
    s_ref = "My "+home+"/path is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$HOME/path environment variable within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $HOME environment variable at end of string
    s_in  = "My $HOME";
    s_ref = "My "+home;
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$HOME environment variable at end of string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Environment variable within single quotes
    s_in  = "My '$(HOME)' is my castle.";
    s_ref = s_in;
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"Environment variable within single quotes",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Environment variable within double quotes
    s_in  = "My \"$(HOME)\" is my castle.";
    s_ref = "My \""+home+"\" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"Environment variable within double quotes",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Non existing environment variable within string
    s_in  = "My $(HOMEIXYZ) is my castle.";
    s_ref = "My $(HOMEIXYZ) is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"Non existing environment variable within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Empty environment variable within string
    s_in  = "My $() is my castle.";
    s_ref = "My $() is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"Empty environment variable within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Two successive environment variables within string
    s_in  = "My $(HOME)$ENV{HOME} is my castle.";
    s_ref = "My "+home+home+" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"Two successive environment variables within string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $(HOME) at beginning of string
    s_in  = "$(HOME) is my castle.";
    s_ref = home+" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$(HOME) at beginning of string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $ENV(HOME) at beginning of string
    s_in  = "$ENV(HOME) is my castle.";
    s_ref = home+" is my castle.";
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$ENV(HOME) at beginning of string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $(HOME) at end of string
    s_in  = "My castle is $(HOME)";
    s_ref = "My castle is "+home;
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$(HOME) at end of string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // $ENV{HOME}${HOME}$ENV(HOME)$(HOME) only string
    s_in  = "$ENV{HOME}${HOME}$ENV(HOME)$(HOME)";
    s_ref = home+home+home+home;
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"$ENV{HOME}${HOME}$ENV(HOME)$(HOME) only string",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Test ~
    s_in  = "My castle is ~";
    s_ref = gammalib::expand_env("My castle is $(HOME)");
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"String with ~",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Test ~+
    s_in  = "My castle is ~+";
    s_ref = gammalib::expand_env("My castle is $(PWD)");
    s_out = gammalib::expand_env(s_in);
    test_assert(s_out == s_ref,"String with ~+",
                "Unexpected string \""+s_out+"\" (expected \""+s_ref+"\")");

    // Exit test
    return;
}


/***********************************************************************//**
 * @brief Test GNodeArray class
 *
 * Test the GNodeArray class.
 ***************************************************************************/
void TestGSupport::test_node_array(void)
{
    // Test void constructor
    test_try("Void constructor");
    try {
        GNodeArray array;
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test copy constructor
    test_try("Copy constructor");
    try {
        GNodeArray array;
        GNodeArray array2(array);
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test array constructor
    test_try("Array constructor");
    try {
        double array[] = {0.0, 1.0, 2.0, 3.0, 5.0};
        GNodeArray array2(5, array);
        test_try_success();
        for (int i = 0; i < 5; ++i) {
            test_value(array2[i], array[i]);
        }
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test GVector constructor
    test_try("GVector constructor");
    try {
        double array[] = {0.0, 1.0, 2.0, 3.0, 5.0};
        GVector vector(5);
        for (int i = 0; i < 5; ++i) {
            vector[i] = array[i];
        }
        GNodeArray array2(vector);
        test_try_success();
        for (int i = 0; i < 5; ++i) {
            test_value(array2[i], vector[i]);
        }
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test std::vector constructor
    test_try("std::vector constructor");
    try {
        double array[] = {0.0, 1.0, 2.0, 3.0, 5.0};
        std::vector<double> vector;
        for (int i = 0; i < 5; ++i) {
            vector.push_back(array[i]);
        }
        GNodeArray array2(vector);
        test_try_success();
        for (int i = 0; i < 5; ++i) {
            test_value(array2[i], vector[i]);
        }
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test container manipulation
    test_try("Container manipulation");
    try {
        GNodeArray array;
        test_assert(array.is_empty(), "Node array should be empty");
        array.append(0.0);
        test_assert(!array.is_empty(), "Node array should not be empty");
        test_value(array.size(), 1);
        array.append(1.0);
        array.append(2.0);
        array.append(3.0);
        array.append(5.0);
        test_value(array.size(), 5);
        array.insert(4, 4.0);
        test_value(array.size(), 6);
        for (int i = 0; i < array.size(); ++i) {
            test_value(array[i], double(i));   // 0, 1, 2, 3, 4, 5
        }
        array.remove(1);
        array.remove(2);
        array.remove(3);
        test_value(array.size(), 3);
        for (int i = 0; i < array.size(); ++i) {
            test_value(array[i], double(2*i)); // 0, 2, 4
        }
        GNodeArray array2;
        array2.append(6.0);
        array2.append(8.0);
        test_value(array2.size(), 2);
        array.extend(array2);
        test_value(array.size(), 5);
        for (int i = 0; i < array.size(); ++i) {
            test_value(array[i], double(2*i)); // 0, 2, 4, 6, 8
        }
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test linear interpolation
    double array_lin[] = {-1.0, 0.0, 1.0};
    test_node_array_interpolation(3, array_lin);

    // Test non-linear interpolation
    double array_nonlin[] = {-1.3, 0.0, 1.7};
    test_node_array_interpolation(3, array_nonlin);

    // Test node array change using access operator[]
    GNodeArray nodes;
    nodes.append(1.0);
    nodes.append(2.0);
    nodes.append(3.0);
    nodes.set_value(2.5);
    test_value(nodes.inx_left(), 1, "Expected node 1");
    test_value(nodes.inx_right(), 2, "Expected node 2");
    test_value(nodes.wgt_left(), 0.5, 1.0e-6, "Expected weight 0.5");
    test_value(nodes.wgt_right(), 0.5, 1.0e-6, "Expected weight 0.5");
    nodes[1] = 3.0;
    nodes[2] = 4.0;
    nodes.set_value(2.5);
    test_value(nodes.inx_left(), 0, "Expected node 0");
    test_value(nodes.inx_right(), 1, "Expected node 1");
    test_value(nodes.wgt_left(), 0.25, 1.0e-6, "Expected weight 0.25");
    test_value(nodes.wgt_right(), 0.75, 1.0e-6, "Expected weight 0.75");

    // Remove test file
    GFilename filename("test_nodes.fits");
    filename.remove();

    // Check saving
    nodes.save("test_nodes.fits");
    GNodeArray load1("test_nodes.fits");
    test_value(load1.size(), 3, "GNodeArray should have 3 nodes.");
    test_value(load1[0], 1.0, 1.0e-7, "First node should be 1.");
    test_value(load1[1], 3.0, 1.0e-7, "First node should be 3.");
    test_value(load1[2], 4.0, 1.0e-7, "First node should be 4.");

    // Check saving in a different extnsion
    nodes.append(10.0);
    nodes.append(11.0);
    nodes.save("test_nodes.fits[NODE ARRAY]", true);
    GNodeArray load2("test_nodes.fits[NODE ARRAY]");
    test_value(load2.size(), 5, "GNodeArray should have 5 nodes.");
    test_value(load2[0], 1.0, 1.0e-7, "First node should be 1.");
    test_value(load2[1], 3.0, 1.0e-7, "First node should be 3.");
    test_value(load2[2], 4.0, 1.0e-7, "First node should be 4.");
    test_value(load2[3], 10.0, 1.0e-7, "First node should be 10.");
    test_value(load2[4], 11.0, 1.0e-7, "First node should be 11.");

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GNodeArray class interpolation
 *
 * @param[in] num Number of nodes.
 * @param[in] nodes Nodes.
 *
 * Test the GNodeArray class interpolation method by comparing the
 * interpolation results for a linear function to the expected result.
 ***************************************************************************/
void TestGSupport::test_node_array_interpolation(const int&    num,
                                                 const double* nodes)
{
    // Setup function parameters
    const double slope  = 3.1;
    const double offset = 7.9;

    // Initialise node array
    GNodeArray array(num, nodes);

    // Setup node values
    std::vector<double> values;
    for (int i = 0; i < 3; ++i) {
        values.push_back(nodes[i] * slope + offset);
    }

    // Test values
    for (double value = -2.0; value <= +2.0; value += 0.2) {
        double expected = value * slope + offset;
        double result   = array.interpolate(value, values);
        test_value(result, expected);
    }

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GBilinear class
 *
 * Test the GBilinear class.
 ***************************************************************************/
void TestGSupport::test_bilinear(void)
{
    // Test constructor
    GBilinear interpolator;

    // Test value setting and retrieving
    interpolator.index1()  = 1;
    interpolator.index2()  = 2;
    interpolator.index3()  = 3;
    interpolator.index4()  = 4;
    interpolator.weight1() = 1.0;
    interpolator.weight2() = 2.0;
    interpolator.weight3() = 3.0;
    interpolator.weight4() = 4.0;
    test_value(interpolator.index1(), 1);
    test_value(interpolator.index2(), 2);
    test_value(interpolator.index3(), 3);
    test_value(interpolator.index4(), 4);
    test_value(interpolator.weight1(), 1.0);
    test_value(interpolator.weight2(), 2.0);
    test_value(interpolator.weight3(), 3.0);
    test_value(interpolator.weight4(), 4.0);

    // Test copy constructor
    GBilinear interpolator2(interpolator);
    test_value(interpolator2.index1(), 1);
    test_value(interpolator2.index2(), 2);
    test_value(interpolator2.index3(), 3);
    test_value(interpolator2.index4(), 4);
    test_value(interpolator2.weight1(), 1.0);
    test_value(interpolator2.weight2(), 2.0);
    test_value(interpolator2.weight3(), 3.0);
    test_value(interpolator2.weight4(), 4.0);

    // Test interpolator
    double array[5]  = {1.0, 2.0, 3.0, 4.0, 5.0};
    double reference = 1.0 * array[1] +
                       2.0 * array[2] +
                       3.0 * array[3] +
                       4.0 * array[4];
    test_value(interpolator(array), reference);
    test_value(interpolator2(array), reference);

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GUrlFile class
 *
 * Test the GUrlFile class.
 ***************************************************************************/
void TestGSupport::test_url_file(void)
{
    // Test void constructor
    test_try("Void constructor");
    try {
        GUrlFile url;
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test open constructor
    test_try("Open constructor");
    try {
        GUrlFile url("test_url.dat", "w");
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test file writing
    GUrlFile url("test_url.dat", "w");
    test_value(url.write("abcd", 4), 4);
    url.put_char('e');
    url.printf("fghi%s%d%3.1fxyz", "jklm", 41, 9.9);
    url.close();

    // Test file reading using read() method
    char buffer[100];
    url.open("test_url.dat", "r");
    test_value(url.read(buffer, 99), 21);
    std::string result = std::string(buffer, 21);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");
    url.close();

    // Test file reading using get_char() method
    result.clear();
    url.open("test_url.dat", "r");
    int character = 0;
    do {
        character = url.get_char();
        if (character != EOF) {
            char c = (char)character;
            result.append(1, c);
        }
    } while (character != EOF);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");
    url.close();

    // Test file reading using scanf() method
    result.clear();
    url.open("test_url.dat", "r");
    url.scanf("%99s", buffer);
    result = std::string(buffer, 21);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");
    url.close();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GUrlString class
 *
 * Test the GUrlString class.
 ***************************************************************************/
void TestGSupport::test_url_string(void)
{
    // Test void constructor
    test_try("Void constructor");
    try {
        GUrlString url;
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test open constructor
    test_try("Open constructor");
    try {
        GUrlString url("My nice text string");
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Test string writing
    GUrlString url;
    test_value(url.write("abcd", 4), 4);
    url.put_char('e');
    url.printf("fghi%s%d%3.1fxyz", "jklm", 41, 9.9);

    // Test string reading using read() method
    char buffer[100];
    url.rewind();
    test_value(url.read(buffer, 99), 21);
    std::string result = std::string(buffer, 21);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");

    // Test string reading using get_char() method
    result.clear();
    url.rewind();
    int character = 0;
    do {
        character = url.get_char();
        if (character != EOF) {
            char c = (char)character;
            result.append(1, c);
        }
    } while (character != EOF);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");

    // Test string reading using scanf() method
    char buffer2[100];
    result.clear();
    url.rewind();
    url.scanf("%99s", buffer2);
    result = std::string(buffer2, 21);
    test_assert(result.compare("abcdefghijklm419.9xyz") == 0,
                "Expected \"abcdefghijklm419.9xyz\" in file, found \""+
                result+"\"");
    url.close();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GFilename class
 *
 * Test the GFilename class.
 ***************************************************************************/
void TestGSupport::test_filename(void)
{
    // Test void constructor
    test_try("Void constructor");
    try {
        GFilename filename;
        test_try_success();
    }
    catch (std::exception &e) {
        test_try_failure(e);
    }

    // Set filename without extension
    GFilename filename = "myfile.fits";
    test_value(filename.url(), "myfile.fits");
    test_assert(!filename.has_extname(),
                "Expected that extension name is not set.");

    // Set filename with extension name
    filename = "myfile.fits[EVENTS]";
    test_value(filename.url(), "myfile.fits");
    test_value(filename.extname(), "EVENTS");
    test_assert(filename.has_extname(),
                "Expected that extension name is set.");

    // Set filename with extension name and version
    filename = "myfile.fits[EVENTS,2]";
    test_value(filename.url(), "myfile.fits");
    test_value(filename.extname(), "EVENTS");
    test_assert(filename.has_extname(),
                "Expected that extension name is set.");
    test_value(filename.extver(), 2);
    test_assert(filename.has_extver(),
                "Expected that extension version is set.");

    // Set filename with lower case extension name
    filename = "myfile.fits[events]";
    test_value(filename.extname(), "EVENTS");

    // Set filename with number in extension name
    filename = "myfile.fits[EVENTS_2D]";
    test_value(filename.extname(), "EVENTS_2D");

    // Set filename with extension number and version
    filename = "myfile.fits[1,2]";
    test_value(filename.url(), "myfile.fits");
    test_value(filename.extno(), 1);
    test_assert(filename.has_extno(),
                "Expected that extension number is set.");
    test_value(filename.extver(), 2);
    test_assert(filename.has_extver(),
                "Expected that extension version is set.");

    // Set filename with extension name and expression
    filename = "myfile.fits[EVENTS][ENERGY>0.1]";
    test_value(filename.url(), "myfile.fits");
    test_value(filename.extname(), "EVENTS");
    test_value(filename.expression(), "ENERGY>0.1");

    // Test missing closing symbol
    test_try("Missing ] symbol");
    try {
        GFilename filename("myfile.fits[");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test character after closing symbol
    test_try("Character after ] symbol");
    try {
        GFilename filename("myfile.fits[EVENTS]a");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test character after closing symbol
    test_try("Character after ] symbol after expression");
    try {
        GFilename filename("myfile.fits[EVENTS][ENERGY>0.1]a");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test empty extension name
    test_try("Empty extension name");
    try {
        GFilename filename("myfile.fits[]");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test invalid extension number
    test_try("Invalid extension number");
    try {
        GFilename filename("myfile.fits[-1]");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test missing extension version
    test_try("Missing extension version");
    try {
        GFilename filename("myfile.fits[EVENTS,]");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test invalid extension version
    test_try("Invalid extension version");
    try {
        GFilename filename("myfile.fits[EVENTS,-1]");
        test_try_failure();
    }
    catch (GException::invalid_argument &e) {
        test_try_success();
    }

    // Test size operators
    filename = "myfile.fits";
    test_assert(!filename.is_empty(), "Non empty file name expected.");
    test_value(filename.length(), 11);

    // Test default extension name
    filename = "myfile.fits";
    test_value(filename.extname("EVENTS"), "EVENTS");
    filename = "myfile.fits[LUCKY]";
    test_value(filename.extname("EVENTS"), "LUCKY");

    // Test default extension number
    filename = "myfile.fits";
    test_value(filename.extno(1), 1);
    filename = "myfile.fits[3]";
    test_value(filename.extno(1), 3);

    // Test default extension version
    filename = "myfile.fits";
    test_value(filename.extver(1), 1);
    filename = "myfile.fits[3,3]";
    test_value(filename.extver(1), 3);

    // Test type method
    filename = "myfile.fits";
    test_value(filename.type(), "fits");
    filename = "myfile.fit";
    test_value(filename.type(), "fits");
    filename = "myfile.fits.gz";
    test_value(filename.type(), "fits");
    filename = "myfile.fits.Z";
    test_value(filename.type(), "fits");
    filename = "myfile.fits.z";
    test_value(filename.type(), "fits");
    filename = "myfile.fits.zip";
    test_value(filename.type(), "fits");
    filename = "myfile.csv";
    test_value(filename.type(), "");
    filename = "myfile.csv.gz";
    test_value(filename.type(), "");

    // Return
    return;
}


/***********************************************************************//**
 * @brief Test GCsv class
 *
 * Test the GCsv class.
 ***************************************************************************/
void TestGSupport::test_csv(void)
{
    // Test void constructor
    GCsv csv1;
    test_value(csv1.size(), 0);
    test_value(csv1.ncols(), 0);
    test_value(csv1.nrows(), 0);

    // Test rows and columns constructor
    GCsv csv2(3,4);
    test_value(csv2.size(), 12);
    test_value(csv2.ncols(), 4);
    test_value(csv2.nrows(), 3);

    // Test filename constructor
    GCsv csv3(csv_file, ",");
    test_value(csv3.size(), 12);
    test_value(csv3.ncols(), 3);
    test_value(csv3.nrows(), 4);

    // Test copy constructor
    GCsv csv4(csv3);
    test_value(csv3.size(), 12);
    test_value(csv3.ncols(), 3);
    test_value(csv3.nrows(), 4);

    // Test clear method
    csv4.clear();
    test_value(csv4.size(), 0);
    test_value(csv4.ncols(), 0);
    test_value(csv4.nrows(), 0);

    // Test clone method
    GCsv* csv5 = csv3.clone();
    test_value(csv5->size(), 12);
    test_value(csv5->ncols(), 3);
    test_value(csv5->nrows(), 4);

    // Test append method
    std::vector<std::string> row1;
    std::vector<std::string> row2;
    row1.push_back("ra");
    row1.push_back("dec");
    row1.push_back("durations");
    row2.push_back("10.0");
    row2.push_back("-10.0");
    row2.push_back("1000.0");
    csv4.append(row1);
    csv4.append(row2);
    test_value(csv4.size(), 6);
    test_value(csv4.ncols(), 3);
    test_value(csv4.nrows(), 2);

    // Test operator access method
    test_value(csv4(0,0), "ra");
    test_value(csv4(0,1), "dec");
    test_value(csv4(0,2), "durations");
    test_value(csv4(1,0), "10.0");
    test_value(csv4(1,1), "-10.0");
    test_value(csv4(1,2), "1000.0");

    // Test access methods
    test_value(csv4.string(1,0), "10.0");
    test_value(csv4.real(1,0), 10.0);
    test_value(csv4.integer(1,0), 10);

    // Test set methods
    csv4.string(1,0,"11.0");
    test_value(csv4.string(1,0), "11.0");
    csv4.real(1,0, 12.0);
    test_value(csv4.real(1,0), 12.0);
    csv4.integer(1,0, 13);
    test_value(csv4.integer(1,0), 13);

    // Test save method (make sure that former result is overwritten)
    csv4.save("test_csv.dat", ",", true);
 
    // Test load method
    GCsv csv6;
    csv6.load("test_csv.dat", ",");
    test_value(csv6.size(), 6);
    test_value(csv6.ncols(), 3);
    test_value(csv6.nrows(), 2);
    test_value(csv6(0,0), "ra");
    test_value(csv6(0,1), "dec");
    test_value(csv6(0,2), "durations");
    test_value(csv6(1,0), "13");
    test_value(csv6(1,1), "-10.0");
    test_value(csv6(1,2), "1000.0");

    // Return
    return;
}


/***********************************************************************//**
 * @brief Main test entry point
 ***************************************************************************/
int main(void)
{
    // Allocate test suite container
    GTestSuites testsuites("Support module");

    // Initially assume that we pass all tests
    bool success = true;

    // Create and append test suite
    TestGSupport test;

    // Append test to the container
    testsuites.append(test);

    // Run the testsuites
    success = testsuites.run();

    // Save test report
    testsuites.save("reports/GSupport.xml");

    // Return success status
    return (success ? 0 : 1);
}