polaris-api 0.4.1

Rust API client library for Black Duck Polaris.
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
use std::sync::Arc;
use tokio::sync::RwLock;
use zeroize::Zeroizing;

use crate::auth::AuthClient;
use crate::common::{CommonClient, JsonApiResponse, Project, Branch};
use crate::error::{PolarisError, Result};

/// Configuration for the Polaris client.
#[derive(Debug, Clone)]
pub struct PolarisConfig {
    pub base_url: String,
    pub api_token: String,
}

impl PolarisConfig {
    pub fn from_env() -> Result<Self> {
        let api_token = std::env::var("POLARIS_API_TOKEN")
            .map_err(|_| PolarisError::Other("POLARIS_API_TOKEN env var not set".into()))?;
        let base_url = std::env::var("POLARIS_BASE_URL")
            .unwrap_or_else(|_| "https://your-instance.polaris.blackduck.com".into());
        Ok(Self {
            base_url,
            api_token,
        })
    }
}

/// High-level client for the BlackDuck Polaris API.
pub struct PolarisClient {
    config: PolarisConfig,
    auth: AuthClient,
    jwt: Arc<RwLock<Option<Zeroizing<String>>>>,
}

impl PolarisClient {
    pub fn new(config: PolarisConfig) -> Self {
        let auth = AuthClient::new(&config.base_url);
        Self {
            config,
            auth,
            jwt: Arc::new(RwLock::new(None)),
        }
    }

    /// Authenticate and return the JWT. Caches the JWT for subsequent calls.
    pub async fn authenticate(&self) -> Result<String> {
        let jwt = self
            .auth
            .authenticate_with_token(&self.config.api_token)
            .await?;
        *self.jwt.write().await = Some(Zeroizing::new(jwt.clone()));
        Ok(jwt)
    }

    /// Get the current JWT, authenticating if needed.
    async fn get_jwt(&self) -> Result<String> {
        {
            let jwt = self.jwt.read().await;
            if let Some(ref j) = *jwt {
                return Ok((**j).clone());
            }
        }
        self.authenticate().await
    }

    fn common_client(&self, jwt: &str) -> Result<CommonClient> {
        CommonClient::new(&self.config.base_url, jwt)
    }

    fn authed_http(&self, jwt: &str) -> Result<reqwest::Client> {
        let mut headers = reqwest::header::HeaderMap::new();
        headers.insert(
            reqwest::header::AUTHORIZATION,
            reqwest::header::HeaderValue::from_str(&format!("Bearer {jwt}"))
                .map_err(|e| PolarisError::Other(format!("invalid header value: {e}")))?,
        );
        headers.insert(
            reqwest::header::ACCEPT,
            reqwest::header::HeaderValue::from_static("application/vnd.api+json"),
        );
        reqwest::Client::builder()
            .default_headers(headers)
            .timeout(std::time::Duration::from_secs(120))
            .connect_timeout(std::time::Duration::from_secs(30))
            .build()
            .map_err(PolarisError::Http)
    }

    // ── Projects ──

    /// List projects, optionally filtering by name.
    pub async fn list_projects(
        &self,
        name_filter: Option<&str>,
        limit: u32,
        offset: u32,
    ) -> Result<JsonApiResponse<Project>> {
        let jwt = self.get_jwt().await?;
        self.common_client(&jwt)?
            .list_projects(name_filter, limit, offset)
            .await
    }

    /// Fetch all projects by auto-paginating.
    pub async fn list_all_projects(
        &self,
        name_filter: Option<&str>,
        page_size: u32,
    ) -> Result<JsonApiResponse<Project>> {
        let mut all_data = Vec::new();
        let mut all_included = Vec::new();
        let mut offset = 0u32;
        let mut total = None;

        loop {
            let resp = self.list_projects(name_filter, page_size, offset).await?;
            if let Some(ref meta) = resp.meta {
                total = meta.total;
            }
            let count = resp.data.len();
            all_data.extend(resp.data);
            all_included.extend(resp.included);
            if count < page_size as usize {
                break;
            }
            offset += page_size;
            if let Some(t) = total && offset as u64 >= t {
                break;
            }
        }

        Ok(JsonApiResponse {
            data: all_data,
            included: all_included,
            meta: total.map(|t| crate::common::PaginationMeta {
                offset: Some(0),
                limit: None,
                total: Some(t),
            }),
        })
    }

    /// List branches for a project.
    pub async fn list_branches(
        &self,
        project_id: &str,
        limit: u32,
        offset: u32,
    ) -> Result<JsonApiResponse<Branch>> {
        let jwt = self.get_jwt().await?;
        self.common_client(&jwt)?
            .list_branches(project_id, limit, offset)
            .await
    }

    /// Fetch all branches for a project by auto-paginating.
    pub async fn list_all_branches(
        &self,
        project_id: &str,
        page_size: u32,
    ) -> Result<JsonApiResponse<Branch>> {
        let mut all_data = Vec::new();
        let mut offset = 0u32;
        let mut total = None;

        loop {
            let resp = self.list_branches(project_id, page_size, offset).await?;
            if let Some(ref meta) = resp.meta {
                total = meta.total;
            }
            let count = resp.data.len();
            all_data.extend(resp.data);
            if count < page_size as usize {
                break;
            }
            offset += page_size;
            if let Some(t) = total && offset as u64 >= t {
                break;
            }
        }

        Ok(JsonApiResponse {
            data: all_data,
            included: vec![],
            meta: total.map(|t| crate::common::PaginationMeta {
                offset: Some(0),
                limit: None,
                total: Some(t),
            }),
        })
    }

    // ── Issues ──

    /// List issues for a project + branch (or run).
    pub async fn list_issues(
        &self,
        project_id: &str,
        branch_id: Option<&str>,
        run_ids: Option<&[&str]>,
        limit: u32,
        offset: u32,
    ) -> Result<IssuesResponse> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let mut url = format!(
            "{}/api/query/v1/issues?project-id={}&page[limit]={limit}&page[offset]={offset}",
            self.config.base_url,
            urlencoding::encode(project_id),
        );

        if let Some(bid) = branch_id {
            url.push_str(&format!("&branch-id={}", urlencoding::encode(bid)));
        }
        if let Some(rids) = run_ids {
            for rid in rids {
                url.push_str(&format!("&run-id[]={}", urlencoding::encode(rid)));
            }
        }

        // Include common relationships
        url.push_str("&include[issue][]=severity&include[issue][]=issue-type&include[issue][]=tool-domain-service");

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    /// Fetch all issues by auto-paginating.
    pub async fn list_all_issues(
        &self,
        project_id: &str,
        branch_id: Option<&str>,
        run_ids: Option<&[&str]>,
        page_size: u32,
    ) -> Result<IssuesResponse> {
        let mut all_data = Vec::new();
        let mut all_included = Vec::new();
        let mut offset = 0u32;
        let mut total = None;

        loop {
            let resp = self
                .list_issues(project_id, branch_id, run_ids, page_size, offset)
                .await?;
            if let Some(ref meta) = resp.meta {
                total = meta.total;
            }
            let count = resp.data.len();
            all_data.extend(resp.data);
            all_included.extend(resp.included);
            if count < page_size as usize {
                break;
            }
            offset += page_size;
            if let Some(t) = total && offset as u64 >= t {
                break;
            }
        }

        Ok(IssuesResponse {
            data: all_data,
            included: all_included,
            meta: total.map(|t| IssuesMeta {
                offset: Some(0),
                limit: None,
                total: Some(t),
            }),
        })
    }

    /// Get a single issue by ID.
    pub async fn get_issue(
        &self,
        issue_id: &str,
        project_id: &str,
        branch_id: &str,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/query/v1/issues/{}?project-id={}&branch-id={}&include[issue][]=severity&include[issue][]=issue-type&include[issue][]=tool-domain-service&include[issue][]=path&include[issue][]=transitions",
            self.config.base_url,
            urlencoding::encode(issue_id),
            urlencoding::encode(project_id),
            urlencoding::encode(branch_id),
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    // ── Code Analysis Events ──

    /// Get the event tree with source code snippets for a finding.
    pub async fn get_events_with_source(
        &self,
        finding_key: &str,
        run_id: &str,
        occurrence_number: Option<u32>,
        max_depth: Option<u32>,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let mut url = format!(
            "{}/api/code-analysis/v0/events-with-source?finding-key={}&run-id={}",
            self.config.base_url,
            urlencoding::encode(finding_key),
            urlencoding::encode(run_id),
        );
        if let Some(occ) = occurrence_number {
            url.push_str(&format!("&occurrence-number={occ}"));
        }
        if let Some(depth) = max_depth {
            url.push_str(&format!("&max-depth={depth}"));
        }

        let resp = http
            .get(&url)
            .header("Accept-Language", "en")
            .header("Accept", "application/json")
            .send()
            .await?;
        check_response(resp).await
    }

    /// Get full source code for a file in a run.
    pub async fn get_source_code(
        &self,
        run_id: &str,
        path: &str,
    ) -> Result<String> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/code-analysis/v0/source-code?run-id={}&path={}",
            self.config.base_url,
            urlencoding::encode(run_id),
            urlencoding::encode(path),
        );

        let resp = http
            .get(&url)
            .header("Accept", "text/plain")
            .send()
            .await?;
        let status = resp.status();
        if !status.is_success() {
            let detail = resp.text().await.unwrap_or_default();
            return Err(PolarisError::Api {
                status: status.as_u16(),
                detail,
            });
        }
        Ok(resp.text().await?)
    }

    // ── Triage ──

    /// Get current triage status for an issue.
    pub async fn get_triage(
        &self,
        project_id: &str,
        issue_key: &str,
    ) -> Result<TriageCurrentResponse> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/triage-query/v1/triage-current?filter[triage-current][project-id][$eq]={}&filter[triage-current][issue-key][$eq]={}",
            self.config.base_url,
            urlencoding::encode(project_id),
            urlencoding::encode(issue_key),
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    /// Update triage for one or more issues.
    pub async fn update_triage(
        &self,
        project_id: &str,
        issue_keys: &[&str],
        triage_values: &TriageValues,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/triage-command/v1/triage-issues",
            self.config.base_url
        );

        let mut triage_map = serde_json::Map::new();
        if let Some(ref dismiss) = triage_values.dismiss {
            triage_map.insert("DISMISS".into(), serde_json::Value::String(dismiss.clone()));
        }
        if let Some(ref owner) = triage_values.owner {
            triage_map.insert("OWNER".into(), serde_json::Value::String(owner.clone()));
        }
        if let Some(ref comment) = triage_values.commentary {
            triage_map.insert("COMMENTARY".into(), serde_json::Value::String(comment.clone()));
        }

        let body = serde_json::json!({
            "data": {
                "type": "triage-issues",
                "attributes": {
                    "project-id": project_id,
                    "issue-keys": issue_keys,
                    "triage-values": triage_map,
                }
            }
        });

        let resp = http
            .post(&url)
            .header("Content-Type", "application/vnd.api+json")
            .json(&body)
            .send()
            .await?;

        check_response(resp).await
    }

    /// Get triage history for an issue.
    pub async fn get_triage_history(
        &self,
        project_id: &str,
        issue_key: &str,
        limit: u32,
        offset: u32,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/triage-query/v1/triage-history-items?filter[triage-history-items][project-id][$eq]={}&filter[triage-history-items][issue-key][$eq]={}&page[limit]={limit}&page[offset]={offset}",
            self.config.base_url,
            urlencoding::encode(project_id),
            urlencoding::encode(issue_key),
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    // ── Metrics & Discovery ──

    /// Get roll-up counts of issues, optionally grouped by a field.
    pub async fn get_roll_up_counts(
        &self,
        project_id: &str,
        branch_id: Option<&str>,
        group_by: Option<&str>,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let mut url = format!(
            "{}/api/query/v1/roll-up-counts?project-id={}&page[limit]=100",
            self.config.base_url,
            urlencoding::encode(project_id),
        );
        if let Some(bid) = branch_id {
            url.push_str(&format!("&branch-id={}", urlencoding::encode(bid)));
        }
        if let Some(gb) = group_by {
            url.push_str(&format!("&group-by={}", urlencoding::encode(gb)));
        }

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    /// Get issue counts over time, grouped by status or severity.
    pub async fn get_issues_over_time(
        &self,
        project_id: &str,
        branch_id: Option<&str>,
        group_by: Option<&str>,
        start_date: Option<&str>,
        end_date: Option<&str>,
        granularity: Option<&str>,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let mut url = format!(
            "{}/api/query/v1/counts/issues-over-time?project-id={}",
            self.config.base_url,
            urlencoding::encode(project_id),
        );
        if let Some(bid) = branch_id {
            url.push_str(&format!("&branch-id={}", urlencoding::encode(bid)));
        }
        if let Some(gb) = group_by {
            url.push_str(&format!("&group-by={}", urlencoding::encode(gb)));
        }
        if let Some(sd) = start_date {
            url.push_str(&format!("&start-date={}", urlencoding::encode(sd)));
        }
        if let Some(ed) = end_date {
            url.push_str(&format!("&end-date={}", urlencoding::encode(ed)));
        }
        if let Some(g) = granularity {
            url.push_str(&format!("&granularity={}", urlencoding::encode(g)));
        }

        let resp = http
            .get(&url)
            .header("Accept", "application/json")
            .send()
            .await?;
        check_response(resp).await
    }

    /// Get issue age metrics (average for outstanding or resolved issues).
    pub async fn get_issue_age(
        &self,
        project_id: &str,
        branch_id: &str,
        metric: Option<&str>,
    ) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let metric_val = metric.unwrap_or("average-for-outstanding-issues");
        let url = format!(
            "{}/api/query/v1/issue-metrics/age?project-id={}&branch-id={}&metric={}&include[issue-metrics-age]=taxon&page[limit]=100",
            self.config.base_url,
            urlencoding::encode(project_id),
            urlencoding::encode(branch_id),
            urlencoding::encode(metric_val),
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    /// Get available filter keys for issue queries.
    pub async fn get_filter_keys(&self) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/query/v1/discovery/filter-keys",
            self.config.base_url,
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }

    /// Get available group-by values for issue queries.
    pub async fn get_group_bys(&self) -> Result<serde_json::Value> {
        let jwt = self.get_jwt().await?;
        let http = self.authed_http(&jwt)?;

        let url = format!(
            "{}/api/query/v1/discovery/group-bys",
            self.config.base_url,
        );

        let resp = http.get(&url).send().await?;
        check_response(resp).await
    }
}

// ── Response types ──

use serde::{Deserialize, Serialize};

#[derive(Debug, Deserialize)]
pub struct IssuesResponse {
    pub data: Vec<Issue>,
    #[serde(default)]
    pub included: Vec<serde_json::Value>,
    #[serde(default)]
    pub meta: Option<IssuesMeta>,
}

#[derive(Debug, Deserialize)]
pub struct IssuesMeta {
    #[serde(rename = "total")]
    pub total: Option<u64>,
    #[serde(rename = "offset")]
    pub offset: Option<u64>,
    #[serde(rename = "limit")]
    pub limit: Option<u64>,
}

#[derive(Debug, Deserialize)]
pub struct Issue {
    #[serde(rename = "type")]
    pub resource_type: String,
    pub id: String,
    pub attributes: IssueAttributes,
    #[serde(default)]
    pub relationships: Option<serde_json::Value>,
}

#[derive(Debug, Deserialize)]
pub struct IssueAttributes {
    #[serde(rename = "issue-key")]
    pub issue_key: String,
    #[serde(rename = "finding-key")]
    pub finding_key: String,
    #[serde(rename = "sub-tool", default)]
    pub sub_tool: Option<String>,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct TriageCurrentResponse {
    pub data: Vec<TriageCurrent>,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct TriageCurrent {
    #[serde(rename = "type")]
    pub resource_type: String,
    pub id: String,
    pub attributes: TriageCurrentAttributes,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct TriageCurrentAttributes {
    #[serde(rename = "issue-key")]
    pub issue_key: String,
    #[serde(rename = "project-id")]
    pub project_id: String,
    #[serde(rename = "dismissal-status", default)]
    pub dismissal_status: Option<String>,
    #[serde(rename = "triage-current-values", default)]
    pub triage_current_values: Vec<serde_json::Value>,
}

/// Values for updating triage on issues.
#[derive(Debug, Clone, Default, Serialize)]
pub struct TriageValues {
    /// Dismiss value: NOT_DISMISSED, DISMISSED_BY_DESIGN, DISMISSED_AS_FP, etc.
    pub dismiss: Option<String>,
    /// Owner email address.
    pub owner: Option<String>,
    /// Free text comment.
    pub commentary: Option<String>,
}

async fn check_response<T: serde::de::DeserializeOwned>(
    resp: reqwest::Response,
) -> Result<T> {
    let status = resp.status();
    if !status.is_success() {
        let code = status.as_u16();
        let body = resp.text().await.unwrap_or_default();
        if code == 404 {
            return Err(PolarisError::NotFound(body));
        }
        return Err(PolarisError::Api {
            status: code,
            detail: body,
        });
    }

    resp.json::<T>()
        .await
        .map_err(|e| PolarisError::Deserialize(e.to_string()))
}