chore: Initialize mock testing

Author: gtema

.github/workflows/ci.yml

@@ -90,3 +90,25 @@ jobs:
 
       - name: Run tests
         run: cargo +nightly fuzz run fuzz_openstack_sdk_config --features=fuzzing -- -max_total_time=60
+
+  mock_openstack_types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@56f84321dbccf38fb67ce29ab63e4754056677e0 # stable
+        with:
+          toolchain: stable
+
+      - name: Rust Cache
+        uses: swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
+
+      - name: Start prism
+        run: |
+          docker run --init --rm -d -v "$GITHUB_WORKSPACE/openstack_types/data":"/data" -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 /data/block-storage/v3.yaml -d
+
+      - name: Run tests
+        env:
+          OPENSTACK_BLOCK_STORAGE_ENDPOINT: http://localhost:4010/v3
+        run: cargo test -p openstack_types --test mocked

Cargo.lock

@@ -159,6 +159,15 @@ pub struct AuthToken {
     pub(crate) auth_info: Option<AuthResponse>,
 }
 
+impl From<&str> for AuthToken {
+    fn from(value: &str) -> Self {
+        Self {
+            token: value.into(),
+            ..Default::default()
+        }
+    }
+}
+
 impl Debug for AuthToken {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         f.debug_struct("Auth")

openstack_sdk/src/auth/authtoken.rs

@@ -36,4 +36,4 @@ pub use crate::openstack::OpenStack;
 pub use crate::openstack_async::AsyncOpenStack;
 
 #[allow(dead_code)]
-mod test;
+pub mod test;

openstack_sdk/src/lib.rs

@@ -35,6 +35,7 @@ use crate::api::AsyncClient;
 #[cfg(feature = "sync")]
 use crate::api::Client;
 use crate::api::{ApiError, RestClient};
+use crate::auth::Auth;
 
 use crate::catalog::{CatalogError, ServiceEndpoint};
 use crate::types::identity::v3::Project;
@@ -96,6 +97,9 @@ use crate::RestError;
 pub struct FakeOpenStackClient {
     /// Known endpoints used by the client
     endpoints: HashMap<String, ServiceEndpoint>,
+
+    /// Optional auth information to be used
+    auth: Option<Auth>,
 }
 
 impl FakeOpenStackClient {
@@ -104,6 +108,7 @@ impl FakeOpenStackClient {
     pub fn new<S: AsRef<str>>(url: S) -> Self {
         let mut slf = Self {
             endpoints: HashMap::new(),
+            auth: None,
         };
         slf.add_endpoint("default", Url::parse(url.as_ref()).unwrap());
         slf
@@ -118,6 +123,12 @@ impl FakeOpenStackClient {
         );
         self
     }
+
+    /// Set auth information
+    pub fn set_auth(&mut self, auth: Option<Auth>) -> &mut Self {
+        self.auth = auth;
+        self
+    }
 }
 
 impl RestClient for FakeOpenStackClient {
@@ -145,10 +156,13 @@ impl RestClient for FakeOpenStackClient {
 impl Client for FakeOpenStackClient {
     fn rest(
         &self,
-        request: RequestBuilder,
+        mut request: RequestBuilder,
         body: Vec<u8>,
     ) -> Result<Response<Bytes>, ApiError<Self::Error>> {
         let call = || -> Result<_, Self::Error> {
+            if let Some(auth) = &self.auth {
+                auth.set_header(request.headers_mut().unwrap())?;
+            }
             let http_request = request.body(body.clone())?;
             let request = http_request.try_into()?;
 
@@ -175,11 +189,14 @@ impl Client for FakeOpenStackClient {
 impl AsyncClient for FakeOpenStackClient {
     async fn rest_async(
         &self,
-        request: http::request::Builder,
+        mut request: http::request::Builder,
         body: Vec<u8>,
     ) -> Result<HttpResponse<Bytes>, ApiError<Self::Error>> {
         use futures_util::TryFutureExt;
         let call = || async {
+            if let Some(auth) = &self.auth {
+                auth.set_header(request.headers_mut().unwrap())?;
+            }
             let http_request = request.body(body)?;
             let request = http_request.try_into()?;
 

openstack_sdk/src/test/client.rs

@@ -42,3 +42,14 @@ chrono = { workspace= true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 structable = { workspace = true }
+
+[dev-dependencies]
+openstack_sdk = { path = "../openstack_sdk" }
+reqwest.workspace = true
+tokio.workspace = true
+url.workspace = true
+
+[[test]]
+name = "mocked"
+path = "tests/mocked/main.rs"
+test = false

openstack_types/Cargo.toml

@@ -0,0 +1,15 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+mod v3;

openstack_types/tests/mocked/block_storage/mod.rs

@@ -0,0 +1,15 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+mod response;

openstack_types/tests/mocked/block_storage/v3/attachment/mod.rs

@@ -0,0 +1,30 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+use openstack_sdk::api::block_storage::v3::attachment::list::Request;
+use openstack_sdk::api::{paged, Pagination, QueryAsync};
+use openstack_types::block_storage::v3::attachment::response::list::AttachmentResponse;
+
+use crate::get_client;
+
+#[tokio::test]
+async fn deserialize() -> Result<(), Box<dyn std::error::Error>> {
+    let client = get_client("block-storage");
+
+    let _res: Vec<AttachmentResponse> = paged(Request::builder().build()?, Pagination::Limit(10))
+        .query_async(&client)
+        .await?;
+
+    Ok(())
+}

openstack_types/tests/mocked/block_storage/v3/attachment/response/list.rs

@@ -0,0 +1,30 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+use openstack_sdk::api::block_storage::v3::attachment::list_detailed::Request;
+use openstack_sdk::api::{paged, Pagination, QueryAsync};
+use openstack_types::block_storage::v3::attachment::response::list_detailed::AttachmentResponse;
+
+use crate::get_client;
+
+#[tokio::test]
+async fn deserialize() -> Result<(), Box<dyn std::error::Error>> {
+    let client = get_client("block-storage");
+
+    let _res: Vec<AttachmentResponse> = paged(Request::builder().build()?, Pagination::Limit(10))
+        .query_async(&client)
+        .await?;
+
+    Ok(())
+}