feat(): Catch up to the old repo (#2)

Author: Nao-ris

CODEOWNERS

@@ -0,0 +1 @@
+* @doctolib/bics

Cargo.toml

@@ -1,13 +1,20 @@
 [package]
 name = "couchbase_lite"
-version = "0.2.0"
+version = "0.2.1"
 
 [dependencies]
 enum_primitive = "*"
 tempdir = "*"
+lazy_static = "1.4.0"
+
+[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"]
 
 [build-dependencies]
-bindgen = "0.53.1"
+bindgen = "0.63"
+fs_extra = "1.2.0"
 
 [lib]
 bench = false
@@ -20,3 +27,7 @@ lto = true
 codegen-units = 1
 incremental = false
 # See: https://github.com/johnthagen/min-sized-rust
+
+[features]
+flaky-test = []
+unsafe-threads-test = []

Dockerfile

@@ -0,0 +1,28 @@
+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
+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/armv7-linux-androideabi/libcblite.so -o /build/libcblite/lib/armv7-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
+
+FROM scratch AS strip 
+COPY --from=strip-stage /build/libcblite/ .
+COPY --from=strip-stage /build/libcblite/ .

README.md

@@ -20,9 +20,34 @@ In addition to [Rust][RUST], you'll need to install LLVM and Clang, which are re
 [bindgen][BINDGEN] tool that generates Rust FFI APIs from C headers.
 Installation instructions are [here][BINDGEN_INSTALL].
 
-### 2. Get Couchbase Lite For C
+### 2. Couchbase Lite For C
+
+The Couchbase Lite For C shared library and headers ([Git repo][CBL_C]) are already embedded in this repo.
+To upgrade the version, start by replacing all the necessary files in the folder libcblite-3.0.3
+
+For Android there is an extra step: stripping the libraries.
+Place your terminal to the root of this repo, then follow the instructions below.
+
+Run Docker:
+    ``$ docker run --rm  --platform linux/amd64 -it -v $(PWD):/build archlinux``
+Install strip:
+    ``$ pacman -Sy base-devel``
+Strip:
+    ``$ cd /build/libcblite-3.0.3/lib/x86_64-linux-android
+    $ strip libcblite.so -o libcblite.stripped.so
+    $ cd /build/libcblite-3.0.3/lib/i686-linux-android
+    $ strip libcblite.so -o libcblite.stripped.so``
+
+Run docker:
+    ``$ docker run --rm  --platform linux/arm64 -it -v $(PWD):/build debian``
+Install strip:
+    ``$ apt update && apt install binutils -y``
+Strip:
+    ``$ cd /build/libcblite-3.0.3/lib/aarch64-linux-android
+    $ strip libcblite.so -o libcblite.stripped.so
+    $ cd /build/libcblite-3.0.3/lib/armv7-linux-androideabi
+    $ strip libcblite.so -o libcblite.stripped.so``
 
-Next you need the Couchbase Lite For C shared library and headers. You can download them from Couchbase, or build them yourself from the [Git repo][CBL_C].
 
 ### 3. Fix The Skanky Hardcoded Paths
 
@@ -39,10 +64,20 @@ This tells the crate where to find Couchbase Lite's headers and library, and the
 counting the number of extant Couchbase Lite objects before and after it runs, and failing if the
 number increases. That works only if a single test runs at a time.
 
-    $ cargo test -- --test-threads 1
+    $ LEAK_CHECK=y cargo test -- --test-threads 1
 
-The library itself has no thread-safety problems; if you want to run the tests multi-threaded, just
-edit `tests/simple_tests.rs` and change the value of `LEAK_CHECKS` to `false`.
+### 6. Sanitizer
+
+    $ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test 
+
+**To diag flaky test** 
+
+    $ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test --verbose --features=flaky-test flaky
+
+### 7. Strip libraries
+```
+DOCKER_BUILDKIT=1 docker build --file Dockerfile -t strip --output libcblite .
+```
 
 ## Learning