osrm-backend/test/data-tests/testdata-xml.cpp

/* The code in this file is released into the Public Domain. */

#define CATCH_CONFIG_MAIN
#include "catch.hpp"

#include <cassert>
#include <cstdlib>
#include <iostream>
#include <string>

#include <osmium/io/xml_input.hpp>
#include <osmium/io/gzip_compression.hpp>
#include <osmium/visitor.hpp>

std::string S_(const char* s) {
    return std::string(s);
}

std::string filename(const char* test_id, const char* suffix = "osm") {
    const char* testdir = getenv("TESTDIR");
    if (!testdir) {
        std::cerr << "You have to set TESTDIR environment variable before running testdata-xml\n";
        exit(2);
    }

    std::string f;
    f += testdir;
    f += "/";
    f += test_id;
    f += "/data.";
    f += suffix;
    return f;
}

struct header_buffer_type {
    osmium::io::Header header;
    osmium::memory::Buffer buffer;
};

// =============================================

// The following helper functions are used to call different parts of the
// Osmium internals used to read and parse XML files. This way those parts
// can be tested individually. These function can not be used in normal
// operations, because they make certain assumptions, for instance that
// file contents fit into small buffers.

std::string read_file(const char* test_id) {
    int fd = osmium::io::detail::open_for_reading(filename(test_id));
    assert(fd >= 0);

    std::string input(10000, '\0');
    auto n = ::read(fd, reinterpret_cast<unsigned char*>(const_cast<char*>(input.data())), 10000);
    assert(n >= 0);
    input.resize(static_cast<std::string::size_type>(n));

    close(fd);

    return input;
}

std::string read_gz_file(const char* test_id, const char* suffix) {
    int fd = osmium::io::detail::open_for_reading(filename(test_id, suffix));
    assert(fd >= 0);

    osmium::io::GzipDecompressor gzip_decompressor(fd);
    std::string input = gzip_decompressor.read();
    gzip_decompressor.close();

    return input;
}


header_buffer_type parse_xml(std::string input) {
    osmium::thread::Queue<std::string> input_queue;
    osmium::thread::Queue<osmium::memory::Buffer> output_queue;
    std::promise<osmium::io::Header> header_promise;
    std::atomic<bool> done {false};
    input_queue.push(input);
    input_queue.push(std::string()); // EOF marker

    osmium::io::detail::XMLParser parser(input_queue, output_queue, header_promise, osmium::osm_entity_bits::all, done);
    parser();

    header_buffer_type result;
    result.header = header_promise.get_future().get();
    output_queue.wait_and_pop(result.buffer);

    if (result.buffer) {
        osmium::memory::Buffer buffer;
        output_queue.wait_and_pop(buffer);
        assert(!buffer);
    }

    return result;
}

header_buffer_type read_xml(const char* test_id) {
    std::string input = read_file(test_id);
    return parse_xml(input);
}

// =============================================

TEST_CASE("Reading OSM XML 100") {

    SECTION("Direct") {
        header_buffer_type r = read_xml("100-correct_but_no_data");

        REQUIRE(r.header.get("generator") == "testdata");
        REQUIRE(0 == r.buffer.committed());
        REQUIRE(! r.buffer);
    }

    SECTION("Using Reader") {
        osmium::io::Reader reader(filename("100-correct_but_no_data"));

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(0 == buffer.committed());
        REQUIRE(! buffer);
        reader.close();
    }

    SECTION("Using Reader asking for header only") {
        osmium::io::Reader reader(filename("100-correct_but_no_data"), osmium::osm_entity_bits::nothing);

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");
        reader.close();
    }

}

// =============================================

TEST_CASE("Reading OSM XML 101") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS(read_xml("101-missing_version"), osmium::format_version_error);
        try {
            read_xml("101-missing_version");
        } catch (osmium::format_version_error& e) {
            REQUIRE(e.version.empty());
        }
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("101-missing_version"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::format_version_error);
    }

}

// =============================================

TEST_CASE("Reading OSM XML 102") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS(read_xml("102-wrong_version"), osmium::format_version_error);
        try {
            read_xml("102-wrong_version");
        } catch (osmium::format_version_error& e) {
            REQUIRE(e.version == "0.1");
        }
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("102-wrong_version"));

            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::format_version_error);
    }

}

// =============================================

TEST_CASE("Reading OSM XML 103") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS(read_xml("103-old_version"), osmium::format_version_error);
        try {
            read_xml("103-old_version");
        } catch (osmium::format_version_error& e) {
            REQUIRE(e.version == "0.5");
        }
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("103-old_version"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::format_version_error);
    }

}

// =============================================

TEST_CASE("Reading OSM XML 104") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS(read_xml("104-empty_file"), osmium::xml_error);
        try {
            read_xml("104-empty_file");
        } catch (osmium::xml_error& e) {
            REQUIRE(e.line == 1);
            REQUIRE(e.column == 0);
        }
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("104-empty_file"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::xml_error);
    }
}

// =============================================

TEST_CASE("Reading OSM XML 105") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS(read_xml("105-incomplete_xml_file"), osmium::xml_error);
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("105-incomplete_xml_file"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::xml_error);
    }

}

// =============================================

TEST_CASE("Reading OSM XML 120") {

    SECTION("Direct") {
        std::string data = read_gz_file("120-correct_gzip_file_without_data", "osm.gz");

        REQUIRE(data.size() == 102);

        header_buffer_type r = parse_xml(data);
        REQUIRE(r.header.get("generator") == "testdata");
        REQUIRE(0 == r.buffer.committed());
        REQUIRE(! r.buffer);
    }

    SECTION("Using Reader") {
        osmium::io::Reader reader(filename("120-correct_gzip_file_without_data", "osm.gz"));

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(0 == buffer.committed());
        REQUIRE(! buffer);
        reader.close();
    }

}

// =============================================

TEST_CASE("Reading OSM XML 121") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS( {
            read_gz_file("121-truncated_gzip_file", "osm.gz");
        }, osmium::gzip_error);
    }

    SECTION("Using Reader") {
        // can throw osmium::gzip_error or osmium::xml_error
        REQUIRE_THROWS({
            osmium::io::Reader reader(filename("121-truncated_gzip_file", "osm.gz"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        });
    }

}

// =============================================

TEST_CASE("Reading OSM XML 122") {

    SECTION("Direct") {
        REQUIRE_THROWS_AS( {
            read_xml("122-no_osm_element");
        }, osmium::xml_error);
    }

    SECTION("Using Reader") {
        REQUIRE_THROWS_AS({
            osmium::io::Reader reader(filename("122-no_osm_element"));
            osmium::io::Header header = reader.header();
            osmium::memory::Buffer buffer = reader.read();
            reader.close();
        }, osmium::xml_error);
    }

}

// =============================================

TEST_CASE("Reading OSM XML 140") {

    SECTION("Using Reader") {
        osmium::io::Reader reader(filename("140-unicode"));
        osmium::memory::Buffer buffer = reader.read();
        reader.close();

        int count = 0;
        for (auto it = buffer.begin<osmium::Node>(); it != buffer.end<osmium::Node>(); ++it) {
            ++count;
            REQUIRE(it->id() == count);
            const osmium::TagList& t = it->tags();

            const char* uc = t["unicode_char"];

            auto len = atoi(t["unicode_utf8_length"]);
            REQUIRE(len == strlen(uc));

            REQUIRE(S_(uc) == t["unicode_xml"]);

// workaround for missing support for u8 string literals on Windows
#if !defined(_MSC_VER)
            switch (count) {
                case 1:
                    REQUIRE(S_(uc) ==  u8"a");
                    break;
                case 2:
                    REQUIRE(S_(uc) == u8"\u00e4");
                    break;
                case 3:
                    REQUIRE(S_(uc) == u8"\u30dc");
                    break;
                case 4:
                    REQUIRE(S_(uc) == u8"\U0001d11e");
                    break;
                case 5:
                    REQUIRE(S_(uc) == u8"\U0001f6eb");
                    break;
                default:
                    REQUIRE(false); // should not be here
            }
#endif
        }
        REQUIRE(count == 5);
    }

}


// =============================================

TEST_CASE("Reading OSM XML 141") {

    SECTION("Using Reader") {
        osmium::io::Reader reader(filename("141-entities"));
        osmium::memory::Buffer buffer = reader.read();
        reader.close();
        REQUIRE(buffer.committed() > 0);
        REQUIRE(buffer.get<osmium::memory::Item>(0).type() == osmium::item_type::node);

        const osmium::Node& node = buffer.get<osmium::Node>(0);
        const osmium::TagList& tags = node.tags();

        REQUIRE(S_(tags["less-than"])    == "<");
        REQUIRE(S_(tags["greater-than"]) == ">");
        REQUIRE(S_(tags["apostrophe"])   == "'");
        REQUIRE(S_(tags["ampersand"])    == "&");
        REQUIRE(S_(tags["quote"])        == "\"");
    }

}


// =============================================

TEST_CASE("Reading OSM XML 142") {

    SECTION("Using Reader to read nodes") {
        osmium::io::Reader reader(filename("142-whitespace"));
        osmium::memory::Buffer buffer = reader.read();
        reader.close();

        int count = 0;
        for (auto it = buffer.begin<osmium::Node>(); it != buffer.end<osmium::Node>(); ++it) {
            ++count;
            REQUIRE(it->id() == count);
            REQUIRE(it->tags().size() == 1);
            const osmium::Tag& tag = *(it->tags().begin());

            switch (count) {
                case 1:
                    REQUIRE(S_(it->user()) == "user name");
                    REQUIRE(S_(tag.key()) == "key with space");
                    REQUIRE(S_(tag.value()) == "value with space");
                    break;
                case 2:
                    REQUIRE(S_(it->user()) == "line\nfeed");
                    REQUIRE(S_(tag.key()) == "key with\nlinefeed");
                    REQUIRE(S_(tag.value()) == "value with\nlinefeed");
                    break;
                case 3:
                    REQUIRE(S_(it->user()) == "carriage\rreturn");
                    REQUIRE(S_(tag.key()) == "key with\rcarriage\rreturn");
                    REQUIRE(S_(tag.value()) == "value with\rcarriage\rreturn");
                    break;
                case 4:
                    REQUIRE(S_(it->user()) == "tab\tulator");
                    REQUIRE(S_(tag.key()) == "key with\ttab");
                    REQUIRE(S_(tag.value()) == "value with\ttab");
                    break;
                case 5:
                    REQUIRE(S_(it->user()) == "unencoded linefeed");
                    REQUIRE(S_(tag.key()) == "key with unencoded linefeed");
                    REQUIRE(S_(tag.value()) == "value with unencoded linefeed");
                    break;
                default:
                    REQUIRE(false); // should not be here
            }
        }
        REQUIRE(count == 5);
    }

    SECTION("Using Reader to read relation") {
        osmium::io::Reader reader(filename("142-whitespace"));
        osmium::memory::Buffer buffer = reader.read();
        reader.close();

        auto it = buffer.begin<osmium::Relation>();
        REQUIRE(it != buffer.end<osmium::Relation>());
        REQUIRE(it->id() == 21);
        const auto& members = it->members();
        REQUIRE(members.size() == 5);

        int count = 0;
        for (const auto& member : members) {
            ++count;
            switch (count) {
                case 1:
                    REQUIRE(S_(member.role()) == "role with whitespace");
                    break;
                case 2:
                    REQUIRE(S_(member.role()) == "role with\nlinefeed");
                    break;
                case 3:
                    REQUIRE(S_(member.role()) == "role with\rcarriage\rreturn");
                    break;
                case 4:
                    REQUIRE(S_(member.role()) == "role with\ttab");
                    break;
                case 5:
                    REQUIRE(S_(member.role()) == "role with unencoded linefeed");
                    break;
                default:
                    REQUIRE(false); // should not be here
            }
        }
        REQUIRE(count == 5);
    }

}


// =============================================

TEST_CASE("Reading OSM XML 200") {

    SECTION("Direct") {
        header_buffer_type r = read_xml("200-nodes");

        REQUIRE(r.header.get("generator") == "testdata");
        REQUIRE(r.buffer.committed() > 0);
        REQUIRE(r.buffer.get<osmium::memory::Item>(0).type() == osmium::item_type::node);
        REQUIRE(r.buffer.get<osmium::Node>(0).id() == 36966060);
        REQUIRE(std::distance(r.buffer.begin(), r.buffer.end()) == 3);
    }

    SECTION("Using Reader") {
        osmium::io::Reader reader(filename("200-nodes"));

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(buffer.committed() > 0);
        REQUIRE(buffer.get<osmium::memory::Item>(0).type() == osmium::item_type::node);
        REQUIRE(buffer.get<osmium::Node>(0).id() == 36966060);
        REQUIRE(std::distance(buffer.begin(), buffer.end()) == 3);
        reader.close();
    }

    SECTION("Using Reader asking for nodes") {
        osmium::io::Reader reader(filename("200-nodes"), osmium::osm_entity_bits::node);

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(buffer.committed() > 0);
        REQUIRE(buffer.get<osmium::memory::Item>(0).type() == osmium::item_type::node);
        REQUIRE(buffer.get<osmium::Node>(0).id() == 36966060);
        REQUIRE(std::distance(buffer.begin(), buffer.end()) == 3);
        reader.close();
    }

    SECTION("Using Reader asking for header only") {
        osmium::io::Reader reader(filename("200-nodes"), osmium::osm_entity_bits::nothing);

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(0 == buffer.committed());
        REQUIRE(! buffer);
        reader.close();
    }

    SECTION("Using Reader asking for ways") {
        osmium::io::Reader reader(filename("200-nodes"), osmium::osm_entity_bits::way);

        osmium::io::Header header = reader.header();
        REQUIRE(header.get("generator") == "testdata");

        osmium::memory::Buffer buffer = reader.read();
        REQUIRE(0 == buffer.committed());
        REQUIRE(! buffer);
        reader.close();
    }

}