corpus-test.h

/*
 * Copyright 2017 MongoDB, Inc.
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef CORPUS_TEST_H
#define CORPUS_TEST_H

#include "TestSuite.h"

#include <bson.h>

/*
See:
github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.rst
#testing-validity
*/
typedef struct _test_bson_valid_type_t {
   const char *scenario_description;
   bson_type_t bson_type;
   const char *test_description;
   uint8_t *cB;         /* "canonical_bson" */
   uint32_t cB_len;
   uint8_t *dB;         /* "degenerate_bson" */
   uint32_t dB_len;
   const char *cE;      /* "canonical_extjson" */
   const char *rE;      /* "relaxed_extjson" */
   const char *dE;      /* "degenerate_extjson" */
   bool lossy;
} test_bson_valid_type_t;

/*
See:
github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.rst
#testing-decode-errors
 */
typedef struct _test_bson_decode_error_type_t {
   const char *scenario_description;
   bson_type_t bson_type;
   const char *test_description;
   uint8_t *bson;
   uint32_t bson_len;
} test_bson_decode_error_type_t;

/*
See:
github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.rst
#testing-parsing-errors
 */
typedef struct _test_bson_parse_error_type_t {
   const char *scenario_description;
   bson_type_t bson_type;
   const char *test_description;
   const char *str;
   uint32_t str_len;
} test_bson_parse_error_type_t;

typedef void (*test_bson_valid_cb) (test_bson_valid_type_t *test);
typedef void (*test_bson_decode_error_cb) (test_bson_decode_error_type_t *test);
typedef void (*test_bson_parse_error_cb) (test_bson_parse_error_type_t *test);

void
corpus_test_print_description (const char *description);
uint8_t *
corpus_test_unhexlify (bson_iter_t *iter, uint32_t *bson_str_len);
void
corpus_test (bson_t *scenario,
             test_bson_valid_cb valid,
             test_bson_decode_error_cb decode_error,
             test_bson_parse_error_cb parse_error);

#endif