Merge branch '7.x' into 7.7

ezimuel · ezimuel · commit 9458d039e7cd · 2020-04-17T13:22:45.000+02:00
diff --git a/.ci/Dockerfile b/.ci/Dockerfile
@@ -1,11 +1,8 @@
 ARG PHP_VERSION=7.4-cli
 FROM php:${PHP_VERSION}
 
-# Create app directory
 WORKDIR /usr/src/app
 
-COPY . .
-
 # Install git
 RUN apt-get update && \
     apt-get install -y --no-install-recommends git
@@ -15,10 +12,24 @@ RUN apt-get install -y \
         libzip-dev \
         zip \
     && docker-php-ext-install zip
-  
+
+# Print PHP version
+RUN php -v
+
 # Install composer
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-# Install dependencies using composer
-RUN composer global require hirak/prestissimo && \
-    composer install --prefer-dist --no-progress --no-interaction
+# Print composer version
+RUN composer --version
+
+COPY composer.json .
+
+# Install dependencies with composer
+RUN composer global require hirak/prestissimo && composer install
+
+COPY . .
+
+# Updating elasticsearch submodule
+RUN git submodule update --init --recursive
+
+CMD ["bash", ".ci/yaml-tests.sh"]
diff --git a/.ci/jobs/defaults.yml b/.ci/jobs/defaults.yml
@@ -69,6 +69,6 @@
     publishers:
     - email:
         recipients: infra-root+build@elastic.co
-    # - junit:
-    #     results: "*-junit.xml"
-    #     allow-empty-results: true
+    - junit:
+        results: "tests/*-junit.xml"
+        allow-empty-results: true
diff --git a/.ci/jobs/elastic+elasticsearch-php+7.7.yml b/.ci/jobs/elastic+elasticsearch-php+7.7.yml
@@ -0,0 +1,14 @@
+---
+- job:
+    name: elastic+elasticsearch-php+7.7
+    display-name: 'elastic / elasticsearch-php # 7.7'
+    description: Testing the elasticsearch-php 7.7 branch.
+    parameters:
+    - string:
+        name: branch_specifier
+        default: refs/heads/7.7
+        description: the Git branch specifier to build (&lt;branchName&gt;, &lt;tagName&gt;,
+          &lt;commitId&gt;, etc.)
+    triggers:
+    - github
+    - timed: '@daily'
diff --git a/.ci/jobs/elastic+elasticsearch-php+7.x.yml b/.ci/jobs/elastic+elasticsearch-php+7.x.yml
@@ -11,4 +11,4 @@
           &lt;commitId&gt;, etc.)
     triggers:
     - github
-    - timed: '@weekly'
+    - timed: '@daily'
diff --git a/.ci/jobs/elastic+elasticsearch-php+pull-request.yml b/.ci/jobs/elastic+elasticsearch-php+pull-request.yml
@@ -3,6 +3,7 @@
     name: elastic+elasticsearch-php+pull-request
     display-name: 'elastic / elasticsearch-php # pull-request'
     description: Testing of elasticsearch-php pull requests.
+    junit_results: "tests/*-junit.xml"
     scm:
     - git:
         branches:
@@ -16,4 +17,3 @@
         github-hooks: true
         status-context: clients-ci
         cancel-builds-on-update: true
-    publishers: []
diff --git a/.ci/run-repository.sh b/.ci/run-repository.sh
@@ -22,6 +22,7 @@ echo -e "\033[34;1mINFO:\033[0m PHP_VERSION ${PHP_VERSION}\033[0m"
 echo -e "\033[1m>>>>> Build docker container >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\033[0m"
 
 docker build \
+  --no-cache \
   --file .ci/Dockerfile \
   --tag elastic/elasticsearch-php \
   --build-arg PHP_VERSION=${PHP_VERSION} \
@@ -33,13 +34,13 @@ repo=$(realpath $(dirname $(realpath -s $0))/../)
 
 docker run \
   --network=${network_name} \
-  --env "STACK_VERSION=${STACK_VERSION}" \
-  --env "TEST_SUITE=${TEST_SUITE}" \
-  --env "PHP_VERSION=${PHP_VERSION}" \
-  --env "ELASTICSEARCH_URL=${ELASTICSEARCH_URL}" \
-  --volume $repo:/usr/src/app \
+  --workdir="/usr/src/app" \
+  --volume=${repo}/tests:/usr/src/app/tests \
+  --env STACK_VERSION=${STACK_VERSION} \
+  --env TEST_SUITE=${TEST_SUITE} \
+  --env PHP_VERSION=${PHP_VERSION} \
+  --env ELASTICSEARCH_URL=${ELASTICSEARCH_URL} \
   --ulimit nofile=65535:65535 \
   --name elasticsearch-php \
   --rm \
-  elastic/elasticsearch-php \
-  php util/RestSpecRunner.php && vendor/bin/phpunit -c phpunit-integration.xml --group sync
+  elastic/elasticsearch-php
diff --git a/.ci/run-tests b/.ci/run-tests
@@ -20,4 +20,4 @@ if [[ -n "$RUNSCRIPTS" ]]; then
 fi
 
 echo -e "\033[1m>>>>> Repository specific tests >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\033[0m"
-bash .ci/run-repository.sh
+bash .ci/run-repository.sh
diff --git a/.ci/test-matrix.yml b/.ci/test-matrix.yml
@@ -1,6 +1,6 @@
 ---
 STACK_VERSION:
-  - 7.7.0-SNAPSHOT
+  - 7.x-SNAPSHOT
 
 PHP_VERSION:
   - 7.4-cli
diff --git a/.ci/yaml-tests.sh b/.ci/yaml-tests.sh
@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# Checkout the YAML test from Elasticsearch tag
+php util/RestSpecRunner.php
+
+# Run YAML tests
+vendor/bin/phpunit -c phpunit-integration.xml --group sync
diff --git a/.gitignore b/.gitignore
@@ -32,3 +32,6 @@ util/cache/
 
 # Code coverage
 build
+
+# Junit test output
+tests/*-junit.xml
diff --git a/.travis.yml b/.travis.yml
@@ -29,7 +29,7 @@ jobs:
 
 env:
   global:
-    - STACK_VERSION="7.7.0-SNAPSHOT"
+    - STACK_VERSION="7.x-SNAPSHOT"
 
 before_install:
   - ./travis/run_es_docker.sh
diff --git a/docs/crud.asciidoc b/docs/crud.asciidoc
@@ -1,15 +1,21 @@
 [[indexing_documents]]
-== Indexing Documents
+== Indexing documents
 
-IMPORTANT: Please note that mapping types will disappear from Elasticsearch, read more https://www.elastic.co/guide/en/elasticsearch/reference/7.x/removal-of-types.html[here]. If you migrated types from Elasticsearch 6 to 7, you can address these with the `type` param.
+IMPORTANT: Please note that mapping types will disappear from {es}, read more 
+{ref-7x}/removal-of-types.html[here]. If you migrated types from {es} 6 to 7, 
+you can address these with the `type` param.
+
+When you add documents to {es}, you index JSON documents. This maps naturally to 
+PHP associative arrays, since they can easily be encoded in JSON. Therefore, in 
+Elasticsearch-PHP you create and pass associative arrays to the client for 
+indexing. There are several methods of ingesting data into {es} which we cover 
+here.
 
-When you add documents to Elasticsearch, you index JSON documents.  This maps naturally to PHP associative arrays, since
-they can easily be encoded in JSON.  Therefore, in Elasticsearch-PHP you create and pass associative arrays to the client
-for indexing.  There are several methods of ingesting data into Elasticsearch, which we will cover here.
 
 === Single document indexing
 
-When indexing a document, you can either provide an ID or let elasticsearch generate one for you.
+When indexing a document, you can either provide an ID or let {es} generate one 
+for you.
 
 {zwsp} +
 
@@ -40,7 +46,9 @@ $response = $client->index($params);
 ----
 {zwsp} +
 
-If you need to set other parameters, such as a `routing` value, you specify those in the array alongside the `index`, etc.  For example, let's set the routing and timestamp of this new document:
+If you need to set other parameters, such as a `routing` value, you specify 
+those in the array alongside the `index`, and others. For example, let's set the 
+routing and timestamp of this new document:
 
 .Additional parameters
 [source,php]
@@ -58,11 +66,14 @@ $response = $client->index($params);
 ----
 {zwsp} +
 
+
 === Bulk Indexing
 
-Elasticsearch also supports bulk indexing of documents.  The bulk API expects JSON action/metadata pairs, separated by
-newlines.  When constructing your documents in PHP, the process is similar.  You first create an action array object
-(e.g. `index` object), then you create a document body object.  This process repeats for all your documents.
+{es} also supports bulk indexing of documents. The bulk API expects JSON 
+action/metadata pairs, separated by newlines. When constructing your documents 
+in PHP, the process is similar. You first create an action array object (for 
+example, an `index` object), then you create a document body object. This 
+process repeats for all your documents.
 
 A simple example might look like this:
 
@@ -85,9 +96,9 @@ for($i = 0; $i < 100; $i++) {
 $responses = $client->bulk($params);
 ----
 
-In practice, you'll likely have more documents than you want to send in a single bulk request.  In that case, you need
-to batch up the requests and periodically send them:
-
+In practice, you'll likely have more documents than you want to send in a single 
+bulk request. In that case, you need to batch up the requests and periodically 
+send them:
 
 .Bulk indexing with batches
 [source,php]
@@ -126,11 +137,12 @@ if (!empty($params['body'])) {
 ----
 
 [[getting_documents]]
-== Getting Documents
+== Getting documents
 
-Elasticsearch provides realtime GETs of documents.  This means that as soon as the document has been indexed and your
-client receives an acknowledgement, you can immediately retrieve the document from any shard.  Get operations are
-performed by requesting a document by it's full `index/type/id` path:
+{es} provides realtime GETs of documents. This means that as soon as the 
+document is indexed and your client receives an acknowledgement, you can 
+immediately retrieve the document from any shard. Get operations are performed 
+by requesting a document by its full `index/type/id` path:
 
 [source,php]
 ----
@@ -145,15 +157,17 @@ $response = $client->get($params);
 {zwsp} +
 
 [[updating_documents]]
-== Updating Documents
+== Updating documents
 
-Updating a document allows you to either completely replace the contents of the existing document, or perform a partial
-update to just some fields (either changing an existing field, or adding new fields).
+Updating a document allows you to either completely replace the contents of the 
+existing document, or perform a partial update to just some fields (either 
+changing an existing field or adding new fields).
 
 === Partial document update
 
-If you want to partially update a document (e.g. change an existing field, or add a new one) you can do so by specifying
-the `doc` in the `body` parameter.  This will merge the fields in `doc` with the existing document
+If you want to partially update a document (for example, change an existing 
+field or add a new one) you can do so by specifying the `doc` in the `body` 
+parameter. This merges the fields in `doc` with the existing document.
 
 
 [source,php]
@@ -173,10 +187,12 @@ $response = $client->update($params);
 ----
 {zwsp} +
 
+
 === Scripted document update
 
-Sometimes you need to perform a scripted update, such as incrementing a counter or appending a new value to an array.
-To perform a scripted update, you need to provide a script and (usually) a set of parameters:
+Sometimes you need to perform a scripted update, such as incrementing a counter 
+or appending a new value to an array. To perform a scripted update, you need to 
+provide a script and usually a set of parameters:
 
 [source,php]
 ----
@@ -195,10 +211,12 @@ $response = $client->update($params);
 ----
 {zwsp} +
 
+
 === Upserts
 
-Upserts are "Update or Insert" operations.  This means an upsert will attempt to run your update script, but if the document
-does not exist (or the field you are trying to update doesn't exist), default values will be inserted instead.
+Upserts are "Update or Insert" operations. This means an upsert attempts to run 
+your update script, but if the document does not exist (or the field you are 
+trying to update doesn't exist), default values are inserted instead.
 
 [source,php]
 ----
@@ -222,10 +240,12 @@ $response = $client->update($params);
 ----
 {zwsp} +
 
+
 [[deleting_documents]]
 == Deleting documents
 
-Finally, you can delete documents by specifying their full `/index/_doc_/id` path:
+Finally, you can delete documents by specifying their full `/index/_doc_/id` 
+path:
 
 [source,php]
 ----
diff --git a/docs/namespaces.asciidoc b/docs/namespaces.asciidoc
@@ -2,22 +2,22 @@
 == Namespaces
 
 The client has a number of "namespaces", which generally expose administrative
-functionality.  The namespaces correspond to the various administrative endpoints
-in Elasticsearch.  This is a complete list of namespaces:
+functionality. The namespaces correspond to the various administrative endpoints
+in {es}. This is a complete list of namespaces:
 
 
 [width="40%",options="header",frame="topbot"]
 |============================
-| Namespace  | Functionality
+| Namespace    | Functionality
 | `indices()`  | Index-centric stats and info
 | `nodes()`    | Node-centric stats and info
 | `cluster()`  | Cluster-centric stats and info
 | `snapshot()` | Methods to snapshot/restore your cluster and indices
 | `cat()`      | Access to the Cat API (which is generally used standalone from the command line
 |============================
 
-Some methods are available in several different namespaces, which give you
-the same information but grouped into different contexts.  To see how these
+Some methods are available in several different namespaces, which give you the 
+same information but grouped into different contexts. To see how these 
 namespaces work, let's look at the `_stats` output:
 
 
@@ -39,8 +39,8 @@ $response = $client->cluster()->stats();
 ----
 {zwsp} +
 
-As you can see, the same `stats()` call is made through three different
-namespaces.  Sometimes the methods require parameters.  These parameters work
+As you can see, the same `stats()` call is made through three different 
+namespaces. Sometimes the methods require parameters. These parameters work
 just like any other method in the library.
 
 For example, we can requests index stats about a specific index, or multiple
@@ -60,7 +60,7 @@ $response = $client->indices()->stats($params);
 ----
 {zwsp} +
 
-As another example, here is how you might add an alias to an existing index:
+The following example shows how you can add an alias to an existing index:
 
 [source,php]
 ----
@@ -77,6 +77,7 @@ $params['body'] = array(
 $client->indices()->updateAliases($params);
 ----
 
-Notice how both the `stats` calls and the updateAlias took a variety of parameters,
-each according to what the particular API requires.  The `stats` API only requires
-an index name(s), while the `updateAlias` requires a body of actions.
+Notice how both the `stats` calls and the updateAlias took a variety of 
+parameters, each according to what the particular API requires. The `stats` API 
+only requires an index name(s), while the `updateAlias` requires a body of 
+actions.
diff --git a/docs/search-operations.asciidoc b/docs/search-operations.asciidoc
diff --git a/docs/security.asciidoc b/docs/security.asciidoc
diff --git a/phpunit-integration.xml b/phpunit-integration.xml
diff --git a/tests/Elasticsearch/Tests/YamlRunnerTest.php b/tests/Elasticsearch/Tests/YamlRunnerTest.php
