Eclipse

Introduction

In this lab, you will explore Eclipse. If you already use the Eclipse editor, this lab may provide you with more information.

All Eclipse applications are built as a project. If you choose to use Eclipse this semester, each lab and each PA that you complete will be in its own project and each project will have its own folder.

Resources

Norm Krumpe's Eclipse Tutorial covers some of the basic information you'll need to complete this activity.

Part 1 - Hello World

1. If you have not done so already, open Eclipse. At the "Workspace" prompt, fill in a location for your workspace.
2. Choose the tutorials icon. (Pen and green check-mark).
3. Choose "Create a Hello World application".
4. Follow the steps in the tutorial. Be sure to see how the automatic syntax checking works by introducing some bugs. Also explore the autofill options (showing the list of available members of an object).

Part 2 - Coding in Eclipse

1. Create a new Eclipse project named PointLab:
   File -> New -> Project... -> Java Project
2. Use Eclipse to create a new class that corresponds to the UML diagram below. Don't worry about commenting the code. We'll address that later on.
   
   

   The return value of the toString method should consist of an open-parenthesis followed by the x-coordinate, followed by a comma, then a space, then the y-coordinate followed by a close-parenthesis. For example: "(1.0, 2.0)".

   The equals method should return true if the two points have the same x position and y position.

3. Once you have completed a syntactically correct Point class, move on to the next step.

Part 3 - Adding A .jar File

One standard mechanism for distributing Java code is through .jar files. A .jar file is a compressed archive that can hold any number of Java classes in either source or binary form (as .java files or as .class files). For some projects in this course you will be provided with .jar files containing support code.

1. Create a new folder named "lib" in your Java project. Download the file PointCode.jar, and drag it into the newly-created folder.
2. Right click PointCode.jar and select Build Path -> Add to Build Path.
3. There should now be a "Referenced Libraries" entry in your project explorer. Expanding that entry should allow you to inspect the details of the PointCode.jar archive. All classes included in that archive are now available within your project. In this case there is only one class: PointDisplay.

Part 3 - Importing and Running

1. Download the file PointDemo.java to your Desktop, then drag it into the "src" section of your project.
2. Look over the PointDemo class to get a feel for what it should do. Run the code to confirm that everything is working as expected.

Part 4 - Checkstyle Eclipse Integration

Checkstyle is a development tool that makes it easy to test Java code against a particular coding standard. Our Web-CAT submission system will analyze your programming assignments using Checkstyle to verify that they conform to the CS159 style guide. It will be in your best interest to use Checkstyle off-line so that you can avoid wasting your limited submissions. Checkstyle can be run from the command line, but today we will try it out using an Eclipse plug-in.

1. Navigate to the following web-page in a separate browser window or tab: http://eclipse-cs.sourceforge.net. Drag the blue "Install" button onto your Eclipse window and follow the instructions for installing the plugin.
2. Download the following XML file to your Desktop: CS159_checkstyle.xml. This file contains a Checkstyle configuration that matches the CS159 style guide. This is exactly the same configuration that Web-CAT will use to check your submissions.
3. Configure the Checkstyle plugin to use the configuration file: Window -> Preferences -> Checkstyle -> New. Select "External Configuration" as the Type and then select the file you downloaded in the previous step. Click "OK" and then set this configuration as the default.
4. Unfortunately, checkstyle needs to be explicitly enabled for each new Eclipse project. Right click your PointLab project in the "Package Explorer" tab and then select Properties -> Checkstyle. Click on the check-box labeled "Checkstyle active for this project".
5. Once you have completed the previous step, navigate to your Point.java file, right-click in the editor window and select "validate". Many lines of code should now be marked in yellow. Each of these marked lines contains a violation of the style guidelines that would prevent you from successfully submitting a programming assignment. Clicking on the yellow magnifying glasses in the left margin will show you a description of the problem. We'll fix these problems in the next part of the lab.

Part 5 - Eclipse Auto-Formatting

One of Eclipse's handiest features is the ability to automatically handle low-level code formatting. This dramatically reduces the effort involved in producing consistently formatted (and thus more readable) code. This auto-formatting feature will also help you write code that conforms to the course coding standards.

1. Download the file CS159_formatter.xml. This XML file contains the configuration information necessary for Eclipse to format your code in a way that is consistent with the CS159 coding standards.
2. Configure Eclipse to use the file you just downloaded: Preferences -> Java -> Code Style -> Formatter -> Import.
3. Once you have configured the auto-formatter you should be able to re-format your Point.java file by selecting the entire file (CTRL-A) and then pressing SHIFT-CTRL-F.
4. Once you have auto-formatted your code (and saved it!), re-validate using Checkstyle. Hopefully, many of the flagged formatting errors should now be gone. Most of the remaining issues probably relate to missing Javadocs.
5. Add appropriate Javadoc comments to your Point class. Eclipse will automatically generate a Javadoc template for any method. You can either type /**[ENTER] just above the method, or select the method and press SHIFT-ALT-J.
6. Re-run code validation, and address any remaining formatting issues.

Part 6 - JUnit Integration in Eclipse

JUnit is a framework that automates testing by providing a standard format for tests and an easy way to execute them (see JUnit FAQ).  The JUnit site provides a wealth of useful information on JUnit and the host of JUnit-based products ( visit http://www.junit.org/). For most of the programming assignments and labs in this course, you will be required to test your own code using JUnit. Here is how you can write JUnit Test Cases and test your code within Eclipse:

1. Select File -> New -> Other -> Junit Test Case. Select "New JUnit 4 test" and name your class PointTest. Click Next, and select the Point class to make stub testing methods.
2. To run JUnit tests, select Run -> RunAs -> JUnit Test. This will test your methods using PointTest.
3. Finish writing test cases for your program.

Part 7 - EclEmma: Code Coverage during Testing

While writing unit tests for your program, you would like to find out if your test cases are actually executing all of the code you are trying to test. EclEmma is a free Java code coverage tool for Eclipse that allows you to do this. It brings code coverage analysis directly into Eclipse. Follow the steps below to integrate EclEmma into your Eclipse environment. The Lab machines might already have this feature. In that case skip Step 1 and directly continue to Step 2.

1. Go to Help -> Eclipse Marketplace, find EclEmma, and click Install. This plugin will allow you to run 'Code Coverage' tests (like Web-CAT does) against your program to see the coverage of your test files against your code.
2. You can now run coverage tests against your program by right-clicking your project and selecting 'Coverage As' -> JUnit Test.

Part 8 - Submitting Through Web-CAT

1. Navigate to http://webcat.cs.jmu.edu and log-in using your JMU eid and password.
2. For submission, create a zip archive containing Point.java and PointTest.java . Submit the zip folder in webcat.
   
3. If your code fails any of the submission tests, make any necessary modifications and resubmit until there are no failures.