openstack_sdk/api/identity/v3/service/
create.rs

1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5//     http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12//
13// SPDX-License-Identifier: Apache-2.0
14//
15// WARNING: This file is automatically generated from OpenAPI schema using
16// `openstack-codegenerator`.
17
18//! Creates a service.
19//!
20//! Relationship:
21//! `https://docs.openstack.org/api/openstack-identity/3/rel/services`
22//!
23use derive_builder::Builder;
24use http::{HeaderMap, HeaderName, HeaderValue};
25
26use crate::api::rest_endpoint_prelude::*;
27
28use serde::Deserialize;
29use serde::Serialize;
30use serde_json::Value;
31use std::borrow::Cow;
32use std::collections::BTreeMap;
33
34/// A `service` object.
35#[derive(Builder, Debug, Deserialize, Clone, Serialize)]
36#[builder(setter(strip_option))]
37pub struct Service<'a> {
38    /// Defines whether the service and its endpoints appear in the service
39    /// catalog: - `false`. The service and its endpoints do not appear in the
40    /// service catalog. - `true`. The service and its endpoints appear in the
41    /// service catalog.
42    #[serde(skip_serializing_if = "Option::is_none")]
43    #[builder(default, setter(into))]
44    pub(crate) enabled: Option<bool>,
45
46    /// The service name.
47    #[serde(skip_serializing_if = "Option::is_none")]
48    #[builder(default, setter(into))]
49    pub(crate) name: Option<Cow<'a, str>>,
50
51    /// The service type, which describes the API implemented by the service.
52    /// Value is `compute`, `ec2`, `identity`, `image`, `network`, or `volume`.
53    #[serde(rename = "type")]
54    #[builder(setter(into))]
55    pub(crate) _type: Cow<'a, str>,
56
57    #[builder(setter(name = "_properties"), default, private)]
58    #[serde(flatten)]
59    _properties: BTreeMap<Cow<'a, str>, Value>,
60}
61
62impl<'a> ServiceBuilder<'a> {
63    pub fn properties<I, K, V>(&mut self, iter: I) -> &mut Self
64    where
65        I: Iterator<Item = (K, V)>,
66        K: Into<Cow<'a, str>>,
67        V: Into<Value>,
68    {
69        self._properties
70            .get_or_insert_with(BTreeMap::new)
71            .extend(iter.map(|(k, v)| (k.into(), v.into())));
72        self
73    }
74}
75
76#[derive(Builder, Debug, Clone)]
77#[builder(setter(strip_option))]
78pub struct Request<'a> {
79    /// A `service` object.
80    #[builder(setter(into))]
81    pub(crate) service: Service<'a>,
82
83    #[builder(setter(name = "_headers"), default, private)]
84    _headers: Option<HeaderMap>,
85}
86impl<'a> Request<'a> {
87    /// Create a builder for the endpoint.
88    pub fn builder() -> RequestBuilder<'a> {
89        RequestBuilder::default()
90    }
91}
92
93impl RequestBuilder<'_> {
94    /// Add a single header to the Service.
95    pub fn header(&mut self, header_name: &'static str, header_value: &'static str) -> &mut Self
96where {
97        self._headers
98            .get_or_insert(None)
99            .get_or_insert_with(HeaderMap::new)
100            .insert(header_name, HeaderValue::from_static(header_value));
101        self
102    }
103
104    /// Add multiple headers.
105    pub fn headers<I, T>(&mut self, iter: I) -> &mut Self
106    where
107        I: Iterator<Item = T>,
108        T: Into<(Option<HeaderName>, HeaderValue)>,
109    {
110        self._headers
111            .get_or_insert(None)
112            .get_or_insert_with(HeaderMap::new)
113            .extend(iter.map(Into::into));
114        self
115    }
116}
117
118impl RestEndpoint for Request<'_> {
119    fn method(&self) -> http::Method {
120        http::Method::POST
121    }
122
123    fn endpoint(&self) -> Cow<'static, str> {
124        "services".to_string().into()
125    }
126
127    fn parameters(&self) -> QueryParams {
128        QueryParams::default()
129    }
130
131    fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
132        let mut params = JsonBodyParams::default();
133
134        params.push("service", serde_json::to_value(&self.service)?);
135
136        params.into_body()
137    }
138
139    fn service_type(&self) -> ServiceType {
140        ServiceType::Identity
141    }
142
143    fn response_key(&self) -> Option<Cow<'static, str>> {
144        Some("service".into())
145    }
146
147    /// Returns headers to be set into the request
148    fn request_headers(&self) -> Option<&HeaderMap> {
149        self._headers.as_ref()
150    }
151
152    /// Returns required API version
153    fn api_version(&self) -> Option<ApiVersion> {
154        Some(ApiVersion::new(3, 0))
155    }
156}
157
158#[cfg(test)]
159mod tests {
160    use super::*;
161    #[cfg(feature = "sync")]
162    use crate::api::Query;
163    use crate::test::client::FakeOpenStackClient;
164    use crate::types::ServiceType;
165    use http::{HeaderName, HeaderValue};
166    use httpmock::MockServer;
167    use serde_json::json;
168
169    #[test]
170    fn test_service_type() {
171        assert_eq!(
172            Request::builder()
173                .service(ServiceBuilder::default()._type("foo").build().unwrap())
174                .build()
175                .unwrap()
176                .service_type(),
177            ServiceType::Identity
178        );
179    }
180
181    #[test]
182    fn test_response_key() {
183        assert_eq!(
184            Request::builder()
185                .service(ServiceBuilder::default()._type("foo").build().unwrap())
186                .build()
187                .unwrap()
188                .response_key()
189                .unwrap(),
190            "service"
191        );
192    }
193
194    #[cfg(feature = "sync")]
195    #[test]
196    fn endpoint() {
197        let server = MockServer::start();
198        let client = FakeOpenStackClient::new(server.base_url());
199        let mock = server.mock(|when, then| {
200            when.method(httpmock::Method::POST)
201                .path("/services".to_string());
202
203            then.status(200)
204                .header("content-type", "application/json")
205                .json_body(json!({ "service": {} }));
206        });
207
208        let endpoint = Request::builder()
209            .service(ServiceBuilder::default()._type("foo").build().unwrap())
210            .build()
211            .unwrap();
212        let _: serde_json::Value = endpoint.query(&client).unwrap();
213        mock.assert();
214    }
215
216    #[cfg(feature = "sync")]
217    #[test]
218    fn endpoint_headers() {
219        let server = MockServer::start();
220        let client = FakeOpenStackClient::new(server.base_url());
221        let mock = server.mock(|when, then| {
222            when.method(httpmock::Method::POST)
223                .path("/services".to_string())
224                .header("foo", "bar")
225                .header("not_foo", "not_bar");
226            then.status(200)
227                .header("content-type", "application/json")
228                .json_body(json!({ "service": {} }));
229        });
230
231        let endpoint = Request::builder()
232            .service(ServiceBuilder::default()._type("foo").build().unwrap())
233            .headers(
234                [(
235                    Some(HeaderName::from_static("foo")),
236                    HeaderValue::from_static("bar"),
237                )]
238                .into_iter(),
239            )
240            .header("not_foo", "not_bar")
241            .build()
242            .unwrap();
243        let _: serde_json::Value = endpoint.query(&client).unwrap();
244        mock.assert();
245    }
246}