diff --git a/src/data/nav.yaml b/src/data/nav.yaml index 2270d5ed..204bbd4c 100644 --- a/src/data/nav.yaml +++ b/src/data/nav.yaml @@ -100,9 +100,9 @@ path: /docs/ecosystem/cps-yaml - title: Updating credentials in an Ecosystem path: /docs/ecosystem/ecosystem-update-creds - - title: Managing integrated test runs + - title: Managing configuration properties path: /docs/ecosystem/ecosystem-manage-cps - - title: Managing tests in an Ecosystem + - title: Managing tests in a Galasa Ecosystem path: /docs/manage-ecosystem items: - title: Test streams diff --git a/src/markdown-pages/docs/ecosystem/ecosystem-manage-cps.md b/src/markdown-pages/docs/ecosystem/ecosystem-manage-cps.md index fdfb44ef..cafb4355 100644 --- a/src/markdown-pages/docs/ecosystem/ecosystem-manage-cps.md +++ b/src/markdown-pages/docs/ecosystem/ecosystem-manage-cps.md @@ -1,6 +1,6 @@ --- path: "/docs/ecosystem/ecosystem-manage-cps" -title: "Managing integrated test runs" +title: "Managing configuration properties" --- [Retrieving namespaces](#retrievingnamespaces)
diff --git a/src/markdown-pages/docs/manage-ecosystem/test-streams-architecture.svg b/src/markdown-pages/docs/manage-ecosystem/test-streams-architecture.svg new file mode 100644 index 00000000..225825b6 --- /dev/null +++ b/src/markdown-pages/docs/manage-ecosystem/test-streams-architecture.svg @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/markdown-pages/docs/manage-ecosystem/test-streams.md b/src/markdown-pages/docs/manage-ecosystem/test-streams.md index bc623cec..7c9f2ec9 100644 --- a/src/markdown-pages/docs/manage-ecosystem/test-streams.md +++ b/src/markdown-pages/docs/manage-ecosystem/test-streams.md @@ -3,11 +3,48 @@ path: "/docs/manage-ecosystem/test-streams" title: "Test streams" --- -Galasa's ecosystem organises tests into _streams_. Test streams give you more options when it comes to organising your test projects, how often they are built and where they are deployed. +Galasa's Ecosystem organises tests into _streams_. Test streams give you more options when it comes to organising your test projects, how often they are built and where they are deployed. -You can have as few or as many test streams as you wish. +A test stream is a group of tests that you want to run in automation, represented by a single OBR (OSGi Bundle Repository) and its equivalent test catalog. Galasa uses the OBR to locate your tests in a Maven repository, along with all of the Managers that a test project requires. A test catalog is generated directly from the test source, is always up to date, and is specified in the Galasa CLI to select tests to run in automation. Administrators can create few or many test streams, depending on testing requirements. Testers can contribute tests to one or more test streams. -A stream is a group of tests that you wish to run in automation represented by a single OBR (OSGi Bundle Repository) and its equivalent test catalog. Galasa uses an OBR to locate your tests in a Maven repository, along with all of the Managers that a test project requires. A test catalog is generated directly from the test source, is always up to date, and is what you would specify in the Galasa CLI to select tests to run in automation. +## Test stream components + +A test stream is made up of a name, description, OBR, location and repository components. + +- The OBR component is a URL that points to a list of Maven coodinates in the format `mvn:{grp}/{artifact id}/{version}/{obr}`. +- The location component is a URL that points to the location of the test catalog that is associated with a particular OBR in the format `http://points-to-my-testcatalog`. A test catalog is an index of tests. + +- The repository component provides the location of the Maven repository where the test code and test catalog are deployed + +The following diagram shows the relationship between the test code, test catalog, and test stream. + +![test stream architecture:](test-streams-architecture.svg) + + +## Creating and retrieving test stream components + +The components of the `test.stream` property are set by using `galasactl properties set` command, as shown in the following example: + +``` +galasactl properties set --namespace framework --name test.stream.mystream.description --value "My stream to use as an example" +galasactl properties set --namespace framework --name test.stream.mystream.repo --value http://points-to-my-maven-repo +galasactl properties set --namespace framework --name test.stream.mystream.location --value http://points-to-my-test-catalog +galasactl properties set --namespace framework --name test.stream.mystream.obr --value mvn:myorg/myartifact/0.0.1/obr +``` + +These four commands each set a part of the stream. Streams must always be created in the `framework` namespace and must always have all four components set. + +You can view all test streams in the `framework` namespace by using the `galasactl properties get` command, as shown in the following example: + +``` +galasactl properties get --namespace framework --name test.streams +namespace name value +framework test.streams integrationtests, regressiontests + +Total:2 +``` + +## Organising test streams There are many ways to organise test streams: