[maven-plugin] allow for ignore file override

modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/cmd/Generate.java

@@ -121,6 +121,9 @@ public class Generate implements Runnable {
     @Option(name = {"--reserved-words-mappings"}, title = "import mappings",
             description = "specifies how a reserved name should be escaped to. Otherwise, the default _<name> is used. For example id=identifier")
     private String reservedWordsMappings;
+
+    @Option(name = {"--ignore-file-override"}, title = "ignore file override location", description = CodegenConstants.IGNORE_FILE_OVERRIDE_DESC)
+    private String ignoreFileOverride;
 
     @Override
     public void run() {
@@ -215,6 +218,10 @@ public void run() {
             configurator.setHttpUserAgent(httpUserAgent);
         }
 
+        if (isNotEmpty(ignoreFileOverride)) {
+            configurator.setIgnoreFileOverride(ignoreFileOverride);
+        }
+
         applySystemPropertiesKvp(systemProperties, configurator);
         applyInstantiationTypesKvp(instantiationTypes, configurator);
         applyImportMappingsKvp(importMappings, configurator);

modules/swagger-codegen-maven-plugin/README.md

@@ -49,6 +49,7 @@ mvn clean compile
 - `useJaxbAnnotations` - enable Jaxb annotations inside the generated models
 - `configOptions` - a map of language-specific parameters (see below)
 - `configHelp` - dumps the configuration help for the specified library (generates no sources)
+- `ignoreFileOverride` - specifies the full path to a `.swagger-codegen-ignore` used for pattern based overrides of generated outputs
 
 ### Custom Generator
 

modules/swagger-codegen-maven-plugin/src/main/java/io/swagger/codegen/plugin/CodeGenMojo.java

@@ -162,6 +162,12 @@ public class CodeGenMojo extends AbstractMojo {
     @Parameter(name = "modelNameSuffix", required = false)
     private String modelNameSuffix;
 
+    /**
+     * Sets an optional ignoreFileOverride path
+     */
+    @Parameter(name = "ignoreFileOverride", required = false)
+    private String ignoreFileOverride;
+
     /**
      * A map of language-specific parameters as passed with the -c option to the command line
      */
@@ -216,6 +222,10 @@ public void execute() throws MojoExecutionException {
             configurator.setGitRepoId(gitRepoId);
         }
 
+        if(isNotEmpty(ignoreFileOverride)) {
+            configurator.setIgnoreFileOverride(ignoreFileOverride);
+        }
+
         configurator.setLang(language);
 
         configurator.setOutputDir(output.getAbsolutePath());

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConfig.java

@@ -199,5 +199,8 @@ public interface CodegenConfig {
     String getHttpUserAgent();
 
     String getCommonTemplateDir();
-
+
+    void setIgnoreFilePathOverride(String ignoreFileOverride);
+
+    String getIgnoreFilePathOverride();
 }

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConstants.java

@@ -153,4 +153,7 @@ public static enum MODEL_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case
 
     public static final String NON_PUBLIC_API = "nonPublicApi";
     public static final String NON_PUBLIC_API_DESC = "Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.";
+
+    public static final String IGNORE_FILE_OVERRIDE = "ignoreFileOverride";
+    public static final String IGNORE_FILE_OVERRIDE_DESC = "Specifies an override location for the .swagger-codegen-ignore file. Most useful on initial generation.";
 }

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java

@@ -115,6 +115,8 @@ public class DefaultCodegen {
     // Then translated back during JSON encoding and decoding
     protected Map<String, String> specialCharReplacements = new HashMap<String, String>();
 
+    protected String ignoreFilePathOverride;
+
     public List<CliOption> cliOptions() {
         return cliOptions;
     }
@@ -3454,7 +3456,26 @@ public boolean convertPropertyToBooleanAndWriteBack(String propertyKey) {
 
         return booleanValue;
     }
-
+
+    /**
+     * Provides an override location, if any is specified, for the .swagger-codegen-ignore.
+     *
+     * This is originally intended for the first generation only.
+     *
+     * @return a string of the full path to an override ignore file.
+     */
+    public String getIgnoreFilePathOverride() {
+        return ignoreFilePathOverride;
+    }
+
+    /**
+     * Sets an override location for the .swagger-codegen.ignore location for the first code generation.
+     *
+     * @param ignoreFileOverride The full path to an ignore file
+     */
+    public void setIgnoreFilePathOverride(final String ignoreFileOverride) {
+        this.ignoreFilePathOverride = ignoreFileOverride;
+    }
 
     public boolean convertPropertyToBoolean(String propertyKey) {
         boolean booleanValue = false;

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultGenerator.java

@@ -42,7 +42,21 @@ public Generator opts(ClientOptInput opts) {
         this.swagger = opts.getSwagger();
         this.config = opts.getConfig();
         this.config.additionalProperties().putAll(opts.getOpts().getProperties());
-        ignoreProcessor = new CodegenIgnoreProcessor(this.config.getOutputDir());
+
+        String ignoreFileLocation = this.config.getIgnoreFilePathOverride();
+        if(ignoreFileLocation != null) {
+            final File ignoreFile = new File(ignoreFileLocation);
+            if(ignoreFile.exists() && ignoreFile.canRead()) {
+                this.ignoreProcessor = new CodegenIgnoreProcessor(ignoreFile);
+            } else {
+                LOGGER.warn("Ignore file specified at {} is not valid. This will fall back to an existing ignore file if present in the output directory.", ignoreFileLocation);
+            }
+        }
+
+        if(this.ignoreProcessor == null) {
+            this.ignoreProcessor = new CodegenIgnoreProcessor(this.config.getOutputDir());
+        }
+
         return this;
     }
 

modules/swagger-codegen/src/main/java/io/swagger/codegen/config/CodegenConfigurator.java

@@ -54,6 +54,7 @@ public class CodegenConfigurator {
     private String artifactId;
     private String artifactVersion;
     private String library;
+    private String ignoreFileOverride;
     private Map<String, String> systemProperties = new HashMap<String, String>();
     private Map<String, String> instantiationTypes = new HashMap<String, String>();
     private Map<String, String> typeMappings = new HashMap<String, String>();
@@ -356,7 +357,16 @@ public CodegenConfigurator setReservedWordsMappings(Map<String, String> reserved
     public CodegenConfigurator addAdditionalReservedWordMapping(String key, String value) {
         this.reservedWordMappings.put(key, value);
         return this;
-    }    
+    }
+
+    public String getIgnoreFileOverride() {
+        return ignoreFileOverride;
+    }
+
+    public CodegenConfigurator setIgnoreFileOverride(final String ignoreFileOverride) {
+        this.ignoreFileOverride = ignoreFileOverride;
+        return this;
+    }
 
     public ClientOptInput toClientOptInput() {
 
@@ -371,6 +381,7 @@ public ClientOptInput toClientOptInput() {
         config.setInputSpec(inputSpec);
         config.setOutputDir(outputDir);
         config.setSkipOverwrite(skipOverwrite);
+        config.setIgnoreFilePathOverride(ignoreFileOverride);
 
         config.instantiationTypes().putAll(instantiationTypes);
         config.typeMapping().putAll(typeMappings);

modules/swagger-codegen/src/main/java/io/swagger/codegen/ignore/CodegenIgnoreProcessor.java

@@ -8,34 +8,71 @@
 
 import java.io.*;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 
+/**
+ * Presents a processing utility for parsing and evaluating files containing common ignore patterns. (.swagger-codegen-ignore)
+ */
 public class CodegenIgnoreProcessor {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(CodegenIgnoreProcessor.class);
-    private final String outputPath;
+
+    private File ignoreFile = null;
+
     private List<Rule> exclusionRules = new ArrayList<>();
     private List<Rule> inclusionRules = new ArrayList<>();
 
-    public CodegenIgnoreProcessor(String outputPath) {
-        this.outputPath = outputPath;
-        final File directory = new File(outputPath);
-        if(directory.exists() && directory.isDirectory()){
-            final File codegenIgnore = new File(directory, ".swagger-codegen-ignore");
-            if(codegenIgnore.exists() && codegenIgnore.isFile()){
-                try {
-                    loadCodegenRules(codegenIgnore);
-                } catch (IOException e) {
-                    LOGGER.error("Could not process .swagger-codegen-ignore.", e.getMessage());
-                }
-            } else {
-                // log info message
-                LOGGER.info("No .swagger-codegen-ignore file found.");
+    /**
+     * Loads the default ignore file (.swagger-codegen-ignore) from the specified path.
+     *
+     * @param baseDirectory The base directory of the files to be processed. This contains the ignore file.
+     */
+    public CodegenIgnoreProcessor(final String baseDirectory) {
+        this(baseDirectory, ".swagger-codegen-ignore");
+    }
+
+    /**
+     * Loads the specified ignore file by name ([ignoreFile]) from the specified path.
+     *
+     * @param baseDirectory The base directory of the files to be processed. This contains the ignore file.
+     * @param ignoreFile    The file containing ignore patterns.
+     */
+    @SuppressWarnings("WeakerAccess")
+    public CodegenIgnoreProcessor(final String baseDirectory, final String ignoreFile) {
+        final File directory = new File(baseDirectory);
+        final File targetIgnoreFile = new File(directory, ignoreFile);
+        if (directory.exists() && directory.isDirectory()) {
+            loadFromFile(targetIgnoreFile);
+        } else {
+            LOGGER.warn("Directory does not exist, or is inaccessible. No file will be evaluated.");
+        }
+    }
+
+    /**
+     * Constructs an instance of {@link CodegenIgnoreProcessor} from an ignore file defined by {@code targetIgnoreFile}.
+     *
+     * @param targetIgnoreFile The ignore file location.
+     */
+    public CodegenIgnoreProcessor(final File targetIgnoreFile) {
+        loadFromFile(targetIgnoreFile);
+    }
+
+    private void loadFromFile(File targetIgnoreFile) {
+        if (targetIgnoreFile.exists() && targetIgnoreFile.isFile()) {
+            try {
+                loadCodegenRules(targetIgnoreFile);
+                this.ignoreFile = targetIgnoreFile;
+            } catch (IOException e) {
+                LOGGER.error(String.format("Could not process %s.", targetIgnoreFile.getName()), e.getMessage());
             }
+        } else {
+            // log info message
+            LOGGER.info(String.format("No %s file found.", targetIgnoreFile.getName()));
         }
     }
 
-    void loadCodegenRules(File codegenIgnore) throws IOException {
+    void loadCodegenRules(final File codegenIgnore) throws IOException {
         try (BufferedReader reader = new BufferedReader(new FileReader(codegenIgnore))) {
             String line;
 
@@ -61,8 +98,17 @@ void loadCodegenRules(File codegenIgnore) throws IOException {
         }
     }
 
-    public boolean allowsFile(File targetFile) {
-        File file = new File(new File(this.outputPath).toURI().relativize(targetFile.toURI()).getPath());
+    /**
+     * Determines whether or not a file defined by {@code toEvaluate} is allowed,
+     * under the exclusion rules from the ignore file being processed.
+     *
+     * @param targetFile The file to check against exclusion rules from the ignore file.
+     * @return {@code false} if file matches any pattern in the ignore file (disallowed), otherwise {@code true} (allowed).
+     */
+    public boolean allowsFile(final File targetFile) {
+        if(this.ignoreFile == null) return true;
+
+        File file = new File(this.ignoreFile.getParentFile().toURI().relativize(targetFile.toURI()).getPath());
         Boolean directoryExcluded = false;
         Boolean exclude = false;
         if(exclusionRules.size() == 0 && inclusionRules.size() == 0) {
@@ -124,10 +170,23 @@ public boolean allowsFile(File targetFile) {
         return Boolean.FALSE.equals(exclude);
     }
 
+    /**
+     * Allows a consumer to manually inspect explicit "inclusion rules". That is, patterns in the ignore file which have been negated.
+     *
+     * @return A {@link ImmutableList#copyOf(Collection)} of rules which possibly negate exclusion rules in the ignore file.
+     */
     public List<Rule> getInclusionRules() {
         return ImmutableList.copyOf(inclusionRules);
     }
 
+    /**
+     * Allows a consumer to manually inspect all "exclusion rules". That is, patterns in the ignore file which represent
+     * files and directories to be excluded, unless explicitly overridden by {@link CodegenIgnoreProcessor#getInclusionRules()} rules.
+     *
+     * NOTE: Existence in this list doesn't mean a file is excluded. The rule can be overridden by {@link CodegenIgnoreProcessor#getInclusionRules()} rules.
+     *
+     * @return A {@link ImmutableList#copyOf(Collection)} of rules which define exclusions by patterns in the ignore file.
+     */
     public List<Rule> getExclusionRules() {
         return ImmutableList.copyOf(exclusionRules);
     }

modules/swagger-codegen/src/main/java/io/swagger/codegen/ignore/rules/Rule.java

@@ -51,6 +51,8 @@ protected String getPattern() {
      * Example: **\/*.bak excludes all backup. Adding !/test.bak will include test.bak in the project root.
      * <p>
      * NOTE: It is not possible to re-include a file if a parent directory of that file is excluded.
+     *
+     * @return {@code true} if the rule is negated (inverse), otherwise {@code false} (normal).
      */
     public Boolean getNegated() {
         return this.syntax != null && this.syntax.size() > 0 && this.syntax.get(0).getToken() == IgnoreLineParser.Token.NEGATE;

modules/swagger-codegen/src/test/java/io/swagger/codegen/config/CodegenConfiguratorTest.java

@@ -295,6 +295,8 @@ public void testFromFile() throws Exception {
 
         assertEquals(configurator.getDynamicProperties().size(), 1);
         assertValueInMap(configurator.getDynamicProperties(), CodegenConstants.LOCAL_VARIABLE_PREFIX, "_");
+
+        assertEquals(configurator.getIgnoreFileOverride(), "/path/to/override/.swagger-codegen-ignore");
     }
 
     @SuppressWarnings("unused")

modules/swagger-codegen/src/test/java/io/swagger/codegen/ruby/RubyClientCodegenTest.java

@@ -49,8 +49,7 @@ public void testGenerateRubyClientWithHtmlEntity() throws Exception {
       ClientOptInput clientOptInput = new ClientOptInput().opts(new ClientOpts()).swagger(swagger).config(codegenConfig);
 
       DefaultGenerator generator = new DefaultGenerator();
-      generator.opts(clientOptInput);
-      List<File> files = generator.generate();
+      List<File> files = generator.opts(clientOptInput).generate();
       boolean apiFileGenerated = false;
       for (File file : files) {
         if (file.getName().equals("default_api.rb")) {

modules/swagger-codegen/src/test/resources/sampleConfig.json

@@ -13,6 +13,7 @@
     "artifactId" : "awesome-api",
     "artifactVersion" : "1.2.3",
     "library" : "jersey2",
+    "ignoreFileOverride": "/path/to/override/.swagger-codegen-ignore",
     "systemProperties" : {
         "systemProp1" : "value1"
     },