WebAppIntegrationTest

The WebAppIntegrationTest is somewhat different to the previously described Galasa SimBank tests. It shows how you can use Galasa to test a hybrid cloud application that uses a mix of platforms and technologies. A mix of technologies makes end-to-end integration testing complicated. Use the WebAppIntegrationTest to help understand how Galasa simplifies integration testing in such an environment. The SimBank Web App Integration test is available in the Galasa simplatform repository in GitHub.

About the WebAppIntegrationTest

This test performs a similar function to the ProvisionedAccountCreditTest.java but includes the use of the Selenium Manager. The Selenium Manager enables the test to run Selenium WebDrivers which drive the SimBank Web Application that is provided with Galasa SimBank.

The WebAppIntegrationTest performs the following functions:

Generates a random account number
Uses a 3270 application to ensure that this account number does not exist in SimBank
If the account does not exist, invokes a batch job to create the account
Uses Selenium to drive the SimBank Web Application to credit the account with some funds
Runs the 3270 application again to validate that the expected funds were added to the account

Running the WebAppIntegrationTest

As the WebAppIntegrationTest is slightly different to the other tests, there's a bit more set up to do than for the other supplied SimBank tests.

The test is still run locally but is designed to help you to understand how to set the properties that enable the test to run in a Galasa Ecosystem. When running the WebAppIntegrationTest locally, use the localhost setting 127.0.0.1 to ensure that only the local machine is able to connect. You could then run the test in automation by simply updating your CPS properties to the relevant resource definition. For example, to use a remote server as a Docker Engine, simply change the default engine from LOCAL to REMOTE and specify the appropriate connection details. No change is required to the test code, only to the CPS properties file.

The test uses the Selenium Manager, which in turn is dependent on the Docker Manager. Use the following sections to help you to understand how to configure your environment to work with the Selenium Manager and Docker Manager.

Using the Selenium Manager

To use the Selenium Manager you must have a web browser, for example, Firefox or Chrome installed as well as a browser driver, for example, GeckoDriver or ChromeDriver. In this example, Firefox and GeckoDriver are used.

You can download GeckoDriver from GitHub.

You must define the default and local driver properties in the CPS, as shown in the following example:

selenium.default.driver=FIREFOX
selenium.local.driver.FIREFOX.path=<path/to/geckodriver>

Using the Docker Manager

The Selenium Manager has a dependency on the Docker Manager in order to run. Some set up is required for the Docker Manager in the CPS properties file. To configure the Docker Manager, set the following CPS properties:

docker.dse.engine.PRIMARY=LOCAL
docker.default.engines=LOCAL
docker.engine.LOCAL.hostname=127.0.0.1
docker.engine.LOCAL.port=2375
docker.engine.LOCAL.max.slots=10

These properties allow local test runs to access the local Docker Engine when the TCP port of the local Docker Engine is enabled.

Galasa interacts with Docker by using the Docker Engine API. In a typical infrastructure, you would expose the socket to TCP traffic. As we are running the test locally in this example, a temporary bridging mechanism is used to allow access to the socket via a container. This set up makes it easy to control the opening and closing of the socket to accept traffic.

After updating the CPS properties for the Docker Manager, run the following terminal commands to open a TCP socket for accessing the Docker Engine API:

docker pull alpine/socat
docker run -d -p 127.0.0.1:2375:2375 -v /var/run/docker.sock:/var/run/docker.sock alpine/socat tcp-listen:2375,fork,reuseaddr unix-connect:/var/run/docker.sock

Although this configuration might see a little strange when running locally, the idea is to make the example consistent with the configuration that would be undertaken if contacting a remote Docker server in a Galasa Ecosystem.

Building a Docker image

Complete the following steps to build a Docker image called simbank-webapp to use in the test. We plan to automate these manual steps in a future release.

If you have not done so already, clone the Galasa simplatform repository on your machine by running the following command in the directory on your local machine in which you want to clone the repository files:
```
git clone https://github.com/galasa-dev/simplatform.git
```
Build the image and test that the container is working correctly by running the following commands. For the commands to work, the terminal must be running in the same directory as the one that contains the Dockerfile. The Dockerfile is located in the galasa-simplatform-webapp directory in the Galasa simplatform repository.
```
mvn install
docker image build -t simbank-webapp .
docker run -p 8080:8080 -d simbank-webapp
```
Access the Galasa SimBank web application from http://localhost:8080/galasa-simplatform-webapp/simbank

Troubleshooting

If the container is not working correctly, for example, compilation and runtime errors are returned, check the version of tomcat in the Dockerfile. You might need to edit the tomcat version to a version that is compatible with Java 11, for example, FROM tomcat:8.5.82-jre11-temurin.

Walkthrough - WebAppIntegrationTest

To run the test, follow the same steps as for SimBankIVT.java but using the test class name WebAppIntegrationTest instead of SimBankIVT.

For brevity, package declarations and imports are omitted in the following walkthrough.

First, some objects are declared and then the provisionAccount() method is specified:

String accountNumber = provisionAccount(openingBalance);
logger.info("Account number selected: " + accountNumber);

The provisionAccount() method generates a random account number to use in the test, using a 3270 SimBank terminal to ensure that the generated account does not exist:

public String provisionAccount(BigDecimal openingBalance) throws Exception {
		// Generate a random account number
		String accountNumber =  generateRandomAccountNumber();
		boolean searching = true;
		
		// A looped search to ensure the account number is unique.
		while (searching) {
			if (doesAccountExist(accountNumber)) {
				accountNumber =  generateRandomAccountNumber();
			} else {
				searching = false;
			}
		}

The account is opened and credited by using a z/OS Batch Job. When the amount to be credited is set, a HashMap is prepared with the parameters for the subsequent web services call:

HashMap<String, Object> parameters = new HashMap<>();
parameters.put("CONTROL", "ACCOUNT_OPEN");
parameters.put("DATAIN", accountNumber+",20-24-09,"+openingBalance);

The following code enables Selenium to drive the SimBank Web Application to credit the account with some funds:

public IWebPage completeWebFormAndSubmit(String accountNumber, String creditAmount)
		throws SimBankManagerException, WebDriverException {
	String webpage = webApp.getHostName() + "/galasa-simplatform-webapp/simbank";
	// Selenium Options to run the driver headlessly
	IFirefoxOptions options = webDriver.getFirefoxOptions();


	// Open the Simbank Web Application in a Firefox browser
	IWebPage page = webDriver.allocateWebPage(webpage, options);
	page.takeScreenShot();
	assertThat(page.getTitle()).containsOnlyOnce("Simbank");
		
	// Fill in the Form and submit
	page.sendKeysToElementById("accnr", accountNumber);
	page.sendKeysToElementById("amount", creditAmount);
	page.takeScreenShot();
	page.clickElementById("submit");

Checks are made to ensure that the web application response is as expected and that the data is updated throughout the application, including the backend database:

assertThat(page.waitForElementById("good").getText()).contains("You have successfully completed the transaction");
page.quit();
logger.info("Response from servlet OK. Now validating the data has been updated in the database");
BigDecimal balance = retrieveAccountBalance(accountNumber).setScale(2);
assertThat(balance).isEqualTo(openingBalance.add(creditAmount));
logger.info("Test method complete");

At the end of the test, the Selenium Manager automatically closes the WebDriver which removes the web page.

Edit this page on GitHub