Update CI scripts (#5287) (#5291)

* Update ci scripts
* Update snippets for 7.x
* Update readme

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>

Author: github-actions[bot]

.ci/functions/imports.sh

@@ -18,7 +18,7 @@ require_stack_version
 if [[ -z $es_node_name ]]; then
   # only set these once
   set -euo pipefail
-  export TEST_SUITE=${TEST_SUITE-oss}
+  export TEST_SUITE=${TEST_SUITE-free}
   export RUNSCRIPTS=${RUNSCRIPTS-}
   export DETACH=${DETACH-false}
   export CLEANUP=${CLEANUP-false}
@@ -27,8 +27,7 @@ if [[ -z $es_node_name ]]; then
   export elastic_password=changeme
   export elasticsearch_image=elasticsearch
   export elasticsearch_url=https://elastic:${elastic_password}@${es_node_name}:9200
-  if [[ $TEST_SUITE != "xpack" ]]; then
-    export elasticsearch_image=elasticsearch-${TEST_SUITE}
+  if [[ $TEST_SUITE != "platinum" ]]; then
     export elasticsearch_url=http://${es_node_name}:9200
   fi
   export external_elasticsearch_url=${elasticsearch_url/$es_node_name/localhost}

.ci/readme.md

@@ -13,38 +13,38 @@ Each `do` section in the yaml is mapped to a low level client method. To aid wit
 way to deal with elasticsearch responses in a semi typed fashion.
 
 These `rest-api-spec` tests are in addition to the unit and integration tests that live under `src/Tests/Tests` which for 90% of the cases focuses 
-more on the high level client `NEST` where as these `rest-api-spec` test fully focus on the low level client `Elasticsearch.Net`
+more on the high level client `NEST` where as these `rest-api-spec` tests fully focus on the low level client `Elasticsearch.Net`
 
-The `DockerFile` in this folder sets up this repos inside a docker container ready to run our build.
+The `DockerFile` in this folder sets up this repo inside a docker container ready to run our build.
 
 The `rest-api-spec` runner expects Elasticsearch to be started before invocation and uses the endpoint its passed to discover the current Elasticsearch
 `build hash` that is running and downloads the tests matching that `build hash`.
 
-If you want to run the tests the same that the Jenkins instance on elastic.co does you can call 
+If you want to run the tests the same way that the Jenkins instance on elastic.co does you can call 
 
 ```bash
-$ ELASTICSEARCH_VERSION=8.0.0-SNAPSHOT ./.ci/run-tests 
+$ STACK_VERSION=7.x-SNAPSHOT ELASTICSEARCH_VERSION=7.x-SNAPSHOT ./.ci/run-tests 
 ```
 
 | Variable Name           | Default     | Description |
 |-------------------------|-------------|-------------|
-| `ELASTICSEARCH_VERSION` | `N/A`       | The elasticsearch version to target
-| `TEST_SUITE`            | `oss`       | `oss` or `xpack` sets which test suite to run and which container to run against. |
+| `STACK_VERSION` | `N/A`       | The elasticsearch version to target
+| `TEST_SUITE`            | `basic`     | `free` or `platinum` sets which test suite to run and which container to run against. |
 | `DOTNET_VERSION`        | `5.0.100`   | The .NET sdk version used to grab the proper container |
 
 
-If you want to manually spin up elasticsearch for this tests and call the runner afterwards you can use
+If you want to manually spin up elasticsearch for these tests and call the runner afterwards you can use
 
 ```bash
-$ ELASTICSEARCH_VERSION=elasticsearch-oss:8.0.0-SNAPSHOT DETACH=true bash .ci/run-elasticsearch.sh
+$ STACK_VERSION=7.x-SNAPSHOT DETACH=true bash .ci/run-elasticsearch.sh
 ```
 
-Note that `ELASTICSEARCH_VERSION` here is the full docker reference, `.ci/run-tests` is smart enough to compose this based on `TEST_SUITE`
+Note that `STACK_VERSION` here is the full docker reference, `.ci/run-tests` is smart enough to compose this based on `TEST_SUITE`
 
 Spinning down the cluster can be done by passing `CLEANUP=true` using the same args
 
 ```bash
-$ ELASTICSEARCH_VERSION=elasticsearch-oss:8.0.0-SNAPSHOT CLEANUP=true bash .ci/run-elasticsearch.sh
+$ STACK_VERSION=7.x-SNAPSHOT CLEANUP=true bash .ci/run-elasticsearch.sh
 ```
 
 To kick off the `rest-api-spec` tests manually after starting the cluster manually:
@@ -62,6 +62,5 @@ $ ./build.sh rest-spec-tests -f --help
 Against in most cases running through `./ci/run-tests` is all you need:
 
 ```bash
-$ ELASTICSEARCH_VERSION=8.0.0-SNAPSHOT ./.ci/run-tests 
-```
-
+$ STACK_VERSION=7.x-SNAPSHOT ./.ci/run-tests 
+```

.ci/run-elasticsearch.ps1

@@ -166,7 +166,7 @@ $volumes = @(
   "--volume", "${volume_name}:/usr/share/elasticsearch/data"
 )
 
-if (-not $env:ELASTICSEARCH_VERSION -contains "oss") {
+if (-not $env:ELASTICSEARCH_VERSION -contains "free") {
   $environment += @(
     "--env", "ELASTIC_PASSWORD=`"$ELASTIC_PASSWORD`"",
     "--env", "xpack.license.self_generated.type=trial",
@@ -190,7 +190,7 @@ if (-not $env:ELASTICSEARCH_VERSION -contains "oss") {
 }
 
 $url="http://$NODE_NAME"
-if (-not $env:ELASTICSEARCH_VERSION -contains "oss") {
+if (-not $env:ELASTICSEARCH_VERSION -contains "free") {
   $url="https://elastic:$ELASTIC_PASSWORD@$NODE_NAME"
 }
 

.ci/run-elasticsearch.sh

@@ -4,7 +4,7 @@
 # to form a cluster suitable for running the REST API tests.
 #
 # Export the STACK_VERSION variable, eg. '8.0.0-SNAPSHOT'.
-# Export the TEST_SUITE variable, eg. 'oss' or 'xpack' defaults to 'oss'.
+# Export the TEST_SUITE variable, eg. 'free' or 'platinum' defaults to 'free'.
 # Export the NUMBER_OF_NODES variable to start more than 1 node
 
 # Version 1.1.0
@@ -38,7 +38,7 @@ environment=($(cat <<-END
   --env repositories.url.allowed_urls=http://snapshot.test*
 END
 ))
-if [[ "$TEST_SUITE" == "xpack" ]]; then
+if [[ "$TEST_SUITE" == "platinum" ]]; then
   environment+=($(cat <<-END
     --env ELASTIC_PASSWORD=$elastic_password
     --env xpack.license.self_generated.type=trial
@@ -63,7 +63,7 @@ END
 fi
 
 cert_validation_flags=""
-if [[ "$TEST_SUITE" == "xpack" ]]; then
+if [[ "$TEST_SUITE" == "platinum" ]]; then
   cert_validation_flags="--insecure --cacert /usr/share/elasticsearch/config/certs/ca.crt --resolve ${es_node_name}:443:127.0.0.1"
 fi
 

.ci/run-repository.sh

@@ -2,7 +2,7 @@
 # parameters are available to this script
 
 # STACK_VERSION -- version e.g Major.Minor.Patch(-Prelease)
-# TEST_SUITE -- which test suite to run: oss or xpack
+# TEST_SUITE -- which test suite to run: free or platinum
 # ELASTICSEARCH_URL -- The url at which elasticsearch is reachable, a default is composed based on STACK_VERSION and TEST_SUITE
 # DOTNET_VERSION -- SDK version (defined in test-matrix.yml, a default is hardcoded here)
 script_path=$(dirname $(realpath -s $0))

.ci/run-tests.ps1

@@ -4,8 +4,8 @@ param (
     $ELASTICSEARCH_VERSION,
 
     [string]
-    [ValidateSet("oss", "xpack")]
-    $TEST_SUITE = "oss",
+    [ValidateSet("free", "platinum")]
+    $TEST_SUITE = "free",
 
     [string]
     $DOTNET_VERSION = "5.0.100"
@@ -16,8 +16,7 @@ $NODE_NAME = "es1"
 $elasticsearch_image= "elasticsearch"
 $elasticsearch_url = "https://elastic:changeme@${NODE_NAME}:9200"
 
-if ($TEST_SUITE -ne "xpack") {
-  $elasticsearch_image= "elasticsearch-${TEST_SUITE}"
+if ($TEST_SUITE -ne "platinum") {
   $elasticsearch_url = "http://${NODE_NAME}:9200"
 }
 

.ci/test-matrix.yml

@@ -4,8 +4,8 @@ STACK_VERSION:
   - 7.x-SNAPSHOT
 
 TEST_SUITE:
-  - oss
-  - xpack
+  - free
+  - platinum
 
 DOTNET_VERSION:
     - 5.0.100