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