busbar-sf-tooling 0.0.3

Salesforce Tooling API client: ApexClass, ApexTrigger, ApexLog, Debug, Execute Anonymous
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
140
141
142
143
144
145

use tracing::instrument;

use crate::error::Result;
use crate::types::{
    RunTestsAsyncRequest, RunTestsRequest, RunTestsResponse, RunTestsSyncRequest,
    RunTestsSyncResult, TestDiscoveryResult,
};

impl super::ToolingClient {
    /// Run tests asynchronously.
    ///
    /// Returns the AsyncApexJob ID as a plain string.
    #[instrument(skip(self, request))]
    pub async fn run_tests_async(&self, request: &RunTestsAsyncRequest) -> Result<String> {
        let url = format!(
            "{}/services/data/v{}/tooling/runTestsAsynchronous/",
            self.client.instance_url(),
            self.client.api_version()
        );

        // Salesforce returns the job ID as a plain quoted JSON string, not an object
        let job_id: String = self.client.post_json(&url, request).await?;
        Ok(job_id)
    }

    /// Run tests synchronously.
    ///
    /// Blocks until completion. Returns full results including successes and failures.
    #[instrument(skip(self, request))]
    pub async fn run_tests_sync(
        &self,
        request: &RunTestsSyncRequest,
    ) -> Result<RunTestsSyncResult> {
        let url = format!(
            "{}/services/data/v{}/tooling/runTestsSynchronous/",
            self.client.instance_url(),
            self.client.api_version()
        );

        self.client
            .post_json(&url, request)
            .await
            .map_err(Into::into)
    }

    /// Discover available tests (Apex and Flow tests).
    ///
    /// **Requires API v65.0 or later.**
    #[instrument(skip(self))]
    pub async fn discover_tests(&self, category: Option<&str>) -> Result<TestDiscoveryResult> {
        let mut url = format!(
            "{}/services/data/v{}/tooling/tests/",
            self.client.instance_url(),
            self.client.api_version()
        );

        if let Some(cat) = category {
            url = format!("{}?category={}", url, cat);
        }

        self.client.get_json(&url).await.map_err(Into::into)
    }

    /// Run tests using the unified Test Runner API (v65.0+).
    #[instrument(skip(self, request))]
    pub async fn run_tests(&self, request: &RunTestsRequest) -> Result<String> {
        let url = format!(
            "{}/services/data/v{}/tooling/tests/",
            self.client.instance_url(),
            self.client.api_version()
        );

        let response: RunTestsResponse = self.client.post_json(&url, request).await?;
        Ok(response.test_run_id)
    }
}

#[cfg(test)]
mod tests {
    use super::super::ToolingClient;

    #[test]
    fn test_run_tests_async_url() {
        let client = ToolingClient::new("https://na1.salesforce.com", "token")
            .unwrap()
            .with_api_version("65.0");

        let expected =
            "https://na1.salesforce.com/services/data/v65.0/tooling/runTestsAsynchronous/";
        let actual = format!(
            "{}/services/data/v{}/tooling/runTestsAsynchronous/",
            client.instance_url(),
            client.api_version()
        );
        assert_eq!(actual, expected);
    }

    #[test]
    fn test_run_tests_sync_url() {
        let client = ToolingClient::new("https://na1.salesforce.com", "token")
            .unwrap()
            .with_api_version("62.0");

        let expected =
            "https://na1.salesforce.com/services/data/v62.0/tooling/runTestsSynchronous/";
        let actual = format!(
            "{}/services/data/v{}/tooling/runTestsSynchronous/",
            client.instance_url(),
            client.api_version()
        );
        assert_eq!(actual, expected);
    }

    #[test]
    fn test_discover_tests_url() {
        let client = ToolingClient::new("https://na1.salesforce.com", "token")
            .unwrap()
            .with_api_version("65.0");

        let url_no_cat = format!(
            "{}/services/data/v{}/tooling/tests/",
            client.instance_url(),
            client.api_version()
        );
        assert_eq!(
            url_no_cat,
            "https://na1.salesforce.com/services/data/v65.0/tooling/tests/"
        );
    }

    #[test]
    fn test_run_tests_url() {
        let client = ToolingClient::new("https://na1.salesforce.com", "token")
            .unwrap()
            .with_api_version("65.0");

        let expected = "https://na1.salesforce.com/services/data/v65.0/tooling/tests/";
        let actual = format!(
            "{}/services/data/v{}/tooling/tests/",
            client.instance_url(),
            client.api_version()
        );
        assert_eq!(actual, expected);
    }
}