Cleanup README

Author: Nao-ris

.github/workflows/test.yml

@@ -24,5 +24,7 @@ jobs:
       - uses: actions/checkout@v3
       - name: Run tests
         run: cargo test --features=${{ matrix.version }} --verbose
+      - name: Run tests with Couchbase Lite C leak check
+        run: LEAK_CHECK=y cargo test --features=${{ matrix.version }} --verbose -- --test-threads 1
       - name: Run tests (with address sanitizer)
         run: LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test --features=${{ matrix.version }} --verbose

README.md

@@ -20,22 +20,25 @@ Installation instructions are [here][BINDGEN_INSTALL].
 
 ### 2. Build!
 
-You can use Couchbase Lite C community or entreprise editions:
+There two different editions of Couchbase Lite C: community & enterprise.
+You can find the differences [here][CBL_EDITIONS_DIFF].
+
+When building or declaring this repository as a dependency, you need to specify the edition through a cargo feature:
 
 ```shell
-$ cargo build --features=enterprise
+$ cargo build --features=community
 ```
 
 ```shell
-$ cargo build --features=community
+$ cargo build --features=enterprise
 ```
 
 ## Maintaining
 
 ### Couchbase Lite For C
 
 The Couchbase Lite For C shared library and headers ([Git repo][CBL_C]) are already embedded in this repo.
-They are present in the directory `libcblite`.
+They are present in two directories, one for each edition: `libcblite_community` & `libcblite_enterprise`.
 
 ### Upgrade Couchbase Lite C
 
@@ -54,24 +57,39 @@ $ brew install wget
 $ brew install bash
 ```
 
-After that, fix the compilation & tests and you can create a pull request.
+If the script was successful:
+- Change the link `CBL_API_REFERENCE` in this README
+- Change the version in the test `couchbase_lite_c_version_test`
+- Update the version in `Cargo.toml`
+- Fix the compilation in both editions
+- Fix the tests in both editions
+- Create pull request
 
 New C features should also be added to the Rust API at some point.
 
 ### Test
 
-**The unit tests must be run single-threaded.** This is because each test case checks for leaks by
-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.
+Tests can be found in the `tests` subdirectory.
+Test are run in the GitHub wrokflow `Test`. You can find the commands used there.
+
+There are three variations:
+
+### Nominal run
+
+```shell
+$ cargo test --features=enterprise
+```
+
+### Run with Couchbase Lite C leak check
 
 ```shell
-$ LEAK_CHECK=y cargo test -- --test-threads 1
+$ LEAK_CHECK=y cargo test --features=enterprise -- --test-threads 1
 ```
 
-### Sanitizer
+### Run with address sanitizer
 
 ```shell
-$ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test 
+$ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nightly test  --features=enterprise
 ```
 
 ## Learning
@@ -96,6 +114,8 @@ $ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nigh
 
 [CBL_API_REFERENCE]: https://docs.couchbase.com/mobile/3.2.1/couchbase-lite-c/C/html/modules.html
 
+[CBL_EDITIONS_DIFF]: https://www.couchbase.com/products/editions/
+
 [FLEECE]: https://github.com/couchbaselabs/fleece/wiki/Using-Fleece
 
 [BINDGEN]: https://rust-lang.github.io/rust-bindgen/

tests/utils.rs

@@ -43,7 +43,7 @@ where
 {
     init_logging();
 
-    let start_inst_count = instance_count() as isize;
+    let start_inst_count = instance_count();
     let tmp_dir = TempDir::new("cbl_rust").expect("create temp dir");
     let cfg = DatabaseConfiguration {
         directory: tmp_dir.path(),
@@ -58,11 +58,11 @@ where
     db.delete().unwrap();
 
     if LEAK_CHECK.is_some() {
-        warn!("Couchbase Lite objects were leaked by this test");
+        info!("Checking if Couchbase Lite objects were leaked by this test");
         dump_instances();
         assert_eq!(
-            instance_count() as usize,
-            start_inst_count as usize,
+            instance_count(),
+            start_inst_count,
             "Native object leak: {} objects, was {}",
             instance_count(),
             start_inst_count