CDRIVER-4673 fix include of bson-dsl.h (#1388)

* move bson-dsl.h to src/common

bson-dsl.h is not installed, but shared between libmongoc and libbson.
Intended to resolve CDRIVER-4673.

* format bson-dsl.h

* add bson-dsl.h to dist tarball

* remove bson-dsl.h from old dist list

* add regression test

Author: kevinAlbs

.evergreen/generated_configs/legacy-config.yml

@@ -1094,6 +1094,16 @@ tasks:
       script: |-
         set -o errexit
         bash ./.evergreen/scripts/build-and-test-with-toolchain.sh
+- name: install-libmongoc-after-libbson
+  commands:
+  - command: shell.exec
+    type: test
+    params:
+      working_dir: mongoc
+      shell: bash
+      script: |-
+        set -o errexit
+        bash ./.evergreen/scripts/install-libmongoc-after-libbson.sh
 - name: test-coverage-latest-replica-set-auth-sasl-openssl
   tags:
   - latest
@@ -9287,6 +9297,7 @@ buildvariants:
   - name: build-and-test-with-toolchain
     distros:
     - debian10-small
+  - install-libmongoc-after-libbson
 - name: clang34ubuntu
   display_name: clang 3.4 (Ubuntu 14.04)
   expansions:

.evergreen/legacy_config_generator/evergreen_config_lib/tasks.py

@@ -416,6 +416,10 @@ def __init__(
             shell_mongoc("bash ./.evergreen/scripts/build-and-test-with-toolchain.sh"),
         ],
     ),
+    NamedTask(
+        "install-libmongoc-after-libbson",
+        commands=[shell_mongoc("bash ./.evergreen/scripts/install-libmongoc-after-libbson.sh"),],
+    ),
 ]
 
 

.evergreen/legacy_config_generator/evergreen_config_lib/variants.py

@@ -71,6 +71,7 @@ def days(n: int) -> int:
             OD([("name", "install-uninstall-check-msvc"), ("distros", ["windows-vsCurrent-large"])]),
             "debug-compile-with-warnings",
             OD([("name", "build-and-test-with-toolchain"), ("distros", ["debian10-small"])]),
+            "install-libmongoc-after-libbson",
         ],
         {},
     ),

.evergreen/scripts/install-libmongoc-after-libbson.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+# Install libbson only.
+EXTRA_CONFIGURE_FLAGS="-DENABLE_MONGOC=OFF" \
+  ./.evergreen/scripts/compile.sh
+
+# Install libmongoc using the system installed libbson.
+EXTRA_CONFIGURE_FLAGS="-DENABLE_MONGOC=ON -DUSE_SYSTEM_LIBBSON=ON" \
+  ./.evergreen/scripts/compile.sh

src/common/CMakeLists.txt

@@ -13,6 +13,7 @@ configure_file (
 )
 
 set (src_common_DIST_noinst_hs
+   bson-dsl.h
    common-b64-private.h
    common-md5-private.h
    common-prelude.h

src/libbson/src/bson/bson-dsl.h renamed to src/common/bson-dsl.h

@@ -1,3 +1,5 @@
+#include "common-prelude.h"
+
 #ifndef BSON_BSON_DSL_H_INCLUDED
 #define BSON_BSON_DSL_H_INCLUDED
 
@@ -22,10 +24,10 @@ enum {
 };
 
 #define _bson_thread_local \
-   BSON_IF_GNU_LIKE (__thread) BSON_IF_MSVC (__declspec(thread))
+   BSON_IF_GNU_LIKE (__thread) BSON_IF_MSVC (__declspec (thread))
 
-#define _bson_comdat                       \
-   BSON_IF_WINDOWS (__declspec(selectany)) \
+#define _bson_comdat                        \
+   BSON_IF_WINDOWS (__declspec (selectany)) \
    BSON_IF_POSIX (__attribute__ ((weak)))
 
 #ifdef __GNUC__
@@ -89,7 +91,7 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
 #define _bsonDSL_end   \
    --_bson_dsl_indent; \
    }                   \
-   else((void) 0)
+   else ((void) 0)
 
 /**
  * @brief Expands to a call to bson_append_{Kind}, with the three first
@@ -286,7 +288,7 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
    const bool _bvHalt = false; /* Required for _bsonVisitEach() */           \
    _bsonVisitEach (                                                          \
       OtherBSON,                                                             \
-      if (Pred, then (do(_bsonDocOperation_iterElement (bsonVisitIter)))));  \
+      if (Pred, then (do (_bsonDocOperation_iterElement (bsonVisitIter))))); \
    _bsonDSL_end
 
 #define _bsonDocOperation_insertFromIter(Iter, Pred)                   \
@@ -312,16 +314,16 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
 
 /// Insert the given BSON document into the parent array. Keys of the given
 /// document are discarded and it is treated as an array of values.
-#define _bsonArrayOperation_insert(OtherArr, Pred)                          \
-   _bsonDSL_begin ("Insert other array: [%s]", _bsonDSL_str (OtherArr));    \
-   _bsonVisitEach (                                                         \
-      OtherArr,                                                             \
-      if (Pred, then (do(_bsonArrayOperation_iterValue (bsonVisitIter))))); \
+#define _bsonArrayOperation_insert(OtherArr, Pred)                           \
+   _bsonDSL_begin ("Insert other array: [%s]", _bsonDSL_str (OtherArr));     \
+   _bsonVisitEach (                                                          \
+      OtherArr,                                                              \
+      if (Pred, then (do (_bsonArrayOperation_iterValue (bsonVisitIter))))); \
    _bsonDSL_end
 
 #define _bsonArrayAppendValue(ValueOperation)               \
    _bsonDSL_begin ("[%d] => [%s]",                          \
-                  (int) bsonBuildContext.index,                  \
+                   (int) bsonBuildContext.index,            \
                    _bsonDSL_strElide (30, ValueOperation)); \
    /* Set the doc key to the array index as a string: */    \
    _bsonBuild_setKeyToArrayIndex (bsonBuildContext.index);  \
@@ -396,9 +398,11 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
       _bsonValueOperationIf_##Else;                                     \
    }
 
-#define _bsonBuild_setKeyToArrayIndex(Idx)                                    \
-   _bbCtx.key_len = bson_snprintf (                                           \
-      _bbCtx.index_key_str, sizeof _bbCtx.index_key_str, "%d",(int) _bbCtx.index); \
+#define _bsonBuild_setKeyToArrayIndex(Idx)                      \
+   _bbCtx.key_len = bson_snprintf (_bbCtx.index_key_str,        \
+                                   sizeof _bbCtx.index_key_str, \
+                                   "%d",                        \
+                                   (int) _bbCtx.index);         \
    _bbCtx.key = _bbCtx.index_key_str
 
 /// Handle an element of array()
@@ -716,19 +720,19 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
    (NthInt < _bpNumVisitBitInts &&              \
     (_bpVisitBits[NthInt] & (UINT64_C (1) << NthBit)))
 
-#define _bsonParseOperation_find(Predicate, ...)                   \
-   _bsonDSL_begin ("find(%s)", _bsonDSL_str (Predicate));          \
-   _bpFoundElement = false;                                        \
-   _bsonVisitEach (                                                \
-      *_bpDoc,                                                     \
-      if (Predicate,                                               \
-          then (do(_bsonParseMarkVisited (bsonVisitContext.index); \
-                   _bpFoundElement = true),                        \
-                __VA_ARGS__,                                       \
-                break)));                                          \
-   if (!_bpFoundElement && !bsonParseError) {                      \
-      _bsonDSLDebug ("[not found]");                               \
-   }                                                               \
+#define _bsonParseOperation_find(Predicate, ...)                    \
+   _bsonDSL_begin ("find(%s)", _bsonDSL_str (Predicate));           \
+   _bpFoundElement = false;                                         \
+   _bsonVisitEach (                                                 \
+      *_bpDoc,                                                      \
+      if (Predicate,                                                \
+          then (do (_bsonParseMarkVisited (bsonVisitContext.index); \
+                    _bpFoundElement = true),                        \
+                __VA_ARGS__,                                        \
+                break)));                                           \
+   if (!_bpFoundElement && !bsonParseError) {                       \
+      _bsonDSLDebug ("[not found]");                                \
+   }                                                                \
    _bsonDSL_end
 
 #define _bsonParseOperation_require(Predicate, ...)                      \
@@ -737,8 +741,8 @@ BSON_IF_GNU_LIKE (_Pragma ("GCC diagnostic ignored \"-Wshadow\""))
    _bsonVisitEach (                                                      \
       *_bpDoc,                                                           \
       if (Predicate,                                                     \
-          then (do(_bsonParseMarkVisited (bsonVisitContext.index);       \
-                   _bpFoundElement = true),                              \
+          then (do (_bsonParseMarkVisited (bsonVisitContext.index);      \
+                    _bpFoundElement = true),                             \
                 __VA_ARGS__,                                             \
                 break)));                                                \
    if (!_bpFoundElement && !bsonParseError) {                            \
@@ -1140,7 +1144,7 @@ _bson_dsl_dupPath (char **into)
       char *prev = acc;
       if (ctx->parent && BSON_ITER_HOLDS_ARRAY (&ctx->parent->iter)) {
          // We're an array element
-         acc = bson_strdup_printf ("[%d]%s", (int)ctx->index, prev);
+         acc = bson_strdup_printf ("[%d]%s", (int) ctx->index, prev);
       } else {
          // We're a document element
          acc = bson_strdup_printf (".%s%s", bson_iter_key (&ctx->iter), prev);

src/libbson/src/bson/bson-dsl.md renamed to src/common/bson-dsl.md

@@ -1,6 +1,6 @@
 # Using `bson-dsl.h`
 
-The header `<bson/bson-dsl.h>` exposes an embedded domain-specific language
+The header `<bson-dsl.h>` exposes an embedded domain-specific language
 (DSL) built upon the C99 preprocessor. The DSL emits valid C99 and C++03 code
 that can be used to inspect and construct `bson_t` objects.
 

src/libbson/src/bson/CMakeLists.txt

@@ -6,7 +6,6 @@ set (src_libbson_src_bson_DIST_hs
    bson-compat.h
    bson-context.h
    bson-decimal128.h
-   bson-dsl.h
    bson-endian.h
    bson-error.h
    bson-iter.h

src/libbson/tests/test-bson.c

@@ -21,7 +21,7 @@
 #include <fcntl.h>
 #include <time.h>
 
-#include <bson/bson-dsl.h>
+#include <bson-dsl.h>
 
 #include "TestSuite.h"
 #include "test-conveniences.h"

src/libmongoc/src/mongoc/mongoc-aggregate.c

@@ -23,7 +23,7 @@
 #include "mongoc-trace-private.h"
 #include "mongoc-util-private.h"
 
-#include <bson/bson-dsl.h>
+#include <bson-dsl.h>
 
 /*--------------------------------------------------------------------------
  *