org.openapitools.codegen.DryRunTemplateManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.9.0
package org.openapitools.codegen;

import org.openapitools.codegen.api.TemplateProcessor;
import org.openapitools.codegen.templating.TemplateManagerOptions;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * Manages templates for a generator "dry run"
 */
public class DryRunTemplateManager implements TemplateProcessor {
    private final TemplateManagerOptions options;
    private final Map dryRunStatusMap = new HashMap<>();
    
    private final Map> capturedTemplateData = new HashMap<>();
    private boolean recordTemplateData = false;

    /**
     * Constructs a new instance of {@link DryRunTemplateManager} for the provided options
     *
     * @param options Options pertaining to templates (reads and writes)
     */
    public DryRunTemplateManager(TemplateManagerOptions options) {
        this.options = options;
    }

    /**
     * Gets the full status of this dry run.
     *
     * @return An immutable copy of the dry run status.
     */
    public Map getDryRunStatusMap() {
        return Collections.unmodifiableMap(dryRunStatusMap);
    }

    /**
     * Writes data to a compiled template
     *
     * @param data     Input data
     * @param template Input template location
     * @param target   The targeted file output location
     * @return The actual file
     */
    @Override
    public File write(Map data, String template, File target) throws IOException {
        if (recordTemplateData) {
            this.capturedTemplateData.put(target.getAbsolutePath(), data);
        }
        return writeToFile(target.getAbsolutePath(), "dummy".getBytes(StandardCharsets.UTF_8));
    }

    @Override
    public File writeToFile(String filename, byte[] contents) throws IOException {
        final Path path = Paths.get(filename);
        final File outputFile = path.toFile();
        DryRunStatus status = new DryRunStatus(path);

        if (outputFile.exists()) {
            if (this.options.isSkipOverwrite()) {
                status = new DryRunStatus(
                    path,
                    DryRunStatus.State.SkippedOverwrite,
                    "File exists and skip overwrite option is enabled."
                );
            } else if (this.options.isMinimalUpdate()) {
                status.setState(DryRunStatus.State.WriteIfNewer);
            } else {
                status.setState(DryRunStatus.State.Write);
            }
        } else if (this.options.isMinimalUpdate()) {
            status.setState(DryRunStatus.State.WriteIfNewer);
        } else {
            status.setState(DryRunStatus.State.Write);
        }
        dryRunStatusMap.put(filename, status);

        return outputFile;
    }

    @Override
    public void ignore(Path path, String context) {
        dryRunStatusMap.put(path.toString(),
                new DryRunStatus(
                        path,
                        DryRunStatus.State.Ignored,
                        context
                ));
    }

    @Override
    public void skip(Path path, String context) {
        final DryRunStatus status = new DryRunStatus(path, DryRunStatus.State.Skipped, context);
        if (this.options.isSkipOverwrite() && path.toFile().exists()) {
            status.setState(DryRunStatus.State.SkippedOverwrite);
        }
        dryRunStatusMap.put(path.toString(), status);
    }

    @Override
    public void error(Path path, String context) {
        dryRunStatusMap.put(path.toString(), new DryRunStatus(path, DryRunStatus.State.Error, context));
    }

    /**
     * Enable capturing of data being passed to the files as they are being written.

     * Call this method before calling {@link Generator#generate()}.
     */
    public DryRunTemplateManager enableTemplateDataCapturing() {
        recordTemplateData = true;
        return this;
    }

    /**
     * Retrieve the captured template data for a specific file. Capturing must have  
     * been enabled via {@link #enableTemplateDataCapturing()} prior to generation.

     * Note: Not all files have template data (e.g. Metadata files) – in such case an empty
     * map is returned.
     * @param generatedFile An absolute path to the generated file
     * @return Typically one of the *Map types found in {@link org.openapitools.codegen.model}
     */
    public Map getCapturedTemplateData(Path generatedFile) {
        return capturedTemplateData.getOrDefault(generatedFile.toString(), Map.of());
    }
}