Error - Maven Plugin - Cannot invoke "String.replaceAll(String, String)" because "location" is null

[aniljose72]

Getting this error

Failed to execute goal org.openapitools.openapidiff:openapi-diff-maven:2.0.1:diff (default-cli) on project <component-name>: Unexpected error: Cannot invoke "String.replaceAll(String, String)" because "location" is null 

<plugin>
    <groupId>org.openapitools.openapidiff</groupId>
    <artifactId>openapi-diff-maven</artifactId>
    <version>2.0.1</version>
    <executions>
        <execution>
            <goals>
                <goal>diff</goal>
            </goals>
            <configuration>
                <!-- Reference specification (perhaps your prod schema) -->
                <oldSpec>${basedir}/openapi_main.yaml</oldSpec>
                <!-- Specification generated by your project in the compile phase -->
                <newSpec>${basedir}/openapi.json</newSpec>
                <!-- Fail only if API changes broke backward compatibility (default: false) -->
                <failOnIncompatible>true</failOnIncompatible>
                <!-- Fail if API changed (default: false) -->
                <failOnChanged>false</failOnChanged>
            </configuration>
        </execution>
    </executions>
</plugin>

[joschi]

@aniljose72 Please try OpenAPI Diff 2.1.0-beta.6 and check if the error still occurs.

If it does, please provide a minimal example from your OpenAPI spec to reproduce the issue.

[sbelan]

@joschi its same as above I added maven plugin as per ReadMe instruction.

[joschi]

@sbelan Here's an example (well, it's a test) which does exactly the same:
https://github.com/OpenAPITools/openapi-diff/blob/2.1.0-beta.6/maven-example/pom.xml

This is being executed in every single build of openapi-diff and it doesn't fail.
Example: https://github.com/OpenAPITools/openapi-diff/actions/runs/4809721609/jobs/8561362189#step:5:880

So it probably is related to your actual OpenAPI specs. If you can't provide them to reproduce the issue, I cannot investigate the bug.

[rickwporter-oracle]

I'm hitting this, too!

Running directly from Java, everything is fine from a copy of the latest.

I do not believe it is related to the file content for 2 reasons:

• My OpenAPI spec works when invoked from Java
• I substituted the Petstore OAS for my current and previous versions and got the same failure

Whenever I run from the Maven plugin, I'm hitting the error. Whether I invoke Maven directly, or via a container, I get the same error. I expect it is some sort of path issue, but not quite sure what. I have tried with v2.0.1 and v2.1.0-beta.6. I included a snippet from the backtrace (using the -e flag for Maven).

Any suggestions for further debug? The -X flag showed me an unresolved configuration and a whole lot more noise. It would not surprise me if it is something to do with an old Maven version.

Direct:

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)
Maven home: /home/rwporter/bin/apache-maven-3.8.4
Java version: 17.0.2, vendor: Oracle Corporation, runtime: /scratch/home/rwporter/bin/jdk-17.0.2
Default locale: en_US, platform encoding: ANSI_X3.4-1968
OS name: "linux", version: "4.14.35-2047.526.2.1.el7uek.x86_64", arch: "amd64", family: "unix"

Container:

Apache Maven 3.8.5 (3599d3414f046de2324203b78ddcf9b5e4388aa0)
Maven home: /usr/share/maven
Java version: 17.0.4.1, vendor: Oracle Corporation, runtime: /usr/java/jdk-17
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "4.14.35-2047.526.2.1.el7uek.x86_64", arch: "amd64", family: "unix"

Regards,
Rick

Backtrace:

Caused by: java.lang.NullPointerException: Cannot invoke "String.replaceAll(String, String)" because "location" is null
    at io.swagger.v3.parser.OpenAPIV3Parser.readContentFromLocation (OpenAPIV3Parser.java:218)
    at io.swagger.v3.parser.OpenAPIV3Parser.readLocation (OpenAPIV3Parser.java:87)
    at io.swagger.parser.OpenAPIParser.readLocation (OpenAPIParser.java:16)
    at org.openapitools.openapidiff.core.OpenApiCompare.readLocation (OpenApiCompare.java:117)
    at org.openapitools.openapidiff.core.OpenApiCompare.fromLocations (OpenApiCompare.java:91)
    at org.openapitools.openapidiff.core.OpenApiCompare.fromLocations (OpenApiCompare.java:78)
    at org.openapitools.openapidiff.maven.OpenApiDiffMojo.execute (OpenApiDiffMojo.java:31)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:137)
    at org.apache.maven.lifecycle.internal.MojoExecutor.doExecute (MojoExecutor.java:301)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:211)
   ...

[navbhu]

Could you check if this works?

<plugin>
    <groupId>org.openapitools.openapidiff</groupId>
    <artifactId>openapi-diff-maven</artifactId>
    <version>2.0.1</version>
    <executions>
        <execution>
            <goals>
                <goal>diff</goal>
            </goals>
         </execution>
    </executions>
    <configuration>
                <!-- Reference specification (perhaps your prod schema) -->
                <oldSpec>${basedir}/openapi_main.yaml</oldSpec>
                <!-- Specification generated by your project in the compile phase -->
                <newSpec>${basedir}/openapi.json</newSpec>
                <!-- Fail only if API changes broke backward compatibility (default: false) -->
                <failOnIncompatible>true</failOnIncompatible>
                <!-- Fail if API changed (default: false) -->
                <failOnChanged>false</failOnChanged>
     </configuration>
</plugin>

[MatKuhr]

For the record, I'm also getting the same behavior. Notably, debug logs show:

[DEBUG] -----------------------------------------------------------------------
[DEBUG] Goal:          org.openapitools.openapidiff:openapi-diff-maven:2.0.1:diff (default-cli)
[DEBUG] Style:         Regular
[DEBUG] Configuration: <?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <failOnChanged default-value="false">${failOnChanged}</failOnChanged>
  <failOnIncompatible default-value="false">${failOnIncompatible}</failOnIncompatible>
  <newSpec>${newSpec}</newSpec>
  <oldSpec>${oldSpec}</oldSpec>
</configuration>
[DEBUG] =======================================================================

....

[DEBUG] Loading mojo org.openapitools.openapidiff:openapi-diff-maven:2.0.1:diff from plugin realm ClassRealm[plugin>org.openapitools.openapidiff:openapi-diff-maven:2.0.1, parent: jdk.internal.loader.ClassLoaders$AppClassLoader@2c854dc5]
[DEBUG] Configuring mojo execution 'org.openapitools.openapidiff:openapi-diff-maven:2.0.1:diff:default-cli' with basic configurator -->
[DEBUG]   (f) failOnChanged = false
[DEBUG]   (f) failOnIncompatible = false
[DEBUG] -- end configuration --

which looks off. I am using:

Apache Maven 3.9.9 (8e8579a9e76f7d015ee5ec7bfcdc97d260186937)
Maven home: /opt/homebrew/Cellar/maven/3.9.9/libexec
Java version: 21.0.5, vendor: SAP SE, runtime: /Library/Java/JavaVirtualMachines/sapmachine-21.jdk/Contents/Home
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "15.1.1", arch: "aarch64", family: "mac"