Simple e2e testing framework, passthrough and corner case tests

Signed-off-by: Eloi DEMOLIS <eloi.demolis@clever-cloud.com>

make tests.rs to a test module, allow unused code in e2e
exclude e2e tests from tarpaulin
use serial-test to run tests sequentially
Repeated tests, to run the same function multiple times

zombie crash test for #806
tests for #808 and #810
Invalid HTTP content-length test
test for #810, HTTP variant of TCP crash on missing listeners
Upgrade test (not working)
test_issue_806 can yield an Undecided

.github/workflows/ci.yml

@@ -8,7 +8,6 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      max-parallel: 1 # because concurrent testing bring certain time-based tests to fail
       matrix:
         rust:
           - stable
@@ -30,7 +29,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --verbose ${{ matrix.features }}
+          args: ${{ matrix.features }}
 
       - name: Test
         uses: actions-rs/cargo@v1
@@ -78,15 +77,15 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: install
-          args: cargo-tarpaulin --version 0.18.0-alpha3 # @TODO restore to normal (https://github.com/xd009642/tarpaulin/issues/756#issuecomment-838769320)
+          args: cargo-tarpaulin
 
       - name: Run cargo tarpaulin
         uses: actions-rs/cargo@v1
         env:
           TOKEN: ${{ secrets.COVERALLS_TOKEN }}
         with:
           command: tarpaulin
-          args: --coveralls $TOKEN --avoid-cfg-tarpaulin # @TODO restore to normal (https://github.com/xd009642/tarpaulin/issues/756#issuecomment-838769320)
+          args: --coveralls $TOKEN
 
   dockerhub:
     name: Docker build and push to Docker Hub

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["lib/", "command/", "bin/"]
+members = ["lib/", "command/", "bin/", "e2e/"]
 
 [profile.release]
 lto = true

bin/src/worker.rs

@@ -18,7 +18,6 @@ use std::{
     process::Command,
 };
 
-use std::env;
 use anyhow::{bail, Context};
 use libc::{self, pid_t};
 #[cfg(target_os = "macos")]

e2e/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "sozu-e2e"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+sozu-lib = { path = "../lib" }
+sozu-command-lib = { path = "../command" }
+slab = "^0.4.7"
+mio = "^0.8.4"
+time = "^0.3.14"
+futures = "^0.3.24"
+libc = "^0.2.138"
+serial_test = "^0.10.0"

e2e/README.md

@@ -0,0 +1,38 @@
+# End to end tests
+
+We want to check Sōzu's behavior in all corner cases for the CI.
+
+## Principles
+
+This crate contains thin wrappers around the Sōzu lib, that create:
+
+- a Sōzu worker with a very simple config, able to run a detached thread
+- mocked clients that send simple HTTP requests
+- mocked backends, sync and async, that reply dummy 200 OK responses (for instance)
+
+This crate provides the `Aggregator` trait, that allows to create simple aggregators.
+The aggregators keep track, for instance, of how many requests were received,
+and how many were sent, by a backend (just an example).
+
+These elements are instantiated in test functions. They aim at both normal behaviour
+(traffic passthrough) but also tackle corner cases, such as:
+
+- smooth soft stop
+- immediate hard stop
+- behaviour of the zombie checker
+- reconnection to a backend
+
+# How to run
+
+The tests are flagged with the usual macros, so they will run with all other tests when you do:
+
+    cargo test
+
+All tests are run one at a time with the `#[serial]` macro. You can run just one using
+
+    cargo test test_issue_810_timeout
+
+If you want to run all e2e tests at once, do:
+
+    cd e2e
+    cargo test

e2e/src/http_utils/mod.rs

@@ -0,0 +1,26 @@
+pub fn http_ok_response<S: Into<String>>(content: S) -> String {
+    let content = content.into();
+    let status_line = "HTTP/1.1 200 OK";
+    let length = content.len();
+    format!(
+        "{}\r\nContent-Length: {}\r\n\r\n{}",
+        status_line, length, content
+    )
+}
+
+/// Creates an HTTP/1 raw request
+pub fn http_request<S1: Into<String>, S2: Into<String>, S3: Into<String>>(
+    method: S1,
+    uri: S2,
+    content: S3,
+) -> String {
+    let content = content.into();
+    let length = content.len();
+    format!(
+        "{} {} HTTP/1.1\r\nHost: localhost\r\nConnection: keep-alive\r\nContent-Length: {}\r\n\r\n{}",
+        method.into(),
+        uri.into(),
+        length,
+        content,
+    )
+}

e2e/src/lib.rs

@@ -0,0 +1,11 @@
+
+#![allow(dead_code)]
+
+mod http_utils;
+mod mock;
+mod sozu;
+#[cfg(test)]
+#[cfg(not(tarpaulin))]
+mod tests;
+
+const BUFFER_SIZE: usize = 4096;

e2e/src/mock/aggregator.rs

@@ -0,0 +1,10 @@
+/// Used to hold and accumulate any data on an asynchronous task
+pub trait Aggregator {}
+
+/// Gathers only data on sent and received requests
+#[derive(Debug, Clone)]
+pub struct SimpleAggregator {
+    pub requests_received: usize,
+    pub responses_sent: usize,
+}
+impl Aggregator for SimpleAggregator {}