gitlab/api/projects/pipeline_schedules/
play.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
7use derive_builder::Builder;
8
9use crate::api::common::NameOrId;
10use crate::api::endpoint_prelude::*;
11
12/// Play of a pipeline schedule on a project.
13#[derive(Debug, Builder, Clone)]
14#[builder(setter(strip_option))]
15pub struct PlayPipelineSchedule<'a> {
16    /// The project to take ownership of a pipeline schedule on.
17    #[builder(setter(into))]
18    project: NameOrId<'a>,
19    /// The pipeline schedule id.
20    id: u64,
21}
22
23impl<'a> PlayPipelineSchedule<'a> {
24    /// Create a builder for the endpoint.
25    pub fn builder() -> PlayPipelineScheduleBuilder<'a> {
26        PlayPipelineScheduleBuilder::default()
27    }
28}
29
30impl Endpoint for PlayPipelineSchedule<'_> {
31    fn method(&self) -> Method {
32        Method::POST
33    }
34
35    fn endpoint(&self) -> Cow<'static, str> {
36        format!(
37            "projects/{}/pipeline_schedules/{}/play",
38            self.project, self.id
39        )
40        .into()
41    }
42}
43
44#[cfg(test)]
45mod tests {
46    use http::Method;
47
48    use crate::api::projects::pipeline_schedules::{
49        PlayPipelineSchedule, PlayPipelineScheduleBuilderError,
50    };
51    use crate::api::{self, Query};
52    use crate::test::client::{ExpectedUrl, SingleTestClient};
53
54    #[test]
55    fn project_and_id_are_needed() {
56        let err = PlayPipelineSchedule::builder().build().unwrap_err();
57        crate::test::assert_missing_field!(err, PlayPipelineScheduleBuilderError, "project");
58    }
59
60    #[test]
61    fn project_is_needed() {
62        let err = PlayPipelineSchedule::builder().id(1).build().unwrap_err();
63        crate::test::assert_missing_field!(err, PlayPipelineScheduleBuilderError, "project");
64    }
65
66    #[test]
67    fn id_is_needed() {
68        let err = PlayPipelineSchedule::builder()
69            .project(1)
70            .build()
71            .unwrap_err();
72        crate::test::assert_missing_field!(err, PlayPipelineScheduleBuilderError, "id");
73    }
74
75    #[test]
76    fn project_and_id_are_sufficient() {
77        PlayPipelineSchedule::builder()
78            .project(1)
79            .id(1)
80            .build()
81            .unwrap();
82    }
83
84    #[test]
85    fn endpoint() {
86        let endpoint = ExpectedUrl::builder()
87            .method(Method::POST)
88            .endpoint("projects/simple%2Fproject/pipeline_schedules/10/play")
89            .build()
90            .unwrap();
91        let client = SingleTestClient::new_raw(endpoint, "");
92
93        let endpoint = PlayPipelineSchedule::builder()
94            .project("simple/project")
95            .id(10)
96            .build()
97            .unwrap();
98        api::ignore(endpoint).query(&client).unwrap();
99    }
100}
gitlab/api/projects/pipeline_schedules/play.rs

gitlab/api/projects/pipeline_schedules/
play.rs
