Setup community edition (#22)

There are two editions of Couchbase Lite C: `enterprise` and
`community`.
In Doctolib we only use the `enterprise` version, but in order to
release this crate on [crates.io](https://crates.io/) it would be
beneficial to offer both options. This is the goal of this pull request.

The main changes of this pull request are:

1. Two new features in Cargo.toml: `enterprise` & `community`. Exactly
one must be selected or the compilation will fail in `build.rs`.
2. All the functionalities that are not available in the `community`
edition (encryption & peer-to-peer) are hidden behind the `enterpise`
feature.
3. Instead of the `libcblite` folder containing the enterprise lib
files, there are now two folders: `libcblite_enterprise` &
`libcblite_community`.
4. The file `build.rs` is modified in order to link with the right
folder depending on the specified edition.
5. The script `update_cblite_c.sh` is enhanced to run the whole process
for both editions.

Some smaller changes are also added:

1. A custom pre-commit hook is added to check that both editions build.
2. The GH workflow `rust` is split in two worflows: `build` & `test`.
3. The three workflows `build`, `test` & `clippy` now use matrixes to
check both editions.
4. The `c_playground` is modified with the new path of the `enterprise`
lib files.

Author: Nao-ris

.cargo-husky/hooks/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh -xe
+
+cargo clippy --features=community -- -D warnings
+cargo clippy --features=enterprise -- -D warnings
+
+# Check fmt (protip: run 'cargo fmt --all -- --emit files' to apply format locally)
+cargo fmt --all -- --check

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  push
+
+env:
+  CARGO_TERM_COLOR: always
+  LIBCLANG_PATH: /usr/lib/llvm-14/lib/
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        version: [community, enterprise]
+    steps:
+      - name: Install apt-get
+        run: sudo apt-get install -y clang llvm
+      - uses: actions/checkout@v3
+      - name: Build
+        run: cargo build --features=${{ matrix.version }} --verbose

.github/workflows/clippy.yml

@@ -1,17 +1,22 @@
-on: push
 name: Clippy check
 
+on: push
+
 env:
   CARGO_TERM_COLOR: always
   LIBCLANG_PATH: /usr/lib/llvm-14/lib/
 
 jobs:
   clippy_check:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [community, enterprise]
     steps:
       - uses: actions/checkout@v1
       - run: rustup component add clippy
       - uses: actions-rs/clippy-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          name: Clippy default
+          name: Clippy
+          args: --features=${{ matrix.version }}

.github/workflows/rust.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  push
+
+env:
+  CARGO_TERM_COLOR: always
+  LIBCLANG_PATH: /usr/lib/llvm-14/lib/
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        version: [community, enterprise]
+    steps:
+      - name: Install apt-get
+        run: sudo apt-get install -y clang llvm
+      - name: Install latest nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+            toolchain: nightly
+            components: rustfmt, clippy
+      - uses: actions/checkout@v3
+      - name: Run tests
+        run: cargo test --features=${{ matrix.version }} --verbose
+      - name: Run tests (with address sanitizer)
+        run: LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test --features=${{ matrix.version }} --verbose

.github/workflows/test.yml

@@ -1,7 +1,7 @@
 [package]
 name = "couchbase_lite"
-version = "3.2.1-0"
 # The first three numbers correspond to the Couchbase Lite C release, the fourth number corresponds to the Doctolib release
+version = "3.2.1-0"
 edition = "2021"
 
 [dependencies]
@@ -13,7 +13,7 @@ regex = "1.10.4"
 [dev-dependencies.cargo-husky]
 version = "1"
 default-features = false # Disable features which are enabled by default
-features = ["precommit-hook", "run-cargo-clippy", "run-cargo-fmt"]
+features = ["user-hooks"]
 
 [build-dependencies]
 bindgen = "0.69.4"
@@ -32,5 +32,7 @@ incremental = false
 # See: https://github.com/johnthagen/min-sized-rust
 
 [features]
-flaky-test = []
+community = []
+enterprise = []
+
 unsafe-threads-test = []

Cargo.toml

@@ -1,28 +1,15 @@
-FROM --platform=amd64 rust AS build
-RUN apt-get update
-RUN apt-get -y install clang
-RUN mkdir /build
-WORKDIR /build
-ENV LIBCLANG_PATH=/usr/lib/llvm-11/lib/
-ADD Cargo.toml Cargo.toml
-ADD build.rs build.rs
-ADD libcblite libcblite
-ADD src src
-RUN cargo c
-RUN cargo test -- --test-threads=1
-
 FROM --platform=amd64 rust AS strip-stage
+ARG DIRNAME
 RUN apt-get update
 RUN apt-get -y install binutils binutils-aarch64-linux-gnu
 RUN mkdir /build
 WORKDIR /build
-ADD libcblite libcblite
-RUN strip /build/libcblite/lib/x86_64-linux-android/libcblite.so -o /build/libcblite/lib/x86_64-linux-android/libcblite.stripped.so
-RUN strip /build/libcblite/lib/i686-linux-android/libcblite.so -o /build/libcblite/lib/i686-linux-android/libcblite.stripped.so
-RUN /usr/aarch64-linux-gnu/bin/strip /build/libcblite/lib/aarch64-linux-android/libcblite.so -o /build/libcblite/lib/aarch64-linux-android/libcblite.stripped.so
-RUN /usr/aarch64-linux-gnu/bin/strip /build/libcblite/lib/arm-linux-androideabi/libcblite.so -o /build/libcblite/lib/arm-linux-androideabi/libcblite.stripped.so
-RUN strip /build/libcblite/lib/x86_64-pc-windows-gnu/cblite.dll -o /build/libcblite/lib/x86_64-pc-windows-gnu/cblite.stripped.dll
+ADD ${DIRNAME} ${DIRNAME}
+RUN strip /build/${DIRNAME}/lib/x86_64-linux-android/libcblite.so -o /build/${DIRNAME}/lib/x86_64-linux-android/libcblite.stripped.so
+RUN strip /build/${DIRNAME}/lib/i686-linux-android/libcblite.so -o /build/${DIRNAME}/lib/i686-linux-android/libcblite.stripped.so
+RUN /usr/aarch64-linux-gnu/bin/strip /build/${DIRNAME}/lib/aarch64-linux-android/libcblite.so -o /build/${DIRNAME}/lib/aarch64-linux-android/libcblite.stripped.so
+RUN /usr/aarch64-linux-gnu/bin/strip /build/${DIRNAME}/lib/arm-linux-androideabi/libcblite.so -o /build/${DIRNAME}/lib/arm-linux-androideabi/libcblite.stripped.so
+RUN strip /build/${DIRNAME}/lib/x86_64-pc-windows-gnu/cblite.dll -o /build/${DIRNAME}/lib/x86_64-pc-windows-gnu/cblite.stripped.dll
 
-FROM scratch AS strip 
-COPY --from=strip-stage /build/libcblite/ .
-COPY --from=strip-stage /build/libcblite/ .
+FROM scratch AS strip
+COPY --from=strip-stage /build/${DIRNAME}/ .

Dockerfile

@@ -20,8 +20,14 @@ Installation instructions are [here][BINDGEN_INSTALL].
 
 ### 2. Build!
 
+You can use Couchbase Lite C community or entreprise editions:
+
+```shell
+$ cargo build --features=enterprise
+```
+
 ```shell
-$ cargo build
+$ cargo build --features=community
 ```
 
 ## Maintaining
@@ -68,12 +74,6 @@ $ LEAK_CHECK=y cargo test -- --test-threads 1
 $ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test 
 ```
 
-**To diag flaky test**
-
-```shell
-$ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test --verbose --features=flaky-test flaky
-```
-
 ## Learning
 
 [Official Couchbase Lite documentation][CBL_DOCS]

README.md

@@ -22,6 +22,11 @@
 // - https://rust-lang.github.io/rust-bindgen/tutorial-3.html
 // - https://doc.rust-lang.org/cargo/reference/build-scripts.html
 
+#[cfg(all(not(feature = "community"), not(feature = "enterprise")))]
+compile_error!("You need to have one the following features activated: community, enterprise");
+#[cfg(all(feature = "community", feature = "enterprise"))]
+compile_error!("You need to have one the following features activated: community, enterprise");
+
 extern crate bindgen;
 extern crate fs_extra;
 
@@ -32,8 +37,15 @@ use std::path::PathBuf;
 use std::process::Command;
 use fs_extra::dir;
 
-static CBL_INCLUDE_DIR: &str = "libcblite/include";
-static CBL_LIB_DIR: &str = "libcblite/lib";
+#[cfg(feature = "community")]
+static CBL_INCLUDE_DIR: &str = "libcblite_community/include";
+#[cfg(feature = "enterprise")]
+static CBL_INCLUDE_DIR: &str = "libcblite_enterprise/include";
+
+#[cfg(feature = "community")]
+static CBL_LIB_DIR: &str = "libcblite_community/lib";
+#[cfg(feature = "enterprise")]
+static CBL_LIB_DIR: &str = "libcblite_enterprise/lib";
 
 fn main() -> Result<(), Box<dyn Error>> {
     generate_bindings()?;

build.rs

@@ -2,8 +2,8 @@ cmake_minimum_required(VERSION 3.15)
 
 project(c_playground)
 
-include_directories(${CMAKE_SOURCE_DIR}/../libcblite/include)
+include_directories(${CMAKE_SOURCE_DIR}/../libcblite_enterprise/include)
 
 add_executable(Main main.c)
 
-target_link_libraries(Main PUBLIC ${CMAKE_SOURCE_DIR}/../libcblite/lib/macos/libcblite.3.dylib)
+target_link_libraries(Main PUBLIC ${CMAKE_SOURCE_DIR}/../libcblite_enterprise/lib/macos/libcblite.3.dylib)