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 @@ -395,12 +395,7 @@ private void generateModelTests(List<File> files, Map<String, Object> models, St
this.templateProcessor.skip(modelTestFile.toPath(), "Test files never overwrite an existing file of the same name.");
} else {
File written = processTemplateToFile(models, templateName, filename, generateModelTests, CodegenConstants.MODEL_TESTS, config.modelTestFileFolder());
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "model-test");
}
}
addGeneratedFile(files, written, "model-test");
}
} else if (dryRun) {
Path skippedPath = java.nio.file.Paths.get(filename);
Expand All @@ -416,12 +411,7 @@ private void generateModelDocumentation(List<File> files, Map<String, Object> mo
String filename = config.modelDocFileFolder() + File.separator + config.toModelDocFilename(modelName) + suffix;

File written = processTemplateToFile(models, templateName, filename, generateModelDocumentation, CodegenConstants.MODEL_DOCS);
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "model-doc");
}
}
addGeneratedFile(files, written, "model-doc");
}
}

Expand All @@ -436,12 +426,7 @@ private void generateModel(List<File> files, Map<String, Object> models, String
String filename = config.modelFilename(templateName, modelName);
written = processTemplateToFile(models, templateName, filename, generateModels, CodegenConstants.MODELS);
}
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "model");
}
}
addGeneratedFile(files, written, "model");
}
}

Expand Down Expand Up @@ -797,12 +782,7 @@ void generateApis(List<File> files, List<OperationsMap> allOperations, List<Mode
LOGGER.info("Implementation file {} is not overwritten", filename);
}
}
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api");
}
}
addGeneratedFile(files, written, "api");
}

// to generate api test files
Expand All @@ -814,25 +794,15 @@ void generateApis(List<File> files, List<OperationsMap> allOperations, List<Mode
this.templateProcessor.skip(apiTestFile.toPath(), "Test files never overwrite an existing file of the same name.");
} else {
File written = processTemplateToFile(operation, templateName, filename, generateApiTests, CodegenConstants.API_TESTS, config.apiTestFileFolder());
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api-test");
}
}
addGeneratedFile(files, written, "api-test");
}
}

// to generate api documentation files
for (String templateName : config.apiDocTemplateFiles().keySet()) {
String filename = config.apiDocFilename(templateName, tag);
File written = processTemplateToFile(operation, templateName, filename, generateApiDocumentation, CodegenConstants.API_DOCS);
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api-doc");
}
}
addGeneratedFile(files, written, "api-doc");
}

} catch (Exception e) {
Expand Down Expand Up @@ -956,12 +926,7 @@ void generateWebhooks(List<File> files, List<WebhooksMap> allWebhooks, List<Mode
LOGGER.info("Implementation file {} is not overwritten", filename);
}
}
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api");
}
}
addGeneratedFile(files, written, "api");
}

// to generate api test files
Expand All @@ -973,25 +938,15 @@ void generateWebhooks(List<File> files, List<WebhooksMap> allWebhooks, List<Mode
this.templateProcessor.skip(apiTestFile.toPath(), "Test files never overwrite an existing file of the same name.");
} else {
File written = processTemplateToFile(operation, templateName, filename, generateApiTests, CodegenConstants.API_TESTS, config.apiTestFileFolder());
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api-test");
}
}
addGeneratedFile(files, written, "api-test");
}
}

// to generate api documentation files
for (String templateName : config.apiDocTemplateFiles().keySet()) {
String filename = config.apiDocFilename(templateName, tag);
File written = processTemplateToFile(operation, templateName, filename, generateApiDocumentation, CodegenConstants.API_DOCS);
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "api-doc");
}
}
addGeneratedFile(files, written, "api-doc");
}

} catch (Exception e) {
Expand Down Expand Up @@ -1112,12 +1067,7 @@ private void generateSupportingFiles(List<File> files, Map<String, Object> bundl
}

File written = processTemplateToFile(bundle, support.getTemplateFile(), outputFilename, shouldGenerate, CodegenConstants.SUPPORTING_FILES);
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "supporting-file");
}
}
addGeneratedFile(files, written, "supporting-file");
} catch (Exception e) {
throw new RuntimeException("Could not generate supporting file '" + support + "'", e);
}
Expand All @@ -1137,12 +1087,7 @@ private void generateSupportingFiles(List<File> files, Map<String, Object> bundl
shouldGenerate = supportingFilesToGenerate.contains(openapiGeneratorIgnore);
}
File written = processTemplateToFile(bundle, openapiGeneratorIgnore, ignoreFileNameTarget, shouldGenerate, CodegenConstants.SUPPORTING_FILES);
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, "openapi-generator-ignore");
}
}
addGeneratedFile(files, written, "openapi-generator-ignore");
} catch (Exception e) {
throw new RuntimeException("Could not generate supporting file '" + ignoreFileNameTarget + "'", e);
}
Expand Down Expand Up @@ -1444,6 +1389,22 @@ private void processUserDefinedTemplates() {
}
}

/**
* Tracks a generated file and post-processes it if enabled (never on a dry run).
*
* @param files The list tracking generated files
* @param written The file that was written, or null if no file was written
* @param fileType The file type passed to {@link CodegenConfig#postProcessFile(File, String)}
*/
private void addGeneratedFile(List<File> files, File written, String fileType) {
if (written != null) {
files.add(written);
if (config.isEnablePostProcessFile() && !dryRun) {
config.postProcessFile(written, fileType);
}
}
}

protected File processTemplateToFile(Map<String, Object> templateData, String templateName, String outputFilename, boolean shouldGenerate, String skippedByOption) throws IOException {
return processTemplateToFile(templateData, templateName, outputFilename, shouldGenerate, skippedByOption, this.config.getOutputDir());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@
import java.nio.file.StandardOpenOption;
import java.util.*;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;

Expand Down Expand Up @@ -79,6 +84,57 @@ public void testPostProcessRunsWhenQuietIsDisabled() throws IOException {
}
}

@Test
public void testPostProcessFileReceivesFileTypes() throws IOException {
Path target = Files.createTempDirectory("test");
File output = target.toFile();
try {
ClientOptInput clientOptInput = new CodegenConfigurator()
.setGeneratorName("java")
.setInputSpec("src/test/resources/3_0/petstore.yaml")
.setOutputDir(target.toAbsolutePath().toString())
.setEnablePostProcessFile(true)
.toClientOptInput();

CodegenConfig configSpy = spy(clientOptInput.getConfig());
doNothing().when(configSpy).postProcessFile(any(), any());
clientOptInput.config(configSpy);

DefaultGenerator generator = new DefaultGenerator();
generator.opts(clientOptInput).generate();

verify(configSpy).postProcessFile(argThat(f -> f.getName().equals("Pet.java")), eq("model"));
verify(configSpy).postProcessFile(argThat(f -> f.getName().equals("PetApi.java")), eq("api"));
verify(configSpy).postProcessFile(argThat(f -> f.getName().equals("pom.xml")), eq("supporting-file"));
} finally {
output.deleteOnExit();
}
}

@Test
public void testPostProcessFileIsNotCalledOnDryRun() throws IOException {
Path target = Files.createTempDirectory("test");
File output = target.toFile();
try {
ClientOptInput clientOptInput = new CodegenConfigurator()
.setGeneratorName("java")
.setInputSpec("src/test/resources/3_0/pingSomeObj.yaml")
.setOutputDir(target.toAbsolutePath().toString())
.setEnablePostProcessFile(true)
.toClientOptInput();

CodegenConfig configSpy = spy(clientOptInput.getConfig());
clientOptInput.config(configSpy);

DefaultGenerator generator = new DefaultGenerator(true);
generator.opts(clientOptInput).generate();

verify(configSpy, never()).postProcessFile(any(), any());
} finally {
output.deleteOnExit();
}
}

@Test
public void testIgnoreFileProcessing() throws IOException {
Path target = Files.createTempDirectory("test");
Expand Down
Loading