gitlab/api/projects/pipelines/
delete.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/// Delete a pipeline.
13#[derive(Debug, Builder, Clone)]
14pub struct DeletePipeline<'a> {
15    /// The project to delete the pipeline from.
16    #[builder(setter(into))]
17    project: NameOrId<'a>,
18    /// The ID of the pipeline.
19    pipeline: u64,
20}
21
22impl<'a> DeletePipeline<'a> {
23    /// Create a builder for the endpoint.
24    pub fn builder() -> DeletePipelineBuilder<'a> {
25        DeletePipelineBuilder::default()
26    }
27}
28
29impl Endpoint for DeletePipeline<'_> {
30    fn method(&self) -> Method {
31        Method::DELETE
32    }
33
34    fn endpoint(&self) -> Cow<'static, str> {
35        format!("projects/{}/pipelines/{}", self.project, self.pipeline).into()
36    }
37}
38
39#[cfg(test)]
40mod tests {
41    use http::Method;
42
43    use crate::api::projects::pipelines::{DeletePipeline, DeletePipelineBuilderError};
44    use crate::api::{self, Query};
45    use crate::test::client::{ExpectedUrl, SingleTestClient};
46
47    #[test]
48    fn project_and_pipeline_are_needed() {
49        let err = DeletePipeline::builder().build().unwrap_err();
50        crate::test::assert_missing_field!(err, DeletePipelineBuilderError, "project");
51    }
52
53    #[test]
54    fn project_is_needed() {
55        let err = DeletePipeline::builder().pipeline(1).build().unwrap_err();
56        crate::test::assert_missing_field!(err, DeletePipelineBuilderError, "project");
57    }
58
59    #[test]
60    fn pipeline_is_needed() {
61        let err = DeletePipeline::builder().project(1).build().unwrap_err();
62        crate::test::assert_missing_field!(err, DeletePipelineBuilderError, "pipeline");
63    }
64
65    #[test]
66    fn project_and_pipeline_are_sufficient() {
67        DeletePipeline::builder()
68            .project(1)
69            .pipeline(1)
70            .build()
71            .unwrap();
72    }
73
74    #[test]
75    fn endpoint() {
76        let endpoint = ExpectedUrl::builder()
77            .method(Method::DELETE)
78            .endpoint("projects/simple%2Fproject/pipelines/1")
79            .build()
80            .unwrap();
81        let client = SingleTestClient::new_raw(endpoint, "");
82
83        let endpoint = DeletePipeline::builder()
84            .project("simple/project")
85            .pipeline(1)
86            .build()
87            .unwrap();
88        api::ignore(endpoint).query(&client).unwrap();
89    }
90}