gitlab/api/projects/
merge_trains.rs

1// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
2// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
3// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
4// option. This file may not be copied, modified, or distributed
5// except according to those terms.
6
7//! Project merge train API endpoint.
8//!
9//! These endpoints are used for querying projects' merge trains.
10
11use derive_builder::Builder;
12
13use crate::api::common::{NameOrId, SortOrder};
14use crate::api::{endpoint_prelude::*, ParamValue};
15
16/// Filter merge train entries by a scope.
17#[derive(Debug, Clone, Copy, PartialEq, Eq)]
18#[non_exhaustive]
19pub enum MergeTrainsScope {
20    /// Still in progress.
21    Active,
22    /// Has been merged.
23    Complete,
24}
25
26impl MergeTrainsScope {
27    fn as_str(self) -> &'static str {
28        match self {
29            MergeTrainsScope::Active => "active",
30            MergeTrainsScope::Complete => "complete",
31        }
32    }
33}
34
35impl ParamValue<'static> for MergeTrainsScope {
36    fn as_value(&self) -> Cow<'static, str> {
37        self.as_str().into()
38    }
39}
40
41/// Get the list of merge trains for project.
42#[derive(Debug, Builder, Clone)]
43#[builder(setter(strip_option))]
44pub struct MergeTrains<'a> {
45    /// The project with the merge request.
46    #[builder(setter(into))]
47    project: NameOrId<'a>,
48
49    /// Filter merge trains within a scope.
50    #[builder(default)]
51    scope: Option<MergeTrainsScope>,
52
53    /// The sort order for returned results.
54    #[builder(default)]
55    sort: Option<SortOrder>,
56}
57
58impl<'a> MergeTrains<'a> {
59    /// Create a builder for the endpoint.
60    pub fn builder() -> MergeTrainsBuilder<'a> {
61        MergeTrainsBuilder::default()
62    }
63}
64
65impl Endpoint for MergeTrains<'_> {
66    fn method(&self) -> Method {
67        Method::GET
68    }
69
70    fn endpoint(&self) -> Cow<'static, str> {
71        format!("projects/{}/merge_trains", self.project).into()
72    }
73
74    fn parameters(&self) -> QueryParams {
75        let mut params = QueryParams::default();
76
77        params
78            .push_opt("scope", self.scope)
79            .push_opt("sort", self.sort);
80
81        params
82    }
83}
84
85impl Pageable for MergeTrains<'_> {}
86
87#[cfg(test)]
88mod tests {
89    use crate::api::projects::merge_trains::{
90        MergeTrains, MergeTrainsBuilderError, MergeTrainsScope,
91    };
92
93    use crate::api::common::SortOrder;
94    use crate::api::{self, Query};
95    use crate::test::client::{ExpectedUrl, SingleTestClient};
96
97    #[test]
98    fn project_is_needed() {
99        let err = MergeTrains::builder().build().unwrap_err();
100        crate::test::assert_missing_field!(err, MergeTrainsBuilderError, "project");
101    }
102
103    #[test]
104    fn project_is_sufficient() {
105        MergeTrains::builder().project(1).build().unwrap();
106    }
107
108    #[test]
109    fn endpoint_sort() {
110        let endpoint = ExpectedUrl::builder()
111            .endpoint("projects/simple%2Fproject/merge_trains")
112            .add_query_params(&[("sort", "desc")])
113            .build()
114            .unwrap();
115        let client = SingleTestClient::new_raw(endpoint, "");
116
117        let endpoint = MergeTrains::builder()
118            .project("simple/project")
119            .sort(SortOrder::Descending)
120            .build()
121            .unwrap();
122        api::ignore(endpoint).query(&client).unwrap();
123    }
124
125    #[test]
126    fn merge_train_scope_as_str() {
127        let items = &[
128            (MergeTrainsScope::Active, "active"),
129            (MergeTrainsScope::Complete, "complete"),
130        ];
131
132        for (i, s) in items {
133            assert_eq!(i.as_str(), *s);
134        }
135    }
136
137    #[test]
138    fn endpoint_scope() {
139        let endpoint = ExpectedUrl::builder()
140            .endpoint("projects/simple%2Fproject/merge_trains")
141            .add_query_params(&[("scope", "active")])
142            .build()
143            .unwrap();
144        let client = SingleTestClient::new_raw(endpoint, "");
145
146        let endpoint = MergeTrains::builder()
147            .project("simple/project")
148            .scope(MergeTrainsScope::Active)
149            .build()
150            .unwrap();
151        api::ignore(endpoint).query(&client).unwrap();
152    }
153}
gitlab/api/projects/merge_trains.rs

gitlab/api/projects/
merge_trains.rs
