Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 3.56 KB

troubleshooting-guide.md

File metadata and controls

79 lines (47 loc) · 3.56 KB
title: "Troubleshooting Guide"

Developer Troubleshooting Guide

This document can help you to fix the common problems encountered while contributing to TEAMMATES.

Common setup errors and solutions

Due to framework limitation, this is an expected behavior if the working directory contains a space character in it. This can be resolved by moving the repository to another directory.

This is the expected behaviour if you are running the server in the foreground.

The front-end type definitions need to be built before running the dev server.

This is possible if a part of API input/output definition changes. Simply rerun the command to build the type definitions to resolve the problem.


Common test errors and solutions

Re-run the failed tests with TestNG, all test cases should pass eventually (it may take a few runs). If there are tests that persistently fail and not addressed in other parts of this guide, you may request for help in the discussion forum.

Ensure that the text file encoding for your workspace has been set to UTF-8 as specified under Setting up guide.

Ensure that your dev server is started prior to running those tests.

Ensure compatible version of Firefox is installed as specified under Development process document.

REASON 1: Path to Firefox executable on local machine is incorrect.

SOLUTION 1 (on Windows): Specify the correct folder in system PATH variable.

Open Windows Explorer → Right-click on Computer → Advanced System Settings → "Advanced" tab → Environment Variables… → Select "PATH" from the list → Add directory of "Mozilla Firefox" folder to "Variable value" field.

REASON 2: Incorrect custom path in test.firefox.path.

SOLUTION 2: Make sure that the path is set correctly following the example from test.template.properties.

Add -Djava.io.tmpdir=/path/to/teammates/tmp for the tests' run configurations. The "tmp" folder in the specified directory needs to be created before running the tests.


Submitting help request

If none of the items in this guide helps with the problem you face, you can post in the discussion forum to request for help. Remember to supply as much relevant information as possible when requesting for help.