diff options
Diffstat (limited to 'tests/test_packet.c')
| -rw-r--r-- | tests/test_packet.c | 409 |
1 files changed, 409 insertions, 0 deletions
diff --git a/tests/test_packet.c b/tests/test_packet.c new file mode 100644 index 00000000..6f486b24 --- /dev/null +++ b/tests/test_packet.c @@ -0,0 +1,409 @@ +/* + * This file is Copyright (c) 2010 by the GPSD project + * SPDX-License-Identifier: BSD-2-clause + */ +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <stdarg.h> +#include <ctype.h> +#include <sys/types.h> +#include <fcntl.h> +#include <unistd.h> + +#include "../gpsd.h" + +static int verbose = 0; + +struct map +{ + char *legend; + char test[MAX_PACKET_LENGTH + 1]; + size_t testlen; + int garbage_offset; + int type; +}; + +/* *INDENT-OFF* */ +static struct map singletests[] = { + /* NMEA tests */ + { + .legend = "NMEA packet with checksum (1)", + .test = "$GPVTG,308.74,T,,M,0.00,N,0.0,K*68\r\n", + .testlen = 36, + .garbage_offset = 0, + NMEA_PACKET, + }, + { + .legend = "NMEA packet with checksum (2)", + .test = "$GPGGA,110534.994,4002.1425,N,07531.2585,W,0,00,50.0,172.7,M,-33.8,M,0.0,0000*7A\r\n", + .testlen = 82, + .garbage_offset = 0, + .type = NMEA_PACKET, + }, + { + .legend = "NMEA packet with checksum and 4 chars of leading garbage", + .test = "\xff\xbf\x00\xbf$GPVTG,308.74,T,,M,0.00,N,0.0,K*68\r\n", + .testlen = 40, + .garbage_offset = 4, + .type = NMEA_PACKET, + }, + { + .legend = "NMEA packet without checksum", + .test = "$PSRF105,1\r\n", + .testlen = 12, + .garbage_offset = 0, + .type = NMEA_PACKET, + }, + { + .legend = "NMEA packet with wrong checksum", + .test = "$GPVTG,308.74,T,,M,0.00,N,0.0,K*28\r\n", + .testlen = 36, + .garbage_offset = 0, + .type = BAD_PACKET, + }, + { + .legend = "NMEA interspersed packet", + .test = "$GPZDA,112533.00,20,01,20$PTNTA,20000102173852,1,T4,,,6,1,0*32\r\n", + .testlen = 64, + .garbage_offset = 25, + .type = NMEA_PACKET, + }, + { + .legend = "NMEA interrupted packet", + .test = "$GPZDA,112533.00,20,01,2016,00,00*67\r\n$GPZDA,112533.00,20,01,20$PTNTA,20000102173852,1,T4,,,6,1,0*32\r\n16,00,00*67\r\n", + .testlen = 115, + .garbage_offset = 0, + .type = NMEA_PACKET, + }, + /* SiRF tests */ + { + .legend = "SiRF WAAS version ID", + .test = { + 0xA0, 0xA2, 0x00, 0x15, + 0x06, 0x06, 0x31, 0x2E, 0x32, 0x2E, 0x30, 0x44, + 0x4B, 0x49, 0x54, 0x31, 0x31, 0x39, 0x20, 0x53, + 0x4D, 0x00, 0x00, 0x00, 0x00, + 0x03, 0x82, 0xB0, 0xB3}, + .testlen = 29, + .garbage_offset = 0, + .type = SIRF_PACKET, + }, + { + .legend = "SiRF WAAS version ID with 3 chars of leading garbage", + .test = { + 0xff, 0x00, 0xff, + 0xA0, 0xA2, 0x00, 0x15, + 0x06, 0x06, 0x31, 0x2E, 0x32, 0x2E, 0x30, 0x44, + 0x4B, 0x49, 0x54, 0x31, 0x31, 0x39, 0x20, 0x53, + 0x4D, 0x00, 0x00, 0x00, 0x00, + 0x03, 0x82, 0xB0, 0xB3}, + .testlen = 32, + .garbage_offset = 3, + .type = SIRF_PACKET, + }, + { + .legend = "SiRF WAAS version ID with wrong checksum", + .test = { + 0xA0, 0xA2, 0x00, 0x15, + 0x06, 0x06, 0x31, 0x2E, 0x32, 0x2E, 0x30, 0x44, + 0x4B, 0x49, 0x54, 0x31, 0x31, 0x39, 0x20, 0x53, + 0x4D, 0x00, 0x00, 0x00, 0x00, + 0x03, 0x00, 0xB0, 0xB3}, + .testlen = 29, + .garbage_offset = 0, + .type = BAD_PACKET, + }, + { + .legend = "SiRF WAAS version ID with bad length", + .test = { + 0xA0, 0xA2, 0xff, 0x15, + 0x06, 0x06, 0x31, 0x2E, 0x32, 0x2E, 0x30, 0x44, + 0x4B, 0x49, 0x54, 0x31, 0x31, 0x39, 0x20, 0x53, + 0x4D, 0x00, 0x00, 0x00, 0x00, + 0x03, 0x82, 0xB0, 0xB3}, + .testlen = 29, + .garbage_offset = 0, + .type = BAD_PACKET, + }, + /* Zodiac tests */ + { + .legend = "Zodiac binary 1000 Geodetic Status Output Message", + .test = { + 0xff, 0x81, 0xe8, 0x03, 0x31, 0x00, 0x00, 0x00, 0xe8, 0x79, + 0x74, 0x0e, 0x00, 0x00, 0x24, 0x00, 0x24, 0x00, 0x04, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x90, 0x03, 0x23, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x1d, 0x00, 0x06, 0x00, + 0xcd, 0x07, 0x00, 0x00, 0x00, 0x00, 0x16, 0x00, 0x7b, 0x0d, + 0x00, 0x00, 0x12, 0x6b, 0xa7, 0x04, 0x41, 0x75, 0x32, 0xf8, + 0x03, 0x1f, 0x00, 0x00, 0xe6, 0xf2, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x11, 0xf6, 0x00, 0x00, 0x00, 0x00, 0xc0, 0x40, + 0xd9, 0x12, 0x90, 0xd0, 0x03, 0x00, 0x00, 0xa3, 0xe1, 0x11, + 0x10, 0x27, 0x00, 0x00, 0x00, 0x00, 0x00, 0xa3, 0xe1, 0x11, + 0x00, 0x00, 0x00, 0x00, 0xe0, 0x93, 0x04, 0x00, 0x04, 0xaa}, + .testlen = 110, + .garbage_offset = 0, + .type = ZODIAC_PACKET, + }, + /* EverMore tests */ + { + .legend = "EverMore status packet 0x20", + .test = { + 0x10, 0x02, 0x0D, 0x20, 0xE1, 0x00, 0x00, 0x00, + 0x0A, 0x00, 0x1E, 0x00, 0x32, 0x00, 0x5b, 0x10, + 0x03}, + .testlen = 17, + .garbage_offset = 0, + .type = EVERMORE_PACKET, + }, + { + .legend = "EverMore packet 0x04 with 0x10 0x10 sequence", + .test = { + 0x10, 0x02, 0x0f, 0x04, 0x00, 0x00, 0x10, 0x10, + 0xa7, 0x13, 0x03, 0x2c, 0x26, 0x24, 0x0a, 0x17, + 0x00, 0x68, 0x10, 0x03}, + .testlen = 20, + .garbage_offset = 0, + .type = EVERMORE_PACKET, + }, + { + .legend = "EverMore packet 0x04 with 0x10 0x10 sequence, some noise before packet data", + .test = { + 0x10, 0x03, 0xff, 0x10, 0x02, 0x0f, 0x04, 0x00, + 0x00, 0x10, 0x10, 0xa7, 0x13, 0x03, 0x2c, 0x26, + 0x24, 0x0a, 0x17, 0x00, 0x68, 0x10, 0x03}, + .testlen = 23, + .garbage_offset = 3, + .type = EVERMORE_PACKET, + }, + { + .legend = "EverMore packet 0x04, 0x10 and some other data at the beginning", + .test = { + 0x10, 0x12, 0x10, 0x03, 0xff, 0x10, 0x02, 0x0f, + 0x04, 0x00, 0x00, 0x10, 0x10, 0xa7, 0x13, 0x03, + 0x2c, 0x26, 0x24, 0x0a, 0x17, 0x00, 0x68, 0x10, + 0x03}, + .testlen = 25, + .garbage_offset = 5, + .type = EVERMORE_PACKET, + }, + { + .legend = "EverMore packet 0x04, 0x10 three times at the beginning", + .test = { + 0x10, 0x10, 0x10, + 0x10, 0x02, 0x0f, 0x04, 0x00, 0x00, 0x10, 0x10, + 0xa7, 0x13, 0x03, 0x2c, 0x26, 0x24, 0x0a, 0x17, + 0x00, 0x68, 0x10, 0x03}, + .testlen = 23, + .garbage_offset = 3, + .type = EVERMORE_PACKET, + }, + { + /* from page 4-3 of RTCM 10403.1 */ + .legend = "RTCM104V3 type 1005 packet", + /* + * Reference Station Id = 2003 + * GPS Service supported, but not GLONASS or Galileo + * ARP ECEF-X = 1114104.5999 meters + * ARP ECEF-Y = -4850729.7108 meters + * ARP ECEF-Z = 3975521.4643 meters + */ + .test = { + 0xD3, 0x00, 0x13, 0x3E, 0xD7, 0xD3, 0x02, 0x02, + 0x98, 0x0E, 0xDE, 0xEF, 0x34, 0xB4, 0xBD, 0x62, + 0xAC, 0x09, 0x41, 0x98, 0x6F, 0x33, 0x36, 0x0B, + 0x98, + }, + .testlen = 25, + .garbage_offset = 0, + .type = RTCM3_PACKET, + }, + { + .legend = "RTCM104V3 type 1005 packet with 4th byte garbled", + .test = { + 0xD3, 0x00, 0x13, 0x3F, 0xD7, 0xD3, 0x02, 0x02, + 0x98, 0x0E, 0xDE, 0xEF, 0x34, 0xB4, 0xBD, 0x62, + 0xAC, 0x09, 0x41, 0x98, 0x6F, 0x33, 0x36, 0x0B, + 0x98, + }, + .testlen = 25, + .garbage_offset = 0, + .type = BAD_PACKET, + }, + { + /* from page 3-71 of the RTCM 10403.1 */ + .legend = "RTCM104V3 type 1029 packet", + .test = { + 0xD3, 0x00, 0x27, 0x40, 0x50, 0x17, 0x00, 0x84, + 0x73, 0x6E, 0x15, 0x1E, 0x55, 0x54, 0x46, 0x2D, + 0x38, 0x20, 0xD0, 0xBF, 0xD1, 0x80, 0xD0, 0xBE, + 0xD0, 0xB2, 0xD0, 0xB5, 0xD1, 0x80, 0xD0, 0xBA, + 0xD0, 0xB0, 0x20, 0x77, 0xC3, 0xB6, 0x72, 0x74, + 0x65, 0x72, 0xED, 0xA3, 0x3B + }, + .testlen = 45, + .garbage_offset = 0, + .type = RTCM3_PACKET, + }, +}; +/* *INDENT-ON* */ + +/* *INDENT-OFF* */ +static struct map runontests[] = { + /* NMEA tests */ + { + .legend = "Double NMEA packet with checksum", + .test = "$GPVTG,308.74,T,,M,0.00,N,0.0,K*68\r\n$GPGGA,110534.994,4002.1425,N,07531.2585,W,0,00,50.0,172.7,M,-33.8,M,0.0,0000*7A\r\n", + .testlen = 118, + 0, + NMEA_PACKET, + }, +}; +/* *INDENT-ON* */ + +static int packet_test(struct map *mp) +{ + struct gps_lexer_t lexer; + int failure = 0; + + lexer_init(&lexer); + lexer.errout.debug = verbose; + memcpy(lexer.inbufptr = lexer.inbuffer, mp->test, mp->testlen); + lexer.inbuflen = mp->testlen; + packet_parse(&lexer); + if (lexer.type != mp->type) + printf("%2ti: %s test FAILED (packet type %d wrong).\n", + mp - singletests + 1, mp->legend, lexer.type); + else if (memcmp + (mp->test + mp->garbage_offset, lexer.outbuffer, + lexer.outbuflen)) { + printf("%2ti: %s test FAILED (data garbled).\n", mp - singletests + 1, + mp->legend); + ++failure; + } else + printf("%2ti: %s test succeeded.\n", mp - singletests + 1, + mp->legend); + + return failure; +} + +static void runon_test(struct map *mp) +{ + struct gps_lexer_t lexer; + int nullfd = open("/dev/null", O_RDONLY); + ssize_t st; + + lexer_init(&lexer); + lexer.errout.debug = verbose; + memcpy(lexer.inbufptr = lexer.inbuffer, mp->test, mp->testlen); + lexer.inbuflen = mp->testlen; + (void)fputs(mp->test, stdout); + do { + st = packet_get(nullfd, &lexer); + //printf("packet_parse() returned %zd\n", st); + } while (st > 0); +} + +static int property_check(void) +{ + const struct gps_type_t **dp; + int status; + + for (dp = gpsd_drivers; *dp; dp++) { + if (*dp == NULL || (*dp)->packet_type == COMMENT_PACKET) + continue; + +#ifdef RECONFIGURE_ENABLE + if (CONTROLLABLE(*dp)) + (void)fputs("control\t", stdout); + else + (void)fputs(".\t", stdout); + if ((*dp)->event_hook != NULL) + (void)fputs("hook\t", stdout); + else + (void)fputs(".\t", stdout); +#endif /* RECONFIGURE_ENABLE */ + if ((*dp)->trigger != NULL) + (void)fputs("trigger\t", stdout); + else if ((*dp)->probe_detect != NULL) + (void)fputs("probe\t", stdout); + else + (void)fputs(".\t", stdout); +#ifdef CONTROLSEND_ENABLE + if ((*dp)->control_send != NULL) + (void)fputs("send\t", stdout); + else + (void)fputs(".\t", stdout); +#endif /* CONTROLSEND_ENABLE */ + if ((*dp)->packet_type > NMEA_PACKET) + (void)fputs("binary\t", stdout); + else + (void)fputs("NMEA\t", stdout); +#ifdef CONTROLSEND_ENABLE + if (STICKY(*dp)) + (void)fputs("sticky\t", stdout); + else + (void)fputs(".\t", stdout); +#endif /* CONTROLSEND_ENABLE */ + (void)puts((*dp)->type_name); + } + + status = EXIT_SUCCESS; + for (dp = gpsd_drivers; *dp; dp++) { + if (*dp == NULL || (*dp)->packet_type == COMMENT_PACKET) + continue; +#if defined(CONTROLSEND_ENABLE) && defined(RECONFIGURE_ENABLE) + if (CONTROLLABLE(*dp) && (*dp)->control_send == NULL) { + (void)fprintf(stderr, "%s has control methods but no send\n", + (*dp)->type_name); + status = EXIT_FAILURE; + } + if ((*dp)->event_hook != NULL && (*dp)->control_send == NULL) { + (void)fprintf(stderr, "%s has event hook but no send\n", + (*dp)->type_name); + status = EXIT_FAILURE; + } +#endif /* CONTROLSEND_ENABLE && RECONFIGURE_ENABLE*/ + } + + return status; +} + +int main(int argc, char *argv[]) +{ + struct map *mp; + int failcount = 0; + int option, singletest = 0; + + verbose = 0; + while ((option = getopt(argc, argv, "ce:t:v:")) != -1) { + switch (option) { + case 'c': + exit(property_check()); + case 'e': + mp = singletests + atoi(optarg) - 1; + (void)fwrite(mp->test, mp->testlen, sizeof(char), stdout); + (void)fflush(stdout); + exit(EXIT_SUCCESS); + case 't': + singletest = atoi(optarg); + break; + case 'v': + verbose = atoi(optarg); + break; + } + } + + if (singletest) + failcount += packet_test(singletests + singletest - 1); + else { + (void)fputs("=== Packet identification tests ===\n", stdout); + for (mp = singletests; + mp < singletests + sizeof(singletests) / sizeof(singletests[0]); + mp++) + failcount += packet_test(mp); + (void)fputs("=== EOF with buffer nonempty test ===\n", stdout); + runon_test(&runontests[0]); + } + exit(failcount > 0 ? EXIT_FAILURE : EXIT_SUCCESS); +} |