This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.

Overview
Configuring
Provided annotation
Code snippets and examples

Overview

The zos3270Terminal Manager enables 3270 terminal interactions with back-end application programs and subsystems.

Colour and highlight validation is supported. Use the retrieveHighlightAtCursor method to check that a field is highlighted as expected. Use the retrieveColourAtCursor method to check that the text colour in a specified field is as expected. You can check for the following colours: blue, red, pink, green, turquoise, yellow, neutral, and default. Use the terminal.reportExtendedScreen method to send colour output to the log. Support is also provided for diffent screen sizes. Screen sizes can be specified on the @Zos3270Terminal annotation.

The ConfidentialTextFiltering service enables confidential information such as passwords to be replaced with a numbered shield in these generated logs.

Examples of using colour support and screen sizing are available in the Code snippets and examples section.

When running a Galasa test with the Galasa CLI, terminal images are logged to the run log and PNG representations of the terminal screens can also be saved to the Result Archive Store (RAS) as the outputs are now controlled by the zos3270.terminal.output CPS property.

The zos3270Terminal Manager supports Gherkin keywords.

Note: The feature for saving PNG representations of the terminal screens to the RAS is available in the current release as experimental code only.

Including the Manager in a test

To use the Zos3270Terminal Manager in a test you must import the @Zos3270Terminal annotation into the test, as shown in the following example:

@Zos3270Terminal(imageTag = "PRIMARY")
public ITerminal terminal;

To use the colour and highlight features in a test, import the following components into the test:

import dev.galasa.zos3270.spi.Colour;
import dev.galasa.zos3270.spi.Highlight;

You also need to add the Manager dependency into the pom.xml file if you are using Maven, or into the build.gradle file if you are using Gradle.

If you are using Maven, add the following dependencies into the pom.xml in the dependencies section:

<dependency>
<groupId>dev.galasa</groupId>
<artifactId>dev.galasa.zos3270.manager</artifactId>
</dependency>

If you are using Gradle, add the following dependencies into build.gradle in the dependencies closure:

dependencies {
compileOnly 'dev.galasa:dev.galasa.zos3270.manager'
}

Configuring

The following properties are used to configure the Zos3270Terminal Manager:

Configuration Properties

Annotations provided by the Manager

The following annotations are provided by the Zos3270Terminal Manager:

Code snippets and examples

terminal.waitForKeyboard().waitForTextInField("SIMPLATFORM LOGON SCREEN");

terminal.positionCursorToFieldContaining("Userid").tab().type("TESTER1")
        .positionCursorToFieldContaining("Password").tab().type("SYS1").enter();

terminal.waitForKeyboard().waitForTextInField("SIMBANK MAIN MENU").positionCursorToFieldContaining("===>")
        .tab().type("BANKTEST").enter();

terminal.positionCursorToFieldContaining("CUSTOMER NUMBER").cursorRight();
assertThat(terminal.retrieveColourAtCursor()).isEqualTo(Colour.TURQUOISE);

assertThat(terminal.retrieveColourAtPosition(5, 3)).isEqualTo(Colour.BLUE);

@Zos3270Terminal(primaryColumns = 80, primaryRows = 24)
        public ITerminal t2;

terminal.reportExtendedScreen(true, true, true, true, true, true, true);