We're here to help

Apache Ant, Java JDK and environment variables

Introduction to Apache Ant

Apache Ant or ANT is a command-line tool for driving software processes. In Provar, ANT can be used to run a Provar test suite via the command line or using a Continuous Integration (CI) server such as Jenkins. This is achieved by configuring and executing Provar Compile and Run tasks in ANT, using a Build File.

Before a Build File can be generated, first make sure that you have Apache Ant and Java JDK installed, and that their environment variables have been correctly configured. Follow the steps below to complete these actions.

Installing Apache Ant

Start by downloading and installing Apache Ant.

To download Apache Ant, visit this page. (In case this link is not available, visit the Apache website, go to the downloads section, select a mirror site directory, then navigate to ant/ and then binaries/). Choose your preferred version (1.8 or later*), then download the version file ending in bin.zip, e.g. apache-ant-1.9.4-bin.zip. *earlier versions may work but have not been tested.

Once the file has been downloaded, extract it to your preferred location. Take a note of the directory, e.g. C:\apache-ant-1.9.4 or /Users/hetty.bw/apache-ant-1.10.1, as you will need to add this information to an environment variable (see below).

Setting the ANT_HOME Environment Variable

On Windows:

Open the System Control panel, then select the Advanced tab:

Click the ‘Environment Variables…’ button. The following dialog will appear:

Click the ‘New’ button.

In ‘Variable name’, enter ANT_HOME, and in ‘Variable value’, enter the directory to which Apache Ant was extracted previously, e.g. C:\apache-ant-1.9.4:

Then click the ‘OK’ button.

On Mac:

Navigate to your User Home folder. The fastest way to do this is using Shift + Command + H, or you can open Finder, select ‘Go’ in the menubar and then click ‘Home’:

From User Home, navigate to Library > LaunchAgents folder. If you can’t see this folder, your computer may not be showing hidden files. To show hidden files, open Terminal, and paste the following command: defaults write com.apple.finder AppleShowAllFiles YES

Then press the ‘Return’ key. Then right-click on the Finder icon in the dock and select ‘Relaunch’. (If you do not see this option, restart your computer to achieve the same result.) Navigate back to User Home, then to Library > LaunchAgents folder.

If there is no existing environment.plist file

Create a new file in that folder called environment.plist. This can be done by opening a text editor, saving the file as environment.plist(ensuring no other filetype suffix is added) and adding this into the LaunchAgents folder. (Note that you may not be able to save the file directly to the LaunchAgents folder, since this is a hidden folder. If this is the case, save the file to Desktop, then open Finder and move the file manually to the LaunchAgents folder.

In the new, empty file, add the contents below.

Make sure that you modify the contents by replacing /Users/ravindra/apache-ant-1.9.6 and /Users/ravindra/apache-ant-1.9.6/bin with the same filepath you recorded when installing Apache Ant (see above).

Note that the second entry (PATH) should have /bin added at the end of it, while the first entry (ANT_HOME) should not.

Paste the following into the empty file.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>my.startup</string>
<key>ProgramArguments</key>
<array>
<string>sh</string>
<string>-c</string>
<string>
launchctl setenv ANT_HOME /Users/hetty.bw/apache-ant-1.10.1
launchctl setenv PATH $PATH:/Users/hetty.bw/apache-ant-1.10.1/bin
</string>
</array>
<key>RunAtLoad</key>
<true/>
</dict>
</plist>