Apache Ant, Java JDK and Environment Variables

Contents

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 contents of this .txt file into the empty file.

Then save the changes.

If you already have an environment.plist file in the LaunchAgents folder:

First take a backup copy of the file contents.

Then add these launchctl entries into the existing file, inside your array and string tags:

launchctl setenv ANT_HOME /Users/ravindra/apache-ant-1.9.6

launchctl setenv PATH $PATH:/Users/ravindra/apache-ant-1.9.6/bin

Make sure that you replace /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.

Then save the changes.

Once you have created your environment.plist file (or updated the existing one), open Terminal and run the following command:

launchctl load ~/Library/LaunchAgents/environment.plist

Then shut down your machine and start it again.

Updating the Path Environment Variable

On Windows:

In the Environment Variables dialog, select the variable Path, then click the ‘Edit’ button:

On the dialog box that appears, click the ‘Edit Text…’ button:

The following dialog will appear. Navigate to the end of the ‘Variable value, then add a semicolon (;) then %ANT_HOME%\bin

Make sure that the end of the string looks like this (note that earlier string contents may differ):

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’:

If you can’t see .bash_profile, you may not have your Mac set up to show 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 your User Home folder and locate your .bash_profile file. If you can’t see it, it might be that one doesn’t exist and you will need to create it.

To create a bash_profile file, open Terminal, and use the following command to make sure you are in your home folder:

cd ~/

Press the ‘Return’ key. Then type:

touch .bash_profile

And press ‘Return’ again. This will create your new file.

Once you can see a .bash_profile file in your User Home folder, right-click it and open it in Text Edit:

On a new line in the file, enter the following:

export PATH=$PATH:/Users/hetty.bw/apache-ant-1.10.1/bin

Note that, even if an export PATH already exists, it is fine to create this as a new entry as above, and this is safer than amending the existing entry. Do not try to amend the existing entry unless you are confident and have experience in editing .bash_profile.

Replace :/Users/hetty.bw/apache-ant-1.10.1/bin with the same filepath you recorded when installing Apache Ant (see above), but make sure that you add /bin at the end of it:

Then save and close the file.

Installing Java JDK

Next, check that Java JDK is installed on your machine.

If you are not sure, here is a fast way to check:

Open Command Prompt (Windows) or Terminal (Mac) and type:

java –version

Then press return.

If the command comes back as not recognized, the Java JDK is probably not installed.

If a version comes back which is earlier than 1.8, you should remove these files and download a newer version from the website.

To download the JDK, visit this page. (In case this link is not available, visit the Oracle website, scroll to the bottom of the home page and select the action ‘Download Java for Developers’). Then download the JDK.

Once downloaded, run the installer.

This completes your Apache Ant and Java JDK installation. You can move on to Generating a Build File.

2017-08-30T15:41:53+00:00

Leave A Comment