Merge "Add content type for long description for twine"

[ric-plt/lib/rmr.git] / test / mbuf_api_static_test.c

diff --git a/test/mbuf_api_static_test.c b/test/mbuf_api_static_test.c
index 4c0cd5e..936c43a 100644 (file)
--- a/test/mbuf_api_static_test.c
+++ b/test/mbuf_api_static_test.c
@@ -1,14 +1,14 @@
 // : vi ts=4 sw=4 noet :
 /*
 ==================================================================================
 // : vi ts=4 sw=4 noet :
 /*
 ==================================================================================

-        Copyright (c) 2019 Nokia 
-        Copyright (c) 2018-2019 AT&T Intellectual Property.
+           Copyright (c) 2019 Nokia
+           Copyright (c) 2018-2019 AT&T Intellectual Property.

 
    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
 
 
    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
+          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,
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,


@@ -21,7 +21,7 @@
 /*
        Mmemonic:       mbuf_api_static_test.c
        Abstract:       Test the message buffer  funcitons. These are meant to be included at compile
 /*
        Mmemonic:       mbuf_api_static_test.c
        Abstract:       Test the message buffer  funcitons. These are meant to be included at compile

-                               time by the test driver.  
+                               time by the test driver.

 
        Author:         E. Scott Daniels
        Date:           3 April 2019
 
        Author:         E. Scott Daniels
        Date:           3 April 2019


@@ -34,29 +34,47 @@
 #include <errno.h>
 #include <string.h>
 #include <stdint.h>
 #include <errno.h>
 #include <string.h>
 #include <stdint.h>

+#include <pthread.h>
+#include <semaphore.h>

 
 

-#include "../src/common/include/rmr.h"
-#include "../src/common/include/rmr_agnostic.h"
+#include "rmr.h"
+#include "rmr_agnostic.h"

 
 
 int mbuf_api_test( ) {
        unsigned char* c;
        int i;
 
 
 int mbuf_api_test( ) {
        unsigned char* c;
        int i;

+       int state;

        int errors = 0;
        int errors = 0;

+       char*   buf;
+       void*   ptr;

        rmr_mbuf_t*     mbuf;
        rmr_mbuf_t*     mbuf;

+       uta_mhdr_t*     hdr;

        unsigned char src_buf[256];
        unsigned char src_buf[256];

+       unsigned char dest_buf[256];

 
 

+
+       // --- dummy up a message buffer --------------------------------------------------------

        mbuf = (rmr_mbuf_t *) malloc( sizeof( *mbuf ) );
        if( mbuf == NULL ) {
                fprintf( stderr, "[FAIL] tester cannot allocate memory: mbuf\n" );
                exit( 1 );
        }
        mbuf = (rmr_mbuf_t *) malloc( sizeof( *mbuf ) );
        if( mbuf == NULL ) {
                fprintf( stderr, "[FAIL] tester cannot allocate memory: mbuf\n" );
                exit( 1 );
        }

+       memset( mbuf, 0, sizeof( *mbuf ) );
+
+       mbuf->tp_buf = (void *) malloc( sizeof( char ) * 1024 );                // add a dummy header/payload
+       memset( mbuf->tp_buf, 0, sizeof( char ) * 1024 );

 
 

-       mbuf->payload = (void *) malloc( sizeof( char ) * 1024 );               // add a dummy payload
-       mbuf->tp_buf = mbuf->payload;
-       mbuf->header = mbuf->payload;
+       mbuf->header = mbuf->tp_buf;

        mbuf->alloc_len = 1024;
        mbuf->alloc_len = 1024;

+       mbuf->payload = PAYLOAD_ADDR( mbuf->header );
+       hdr = (rmr_mbuf_t *) mbuf->header;
+       mbuf->xaction = hdr->xid;
+
+
+

 
 

+       // --- test payload field  access functions ---------------------------------------------------

        memset( src_buf, 0, sizeof( src_buf ) );
        rmr_bytes2payload( mbuf, NULL, strlen( src_buf) );                              // errno should be set on return
        errors += fail_if( errno == 0, "buf copy to payload with nil src returned good errno" );
        memset( src_buf, 0, sizeof( src_buf ) );
        rmr_bytes2payload( mbuf, NULL, strlen( src_buf) );                              // errno should be set on return
        errors += fail_if( errno == 0, "buf copy to payload with nil src returned good errno" );


@@ -71,11 +89,13 @@ int mbuf_api_test( ) {
        rmr_bytes2payload( mbuf, src_buf, 8192 );                                               // bust the limit
        errors += fail_if( mbuf->state == RMR_OK, "huge buf copy to payload returned good state in mbuf" );
        errors += fail_if( errno == 0, "huge buf copy to payload returned good state in errno" );
        rmr_bytes2payload( mbuf, src_buf, 8192 );                                               // bust the limit
        errors += fail_if( mbuf->state == RMR_OK, "huge buf copy to payload returned good state in mbuf" );
        errors += fail_if( errno == 0, "huge buf copy to payload returned good state in errno" );

-       
+

 
        snprintf( src_buf, sizeof( src_buf ), "This is some text in the buffer" );
        rmr_str2payload( mbuf, src_buf );                                                       // this uses bytes2payload, so only one invocation needed
 
 
        snprintf( src_buf, sizeof( src_buf ), "This is some text in the buffer" );
        rmr_str2payload( mbuf, src_buf );                                                       // this uses bytes2payload, so only one invocation needed
 

+
+       // --- test meid field  access functions ---------------------------------------------------

        errno = 0;
        i = rmr_bytes2meid( NULL, src_buf, RMR_MAX_MEID );
        errors += fail_if( errno == 0, "(errno) attempt to copy bytes to meid with nil message" );
        errno = 0;
        i = rmr_bytes2meid( NULL, src_buf, RMR_MAX_MEID );
        errors += fail_if( errno == 0, "(errno) attempt to copy bytes to meid with nil message" );


@@ -121,6 +141,34 @@ int mbuf_api_test( ) {
        errors += fail_if( i == RMR_OK, "(rv) attempt to copy string to meid with large source buffer" );
 
 
        errors += fail_if( i == RMR_OK, "(rv) attempt to copy string to meid with large source buffer" );
 
 

+       snprintf( src_buf, sizeof( src_buf ), "test-meid" );
+       rmr_str2meid( mbuf, src_buf );
+
+       errno = 0;
+       c = rmr_get_meid( NULL, NULL );
+       errors += fail_if( c != NULL, "get meid with nil message buffer" );
+       errors += fail_if( errno == 0, "(errno bad) get meid with nil msg buffer" );
+
+       c = rmr_get_meid( mbuf, NULL );                 // should allocate and return c
+       errors += fail_if( c == NULL, "get meid with nil dest pointer (did not allocate a buffer)" );
+       errors += fail_if( strcmp( c, "test-meid" ) != 0, "did not get expected meid from mbuffer" );
+       if( c ) {
+               free( c );
+               c = NULL;
+       }
+
+       c = rmr_get_meid( mbuf, c );
+       errors += fail_if( c == NULL, "get meid with a dest pointer returned no pointer" );
+       errors += fail_if( strcmp( c, "test-meid" ) != 0, "did not get expected meid from mbuffer" );
+       if( c ) {
+               free( c );
+               c = NULL;
+       }
+
+
+       // --- test transaction field  access functions ---------------------------------------------------
+       snprintf( src_buf, sizeof( src_buf ), "xaction-test##################." );              // full 32 bytes
+

        errno = 0;
        i = rmr_bytes2xact( NULL, src_buf, RMR_MAX_XID );
        errors += fail_if( errno == 0, "(errno) attempt to copy bytes to xact with nil message" );
        errno = 0;
        i = rmr_bytes2xact( NULL, src_buf, RMR_MAX_XID );
        errors += fail_if( errno == 0, "(errno) attempt to copy bytes to xact with nil message" );


@@ -141,7 +189,33 @@ int mbuf_api_test( ) {
        errors += fail_if( errno != 0, "copy bytes to xact; expected errno to be ok" );
        errors += fail_if( i != RMR_MAX_XID, "copy bytes to xact; expected return value to be max xact len" );
 
        errors += fail_if( errno != 0, "copy bytes to xact; expected errno to be ok" );
        errors += fail_if( i != RMR_MAX_XID, "copy bytes to xact; expected return value to be max xact len" );
 

-
+       errno = 0;
+       ptr = rmr_get_xact( NULL, NULL );
+       errors += fail_if( errno == 0, "get xaction with nil msg did not set errno" );
+       errors += fail_not_nil( ptr, "get xaction with nil msg did not return a nil pointer" );
+       
+       errno = 999;
+       ptr = rmr_get_xact( mbuf, NULL );
+       errors += fail_if( errno == 999, "get xaction with valid msg and nil dest didn't clear errno" );
+       errors += fail_not_equal( errno, 0, "get xaction with valid msg and nil dest set errno (a)" );
+       errors += fail_if_nil( ptr, "get xaction with valid msg  and nil dest did not return a valid pointer" );
+       if( ptr ) {
+               i = strcmp( ptr, src_buf );
+               errors += fail_not_equal( i, 0, "get xaction did not fetch expected string cmp return (a) was not 0" );
+               free( ptr );
+               ptr = NULL;
+       }
+       
+       errno = 999;
+       ptr = rmr_get_xact( mbuf, dest_buf );
+       errors += fail_if( errno == 999, "get xaction with valid msg and nil dest didn't clear errno" );
+       errors += fail_not_equal( errno, 0, "get xaction with valid msg and nil dest set errno (a)" );
+       errors += fail_if_nil( ptr, "get xaction with valid msg  and valid dest did not return a valid pointer" );
+       errors += fail_if( ptr != dest_buf, "get xaction did not return pointer to dest string" );
+       if( ptr == dest_buf ) {
+               i = strcmp( ptr, src_buf );
+               errors += fail_not_equal( i, 0, "get xaction into dest string did not fetch expected string cmp return (a) was not 0" );
+       }

 
        errno = 0;
        snprintf( src_buf, sizeof( src_buf ), "xact-fits" );
 
        errno = 0;
        snprintf( src_buf, sizeof( src_buf ), "xact-fits" );


@@ -165,24 +239,112 @@ int mbuf_api_test( ) {
        errors += fail_if( errno == 0, "(errno) attempt to copy string to xact with large source buffer" );
        errors += fail_if( i == RMR_OK, "(rv) attempt to copy string to xact with large source buffer" );
 
        errors += fail_if( errno == 0, "(errno) attempt to copy string to xact with large source buffer" );
        errors += fail_if( i == RMR_OK, "(rv) attempt to copy string to xact with large source buffer" );
 

-       
-       snprintf( src_buf, sizeof( src_buf ), "test-meid" );
-       rmr_str2meid( mbuf, src_buf );

 
 

-       errno = 0;
-       c = rmr_get_meid( NULL, NULL );
-       errors += fail_if( c != NULL, "get meid with nil message buffer" );
-       errors += fail_if( errno == 0, "(errno bad) get meid with nil msg buffer" ); 
+       rmr_free_msg( mbuf );

 
 

-       
-       c = rmr_get_meid( mbuf, NULL );                 // should allocate and return c
-       errors += fail_if( c == NULL, "get meid with nil dest pointer (did not allocate a buffer)" );
-       errors += fail_if( strcmp( c, "test-meid" ) != 0, "did not get expected meid from mbuffer" );
+       // ------------ trace data tests ----------------------------------------------------------------
+       // CAUTION: to support standalone mbuf api tests, the underlying buffer reallocation functions are NOT used
+       //                      if this is driven by the mbuf_api_test.c driver

 
 

-       c = rmr_get_meid( mbuf, c );
-       errors += fail_if( c == NULL, "get meid with a dest pointer returned no pointer" );
-       errors += fail_if( strcmp( c, "test-meid" ) != 0, "did not get expected meid from mbuffer" );
-       
+       mbuf = test_mk_msg( 2048, 0 );          // initially no trace size to force realloc
+
+       state = TRACE_OFFSET( mbuf->header ) - PAYLOAD_OFFSET( mbuf->header );          // no trace data, payload and trace offset should be the same
+       errors += fail_not_equal( state, 0, "trace offset and payload offset do NOT match when trace data is absent" );
+
+       state = rmr_get_trlen( mbuf );
+       errors += fail_not_equal( state, 0, "initial trace len reported (a) does not match expected (b)" );
+
+       state = rmr_set_trace( NULL, src_buf, 100 );                            // coverage test on nil check
+       errors += fail_not_equal( state, 0, "set trace with nil msg didn't return expected 0 status" );
+
+       state = rmr_set_trace( mbuf, src_buf, 0 );                              // coverage test on length check
+       errors += fail_not_equal( state, 0, "set trace with 0 len didn't return expected 0 status" );
+
+       state = rmr_get_trace( NULL, src_buf, 100 );                            // coverage test on nil check
+       errors += fail_not_equal( state, 0, "get trace with nil msg didn't return expected 0 status" );
+
+       state = rmr_get_trace( mbuf, NULL, 100 );                                       // coverage test on nil check
+       errors += fail_not_equal( state, 0, "get trace with nil dest didn't return expected 0 status" );
+
+       state = rmr_get_trlen( NULL );                                                          // coverage test on nil check
+       errors += fail_not_equal( state, 0, "get trace length with nil msg didn't return expected 0 status" );
+
+       ptr = rmr_trace_ref( NULL, NULL );
+       errors += fail_not_nil( ptr, "trace ref returned non-nil pointer when given nil message" );
+
+       mbuf = test_mk_msg( 2048, 0 );          // initially no trace size to force realloc
+       ptr = rmr_trace_ref( mbuf, NULL );
+       errors += fail_not_nil( ptr, "trace ref returned non-nil pointer when given a message without trace data" );
+
+       i = 100;                                                                // ensure that i is reset when there is no trace data
+       ptr = rmr_trace_ref( mbuf, &i );
+       errors += fail_not_nil( ptr, "trace ref returned non-nil pointer when given a message without trace data" );
+       errors += fail_not_equal( i, 0, "trace ref returned non zero size (a) when no trace info in message" );
+
+       i = 100;
+       mbuf = test_mk_msg( 2048, 113 );                // alloc with a trace data area
+       ptr = rmr_trace_ref( mbuf, &i );
+       errors += fail_if_nil( ptr, "trace ref returned nil pointer when given a message with trace data" );
+       errors += fail_not_equal( i, 113, "trace ref returned bad size (a), expected (b)" );
+
+
+       src_buf[0] = 0;
+       state = rmr_set_trace( mbuf, "foo bar was here", 17 );          // should force a realloc
+       errors += fail_not_equal( state, 17, "bytes copied to trace (a) did not match expected size (b)" );
+
+       state = rmr_get_trace( mbuf, src_buf, 17 );
+       errors += fail_not_equal( state, 17, "bytes retrieved from trace (a) did not match expected size (b)" );
+
+       state = rmr_get_trlen( mbuf );
+       errors += fail_not_equal( state, 17, "trace len reported (a) does not match expected (b)" );
+       state = strcmp( src_buf, "foo bar was here" );
+       errors+= fail_not_equal( state, 0, "compare of pulled trace info did not match" );
+
+       state = TRACE_OFFSET( mbuf->header ) - PAYLOAD_OFFSET( mbuf->header );          // when there is a trace area these should NOT be the same
+       errors += fail_if_equal( state, 0, "trace offset and payload offset match when trace data is present" );
+
+
+                                                                                       // second round of trace testing, allocating a message with a trace size that matches
+       mbuf = test_mk_msg( 2048, 17 );                 // trace size that matches what we'll stuff in, no realloc
+       state = rmr_get_trlen( mbuf );
+       errors += fail_not_equal( state, 17, "alloc with trace size: initial trace len reported (a) does not match expected (b)" );
+
+       src_buf[0] = 0;
+       state = rmr_set_trace( mbuf, "foo bar was here", 17 );          // should force a realloc
+       errors += fail_not_equal( state, 17, "bytes copied to trace (a) did not match expected size (b)" );
+
+       state = rmr_get_trace( mbuf, src_buf, 17 );
+       errors += fail_not_equal( state, 17, "bytes retrieved from trace (a) did not match expected size (b)" );
+       state = strcmp( src_buf, "foo bar was here" );
+       errors+= fail_not_equal( state, 0, "compare of pulled trace info did not match" );
+
+       i = rmr_get_trlen( mbuf );
+
+
+       // ------------- source field tests ------------------------------------------------------------
+       // we cannot force anything into the message source field, so no way to test the content, but we
+       // can test pointers and expected nils
+
+       buf = rmr_get_src( NULL, src_buf );                                     // coverage test for nil msg check
+       errors += fail_not_nil( buf, "rmr_get_src returned a pointer when given a nil message" );
+
+       buf = rmr_get_src( mbuf, NULL );                                        // coverage test for nil dst check
+       errors += fail_not_nil( buf, "rmr_get_src returned a pointer when given a nil dest buffer" );
+
+       buf = rmr_get_src( mbuf, src_buf );
+       errors += fail_not_equalp( buf, src_buf, "rmr_get_src didn't return expexted buffer pointer" );
+
+       buf = rmr_get_srcip( NULL, NULL );
+       errors += fail_not_nil( buf, "get_srcip did not return nil when given nil pointers" );
+
+       buf = rmr_get_srcip( mbuf, NULL );
+       errors += fail_not_nil( buf, "get_srcip did not return nil when given nil destination" );
+
+       buf = rmr_get_srcip( mbuf, src_buf );
+       errors += fail_not_equalp( buf, src_buf, "rmr_get_srcip didn't return expexted buffer pointer" );
+
+       test_set_ver( mbuf, 2 );                                                        // set older message version to ensure properly handled
+       buf = rmr_get_srcip( mbuf, src_buf );

 
        return errors > 0;                      // overall exit code bad if errors
 }
 
        return errors > 0;                      // overall exit code bad if errors
 }