gitlab/api/projects/merge_requests/
diffs.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 s.
6
7use derive_builder::Builder;
8
9use crate::api::common::NameOrId;
10use crate::api::endpoint_prelude::*;
11
12/// Shows information of a merge request including its files and changes.
13#[derive(Debug, Builder, Clone)]
14#[builder(setter(strip_option))]
15pub struct MergeRequestDiffs<'a> {
16    /// The project with the merge request.
17    #[builder(setter(into))]
18    project: NameOrId<'a>,
19    /// The ID of the merge request.
20    merge_request: u64,
21
22    /// Return diffs as unified diffs.
23    #[builder(default)]
24    unidiff: Option<bool>,
25}
26
27impl<'a> MergeRequestDiffs<'a> {
28    /// Create a builder for the endpoint.
29    pub fn builder() -> MergeRequestDiffsBuilder<'a> {
30        MergeRequestDiffsBuilder::default()
31    }
32}
33
34impl Endpoint for MergeRequestDiffs<'_> {
35    fn method(&self) -> Method {
36        Method::GET
37    }
38
39    fn endpoint(&self) -> Cow<'static, str> {
40        format!(
41            "projects/{}/merge_requests/{}/diffs",
42            self.project, self.merge_request,
43        )
44        .into()
45    }
46
47    fn parameters(&self) -> QueryParams {
48        let mut params = QueryParams::default();
49
50        params.push_opt("unidiff", self.unidiff);
51
52        params
53    }
54}
55
56impl Pageable for MergeRequestDiffs<'_> {}
57
58#[cfg(test)]
59mod tests {
60    use http::Method;
61
62    use crate::api::projects::merge_requests::{MergeRequestDiffs, MergeRequestDiffsBuilderError};
63    use crate::api::{self, Query};
64    use crate::test::client::{ExpectedUrl, SingleTestClient};
65
66    #[test]
67    fn project_and_merge_request_are_needed() {
68        let err = MergeRequestDiffs::builder().build().unwrap_err();
69        crate::test::assert_missing_field!(err, MergeRequestDiffsBuilderError, "project");
70    }
71
72    #[test]
73    fn project_is_needed() {
74        let err = MergeRequestDiffs::builder()
75            .merge_request(1)
76            .build()
77            .unwrap_err();
78        crate::test::assert_missing_field!(err, MergeRequestDiffsBuilderError, "project");
79    }
80
81    #[test]
82    fn merge_request_is_needed() {
83        let err = MergeRequestDiffs::builder().project(1).build().unwrap_err();
84        crate::test::assert_missing_field!(err, MergeRequestDiffsBuilderError, "merge_request");
85    }
86
87    #[test]
88    fn project_and_merge_request_are_sufficient() {
89        MergeRequestDiffs::builder()
90            .project(1)
91            .merge_request(1)
92            .build()
93            .unwrap();
94    }
95
96    #[test]
97    fn endpoint() {
98        let endpoint = ExpectedUrl::builder()
99            .method(Method::GET)
100            .endpoint("projects/simple%2Fproject/merge_requests/1/diffs")
101            .build()
102            .unwrap();
103        let client = SingleTestClient::new_raw(endpoint, "");
104
105        let endpoint = MergeRequestDiffs::builder()
106            .project("simple/project")
107            .merge_request(1)
108            .build()
109            .unwrap();
110        api::ignore(endpoint).query(&client).unwrap();
111    }
112
113    #[test]
114    fn endpoint_unidiff() {
115        let endpoint = ExpectedUrl::builder()
116            .method(Method::GET)
117            .endpoint("projects/simple%2Fproject/merge_requests/1/diffs")
118            .add_query_params(&[("unidiff", "true")])
119            .build()
120            .unwrap();
121        let client = SingleTestClient::new_raw(endpoint, "");
122
123        let endpoint = MergeRequestDiffs::builder()
124            .project("simple/project")
125            .merge_request(1)
126            .unidiff(true)
127            .build()
128            .unwrap();
129        api::ignore(endpoint).query(&client).unwrap();
130    }
131}