Merge branch 'main' into fix/iterator-consistency-fallback

Author: yhmo

.github/mergify.yml

@@ -26,7 +26,8 @@ pull_request_rules:
   - name: Test passed for code changed
     conditions:
       - base=main
-      - "status-success=Unittest AMD64 Ubuntu 18.04"
+      - "status-success=Unittest AMD64 Ubuntu 22.04"
+      - "status-success=Compile tests macOS 15"
     actions:
       label:
         add:
@@ -51,10 +52,21 @@ pull_request_rules:
         add:
           - ci-passed
 
-  - name: Remove ci-passed when unittest failed
+  - name: Remove ci-passed when linux unittest failed
     conditions:
       - base=main
-      - "check-failure=Unittest AMD64 Ubuntu 18.04"
+      - "check-failure=Unittest AMD64 Ubuntu 22.04"
+      - files~=^(?!\.github\/mergify\.yml).*$
+      - files~=\.(?!md|png)
+    actions:
+      label:
+        remove:
+          - ci-passed
+
+  - name: Remove ci-passed when macOS test compile failed
+    conditions:
+      - base=main
+      - "check-failure=Compile tests macOS 15"
       - files~=^(?!\.github\/mergify\.yml).*$
       - files~=\.(?!md|png)
     actions:

.github/workflows/main.yml

@@ -21,40 +21,56 @@ on:
       - 'docker-compose.yml'
 
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    name: Unittest AMD64 Ubuntu ${{ matrix.ubuntu }}
+  ut-linux:
+    name: UT on Ubuntu-${{ matrix.ubuntu }}
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
     timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
-        ubuntu: [18.04]
+        ubuntu: [22.04]
     env:
       UBUNTU: ${{ matrix.ubuntu }}
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v3
         with:
           submodules: 'true'
-          
+
+      - uses: Swatinem/rust-cache@v2
+
       - name: Setup Milvus
-        run: sudo docker-compose up -d && sleep 15s
+        run: docker compose -f ./docker-compose.yml up -d && sleep 15s
 
-      - name: Setup protoc
-        uses: arduino/setup-protoc@v1.1.2
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-    
       # Runs a single command using the runners shell
       - name: Run Unittest
         run: RUST_BACKTRACE=1 cargo test
       # - name: Upload coverage to Codecov
       #   if: github.repository == 'milvus-io/milvus-sdk-rust'
       #   uses: codecov/codecov-action@v1
       #   with:
-      #     token: ${{ secrets.CODECOV_TOKEN }} 
+      #     token: ${{ secrets.CODECOV_TOKEN }}
       #     file: ./coverage.project.out
       #     name: ubuntu-${{ matrix.ubuntu }}-unittests
+
+  ut-macos:
+    name: Compile on macOS 15
+    runs-on: macos-15
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+
+      - uses: Swatinem/rust-cache@v2
+
+      # GitHub-hosted macOS runners do not provide Docker for the Milvus integration-test stack.
+      # Compile test binaries on macOS, but run Milvus-backed integration tests on Linux.
+      - name: Compile Tests
+        run: cargo test --no-run

.gitignore

@@ -17,3 +17,6 @@ Cargo.lock
 /target
 #Cargo.lock
 /.idea/
+
+# docker container data
+/volumes/

Cargo.toml

@@ -29,6 +29,7 @@ lazy_static = "1.4"
 tonic-build = { version = "0.11.0", default-features = false, features = [
     "prost",
 ] }
+protoc-bin-vendored = "=3.2.0"
 
 [dev-dependencies]
 rand = "0.8.5"

README.md

@@ -37,24 +37,81 @@ async fn main() -> Result<(), Error> {
 
 ## Development
 
-Pre-requisites:
-- cargo
-- protocol-compiler
-- docker (for testing)
+### Prerequisites
+
+- Rust toolchain with Cargo
+- initialized `milvus-proto` submodule
+- Docker or Docker Compose for integration tests
+
+The protobuf compiler is provided through Cargo during build, so a system-installed `protoc` is not required.
+
+Initialize submodules if needed:
+
+```
+git submodule update --init --recursive
+```
+
+### Build
+
+This repository uses Cargo directly; there is no Makefile.
+
+Build the SDK:
+
+```
+cargo build
+```
+
+Build an optimized release artifact:
+
+```
+cargo build --release
+```
+
+### Test
+
+Many tests require a Milvus server at `localhost:19530`. Start one with the provided Docker Compose file:
 
-### How to test
-Many tests require the Milvus server, the project provide a docker-compose file to setup a Milvus cluster:
 ```
 docker-compose -f ./docker-compose.yml up -d
 ```
-You may need to wait for seconds until the system ready
 
-Run all tests:
+On systems using Docker Compose v2, use:
+
+```
+docker compose -f ./docker-compose.yml up -d
+```
+
+Wait until Milvus is ready, then run all tests:
+
 ```
 cargo test
 ```
 
+Run a single test target:
+
+```
+cargo test --test client_flush_collections -- --nocapture
+```
+
 Enable the full backtrace for debugging:
+
 ```
 RUST_BACKTRACE=1 cargo test
 ```
+
+### Clean
+
+Remove build artifacts:
+
+```
+cargo clean
+```
+
+### Rebuild
+
+Force a clean rebuild, including regenerated protobuf bindings:
+
+```
+cargo clean
+cargo build
+```

build.rs

@@ -1,4 +1,9 @@
 fn main() -> Result<(), Box<dyn std::error::Error>> {
+    if std::env::var_os("PROTOC").is_none() {
+        let protoc = protoc_bin_vendored::protoc_bin_path()?;
+        std::env::set_var("PROTOC", protoc);
+    }
+
     tonic_build::configure()
         .build_server(false)
         .out_dir("src/proto")

docker-compose.yml

@@ -29,7 +29,7 @@ services:
 
   standalone:
     container_name: milvus-standalone
-    image: milvusdb/milvus:v2.5.15
+    image: milvusdb/milvus:v2.5.18
     command: [ "milvus", "run", "standalone" ]
     security_opt:
       - seccomp:unconfined