instrumentality 0.3.0

A data aggregation platform.
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Always use `prepare_environment` unless you are certain of what you are
//! doing. Using it twice will not create another user. Use the given user
//! to create an invite via /invite and register that user.
//!
//! `setup_client` starts instrumentality, which will connect to mongodb on
//! startup and check if the user collection is empty (shorthand for is this
//! a fresh database). If so, a root account is created as are some indexes.
//!
//! It is VITAL that you do not call `inject_test_account` before setting up
//! the client. If you do this, the indexes enforcing uniqueness on collections
//! will not be created and your test environment will yield subtly different
//! outcomes making debugging difficult.

use axum::body::Body;
use axum::http::Method;
use axum::http::Request;
use axum::http::StatusCode;
use axum::Router;
use axum_server::Handle;
use chrono::Utc;
use instrumentality::config;
use instrumentality::config::IConfig;
use instrumentality::data::Data;
use instrumentality::database;
use instrumentality::routes::response::LoginResponse;
use instrumentality::server;
use instrumentality::user::User;
use tower::Service;
use uuid::Uuid;

pub const TEST_ENVIRONMENT_CONFIG: &str = "InstrumentalityTest.toml";

pub struct Environment {
    pub app: Router,
    pub user: User,
    pub user_key: String,
    pub config: IConfig,
    pub handle: Handle,
}

impl Environment {
    pub async fn default() -> Self {
        Self::new(TEST_ENVIRONMENT_CONFIG).await
    }

    // TODO: add an attribute macro that calls new and cleanup for a test.
    pub async fn new(config_path: &str) -> Self {
        let mut config = config::open(config_path).unwrap();
        let test_db_id = Uuid::new_v4().to_string();
        config.mongodb.database = test_db_id.clone();
        let (app, _, _, handle) = server::build_server(&config).await;

        let (user, key) = User::new("test");
        Self::inject_account(&config, &user).await;

        Self {
            app,
            user,
            user_key: key,
            config,
            handle,
        }
    }

    pub async fn cleanup(&self) {
        let database = database::open(&self.config).await.unwrap();
        database::drop_database(
            &database.handle_with_started_transaction().await,
        )
        .await;
    }

    // This is only used in tests, so it flags as dead code.
    #[allow(dead_code)]
    pub async fn login(&mut self) -> LoginResponse {
        let res = self
            .app
            .call(
                Request::builder()
                    .method(Method::GET)
                    .header("X-API-KEY", &self.user_key)
                    .uri("/user/login")
                    .body(Body::empty())
                    .unwrap(),
            )
            .await
            .unwrap();

        assert_eq!(res.status(), StatusCode::OK);

        let body = hyper::body::to_bytes(res.into_body()).await.unwrap();
        let lr: LoginResponse = serde_json::from_slice(&body).unwrap();

        lr
    }

    pub async fn inject_account(config: &IConfig, user: &User) {
        let database = database::open(&config).await.unwrap();

        let _user_coll = database
            .handle_with_started_transaction()
            .await
            .collection::<User>("users")
            .insert_one(user, None)
            .await
            .unwrap();
    }
}

#[allow(dead_code)]
pub fn create_mock_content(id: &str, platform: &str) -> Data {
    Data::Content {
        id: id.to_string(),
        platform: platform.to_string(),
        content_type: "story".to_string(),
        retrieved_at: Utc::now(),
        content_id: Uuid::new_v4().to_string(),
        deleted: Some(false),
        retrieved_from: None,
        created_at: None,
        body: None,
        media: None,
        references: None,
        added_by: None,
        added_at: None,
    }
}

#[allow(dead_code)]
pub fn create_mock_presence(id: &str, platform: &str) -> Data {
    Data::Presence {
        id: id.to_string(),
        platform: platform.to_string(),
        presence_type: "live".to_string(),
        retrieved_at: Utc::now(),
        added_by: None,
        added_at: None,
    }
}