SigTest

Revision as of 16:34, 15 July 2016 by Jtulach (Talk | contribs)

APITest tool

APITest is the tool behind NetBeans signature testing infrastructure. It checks for incompatibilities between different versions of the same API. NetBeans uses the APITest tool as an Ant task to check for binary backward compatibility and mutual signature compatibility. There is however also a version released as a Maven Plugin ready for use in your own project. The sources are in its own dedicated Mercurial repository and are available under GPL version 2.

Use in Maven

The Maven Plugin is available on Maven central, so it easy to embed it into your own project.

Generate the Signature File

The first thing to do is to generate the signature file. Just add following into your own `pom.xml` file:

<plugin>
  <groupId>org.netbeans.tools</groupId>
  <artifactId>sigtest-maven-plugin</artifactId>
  <version>1.0</version>
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
  <packages>org.yourcompany.app.api,org.yourcompany.help.api</packages>
  </configuration>
</plugin>

with just this change the API of your classes in the listed packages is going to be recorded into a `.sigtest` file and included as an artefact of your project when you invoke `mvn install`.

For example libraries of Html4Java NetBeans API have the sigtest file attached even in Maven central repository.

Develop

Binary Builds are available from our hudson builder. Get the sources with

  hg clone http://hg.netbeans.org/apitest/
  cd apitest
  ant jar test
  # open in NetBeans

Why another API test tool?

  • We need our own extended Ant task - it would be the best if sigtest could use Ant task with the same setters and behaviour
  • There does not seem to be many tests in original sigtest, we need the sigtest to pass our

tests.

  • The sources of sigtest cannot be smoothly opened in NetBeans. Until that is changed, we need to keep the project skeleton in some public repository

Existing patches to sigtest

  • All were accepted.
Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo