Remove deprecated MockDefaultGenerator (OpenAPITools#18857)

* Make DryRunStatus path field final

* Add templateData capture functionality to DryRunTemplateManager

* Replace MockDefaultGenerator with DryRunTemplateManager captures

* Remove MockDefaultGenerator

Author: Philzen

modules/openapi-generator/src/main/java/org/openapitools/codegen/DryRunStatus.java

@@ -16,7 +16,7 @@
      *
      * @return a {@link Path} instance
      */
-    private Path path;
+    private final Path path;
     /**
      * -- GETTER --
      *  Gets the 

modules/openapi-generator/src/main/java/org/openapitools/codegen/DryRunTemplateManager.java

@@ -18,6 +18,9 @@
 public class DryRunTemplateManager implements TemplateProcessor {
     private final TemplateManagerOptions options;
     private final Map<String, DryRunStatus> dryRunStatusMap = new HashMap<>();
+    
+    private final Map<String, Map<String, Object>> capturedTemplateData = new HashMap<>();
+    private boolean recordTemplateData = false;
 
     /**
      * Constructs a new instance of {@link DryRunTemplateManager} for the provided options
@@ -47,6 +50,9 @@ public Map<String, DryRunStatus> getDryRunStatusMap() {
      */
     @Override
     public File write(Map<String, Object> data, String template, File target) throws IOException {
+        if (recordTemplateData) {
+            this.capturedTemplateData.put(target.getAbsolutePath(), data);
+        }
         return writeToFile(target.getAbsolutePath(), "dummy".getBytes(StandardCharsets.UTF_8));
     }
 
@@ -101,4 +107,25 @@ public void skip(Path path, String context) {
     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.<br>
+     * Call this method <b><u>before</u></b> 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.<br>
+     * 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<String, Object> getCapturedTemplateData(Path generatedFile) {
+        return capturedTemplateData.getOrDefault(generatedFile.toString(), Map.of());
+    }
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/MockDefaultGenerator.java

@@ -15,12 +15,10 @@
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.servers.Server;
 import io.swagger.v3.parser.core.models.ParseOptions;
-import org.openapitools.codegen.MockDefaultGenerator.WrittenTemplateBasedFile;
 import org.openapitools.codegen.java.assertions.JavaFileAssert;
 import org.openapitools.codegen.model.ModelMap;
 import org.openapitools.codegen.model.ModelsMap;
 import org.openapitools.codegen.utils.ModelUtils;
-import org.testng.Assert;
 
 import java.io.File;
 import java.io.IOException;
@@ -95,24 +93,6 @@ public static OpenAPI createOpenAPIWithOneSchema(String name, Schema<?> schema)
         return openAPI;
     }
 
-    /**
-     * Extract file from {@link MockDefaultGenerator}
-     *
-     * @param generator Generator
-     * @param root root path
-     * @param filename filename under root
-     *
-     * @return a {@link WrittenTemplateBasedFile}
-     * @deprecated Since 5.0. Please avoid this method and usage of {@link MockDefaultGenerator}, prefer {@link DefaultGenerator#DefaultGenerator(Boolean)} with dryRun=true.
-     */
-    @Deprecated
-    public static WrittenTemplateBasedFile getTemplateBasedFile(MockDefaultGenerator generator, File root, String filename) {
-        String defaultApiFilename = new File(root, filename).getAbsolutePath().replace("\\", "/");
-        Optional<WrittenTemplateBasedFile> optional = generator.getTemplateBasedFiles().stream().filter(f -> defaultApiFilename.equals(f.getOutputFilename())).findFirst();
-        Assert.assertTrue(optional.isPresent());
-        return optional.get();
-    }
-
     public static void ensureContainsFile(List<File> generatedFiles, File root, String filename) {
         Path path = root.toPath().resolve(filename);
         assertTrue(generatedFiles.contains(path.toFile()), "File '" + path.toAbsolutePath() + "' was not found in the list of generated files");