run SB tests from cli #708

CaroMac · 2023-10-05T10:09:15Z

No description provided.

jt-nti

I wasn't able to get the tests to run :(

jt-nti · 2023-10-13T13:39:23Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+
+The SimBank tests are held in the <a href="https://github.com/galasa-dev/simplatform" target="_blank"> Galasa simplatform repository</a> in GitHub. To start running the tests you need to clone the repository and launch SimBank so that the tests are available on your local machine. To find out how to clone the cli repository and launch the SimBank application, follow the instructions in the `Launching SimBank` section in the [Exploring Galasa SimBank using the CLI]() documentation.
+
+After cloning the repository and launching SimBank, complete the following steps to run the SimBankIVT test that is provided with Galasa. The following example uses SimBank OBR version `0.25.0` and Galasa OBR version `0.29.0`.


What does "OBR" mean?

jt-nti · 2023-10-13T13:42:22Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+1. In a new terminal, navigate to your `simplatform` directory and run the following command to install and build your project:
+
+```
+mvn install


This doesn't work in the simplatform directory. Does it need to be run in both the galasa-simbank-tests and galasa-simplatform-application sub directories? If so, it might be better to convert simplatform into a multi-module project.

jt-nti · 2023-10-13T13:45:33Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+galasactl runs submit local --log - \
+--obr mvn:dev.galasa/dev.galasa.simbank.obr/0.25.0/obr \
+--obr mvn:dev.galasa/dev.galasa.uber.obr/0.29.0/obr \
+--class dev.galasa.simbank.tests/dev.galasa.simbank.tests.SimBankIVT 


I couldn't get this to work. I tried a few different directories to see if that helped but no luck. It might be useful to include a reminder to run galasactl local init (really weirdly the command fails to run if the bootstrap.properties file is missing but then tries to create it when it does exist!)

Now works with the "Updating the overrides and credentials property files" information! I did trip over running init again, and it might be useful to include an extract of the console output of a successful run just in case things don't go smoothly, e.g. like the run-locally.sh above.

jt-nti · 2023-11-09T14:05:48Z

Adding settings to overrides.properties and credentials.properties got the tests running! 🎉

galasa.dev/src/markdown-pages/docs/first-steps/installing-online.md

Line 61 in f20db23

    
           1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains:

jt-nti

Very happy I could run some Galasa tests with the updated docs, thank you! A few minor comments but it would be great to get these updates published.

jt-nti · 2023-11-09T14:55:40Z

src/markdown-pages/docs/first-steps/installing-offline.md

@@ -99,7 +124,7 @@ dss.properties
   Setup complete
   ```
 1. Locate your user home directory and confirm it contains a `.galasa` folder. On Windows, the user home directory resembles: `C:\Users\<username>`, on MacOS it will be `/Users/<username>` and on Linux `/home/<username>`.  Note that any file or folder beginning with a `.` is a hidden folder, so you might need to change the settings on your operating system to show hidden files.
-1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains:
+1. EEdit a file called `overrides.properties` in your `.galasa` folder so that it contains the following configuration properties. Configuration properties held in this file is used by Galasa tests at runtime. You can change the value of the properties that are set in this file to enable you to run tests against different configurations without changing the test code. The following example configuration properties enable the provided Galasa SimBank tests to run on your machine:


"EEdit" typo. Maybe, "Configuration properties held in this file are used by Galasa tests at runtime." instead of is used?

jt-nti · 2023-11-09T14:56:54Z

src/markdown-pages/docs/first-steps/installing-offline.md

@@ -118,7 +143,7 @@ dss.properties
   zosmf.server.SIMBANK.port=2040
   zosmf.server.SIMBANK.https=false
   ```
-1. Edit a file called `credentials.properties` in your `.galasa` folder so that it contains:
+1. Edit a file called `credentials.properties` in your `.galasa` folder. Credentials that are held in this file are used by Galasa tests, for example to pass credentials to the application being tested. Storing values in this file avoids the need to hard-code credentials inside a test class, enabling the test to run in different environments without changing any test code. The following example properties enable the provided Galasa SimBank tests to run on your machine:


Looks good!

jt-nti · 2023-11-09T14:58:08Z

src/markdown-pages/docs/first-steps/installing-online.md

@@ -23,6 +23,31 @@ Depending on how you plan to use Galasa, there are several software prerequisite
 | 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to explore Galasa Simbank, a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| 


+## Installing Java 
+
+Install a Java version 11 JDK or later. We do not currently support Java 17 or later. The following example uses Homebrew to install Java version 11 on a MacOS.


Adding a link to Homebrew could be helpful

jt-nti · 2023-11-09T14:59:55Z

src/markdown-pages/docs/first-steps/installing-online.md

@@ -58,7 +83,7 @@ dss.properties
   Setup complete
   ```
 1. Locate your user home directory and confirm it contains a `.galasa` folder. On Windows, the user home directory resembles: `C:\Users\<username>`, on MacOS it will be `/Users/<username>` and on Linux `/home/<username>`.  Note that any file or folder beginning with a `.` is a hidden folder, so you might need to change the settings on your operating system to show hidden files.
-1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains:
+1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains the following configuration properties. Configuration properties held in this file is used by Galasa tests at runtime. You can change the value of the properties that are set in this file to enable you to run tests against different configurations without changing the test code. The following example configuration properties enable the provided Galasa SimBank tests to run on your machine:


"are used" again?

jt-nti · 2023-11-09T15:10:00Z

src/markdown-pages/docs/cli-command-reference/installing-cli-tool.md

@@ -46,6 +46,86 @@ On Windows (Powershell)

 You can now run the Galasa CLI too from any directory in your file system without having to specify the absolute path.

+## Installing Java 
+
+Install a Java version 11 JDK or later. We do not currently support Java 17 or later. The following example uses Homebrew to install Java version 11 on a MacOS.


Adding a link to Homebrew could be helpful

jt-nti · 2023-11-09T15:12:56Z

src/markdown-pages/docs/cli-command-reference/installing-cli-tool.md

+brew update
+brew install maven
+```
+2. Add the follwing information to your `~/.m2/settings.xml` file:


"follwing" typo.

Also, is this manual step required? It seems to have been added automatically to my settings file.

jt-nti · 2023-11-09T15:13:50Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+In order to run the Galasa SimBanks tests you need to add some configuration information in the `overrides.properties` and `credentials.properties` files that were created when you initialised your Galasa home folder by running the ```galasactl local init``` command. Complete the following steps to edit the files:
+
+
+1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains the following configuration properties. Configuration properties held in this file is used by Galasa tests at runtime. You can change the value of the properties that are set in this file to enable you to run tests against different configurations without changing the test code. The following example configuration properties enable the provided Galasa SimBank tests to run on your machine:


"are used"?

jt-nti · 2023-11-09T15:16:02Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+
+The following sections explain how to run the `SimBankIVT` test class by using the CLI. Make sure that you have installed the Galasa CLI tool and Java version 11 JDK, and set the JAVA_HOME environment variable, as described in the _Installing the Galasa CLI_ documentation. 
+
+## Updating the overrides and credentials property files


Nice, this was the information I needed to get the tests running!

jt-nti · 2023-11-09T15:17:21Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+
+## Running the SimBank IVT test class by using the CLI
+
+The SimBank tests are held in the <a href="https://github.com/galasa-dev/simplatform" target="_blank"> Galasa simplatform repository</a> in GitHub. To start running the tests you need to clone the repository, if you have not already done so. To find out how to clone the cli repository, follow the instruction in the `Launching SimBank` section in the [Exploring Galasa SimBank using the CLI]() documentation.


Missing link for "Exploring Galasa SimBank using the CLI"

jt-nti · 2023-11-09T15:21:50Z

src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md

+galasactl runs submit local --log - \
+--obr mvn:dev.galasa/dev.galasa.simbank.obr/0.25.0/obr \
+--obr mvn:dev.galasa/dev.galasa.uber.obr/0.29.0/obr \
+--class dev.galasa.simbank.tests/dev.galasa.simbank.tests.SimBankIVT 


Now works with the "Updating the overrides and credentials property files" information! I did trip over running init again, and it might be useful to include an extract of the console output of a successful run just in case things don't go smoothly, e.g. like the run-locally.sh above.

run SB tests from cli

ecdcbdb

jt-nti reviewed Oct 13, 2023

View reviewed changes

CaroMac added 2 commits October 30, 2023 09:33

cli sb test updates

c8808a7

cli updates

9b1c779

CaroMac force-pushed the SBtestsonCLI branch from d71f41f to 9b1c779 Compare November 1, 2023 08:58

CaroMac added 3 commits November 6, 2023 13:21

update info for running local SB tests using CLI

d6d28f7

fix ordering of other areas

f79d77d

add properties updates

861bc0a

CaroMac force-pushed the SBtestsonCLI branch from bd284ea to 861bc0a Compare November 9, 2023 13:49

fix links

63ebbb0

CaroMac force-pushed the SBtestsonCLI branch from a19d5e1 to 63ebbb0 Compare November 9, 2023 14:15

fix last link

671be55

CaroMac force-pushed the SBtestsonCLI branch from 8b37fa2 to 671be55 Compare November 9, 2023 14:28

Merge branch 'next' into SBtestsonCLI

3b2a926

CaroMac requested a review from jt-nti November 9, 2023 14:39

jt-nti approved these changes Nov 9, 2023

View reviewed changes

eamansour approved these changes Nov 9, 2023

View reviewed changes

CaroMac merged commit 60a32ba into galasa-dev:next Nov 9, 2023
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

run SB tests from cli #708

run SB tests from cli #708

CaroMac commented Oct 5, 2023

jt-nti left a comment

jt-nti Oct 13, 2023

jt-nti Oct 13, 2023

jt-nti Oct 13, 2023

jt-nti Nov 9, 2023

jt-nti commented Nov 9, 2023

jt-nti left a comment

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023

jt-nti Nov 9, 2023


		The SimBank tests are held in the <a href="https://github.com/galasa-dev/simplatform" target="_blank"> Galasa simplatform repository</a> in GitHub. To start running the tests you need to clone the repository and launch SimBank so that the tests are available on your local machine. To find out how to clone the cli repository and launch the SimBank application, follow the instructions in the `Launching SimBank` section in the [Exploring Galasa SimBank using the CLI]() documentation.

		After cloning the repository and launching SimBank, complete the following steps to run the SimBankIVT test that is provided with Galasa. The following example uses SimBank OBR version `0.25.0` and Galasa OBR version `0.29.0`.

		In order to run the Galasa SimBanks tests you need to add some configuration information in the `overrides.properties` and `credentials.properties` files that were created when you initialised your Galasa home folder by running the ```galasactl local init``` command. Complete the following steps to edit the files:


		1. Edit a file called `overrides.properties` in your `.galasa` folder so that it contains the following configuration properties. Configuration properties held in this file is used by Galasa tests at runtime. You can change the value of the properties that are set in this file to enable you to run tests against different configurations without changing the test code. The following example configuration properties enable the provided Galasa SimBank tests to run on your machine:


		The following sections explain how to run the `SimBankIVT` test class by using the CLI. Make sure that you have installed the Galasa CLI tool and Java version 11 JDK, and set the JAVA_HOME environment variable, as described in the _Installing the Galasa CLI_ documentation.

		## Updating the overrides and credentials property files


		## Running the SimBank IVT test class by using the CLI

		The SimBank tests are held in the <a href="https://github.com/galasa-dev/simplatform" target="_blank"> Galasa simplatform repository</a> in GitHub. To start running the tests you need to clone the repository, if you have not already done so. To find out how to clone the cli repository, follow the instruction in the `Launching SimBank` section in the [Exploring Galasa SimBank using the CLI]() documentation.

run SB tests from cli #708

run SB tests from cli #708

Conversation

CaroMac commented Oct 5, 2023

jt-nti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jt-nti commented Nov 9, 2023

jt-nti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment