Giter Club home page Giter Club logo

approvaltests.java's Introduction

ApprovalTests.Java

Capturing Human Intelligence - ApprovalTests is an open source assertion/verification library to aid unit testing.

It is compatible with JUnit 3 & 4 and TestNG

What can it be used for?

Approval Tests can be used for verifying objects that require more than a simple assert. They also come prepackaged with utilities for some common .Net scenarios including

  • HashMaps & Collections
  • Long Strings
  • Log Files
  • JPanels
  • Xml
  • Html
  • Json

How to get it

Unfortunately, I haven't added this to maven repo yet. Simply download the zip from the releases tab and add the jar to your project.

You can watch a bunch of short videos on getting started and using ApprovalTests in Java at youtube

Podcasts

If you prefer auditory learning, you might enjoy the following podcast (Note: Some of these talk about the .net side)

Download

You can find the latest ApprovalTests release under https://github.com/approvals/ApprovalTests.Java/releases.

Examples

ApprovalTests eats it own dogfood, so the best examples are in the source code itself.

None the less, Here's a quick look at some Sample Code

public class SampleArrayTest extends TestCase
{
	public void testList() throws Exception
	{
		String[] names = {"Llewellyn", "James", "Dan", "Jason", "Katrina"};
		Arrays.sort(names);
		Approvals.verifyAll("", names);
	}
}

Will Produce a File

SampleTest.TestList.received.txt
[0] = Dan
[1] = James
[2] = Jason
[3] = Katrina
[4] = Llewellyn

Simply rename this to SampleTest.testList.approved.txt and the test will now pass.

Approved File Artifacts

The *.approved.* files must be checked into source your source control. This can be an issue with git as it will change the line endings. The suggested fix is to add *.approved.* binary to your .gitattributes

More Info

LICENSE

Apache 2.0 License

Questions?

twitter: @LlewellynFalco or #ApprovalTests

Developer notes

We are currently migrating the build from Ant to Maven. To build with Maven, first you must download the ApprovalTests.jar package from Releases and install it in your local maven repository:

mvn install:install-file -Dfile=ApprovalTests.jar -DgroupId=com.approvaltests -DartifactId=approvals -Dversion=020 -Dpackaging=jar

All the other dependencies should be available on Maven central, so this command should then build the project:

mvn install

Unfortunately right now we have test failures so this will work to install the jars locally as a temporary fix while we sort that out:

mvn install -DskipTests

I also had trouble with the "mrunit" package which is listed on Maven central but which wouldn't download for me. To fix that you can always install it locally with this command:

mvn install:install-file -Dfile=java/jars/hadoop/mrunit-0.9.0-incubating-hadoop1.jar -DgroupId=org.apache.mrunit -DartifactId=mrunit -Dversion=0.9.0-incubating -Dpackaging=jar

If you would like to build this project with Apache ant, then use these commands:

 ant "Publish    Spun" -buildfile build/build.xml
 cp spun/target/spun.jar java/jars/
 ant "Publish    ApprovalTests" -buildfile build/build.xml
 cp approvals/target/ApprovalTests.jar java/jars
 ant "Publish    HtmlLocker" -buildfile build/build.xml
 ant "Publish    CounterDisplay" -buildfile build/build.xml

This will build jar files under the target folder for each respective project. At present you have to copy the built jar files by hand in between ant steps, since the subprojects depned on one another. Soon this will be handled by maven instead.

approvaltests.java's People

Contributors

isidore avatar emilybache avatar martinsson avatar beatngu13 avatar rkalis avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.