cli updates

galasa-dev · Nov 1, 2023 · 9b1c779 · 9b1c779
1 parent c8808a7
commit 9b1c779
Show file tree

Hide file tree

Showing 4 changed files with 138 additions and 3 deletions.
diff --git a/src/markdown-pages/docs/cli-command-reference/installing-cli-tool.md b/src/markdown-pages/docs/cli-command-reference/installing-cli-tool.md
@@ -5,12 +5,13 @@ title: "Installing the Galasa CLI"
 
 This section provides details about prerequisite software requirements and information about how to download and install the Galasa command line interface tool (Galasa CLI) on your local machine. 
 
+
 ## Prerequisites
 
 | Software |  Description  |
 | :---- | :-------- | 
 | Java JDK  | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. |
-| Maven or Gradle  | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.8.x and later. |
+| Maven or Gradle  | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle 6.x releases. |
 | 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.| 
 
 
@@ -53,6 +54,74 @@ 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 <a href="https://sdkman.io" target="_blank"> SDKman</a> to install Java version 11 on a MacOS.
+1. Install SDKman by using the command: 
+`curl -s "https://get.sdkman.io" | bash`   
+2. Run the following command on the current command-line session:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+```
+3. List the available Java releases by running the command:
+`sdk list java`
+4. Install the Semeru Java 11 release:
+`sdk install java 11.0.16.1-sem`
+5. Add the following information to your shell’s initialization file:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+export SDKMAN_JAVA_VERSION="11.0.16.1-sem"
+sdk default java ${SDKMAN_JAVA_VERSION}
+sdk use java ${SDKMAN_JAVA_VERSION}
+```
+
+
+
+## Installing Maven
+
+Install Maven 3.8 or later. The following example uses Homebrew:
+
+1. Run the following command to install Maven:
+```
+brew update
+brew install maven
+```
+2. Add the follwing information to your `~/.m2/settings.xml` file:
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+  <pluginGroups>
+    <pluginGroup>dev.galasa</pluginGroup>
+  </pluginGroups>
+  <profiles>
+    <profile>
+      <id>galasa</id>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <pluginRepositories>
+        <pluginRepository>
+          <id>galasa.repo</id>
+          <url>https://nexus.galasa.dev/repository/master</url>
+        </pluginRepository>
+      </pluginRepositories>
+    </profile>    
+  </profiles>
+
+</settings>
+This information tells Maven where to find some custom Maven plug-in tools that are used by the build.
+
+
+## Installing Gradle
+
+1. Install <a href="https://gradle.org/install/" target="_blank"> Gradle</a> version 6.x. *Note:* Gradle version 7.x is not currently supported.
+2. Put Gradle on your PATH by adding the following information to your shell’s initialization file:
+```
+export PATH="/opt/homebrew/opt/gradle@6/bin:$PATH"
+gradle --version | grep "Gradle" | cut -f2 -d' '
+```
 
 ## Next steps
 

diff --git a/src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md b/src/markdown-pages/docs/cli-command-reference/running-simbank-tests-cli.md
@@ -10,7 +10,7 @@ Galasa SimBank comes with a selection of prepared Galasa tests:
 - A test that uses a provisioned account object to perform the same test as `BasicAccountCreditTest.java` in an improved test design - `ProvisionedAccountCreditTests.java`.
 - A test that exercises the z/OS Batch Manager by simulating the submission of a JCL job to add a number of accounts to the SimBank system - `BatchAccountsOpenTest.java`.
 
-The following section explains how to run the `SimBankIVT` test class by using the CLI. 
+The following sections explain how to run the `SimBankIVT` test class by using the CLI. 
 
 ## Running the SimBank IVT test class by using the CLI
 

diff --git a/src/markdown-pages/docs/first-steps/installing-offline.md b/src/markdown-pages/docs/first-steps/installing-offline.md
@@ -29,13 +29,45 @@ Depending on how you use Galasa, there are several software prerequisites, some
 | Software |  Description  |
 | :---- | :-------- | 
 | Java JDK  | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. |
-| Gradle  | Required to install the zipped distribution. You can also build Galasa projects using Gradle (or you can use Maven to build projects if you prefer). Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.8.x and later.|
+| Gradle  | Required to install the zipped distribution. You can also build Galasa projects using Gradle (or you can use Maven to build projects if you prefer). Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.8.x and later. If you are using Eclipse, you do not explicitly need to install Maven because the Galasa plugin downloads and installs it silently during its own installation and configuration. |
 | Eclipse | Required. Provides the ability to interact with and use Galasa. See [Getting started using Eclipse](/docs/getting-started) documentation for more information about installation requirements.  | 
 | Docker  | Required if using the Docker image. If you want to deploy the Docker image that is provided in the zip file, you will need to have Docker installed.  |
 | Maven  | Optional (as Gradle is required). You can use Maven rather than Gradle to build Galasa projects. You do not explicitly need to install Maven because the Galasa plugin downloads and installs it silently during its own installation and configuration. |
 | 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 <a href="https://sdkman.io" target="_blank"> SDKman</a> to install Java version 11 on a MacOS.
+1. Install SDKman by using the command: 
+`curl -s "https://get.sdkman.io" | bash`   
+2. Run the following command on the current command-line session:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+```
+3. List the available Java releases by running the command:
+`sdk list java`
+4. Install the Semeru Java 11 release:
+`sdk install java 11.0.16.1-sem`
+5. Add the following information to your shell’s initialization file:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+export SDKMAN_JAVA_VERSION="11.0.16.1-sem"
+sdk default java ${SDKMAN_JAVA_VERSION}
+sdk use java ${SDKMAN_JAVA_VERSION}
+```
+
+## Installing Gradle
+
+1. Install <a href="https://gradle.org/install/" target="_blank"> Gradle</a> version 6.x. *Note:* Gradle version 7.x is not currently supported.
+2. Put Gradle on your PATH by adding the following information to your shell’s initialization file:
+```
+export PATH="/opt/homebrew/opt/gradle@6/bin:$PATH"
+gradle --version | grep "Gradle" | cut -f2 -d' '
+```
+
 ## Unpacking the zip file
 
 Extract the contents of the zip file into a directory of your choice.

diff --git a/src/markdown-pages/docs/first-steps/installing-online.md b/src/markdown-pages/docs/first-steps/installing-online.md
@@ -23,6 +23,40 @@ 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 <a href="https://sdkman.io" target="_blank"> SDKman</a> to install Java version 11 on a MacOS.
+1. Install SDKman by using the command: 
+`curl -s "https://get.sdkman.io" | bash`   
+2. Run the following command on the current command-line session:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+```
+3. List the available Java releases by running the command:
+`sdk list java`
+4. Install the Semeru Java 11 release:
+`sdk install java 11.0.16.1-sem`
+5. Add the following information to your shell’s initialization file:
+```
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk version
+export SDKMAN_JAVA_VERSION="11.0.16.1-sem"
+sdk default java ${SDKMAN_JAVA_VERSION}
+sdk use java ${SDKMAN_JAVA_VERSION}
+```
+
+
+## Installing Gradle
+
+1. Install <a href="https://gradle.org/install/" target="_blank"> Gradle</a> version 6.x. *Note:* Gradle version 7.x is not currently supported.
+2. Put Gradle on your PATH by adding the following information to your shell’s initialization file:
+```
+export PATH="/opt/homebrew/opt/gradle@6/bin:$PATH"
+gradle --version | grep "Gradle" | cut -f2 -d' '
+```
+
+
 ## Installing the Galasa plug-in
 
 1. Launch Eclipse. If present, close any initial welcome screen.