Galasa Ecosystem Manager
This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
Overview
Provided annotation
Code snippets and examples
Overview
This Manager provides the test with a fully provisioned Galasa Ecosystem on which to test. When the test starts running the test can be assured that all the services are up and working.
The Galasa Ecosystem Manager supports Galasa Shared Environments. Shared Environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test.
Limitations
The Manager only supports the following platforms:
- Kubernetes Namespace
In the near future, this Manager will be able to provision ecosystems in Docker and on a plain Linux server.
Annotations
The following annotations are available with the Galasa Ecosystem Manager
Kubernetes Ecosystem
| Annotation: | Kubernetes Ecosystem |
|---|---|
| Name: | @KubernetesEcosystem |
| Description: | The @KubernetesEcosystem annotation requests the Galasa Ecosystem Manager to provision a Galasa Ecosystem within a Kubernetes Namespace. |
Attribute: ecosystemNamespaceTag |
The ecosystemNamespaceTag is used to identify the Ecosystem to other Managers or Shared Environments. If a test is using multiple Ecosystems, each separate Ecosystem must have a unique tag. If two Ecosystems use the same tag, they refer to the same Ecosystem. |
Attribute: kubernetesNamespaceTag |
The kubernetesNamespaceTag identifies which tagged Kubernetes Namespace is to be used to deploy the Galasa Ecosystem into. |
Attribute: yamlDirectory |
The yamlDirectory points to a resource directory within the test bundle that contains a set of override yaml files to use when creating the ecosystem. Each file must end with .yaml to be found. If a directory or resource is not provided, the stable yaml files within the Galasa Ecosystem Manager will be used. |
| Syntax: | @KubernetesEcosystem |
| Notes: | The IKubernetesEcosystem interface gives the test access to the URLs of the services and API endpoints within the Ecosystem. When the test runs all the services that are required by the test are known to be up and working.The test must provide a @KubernetesNamespace IKubernetesNamespace annotation, as this is where the Ecosystem is provisioned in. In the future, Docker and Linux will be options. The Galasa Ecosystem has its own stable versions of the Kubernetes yaml files that are needed to create the entire Ecosystem. If you want to override those and use your own yaml files, then use the yamlDirectory attribute. If a resource is missing in the test's set, then the stable version is used. |
Local Ecosystem
| Annotation: | Local Ecosystem |
|---|---|
| Name: | @LocalEcosystem |
| Description: | The @LocalEcosystem annotation requests the Galasa Ecosystem Manager to provision a local running environment on a Linux or Windows instance. The Local running environment will use the FPF file configuration and not run any of the servers by default. |
Attribute: ecosystemTag |
The ecosystemNamespaceTag is used to identify the Ecosystem to other Managers or Shared Environments. If a test is using multiple Ecosystems, each separate Ecosystem must have a unique tag. If two Ecosystems use the same tag, they refer to the same Ecosystem. |
Attribute: linuxImageTag |
The linuxImageTag identifies which tagged Linux image is to be used to deploy the Galasa Ecosystem into. |
Attribute: windowsImageTag |
The windowsImageTag identifies which tagged Windows image is to be used to deploy the Galasa Ecosystem into. |
Attribute: javaInstallationTag |
The javaInstallationTag to which Java installation on the image is to be used to run the Galasa tests and services. |
Attribute: isolationInstallation |
|
| Syntax: | @LocalEcosystem(linuxImageTag="PRIMARY") |
| Notes: | The ILocalEcosystem interface gives the test access FPF services and the ability to run tests from the commandline. The Manager will pre-configure the CPS, DSS and CREDS before the test begins.The test must provide a @LocalNamespace ILocalNamespace annotation, as this is where the Ecosystem is provisioned in. The annotation must provide either a Windows or Linux image tag, but not both and must provide a @JavaInstallation tag. |
Code snippets
Use the following code snippets to help you get started with the Galasa Ecosystem Manager.
Obtain a Kubernetes Namespace
@KubernetesEcosystem
public IKubernetesEcosystem ecosystem;
@KubernetesNamespace
public IKubernetesNamespace namespace;This code requests that the Galasa Ecosystem be provisioned in a Kubernetes Namespace. The default tag for both of them is PRIMARY.
Retrieve the RAS Endpoint
@KubernetesEcosystem
public IKubernetesEcosystem ecosystem;
URI ras = ecosystem.getEndpoint(EcosystemEndpoint.RAS);
This snippet demonstrates how to retrieve the Result Archive Store (RAS) endpoint. Be aware, that the URI is prefixed with the store type, e.g. couchdb:http://couchdb.server:5984. This is the same for the CPS, DSS and CREDS.
Set and retrieve a CPS property
ecosystem.setCpsProperty("bob", "hello");
String value = ecosystem.getCpsProperty("bob")Sets the CPS property bob with the value hello and retrieves it again.
Configuration Properties
The following are properties used to configure the Galasa Ecosystem Manager.
Docker Registry
| Property: | Docker Registry |
|---|---|
| Name: | galasaecosystem.docker.registry |
| Description: | The registry that contains the Docker images |
| Required: | No |
| Default value: | docker.io |
| Valid values: | a valid hostname |
| Examples: | galasaecosystem.docker.registry=docker.io |
Docker Image Version
| Property: | Docker Image Version |
|---|---|
| Name: | galasaecosystem.docker.version |
| Description: | The versions of the Docker images to be used with the Ecosystem |
| Required: | Yes |
| Default value: | The setting of galasaecosystem.maven.version |
| Valid values: | A valid Docker version literial |
| Examples: | galasaecosystem.docker.version=0.4.0 |
Isolated Full zip location
| Property: | Isolated Full zip location |
|---|---|
| Name: | galasaecosystem.isolated.full.zip |
| Description: | The location of the isolated zip for the full distribution |
| Required: | No |
| Default value: | None |
| Valid values: | Valid URL |
| Examples: | galasaecosystem.isolated.full.zip=https://resources.galasa.dev/isolated.zip |
Isolated MVP zip location
| Property: | Isolated MVP zip location |
|---|---|
| Name: | galasaecosystem.isolated.mvp.zip |
| Description: | The location of the isolated zip for the mvp distribution |
| Required: | No |
| Default value: | None |
| Valid values: | Valid URL |
| Examples: | galasaecosystem.isolated.mvp.zip=https://github.com/galasa-dev/isolated/releases/download/v0.38.0/galasa-isolated-mvp-0.38.0.zip |
Kubernetes Ecosystem Tag Shared Environment
| Property: | Kubernetes Ecosystem Tag Shared Environment |
|---|---|
| Name: | galasaecosystem.ecosystem.tag.XXXXXX.shared.environment |
| Description: | Tells the Galasa Ecosystem Manager which Shared Environment is assigned to an Ecosystem Tag |
| Required: | No |
| Default value: | None |
| Valid values: | A valid Shared Environment |
| Examples: | galasaecosystem.ecosystem.tag.SHARED.shared.environment=M1 |
Maven Repository URL
| Property: | Maven Repository URL |
|---|---|
| Name: | galasaecosystem.maven.repository |
| Description: | The location of the Maven Repository all artifacts will be downloaded from |
| Required: | Yes |
| Default value: | None |
| Valid values: | Value URL |
| Examples: | galasaecosystem.maven.repository=https://nexus.galasa.dev/repository/maven-development |
Maven use default local repository
| Property: | Maven use default local repository |
|---|---|
| Name: | galasaecosystem.maven.use.default.local.repository |
| Description: | The Local ecosystems will use a dedicated local repository, however, this slows the installation, so setting this property to true will use the normal ~/.m2/repository so downloads happen only once per day, useful for rapid development and testings |
| Required: | No |
| Default value: | false |
| Valid values: | true or false |
| Examples: | galasaecosystem.maven.use.default.local.repository=true |
Maven Artifact Version
| Property: | Maven Artifact Version |
|---|---|
| Name: | galasaecosystem.maven.version |
| Description: | The versions of the Maven artifacts to be used with the Ecosystem |
| Required: | Yes |
| Default value: | None |
| Valid values: | A valid maven version literial |
| Examples: | galasaecosystem.maven.version=0.4.0 |