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

gitlab/api/projects/deploy_keys/
deploy_key.rs
