blob: 398a8afed9c4e8fec7191e67e21d58f572cdd1df [file] [log] [blame]
Laurence Lundblade2ded3d92018-10-09 21:36:11 +08001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
3 Copyright (c) 2018, Laurence Lundblade.
4 All rights reserved.
5
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundbladed92a6162018-11-01 11:38:35 +070019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladed92a6162018-11-01 11:38:35 +070031 ==============================================================================*/
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080032
33#ifndef __QCBOR__qcbort_decode_tests__
34#define __QCBOR__qcbort_decode_tests__
35
36#include "qcbor.h"
37
38
39/*
40 Notes:
41
42 - All the functions in qcbor.h are called once in the aggregation of all the tests below.
43
44 - All the types that are supported are given as input and parsed by these tests
45
46 - There is some hostile input such as invalid lengths and CBOR too complex
47 and types this parser doesn't handle
48
49 */
50
51
52
53
54/*
55 Parse a well-known set of integers including those around the boundaries and
56 make sure the expected values come out
57 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080058int IntegerValuesParseTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080059
60
61
62
63
64/*
65 Decode a simple CBOR encoded array and make sure it returns all the correct values.
66 This is a decode test.
67 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080068int SimpleArrayTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080069
70
71/*
72 Make sure a maximally deep array can be parsed and that the
73 reported nesting level is correct. This uses test vector
74 of CBOR encoded data with a depth of 10. This a parse test.
75 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080076int ParseDeepArrayTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080077
78
79/*
80 See that the correct error is reported when parsing
81 an array of depth 11, one too large.
82 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080083int ParseTooDeepArrayTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080084
85
86/*
87 Try to parse some legit CBOR types that this parsers
88 doesn't support.
89 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080090int UnsupportedCBORDecodeTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080091
92
93/*
94 This takes the encoded CBOR integers used in the above test and parses
95 it over and over with one more byte less each time. It should fail
96 every time on incorrect CBOR input. This is a hostile input decode test.
97 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +080098int ShortBufferParseTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +080099
100
101/*
102 Same as ShortBufferParseTest, but with a different encoded CBOR input.
103 It is another hostile input test
104 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800105int ShortBufferParseTest2(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800106
107
108/*
109 Parses the somewhat complicated CBOR MAP and makes sure all the correct
110 values parse out. About 15 values are tested. This is a decode test.
111 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800112int ParseMapTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800113
114
115
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800116int FloatValuesTest1(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800117
118
119
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800120int SimpleValuesTest1(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800121
122
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +0900123/*
124
125 */
126int ParseMapAsArrayTest(void);
127
128
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800129
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800130int ParseSimpleTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800131
132
133
134/*
135 Tests a number of failure cases on bad CBOR to get the right error code
136 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800137int FailureTests(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800138
139
140/*
141 Generate all possible input strings up to length x and tries to parse them completely
142 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800143int ComprehensiveInputTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800144
145
146/*
147 Thest the date types -- epoch and strings
148 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800149int DateParseTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800150
151
152/*
153 Test optional tags like the CBOR magic number.
154 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800155int OptTagParseTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800156
157
158/*
159 Parse some big numbers, positive and negative
160 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800161int BignumParseTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800162
163
Laurence Lundbladeea567ac2018-12-09 14:03:21 -0800164int StringDecoderModeFailTest(void);
165
166
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800167/*
168 Parse some nested maps
169 */
Laurence Lundblade9e3651c2018-10-10 11:49:55 +0800170int NestedMapTest(void);
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800171
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530172
173/*
174 Parse maps with indefinite lengths
175 */
Laurence Lundblade742df4a2018-10-13 20:07:17 +0800176int NestedMapTestIndefLen(void);
177
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800178
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530179/*
180 Parse some maps and arrays with indefinite lengths.
181 Includes some error cases.
182 */
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530183int IndefiniteLengthArrayMapTest(void);
Laurence Lundblade4d1ecba2018-10-12 21:22:30 +0800184
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530185
186/*
187 Parse indefinite length strings. Uses
188 MemPool. Includes error cases.
189 */
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530190int IndefiniteLengthStringTest(void);
Laurence Lundblade4d1ecba2018-10-12 21:22:30 +0800191
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530192
193/*
194 Test deep nesting of indefinite length
195 maps and arrays including too deep.
196 */
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530197int IndefiniteLengthNestTest(void);
198
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530199
200/*
201 Test parsing strings were all strings, not
202 just indefinite length strings, are
203 allocated. Includes error test cases.
204 */
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530205int AllocAllStringsTest(void);
206
Laurence Lundblade0155b622018-10-12 20:04:37 +0800207
Laurence Lundbladefab1b522018-10-19 13:40:52 +0530208/*
209 Direct test of MemPool string allocator
210 */
211int MemPoolTest(void);
Laurence Lundblade0155b622018-10-12 20:04:37 +0800212
Laurence Lundblade2ded3d92018-10-09 21:36:11 +0800213
214#endif /* defined(__QCBOR__qcbort_decode_tests__) */