[core][bug] FILES is now path relative with no prefixes (#7271)

* FILES is now path relative with no prefixes

some Java implementations don't honor .relativize documentation fully.
When outDir is /a/b and the input is /a/b/c/d, the result should be c/d.
Some implementations make the output ./c/d which seems to mix the logic
as documented for symlinks. So we need to trim any / or ./ from the start,
as nobody should be generating into system root and our expectation is no ./

This resolves regeneration issues for those on such Java
implementations, although we've not been able to track down the exact
vendor or configurations which might lead to these differences.

* Ensure windows outputs FILES paths in same format

* Normalize FILES paths to remove relativization mid-path

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

@@ -60,6 +60,7 @@ import java.time.ZonedDateTime;
 import java.util.*;
 import java.util.stream.Collectors;
 
+import static org.apache.commons.lang3.StringUtils.removeStart;
 import static org.openapitools.codegen.utils.OnceLogger.once;
 
 @SuppressWarnings("rawtypes")
@@ -1351,10 +1352,21 @@ public class DefaultGenerator implements Generator {
                     }
                 });
 
+                String relativeMeta = METADATA_DIR + File.separator + "VERSION";
                 filesToSort.sort(PathFileComparator.PATH_COMPARATOR);
                 filesToSort.forEach(f -> {
-                    String relativePath = outDir.toPath().relativize(f.toPath()).toString();
+                    String tmp = outDir.toPath().relativize(f.toPath()).normalize().toString();
-                    if (!relativePath.equals(METADATA_DIR + File.separator + "VERSION")) {
+                    // some Java implementations don't honor .relativize documentation fully.
+                    // When outDir is /a/b and the input is /a/b/c/d, the result should be c/d.
+                    // Some implementations make the output ./c/d which seems to mix the logic
+                    // as documented for symlinks. So we need to trim any / or ./ from the start,
+                    // as nobody should be generating into system root and our expectation is no ./
+                    String relativePath = removeStart(removeStart(tmp, "." + File.separator), File.separator);
+                    if (File.separator.equals("\\")) {
+                        // ensure that windows outputs same FILES format
+                        relativePath = relativePath.replace(File.separator, "/");
+                    }
+                    if (!relativePath.equals(relativeMeta)) {
                         sb.append(relativePath).append(System.lineSeparator());
                     }
                 });

samples/client/petstore/typescript-angular-v10-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v10-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v6-not-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v6-not-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v6-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v6-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v7-not-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v7-not-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v7-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v7-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v8-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v8-provided-in-root/builds/with-prefixed-module-name/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-angular-v9-provided-in-root/builds/default/.openapi-generator/FILES

@@ -9,11 +9,11 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 variables.ts

samples/client/petstore/typescript-angular-v9-provided-in-root/builds/with-npm/.openapi-generator/FILES

@@ -9,12 +9,12 @@ configuration.ts
 encoder.ts
 git_push.sh
 index.ts
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 ng-package.json
 package.json

samples/client/petstore/typescript-node/default/.openapi-generator/FILES

@@ -5,10 +5,10 @@ api/petApi.ts
 api/storeApi.ts
 api/userApi.ts
 git_push.sh
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts

samples/client/petstore/typescript-node/npm/.openapi-generator/FILES

@@ -5,12 +5,12 @@ api/petApi.ts
 api/storeApi.ts
 api/userApi.ts
 git_push.sh
-model/./apiResponse.ts
+model/apiResponse.ts
-model/./category.ts
+model/category.ts
-model/./order.ts
+model/order.ts
-model/./pet.ts
+model/pet.ts
-model/./tag.ts
+model/tag.ts
-model/./user.ts
+model/user.ts
 model/models.ts
 package.json
 tsconfig.json

samples/server/petstore/php-symfony/SymfonyBundle-php/.openapi-generator/FILES

@@ -1,26 +1,26 @@
-./Api/ApiServer.php
+Api/ApiServer.php
-./Api/PetApiInterface.php
+Api/PetApiInterface.php
-./Api/StoreApiInterface.php
+Api/StoreApiInterface.php
-./Api/UserApiInterface.php
+Api/UserApiInterface.php
-./Controller/Controller.php
+Controller/Controller.php
-./Controller/PetController.php
+Controller/PetController.php
-./Controller/StoreController.php
+Controller/StoreController.php
-./Controller/UserController.php
+Controller/UserController.php
-./Model/ApiResponse.php
+Model/ApiResponse.php
-./Model/Category.php
+Model/Category.php
-./Model/Order.php
+Model/Order.php
-./Model/Pet.php
+Model/Pet.php
-./Model/Tag.php
+Model/Tag.php
-./Model/User.php
+Model/User.php
-./Service/JmsSerializer.php
+Service/JmsSerializer.php
-./Service/SerializerInterface.php
+Service/SerializerInterface.php
-./Service/StrictJsonDeserializationVisitor.php
+Service/StrictJsonDeserializationVisitor.php
-./Service/SymfonyValidator.php
+Service/SymfonyValidator.php
-./Service/TypeMismatchException.php
+Service/TypeMismatchException.php
-./Service/ValidatorInterface.php
+Service/ValidatorInterface.php
-./Tests/AppKernel.php
+Tests/AppKernel.php
-./Tests/Controller/ControllerTest.php
+Tests/Controller/ControllerTest.php
-./Tests/test_config.yml
+Tests/test_config.yml
 .coveralls.yml
 .gitignore
 .php_cs.dist