ci: address sanitizer for Linux (#814)

* ci: asan on Linux

* test(net): cfg out manually leaks

* fix(ci): apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* ci(asan): run tests & lib tests only

* ci(asan): test more features

* test(ws): close after ping

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: Berrysoft

.github/workflows/ci_test_asan.yml

@@ -0,0 +1,70 @@
+name: TestASan
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '**/*.rs'
+      - '**/Cargo.toml'
+      - '.github/workflows/ci_test_asan.yml'
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '**/*.rs'
+      - '**/Cargo.toml'
+      - '.github/workflows/ci_test_asan.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
+  cancel-in-progress: true
+
+env:
+  RUST_BACKTRACE: 1
+
+jobs:
+  asan:
+    runs-on: ${{ matrix.setup.os }}
+    strategy:
+      matrix:
+        setup:
+          - os: 'ubuntu-22.04'
+            features: 'io-compat,sync,ring,codec-serde-json'
+            target: 'x86_64-unknown-linux-gnu'
+          - os: 'ubuntu-22.04'
+            features: 'polling,io-compat,sync,ring,codec-serde-json'
+            target: 'x86_64-unknown-linux-gnu'
+          - os: 'ubuntu-22.04'
+            features: 'polling,io-compat,sync,ring,codec-serde-json'
+            no_default_features: true
+            target: 'x86_64-unknown-linux-gnu'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup nightly toolchain with rust-src
+        run: rustup toolchain install nightly --component rust-src
+      - name: Setup target
+        if: ${{ matrix.setup.target }}
+        run: rustup +nightly target install ${{ matrix.setup.target }}
+      - name: Run ASan tests
+        run: |
+          set -ex
+
+          ARGS=("--features" "all,nightly")
+
+          # Add features if features is not empty
+          if [[ -n "${{ matrix.setup.features }}" ]]; then
+              ARGS+=("--features" "${{ matrix.setup.features }}")
+          fi
+          # Add no-default-features if no_default_features is true
+          if [[ -n "${{ matrix.setup.no_default_features }}" ]]; then
+              ARGS+=("--no-default-features")
+          fi
+          # Specify target if target is not empty
+          if [[ -n "${{ matrix.setup.target }}" ]]; then
+              ARGS+=("--target" "${{ matrix.setup.target }}")
+          fi
+
+          cargo +nightly test --workspace --tests --lib -Zbuild-std "${ARGS[@]}"
+        env:
+          RUSTFLAGS: -Zsanitizer=address

compio-net/Cargo.toml

@@ -46,4 +46,5 @@ tempfile = { workspace = true }
 [features]
 # Nightly features
 once_cell_try = []
-nightly = ["once_cell_try"]
+sanitize = []
+nightly = ["once_cell_try", "sanitize"]

compio-net/tests/tcp_connect.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(feature = "sanitize", feature(cfg_sanitize))]
+
 use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
 
 use compio_net::{TcpListener, TcpStream, ToSocketAddrsAsync};
@@ -96,9 +98,10 @@ async fn test_connect_impl<A: ToSocketAddrsAsync>(mapping: impl FnOnce(&TcpListe
 }
 
 macro_rules! test_connect {
-    ($(($ident:ident, $mapping:tt),)*) => {
+    ($(($(#[$m:meta])* $ident:ident, $mapping:tt),)*) => {
         $(
             #[compio_macros::test]
+            $(#[$m])*
             async fn $ident() {
                 #[allow(unused_parens)]
                 test_connect_impl($mapping).await;
@@ -111,7 +114,7 @@ test_connect! {
     (ip_string, (|listener: &TcpListener| {
         format!("127.0.0.1:{}", listener.local_addr().unwrap().port())
     })),
-    (ip_str, (|listener: &TcpListener| {
+    (#[cfg_attr(feature = "sanitize", cfg(not(sanitize = "address")))] ip_str, (|listener: &TcpListener| {
         let s = format!("127.0.0.1:{}", listener.local_addr().unwrap().port());
         let slice: &str = &*Box::leak(s.into_boxed_str());
         slice
@@ -120,7 +123,7 @@ test_connect! {
         let addr = listener.local_addr().unwrap();
         (addr.ip(), addr.port())
     })),
-    (ip_port_tuple_ref, (|listener: &TcpListener| {
+    (#[cfg_attr(feature = "sanitize", cfg(not(sanitize = "address")))] ip_port_tuple_ref, (|listener: &TcpListener| {
         let addr = listener.local_addr().unwrap();
         let tuple_ref: &(IpAddr, u16) = &*Box::leak(Box::new((addr.ip(), addr.port())));
         tuple_ref

compio-ws/tests/websocket.rs

@@ -194,6 +194,7 @@ async fn compat_ping_pong() {
 
         let msg = ws.next().await.unwrap().unwrap();
         assert!(matches!(msg, Message::Ping(_)));
+        ws.close().await.unwrap();
     })
     .detach();
 
@@ -211,4 +212,7 @@ async fn compat_ping_pong() {
 
     let response = ws.next().await.unwrap().unwrap();
     assert_eq!(response, Message::Pong(ping_data.into()));
+
+    let response = ws.next().await.unwrap().unwrap();
+    assert!(response.is_close());
 }