reshape and document the dht-cache

.github/workflows/libp2p-rust-dht.yml

@@ -144,6 +144,19 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: mysecretpassword
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
     steps:
     - uses: actions/checkout@v3
 
@@ -179,7 +192,7 @@ jobs:
         RUSTFLAGS: "-Cinstrument-coverage"
         LLVM_PROFILE_FILE: "libp2p-rust-dht-%p-%m.profraw"
       run: |
-        cargo test --verbose
+        cargo test --verbose --all
 
     - name: Get coverage data for codecov
       run: |
@@ -220,34 +233,6 @@ jobs:
             exit 1
         fi
 
-  weighted-code-coverage:
-
-    needs: [build, docs]
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Install protobuf compiler
-      run: |
-        sudo apt-get update
-        sudo apt-get install protobuf-compiler
-
-    - name: Install Rust stable
-      uses: dtolnay/rust-toolchain@stable
-      with:
-        toolchain: stable
-
-    - name: Install grcov
-      env:
-        GRCOV_LINK: https://github.com/mozilla/grcov/releases/download
-        GRCOV_VERSION: v0.8.13
-        GRCOV_BINARY: grcov-x86_64-unknown-linux-musl.tar.bz2
-      run: |
-        curl -L "$GRCOV_LINK/$GRCOV_VERSION/$GRCOV_BINARY" |
-        tar xj -C $HOME/.cargo/bin
-
     - name: Install weighted-code-coverage
       env:
         WCC_LINK: https://github.com/SoftengPoliTo/weighted-code-coverage/releases/download
@@ -257,23 +242,7 @@ jobs:
         curl -L "$WCC_LINK/$WCC_VERSION/$WCC_BINARY" |
         tar xz -C $HOME/.cargo/bin
 
-    - name: Install llvm-tools-preview
-      run: |
-        rustup component add llvm-tools-preview
-
-    # Not necessary on a newly created image, but strictly advised
-    - name: Run cargo clean
-      run: |
-        cargo clean
-
-    - name: Run tests
-      env:
-        RUSTFLAGS: "-Cinstrument-coverage"
-        LLVM_PROFILE_FILE: "libp2p-rust-dht-%p-%m.profraw"
-      run: |
-        cargo test --verbose
-
-    - name: Run grcov
+    - name: Run grcov to produce a coveralls json
       run: |
         grcov . --binary-path ./target/debug/ -t coveralls -s . --token YOUR_COVERALLS_TOKEN > coveralls.json
 
@@ -292,7 +261,7 @@ jobs:
 
   audit:
 
-    needs: [code-coverage, weighted-code-coverage]
+    needs: [code-coverage]
 
     runs-on: ubuntu-latest
 
@@ -322,7 +291,7 @@ jobs:
 
   deny:
 
-    needs: [code-coverage, weighted-code-coverage]
+    needs: [code-coverage]
 
     runs-on: ubuntu-latest
 
@@ -368,7 +337,7 @@ jobs:
 
   udeps:
 
-    needs: [code-coverage, weighted-code-coverage]
+    needs: [code-coverage]
 
     runs-on: ubuntu-latest
 
@@ -446,39 +415,6 @@ jobs:
 
 ################################## UNSAFE CHECKS LEVEL #########################
 
-  valgrind:
-
-    needs: cache-level
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Install protobuf compiler
-      run: |
-        sudo apt-get update
-        sudo apt-get install protobuf-compiler
-
-    - name: Install valgrind
-      run: |
-        sudo apt-get install valgrind
-
-    - name: Install cargo-valgrind
-      env:
-        VALGRIND_LINK: https://github.com/jfrimmel/cargo-valgrind/releases/download
-        VALGRIND_VERSION: 2.1.0
-      run: |
-        curl -L "$VALGRIND_LINK/v$VALGRIND_VERSION/cargo-valgrind-$VALGRIND_VERSION-x86_64-unknown-linux-musl.tar.gz" |
-        tar xz -C $HOME/.cargo/bin
-
-    # Usage of the `help` command as base command, please replace it
-    # with the effective command that valgrind has to analyze
-    - name: Run cargo-valgrind
-      run: |
-        cargo valgrind run -- --help
-        # cargo valgrind test
-
   careful:
 
     needs: cache-level

dht-cache/Cargo.toml

@@ -24,11 +24,19 @@ time = "0.3.17"
 tokio = { version = "1.19.0", features = ["full"] }
 url = "2.2.2"
 rsa = "0.9"
-pem-rfc7468 = { version = "0.7", features = ["alloc"] }
+pem-rfc7468 = { version = "0.7", features = ["std"] }
 sifis-config = { path = "../dht-config" }
 openssl-sys = "*"
 libsqlite3-sys = "*"
+thiserror = "1.0.43"
+anyhow = "1.0.72"
+tokio-stream = "0.1.14"
+futures-concurrency = "7.4.1"
 
+[dev-dependencies]
+env_logger = "0.10.0"
+libp2p-swarm-test = "0.2.0"
+libp2p = { version = "0.52.0", features = ["plaintext"] }
 
 [package.metadata.cargo-udeps.ignore]
 normal = ["openssl-sys", "libsqlite3-sys", "libc"]