Allow elasticsearch to work with rust stable (#89)

This commit allows elasticsearch to work with
rust stable. The only feature requiring rust nightly
is external_doc feature to able to to test the README.md
docs. This is now conditionally compiled
when building with rust nightly, using rustc_version
in a build.rs build script to set a cfg flag for the channel
used.

api_generator requires rust nightly still. The default toolchain
to use for each package is in a rust-toolchain file in
the root of each package directory.

Closes #87

(cherry picked from commit a03fafb)

Author: russcam

.ci/run-elasticsearch.ps1

@@ -202,41 +202,41 @@ if ($LASTEXITCODE -ne 0) {
 }
 
 $environment = @(
-  "--env", "node.name=`"$NODE_NAME`"",
-  "--env", "cluster.name=`"$CLUSTER_NAME`"",
-  "--env", "cluster.initial_master_nodes=`"$MASTER_NODE_NAME`"",
-  "--env", "discovery.seed_hosts=`"$MASTER_NODE_NAME`"",
-  "--env", "cluster.routing.allocation.disk.threshold_enabled=false",
-  "--env", "bootstrap.memory_lock=true",
-  "--env", "node.attr.testattr=test",
-  "--env", "path.repo=/tmp",
-  "--env", "repositories.url.allowed_urls=http://snapshot.test*"
+"--env", "node.name=`"$NODE_NAME`"",
+"--env", "cluster.name=`"$CLUSTER_NAME`"",
+"--env", "cluster.initial_master_nodes=`"$MASTER_NODE_NAME`"",
+"--env", "discovery.seed_hosts=`"$MASTER_NODE_NAME`"",
+"--env", "cluster.routing.allocation.disk.threshold_enabled=false",
+"--env", "bootstrap.memory_lock=true",
+"--env", "node.attr.testattr=test",
+"--env", "path.repo=/tmp",
+"--env", "repositories.url.allowed_urls=http://snapshot.test*"
 )
 
 $volumes = @(
-  "--volume", "${volume_name}:/usr/share/elasticsearch/data"
+"--volume", "${volume_name}:/usr/share/elasticsearch/data"
 )
 
 if (-not ($version -contains "oss")) {
   $environment += @(
-    "--env", "ELASTIC_PASSWORD=`"$ELASTIC_PASSWORD`"",
-    "--env", "xpack.license.self_generated.type=trial",
-    "--env", "xpack.security.enabled=true",
-    "--env", "xpack.security.http.ssl.enabled=true",
-    "--env", "xpack.security.http.ssl.verification_mode=certificate",
-    "--env", "xpack.security.http.ssl.key=certs/testnode.key",
-    "--env", "xpack.security.http.ssl.certificate=certs/testnode.crt",
-    "--env", "xpack.security.http.ssl.certificate_authorities=certs/ca.crt",
-    "--env", "xpack.security.transport.ssl.enabled=true",
-    "--env", "xpack.security.transport.ssl.key=certs/testnode.key",
-    "--env", "xpack.security.transport.ssl.certificate=certs/testnode.crt",
-    "--env", "xpack.security.transport.ssl.certificate_authorities=certs/ca.crt"
+  "--env", "ELASTIC_PASSWORD=`"$ELASTIC_PASSWORD`"",
+  "--env", "xpack.license.self_generated.type=trial",
+  "--env", "xpack.security.enabled=true",
+  "--env", "xpack.security.http.ssl.enabled=true",
+  "--env", "xpack.security.http.ssl.verification_mode=certificate",
+  "--env", "xpack.security.http.ssl.key=certs/testnode.key",
+  "--env", "xpack.security.http.ssl.certificate=certs/testnode.crt",
+  "--env", "xpack.security.http.ssl.certificate_authorities=certs/ca.crt",
+  "--env", "xpack.security.transport.ssl.enabled=true",
+  "--env", "xpack.security.transport.ssl.key=certs/testnode.key",
+  "--env", "xpack.security.transport.ssl.certificate=certs/testnode.crt",
+  "--env", "xpack.security.transport.ssl.certificate_authorities=certs/ca.crt"
   )
 
   $volumes += @(
-    "--volume", "`"${SSL_CERT}:/usr/share/elasticsearch/config/certs/testnode.crt`"",
-    "--volume", "`"${SSL_KEY}:/usr/share/elasticsearch/config/certs/testnode.key`"",
-    "--volume", "`"${SSL_CA}:/usr/share/elasticsearch/config/certs/ca.crt`""
+  "--volume", "`"${SSL_CERT}:/usr/share/elasticsearch/config/certs/testnode.crt`"",
+  "--volume", "`"${SSL_KEY}:/usr/share/elasticsearch/config/certs/testnode.key`"",
+  "--volume", "`"${SSL_CA}:/usr/share/elasticsearch/config/certs/ca.crt`""
   )
 }
 
@@ -315,4 +315,4 @@ if ($DETACH) {
     $env:ES_TEST_SERVER = $localUri.ToString();
     exit 0
   }
-}
+}

.ci/run-tests.ps1

@@ -8,9 +8,9 @@ param (
     [ValidateSet("oss", "xpack")]
     $TEST_SUITE = "xpack",
 
-    # TODO: move to stable once elasticsearch-rs compiles on stable
     [string]
     [Parameter(Mandatory = $false)]
+    [ValidateSet("nightly", "stable")]
     $RUST_VERSION = "nightly",
 
     [string]
@@ -27,6 +27,11 @@ trap {
   cleanup
 }
 
+$toolchain = ""
+if ($RUST_VERSION -eq "nightly") {
+    $toolchain = "+nightly"
+}
+
 $NODE_NAME = "es1"
 $elasticsearch_image= "elasticsearch"
 $elasticsearch_url = "https://elastic:changeme@${NODE_NAME}:9200"
@@ -126,7 +131,7 @@ docker run `
   --name elasticsearch-rs `
   --rm `
 elastic/elasticsearch-rs `
-cargo test $CARGO_TEST_FLAGS
+cargo $toolchain test $CARGO_TEST_FLAGS
 
 $runExitCode = $LASTEXITCODE
 

CONTRIBUTING.md

@@ -71,20 +71,22 @@ The `quote` and `syn` crates help
 
 ### Current development setup
 
-Use Rust nightly for development for now:
+The required toolchain for packages in the workspace are controlled
+by a `rust-toolchain` file in the root of each package.
 
-```sh
-> rustup show
-...
+`elasticsearch` package compiles and runs with rust stable. 
 
-active toolchain
-----------------
+`elasticsearch` tests incorporate testing the examples
+given in the README.md file, using the
+[`external_doc`](https://doc.rust-lang.org/unstable-book/language-features/external-doc.html)
+experimental feature. To run these tests too, run with cargo nightly,
+using the `+<toolchain>` command line override
 
-nightly-x86_64-pc-windows-msvc (default)
-rustc 1.41.0-nightly (a44774c3a 2019-11-25)
+```sh
+ cargo +nightly test -p elasticsearch --doc
 ```
 
-It is expected to move to rust stable once dependencies compile on stable.
+`api_generator` package requires rust nightly.
 
 ### Coding style guide
 

rust-toolchain renamed to api_generator/rust-toolchain

@@ -37,4 +37,7 @@ futures = "0.3.1"
 http = "0.2"
 hyper = { version = "0.13", default-features = false, features = ["tcp", "stream"] }
 sysinfo = "0.12.0"
-tokio = { version = "0.2.0", default-features = false, features = ["macros", "tcp", "time"] }
+tokio = { version = "0.2.0", default-features = false, features = ["macros", "tcp", "time"] }
+
+[build-dependencies]
+rustc_version = "0.2"

elasticsearch/Cargo.toml

@@ -0,0 +1,19 @@
+extern crate rustc_version;
+use rustc_version::{version_meta, Channel};
+
+fn main() {
+    match version_meta().unwrap().channel {
+        Channel::Stable => {
+            println!("cargo:rustc-cfg=RUSTC_IS_STABLE");
+        }
+        Channel::Beta => {
+            println!("cargo:rustc-cfg=RUSTC_IS_BETA");
+        }
+        Channel::Nightly => {
+            println!("cargo:rustc-cfg=RUSTC_IS_NIGHTLY");
+        }
+        Channel::Dev => {
+            println!("cargo:rustc-cfg=RUSTC_IS_DEV");
+        }
+    }
+}

elasticsearch/build.rs

@@ -0,0 +1 @@
+stable

elasticsearch/rust-toolchain

@@ -301,10 +301,10 @@
 // TODO: turn on before releasing :) Will require adding documentation within all REST API specs
 // #![deny(missing_docs)]
 
-// also test examples in README
-#![feature(external_doc)]
-#[doc(include = "../../README.md")]
-#[cfg(doctest)]
+// also test examples in README when using rust nightly.
+// required as external_doc feature requires nightly
+#![cfg_attr(RUSTC_IS_NIGHTLY, feature(external_doc))]
+#[cfg_attr(RUSTC_IS_NIGHTLY, doc(include = "../../README.md"), cfg(doctest))]
 type _DoctestReadme = ();
 
 #[macro_use]