use std::collections::HashSet;
use derive_builder::Builder;
use crate::api::common::NameOrId;
use crate::api::endpoint_prelude::*;
use crate::api::ParamValue;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum JobScope {
Created,
Pending,
Running,
Failed,
Success,
Canceled,
Skipped,
WaitingForResource,
Manual,
}
impl JobScope {
pub(crate) fn as_str(self) -> &'static str {
match self {
JobScope::Created => "created",
JobScope::Pending => "pending",
JobScope::Running => "running",
JobScope::Failed => "failed",
JobScope::Success => "success",
JobScope::Canceled => "canceled",
JobScope::Skipped => "skipped",
JobScope::WaitingForResource => "waiting_for_resource",
JobScope::Manual => "manual",
}
}
}
impl ParamValue<'static> for JobScope {
fn as_value(&self) -> Cow<'static, str> {
self.as_str().into()
}
}
#[derive(Debug, Builder, Clone)]
#[builder(setter(strip_option))]
pub struct Jobs<'a> {
#[builder(setter(into))]
project: NameOrId<'a>,
#[builder(setter(name = "_scopes"), default, private)]
scopes: HashSet<JobScope>,
#[builder(default)]
include_retried: Option<bool>,
}
impl<'a> Jobs<'a> {
pub fn builder() -> JobsBuilder<'a> {
JobsBuilder::default()
}
}
impl<'a> JobsBuilder<'a> {
pub fn scope(&mut self, scope: JobScope) -> &mut Self {
self.scopes.get_or_insert_with(HashSet::new).insert(scope);
self
}
pub fn scopes<I>(&mut self, scopes: I) -> &mut Self
where
I: Iterator<Item = JobScope>,
{
self.scopes.get_or_insert_with(HashSet::new).extend(scopes);
self
}
}
impl<'a> Endpoint for Jobs<'a> {
fn method(&self) -> Method {
Method::GET
}
fn endpoint(&self) -> Cow<'static, str> {
format!("projects/{}/jobs", self.project).into()
}
fn parameters(&self) -> QueryParams {
let mut params = QueryParams::default();
params
.extend(self.scopes.iter().map(|&value| ("scope[]", value)))
.push_opt("include_retried", self.include_retried);
params
}
}
impl<'a> Pageable for Jobs<'a> {
fn use_keyset_pagination(&self) -> bool {
true
}
}
#[cfg(test)]
mod tests {
use crate::api::projects::jobs::{JobScope, Jobs, JobsBuilderError};
use crate::api::{self, Query};
use crate::test::client::{ExpectedUrl, SingleTestClient};
#[test]
fn job_scope_as_str() {
let items = &[
(JobScope::Created, "created"),
(JobScope::Pending, "pending"),
(JobScope::Running, "running"),
(JobScope::Failed, "failed"),
(JobScope::Success, "success"),
(JobScope::Canceled, "canceled"),
(JobScope::Skipped, "skipped"),
(JobScope::WaitingForResource, "waiting_for_resource"),
(JobScope::Manual, "manual"),
];
for (i, s) in items {
assert_eq!(i.as_str(), *s);
}
}
#[test]
fn project_is_needed() {
let err = Jobs::builder().build().unwrap_err();
crate::test::assert_missing_field!(err, JobsBuilderError, "project");
}
#[test]
fn project_is_sufficient() {
Jobs::builder().project(1).build().unwrap();
}
#[test]
fn endpoint() {
let endpoint = ExpectedUrl::builder()
.endpoint("projects/simple%2Fproject/jobs")
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = Jobs::builder().project("simple/project").build().unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_scopes() {
let endpoint = ExpectedUrl::builder()
.endpoint("projects/1/jobs")
.add_query_params(&[("scope[]", "created"), ("scope[]", "success")])
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = Jobs::builder()
.project(1)
.scope(JobScope::Created)
.scopes([JobScope::Created, JobScope::Success].iter().cloned())
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_include_retried() {
let endpoint = ExpectedUrl::builder()
.endpoint("projects/1/jobs")
.add_query_params(&[("include_retried", "true")])
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = Jobs::builder()
.project(1)
.include_retried(true)
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
}