The [[NetBeans]] project is using its [[netbeans:SigTest|SigTest]] - a slight extension to classical [[JDK]] sigtest tool with an excellent integration to [[Maven]] - see [https://github.com/jtulach/netbeans-apitest GitHub repository] for details.

The [[NetBeans]] project is using its [[netbeans:SigTest|SigTest]] - a slight extension to classical [[JDK]] sigtest tool with an excellent integration to [[Maven]] - see [https://github.com/jtulach/netbeans-apitest GitHub repository] for details.

The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

The '''sigtest''' is the official [http://openjdk.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

<source lang="text">

<source lang="text">

=== Java ===

=== Java ===

The [[NetBeans]] project is using its [[netbeans:SigTest|SigTest]] - a slight extension to [http://sigtest.dev.java.net sigtest] open source testing tool with an excellent integration to [[Maven]] - see [[netbeans:SigTest]] for details.

The [[NetBeans]] project is using its [[netbeans:SigTest|SigTest]] - a slight extension to classical [[JDK]] sigtest tool with an excellent integration to [[Maven]] - see [https://github.com/jtulach/netbeans-apitest GitHub repository] for details.

The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

=== Java ===

=== Java ===

The [[NetBeans]] project is using its [[netbeans:APITest|slight extension]] to [http://sigtest.dev.java.net sigtest] open source testing tool. The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

The [[NetBeans]] project is using its [[netbeans:SigTest|SigTest]] - a slight extension to [http://sigtest.dev.java.net sigtest] open source testing tool with an excellent integration to [[Maven]] - see [[netbeans:SigTest]] for details.

 

The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

<source lang="text">

<source lang="text">

--[[User:JaroslavTulach|JaroslavTulach]] 19:08, 9 August 2009 (UTC)

--[[User:JaroslavTulach|JaroslavTulach]] 19:08, 9 August 2009 (UTC)

[[Category:Tools]] [[Category:APIDesignPatterns:Test]]

[[Category:Tools]] [[Category:APIDesignPatterns:Test]]

Since the rise of [[XP]] and other [[Agile]] methodologies testing become more and more popular. Not only among dedicated quality departments, but also among developers. It is not surprising that these days a successful projects is not just code, but also set of tests to verify that the release is good enough and that the project moves into correct direction.

Since the rise of [[XP]] and other [[Agile]] methodologies testing become more and more popular. Not only among dedicated quality departments, but also among developers. It is not surprising that these days a successful projects is not just code, but also set of tests to verify that the release is good enough and that the project moves in the right direction.

The [[API Design]] is not exceptional in this aspect. Proper [[API Design]] requires testing and verification. The goal when designing an [[API]] is to prevent the [[Amoeba Model|amoeba shaking effect]] - e.g. prevent each new release to completely destabilize existing usages. This requires standard unit testing as well, as something special - testing for [[binary compatibility]].

The [[API Design]] is not exceptional in this aspect. Proper [[API Design]] requires testing and verification. The goal when designing an [[API]] is to prevent the [[Amoeba Model|amoeba shaking effect]] - e.g. prevent each new release to completely destabilize existing usages. This requires standard unit testing as well, as something special - testing for [[binary compatibility]].

=== Java ===

=== Java ===

The [[NetBeans]] project is using its [http://wiki.netbeans.org/view/APITests slight extension] to [http://sigtest.dev.java.net sigtest] open source testing tool. The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

The [[NetBeans]] project is using its [[netbeans:APITest|slight extension]] to [http://sigtest.dev.java.net sigtest] open source testing tool. The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

<source lang="text">

<source lang="text">

Existing alternatives to '''sigtest''':

Existing alternatives to '''sigtest''':

* [http://clirr.sourceforge.net/ Clirr]

* [http://clirr.sourceforge.net/ Clirr]

* [http://forge.ispras.ru/projects/java-api-compliance-checker/files Java API Compliance Checker]

* [http://ispras.linuxbase.org/index.php/Java_API_Compliance_Checker Java API Compliance Checker]

Sample usage:

Sample usage:

japi-compliance-checker -lib NAME -d1 OLD.jar -d2 NEW.jar

japi-compliance-checker -lib NAME -old OLD.jar -new NEW.jar

=== C/C++ ===

=== C/C++ ===

There is a backward binary compatibility checker for shared libraries in C/C++. An anonymous coward just provided a link to [http://forge.ispras.ru/projects/abi-compliance-checker/files API compliance checker].

There is a backward binary compatibility checker for shared libraries in C/C++. An anonymous coward just provided a link to [http://ispras.linuxbase.org/index.php/ABI_compliance_checker API compliance checker].

It is good that [[C]] world gets such a useful tool, just realize the difference with [[Java]]. Adding new field into a '''struct''' deserves a warning(!) as it may be incompatible for everyone who embeds such structure inside own '''struct'''. Adding new virtual method in [[BackwardCompatibility|backward compatible]] way is almost impossible, as far as I can see.

It is good that [[C]] world gets such a useful tool, just realize the difference with [[Java]]. Adding new field into a '''struct''' deserves a warning(!) as it may be incompatible for everyone who embeds such structure inside own '''struct'''. Adding new virtual method in [[BackwardCompatibility|backward compatible]] way is almost impossible, as far as I can see.

== Signature Testing Tools ==

== Signature Testing Tools ==

The [[NetBeans]] project is using its [http://wiki.netbeans.org/view/APITests slight extension] to [http://sigtest.dev.java.net sigtest] open source testing tool. The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

The [[NetBeans]] project is using its [http://wiki.netbeans.org/view/APITests slight extension] to [http://sigtest.dev.java.net sigtest] open source testing tool. The '''sigtest''' is the official [http://openjdk.dev.java.net OpenJDK] tool and since version 2.1 (which has been release in Mar 2009) it supports also [[BackwardCompatibility]] tests. We run the tests daily to ensure that our [[API]] are still binary compatible and whether our [[API]]s are changing intentionally and not accidentally. This is example of one of '''sigtest''' reports:

Simple and useful. I cannot imagine [[API]] design without such verification tool. Thanks the ''sigtest'' team for releasing such mature 2.1 version!

Simple and useful. I cannot imagine [[API]] design without such verification tool. Thanks the ''sigtest'' team for releasing such mature 2.1 version!

=== C/C++ ===

=== C/C++ ===

=== C/C++ ===

=== C/C++ ===

There is a backward binary compatibility checker for shared libraries in C/C++. An anonymous coward just provided a link to [http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker API compliance checker].

There is a backward binary compatibility checker for shared libraries in C/C++. An anonymous coward just provided a link to [http://forge.ispras.ru/projects/abi-compliance-checker/files API compliance checker].

It is good that [[C]] world gets such a useful tool, just realize the difference with [[Java]]. Adding new field into a '''struct''' deserves a warning(!) as it may be incompatible for everyone who embeds such structure inside own '''struct'''. Adding new virtual method in [[BackwardCompatibility|backward compatible]] way is almost impossible, as far as I can see.

It is good that [[C]] world gets such a useful tool, just realize the difference with [[Java]]. Adding new field into a '''struct''' deserves a warning(!) as it may be incompatible for everyone who embeds such structure inside own '''struct'''. Adding new virtual method in [[BackwardCompatibility|backward compatible]] way is almost impossible, as far as I can see.

--[[User:JaroslavTulach|JaroslavTulach]] 19:08, 9 August 2009 (UTC)

--[[User:JaroslavTulach|JaroslavTulach]] 19:08, 9 August 2009 (UTC)

[[Category:Tools]]

[[Category:Tools]] [[Category:APIDesignPatterns:Test]]