Skip to content

fix: missing imports for array of files and date-time parameters #22390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: missing imports for array of files and date-time parameters #22390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions ...openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractGoCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,13 +547,15 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
}
for (CodegenParameter param : operation.allParams) {
// import "os" if the operation uses files
if (!addedOSImport && "*os.File".equals(param.dataType)) {
if (!addedOSImport && ("*os.File".equals(param.dataType) ||
(param.items != null && "*os.File".equals(param.items.dataType)))) {
imports.add(createMapping("import", "os"));
addedOSImport = true;
}

// import "time" if the operation has a time parameter.
if (!addedTimeImport && "time.Time".equals(param.dataType)) {
if (!addedTimeImport && ("time.Time".equals(param.dataType) ||
(param.items != null && "time.Time".equals(param.items.dataType)))) {
imports.add(createMapping("import", "time"));
addedTimeImport = true;
}
Expand Down Expand Up @@ -648,13 +650,15 @@ public WebhooksMap postProcessWebhooksWithModels(WebhooksMap objs, List<ModelMap
}
for (CodegenParameter param : operation.allParams) {
// import "os" if the operation uses files
if (!addedOSImport && "*os.File".equals(param.dataType)) {
if (!addedOSImport && ("*os.File".equals(param.dataType) ||
(param.items != null && "*os.File".equals(param.items.dataType)))) {
imports.add(createMapping("import", "os"));
addedOSImport = true;
}

// import "time" if the operation has a time parameter.
if (!addedTimeImport && "time.Time".equals(param.dataType)) {
if (!addedTimeImport && ("time.Time".equals(param.dataType) ||
(param.items != null && "time.Time".equals(param.items.dataType)))) {
imports.add(createMapping("import", "time"));
addedTimeImport = true;
}
Expand Down
99 changes: 99 additions & 0 deletions ...es/openapi-generator/src/test/java/org/openapitools/codegen/go/AbstractGoCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,27 @@

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.media.*;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.parameters.RequestBody;
import org.mockito.Answers;
import org.openapitools.codegen.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.languages.AbstractGoCodegen;
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.testng.Assert;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.withSettings;

Expand Down Expand Up @@ -108,4 +120,91 @@ public void getTypeDeclarationTest() {
defaultValue = codegen.getTypeDeclaration(schema);
Assert.assertEquals(defaultValue, "map[string]interface{}");
}

@Test(description = "test that os import is added for array of binary parameters in operations")
public void testOsImportForArrayOfBinaryParametersInOperations() {
// Create OpenAPI spec with array of binary files
OpenAPI openAPI = new OpenAPI();
openAPI.setComponents(new Components());

// Create operation with array of binary parameter in request body
Operation operation = new Operation();
RequestBody requestBody = new RequestBody();
Content content = new Content();
MediaType mediaType = new MediaType();

Schema<?> arraySchema = new ArraySchema().items(
new BinarySchema()
);

ObjectSchema objectSchema = new ObjectSchema();
objectSchema.addProperty("files", arraySchema);
mediaType.setSchema(objectSchema);
content.addMediaType("multipart/form-data", mediaType);
requestBody.setContent(content);
operation.setRequestBody(requestBody);

codegen.setOpenAPI(openAPI);

// Convert to CodegenOperation
CodegenOperation codegenOperation = codegen.fromOperation("/upload", "post", operation, null);

// Create OperationsMap structure
OperationMap operationMap = new OperationMap();
operationMap.setOperation(codegenOperation);
OperationsMap operationsMap = new OperationsMap();
operationsMap.setOperation(operationMap);
operationsMap.setImports(new ArrayList<>());

// Post-process the operations
OperationsMap result = codegen.postProcessOperationsWithModels(operationsMap, Collections.emptyList());

// Assert that "os" import was added
List<Map<String, String>> imports = result.getImports();
boolean hasOsImport = imports.stream()
.anyMatch(imp -> "os".equals(imp.get("import")));

Assert.assertTrue(hasOsImport, "Expected 'os' import to be added for array of binary files");
}

@Test(description = "test that time import is added for array of date-time parameters in operations")
public void testTimeImportForArrayOfDateTimeParametersInOperations() {
// Create OpenAPI spec with array of date-time parameter
OpenAPI openAPI = new OpenAPI();
openAPI.setComponents(new Components());

Operation operation = new Operation();
Parameter parameter = new Parameter();
parameter.setName("timestamps");
parameter.setIn("query");

ArraySchema arraySchema = new ArraySchema();
DateTimeSchema dateTimeSchema = new DateTimeSchema();
arraySchema.setItems(dateTimeSchema);
parameter.setSchema(arraySchema);

operation.addParametersItem(parameter);

codegen.setOpenAPI(openAPI);

// Convert to CodegenOperation
CodegenOperation codegenOperation = codegen.fromOperation("/events", "get", operation, null);

// Create OperationsMap structure
OperationMap operationMap = new OperationMap();
operationMap.setOperation(codegenOperation);
OperationsMap operationsMap = new OperationsMap();
operationsMap.setOperation(operationMap);
operationsMap.setImports(new ArrayList<>());

// Post-process the operations
OperationsMap result = codegen.postProcessOperationsWithModels(operationsMap, Collections.emptyList());

// Assert that "time" import was added
List<Map<String, String>> imports = result.getImports();
boolean hasTimeImport = imports.stream()
.anyMatch(imp -> "time".equals(imp.get("import")));

Assert.assertTrue(hasTimeImport, "Expected 'time' import to be added for array of date-time parameters");
}
}