*: use xtask workflow (tikv#522)

This PR removes all scripts for maintaining the project. Instead,
introduce [xtask][1] workflow to whole process more portable and rusty.

It also introduces a new workflow named codegen to generate code for
health crate.

[1]: https://github.com/matklad/cargo-xtask

Signed-off-by: Jay Lee <[email protected]>

Author: BusyJay

.cargo/config

@@ -0,0 +1,2 @@
+[alias]
+xtask = "run --manifest-path ./xtask/Cargo.toml --"

.github/workflows/ci.yml

@@ -22,20 +22,22 @@ jobs:
     - run: sudo apt-get install -y clang-tidy-9
     - run: sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-9 100
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version && which cmake && cmake --version
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cargo fmt --all -- --check
     - run: cargo clippy --all -- -D clippy::all && cargo clippy --all --no-default-features --features prost-codec -- -D clippy::all
-    - run: scripts/lint-grpc-sys.sh && git diff-index --quiet HEAD
+    - run: cargo xtask clang-lint && git diff-index --quiet HEAD
 
   Linux-Stable:
     name: Linux-Stable
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - run: sudo apt install -y protobuf-compiler
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version
-    - run: scripts/reset-submodule.cmd
-    - run: env TEST_BIND=0 scripts/generate-bindings.sh && git diff --exit-code HEAD
-    - run: scripts/generate-bindings.sh
+    - run: cargo xtask submodule
+    - run: env TEST_BIND=0 cargo xtask bindgen && git diff --exit-code HEAD
+    - run: cargo xtask codegen && git diff --exit-code HEAD;
+    - run: cargo xtask bindgen
     - run: cargo build --no-default-features
     - run: cargo build --no-default-features --features protobuf-codec
     - run: cargo build --no-default-features --features prost-codec
@@ -49,7 +51,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cargo test --features "openssl-vendored" --all
     - run: cargo clean
     - run: cargo test --features "openssl" --all
@@ -61,7 +63,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: rustup default nightly
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cargo build --no-default-features
     - run: cargo build --no-default-features --features protobuf-codec
     - run: cargo build --no-default-features --features prost-codec
@@ -75,7 +77,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cargo build --no-default-features --features use-bindgen
     - run: cargo build --no-default-features --features "protobuf-codec use-bindgen"
     - run: cargo build --no-default-features --features "prost-codec use-bindgen"
@@ -89,7 +91,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: brew update && brew upgrade [email protected]
     - run: which go && go version && which cargo && cargo version && clang --version && openssl version
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: OPENSSL_ROOT_DIR="/usr/local/opt/[email protected]/" cargo test --features "openssl" --all
     - run: cargo test --features "openssl-vendored" --all
 
@@ -103,7 +105,7 @@ jobs:
     - run: choco install -y llvm
     - run: refreshenv
     - run: go version ; cargo version ; cmake --version 
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cargo build
     - run: cargo test --all
 
@@ -112,7 +114,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - run: scripts/reset-submodule.cmd
+    - run: cargo xtask submodule
     - run: cd grpc-sys && cargo publish --dry-run
     - name: Check generated package size
       run: |

.travis.yml

@@ -29,17 +29,17 @@ jobs:
     arch: arm64-graviton2
     vm: virt
     before_script:
-      - scripts/reset-submodule.cmd
+      - cargo xtask submodule
       - export GRPC_VERSION=1.35.0
       - export PATH="$PATH:$HOME/.cache/bin:$HOME/.cargo/bin"
       - which cmake && cmake --version && openssl version
       - eval "$(gimme stable)"
     script:
       - if [[ $TRAVIS_OS_NAME == "linux" ]] && [[ $TRAVIS_RUST_VERSION == "stable" ]]; then
           rustup component add rustfmt && cargo fmt --all -- --check;
-          env TEST_BIND=0 scripts/generate-bindings.sh && git diff --exit-code HEAD;
+          env TEST_BIND=0 cargo xtask bindgen && git diff --exit-code HEAD;
         fi
-      - ./scripts/generate-bindings.sh
+      - cargo xtask bindgen
       - cargo build --no-default-features
       - cargo build --no-default-features --features protobuf-codec
       - cargo build --no-default-features --features prost-codec
@@ -49,7 +49,7 @@ jobs:
     arch: arm64-graviton2
     vm: virt
     before_script:
-      - scripts/reset-submodule.cmd
+      - cargo xtask submodule
       - export GRPC_VERSION=1.35.0
       - export PATH="$PATH:$HOME/.cache/bin:$HOME/.cargo/bin"
       - sudo apt-get update && sudo apt-get -y install libssl-dev

Cargo.toml

@@ -33,8 +33,11 @@ members = [
     "compiler",
     "health",
     "interop",
-    "tests-and-examples"
+    "tests-and-examples",
 ]
+# Don't include it in workspace to make it possible to use different version of
+# rust-protobuf.
+exclude = ["xtask"]
 
 [features]
 default = ["protobuf-codec", "secure", "use-bindgen"]

README.md

@@ -44,7 +44,7 @@ For Windows, you also need to install following software:
 ## Build
 
 ```
-$ ./scripts/reset-submodule.cmd # if you just cloned the repository
+$ cargo xtask submodule # if you just cloned the repository
 $ cargo build
 ```
 
@@ -142,5 +142,5 @@ Make sure to format and test the code before sending a PR.
 If the content in grpc-sys/grpc is updated, you may need to regenerate bindings:
 
 ```
-$ ./scripts/generate-bindings.sh
+$ cargo xtask bindgen
 ```

compiler/Cargo.toml

@@ -27,3 +27,7 @@ tempfile = { version = "3.0", optional = true }
 [[bin]]
 name = "grpc_rust_plugin"
 required-features = ["protobuf-codec"]
+
+[[bin]]
+name = "grpc_rust_prost"
+required-features = ["prost-codec"]

compiler/src/bin/grpc_rust_prost.rs

@@ -0,0 +1,9 @@
+// Copyright 2021 TiKV Project Authors. Licensed under Apache-2.0.
+
+extern crate grpcio_compiler;
+
+use grpcio_compiler::prost_codegen;
+
+fn main() {
+    prost_codegen::protoc_gen_grpc_rust_main();
+}

compiler/src/prost_codegen.rs

@@ -2,7 +2,7 @@
 
 use std::io::{Error, ErrorKind, Read};
 use std::path::Path;
-use std::{fs, io, process::Command};
+use std::{env, fs, io, process::Command, str};
 
 use derive_new::new;
 use prost::Message;
@@ -536,3 +536,22 @@ fn generate_method_bind(service_name: &str, method: &Method, buf: &mut String) {
     buf.push_str(&method.name);
     buf.push_str("(ctx, req, resp));\n");
 }
+
+pub fn protoc_gen_grpc_rust_main() {
+    let mut args = env::args();
+    args.next();
+    let (mut protos, mut includes, mut out_dir): (Vec<_>, Vec<_>, _) = Default::default();
+    for arg in args {
+        if let Some(value) = arg.strip_prefix("--protos=") {
+            protos.extend(value.split(",").map(|s| s.to_string()));
+        } else if let Some(value) = arg.strip_prefix("--includes=") {
+            includes.extend(value.split(",").map(|s| s.to_string()));
+        } else if let Some(value) = arg.strip_prefix("--out-dir=") {
+            out_dir = value.to_string();
+        }
+    }
+    if protos.is_empty() {
+        panic!("should at least specify protos to generate");
+    }
+    compile_protos(&protos, &includes, &out_dir).unwrap();
+}

grpc-sys/build.rs

@@ -299,7 +299,7 @@ fn get_env(name: &str) -> Option<String> {
 // Generate the bindings to grpc C-core.
 // Try to disable the generation of platform-related bindings.
 #[cfg(feature = "use-bindgen")]
-fn bindgen_grpc(file_path: &PathBuf) {
+fn bindgen_grpc(file_path: &Path) {
     // create a config to generate binding file
     let mut config = bindgen::Builder::default();
     if cfg!(feature = "secure") {

health/src/proto.rs

@@ -2,20 +2,21 @@
 
 #[cfg(feature = "prost-codec")]
 mod reexports {
-    include!("proto/grpc.health.v1.rs");
+    include!("proto/prost/grpc.health.v1.rs");
 
     pub use self::health_check_response::ServingStatus;
 }
 
 #[cfg(feature = "protobuf-codec")]
-#[allow(deprecated)]
-mod health;
-#[cfg(feature = "protobuf-codec")]
-mod health_grpc;
+mod protobuf {
+    #[allow(deprecated)]
+    pub mod health;
+    pub mod health_grpc;
+}
 #[cfg(feature = "protobuf-codec")]
 mod reexports {
-    pub use super::health::*;
-    pub use HealthCheckResponseServingStatus as ServingStatus;
+    pub use super::protobuf::health::*;
+    pub use super::protobuf::health_grpc::*;
 }
 
 pub use self::reexports::*;