// Copyright 2011-2023 David Robillard // SPDX-License-Identifier: ISC #undef NDEBUG #include "serd/buffer.h" #include "serd/env.h" #include "serd/error.h" #include "serd/memory.h" #include "serd/node.h" #include "serd/reader.h" #include "serd/sink.h" #include "serd/statement.h" #include "serd/status.h" #include "serd/stream.h" #include "serd/syntax.h" #include "serd/writer.h" #ifdef _WIN32 # include #endif #include #include #include #include #include #include #include typedef struct { size_t n_written; size_t error_offset; } ErrorContext; typedef struct { int n_base; int n_prefix; int n_statement; int n_end; const SerdNode* graph; } ReaderTest; static const char* const doc_string = "@base .\n" "@prefix eg: .\n" "eg:g {\n" " eg:p \"l\\n\\\"it\" ,\n" " \"\"\"long\"\"\" ,\n" " \"lang\"@en ;\n" " eg:p .\n" "}\n" "eg:s\n" " [\n" " eg:p 3.0 ,\n" " 4 ,\n" " \"lit\" ,\n" " _:n42 ,\n" " \"t\"^^eg:T\n" " ] ;\n" " eg:p () ;\n" " eg:p\\!q (\"s\" 1 2.0 \"l\"@en eg:o) .\n" "[] eg:p eg:o .\n" "[ eg:p eg:o ] eg:q eg:r .\n" "( eg:o ) eg:t eg:u .\n"; static SerdStatus test_base_sink(void* handle, const SerdNode* uri) { (void)uri; ReaderTest* rt = (ReaderTest*)handle; ++rt->n_base; return SERD_SUCCESS; } static SerdStatus test_prefix_sink(void* handle, const SerdNode* name, const SerdNode* uri) { (void)name; (void)uri; ReaderTest* rt = (ReaderTest*)handle; ++rt->n_prefix; return SERD_SUCCESS; } static SerdStatus test_statement_sink(void* handle, SerdStatementFlags flags, const SerdNode* graph, const SerdNode* subject, const SerdNode* predicate, const SerdNode* object, const SerdNode* object_datatype, const SerdNode* object_lang) { (void)flags; (void)subject; (void)predicate; (void)object; (void)object_datatype; (void)object_lang; ReaderTest* rt = (ReaderTest*)handle; ++rt->n_statement; rt->graph = graph; return SERD_SUCCESS; } static SerdStatus test_end_sink(void* handle, const SerdNode* node) { (void)node; ReaderTest* rt = (ReaderTest*)handle; ++rt->n_end; return SERD_SUCCESS; } /// Reads a null byte after a statement, then succeeds again (like a socket) static size_t eof_test_read(void* buf, size_t size, size_t nmemb, void* stream) { assert(size == 1); assert(nmemb == 1); (void)size; static const char* const string = "_:s1 _:o1 .\n" "_:s2 _:o2 .\n"; size_t* const count = (size_t*)stream; // Normal reading for the first statement if (*count < 35) { *(char*)buf = string[*count]; ++*count; return nmemb; } // EOF for the first read at the start of the second statement if (*count == 35) { assert(string[*count] == '_'); ++*count; return 0; } if (*count >= strlen(string)) { return 0; } // Normal reading after the EOF, adjusting for the skipped index 35 *(char*)buf = string[*count - 1]; ++*count; return nmemb; } static int eof_test_error(void* stream) { (void)stream; return 0; } static void test_read_nquads_chunks(const char* const path) { static const char null = 0; FILE* const f = fopen(path, "w+b"); // Write two statements, a null separator, then another statement fprintf(f, " " " .\n"); fprintf(f, " " " .\n"); fwrite(&null, sizeof(null), 1, f); fprintf(f, " " " .\n"); fseek(f, 0, SEEK_SET); ReaderTest* const rt = (ReaderTest*)calloc(1, sizeof(ReaderTest)); SerdReader* const reader = serd_reader_new(SERD_NQUADS, rt, free, test_base_sink, test_prefix_sink, test_statement_sink, test_end_sink); assert(reader); assert(serd_reader_handle(reader) == rt); assert(f); SerdStatus st = serd_reader_start_stream(reader, f, NULL, false); assert(st == SERD_SUCCESS); // Read first statement st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 1); assert(rt->n_end == 0); // Read second statement st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 2); assert(rt->n_end == 0); // Read terminator st = serd_reader_read_chunk(reader); assert(st == SERD_FAILURE); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 2); assert(rt->n_end == 0); // Read last statement st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 3); assert(rt->n_end == 0); // EOF st = serd_reader_read_chunk(reader); assert(st == SERD_FAILURE); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 3); assert(rt->n_end == 0); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); serd_reader_free(reader); fclose(f); remove(path); } static void test_read_turtle_chunks(const char* const path) { static const char null = 0; FILE* const f = fopen(path, "w+b"); // Write two statements separated by null characters fprintf(f, "@base .\n"); fprintf(f, "@prefix eg: .\n"); fprintf(f, "eg:s eg:p1 eg:o1 ;\n"); fprintf(f, " eg:p2 eg:o2 .\n"); fwrite(&null, sizeof(null), 1, f); fprintf(f, "eg:s eg:p [ eg:sp eg:so ] .\n"); fwrite(&null, sizeof(null), 1, f); fseek(f, 0, SEEK_SET); ReaderTest* const rt = (ReaderTest*)calloc(1, sizeof(ReaderTest)); SerdReader* const reader = serd_reader_new(SERD_TURTLE, rt, free, test_base_sink, test_prefix_sink, test_statement_sink, test_end_sink); assert(reader); assert(serd_reader_handle(reader) == rt); assert(f); SerdStatus st = serd_reader_start_stream(reader, f, NULL, false); assert(st == SERD_SUCCESS); // Read base st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 1); assert(rt->n_prefix == 0); assert(rt->n_statement == 0); assert(rt->n_end == 0); // Read prefix st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 0); assert(rt->n_end == 0); // Read first two statements st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 2); assert(rt->n_end == 0); // Read terminator st = serd_reader_read_chunk(reader); assert(st == SERD_FAILURE); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 2); assert(rt->n_end == 0); // Read statements after null terminator st = serd_reader_read_chunk(reader); assert(st == SERD_SUCCESS); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 4); assert(rt->n_end == 1); // Read terminator st = serd_reader_read_chunk(reader); assert(st == SERD_FAILURE); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 4); assert(rt->n_end == 1); // EOF st = serd_reader_read_chunk(reader); assert(st == SERD_FAILURE); assert(rt->n_base == 1); assert(rt->n_prefix == 1); assert(rt->n_statement == 4); assert(rt->n_end == 1); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); serd_reader_free(reader); fclose(f); remove(path); } static void test_read_string(void) { ReaderTest* rt = (ReaderTest*)calloc(1, sizeof(ReaderTest)); SerdReader* reader = serd_reader_new(SERD_TURTLE, rt, free, test_base_sink, test_prefix_sink, test_statement_sink, test_end_sink); assert(reader); assert(serd_reader_handle(reader) == rt); // Test reading a string that ends exactly at the end of input (no newline) const SerdStatus st = serd_reader_read_string(reader, " " " ."); assert(!st); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 1); assert(rt->n_end == 0); serd_reader_free(reader); } static size_t faulty_sink(const void* const buf, const size_t len, void* const stream) { (void)buf; (void)len; ErrorContext* const ctx = (ErrorContext*)stream; const size_t new_n_written = ctx->n_written + len; if (new_n_written >= ctx->error_offset) { errno = EINVAL; return 0U; } ctx->n_written += len; errno = 0; return len; } static SerdStatus quiet_error_sink(void* const handle, const SerdError* const e) { (void)handle; (void)e; return SERD_SUCCESS; } static void test_write_errors(void) { ErrorContext ctx = {0U, 0U}; const SerdWriterFlags style = (SerdWriterFlags)(SERD_WRITE_STRICT | SERD_WRITE_CURIED); const size_t max_offsets[] = {0, 386, 1911, 2003, 386}; // Test errors at different offsets to hit different code paths for (unsigned s = 1; s <= (unsigned)SERD_TRIG; ++s) { const SerdSyntax syntax = (SerdSyntax)s; for (size_t o = 0; o < max_offsets[s]; ++o) { ctx.n_written = 0; ctx.error_offset = o; SerdEnv* const env = serd_env_new(NULL); SerdWriter* const writer = serd_writer_new(syntax, style, env, NULL, faulty_sink, &ctx); SerdReader* const reader = serd_reader_new(SERD_TRIG, writer, NULL, (SerdBaseFunc)serd_writer_set_base_uri, (SerdPrefixFunc)serd_writer_set_prefix, (SerdStatementFunc)serd_writer_write_statement, (SerdEndFunc)serd_writer_end_anon); serd_reader_set_error_sink(reader, quiet_error_sink, NULL); serd_writer_set_error_sink(writer, quiet_error_sink, NULL); const SerdStatus st = serd_reader_read_string(reader, doc_string); assert(st == SERD_ERR_BAD_WRITE); serd_reader_free(reader); serd_writer_free(writer); serd_env_free(env); } } } static void test_writer(const char* const path) { FILE* fd = fopen(path, "wb"); SerdEnv* env = serd_env_new(NULL); assert(fd); SerdWriter* writer = serd_writer_new(SERD_TURTLE, 0, env, NULL, serd_file_sink, fd); assert(writer); serd_writer_chop_blank_prefix(writer, "tmp"); serd_writer_chop_blank_prefix(writer, NULL); const SerdNode lit = serd_node_from_string(SERD_LITERAL, "hello"); assert(serd_writer_set_base_uri(writer, &lit)); assert(serd_writer_set_prefix(writer, &lit, &lit)); assert(serd_writer_end_anon(writer, NULL)); assert(serd_writer_env(writer) == env); uint8_t buf[] = {0xEF, 0xBF, 0xBD, 0}; SerdNode s = serd_node_from_string(SERD_URI, ""); SerdNode p = serd_node_from_string(SERD_URI, "http://example.org/pred"); SerdNode o = serd_node_from_string(SERD_LITERAL, (char*)buf); // Write 3 invalid statements (should write nothing) const SerdNode* junk[][5] = {{&s, &p, &SERD_NODE_NULL, NULL, NULL}, {&s, &SERD_NODE_NULL, &o, NULL, NULL}, {&SERD_NODE_NULL, &p, &o, NULL, NULL}, {&s, &o, &o, NULL, NULL}, {&o, &p, &o, NULL, NULL}, {&s, &p, &SERD_NODE_NULL, NULL, NULL}}; for (size_t i = 0; i < sizeof(junk) / (sizeof(SerdNode*) * 5); ++i) { assert(serd_writer_write_statement(writer, 0, NULL, junk[i][0], junk[i][1], junk[i][2], junk[i][3], junk[i][4])); } const SerdNode t = serd_node_from_string(SERD_URI, "urn:Type"); const SerdNode l = serd_node_from_string(SERD_LITERAL, "en"); const SerdNode* good[][5] = {{&s, &p, &o, NULL, NULL}, {&s, &p, &o, &SERD_NODE_NULL, &SERD_NODE_NULL}, {&s, &p, &o, &t, NULL}, {&s, &p, &o, NULL, &l}, {&s, &p, &o, &t, &l}, {&s, &p, &o, &t, &SERD_NODE_NULL}, {&s, &p, &o, &SERD_NODE_NULL, &l}, {&s, &p, &o, NULL, &SERD_NODE_NULL}, {&s, &p, &o, &SERD_NODE_NULL, NULL}, {&s, &p, &o, &SERD_NODE_NULL, NULL}}; for (size_t i = 0; i < sizeof(good) / (sizeof(SerdNode*) * 5); ++i) { assert(!serd_writer_write_statement(writer, 0, NULL, good[i][0], good[i][1], good[i][2], good[i][3], good[i][4])); } // Write statements with bad UTF-8 (should be replaced) const uint8_t bad_str[] = {0xFF, 0x90, 'h', 'i', 0}; SerdNode bad_lit = serd_node_from_string(SERD_LITERAL, (const char*)bad_str); SerdNode bad_uri = serd_node_from_string(SERD_URI, (const char*)bad_str); assert(!serd_writer_write_statement( writer, 0, NULL, &s, &p, &bad_lit, NULL, NULL)); assert(!serd_writer_write_statement( writer, 0, NULL, &s, &p, &bad_uri, NULL, NULL)); // Write 1 valid statement o = serd_node_from_string(SERD_LITERAL, "hello"); assert(!serd_writer_write_statement(writer, 0, NULL, &s, &p, &o, NULL, NULL)); serd_writer_free(writer); // Test buffer sink SerdBuffer buffer = {NULL, 0}; writer = serd_writer_new(SERD_TURTLE, 0, env, NULL, serd_buffer_sink, &buffer); o = serd_node_from_string(SERD_URI, "http://example.org/base"); assert(!serd_writer_set_base_uri(writer, &o)); serd_writer_free(writer); char* out = serd_buffer_sink_finish(&buffer); assert(!strcmp(out, "@base .\n")); serd_free(out); // Test writing empty node SerdNode nothing = serd_node_from_string(SERD_NOTHING, ""); buffer.buf = NULL; buffer.len = 0; writer = serd_writer_new(SERD_TURTLE, 0U, env, NULL, serd_buffer_sink, &buffer); assert(!serd_writer_write_statement( writer, 0, NULL, &s, &p, ¬hing, NULL, NULL)); assert( !strncmp((const char*)buffer.buf, "<>\n\t ", 30)); serd_writer_free(writer); out = serd_buffer_sink_finish(&buffer); assert(!strcmp((const char*)out, "<>\n\t .\n")); serd_free(out); serd_env_free(env); fclose(fd); } static void test_reader(const char* path) { ReaderTest* rt = (ReaderTest*)calloc(1, sizeof(ReaderTest)); SerdReader* reader = serd_reader_new(SERD_TURTLE, rt, free, test_base_sink, test_prefix_sink, test_statement_sink, test_end_sink); assert(reader); assert(serd_reader_handle(reader) == rt); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); SerdNode g = serd_node_from_string(SERD_URI, "http://example.org/"); serd_reader_set_default_graph(reader, &g); serd_reader_add_blank_prefix(reader, "tmp"); #if defined(__GNUC__) # pragma GCC diagnostic push # pragma GCC diagnostic ignored "-Wnonnull" #endif serd_reader_add_blank_prefix(reader, NULL); #if defined(__GNUC__) # pragma GCC diagnostic pop #endif assert(serd_reader_read_file(reader, "http://notafile")); assert(serd_reader_read_file(reader, "file:///better/not/exist")); assert(serd_reader_read_file(reader, "file://")); const SerdStatus st = serd_reader_read_file(reader, path); assert(!st); assert(rt->n_base == 0); assert(rt->n_prefix == 0); assert(rt->n_statement == 13); assert(rt->n_end == 0); assert(rt->graph && rt->graph->buf && !strcmp(rt->graph->buf, "http://example.org/")); assert(serd_reader_read_string(reader, "This isn't Turtle at all.")); // A read of a big page hits EOF then fails to read chunks immediately { FILE* const in = fopen(path, "rb"); serd_reader_start_stream(reader, in, "test", true); assert(serd_reader_read_chunk(reader) == SERD_SUCCESS); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); serd_reader_end_stream(reader); fclose(in); } // A byte-wise reader that hits EOF once then continues (like a socket) { size_t n_reads = 0; serd_reader_start_source_stream(reader, (SerdSource)eof_test_read, (SerdStreamErrorFunc)eof_test_error, &n_reads, NULL, 1); assert(serd_reader_read_chunk(reader) == SERD_SUCCESS); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); assert(serd_reader_read_chunk(reader) == SERD_SUCCESS); assert(serd_reader_read_chunk(reader) == SERD_FAILURE); } serd_reader_free(reader); } int main(void) { #ifdef _WIN32 char tmp[MAX_PATH] = {0}; const size_t tmp_len = (size_t)GetTempPath(sizeof(tmp), tmp); #else const char* const env_tmp = getenv("TMPDIR"); const char* const tmp = env_tmp ? env_tmp : "/tmp"; const size_t tmp_len = strlen(tmp); #endif const char* const ttl_name = "serd_test_reader_writer.ttl"; const char* const nq_name = "serd_test_reader_writer.nq"; const size_t ttl_name_len = strlen(ttl_name); const size_t nq_name_len = strlen(nq_name); const size_t path_len = tmp_len + 1 + ttl_name_len; char* const path = (char*)calloc(path_len + 1, 1); memcpy(path, tmp, tmp_len + 1); path[tmp_len] = '/'; memcpy(path + tmp_len + 1, nq_name, nq_name_len + 1); test_read_nquads_chunks(path); memcpy(path + tmp_len + 1, ttl_name, ttl_name_len + 1); test_read_turtle_chunks(path); test_read_string(); test_write_errors(); test_writer(path); test_reader(path); assert(!remove(path)); free(path); printf("Success\n"); return 0; }