Testing in jGRASP using JUnit

This guide covers two big things related to JUnit:

We start with the initial setup.

Configuring jGRASP to Use JUnit

While jGRASP has built-in support for JUnit, it does not come preinstalled with JUnit. This is analogous to the fact that jGRASP has built-in support for the Java Development Kit (JDK), but it does not come preinstalled with the JDK. However, unlike with the JDK, jGRASP cannot automatically figure out where JUnit is, so we need to configure it to know where it can find JUnit. The instructions below accomplish just that.

Once jGRASP has been configured to use JUnit, you do not need to fo through these configuration instructions again.

Step 1: Create a Folder/Directory for JUnit Installation Files

Create a folder/directory where you will later save some JUnit installation files. The exact name or location of the folder/directory doesn't particularly matter, though the folder/directory should be in a relatively permanent location which you can easily reference later on. For example, if you have a USB drive which you carry between the lab and home, it'd be good to put this folder on the USB drive. If you're unsure of what to name this folder/directory, the name junit_setup will work.

Step 2: Download JUnit Installation Files

There are two binary files which you need to download, listed below:

These files need to be saved in the folder/directory which you created in the previous step. Exactly how you perform the download depends on which Web browser you're using. For both Firefox and Chrome, you can right-click the above links and choose “Save Link As...”, and then navigate to the target folder/directory and save.

Step 3: Launch jGRASP

Exactly how you do this depends on your particular configuration.

Step 4: Select the JUnit Configure Option

Go to Tools -> JUnit -> Configure. A screenshot showing this is provided below.

Step 5: Click “`Browse`”

Click the “Browse” button, as shown in the screenshot below:

Step 6: Navigate to the JUnit Installation Folder

Using the window that appears after the previous step, navigate to where the folder/directory is which you created in the first step (which should contain JUnit installation files after the second step). Once you have found the directory, click the “Choose” button. A screenshot has been provided below to illustrate, where the folder name/location is /Users/kyledewey/junit_setup.

Step 7: Click “`Ok`”

Click the “Ok” button, as shown in the screenshot below:

Once you finish this step, jGRASP should be configured with JUnit.

Running JUnit Tests in jGRASP

Now that jGRASP is configured to use JUnit, you can run JUnit tests from within jGRASP. That said, there are a couple quirks with running JUnit tests from within jGRASP which you need to be aware of:

jGRASP is picky about the filenames which tests goes in. For example, if you have a file named Foo.java, then jGRASP assumes that all tests for Foo.java are in FooTest.java. That is, the name of the file with tests must be the same as the original file, but the class name ends in the word “Test”.
Even if you already have both code and tests in separate, properly named files (e.g., MyCode.java and MyCodeTest.java), jGRASP does not automatically detect that the code in MyCodeTest.java contains tests for MyCode.java. You need to manually tell this to jGRASP (more information on how to do this follows in the instructions below).

For this class, you'll usually be given some template code (e.g., MyCode.java), along with some template tests (e.g., MyCodeTest.java). With this in mind, you'll almost always need to tell jGRASP that the tests in a given file correspond to a different file. The instructions below show how to do this, using the code file AddFive.java and the tests file AddFiveTest.java.

Step 1: Ensure the Code File and the Test File are in the Same Folder/Directory

Make sure that your file containing code and your file containing tests are in the same folder/directory. With our running example, this means that AddFive.java and AddFiveTest.java must be in the same folder/directory.
This is important! If you fail to perform this step, the subsequent steps will still appear to work somewhat, but your tests won't appear in your tests file (AddFiveTest.java in our running example).

Step 2: Open the File Containing Code

Open the file containing code as you normally would (e.g., AddFive.java in our running example). You can do this by clicking File -> Open, and then navigating to the code you want to open.

Step 3: Tell jGRASP to Create a Test File

Click Tools -> JUnit -> Create Test File, as shown in the screenshot below. This tells jGRASP to associate some tests with your code.

Step 4: Click “`Use Existing File`”

Click the “Use Existing File” button, as shown in the screenshot below.

Step 5: Tell jGRASP to Compile and Run the Test File

Click Tools -> JUnit -> Compile and Run Tests, as shown in the screenshot below.

Step 6: Observe the Test Results

Upon completing the previous step, a number of things may happen, depending on the state of your code and tests. Some possibilities follow:

Your tests fail to compile. In this case, the output from jGRASP in the bottom-right window will display compilation errors. As with normal code, you'll need to fix these compilation errors and try to compile and run your tests again (repeat step 5).
Your tests compile, but tests fail. In this case, a window will appear which show exactly which tests were failing, and perhaps how. With this situation, you'll need to figure out exactly what your code is doing wrong based on your test results, and then respond accordingly. This might mean writing more tests (to check if related cases work, or because you realize there is something you missed in your tests), or editing your code (if you already know exactly what is wrong and new tests won't add anything useful).
Your tests compile, and all of them pass. In this case, a window will appear showing that all tests passed, as shown in the screenshot below.