Commit 206ea18e authored by Adam Knapp's avatar Adam Knapp
Browse files

Executor documentation update



Change-Id: I6b37f07f840a755c0a7cb4d4a0a066abfd7fc199
Signed-off-by: default avatarAdam Knapp <adam.knapp@sigmatechnology.se>
parent 7a32066b
......@@ -966,7 +966,7 @@ In Eclipse for the creation of a hierarchy of projects building on other project
When a project references another project, this means for Eclipse that all of the resources of the referenced project are available for use in the referring project. For example if _Project_2_ is referencing _Project_1_:
* All modules available in _Project_1 can be used in _Project_2_ too (for importation, code completion …). For the on-the-fly toolset is will seem as if those modules were also part of Project_2.
* All modules available in _Project_1_ can be used in _Project_2_ too (for importation, code completion …). For the on-the-fly toolset is will seem as if those modules were also part of Project_2.
* The order in which _Project_1_ and _Project_2_ are built will always be handled automatically:
......
......@@ -2,7 +2,9 @@
== The TITAN Executing Perspective
WARNING: The execution of TITAN Java projects (the Java side of the Test Executor) is done as Eclipse native java applications. It is not yet integrated to the usual Interface elements (Views, TITAN Launch configurations, etc...) that support the execution of the binaries of the C side of the TITAN Test Executor. For information on executing TITAN Java projects see <<launching-modes-supported-by-the-TITAN-Executor-plug-in-for-TITAN-Java-Projects, The Launching Modes Supported by the TITAN Executor Plug-in for TITAN Java Projects>>.
WARNING: The execution of TITAN Java projects (the Java side of the Test Executor) is done as Eclipse native Java applications. It is not yet fully integrated to the usual interface elements like Views that support the execution of the binaries of the C side of the TITAN Test Executor. For information on executing TITAN Java projects see <<launching-modes-supported-by-the-TITAN-Executor-plug-in-for-TITAN-Java-Projects, The Launching Modes Supported by the TITAN Executor Plug-in for TITAN Java Projects>>.
NOTE: In newer Eclipse versions "Launch configuration" is called "Run configuration", however throughout in this document "Launch configuration" is used.
[[Figure-1]]
image::images/2_Figure1.png[title="TITAN Executing perspective"]
......
......@@ -11,11 +11,17 @@ image::images/3_Figure5.png[title="TITAN Executing perspective"]
The following options can be set on the TITAN Executor preferences page:
* **Set the default log folder.**The tests executed by the TITAN Executor will create the log files in the given folder. This option is enabled by default. This option is overridden if the `"FileName"` option is set in the `[LOGGING]` section of the runtime configuration file.
* **Set the default log folder.**
+
The tests executed by the TITAN Executor will create the log files in the given folder. This option is enabled by default. This option is overridden if the `"FileName"` option is set in the `[LOGGING]` section of the runtime configuration file.
* **Delete log files before execution.**The log files in the default log folder will be deleted before each test execution. Files with `.log` extensions are considered to be log files. This option is only available if the default log folder has been set, by default it is disabled. If the files cannot be deleted, an error message will be displayed.
* **Delete log files before execution.**
+
The log files in the default log folder will be deleted before each test execution. Files with `.log` extensions are considered to be log files. This option is only available if the default log folder has been set, by default it is disabled. If the files cannot be deleted, an error message will be displayed.
* **Merge the log files after test execution.**When the test execution is finished, the log files found in the default log directory will be merged into a single file. This option is available if the default log folder has been set, by default it is enabled.
* **Merge the log files after test execution.**
+
When the test execution is finished, the log files found in the default log directory will be merged into a single file. This option is available if the default log folder has been set, by default it is enabled.
== TITAN Executor Project Properties
......
......@@ -3,6 +3,13 @@
This chapter describes launch configurations, their options, and launching modes. After building an executable test suite, it is ready to be launched. In Eclipse, every aspect of the launch can be configured, for example, different environmental settings can be created by creating different launch configurations, without modifying the system environment variables, so different test environments can be created.
[NOTE]
====
This chapter discusses only the launching modes related to TITAN {cpp} projects, i.e. the TITAN Single, the TITAN Parallel and the TITAN JNI launching modes. The TITAN native Java launching mode that is specific to TITAN Java projects is detailed in a separate chapter, see <<launching-modes-supported-by-the-TITAN-Executor-plug-in-for-TITAN-Java-Projects, The Launching Modes Supported by the TITAN Executor Plug-in for TITAN Java Projects>>.
Please note, that TITAN JNI launching mode is marked as obsolete and will be removed in later releases.
====
[[launching-modes-supported-by-the-TITAN-Executor-plug-in]]
== The Launching Modes Supported by the TITAN Executor Plug-in
......@@ -14,7 +21,7 @@ The TITAN Executor can operate in single or parallel mode.
It is possible to execute non-parallel test suites in parallel mode, but doing so results in unnecessary overhead. The {cpp} code generated by the compiler is suitable for both execution modes, there are no command line switches to select mode. The only difference is that another Base Library has to be linked in single and another in parallel mode.
The TITAN Executor plug-in is built on the TITAN Executor and provides support for the following launch and execution modes:
The TITAN Executor plug-in is built on the TITAN Executor and provides support for the following launch and execution modes. These are only available for TITAN {cpp} projects:
* Single mode:
+
......@@ -24,9 +31,9 @@ This mode executes the built executable, and parses its output for information t
+
This mode executes the `mctr_cli` program, and continuously parses its output for information that can be displayed. Although some functions can be reached from the graphical user interface, the main advantage of this launch mode is that it can be driven from its console window, just as `mctr_cli` could be driven from the command line. The user interface reacts to console outputs by the `mctr_cli`. However, as the user is able to change every aspect of the test execution system from outside the execution monitor view, an always consistent controlling environment cannot be provided. There is no limitation on the amount of simultaneously running executions of this kind.
* JNI mode: This mode executes the main controller through the JNI interface, and continuously parses its output for information that can be displayed. The functions can be reached from the graphical user interface. The user interface reacts to the state changes of the main controller through a pipe. There is no limitation on the amount of simultaneously running executions of this kind.
* JNI mode (_obsolete_): This mode executes the main controller through the JNI interface, and continuously parses its output for information that can be displayed. The functions can be reached from the graphical user interface. The user interface reacts to the state changes of the main controller through a pipe. There is no limitation on the amount of simultaneously running executions of this kind.
+
NOTE: Execution in JNI mode is not supported on Windows
NOTE: Execution in JNI mode is not supported on Windows.
* Only one parallel execution can be run at a time.
......@@ -36,7 +43,8 @@ NOTE: Execution in JNI mode is not supported on Windows
Note that some execution modes require a properly set up runtime configuration file.
== Creating a Launch Configuration
[[creating-launch-configuration]]
== Creating Launch Configuration
Launch configurations can be created, modified and deleted in the *Create, manage, and run configuration* dialog window. It can be opened in the numerous ways.
......@@ -44,12 +52,13 @@ Launch configurations can be created, modified and deleted in the *Create, manag
Right click on a project in the *Project explorer* and select *Run configurations*… from the *Run as* option.
[[Figure-4-F7]]
image::images/4_F7.png[title="Executing from the Project Explorer"]
[[Running-from-the-Launch-Command-Toolbar]]
=== Running from the Launch Command Toolbar
In the toolbar, click the down arrow at the *Launch Commands,* and select *Run as.* +
In the toolbar, click the down arrow at the *Launch Commands*, and select *Run as.* +
If not visible, modify the Launch properties in the *Windows > Customize Perspective*.
[[Figure-4-F8]]
......@@ -97,7 +106,7 @@ When this function is invoked on a resource to which no launch configuration has
. A new launch configuration is made.
. The project, working directory, executable path is initialized.
. The project, working directory, executable and configuration file paths are initialized.
. If the executable is found, the available testcase will be extracted.
......@@ -121,7 +130,9 @@ On this page it is possible to set:
* The name of the project.
+
Please note that it is not important to provide the name of the project, it is only provided to support automatic filling of the other fields. If you enter the name of a valid project with TITAN nature (or select one by browsing, as can be seen <<Figure-13,below>>), having the needed build options set, then the fields of the working directory and the executable will be filled in automatically. The entered name is checked for validity.
Filling this field is mandatory. The entered name is checked for validity. The project's root folder is used during the automatically filling of the other fields. The path variables are relative to the project's root supporting the portability of the project as whole. If you enter the name of a valid project with TITAN nature (or select one by browsing, as can be seen <<Figure-13,below>>), having the needed build options set, then the fields of the working directory, the executable and the configuration file will be filled in automatically.
NOTE: It is encouraged to use the *Browse Workspace* button to select a valid project from the workspace that simplifies the filling of the other fields, as well as reduces the possible mistakes.
[[Figure-13]]
image::images/4_F13.png[title="Selecting a project"]
......@@ -138,27 +149,11 @@ Please note that this executable is used to fill in the list of testcases on the
+
Please note that not only the existence but also the validity of the configuration file is evaluated here. If a problem was found while trying to process the configuration file, the launch process will be interrupted here. Please note that this evaluation is done every time this configuration page becomes active, meaning that switching to and from this page can take some time. The entered file path is checked for validity.
* Whether you wish to start executing the configuration file automatically when the launcher is started.
+
Please note that this option is turned on by default.
All fields can be filled in either by entering the proper values, or via browsing for them. Please note that if a field is not needed and it is not required by the given launch configuration it should be left blank.
Differences between the launch configuration modes regarding this page:
* Single launch mode:
* Execute automatically
+
The working directory and the executable must be set, but the configuration file is optional.
Whether the user wish to start executing the configuration file automatically when the launcher is started. Please note that this option is turned on by default.
* Parallel launch mode:
+
The working directory must be set, but the executable and the configuration file are optional.
* JNI based launch mode: (Not available under Windows.)
+
The working directory must be set, but the executable and the configuration file are optional.
In the case of Mctr_cli mode or JNI mode execution if the configuration file is missing, the Main Controller is started with default values. A missing executable can imply that every host controller will connect from remote hosts, and that there is no need to have test sets.
All fields can be filled in either by entering the proper values, or via browsing for them.
[[host-controllers-page-of-the-launch-configuration]]
=== Host Controllers Page of the Launch Configuration
......@@ -418,8 +413,16 @@ For us the two most important parts of this page are:
* The Save as region:
+
Here you can select a directory where the data of the launch configuration will be saved. The file will be named after the name of the launch configuration, with the extension "launch". Eclipse is automatically taking care of such files, if it finds such a file anywhere in the directories of the projects, it will be offered to the user. Please note that for this reason it is advised to put the launch configurations in the project’s directories. On this way if a project is closed, the launch configurations belonging to it won’t be displayed. +
Please note that if you choose not to save the launch configuration it will still be saved, but to an internal point in Eclipse’s inner data hierarchies. output:
Here you can select a directory where the data of the launch configuration will be saved. The file will be named after the name of the launch configuration, with the extension "launch". Eclipse is automatically taking care of such files, if it finds such a file anywhere in the directories of the projects, it will be offered to the user. +
[NOTE]
====
Please note that for this reason it is advised to put the launch configurations in the project’s directories.
Please note that if you choose not to save the launch configuration it will still be saved, but to an internal point in Eclipse’s inner data hierarchies.
Please note if a project is closed, the launch configurations belonging to it won’t be displayed.
====
* Standard input and output:
+
......
= Executing and Controlling the Execution of Test Suites
:figure-number: 25
The three different launch modes that are supported by the Executor plug-in, also imply three different execution mechanisms (executions and executors).
The three different launch modes related to TITAN {cpp} projects that are supported by the Executor plug-in, also imply three different execution mechanisms (executions and executors).
As the general user interaction interfaces, are about the same, we will discuss them one by one, detailing the differences between the execution modes when they apply.
......@@ -105,7 +105,7 @@ This action allows you to automatically execute tests. You will be presented wit
* *Start Host Controllers*:
+
This action starts the Host Controllers set on the Host Controllers page of the launch configuration. Please note that the variables inserted into the Host Controllers commands are extracted at this point. For more information on the Host Controllers page of the launch configuration, please refer <<4-launching_the_test_suite.adoc#host-controllers-page-of-the-launch-configuration, here>>;
This action starts the Host Controllers set on the Host Controllers page of the launch configuration. Please note that the variables inserted into the Host Controllers commands are extracted at this point. For more information on the Host Controllers page of the launch configuration, please refer to <<4-launching_the_test_suite.adoc#host-controllers-page-of-the-launch-configuration, Host Controllers Page of the Launch Configuration>>;
* *Create MTC*:
+
......@@ -129,7 +129,7 @@ This action executes the "**info**" command, providing inner state information t
NOTE: The last five commands are commands of the `Mctr_cli`.
All of the commands of *Mctr_cli* can be issued directly from the Console too (including the ones mentioned). The executor will try to adapt to the changes, for example if you select the *info* action, or execute the *info* command in the Console, the information displayed under the executor node will be updated (this can be seen on <<Figure-29,Figure 29>>). For more information on the commands of the *Mctr_cli* and how to execute testcases in it please refer to chapter 12 of the User Guide <<8-references.adoc#_3, [3]>>.
All of the commands of *Mctr_cli* can be issued directly from the Console too (including the ones mentioned). The executor will try to adapt to the changes, for example if you select the *info* action, or execute the *info* command in the Console, the information displayed under the executor node will be updated (this can be seen on <<Figure-29,Figure 29>>). For more information on the commands of the *Mctr_cli* and how to execute testcases in it please refer to Section 4.4 of the User Guide <<8-references.adoc#_3, [3]>>.
[[Figure-29]]
image::images/5_F29.png[title="Example information display in the Parallel launch mode"]
......@@ -175,7 +175,8 @@ Resumes the interrupted test execution.
* *Stop execution*:
+
Terminates the test execution. +The verdict of the actual test case will not be considered in the statistics of the test suite.
Terminates the test execution. +
The verdict of the actual test case will not be considered in the statistics of the test suite.
* *Exit MTC*:
+
......@@ -233,7 +234,7 @@ As several executions can be ongoing at any given time, this view always shows t
Notifications of an execution can only be reached; as long as the execution is not removed from the system (being terminated is allowed).
Please note that the Performance page of the launch configuration has some options to tweak the performance of this view. For more information please refer <<4-launching_the_test_suite.adoc#host-controllers-page-of-the-launch-configuration, here>>.
Please note that the Performance page of the launch configuration has some options to tweak the performance of this view. For more information please refer to <<4-launching_the_test_suite.adoc#host-controllers-page-of-the-launch-configuration, Host Controllers Page of the Launch Configuration>>.
The following actions are supported:
......@@ -257,9 +258,7 @@ image::images/5_F34.png[title="The Executed tests view"]
The TITAN test results view (above) contains verdict changing notifications extracted from the list of notifications.
This view serves the purpose of summarizing the verdict changes of a test execution, briefly showing when and which testcase set what verdict value. As several executions can be ongoing at any given time, this view always shows the verdict changing messages, created by the execution/launch actually selected in the
TITAN Execution Controller view (<<Figure-26,Figure 26>>). This information of an execution can only be reached; as long as the execution is not removed from the system (being terminated is allowed).
This view serves the purpose of summarizing the verdict changes of a test execution, briefly showing when and which testcase set what verdict value. As several executions can be ongoing at any given time, this view always shows the verdict changing messages, created by the execution/launch actually selected in the TITAN Execution Controller view (<<Figure-26,Figure 26>>). This information of an execution can only be reached as long as the execution is not removed from the system (being terminated is allowed).
It is worth to notice that the tool tip of this view not only identifies the execution it belongs to, but also presents its statistics (as seen below).
......@@ -269,7 +268,7 @@ The following actions are supported:
* *Save as*:
+
Selecting this action allows the user to save the extracted notifications in a file via a standard save as… Window.
Selecting this action allows the user to save the extracted notifications in a file via a standard *save as…* Window.
* *Follow the last record*:
+
......@@ -295,10 +294,12 @@ There are a few things to remember about console views:
=== Creating a New Console View
By default the Executor perspective has only a single Console view open this can be changed by selecting the Open Console menu (Figure 36) and clicking on the New Console View option (Figure 37). By doing so a new Console view will be created in the actual perspective
By default the Executor perspective has only a single Console view open this can be changed by selecting the Open Console menu (<<Figure-36,Figure 36>>) and clicking on the New Console View option (<<Figure-37,Figure 37>>). By doing so a new Console view will be created in the actual perspective
[[Figure-36]]
image::images/5_F36.png[title="The Open Console menu item"]
[[Figure-37]]
image::images/5_F37.png[title="The New Console View menu entry"]
Using this feature of the Console views it is possible to create a separate Console view for each Host Controller or Main Controller of interest, and with their output at the same time.
......@@ -307,15 +308,18 @@ Using this feature of the Console views it is possible to create a separate Cons
The default behavior of the Console View provided by its plug-in is that it always tries to show the data printed to a console. For this reason when any Host controller or the Main Controller displays any information on its standard output, the Console View will automatically switch to the Console displaying that information.
If it is desired to have a given console present at all time this can be achieved by selecting the Display Selected Console menu item (Figure 38), and from the list of available consoles selecting the one desired (Figure 39).
If it is desired to have a given console present at all time this can be achieved by selecting the Display Selected Console menu item (<<Figure-38,Figure 38>>), and from the list of available consoles selecting the one desired (<<Figure-39,Figure 39>>).
[[Figure-38]]
image::images/5_F38.png[title="The Display Selected Console menu"]
[[Figure-39]]
image::images/5_F39.png[title="A list of available consoles displayed"]
To force a Console View to always display the contents of a given console, one has to click on the Pin Console menu item (Figure 40). To lift this limitation from the Console View the Pin Console menu item has to be clicked again.
To force a Console View to always display the contents of a given console, one has to click on the Pin Console menu item (<<Figure-40,Figure 40>>). To lift this limitation from the Console View the Pin Console menu item has to be clicked again.
[[Figure-40]]
image::images/5_F40.png[title="The Pin Console menu item"]
== Limitations
......@@ -324,7 +328,12 @@ image::images/5_F40.png[title="The Pin Console menu item"]
* In JNI mode we have witnessed, that on some machines the Java Virtual Machine fails to load the `LD_LIBRARY_PATH` environmental variable from the shell into his set of environmental variables. +
An indication of this problem is when the JNI executor reports, that the JNI dynamic library could not be loaded, though the path to the file can be found on the `LD_LIBRARY_PATH` of the shell. +
A solution can be to start Eclipse with the following command forcing the Java Virtual Machine to load this environmental variable: *java -classpath startup.jar –Djava.library.path=$LD_LIBRARY_PATH org.eclipse.core.launcher.Main* +
(This command must be executed in the directory where Eclipse was installed to)
A solution can be to start Eclipse with the following command forcing the Java Virtual Machine to load this environmental variable:
[source]
----
java -classpath startup.jar –Djava.library.path=$LD_LIBRARY_PATH org.eclipse.core.launcher.Main
----
(This command must be executed in the directory where Eclipse was installed to.)
* Execution in JNI mode is not supported on Windows
......@@ -3,17 +3,17 @@
== Formatting Log Files
To format a log file (one having log as extension) *right click* the fileand select *Titan Log > Format log*.
To format a log file (one having `.log` as extension) *right click* the file and select *Titan Log > Format log*.
image::images/6_F41.png[title="Format log menu"]
This will produce a formatted log file in the very same directory, with the same name, but having the extension formatted_log.
This will produce a formatted log file in the very same directory, with the same name, but having the extension `.formatted_log`.
Please note that for the duration while the formatted log is being created progress indication is provided in the *Progress view*.
== Merging Log Files
To merge several log files (ones having log as extension) select them, and after right clicking on one select *Titan Log > Format log.*
To merge several log files (ones having `.log` as extension) select them, and after right clicking on one select *Titan Log > Merge log.*
image::images/6_F42.png[title="Merge log menu"]
......
......@@ -8,103 +8,71 @@ In Eclipse, every aspect of the launch can be configured, for example, different
NOTE: Right now the Java side of the TITAN Test Executor is supported as a Java application native to Eclipse. It as executed with the same limitations and benefits.
WARNING: The execution of TITAN Java projects (the Java side of the Test Executor) is done as Eclipse native java applications. It is not yet integrated to the usual Interface elements (Views, TITAN Launch configurations, etc...) that support the execution of the binaries of the C side of the TITAN Test Executor.
WARNING: The execution of TITAN Java projects (the Java side of the Test Executor) is done as Eclipse native Java applications. It is not yet fully integrated to the usual Interface elements like Views that support the execution of the binaries of the C side of the TITAN Test Executor.
[[launching-modes-supported-by-the-TITAN-Executor-plug-in-for-TITAN-Java-Projects]]
== The Launching Modes Supported by the TITAN Executor Plug-in for TITAN Java Projects
The TITAN Executor can operate in single or parallel mode.
The TITAN Executor can operate in single or in parallel mode.
From the point of view there are 2 ways to execute TITAN Java projects:
from Eclipse as Java projects and executing exported jar files.
=== Executing TITAN Java Projects from Eclipse
To execute TITAN Java projects inside Eclipse requires the creation of a Launch configuration.
For that two options are available for the users at the moment: automatic generation of a default launch configuration or manual creation.
To execute TITAN Java projects inside Eclipse requires the creation of a Launch configuration. For TITAN Java Projects the TITAN Native Java launch configuration mode is necessary that supports both the single and parallel execution mode. Launch configurations can be created, modified and deleted in the *Create, manage, and run configuration* dialog window. It can be opened in the numerous ways as detailed in <<creating-launch-configuration,Creating Launch Configuration>>:
* using the *Run as* option in pop-up menu of the *Project explorer* (<<Figure-4-F7,Figure 7>>),
* using the *Launch Commands* on the toolbar (<<Figure-4-F8,Figure 8>>).
NOTE: It is recommended to use the automatic generation to reduce the number of possible mistakes. The generated launch configuration is still editable via the Eclipse embedded launch configurator.
Furthermore, a default launch configuration can be created using launch shortcuts. It works the same way as described in <<creating-launch-configuration,Creating Launch Configuration>>, however the TITAN Native Java launching mode requires less option, i.e.:
NOTE: In newer Eclipse versions "Launch configuration" is called "Run configuration", however throughout in this document "Launch configuration" is used.
. A new launch configuration is made.
==== Generating Launch configuration for TITAN Java Project automatically
. The project and configuration file paths are initialized.
The generation of launch configuration is available from the pop-up menu of a Titan configuration file under *Titan* menu group. The user can choose to generate launch configuration for single operation mode or parallel operation mode as shown in <<Figure-7-lc-popup,Figure 43>>.
. Finally the newly created launch configuration is launched automatically in parallel execution mode.
[[Figure-7-lc-popup]]
image::images/7_lc_popup.png[title="Pop-up menu items for launch configuration generation"]
The launch configuration created using launch shortcuts is automatically added to favorite list under the *Launch Commands* (<<Figure-4-F8,Figure 8>>).
NOTE: This feature is only available for TITAN Java Projects, and the menu only appears if Titan configuration file is selected.
NOTE: It is encouraged to use the launch shortcuts to reduce the number of possible mistakes. The generated launch configuration is still editable in the *Create, manage, and run configuration* dialog window (see below).
After selecting one of the menu items, the user is asked for a file name prefix that will be used during the generation process (see <<Figure-7-lc-dialog,Figure 44>>). It is possible to overwrite the existing launch configuration with the same name. The given name is extended with "-Single" or "-Parallel" according the selected operation mode.
=== Basic Main Controller Options Page of the Launch Configuration
NOTE: By using this feature, launch configuration files are created under the *launch* folder of project root. For single operation mode one launch configuration file is generated, while for parallel operation mode three launch configuration files are generated.
[[Figure-7-lc-dialog]]
image::images/7_lc_dialog.png[title="Dialog for naming the launch configuration"]
After the successful generation of the launch configuration, it will appear immediately between the available launch configurations on the toolbar. The user is able to run the project by clicking on the newly created launch configuration or to further edit it (see <<Figure-7-lc-toolbar,Figure 45>>).
[[Figure-7-lc-toolbar]]
image::images/7_lc_toolbar.png[title="Launch configuration options"]
==== Creating Launch configuration for TITAN Java Project manually
In the toolbar, click the down arrow at the *Launch Commands*, and select *Run Configurations...* . +
If not visible, modify the Launch properties in the *Windows > Customize Perspective* (see <<Figure-4-F8,Figure 4>>).
[[Figure-7-F43]]
image::images/7_F43.png[title="Basic Main Controller options page"]
The following operations are available:
On this page it is possible to set:
* ’*New*’:
* The name of the project.
+
This button can be used to create a new launch configuration. The values of the created launch configurations will be set to their defaults.
Filling this field is mandatory. The entered name is checked for validity. The project's root folder is used during the automatically filling of the other fields. The path variables are relative to the project's root supporting the portability of the project as whole. If you enter the name of a valid project with TITAN nature (or select one by browsing, as can be seen <<Figure-13,below>>), the configuration file will be filled in automatically.
* ’*Duplicate*’:
+
This button will create a new launch configuration, filled with the values of the source launch configuration. This button should be used if the new launch configuration does not differ too much from an earlier one.
NOTE: It is encouraged to use the *Browse Workspace* button to select a valid project from the workspace that simplifies the filling of the other fields, as well as reduces the possible mistakes.
* ’*Delete*’:
* The path of the configuration file.
+
This button deletes the actually selected launch configuration.
To create a new Launch Configuration for executing a TITAN Java Project:
Please note that not only the existence but also the validity of the configuration file is evaluated here. If a problem was found while trying to process the configuration file, the launch process will be interrupted here. Please note that this evaluation is done every time this configuration page becomes active, meaning that switching to and from this page can take some time. The entered file path is checked for validity.
1. select *Java Application*.
2. On the toolbar select *New*.
+
At this point a new Launch Configuration should appear, similar to "New_Configuration (2)" on figure <<Figure-7-F43,Figure 46>>.
* Execute automatically
+
[[Figure-7-F43]]
image::images/7_F43.png[title="Launch configuration options"]
3. To configure the *Main* page:
* for the *Project* field select the project you wish to execute.
Whether the user wish to start executing the configuration file automatically when the launcher is started. Please note that this option is turned on by default.
* for the Main Class field select the generated class fitting to your execution mode:
** classes with their names ending in "generated.Single_main" can be used to drive single mode execution.
** classes with their names ending in "generated.Parallel_main" can be used to drive parallel mode execution.
4. To configure the *Arguments* page:
* for the *Program Arguments* field provide the arguments you would like your execution started with.
** For single mode execution this is generally the path of the configuration file to use (relative to the root folder of the project being executed).
** For parallel mode execution this is generally the host address and port, the Main Controller is expecting connection on.
* In the *VM Arguments* field, you can provide configuration options for the Java Virtual Machine that will do the execution.
[[Figure-7-F44]]
image::images/7_F44.png[title="Example Arguments page for single mode execution"]
* Execute in single mode
+
Whether the user wish to start executing the TITAN Java project in single or in parallel mode. Please note that this option is turned off by default.
Figure <<Figure-7-F44,Figure 47>> shows an example for configuring a single mode execution. The "minimal1.cfg" will be the configuration file used for execution. The Java Virtual Machine will be configured to execute in server mode, using the Garbage First (G1) garbage collector.
All fields can be filled in either by entering the proper values, or via browsing for them.
[[Figure-7-F45]]
image::images/7_F45.png[title="Example Arguments page for parallel mode execution"]
If you press *Apply* some other launch configurations will appear automatically according to the filled values in the *Create, manage, and run configuration* dialog window.
Figure <<Figure-7-F45,Figure 48>> shows an example for configuring a parallel mode execution. The main controller is expecting the host controller to connect to the "localhost" to port number "7339" for execution. The Java Virtual Machine will be configured to execute in server mode, using the Garbage First (G1) garbage collector, and to use 1024 MBs of memory during its execution.
[NOTE]
====
During the filling Eclipse might ask for saving the modification.
All launch configuration types supported by the Executor plug-in can be found in the panel.
Sometimes Eclipse automatically switches to one of the additionally created launch configuration after saving the TITAN Native Java launch configuration.
====
NOTE: Please note, that the process is very similar to that described in section <<Running-from-the-Launch-Command-Toolbar,4.2>>, we are just using a different launch configuration kind to configure the execution.
The functionality of other tab pages of the of the TITAN Native Java launch configuration matches the ones for JNI launch mode, see <<creating-launch-configuration,Creating Launch Configuration>>.
=== Executing TITAN Java project via exported jar files.
......
= References
[[_1]]
* [1] link:https://github.com/eclipse/titan.core/blob/master/usrguide/installationguide.adoc[Installation guide for TITAN TTCN-3 Test Executor]
* [1] link:https://github.com/eclipse/titan.core/blob/master/usrguide/installationguide/installationguide.adoc[Installation guide for TITAN TTCN-3 Test Executor]
[[_2]]
* [2] link:https://github.com/eclipse/titan.EclipsePlug-ins/blob/master/Eclipse_installationguide.adoc[Installation Guide for TITAN Designer and TITAN Executor for the Eclipse IDE]
* [2] link:https://github.com/eclipse/titan.EclipsePlug-ins/blob/master/org.eclipse.titan.help/docs/Eclipse_installationguide/Eclipse_installationguide.adoc[Installation Guide for TITAN Designer and TITAN Executor for the Eclipse IDE]
[[_3]]
* [3] link:https://github.com/eclipse/titan.core/blob/master/usrguide/userguide/README.adoc[User Guide for TITAN TTCN-3 Test Executor]
* [3] link:https://github.com/eclipse/titan.core/blob/master/usrguide/userguide/UserGuide.adoc[User Guide for TITAN TTCN-3 Test Executor]
[[_4]]
* [4] link:https://github.com/eclipse/titan.core/blob/master/usrguide/referenceguide/README.adoc[Programmers Technical Reference for TITAN TTCN-3 Test Executor]
* [4] link:https://github.com/eclipse/titan.core/blob/master/usrguide/referenceguide/ReferenceGuide.adoc[Programmers Technical Reference for TITAN TTCN-3 Test Executor]
[[_5]]
* [5] https://github.com/eclipse/titan.core/blob/master/usrguide/apiguide/README.doc[API Technical Reference for TITAN TTCN-3 Test Executor]
* [5] https://github.com/eclipse/titan.core/blob/master/usrguide/apiguide/Apiguide.adoc[API Technical Reference for TITAN TTCN-3 Test Executor]
[[_6]]
* [6] link:https://github.com/eclipse/titan.core/blob/master/usrguide/releasenotes.adoc[Release Notes for TITAN TTCN-3 Test Executor]
* [6] link:https://github.com/eclipse/titan.core/blob/master/usrguide/releasenotes/releasenotes.adoc[Release Notes for TITAN TTCN-3 Test Executor]
[[_7]]
* [7] TTCN–3 Style Guide
......@@ -25,4 +25,4 @@
* [8] link:https://www.etsi.org/deliver/etsi_es/201800_201899/20187310/04.05.01_60/es_20187310v040501p.pdf[Methods for Testing and Specification (MTS);The Testing and Test Control Notation version 3.Part 1: Core Language European Telecommunications Standards Institute. ES 201 873-1 Version 4.5.1, April 2013]
[[_9]]
* link:https://www.etsi.org/deliver/etsi_es/201800_201899/20187304/04.04.01_60/es_20187304v040401p.pdf[Methods for Testing and Specification (MTS);The Testing and Test Control Notation version 3.Part 4: TTCN–3 Operational Semantics European Telecommunications Standards Institute. ES 201 873-4 Version 4.4.1, April 2012]
* [9] link:https://www.etsi.org/deliver/etsi_es/201800_201899/20187304/04.04.01_60/es_20187304v040401p.pdf[Methods for Testing and Specification (MTS);The Testing and Test Control Notation version 3.Part 4: TTCN–3 Operational Semantics European Telecommunications Standards Institute. ES 201 873-4 Version 4.4.1, April 2012]
---
Author: Jenő Balaskó
Version: 7.2.0
Date: 2020-11-27
Author: Jenő Balaskó, Ádám Knapp
Version: 7.2.1
Date: 2021-02-09
---
= User Guide of the TITAN Executor for the Eclipse IDE plug-in
:author: Jenő Balaskó
:revnumber: 7.2.0
:revdate: 2020-11-27
:author: Jenő Balaskó, Ádám Knapp
:revnumber: 7.2.1
:revdate: 2021-02-09
:title-logo-image: images/titan_logo.png
:sectnums:
:doctype: book
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment