Merge pull request #82 from Tencent/release/v0.3.0

Release/v0.3.0
Tencent · Dec 1, 2023 · 7608e3a · 7608e3a
2 parents d8cf4ab + 44c8b36
commit 7608e3a
Show file tree

Hide file tree

Showing 60 changed files with 1,602 additions and 840 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,8 @@
+website/
+fuzz/
+include/
+target/
+!target/release/tquic_client
+!target/release/tquic_server
+.git/
+.github/
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -10,30 +10,112 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
-
+  build_linux:
+    name: Build for Linux
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: 'recursive'
-
-    - name: Code format check
-      run: cargo fmt --check
-
+    - name: Update rust
+      run: rustup update
     - name: Build TQUIC library
       run: cargo build -F ffi --verbose
-
     - name: Build TQUIC tools
       run: cargo build --all --verbose
 
+  build_ios:
+    name: Build for iOS
+    runs-on: macos-latest
+    env:
+      TARGET: "x86_64-apple-ios"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - name: Install rust toolchain
+        run: rustup target add ${{ env.TARGET }}
+      - name: Remove cdylib from iOS build
+        run: sed -i -e 's/, "cdylib"//g' Cargo.toml
+      - name: Run cargo build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --target=${{ env.TARGET }} --verbose
+
+  build_android:
+    name: Build for Android
+    runs-on: ubuntu-latest
+    env:
+      NDK_LTS_VER: "25"
+      API_LEVEL: "21"
+      TARGET: "aarch64-linux-android"
+      ARCH: "arm64-v8a"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - name: Install rust toolchain
+        run: rustup target add ${{ env.TARGET }}
+      - name: Download Android NDK
+        run: |
+          curl --http1.1 -O https://dl.google.com/android/repository/android-ndk-r${{ env.NDK_LTS_VER }}-linux.zip
+          unzip -q android-ndk-r${{ env.NDK_LTS_VER }}-linux.zip
+      - name: Install cargo-ndk
+        uses: actions-rs/install@v0.1
+        with:
+          crate: cargo-ndk
+      - name: Run cargo ndk
+        uses: actions-rs/cargo@v1
+        with:
+          command: ndk
+          args: -t ${{ env.ARCH }} -p ${{ env.API_LEVEL }} -- build --verbose --features ffi
+        env:
+          ANDROID_NDK_HOME: ${{ github.workspace }}/android-ndk-r${{ env.NDK_LTS_VER  }}
+
+  static_analysis:
+    name: Static analysis
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Update rust
+      run: rustup update
+    - name: Code format check
+      run: cargo fmt --check
     - name: Code lint check
-      run: cargo clippy
+      run: cargo clippy --all -- -D warnings
 
+  unit_testing:
+    name: Unit testing
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Update rust
+      run: rustup update
+    - name: Install cargo-llvm-cov
+      uses: taiki-e/install-action@cargo-llvm-cov  
     - name: Unit testing
       run: cargo test --verbose
+    - name: Generate code coverage
+      run: cargo llvm-cov --lcov --output-path lcov.info
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: lcov.info
+        fail_ci_if_error: true  
 
+  fuzz_testing:
+    name: Fuzz testing
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
     - name: Fuzz testing
       run: |
         rustup install nightly

diff --git a/.github/workflows/tquic-interop.yml b/.github/workflows/tquic-interop.yml
@@ -0,0 +1,50 @@
+name: Interop
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  tquic_interop_testing:
+    name: Interop testing
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        server: [tquic]
+        client: [tquic]
+        include:
+          - server: tquic
+            client: lsquic
+          - server: lsquic
+            client: tquic
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+
+    - name: Build docker image
+      run: docker build -t tquic_interop:v1 -f interop/Dockerfile .
+
+    - name: Install quic-interop-runner
+      run: |
+        git clone https://github.com/tquic-group/quic-interop-runner.git
+        cd quic-interop-runner
+        pip3 install -r requirements.txt
+
+    - name: Install dependences
+      run: |
+        sudo modprobe ip6table_filter
+        sudo add-apt-repository -y ppa:wireshark-dev/stable
+        sudo apt install -y tshark
+
+    - name: Run the interop tests 
+      run: |
+        cd quic-interop-runner   
+        python3 run.py -s ${{ matrix.server }} -c ${{ matrix.client }} -t handshake,retry,resumption,http3,ipv6,transfer,multiplexing,longrtt,blackhole,transferloss,transfercorruption,goodput,crosstraffic -d -r tquic=tquic_interop:v1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,31 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [v0.3.0] - 2023-12-01
+
+### Added
+- Simplify the usage of Endpoint
+- Add config API for stateless retry
+- Add config API for initial RTT
+- Add quic_conn_index() for getting connection index
+- tquic_client: create the output directory if it does not exist
+- tquic_client: convert unspecified address to localhost address
+- tquic_client: prompt help messages for wrong command args -
+- tquic_client: print statistics at the end of execution
+- Improve unit testing
+- Improve static analysis
+
+### Changed
+- endpoint: change Endpoint.close() to support forcily close the endpint
+- endpoint: quic_endpoint_new() no longer takes ownership of the resources provides by the C caller
+- tquic_client: change `-p` option to write the response header and body to stdout
+
+### Fixed
+- Ignore packets with unknown dcid
+- Fix bandwidth over-estimation issue
+- Improve interop testing and resolve new found issues
+
+
 ## [v0.2.0] - 2023-11-09
 
 ### Added
@@ -31,5 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Provide APIs for Rust, C, and C++.
 - Provide example clients and servers.
 
+
+[v0.3.0]: https://github.com/tencent/tquic/compare/v0.2.0...v0.3.0
 [v0.2.0]: https://github.com/tencent/tquic/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/tencent/tquic/releases/tag/v0.1.0
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,4 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -6,8 +7,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -22,17 +23,17 @@ community include:
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
@@ -60,7 +61,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-iyangsj@gmail.com.
+[iyangsj@gmail.com].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -82,15 +83,15 @@ behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
@@ -106,23 +107,27 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations