Skip to content

Commit

Permalink
Merge branch 'next' into SBtestsonCLI
Browse files Browse the repository at this point in the history
  • Loading branch information
CaroMac authored Nov 9, 2023
2 parents 861bc0a + 0fd2f2b commit a19d5e1
Show file tree
Hide file tree
Showing 21 changed files with 433 additions and 47 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,14 @@ jobs:
run: ./gradlew --info libertyPackage
working-directory: package-jar

- name: Publish with Gradle
if: ${{ github.ref == 'refs/heads/staging' || github.ref == 'refs/heads/next' }}
run: ./gradlew --info publish
working-directory: package-jar
env:
ORG_GRADLE_PROJECT_galasaNexusUsername: ${{ secrets.NEXUS_USERNAME }}
ORG_GRADLE_PROJECT_galasaNexusPassword: ${{ secrets.NEXUS_PASSWORD }}

- name: Upload JAR
uses: actions/upload-artifact@v3
with:
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
This repository contains the source for the Galasa test automation system homepage.

If you are interested in the development of Galasa, take a look at the documentation and feel free to post a question in our <a href="https://galasa.slack.com" target="_blank"> Galasa Slack</a> workspace. <a href="https://join.slack.com/t/galasa/shared_invite/zt-ele2ic8x-VepEO1o13t4Jtb3ZuM4RUA" target="_blank"> Register to join</a> first if you're not yet a member.

We have the following available Slack channels:

- `#galasa-dev` - for developers of Galasa code or Galasa extensions
- `#galasa-users` - for users comments, and for making announcements
- `#galasa-tsc` - for technical steering committee discussions on longer term over-arching issues relating to Galasa

You can raise new ideas / features / bugs etc. as issues on [GitHub](https://github.com/galasa-dev/projectmanagement).

## Getting started
Expand Down
2 changes: 1 addition & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const consts = {
githubRepoName: "galasa.dev",
githubOrgName: "galasa-dev",
twitterUrl: "",
slackUrl: "https://join.slack.com/t/galasa/shared_invite/zt-ele2ic8x-VepEO1o13t4Jtb3ZuM4RUA",
slackUrl: "https://openmainframeproject.slack.com/signup#/domain-signup",
algolia: {
appId: "0CBS2VLS6S",
apiKey: "46b619eff7e9e3900835e17fc7aa880b",
Expand Down
7 changes: 6 additions & 1 deletion src/data/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@
path: /docs/cli-command-reference/cli-runs-submit-local
- title: Debugging a test locally
path: /docs/cli-command-reference/cli-runs-local-debug
- title: Exploring Galasa SimBank using the CLI
path: /docs/cli-command-reference/simbank-cli
- title: Running the SimBank tests using the CLI
path: /docs/running-simbank-tests-cli
- title: Viewing test results locally
Expand All @@ -58,7 +60,7 @@
path: /docs/getting-started/installing-online
- title: Installing the Galasa plug-in offline
path: /docs/getting-started/installing-offline
- title: Exploring Galasa SimBank
- title: Exploring Galasa SimBank using Eclipse
path: /docs/getting-started/simbank
- title: Creating a project using Eclipse
path: /docs/running-simbank-tests/setting-up-galasa-project-eclipse
Expand Down Expand Up @@ -101,6 +103,9 @@
path: /docs/ecosystem/installing/k8s
- title: Test streams
path: /docs/writing-own-tests/test-streams
- title: Managing integrated test runs
path: /docs/ecosystem/cps

- title: Selecting tests to run in the Ecosystem
path: /docs/cli-command-reference/ecosystem-cli-runs-prepare
- title: Running tests in the Ecosystem
Expand Down
8 changes: 7 additions & 1 deletion src/markdown-pages/docs/blogs/galasa-blog-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,13 @@ Find out more about [describe and link to relevant content inside galasa.dev](/d

Find out more about <a href="url" target="_blank">describe and link to content outside of galasa.dev</a>

Got a question or a new idea? Join our <a href="https://galasa.slack.com" target="_blank"> Galasa Slack</a> workspace where we discuss new features and provide support for each other. <a href="https://join.slack.com/t/galasa/shared_invite/zt-ele2ic8x-VepEO1o13t4Jtb3ZuM4RUA" target="_blank"> Register to join</a> first if you're not yet a member.
Got a question or a new idea? Join our <a href="https://openmainframeproject.slack.com/archives/C05TCCQDE65" target="_blank"> Galasa Slack</a> workspace where we discuss new features and provide support for each other. <a href="https://openmainframeproject.slack.com/signup#/domain-signup" target="_blank"> Register to join</a> first if you're not yet a member.

We have the following available Slack channels:

- `#galasa-dev` - for developers of Galasa code or Galasa extensions
- `#galasa-users` - for users comments, and for making announcements
- `#galasa-tsc` - for technical steering committee discussions on longer term over-arching issues relating to Galasa

Want to start contributing? Check out the [Contributing to Galasa guidelines](https://github.com/galasa-dev/projectmanagement/blob/main/contributing.md) to propose fixes, add new features or improve the software and documentation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,21 @@ title: "Getting started using the Galasa CLI"
---


If you are installing Galasa for using in the command-line, you can use the Galasa command line interface tool (Galasa CLI) to interact with Galasa to complete tasks, for example, to create Galasa projects, submit tests to an ecosystem, view test results and download test artifacts. You can use the same set of Galasa CLI commands to run a given task, regardless of the technology that you are using.

If you are installing Galasa for using in the command-line, you can use the Galasa command line interface tool (Galasa CLI) to interact with Galasa to complete tasks, for example, submitting and monitoring Galasa test runs. You can use the same set of Galasa CLI commands to run a given task, regardless of the technology that you are using.

Read on to understand more about the prerequisites that you need to install so that you can start using the Galasa CLI.


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




## Next steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,10 @@ path: "/docs/cli-command-reference/installing-cli-tool"
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
This section provides details about how to download and install the Galasa command line interface tool (Galasa CLI) on your local machine and tells you a little bit about getting started with the Galasa CLI commands.

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


## Downloading the Galasa CLI
Expand All @@ -21,14 +15,14 @@ To install Galasa for using in the command-line you first need to download the b

The following versions of the Galasa CLI are available to download for different operating systems and machine architectures:

| Operating system | Download |
| :---- | :-------- |
| MacOSX | galasactl-darwin-x86_64 |
| MacOSX | galasactl-darwin-arm64 |
| Linux 64-bit x86 | galasactl-linux-x86_64 |
| Linux arm64 | galasactl-linux-arm64 |
| zLinux | galasactl-linux-s390x |
| Windows | galasactl-windows-x86_64.exe |
| Operating system | Architecture | Download |
| :---- | :---- | :-------- |
| MacOSX | x86_64 | galasactl-darwin-x86_64 |
| MacOSX | arm64 | galasactl-darwin-arm64 |
| Linux | x86_64 | galasactl-linux-x86_64 |
| Linux arm64 | arm64 | galasactl-linux-arm64 |
| zLinux | s390x| galasactl-linux-s390x |
| Windows | x86_64| galasactl-windows-x86_64.exe |


## Installing the Galasa CLI
Expand All @@ -41,7 +35,7 @@ On Mac or Unix:
2. Download the appropriate binary of the Galasa CLI for your machine architecture from the [Galasa cli repository](https://github.com/galasa-dev/cli/releases) in GitHub and re-name it to `galasactl`.
3. Add Galasa CLI to your PATH to enable you to run CLI commands from anywhere on your file system without having to specify the absolute path. To set the path permanently, you need add the Galasa CLI path to your shell's initialization file. For example, if you downloaded the galasactl executable to a folder called `~/tools` in your home directory, you need to add `~/tools` to the list of directories that your shell searches through when you enter a command. You can do this by adding the line ```export PATH=$PATH:$HOME/tools``` to your shell’s initialization file (for example `~/.bashrc` or `~/.zshrc`).
4. Set execute permission on the binary by running the `chmod +x galasactl` command in the directory containing `galasactl`.
5. If you are using a Mac, you can set permission to open the Galasa CLI tool by running the `spctl --add galasactl` command in the directory containing `galasactl`. You are prompted by a security panel asking you to log in to show that you are issuing the command.
5. If you are using a Mac, you can set permission to open the Galasa CLI tool by running the `sudo spctl --add galasactl` command in the directory containing `galasactl`.

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

Expand Down Expand Up @@ -135,6 +129,38 @@ export PATH="/opt/homebrew/opt/gradle@6/bin:$PATH"
gradle --version | grep "Gradle" | cut -f2 -d' '
```

## About Galasa CLI commands

Galasa CLI commands start with `galasactl`. Example commands are provided for running on Mac or Unix, and Windows Powershell. The Windows Powershell uses the backtick (`) for line continuation characters. If you are using Windows command-shell, the line continuation character is the caret (^).

You can view the Galasa CLI command syntax, including parameter descriptions, in the <a href=https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl.md target="_blank"> cli repository</a> in GitHub.


## Known limitations

Go programs can sometimes struggle to resolve DNS names, especially when a working over a virtual private network (VPN). In such situations, you might notice that a bootstrap file cannot be found with galasactl, but can be found by a desktop browser, or curl command. In such situations you can manually add the host detail to the `/etc/hosts` file, to avoid DNS being involved in the resolution mechanism.


## Getting help

Once you have installed the Galasa CLI, you can use the following command to get more information about the command and command options, including default values.

```
galasactl --help
```

Use the `--log` option to send logging information to a file. Any folder that is referenced must exist. Existing files are overwritten. Specify `-` to log to `stderr`. The default is no logging.

```
galasactl --log <logFilePath>
```

## Errors

You can view a list of error messages that can be generated by the galasactl tool in the <a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/errors-list.md" target="_blank"> Galasa cli repository</a> in GitHub.



## Next steps

Read the [Initialising your local environment](/docs/initialising-home-folder) documentation to help you to set up some basic file structures and files in your home folder so that you can start using Galasa.
Expand Down
Loading

0 comments on commit a19d5e1

Please sign in to comment.