Skip to content

Address edge cases and add tests #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2020
Merged

Address edge cases and add tests #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a07bbe
Address edge cases and add tests
dan4thewin Sep 15, 2020
b917ff5
Restore CUT_AFTER_KEY test
dan4thewin Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions source/core_json.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ typedef union
( ( ( x ) == ' ' ) || ( ( x ) == '\t' ) || \
( ( x ) == '\n' ) || ( ( x ) == '\r' ) )

#define isOpenBracket_( x ) ( ( ( x ) == '{' ) || ( ( x ) == '[' ) )
#define isCloseBracket_( x ) ( ( ( x ) == '}' ) || ( ( x ) == ']' ) )
/* NB. The numeric values of the open and close bracket pairs differ by 2. */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "NB" stand for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nota bene

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be esoteric for readers?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use e.g. and i.e. often enough. I'll keep it.

#define isMatchingBracket_( x, y ) \
( isOpenBracket_( x ) && isCloseBracket_( y ) && ( ( x ) == ( ( y ) - 2 ) ) )

/**
* @brief Advance buffer index beyond whitespace.
*
Expand Down Expand Up @@ -852,7 +858,7 @@ static bool_ skipSpaceAndComma( const char * buf,
i++;
skipSpace( buf, &i, max );

if( ( i < max ) && ( buf[ i ] != '}' ) && ( buf[ i ] != ']' ) )
if( ( i < max ) && !isCloseBracket_( buf[ i ] ) )
{
ret = true;
*start = i;
Expand Down Expand Up @@ -903,7 +909,8 @@ static void skipArrayScalars( const char * buf,
*
* In JSON, objects consist of comma-separated key-value pairs.
* A key is always a string (a scalar) while a value may be a
* scalar, an object, or an array.
* scalar, an object, or an array. A colon must appear between
* each key and value.
*
* @param[in] buf The buffer to parse.
* @param[in,out] start The index at which to begin.
Expand All @@ -916,6 +923,7 @@ static void skipObjectScalars( const char * buf,
size_t max )
{
size_t i;
bool_ comma;

assert( ( buf != NULL ) && ( start != NULL ) && ( max > 0U ) );

Expand All @@ -938,18 +946,25 @@ static void skipObjectScalars( const char * buf,
i++;
skipSpace( buf, &i, max );

if( ( i < max ) && isOpenBracket_( buf[ i ] ) )
{
*start = i;
break;
}

if( skipAnyScalar( buf, &i, max ) != true )
{
break;
}

if( skipSpaceAndComma( buf, &i, max ) != true )
comma = skipSpaceAndComma( buf, &i, max );
*start = i;

if( comma != true )
{
break;
}
}

*start = i;
}

/**
Expand All @@ -965,7 +980,7 @@ static void skipScalars( const char * buf,
size_t max,
char mode )
{
assert( ( mode == '[' ) || ( mode == '{' ) );
assert( isOpenBracket_( mode ) );

skipSpace( buf, start, max );

Expand Down Expand Up @@ -1028,15 +1043,21 @@ static JSONStatus_t skipCollection( const char * buf,
}

stack[ depth ] = c;
skipScalars( buf, &i, max, stack[ depth ] );
break;

case '}':
case ']':

if( depth > 0 )
if( ( depth > 0 ) && isMatchingBracket_( stack[ depth ], c ) )
{
depth--;
( void ) skipSpaceAndComma( buf, &i, max );

if( skipSpaceAndComma( buf, &i, max ) == true )
{
skipScalars( buf, &i, max, stack[ depth ] );
}

break;
}

Expand All @@ -1052,8 +1073,6 @@ static JSONStatus_t skipCollection( const char * buf,
{
break;
}

skipScalars( buf, &i, max, stack[ depth ] );
}

if( ret == JSONSuccess )
Expand Down
29 changes: 25 additions & 4 deletions test/unit-test/core_json_utest.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,15 @@
"\":{\"" SECOND_QUERY_KEY "\" : \"" COMPLETE_QUERY_KEY_ANSWER "\",}}"
#define TRAILING_COMMA_AFTER_VALUE_LENGTH ( sizeof( TRAILING_COMMA_AFTER_VALUE ) - 1 )

#define MISSING_COMMA_AFTER_VALUE "{\"foo\":{}\"bar\":\"abc\"}"
#define MISSING_COMMA_AFTER_VALUE_LENGTH ( sizeof( MISSING_COMMA_AFTER_VALUE ) - 1 )

#define MISSING_VALUE_AFTER_KEY "{\"foo\":{\"bar\":}}"
#define MISSING_VALUE_AFTER_KEY_LENGTH ( sizeof( MISSING_VALUE_AFTER_KEY ) - 1 )

#define MISMATCHED_BRACKETS "{\"foo\":{\"bar\":\"xyz\"]}"
#define MISMATCHED_BRACKETS_LENGTH ( sizeof( MISMATCHED_BRACKETS ) - 1 )

#define INCORRECT_OBJECT_SEPARATOR "{\"foo\": \"bar\"; \"bar\": \"foo\"}"
#define INCORRECT_OBJECT_SEPARATOR_LENGTH ( sizeof( INCORRECT_OBJECT_SEPARATOR ) - 1 )

Expand Down Expand Up @@ -542,10 +551,26 @@ void test_JSON_Validate_Illegal_Documents( void )
CUT_AFTER_COMMA_SEPARATOR_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( CUT_AFTER_KEY,
CUT_AFTER_KEY_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( TRAILING_COMMA_AFTER_VALUE,
TRAILING_COMMA_AFTER_VALUE_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( MISSING_COMMA_AFTER_VALUE,
MISSING_COMMA_AFTER_VALUE_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( MISSING_VALUE_AFTER_KEY,
MISSING_VALUE_AFTER_KEY_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( MISMATCHED_BRACKETS,
MISMATCHED_BRACKETS_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

jsonStatus = JSON_Validate( NUL_ESCAPE, NUL_ESCAPE_LENGTH );
TEST_ASSERT_EQUAL( JSONIllegalDocument, jsonStatus );

Expand Down Expand Up @@ -717,10 +742,6 @@ void test_JSON_Validate_Partial_Documents( void )
jsonStatus = JSON_Validate( CUT_AFTER_OBJECT_START_MARKER,
CUT_AFTER_OBJECT_START_MARKER_LENGTH );
TEST_ASSERT_EQUAL( JSONPartial, jsonStatus );

jsonStatus = JSON_Validate( CUT_AFTER_KEY,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the changes to the parser, a key without a value is considered illegal, not partial. The case is also covered by one of the new tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I put the test back with the other illegal tests.

CUT_AFTER_KEY_LENGTH );
TEST_ASSERT_EQUAL( JSONPartial, jsonStatus );
}

/**
Expand Down