dimescheduler 0.1.0

Official Rust client library for the Dime.Scheduler API.
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

//! Runs tests/contract/scenarios.json (shared with the .NET, JS and Python
//! runners) through the Rust client and asserts the captured request.

use serde::Deserialize;
use wiremock::matchers::any;
use wiremock::{Mock, MockServer, ResponseTemplate};

use crate::transport::Transport;
use crate::{entities, DimeSchedulerClient};

#[derive(Deserialize)]
struct Contract {
    common: Common,
    scenarios: Vec<Scenario>,
}

#[derive(Deserialize)]
struct Common {
    #[serde(rename = "apiKey")]
    api_key: String,
    headers: Headers,
}

#[derive(Deserialize)]
struct Headers {
    #[serde(rename = "x-api-key")]
    x_api_key: String,
    #[serde(rename = "user-agent-pattern")]
    user_agent_pattern: String,
}

#[derive(Deserialize)]
struct Scenario {
    name: String,
    input: Option<serde_json::Value>,
    expect: Expect,
}

#[derive(Deserialize)]
struct Expect {
    method: String,
    path: String,
    body: Option<serde_json::Value>,
}

async fn dispatch(c: &DimeSchedulerClient, name: &str, input: Option<serde_json::Value>) {
    let input = input.unwrap_or(serde_json::Value::Null);
    match name {
        "categories.getAll" => {
            c.categories.get_all().await.unwrap();
        }
        "categories.create" => {
            let cat: entities::Category = serde_json::from_value(input).unwrap();
            c.categories.create(&cat).await.unwrap();
        }
        "resources.getAll" => {
            c.resources.get_all().await.unwrap();
        }
        "jobs.getAll" => {
            c.jobs.get_all().await.unwrap();
        }
        "tasks.getAll" => {
            c.tasks.get_all().await.unwrap();
        }
        "tags.getAll" => {
            c.tags.get_all().await.unwrap();
        }
        "tags.create" => {
            let tag: entities::Tag = serde_json::from_value(input).unwrap();
            c.tags.create(&tag).await.unwrap();
        }
        other => panic!("unknown scenario: {other}. Add a case in dispatch()."),
    }
}

#[tokio::test]
async fn cross_sdk_contract() {
    let raw =
        std::fs::read_to_string("../../tests/contract/scenarios.json").expect("read scenarios");
    let contract: Contract = serde_json::from_str(&raw).expect("parse scenarios");
    // The shared pattern enumerates the other SDKs' names; this crate's
    // User-Agent follows the same `dimescheduler-<lang>/<semver>` shape.
    assert!(
        contract
            .common
            .headers
            .user_agent_pattern
            .starts_with("^dimescheduler-"),
        "contract pattern changed shape: {}",
        contract.common.headers.user_agent_pattern
    );

    for scenario in contract.scenarios {
        let server = MockServer::start().await;
        Mock::given(any())
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([])))
            .mount(&server)
            .await;
        let c = DimeSchedulerClient::from_transport(Transport::new(
            server.uri(),
            contract.common.api_key.clone(),
        ));

        dispatch(&c, &scenario.name, scenario.input).await;

        let reqs = server.received_requests().await.unwrap();
        assert_eq!(
            reqs.len(),
            1,
            "{}: expected exactly one request",
            scenario.name
        );
        let req = &reqs[0];
        assert_eq!(req.url.path(), scenario.expect.path, "{}", scenario.name);
        assert_eq!(
            req.method.as_str(),
            scenario.expect.method,
            "{}",
            scenario.name
        );
        assert_eq!(
            req.headers.get("x-api-key").unwrap(),
            &contract.common.headers.x_api_key,
            "{}",
            scenario.name
        );
        let ua = req.headers.get("user-agent").unwrap().to_str().unwrap();
        assert!(
            ua.starts_with("dimescheduler-rust/"),
            "{}: {ua}",
            scenario.name
        );
        if let Some(expected) = scenario.expect.body {
            let sent: serde_json::Value = serde_json::from_slice(&req.body).unwrap();
            assert_eq!(sent, expected, "{}", scenario.name);
        }
    }
}