eclipse plugin: Document the process necessary for running the test suite.

This commit is contained in:
Timotei Dolean 2011-07-26 15:43:47 +00:00
parent 80f89ad1c5
commit 7e2c8cea76

View file

@ -103,6 +103,24 @@ After you've setup the environment you can run the plugin.
If you want to know how you can use the plugin, please consult the User's Manual.
\section{Running the tests}
The plugin has a Test Suite based on JUnit 4, that tests some aspects of it. To run the tests follow the following steps:
\begin{enumerate}
\item Go to the ``Run" menu, and select ``Run configurations..."
\item In the left pane's list, right click on the ``JUnit" item
\item Select ``New" from the opened context menu
\item Select the first radio box: ``Run a single test"
\item For the \textbf{Project}, enter: ``org.wesnoth" ( or browse for it )
\item For the \textbf{Test Class}, enter: ``org.wesnoth.tests.WMLTestsSuite" ( or ``Search..." for it. Just enter ``WMLTestsSuite" in the newly opened window, and select the item )
\item For the \textbf{Test method}, let it as it is by default: ``(all methods)"
\item In the ``Test runner" Combo Box select ``Junit 4"
\item Go to the ``Arguments" tab, and in the ``VM Arguments" textbox, enter: $-DwesnothDataDir=<path>$
\item Replace the $<path>$ portion with the current path to the wesnoth data directory
\item Press ``Apply" and ``Run"
\end{enumerate}
\textit{Note:} You can always launch last runned configuration with F11 - Debug / CTRL+F11 - Run. Alternatively, you can launch them by clicking near the green bug/run icon, on the little down arrow, and selecting the run configuration.
\section{Building the plugin}
The plugin can be built as a zip archive (usually) for different operating systems. The built application can be launched without any Eclipse prerequisites. This plugin's version is called \textbf{Standalone}. To build the plugin, you need to follow the specified steps: