torrust-index-backend 2.0.0-alpha.3

The backend (API) for the Torrust Index project.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use crate::common::client::Client;

/// Provides a shared test environment for testing. All tests shared the same
/// application instance.
pub struct TestEnv {
    pub authority: String,
}

impl TestEnv {
    /// Provides a wrapper for an external running app instance.
    ///
    /// # Panics
    ///
    /// Will panic if the app is not running. This function requires the app to
    /// be running to provide a valid environment.
    pub async fn running() -> Self {
        let env = Self::default();
        let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
        let is_running = client.server_is_running().await;
        assert!(is_running, "Test server is not running on {}", env.authority);
        env
    }

    /// Provides the API server socket address.
    #[must_use]
    pub fn server_socket_addr(&self) -> Option<String> {
        // If the E2E configuration uses port 0 in the future instead of a
        // predefined port (right now we are using port 3001) we will
        // need to pass an env var with the port used by the server.
        Some(self.authority.clone())
    }
}

impl Default for TestEnv {
    fn default() -> Self {
        Self {
            authority: "localhost:3001".to_string(),
        }
    }
}