[Rust/Rust Server] Fix example/test code (OpenAPITools#19318)

* [Rust Server] Fix code so examples compile Zero length arrays don't correctly type infer, so if we have no scopes, we need to not create a empty array We need an authentication middleware - without it the code doesn't compile. * Update samples * [Rust Server] Remove trailing whitespace * Update samples * [Rust Server] [CI] Build all targets * [Rust] Fix reqwest test
sverrevalskraa · Aug 9, 2024 · ad7acc3 · ad7acc3
1 parent 4b49335
commit ad7acc3
Show file tree

Hide file tree

Showing 28 changed files with 347 additions and 341 deletions.
diff --git a/.github/workflows/samples-rust.yaml b/.github/workflows/samples-rust.yaml
@@ -34,4 +34,4 @@ jobs:
           toolchain: stable
       - name: Build
         working-directory: ${{ matrix.sample }}
-        run: cargo build
+        run: cargo build --all-targets
diff --git a/...openapi-generator/src/main/java/org/openapitools/codegen/languages/RustServerCodegen.java b/...openapi-generator/src/main/java/org/openapitools/codegen/languages/RustServerCodegen.java
@@ -26,6 +26,7 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
+import io.swagger.v3.oas.models.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
 import joptsimple.internal.Strings;
 import lombok.Setter;
@@ -1108,6 +1109,20 @@ public Map<String, Object> postProcessSupportingFileData(Map<String, Object> bun
             bundle.put("callbacks", callbackData);
         }
 
+        // Flag whether we have any OAuth scopes
+        Map<String, SecurityScheme> securitySchemeMap = openAPI.getComponents() != null ? openAPI.getComponents().getSecuritySchemes() : null;
+        List<CodegenSecurity> authMethods = fromSecurity(securitySchemeMap);
+        boolean hasAuthScopes = false;
+        if (authMethods != null && !authMethods.isEmpty()) {
+            for (CodegenSecurity authMethod : authMethods) {
+                if (authMethod.hasScopes != null && authMethod.hasScopes) {
+                    hasAuthScopes = true;
+                    break;
+                }
+            }
+        }
+        bundle.put("hasAuthScopes", hasAuthScopes);
+
         return super.postProcessSupportingFileData(bundle);
     }
 

diff --git a/modules/openapi-generator/src/main/resources/rust-server/example-client-main.mustache b/modules/openapi-generator/src/main/resources/rust-server/example-client-main.mustache
@@ -51,7 +51,7 @@ fn main() {
       {{#operation}}
         {{#vendorExtensions}}
           {{^x-no-client-example}}
-                "{{{operationId}}}", 
+                "{{{operationId}}}",
           {{/x-no-client-example}}
         {{/vendorExtensions}}
       {{/operation}}
@@ -80,24 +80,29 @@ fn main() {
     // In a real (production) system this Bearer token should be obtained via an external Identity/Authentication-server
     // Ensure that you set the correct algorithm and encodingkey that matches what is used on the server side.
     // See https://github.com/Keats/jsonwebtoken for more information
-
     let auth_token = build_token(
             Claims {
-                sub: "tester@acme.com".to_owned(), 
+                sub: "tester@acme.com".to_owned(),
                 company: "ACME".to_owned(),
                 iss: "my_identity_provider".to_owned(),
                 // added a very long expiry time
                 aud: "org.acme.Resource_Server".to_string(),
                 exp: 10000000000,
                 // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
-                scopes: [
-                  {{#authMethods}}
-                   {{#scopes}}
+                scopes:
+                {{#hasAuthScopes}}
+                  [
+                    {{#authMethods}}
+                      {{#scopes}}
                             "{{{scope}}}",
-                   {{/scopes}}
-                  {{/authMethods}}
-                ].join(", ")
-            }, 
+                      {{/scopes}}
+                    {{/authMethods}}
+                  ].join::<&str>(", ")
+                {{/hasAuthScopes}}
+                {{^hasAuthScopes}}
+                  "".to_owned()
+                {{/hasAuthScopes}}
+            },
             b"secret").unwrap();
 
     let auth_data = if !auth_token.is_empty() {

diff --git a/modules/openapi-generator/src/main/resources/rust-server/example-server-auth.mustache b/modules/openapi-generator/src/main/resources/rust-server/example-server-auth.mustache
@@ -1,7 +1,7 @@
 use swagger::{
     ApiError,
     auth::{Basic, Bearer},
-    Has, 
+    Has,
     XSpanIdString};
 use {{{externCrateName}}}::{AuthenticationApi, Claims};
 use crate::server::Server;
@@ -15,29 +15,35 @@ use log::{error, debug};
 
 /// Get a dummy claim with full permissions (all scopes) for testing purposes
 fn full_permission_claim() -> Claims {
-        Claims {
-            sub: "tester@acme.com".to_owned(), 
-            company: "ACME".to_owned(),
-            iss: "mini-bank-IDP".to_owned(),
-            aud: "org.acme.Resource_Server".to_string(),
-            // added a very long expiry time
-            exp: 10000000000,
-            // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
-            scopes: [
-                {{#authMethods}}
-                {{#scopes}}
-                        "{{{scope}}}",
-                {{/scopes}}
-                {{/authMethods}}
-            ].join(", ")
-        }
+    // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
+    Claims {
+        sub: "tester@acme.com".to_owned(),
+        company: "ACME".to_owned(),
+        iss: "mini-bank-IDP".to_owned(),
+        aud: "org.acme.Resource_Server".to_string(),
+        // added a very long expiry time
+        exp: 10000000000,
+        scopes:
+        {{#hasAuthScopes}}
+          [
+            {{#authMethods}}
+              {{#scopes}}
+                    "{{{scope}}}",
+              {{/scopes}}
+            {{/authMethods}}
+          ].join::<&str>(", ")
+        {{/hasAuthScopes}}
+        {{^hasAuthScopes}}
+          "".to_owned()
+        {{/hasAuthScopes}}
+    }
 }
 
 
 
-/// Extract the data from a Bearer token using the provided Key (secret) and using the HS512-algorithm in this example. 
+/// Extract the data from a Bearer token using the provided Key (secret) and using the HS512-algorithm in this example.
 fn extract_token_data(token: &str, key: &[u8]) -> Result<TokenData<Claims>, JwtError::Error> {
-    
+
     // Ensure that you set the correct algorithm and correct key.
     // See https://github.com/Keats/jsonwebtoken for more information.
     let header = decode_header(token)?;
@@ -68,8 +74,8 @@ fn build_authorization(claims: Claims) -> Authorization {
     let scopes = swagger::auth::Scopes::Some(scopes);
 
     Authorization{
-        subject: claims.sub, 
-        scopes, 
+        subject: claims.sub,
+        scopes,
         issuer: Some(claims.iss)}
 }
 
@@ -110,23 +116,23 @@ impl<C> AuthenticationApi for Server<C> where C: Has<XSpanIdString> + Send + Syn
     fn apikey_authorization(&self, api_key: &str) -> Result<Authorization, ApiError> {
         debug!("\tAuthorizationApi: Received api-key, {api_key:#?}");
 
-        // TODO: insert the logic to map received apikey to the set of claims 
+        // TODO: insert the logic to map received apikey to the set of claims
         let claims = full_permission_claim();
 
         // and build an authorization out of it
         Ok(build_authorization(claims))
     }
-    
+
     /// Implementation of the method to map a basic authentication (username and password) to an Authorization
     fn basic_authorization(&self, basic: &Basic) -> Result<Authorization, ApiError> {
         debug!("\tAuthorizationApi: Received Basic-token, {basic:#?}");
 
-        // TODO: insert the logic to map received apikey to the set of claims 
+        // TODO: insert the logic to map received apikey to the set of claims
         let claims = full_permission_claim();
 
         // and build an authorization out of it
         Ok(build_authorization(claims))
     }
 
-} 
+}
 
diff --git a/modules/openapi-generator/src/main/resources/rust-server/example-server-common.mustache b/modules/openapi-generator/src/main/resources/rust-server/example-server-common.mustache
@@ -30,9 +30,7 @@ pub async fn create(addr: &str, https: bool) {
 
     let service = MakeService::new(server);
 
-    // This pushes a fourth layer of the middleware-stack even though Swagger assumes only three levels.
-    // This fourth layer creates an accept-all policy, hower the example-code already acchieves the same via a Bearer-token with full permissions, so next line is not needed (anymore).  
-    // let service = MakeAllowAllAuthenticator::new(service, "cosmo");
+    let service = MakeAllowAllAuthenticator::new(service, "cosmo");
 
     #[allow(unused_mut)]
     let mut service =

diff --git a/samples/client/petstore/rust/reqwest/petstore/tests/type_testing.rs b/samples/client/petstore/rust/reqwest/petstore/tests/type_testing.rs
@@ -12,7 +12,8 @@ fn test_types() {
         double: 45.56,
         string: String::from("something"),
         boolean: true,
-        uuid: Uuid::new_v4()
+        uuid: Uuid::new_v4(),
+        bytes: vec![1,2,3,4]
     };
     assert_eq!(type_of(tt.int32), "i32");
     assert_eq!(type_of(tt.int64), "i64");

diff --git a/samples/server/petstore/rust-server/output/multipart-v3/examples/client/main.rs b/samples/server/petstore/rust-server/output/multipart-v3/examples/client/main.rs
@@ -36,9 +36,9 @@ fn main() {
         .arg(Arg::with_name("operation")
             .help("Sets the operation to run")
             .possible_values(&[
-                "MultipartRelatedRequestPost", 
-                "MultipartRequestPost", 
-                "MultipleIdenticalMimeTypesPost", 
+                "MultipartRelatedRequestPost",
+                "MultipartRequestPost",
+                "MultipleIdenticalMimeTypesPost",
             ])
             .required(true)
             .index(1))
@@ -61,19 +61,18 @@ fn main() {
     // In a real (production) system this Bearer token should be obtained via an external Identity/Authentication-server
     // Ensure that you set the correct algorithm and encodingkey that matches what is used on the server side.
     // See https://github.com/Keats/jsonwebtoken for more information
-
     let auth_token = build_token(
             Claims {
-                sub: "tester@acme.com".to_owned(), 
+                sub: "tester@acme.com".to_owned(),
                 company: "ACME".to_owned(),
                 iss: "my_identity_provider".to_owned(),
                 // added a very long expiry time
                 aud: "org.acme.Resource_Server".to_string(),
                 exp: 10000000000,
                 // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
-                scopes: [
-                ].join(", ")
-            }, 
+                scopes:
+                  "".to_owned()
+            },
             b"secret").unwrap();
 
     let auth_data = if !auth_token.is_empty() {

diff --git a/samples/server/petstore/rust-server/output/multipart-v3/examples/server/server.rs b/samples/server/petstore/rust-server/output/multipart-v3/examples/server/server.rs
@@ -30,9 +30,7 @@ pub async fn create(addr: &str, https: bool) {
 
     let service = MakeService::new(server);
 
-    // This pushes a fourth layer of the middleware-stack even though Swagger assumes only three levels.
-    // This fourth layer creates an accept-all policy, hower the example-code already acchieves the same via a Bearer-token with full permissions, so next line is not needed (anymore).  
-    // let service = MakeAllowAllAuthenticator::new(service, "cosmo");
+    let service = MakeAllowAllAuthenticator::new(service, "cosmo");
 
     #[allow(unused_mut)]
     let mut service =

diff --git a/samples/server/petstore/rust-server/output/multipart-v3/examples/server/server_auth.rs b/samples/server/petstore/rust-server/output/multipart-v3/examples/server/server_auth.rs
@@ -1,7 +1,7 @@
 use swagger::{
     ApiError,
     auth::{Basic, Bearer},
-    Has, 
+    Has,
     XSpanIdString};
 use multipart_v3::{AuthenticationApi, Claims};
 use crate::server::Server;
@@ -15,24 +15,24 @@ use log::{error, debug};
 
 /// Get a dummy claim with full permissions (all scopes) for testing purposes
 fn full_permission_claim() -> Claims {
-        Claims {
-            sub: "tester@acme.com".to_owned(), 
-            company: "ACME".to_owned(),
-            iss: "mini-bank-IDP".to_owned(),
-            aud: "org.acme.Resource_Server".to_string(),
-            // added a very long expiry time
-            exp: 10000000000,
-            // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
-            scopes: [
-            ].join(", ")
-        }
+    // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
+    Claims {
+        sub: "tester@acme.com".to_owned(),
+        company: "ACME".to_owned(),
+        iss: "mini-bank-IDP".to_owned(),
+        aud: "org.acme.Resource_Server".to_string(),
+        // added a very long expiry time
+        exp: 10000000000,
+        scopes:
+          "".to_owned()
+    }
 }
 
 
 
-/// Extract the data from a Bearer token using the provided Key (secret) and using the HS512-algorithm in this example. 
+/// Extract the data from a Bearer token using the provided Key (secret) and using the HS512-algorithm in this example.
 fn extract_token_data(token: &str, key: &[u8]) -> Result<TokenData<Claims>, JwtError::Error> {
-    
+
     // Ensure that you set the correct algorithm and correct key.
     // See https://github.com/Keats/jsonwebtoken for more information.
     let header = decode_header(token)?;
@@ -63,8 +63,8 @@ fn build_authorization(claims: Claims) -> Authorization {
     let scopes = swagger::auth::Scopes::Some(scopes);
 
     Authorization{
-        subject: claims.sub, 
-        scopes, 
+        subject: claims.sub,
+        scopes,
         issuer: Some(claims.iss)}
 }
 
@@ -105,23 +105,23 @@ impl<C> AuthenticationApi for Server<C> where C: Has<XSpanIdString> + Send + Syn
     fn apikey_authorization(&self, api_key: &str) -> Result<Authorization, ApiError> {
         debug!("\tAuthorizationApi: Received api-key, {api_key:#?}");
 
-        // TODO: insert the logic to map received apikey to the set of claims 
+        // TODO: insert the logic to map received apikey to the set of claims
         let claims = full_permission_claim();
 
         // and build an authorization out of it
         Ok(build_authorization(claims))
     }
-    
+
     /// Implementation of the method to map a basic authentication (username and password) to an Authorization
     fn basic_authorization(&self, basic: &Basic) -> Result<Authorization, ApiError> {
         debug!("\tAuthorizationApi: Received Basic-token, {basic:#?}");
 
-        // TODO: insert the logic to map received apikey to the set of claims 
+        // TODO: insert the logic to map received apikey to the set of claims
         let claims = full_permission_claim();
 
         // and build an authorization out of it
         Ok(build_authorization(claims))
     }
 
-} 
+}
 
diff --git a/samples/server/petstore/rust-server/output/no-example-v3/examples/client/main.rs b/samples/server/petstore/rust-server/output/no-example-v3/examples/client/main.rs
@@ -56,19 +56,18 @@ fn main() {
     // In a real (production) system this Bearer token should be obtained via an external Identity/Authentication-server
     // Ensure that you set the correct algorithm and encodingkey that matches what is used on the server side.
     // See https://github.com/Keats/jsonwebtoken for more information
-
     let auth_token = build_token(
             Claims {
-                sub: "tester@acme.com".to_owned(), 
+                sub: "tester@acme.com".to_owned(),
                 company: "ACME".to_owned(),
                 iss: "my_identity_provider".to_owned(),
                 // added a very long expiry time
                 aud: "org.acme.Resource_Server".to_string(),
                 exp: 10000000000,
                 // In this example code all available Scopes are added, so the current Bearer Token gets fully authorization.
-                scopes: [
-                ].join(", ")
-            }, 
+                scopes:
+                  "".to_owned()
+            },
             b"secret").unwrap();
 
     let auth_data = if !auth_token.is_empty() {

diff --git a/samples/server/petstore/rust-server/output/no-example-v3/examples/server/server.rs b/samples/server/petstore/rust-server/output/no-example-v3/examples/server/server.rs
@@ -30,9 +30,7 @@ pub async fn create(addr: &str, https: bool) {
 
     let service = MakeService::new(server);
 
-    // This pushes a fourth layer of the middleware-stack even though Swagger assumes only three levels.
-    // This fourth layer creates an accept-all policy, hower the example-code already acchieves the same via a Bearer-token with full permissions, so next line is not needed (anymore).  
-    // let service = MakeAllowAllAuthenticator::new(service, "cosmo");
+    let service = MakeAllowAllAuthenticator::new(service, "cosmo");
 
     #[allow(unused_mut)]
     let mut service =