Vocareum

After logging in to Vocareum, you will brought to the course page where all open assignments are listed.

You may notice that the score will show points for Coding Style and points for JUnit Tests or Manual Grading. We will be following the Coding Standards very closely. Please review them as your assignments must be fully documented using Javadoc style comments.

• Login to Vocareum using your login credentials

• From the list of assignments, select the one you wish to submit and click on the My Work button.

• You will be brought to the work management interface. From here, you can upload your files for the assignment, run the Checkstyle tool, and Submit your assignment for grading. On this page, select the work/ directory and click the Upload button which will allow you to browse your computer for the files that you would like to upload.

• Once you have selected a file to upload, click OK and you should see it displayed in the directory structure on the left hand side, as well as the contents of the file (if you select the file) in the editor on the right. From here, you can make changes directly to your code in the editor (NOTE: these changes will not affect the local files on your machine, but will update the copy stored in the Vocareum cloud).

• After you have uploaded the file/s, you will see a new button at the top title Run which will run a version of the Checkstyle tool to check all uploaded .java files for coding style. Once you click Run, you will see a very detailed description of any parts of your code that failed the Checkstyle tool.

• As you can see in the screenshot above, the code failed for 5 different errors:
  1. Ordered List ItemMissing the @author tag in the class Javadoc comment
  2. Missing the @version tag in the class Javadoc comment
  3. Missing the Javadoc for the add method
  4. Missing the Javadoc for the sub method
  5. Missing the Javadoc for the mul method

• For any errors that you get from Running the Checkstyle tool, you can fix them directly from the editor there in Vocareum (make sure you are editing the file in the work/ directory). This static analysis of the coding style does not count against you as a Submission so you can run it as many times as you would like, and should do so to avoid using submissions for checking coding style. Once you have fixed all coding style errors, your output from click Run should look similar to this:

• Now, you are ready to Submit your assignment to be checked against the JUnit test cases (if there are any) or to be manually graded by a TA after the deadline. To do so, just click the Submit button at the top, and after a few seconds, your results will be shown at the bottom.

• If there is a portion for JUnit grading and you pass test cases, your output should look similar to that of the screenshot above (45 / 45 points for JUnit Tests) and if you fixed all your coding style errors, 5/5 for the Coding Style Score. If there are any test cases that your submission failed, a short message will be displayed along with the expected output and actual output for each of the failed tests between the lines TEST FAILED… and END OF TEST FAILURES. If you passed all the test cases, there will be nothing between these two lines.

• Assuming you have received a full score of 50 (45 points for JUnit Tests and 5 points for Coding Style, you can then return to the assignment page by clicking the link at the top of the work interface to verify that your grade has been recorded. If all is well, your grade will be displayed in the Grading section for that assignment.

• If there is a portion for manual grading, points won't be displayed until TAs grade your work.