Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
import org.openapitools.codegen.meta.features.*;
import org.openapitools.codegen.model.ModelMap;
import org.openapitools.codegen.model.ModelsMap;
import org.openapitools.codegen.model.OperationMap;
import org.openapitools.codegen.model.OperationsMap;
import org.openapitools.codegen.model.WebhooksMap;
import org.openapitools.codegen.utils.ModelUtils;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand Down Expand Up @@ -742,6 +745,41 @@ public void postProcessEmitDefaultValue(Map<String, Object> vendorExtensions) {
vendorExtensions.put("x-emit-default-value", optionalEmitDefaultValuesFlag);
}

@Override
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
objs = super.postProcessOperationsWithModels(objs, allModels);
if (!GENERICHOST.equals(getLibrary()) || objs == null) {
return objs;
}
putTokenProviderFlags(objs.getOperations());
return objs;
}

@Override
public WebhooksMap postProcessWebhooksWithModels(WebhooksMap objs, List<ModelMap> allModels) {
objs = super.postProcessWebhooksWithModels(objs, allModels);
if (!GENERICHOST.equals(getLibrary()) || objs == null) {
return objs;
}
putTokenProviderFlags(objs.getWebhooks());
return objs;
}

private void putTokenProviderFlags(OperationMap operations) {
if (operations == null) {
return;
}
List<List<CodegenSecurity>> authMethods = operations.getOperation().stream()
.map(operation -> operation.authMethods)
.filter(Objects::nonNull)
.collect(Collectors.toList());
operations.put("classHasApiKeyMethods", authMethods.stream().anyMatch(ProcessUtils::hasApiKeyMethods));
operations.put("classHasHttpBearerMethods", authMethods.stream().anyMatch(ProcessUtils::hasHttpBearerMethods));
operations.put("classHasHttpBasicMethods", authMethods.stream().anyMatch(ProcessUtils::hasHttpBasicMethods));
operations.put("classHasHttpSignatureMethods", authMethods.stream().anyMatch(ProcessUtils::hasHttpSignatureMethods));
operations.put("classHasOAuthMethods", authMethods.stream().anyMatch(ProcessUtils::hasOAuthMethods));
}

@Override
public Mustache.Compiler processCompiler(Mustache.Compiler compiler) {
// To avoid unexpected behaviors when options are passed programmatically such as { "supportsAsync": "" }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,32 +179,32 @@ namespace {{packageName}}.{{apiPackage}}
/// <summary>
/// The class containing the events
/// </summary>
public {{classname}}Events Events { get; }{{#hasApiKeyMethods}}
public {{classname}}Events Events { get; }{{#classHasApiKeyMethods}}

/// <summary>
/// A token provider of type <see cref="ApiKeyProvider"/>
/// </summary>
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }{{/hasApiKeyMethods}}{{#hasHttpBearerMethods}}
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }{{/classHasApiKeyMethods}}{{#classHasHttpBearerMethods}}

/// <summary>
/// A token provider of type <see cref="BearerToken"/>
/// </summary>
public TokenProvider<BearerToken> BearerTokenProvider { get; }{{/hasHttpBearerMethods}}{{#hasHttpBasicMethods}}
public TokenProvider<BearerToken> BearerTokenProvider { get; }{{/classHasHttpBearerMethods}}{{#classHasHttpBasicMethods}}

/// <summary>
/// A token provider of type <see cref="BasicTokenProvider"/>
/// </summary>
public TokenProvider<BasicToken> BasicTokenProvider { get; }{{/hasHttpBasicMethods}}{{#hasHttpSignatureMethods}}
public TokenProvider<BasicToken> BasicTokenProvider { get; }{{/classHasHttpBasicMethods}}{{#classHasHttpSignatureMethods}}

/// <summary>
/// A token provider of type <see cref="HttpSignatureTokenProvider"/>
/// </summary>
public TokenProvider<HttpSignatureToken> HttpSignatureTokenProvider { get; }{{/hasHttpSignatureMethods}}{{#hasOAuthMethods}}
public TokenProvider<HttpSignatureToken> HttpSignatureTokenProvider { get; }{{/classHasHttpSignatureMethods}}{{#classHasOAuthMethods}}

/// <summary>
/// A token provider of type <see cref="OauthTokenProvider"/>
/// </summary>
public TokenProvider<OAuthToken> OauthTokenProvider { get; }{{/hasOAuthMethods}}
public TokenProvider<OAuthToken> OauthTokenProvider { get; }{{/classHasOAuthMethods}}

{{#net80OrLater}}
{{#lambda.unique}}
Expand All @@ -223,23 +223,23 @@ namespace {{packageName}}.{{apiPackage}}
/// Initializes a new instance of the <see cref="{{classname}}"/> class.
/// </summary>
/// <returns></returns>
public {{classname}}(ILogger<{{classname}}> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, {{classname}}Events {{#lambda.camelcase_sanitize_param}}{{classname}}Events{{/lambda.camelcase_sanitize_param}}{{#hasApiKeyMethods}},
TokenProvider<ApiKeyToken> apiKeyProvider{{/hasApiKeyMethods}}{{#hasHttpBearerMethods}},
TokenProvider<BearerToken> bearerTokenProvider{{/hasHttpBearerMethods}}{{#hasHttpBasicMethods}},
TokenProvider<BasicToken> basicTokenProvider{{/hasHttpBasicMethods}}{{#hasHttpSignatureMethods}},
TokenProvider<HttpSignatureToken> httpSignatureTokenProvider{{/hasHttpSignatureMethods}}{{#hasOAuthMethods}},
TokenProvider<OAuthToken> oauthTokenProvider{{/hasOAuthMethods}}{{#net80OrLater}}{{#operation}}{{#lambda.uniqueLines}}{{#vendorExtensions.x-set-cookie}},
public {{classname}}(ILogger<{{classname}}> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, {{classname}}Events {{#lambda.camelcase_sanitize_param}}{{classname}}Events{{/lambda.camelcase_sanitize_param}}{{#classHasApiKeyMethods}},
TokenProvider<ApiKeyToken> apiKeyProvider{{/classHasApiKeyMethods}}{{#classHasHttpBearerMethods}},
TokenProvider<BearerToken> bearerTokenProvider{{/classHasHttpBearerMethods}}{{#classHasHttpBasicMethods}},
TokenProvider<BasicToken> basicTokenProvider{{/classHasHttpBasicMethods}}{{#classHasHttpSignatureMethods}},
TokenProvider<HttpSignatureToken> httpSignatureTokenProvider{{/classHasHttpSignatureMethods}}{{#classHasOAuthMethods}},
TokenProvider<OAuthToken> oauthTokenProvider{{/classHasOAuthMethods}}{{#net80OrLater}}{{#operation}}{{#lambda.uniqueLines}}{{#vendorExtensions.x-set-cookie}},
{{packageName}}.{{clientPackage}}.CookieContainer cookieContainer{{/vendorExtensions.x-set-cookie}}{{/lambda.uniqueLines}}{{/operation}}{{/net80OrLater}})
{
_jsonSerializerOptions = jsonSerializerOptionsProvider.Options;
Logger = logger;
HttpClient = httpClient;
Events = {{#lambda.camelcase_sanitize_param}}{{classname}}Events{{/lambda.camelcase_sanitize_param}};{{#hasApiKeyMethods}}
ApiKeyProvider = apiKeyProvider;{{/hasApiKeyMethods}}{{#hasHttpBearerMethods}}
BearerTokenProvider = bearerTokenProvider;{{/hasHttpBearerMethods}}{{#hasHttpBasicMethods}}
BasicTokenProvider = basicTokenProvider;{{/hasHttpBasicMethods}}{{#hasHttpSignatureMethods}}
HttpSignatureTokenProvider = httpSignatureTokenProvider;{{/hasHttpSignatureMethods}}{{#hasOAuthMethods}}
OauthTokenProvider = oauthTokenProvider;{{/hasOAuthMethods}}{{#net80OrLater}}{{#operation}}{{#lambda.uniqueLines}}{{#vendorExtensions.x-set-cookie}}
Events = {{#lambda.camelcase_sanitize_param}}{{classname}}Events{{/lambda.camelcase_sanitize_param}};{{#classHasApiKeyMethods}}
ApiKeyProvider = apiKeyProvider;{{/classHasApiKeyMethods}}{{#classHasHttpBearerMethods}}
BearerTokenProvider = bearerTokenProvider;{{/classHasHttpBearerMethods}}{{#classHasHttpBasicMethods}}
BasicTokenProvider = basicTokenProvider;{{/classHasHttpBasicMethods}}{{#classHasHttpSignatureMethods}}
HttpSignatureTokenProvider = httpSignatureTokenProvider;{{/classHasHttpSignatureMethods}}{{#classHasOAuthMethods}}
OauthTokenProvider = oauthTokenProvider;{{/classHasOAuthMethods}}{{#net80OrLater}}{{#operation}}{{#lambda.uniqueLines}}{{#vendorExtensions.x-set-cookie}}
CookieContainer = cookieContainer;{{/vendorExtensions.x-set-cookie}}{{/lambda.uniqueLines}}{{/operation}}{{/net80OrLater}}
}
{{#operation}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1119,6 +1119,37 @@ public void testMapResponseWithModelValueGeneratesSystemDictionary() throws IOEx
assertFileNotContains(api.toPath(), "Model.Dictionary<");
}

@Test(description = "generichost: token providers are only injected into Api classes whose operations use the matching security scheme")
public void testGenerichostTokenProvidersBasedOnOperationsAuthMethods() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_1/csharp/issue_25575.yaml");
final DefaultGenerator defaultGenerator = new DefaultGenerator();
final ClientOptInput clientOptInput = new ClientOptInput();
clientOptInput.openAPI(openAPI);
CSharpClientCodegen cSharpClientCodegen = new CSharpClientCodegen();
cSharpClientCodegen.setLibrary("generichost");
cSharpClientCodegen.setOutputDir(output.getAbsolutePath());
cSharpClientCodegen.additionalProperties().put("packageName", "Example.Api.Sdk");
cSharpClientCodegen.additionalProperties().put("netCoreProjectFile", true);
clientOptInput.config(cSharpClientCodegen);
defaultGenerator.opts(clientOptInput);

Map<String, File> files = defaultGenerator.generate().stream()
.collect(Collectors.toMap(File::getPath, Function.identity()));
File securedApi = files.get(Paths.get(output.getAbsolutePath(), "src", "Example.Api.Sdk", "Api", "SecuredApi.cs").toString());
assertNotNull(securedApi, "Could not find generated SecuredApi.cs");
assertFileContains(securedApi.toPath(),
"public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }",
"TokenProvider<ApiKeyToken> apiKeyProvider)");

File publicApi = files.get(Paths.get(output.getAbsolutePath(), "src", "Example.Api.Sdk", "Api", "PublicApi.cs").toString());
assertNotNull(publicApi, "Could not find generated PublicApi.cs");
assertFileNotContains(publicApi.toPath(), "TokenProvider<ApiKeyToken>");
assertFileContains(publicApi.toPath(),
"public PublicApi(ILogger<PublicApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, PublicApiEvents publicApiEvents)");
}

@Test(description = "conditionalSerialization: an all-optional model's public constructor must not raise the serialization flag for value-typed properties the caller never passed")
public void testConditionalSerializationValueTypeConstructorFlags() throws IOException {
Map<String, File> files = generateConditionalSerializationValueTypeModels(true);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
openapi: 3.1.0
info:
title: issue 25575
version: "1"
security:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: This fixture only declares one security scheme, so the regression test cannot catch a bug where an Api class gets the wrong scheme's TokenProvider. Add a second scheme (for example, a bearer or OAuth2 scheme) used by a different tag, and assert that each Api class gets only its own provider. A webhook operation with its own security would also cover the webhook path.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At modules/openapi-generator/src/test/resources/3_1/csharp/issue_25575.yaml, line 5:

<comment>This fixture only declares one security scheme, so the regression test cannot catch a bug where an Api class gets the wrong scheme's TokenProvider. Add a second scheme (for example, a bearer or OAuth2 scheme) used by a different tag, and assert that each Api class gets only its own provider. A webhook operation with its own security would also cover the webhook path.</comment>

<file context>
@@ -0,0 +1,40 @@
+info:
+  title: issue 25575
+  version: "1"
+security:
+  - api_key: []
+paths:
</file context>

- api_key: []
paths:
/secured:
get:
tags:
- Secured
operationId: getSecured
security:
- api_key: []
responses:
"200":
description: ok
/inherited:
get:
tags:
- Secured
operationId: getInherited
responses:
"200":
description: ok
/public:
get:
tags:
- Public
operationId: getPublic
security: []
responses:
"200":
description: ok
components:
securitySchemes:
api_key:
type: apiKey
in: header
name: X-API-KEY
Original file line number Diff line number Diff line change
Expand Up @@ -122,23 +122,16 @@ public sealed partial class APIKEYSApi : IAPIKEYSApi
/// </summary>
public APIKEYSApiEvents Events { get; }

/// <summary>
/// A token provider of type <see cref="ApiKeyProvider"/>
/// </summary>
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }

/// <summary>
/// Initializes a new instance of the <see cref="APIKEYSApi"/> class.
/// </summary>
/// <returns></returns>
public APIKEYSApi(ILogger<APIKEYSApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, APIKEYSApiEvents aPIKEYSApiEvents,
TokenProvider<ApiKeyToken> apiKeyProvider)
public APIKEYSApi(ILogger<APIKEYSApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, APIKEYSApiEvents aPIKEYSApiEvents)
{
_jsonSerializerOptions = jsonSerializerOptionsProvider.Options;
Logger = logger;
HttpClient = httpClient;
Events = aPIKEYSApiEvents;
ApiKeyProvider = apiKeyProvider;
}

partial void FormatGetApiKeysId(ref int id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,23 +122,16 @@ public sealed partial class APIKeysApi : IAPIKeysApi
/// </summary>
public APIKeysApiEvents Events { get; }

/// <summary>
/// A token provider of type <see cref="ApiKeyProvider"/>
/// </summary>
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }

/// <summary>
/// Initializes a new instance of the <see cref="APIKeysApi"/> class.
/// </summary>
/// <returns></returns>
public APIKeysApi(ILogger<APIKeysApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, APIKeysApiEvents aPIKeysApiEvents,
TokenProvider<ApiKeyToken> apiKeyProvider)
public APIKeysApi(ILogger<APIKeysApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, APIKeysApiEvents aPIKeysApiEvents)
{
_jsonSerializerOptions = jsonSerializerOptionsProvider.Options;
Logger = logger;
HttpClient = httpClient;
Events = aPIKeysApiEvents;
ApiKeyProvider = apiKeyProvider;
}

partial void FormatGetApiKeysId(ref int id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,23 +122,16 @@ public sealed partial class ApiKeysApi : IApiKeysApi
/// </summary>
public ApiKeysApiEvents Events { get; }

/// <summary>
/// A token provider of type <see cref="ApiKeyProvider"/>
/// </summary>
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }

/// <summary>
/// Initializes a new instance of the <see cref="ApiKeysApi"/> class.
/// </summary>
/// <returns></returns>
public ApiKeysApi(ILogger<ApiKeysApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, ApiKeysApiEvents apiKeysApiEvents,
TokenProvider<ApiKeyToken> apiKeyProvider)
public ApiKeysApi(ILogger<ApiKeysApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, ApiKeysApiEvents apiKeysApiEvents)
{
_jsonSerializerOptions = jsonSerializerOptionsProvider.Options;
Logger = logger;
HttpClient = httpClient;
Events = apiKeysApiEvents;
ApiKeyProvider = apiKeyProvider;
}

partial void FormatGetApiKeysId(ref int id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,51 +122,16 @@ public sealed partial class AnotherFakeApi : IAnotherFakeApi
/// </summary>
public AnotherFakeApiEvents Events { get; }

/// <summary>
/// A token provider of type <see cref="ApiKeyProvider"/>
/// </summary>
public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }

/// <summary>
/// A token provider of type <see cref="BearerToken"/>
/// </summary>
public TokenProvider<BearerToken> BearerTokenProvider { get; }

/// <summary>
/// A token provider of type <see cref="BasicTokenProvider"/>
/// </summary>
public TokenProvider<BasicToken> BasicTokenProvider { get; }

/// <summary>
/// A token provider of type <see cref="HttpSignatureTokenProvider"/>
/// </summary>
public TokenProvider<HttpSignatureToken> HttpSignatureTokenProvider { get; }

/// <summary>
/// A token provider of type <see cref="OauthTokenProvider"/>
/// </summary>
public TokenProvider<OAuthToken> OauthTokenProvider { get; }

/// <summary>
/// Initializes a new instance of the <see cref="AnotherFakeApi"/> class.
/// </summary>
/// <returns></returns>
public AnotherFakeApi(ILogger<AnotherFakeApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, AnotherFakeApiEvents anotherFakeApiEvents,
TokenProvider<ApiKeyToken> apiKeyProvider,
TokenProvider<BearerToken> bearerTokenProvider,
TokenProvider<BasicToken> basicTokenProvider,
TokenProvider<HttpSignatureToken> httpSignatureTokenProvider,
TokenProvider<OAuthToken> oauthTokenProvider)
public AnotherFakeApi(ILogger<AnotherFakeApi> logger, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, AnotherFakeApiEvents anotherFakeApiEvents)
{
_jsonSerializerOptions = jsonSerializerOptionsProvider.Options;
Logger = logger;
HttpClient = httpClient;
Events = anotherFakeApiEvents;
ApiKeyProvider = apiKeyProvider;
BearerTokenProvider = bearerTokenProvider;
BasicTokenProvider = basicTokenProvider;
HttpSignatureTokenProvider = httpSignatureTokenProvider;
OauthTokenProvider = oauthTokenProvider;
}

partial void FormatCall123TestSpecialTags(ModelClient modelClient);
Expand Down
Loading
Loading