Settings Tab
The Suite window's Settings tab contains general information about the current Eggplant Functional suite. You can access the Settings tab by clicking the Settings button at the bottom left of the Suite window.
The Settings tab consists of sections that provide information and let you set defaults for your suite. These sections are described below.
The Suite window showing the open Settings tab.
The Helper Suites Pane
The Helper Suites section on the Setting tab contains a list of the suites whose scripts, images, and helpers are available to the current suite; such attached suites are known as helper suites
. Helper suites are useful as core suites, with scripts and images that you use across several other suites.
The table shows the following information about each helper suite:
- Relationship: Shows how the helper suite is related to the current suite. This column displays either Includes if the current suite can access resources from the helper suite, or Included by if another suite accesses the current suite as a helper suite.
- Helper Suite: Displays the name of the attached helper suite.
- Path: Shows the file path of the helper suite; red text indicates a file path that is no longer valid.
Double-clicking a helper suite in the list opens that suite (or brings it to the front).
Adding, Creating, or Removing a Helper Suite
To add a helper to your suite, click the Add button and browse to select the suite you want to add.
To create a new helper suite, click the New button. In the New Test Suite window that open, name your new suite and decide where to save it.
To remove a helper suite, select it and click the Remove button. When you remove a helper suite, scripts in the current suite can no longer access that helper suite’s scripts, images, and other helper suites.
Using a Relative Path for a Helper Suite
You can change the path of a helper suite to make it relative to your Home directory or your Default Suite Directory. To edit the path of the helper suite, select the helper suite in your Helper Suites pane and click in the path.
Paths that start with a tilde (~/) are relative to your Home directory. Paths that start with a dot (./) are relative to your Default Suite Directory.
Relative Paths with the <Suite_Root> Token
Beginning in 23.1.0, Eggplant provided an alternative way to specify relative paths in helper suites: the <Suite_Root>
token. The <Suite_Root>
token indicates the folder where the main suite resides. For example, if you enter the path for a helper suite as <Suite_Root>/a_helper_suite.suite
, it will look for the suite at the same level as the main suite. You can also enter paths like so: <Suite_Root>/../../folder1/folder2/other_suite.suite
, which will find the helper suite two levels up and then down through subdirectories “folder1” and “folder2.”
Note that the functionality of relative paths that are relative to the Default Suite Directory described above still works. If you just enter a path like this_suite.suite
, EPF will look for that suite at the first level under the Default Suite Directory.
When you add a new helper suite using the file navigator (either from the Add... helper button on the Settings tab or using the EPF File > New Helper Suite... menu), EPF will, by default, try to use a relative path. In summary, beginning in release 23.1.0, EPF specifies helper suite paths as follows:
- If the helper suite is at the same level or lower than the main suite, Eggplant Studio will use a path relative to the main suite.
- If it is in the Default Suite Directory, Eggplant Studio will use the simple relative path.
- If neither of these is true, Eggplant Studio will use an absolute path.
For more information about using helpers, see Helpers.