Mainframe Test library for Robot Framework
Project description
Mainframe3270Library
Introduction
Mainframe3270 is a library for Robot Framework based on the py3270 project, a Python interface to x3270, an IBM 3270 terminal emulator. It provides an API to a x3270 or s3270 subprocess.
Compatibility
Mainframe3270 requires Python 3. It is tested with Python 3.7 and 3.10, but should support all versions in between these.
Installation
In order to use this library, first install the package from PyPI.
pip install robotframework-mainframe3270
Or you can upgrade with:
pip install --upgrade robotframework-mainframe3270
Then, depending on your OS, proceed with the corresponding chapters in this README.
Windows
You need to install the x3270 project and put the directory on your PATH.
The default folder is "C:\Program Files\wc3270". This needs to be in the PATH
environment variable.
Unix
You can install the x3270 project from the instructions page. Or if it is available in your distribution through:
sudo apt-get install x3270
or
brew install x3270
More information can be found on the Wiki page of this project.
Example
*** Settings ***
Library Mainframe3270
*** Test Cases ***
Example
Open Connection Hostname LUname
Change Wait Time 0.4 seconds
Change Wait Time After Write 0.4 seconds
Set Screenshot Folder C:\\Temp\\IMG
${value} Read 3 10 17
Page Should Contain String ENTER APPLICATION
Wait Field Detected
Write Bare applicationname
Send Enter
Take Screenshot
Close Connection
Keyword Documentation
You can find the keyword documentation here.
Importing
Arguments:
- visible = True
- timeout = 30
- wait_time = 0.5
- wait_time_after_write = 0
- img_folder = .
- run_on_failure_keyword = Take Screenshot
By default the emulator visibility is set to visible=True. In this case test cases are executed using wc3270 (Windows) or x3270 (Linux/MacOSX). You can change this by setting visible=False. Then test cases are run using ws3720 (Windows) or s3270 (Linux/MacOS). This is useful when test cases are run in a CI/CD-pipeline and there is no need for a graphical user interface.
Timeout, waits and screenshot folder are set on library import as shown above. However, they can be changed during runtime. To modify the wait_time
, see Change Wait Time,
to modify the img_folder
, see Set Screenshot Folder,
and to modify the timeout
, see the Change Timeout keyword.
Timeouts support all available Robot Framework time formats.
By default, Mainframe3270 will take a screenshot on failure. You can overwrite this to run any other keyword by setting the run_on_failure_keyword
option. If you pass None
to this argument, no keyword will be run. To change the run_on_failure_keyword
during runtime, see Register Run On Failure Keyword.
Running with Docker
The Docker image contains everything that is needed to run Mainframe tests. Currently the image is not published to Docker Hub. In order to use it, perform the following steps.
- Download the Dockerfile sources
curl -O https://raw.githubusercontent.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/master/Dockerfile
curl -O https://raw.githubusercontent.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/master/entrypoint.sh
- Build the image:
docker build -t mainframe3270 .
- Run the container
docker run --user mfuser -v /path/to/your/tests:/home/mfuser/tests mainframe3270 robot /home/mfuser/tests
Contributing to Robot-Framework-Mainframe3270-Library
Interested in contributing to the project? Great to hear! Whether you found a bug, or want to develop a new feature, please refer to our Contributing Guidelines to help you get started.
Keyword Tests
To run all the library tests, you will need to create a user on the pub400 website.
WIKI
For more information visit the repository Wiki.
Authors
- Altran - Altran Web Site
- Samuel Cabral
- Joao Gomes
- Bruno Calado
- Ricardo Morgado
License
This project is licensed under the MIT License - see LICENSE.md for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for robotframework-mainframe3270-3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e88a3efa79ce04ef7c2cc9352bde99911ef6fca4f7595bd2e77aac59d1f2f211 |
|
MD5 | 51fb35f8e70297d009438a093350a23f |
|
BLAKE2b-256 | cb268a6a522256e19e9e81f922957b4f1cda2d10091a8aa63046cdda3417c903 |