Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gradle 8 #812

Merged
merged 4 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions src/markdown-pages/docs/cli-command-reference/cli-prereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,39 @@ title: "CLI prerequisites online"

The following section explains more about the software prerequisites that you need so that you are ready to install Galasa from the Galasa CLI repository in GitHub.

## 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. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.


### Maven

You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests.

### Gradle

You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests.

The following table shows the current compatibility between Gradle and Galasa versions:


| Gradle release | Compatible Galasa version |
| :---- | :-------- |
| 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. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.|
| 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.9.x. Remember to add Gradle to your Path. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell). |
| 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 [run Galasa Simbank online](../running-simbank-tests/simbank-cli), 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.|
| 6.8.x | All |
| 6.9.x | All |
| 7.x.x | All |
| 8.x.x | 0.36.0 or later |


If you are upgrading to Gradle version 8 from an earlier version, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](../upgrading) documentation to understand the changes you need to make to create Galasa projects and build and compile Galasa test code.

Remember to add Gradle to your PATH. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell).


### 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 [run Galasa Simbank online](../running-simbank-tests/simbank-cli), 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.


## Next steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,44 @@ title: "CLI prerequisites offline"
The following section explains more about the software prerequisites that you need to install so that you are ready to install the zipped distribution for Galasa for running offline.


## Prerequisites
### 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. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.

| Software | Description |
### Gradle

Required to install the offline zipped distribution. You can also build Galasa projects using Gradle. (You can build projects using Maven if you prefer). Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests.

The following table shows the current compatibility between Gradle and Galasa versions:


| Gradle release | Compatible Galasa version |
| :---- | :-------- |
| 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. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation. |
| Gradle | Required to install the zipped distribution. You can also build Galasa projects using Gradle. (You can build projects using Maven 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.9.x.|
| Maven | 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. You do not explicitly need to install Maven because the Galasa plugin downloads and installs it silently during its own installation and configuration. |
| 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. |
| 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 [run Galasa Simbank offline](../running-simbank-tests/simbank-cli-offline), 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.|
| 6.8.x | All |
| 6.9.x | All |
| 7.x.x | All |
| 8.x.x | 0.36.0 or later |


If you are upgrading to Gradle version 8 from an earlier version, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](../upgrading) documentation to understand the changes you need to make to create Galasa projects and build and compile Galasa test code.

Remember to add Gradle to your PATH. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell).




### Maven

You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests.


### 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.

### 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 [run Galasa Simbank online](../running-simbank-tests/simbank-cli), 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.


## Next steps
Expand Down
10 changes: 5 additions & 5 deletions src/markdown-pages/docs/ecosystem/ecosystem-installing-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Complete the following steps to install a Galasa Ecosystem by using Helm:
helm repo add galasa https://galasa-dev.github.io/helm
```
- If the repository exists, run the ```helm repo update``` command to get the latest versions of the packages and then run ```helm search repo galasa``` to see the available charts.<br>
_Note:_ The Galasa Ecosystem Helm chart deploys three persistent volumes (PVs). If you need to provide a Kubernetes storage class for these PVs, download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.35.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file and update the `storageClass` value in the file with the name of a valid storage class on your cluster. If you are deploying to minikube, you can optionally use the standard storage class that is created for you by minikube, but this is not required.
1. Download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.35.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file if you have not done so already, and edit the values of the following properties:
_Note:_ The Galasa Ecosystem Helm chart deploys three persistent volumes (PVs). If you need to provide a Kubernetes storage class for these PVs, download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.36.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file and update the `storageClass` value in the file with the name of a valid storage class on your cluster. If you are deploying to minikube, you can optionally use the standard storage class that is created for you by minikube, but this is not required.
1. Download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.36.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file if you have not done so already, and edit the values of the following properties:
- Set `galasaVersion` to the version of Galasa that you want to run. (See the [Releases](/releases) documentation for released versions). To ensure that each pod in the Ecosystem is running at the same level, do not use `latest` as the Galasa version.
- Set `externalHostname` to the DNS hostname or IP address of the Kubernetes node that is used to access the Galasa Ecosystem services. If you are deploying to minikube, the cluster's IP address can be retrieved by running `minikube ip`.

Expand Down Expand Up @@ -225,22 +225,22 @@ You can then deploy your Galasa tests to a Maven repository and set up a test st
## Upgrading the Galasa Ecosystem


Get the latest version of the Ecosystem chart and upgrade the Galasa Ecosystem to use the newer version of Galasa - for example version 0.35.0 - by running the following command:
Get the latest version of the Ecosystem chart and upgrade the Galasa Ecosystem to use the newer version of Galasa - for example version 0.36.0 - by running the following command:

On Mac or Unix:

```console
helm repo update \
helm upgrade <release-name> galasa/ecosystem --reuse-values \
--set galasaVersion=0.35.0 --wait
--set galasaVersion=0.36.0 --wait
```

On Windows (Powershell):

```console
helm repo update `
helm upgrade <release-name> galasa/ecosystem --reuse-values `
--set galasaVersion=0.35.0 --wait
--set galasaVersion=0.36.0 --wait
```

where:<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In order to run the Galasa SimBanks tests you need to add some configuration inf

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 [Running Galasa SimBank online](../running-simbank-tests/simbank-cli) documentation.

After cloning the repository, 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 uber OBR version `0.35.0`.
After cloning the repository, 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 uber OBR version `0.36.0`.

You can find the version of the `dev.galasa.simbank.obr` that you are using by looking in the `pom.xml` file in the `dev.galasa.simbank.obr` folder. The `dev.galasa.uber.obr` is the OBR that contains all the bundles that are needed for Galasa to work including Managers, any required dependencies, the framework, etc. The version of the `dev.galasa.uber.obr` depends on which version of Galasa you have installed.

Expand Down
54 changes: 47 additions & 7 deletions src/markdown-pages/docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,18 @@ path: "/docs/upgrading"
title: "Upgrading"
---

## Upgrading (online)

You can get the upgrade your version of Galasa by completing the following steps:
[Upgrading the Galasa version (online)](#Upgradeonline)<br>
[Upgrading the Galasa zipped distribution version (offline)](#Upgradeoffline)<br>
[Upgrading tests to compile using Gradle version 8](#UpgradeGradle)<br>
[Moving from Eclipse to the Galasa CLI](#EclipsetoCLI)<br>
[Upgrading tests created against an earlier version of Galasa](#Upgradingtests)<br>
[Troubleshooting](#Troubleshooting)<br>


## <a name="Upgradeonline"></a>Upgrading the Galasa version (online)

You can upgrade your version of Galasa by completing the following steps:

1. Download the appropriate version of the Galasa CLI for your machine architecture from the <a href="https://github.com/galasa-dev/cli/releases" target="_blank"> Galasa CLI repository</a> in GitHub.
2. Re-name the your existing `galasactl` binary so that you can re-name the Galasa binary that you just downloaded to `galasactl` to replace it.
Expand All @@ -14,13 +23,44 @@ You can get the upgrade your version of Galasa by completing the following steps
If you have already added the Galasa CLI path to your shell's initialization file, as described in the [Installing the Galasa CLI online](../docs/cli-command-reference/installing-cli-tool) topic, you should now be able to run the upgraded version of the Galasa CLI tool from any directory in your file system.


## Upgrading the Galasa zipped distribution using the command line (offline)
## <a name="Upgradeoffline"></a>Upgrading the Galasa zipped distribution version (offline)

Download and extract the Galasa zip file to a directory of your choice and complete the steps documented in the [Installing the Galasa CLI offline](../docs/cli-command-reference/installing-offline) topic.


## <a name="UpgradeGradle"></a>Upgrading tests to compile using Gradle version 8

Galasa releases 0.35.0 and earlier support the use of Gradle versions 6.8.x, 6.9.x, and 7.x.x to create Galasa projects and build Galasa test code. From release 0.36.0 and later, Galasa additionally supports the use of Gradle version 8.x.x.

To use Gradle version 8.0 or later to create Galasa projects and build and compile Galasa test code, complete the following steps:

1. Edit the `build.gradle` file in the OBR directory of your parent project, setting the plug-in values at the top of the file to version `0.36.0`, as shown in the following example:
```
plugins {
...
id 'dev.galasa.obr' version '0.36.0'
id 'dev.galasa.testcatalog' version '0.36.0'
...
}
```
2. Add the following task definition to the `build.gradle` file in the OBR directory of the parent project to ensure that Gradle uses the correct build order.

```groovy
tasks.withType(PublishToMavenLocal) { task ->
task.dependsOn genobr
task.dependsOn mergetestcat
}
```
3. In each test project `build.gradle` file, set the `dev.galasa.tests` plug-in to version `0.36.0` to ensure that the build uses the correct plug-in.
```
plugins {
...
id 'dev.galasa.tests' version '0.36.0'
...
}
```

## Upgrading from using Eclipse to using the command line (online)
## <a name="EclipsetoCLI"></a>Moving from Eclipse to the Galasa CLI

Version 0.31.0 is the last version of the Eclipse plug-in for Galasa that is produced and maintained by the Galasa Team.
You can work with later versions of Galasa by using the Galasa command line interface (CLI). The galasactl tool can do everything that the Eclipse tooling can do, and can be run from the command-line of any IDE, for example, the Eclipse terminal view.
Expand All @@ -38,8 +78,7 @@ To upgrade to a Galasa version that uses the CLI when your previous Galasa versi

If you encounter any difficulties, reach out for help in our <a href="https://openmainframeproject.slack.com/archives/C05TCCQDE65" target="_blank"> Galasa Slack</a> workspace in the `#galasa-users` channel.


## Upgrading existing tests
## <a name="Upgradingtests"></a>Upgrading tests created against an earlier version of Galasa

If you have a pre-built version of tests that were created against an earlier version of Galasa in your local repository, you need to rebuild those test projects and any associated Managers after ugprading, so that the pom.xml files of those tests and Managers specify the new version of Galasa.

Expand Down Expand Up @@ -73,7 +112,8 @@ A simple way to do this is to complete the following steps:
a. Go to *File > Preferences > Settings* and expand the *Extensions* section.<br><br>
b. Select *Galasa* and check that the *Version* field is using the default value of ```main```, to automatically select the latest version.

## Troubleshooting

## <a name="Troubleshooting"></a>Troubleshooting

If you have problems after completing the steps for upgrading, try running a clean install.

Expand Down
22 changes: 20 additions & 2 deletions src/markdown-pages/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,33 @@ We have the following available Slack channels:

Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and open issues in the [project management repository](https://github.com/galasa-dev/projectmanagement).

## 0.35.0 - Release Highlights

## 0.36.0 - Release Highlights

- You can now create Galasa projects and build and compile Galasa test code using Gradle version 8. For more information, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](docs/upgrading) documentation to understand the changes you need to make.

- Log into the Galasa Ecosystem and revoke a personal access token by using the `galasactl auth tokens delete` command.

- Set terminal size within Gherkin tests (previously only available in Java tests) and use Scenario Outlines.

- Various updates to the Galasa Web UI

- Various defect fixes

- Various documentation updates


<details>
<summary><b>0.35.0 - Release Highlights</b></summary>

- A fix to the database connector of the DB2 Manager
</details>


<details>
<summary><b>0.34.1 - Release Highlights</b></summary>

- Retrieve a list of all active personal access tokens in the Ecosystem by using the `galasactl auth tokens get` command. Use the information to revoke or delete an access token.
- Retrieve a list of all active personal access tokens in the Ecosystem by using the `galasactl auth tokens get` command. Use the information to revoke an access token.

- The default size of the PVC storage allocated by the Helm chart is increased from 1GB to 30GB and automatic history compaction is now turned on by default to minimise the risk of etcd running out of space.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const IndexPage = () => (
Learn more
</Button>
<Button target={"/releases"} flash={true} isPrimary={true}>
0.35.0 highlights
0.36.0 highlights
</Button>
</div>
</div>
Expand Down
Loading