Tests: Add event context accessors unit tests
[babeltrace.git] / tests / lib / test_ctf_writer.c
index 42277026fcb9b2ac95e31dcdadd7305ae9ed0f22..608172cf926ce9096ab9623fd3a57c0d9888776b 100644 (file)
@@ -34,7 +34,6 @@
 #include <babeltrace/compat/limits.h>
 #include <string.h>
 #include <assert.h>
-#include <unistd.h>
 #include <sys/wait.h>
 #include <fcntl.h>
 #include <dirent.h>
@@ -290,6 +289,8 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
        struct bt_ctf_field_type *enum_type;
        struct bt_ctf_field_type *enum_type_unsigned =
                bt_ctf_field_type_enumeration_create(uint_12_type);
+       struct bt_ctf_field_type *event_context_type =
+               bt_ctf_field_type_structure_create();
        struct bt_ctf_field_type *returned_type;
        struct bt_ctf_event *simple_event;
        struct bt_ctf_field *integer_field;
@@ -303,13 +304,16 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
        const char *mapping_name_negative_test = "negative_value";
        const char *ret_char;
        double ret_double;
-       size_t ret_size_t;
        int64_t ret_range_start_int64_t, ret_range_end_int64_t;
        uint64_t ret_range_start_uint64_t, ret_range_end_uint64_t;
        struct bt_ctf_clock *ret_clock;
        struct bt_ctf_event_class *ret_event_class;
        struct bt_ctf_field *packet_context;
        struct bt_ctf_field *packet_context_field;
+       struct bt_ctf_field *stream_event_context;
+       struct bt_ctf_field *stream_event_context_field;
+       struct bt_ctf_field *event_context;
+       struct bt_ctf_field *event_context_field;
 
        ok(uint_12_type, "Create an unsigned integer type");
 
@@ -322,6 +326,7 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
        ok(!bt_ctf_field_type_enumeration_get_container_type(NULL), "bt_ctf_field_type_enumeration_get_container_type handles NULL correctly");
        ok(!bt_ctf_field_type_enumeration_create(enum_type),
                "bt_ctf_field_enumeration_type_create rejects non-integer container field types");
+       bt_ctf_field_type_put(returned_type);
 
        bt_ctf_field_type_set_alignment(float_type, 32);
        ok(bt_ctf_field_type_get_alignment(NULL) < 0,
@@ -365,15 +370,11 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
                -54, -55), "bt_ctf_field_type_enumeration_add_mapping rejects mapping where end < start");
        bt_ctf_field_type_enumeration_add_mapping(enum_type, "another entry", -42000, -13000);
 
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(NULL, -42, &ret_size_t) < 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(NULL, -42) < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_value handles a NULL field type correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(enum_type, -42, NULL) < 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_value handles a NULL index correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(enum_type, 1000000, &ret_size_t) < 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_value handles invalid values correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(enum_type, -55, &ret_size_t) == 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(enum_type, 1000000) < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_value handles invalid values correctly");
-       ok(ret_size_t == 1,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_value(enum_type, -55) == 1,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_value returns the correct index");
 
        ok(bt_ctf_event_class_add_field(simple_event_class, enum_type,
@@ -474,11 +475,29 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
                "bt_ctf_stream_class_get_event_class_by_name handles a NULL event class name correctly");
        ok(bt_ctf_stream_class_get_event_class_by_name(stream_class, "some event name") == NULL,
                "bt_ctf_stream_class_get_event_class_by_name handles non-existing event class names correctly");
-        ret_event_class = bt_ctf_stream_class_get_event_class_by_name(stream_class, "Simple Event");
+       ret_event_class = bt_ctf_stream_class_get_event_class_by_name(stream_class, "Simple Event");
        ok(ret_event_class == simple_event_class,
                "bt_ctf_stream_class_get_event_class_by_name returns a correct event class");
        bt_ctf_event_class_put(ret_event_class);
 
+       /* Set an event context type which will contain a single integer*/
+       bt_ctf_field_type_structure_add_field(event_context_type, uint_12_type,
+               "event_specific_context");
+       ok(bt_ctf_event_class_get_context_type(NULL) == NULL,
+               "bt_ctf_event_class_get_context_type handles NULL correctly");
+       ok(bt_ctf_event_class_get_context_type(simple_event_class) == NULL,
+               "bt_ctf_event_class_get_context_type returns NULL when no event context type is set");
+       ok(bt_ctf_event_class_set_context_type(simple_event_class, NULL) < 0,
+               "bt_ctf_event_class_set_context_type handles a NULL context type correctly");
+       ok(bt_ctf_event_class_set_context_type(NULL, event_context_type) < 0,
+               "bt_ctf_event_class_set_context_type handles a NULL event class correctly");
+       ok(!bt_ctf_event_class_set_context_type(simple_event_class, event_context_type),
+               "Set an event class' context type successfully");
+       returned_type = bt_ctf_event_class_get_context_type(simple_event_class);
+       ok(returned_type == event_context_type,
+               "bt_ctf_event_class_get_context_type returns the appropriate type");
+       bt_ctf_field_type_put(returned_type);
+
        simple_event = bt_ctf_event_create(simple_event_class);
        ok(simple_event,
                "Instantiate an event containing a single integer field");
@@ -537,6 +556,34 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
 
        ok(bt_ctf_clock_set_time(clock, current_time) == 0, "Set clock time");
 
+       /* Populate stream event context */
+       stream_event_context = bt_ctf_stream_get_event_context(stream);
+       stream_event_context_field = bt_ctf_field_structure_get_field(
+               stream_event_context, "common_event_context");
+       bt_ctf_field_unsigned_integer_set_value(stream_event_context_field, 42);
+
+       /* Populate the event's context */
+       ok(bt_ctf_event_get_event_context(NULL) == NULL,
+               "bt_ctf_event_get_event_context handles NULL correctly");
+       event_context = bt_ctf_event_get_event_context(simple_event);
+       ok(event_context,
+               "bt_ctf_event_get_event_context returns a field");
+       returned_type = bt_ctf_field_get_type(event_context);
+       ok(returned_type == event_context_type,
+               "bt_ctf_event_get_event_context returns a field of the appropriate type");
+       event_context_field = bt_ctf_field_structure_get_field(event_context,
+               "event_specific_context");
+       ok(!bt_ctf_field_unsigned_integer_set_value(event_context_field, 1234),
+               "Successfully set an event context's value");
+       ok(bt_ctf_event_set_event_context(NULL, event_context) < 0,
+               "bt_ctf_event_set_event_context handles a NULL event correctly");
+       ok(bt_ctf_event_set_event_context(simple_event, NULL) < 0,
+               "bt_ctf_event_set_event_context handles a NULL event context correctly");
+       ok(bt_ctf_event_set_event_context(simple_event, event_context_field) < 0,
+               "bt_ctf_event_set_event_context rejects a context of the wrong type");
+       ok(!bt_ctf_event_set_event_context(simple_event, event_context),
+               "Set an event context successfully");
+
        ok(bt_ctf_stream_append_event(stream, simple_event) == 0,
                "Append simple event to trace stream");
 
@@ -552,7 +599,7 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
                "Packet context contains the default packet_size field.");
        bt_ctf_field_put(packet_context_field);
        packet_context_field = bt_ctf_field_structure_get_field(packet_context,
-               "custom_field");
+               "custom_packet_context_field");
        ok(bt_ctf_field_unsigned_integer_set_value(packet_context_field, 8) == 0,
                "Custom packet context field value successfully set.");
 
@@ -574,6 +621,7 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
        bt_ctf_field_type_put(enum_type);
        bt_ctf_field_type_put(enum_type_unsigned);
        bt_ctf_field_type_put(returned_type);
+       bt_ctf_field_type_put(event_context_type);
        bt_ctf_field_put(integer_field);
        bt_ctf_field_put(float_field);
        bt_ctf_field_put(enum_field);
@@ -582,6 +630,10 @@ void append_simple_event(struct bt_ctf_stream_class *stream_class,
        bt_ctf_field_put(enum_container_field_unsigned);
        bt_ctf_field_put(packet_context);
        bt_ctf_field_put(packet_context_field);
+       bt_ctf_field_put(stream_event_context);
+       bt_ctf_field_put(stream_event_context_field);
+       bt_ctf_field_put(event_context);
+       bt_ctf_field_put(event_context_field);
 }
 
 void append_complex_event(struct bt_ctf_stream_class *stream_class,
@@ -619,7 +671,6 @@ void append_complex_event(struct bt_ctf_stream_class *stream_class,
        uint64_t ret_unsigned_int;
        int64_t ret_signed_int;
        const char *ret_string;
-       size_t ret_size_t;
        struct bt_ctf_stream_class *ret_stream_class;
        struct bt_ctf_event_class *ret_event_class;
        struct bt_ctf_field *packet_context, *packet_context_field;
@@ -660,30 +711,21 @@ void append_complex_event(struct bt_ctf_stream_class *stream_class,
        bt_ctf_field_type_enumeration_add_mapping(enum_variant_type,
                "UINT35_TYPE", 2, 7);
 
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(NULL, "INT16_TYPE",
-               &ret_size_t) < 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(NULL,
+               "INT16_TYPE") < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_name handles a NULL field type correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(enum_variant_type, NULL,
-               &ret_size_t) < 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(
+               enum_variant_type, NULL) < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_name handles a NULL name correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(enum_variant_type, "INT16_TYPE",
-               NULL) < 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_name handles a NULL index correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(enum_variant_type, "INT16_TYPE",
-               &ret_size_t) == 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_name returns a value");
-       ok(ret_size_t == 1,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_name(
+               enum_variant_type, "INT16_TYPE") == 1,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_name returns the correct index");
 
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(NULL, 1, &ret_size_t) < 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(NULL, 1) < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value handles a NULL field type correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(enum_variant_type, 1, NULL) < 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value handles a NULL index correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(enum_variant_type, -42, &ret_size_t) < 0,
-               "bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value handles invalid values correctly");
-       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(enum_variant_type, 5, &ret_size_t) == 0,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(enum_variant_type, -42) < 0,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value handles invalid values correctly");
-       ok(ret_size_t == 2,
+       ok(bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(enum_variant_type, 5) == 2,
                "bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value returns the correct index");
 
        ok(bt_ctf_field_type_variant_add_field(variant_type, uint_3_type,
@@ -977,7 +1019,7 @@ void append_complex_event(struct bt_ctf_stream_class *stream_class,
         */
        packet_context = bt_ctf_stream_get_packet_context(stream);
        packet_context_field = bt_ctf_field_structure_get_field(packet_context,
-               "custom_field");
+               "custom_packet_context_field");
        bt_ctf_field_unsigned_integer_set_value(packet_context_field, 1);
 
        ok(bt_ctf_stream_flush(stream) == 0,
@@ -1319,12 +1361,13 @@ void packet_resize_test(struct bt_ctf_stream_class *stream_class,
                bt_ctf_field_type_integer_create(17);
        struct bt_ctf_field_type *string_type =
                bt_ctf_field_type_string_create();
-       struct bt_ctf_event *event;
-       struct bt_ctf_field *ret_field;
-       struct bt_ctf_field_type *ret_field_type;
+       struct bt_ctf_event *event = NULL;
+       struct bt_ctf_field *ret_field = NULL;
+       struct bt_ctf_field_type *ret_field_type = NULL;
        uint64_t ret_uint64;
        int events_appended = 0;
-       struct bt_ctf_field *packet_context, *packet_context_field;
+       struct bt_ctf_field *packet_context = NULL,
+               *packet_context_field = NULL, *event_context = NULL;
 
        ret |= bt_ctf_event_class_add_field(event_class, integer_type,
                "field_1");
@@ -1350,6 +1393,22 @@ void packet_resize_test(struct bt_ctf_stream_class *stream_class,
                "bt_ctf_event_get_payload_by_index handles an invalid index correctly");
        bt_ctf_event_put(event);
 
+       ok(bt_ctf_stream_get_event_context(NULL) == NULL,
+               "bt_ctf_stream_get_event_context handles NULL correctly");
+       event_context = bt_ctf_stream_get_event_context(stream);
+       ok(event_context,
+               "bt_ctf_stream_get_event_context returns a stream event context");
+       ok(bt_ctf_stream_set_event_context(NULL, event_context) < 0,
+               "bt_ctf_stream_set_event_context handles a NULL stream correctly");
+       ok(bt_ctf_stream_set_event_context(stream, NULL) < 0,
+               "bt_ctf_stream_set_event_context handles a NULL stream event context correctly");
+       ok(!bt_ctf_stream_set_event_context(stream, event_context),
+               "bt_ctf_stream_set_event_context correctly set a stream event context");
+       ret_field = bt_ctf_field_create(integer_type);
+       ok(bt_ctf_stream_set_event_context(stream, ret_field) < 0,
+               "bt_ctf_stream_set_event_context rejects an event context of incorrect type");
+       bt_ctf_field_put(ret_field);
+
        for (i = 0; i < PACKET_RESIZE_TEST_LENGTH; i++) {
                event = bt_ctf_event_create(event_class);
                struct bt_ctf_field *integer =
@@ -1366,6 +1425,14 @@ void packet_resize_test(struct bt_ctf_stream_class *stream_class,
                ret |= bt_ctf_event_set_payload(event, "a_string",
                        string);
                bt_ctf_field_put(string);
+
+               /* Populate stream event context */
+               integer = bt_ctf_field_structure_get_field(event_context,
+                       "common_event_context");
+               ret |= bt_ctf_field_unsigned_integer_set_value(integer,
+                       i % 42);
+               bt_ctf_field_put(integer);
+
                ret |= bt_ctf_stream_append_event(stream, event);
                bt_ctf_event_put(event);
 
@@ -1374,7 +1441,7 @@ void packet_resize_test(struct bt_ctf_stream_class *stream_class,
                }
        }
 
-       events_appended = 1;
+       events_appended = !!(i == PACKET_RESIZE_TEST_LENGTH);
        ok(bt_ctf_stream_get_discarded_events_count(NULL, &ret_uint64) < 0,
                "bt_ctf_stream_get_discarded_events_count handles a NULL stream correctly");
        ok(bt_ctf_stream_get_discarded_events_count(stream, NULL) < 0,
@@ -1396,7 +1463,7 @@ end:
         */
        packet_context = bt_ctf_stream_get_packet_context(stream);
        packet_context_field = bt_ctf_field_structure_get_field(packet_context,
-               "custom_field");
+               "custom_packet_context_field");
        bt_ctf_field_unsigned_integer_set_value(packet_context_field, 2);
 
        ok(bt_ctf_stream_flush(stream) == 0,
@@ -1408,6 +1475,7 @@ end:
        bt_ctf_field_type_put(string_type);
        bt_ctf_field_put(packet_context);
        bt_ctf_field_put(packet_context_field);
+       bt_ctf_field_put(event_context);
        bt_ctf_event_class_put(event_class);
 }
 
@@ -1434,7 +1502,11 @@ int main(int argc, char **argv)
        const char *ret_string;
        const unsigned char *ret_uuid;
        unsigned char tmp_uuid[16] = { 0 };
-       struct bt_ctf_field_type *packet_context_type, *packet_context_field_type;
+       struct bt_ctf_field_type *packet_context_type,
+               *packet_context_field_type,
+               *integer_type,
+               *stream_event_context_type,
+               *ret_field_type;
        struct bt_ctf_trace *trace;
        int ret;
 
@@ -1691,10 +1763,42 @@ int main(int argc, char **argv)
                "bt_ctf_stream_class_set_packet_context_type handles a NULL stream class correctly");
        ok(bt_ctf_stream_class_set_packet_context_type(stream_class, NULL),
                "bt_ctf_stream_class_set_packet_context_type handles a NULL packet context type correctly");
+
+       integer_type = bt_ctf_field_type_integer_create(32);
+       ok(bt_ctf_stream_class_set_packet_context_type(stream_class,
+               integer_type) < 0,
+               "bt_ctf_stream_class_set_packet_context_type rejects a packet context that is not a structure");
        ret = bt_ctf_field_type_structure_add_field(packet_context_type,
-               packet_context_field_type, "custom_field");
+               packet_context_field_type, "custom_packet_context_field");
        ok(ret == 0, "Packet context field added successfully");
 
+       /* Define a stream event context containing a my_integer field. */
+       ok(bt_ctf_stream_class_get_event_context_type(NULL) == NULL,
+               "bt_ctf_stream_class_get_event_context_type handles NULL correctly");
+       ok(bt_ctf_stream_class_get_event_context_type(
+               stream_class) == NULL,
+               "bt_ctf_stream_class_get_event_context_type returns NULL when no stream event context type was set.");
+       stream_event_context_type = bt_ctf_field_type_structure_create();
+       bt_ctf_field_type_structure_add_field(stream_event_context_type,
+               integer_type, "common_event_context");
+
+       ok(bt_ctf_stream_class_set_event_context_type(NULL,
+               stream_event_context_type) < 0,
+               "bt_ctf_stream_class_set_event_context_type handles a NULL stream_class correctly");
+       ok(bt_ctf_stream_class_set_event_context_type(stream_class,
+               NULL) < 0,
+               "bt_ctf_stream_class_set_event_context_type handles a NULL event_context correctly");
+       ok(bt_ctf_stream_class_set_event_context_type(stream_class,
+               integer_type) < 0,
+               "bt_ctf_stream_class_set_event_context_type validates that the event context os a structure");
+
+       ok(bt_ctf_stream_class_set_event_context_type(
+               stream_class, stream_event_context_type) == 0,
+               "Set a new stream event context type");
+       ret_field_type = bt_ctf_stream_class_get_event_context_type(
+               stream_class);
+       ok(ret_field_type == stream_event_context_type,
+               "bt_ctf_stream_class_get_event_context_type returns the correct field type.");
 
        /* Instantiate a stream and append events */
        stream1 = bt_ctf_writer_create_stream(writer, stream_class);
@@ -1709,7 +1813,16 @@ int main(int argc, char **argv)
        ok(ret < 0,
                "Packet context type can't be modified once a stream class has been instanciated");
 
-       /* Should fail after instanciating a stream (locked)*/
+       /*
+        * Try to modify the stream event context type after a stream has been
+        * created.
+        */
+       ret = bt_ctf_field_type_structure_add_field(stream_event_context_type,
+               integer_type, "should_fail");
+       ok(ret < 0,
+               "Stream event context type can't be modified once a stream class has been instanciated");
+
+       /* Should fail after instanciating a stream (frozen) */
        ok(bt_ctf_stream_class_set_clock(stream_class, clock),
                "Changes to a stream class that was already instantiated fail");
 
@@ -1732,6 +1845,9 @@ int main(int argc, char **argv)
        bt_ctf_stream_put(stream1);
        bt_ctf_field_type_put(packet_context_type);
        bt_ctf_field_type_put(packet_context_field_type);
+       bt_ctf_field_type_put(integer_type);
+       bt_ctf_field_type_put(stream_event_context_type);
+       bt_ctf_field_type_put(ret_field_type);
        bt_ctf_trace_put(trace);
        free(metadata_string);
 
This page took 0.030205 seconds and 4 git commands to generate.