gitlab 0.1605.2

Gitlab API client.
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

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use derive_builder::Builder;

use crate::api::common::NameOrId;
use crate::api::endpoint_prelude::*;
use crate::api::ParamValue;

/// Scopes for pipeline schedules.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PipelineScheduleScope {
    /// Active schedules.
    Active,
    /// Inactive schedules.
    Inactive,
}

impl PipelineScheduleScope {
    /// The scope as a query parameter.
    fn as_str(self) -> &'static str {
        match self {
            PipelineScheduleScope::Active => "active",
            PipelineScheduleScope::Inactive => "inactive",
        }
    }
}

impl ParamValue<'static> for PipelineScheduleScope {
    fn as_value(&self) -> Cow<'static, str> {
        self.as_str().into()
    }
}

/// Query for pipeline schedules on a project.
#[derive(Debug, Builder, Clone)]
#[builder(setter(strip_option))]
pub struct PipelineSchedules<'a> {
    /// The project to query for pipeline schedules.
    #[builder(setter(into))]
    project: NameOrId<'a>,

    /// Filter schedules by its scope.
    #[builder(default)]
    scope: Option<PipelineScheduleScope>,
}

impl<'a> PipelineSchedules<'a> {
    /// Create a builder for the endpoint.
    pub fn builder() -> PipelineSchedulesBuilder<'a> {
        PipelineSchedulesBuilder::default()
    }
}

impl<'a> Endpoint for PipelineSchedules<'a> {
    fn method(&self) -> Method {
        Method::GET
    }

    fn endpoint(&self) -> Cow<'static, str> {
        format!("projects/{}/pipeline_schedules", self.project).into()
    }

    fn parameters(&self) -> QueryParams {
        let mut params = QueryParams::default();

        params.push_opt("scope", self.scope);

        params
    }
}

impl<'a> Pageable for PipelineSchedules<'a> {}

#[cfg(test)]
mod tests {
    use crate::api::projects::pipeline_schedules::{
        PipelineScheduleScope, PipelineSchedules, PipelineSchedulesBuilderError,
    };
    use crate::api::{self, Query};
    use crate::test::client::{ExpectedUrl, SingleTestClient};

    #[test]
    fn pipeline_schedule_scope_as_str() {
        let items = &[
            (PipelineScheduleScope::Active, "active"),
            (PipelineScheduleScope::Inactive, "inactive"),
        ];

        for (i, s) in items {
            assert_eq!(i.as_str(), *s);
        }
    }

    #[test]
    fn project_is_needed() {
        let err = PipelineSchedules::builder().build().unwrap_err();
        crate::test::assert_missing_field!(err, PipelineSchedulesBuilderError, "project");
    }

    #[test]
    fn project_is_sufficient() {
        PipelineSchedules::builder().project(1).build().unwrap();
    }

    #[test]
    fn endpoint() {
        let endpoint = ExpectedUrl::builder()
            .endpoint("projects/simple%2Fproject/pipeline_schedules")
            .build()
            .unwrap();
        let client = SingleTestClient::new_raw(endpoint, "");

        let endpoint = PipelineSchedules::builder()
            .project("simple/project")
            .build()
            .unwrap();
        api::ignore(endpoint).query(&client).unwrap();
    }

    #[test]
    fn endpoint_scope() {
        let endpoint = ExpectedUrl::builder()
            .endpoint("projects/1/pipeline_schedules")
            .add_query_params(&[("scope", "inactive")])
            .build()
            .unwrap();
        let client = SingleTestClient::new_raw(endpoint, "");

        let endpoint = PipelineSchedules::builder()
            .project(1)
            .scope(PipelineScheduleScope::Inactive)
            .build()
            .unwrap();
        api::ignore(endpoint).query(&client).unwrap();
    }
}