Test the library on more platforms with more versions of etcd.

Squashed commit of the following: commit 7d15f8f5f9b477f606dbe034f26c37a894eb5b46 Author: Tao He <linzhu.ht@alibaba-inc.com> Date: Thu Jan 28 10:47:55 2021 +0800 Add a bit more about how to enable authentication on etcd v3.2.x and v3.3.x. Fixes #33. Signed-off-by: Tao He <linzhu.ht@alibaba-inc.com> commit 9e84e27d480930133d2f2380bed44cb187ff1656 Author: Tao He <sighingnow@gmail.com> Date: Sun Jan 17 20:59:12 2021 +0800 Tweak LD_LIBRARY_PATH, to include /usr/local/lib. Signed-off-by: Tao He <sighingnow@gmail.com> commit c3b913c3c33606caa6ff326639a791e55565da3f Author: Tao He <linzhu.ht@alibaba-inc.com> Date: Sat Dec 26 15:27:54 2020 +0800 Test on various versions of Ubuntu and Mac, with different versions of ETCD. Signed-off-by: Tao He <linzhu.ht@alibaba-inc.com> Signed-off-by: Tao He <linzhu.ht@alibaba-inc.com>
2021-01-28 13:07:34 +08:00 · 2021-01-28 13:07:34 +08:00 · 66c111b5ca
parent cd6e85dacf
commit 66c111b5ca
3 changed files with 149 additions and 28 deletions
--- a/.github/workflows/build-test.yml
+++ b/.github/workflows/build-test.yml
@ -1,21 +1,14 @@
 name: Build and Test

-on:
-  # Trigger the workflow on push or pull request, but only for the master branch
-  push:
-    branches:
-      - ci
-      - master
-  pull_request:
-    branches:
-      - master
+on: [push, pull_request]

 jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
-        os: [ubuntu-20.04]
+        os: [ubuntu-20.04, macos-10.15, macos-11.0]
+        etcd: [v3.2.26, v3.3.11, v3.4.13]
    steps:
      - uses: actions/checkout@v2
        with:
@ -39,28 +32,82 @@ jobs:
          sudo apt update -y
          sudo apt install -y ca-certificates \
                              ccache \
-                              cmake \
                              libboost-all-dev \
                              libcurl4-openssl-dev \
-                              libgrpc-dev \
-                              libgrpc++-dev \
-                              libprotobuf-dev \
                              libssl-dev \
                              libz-dev \
                              lsb-release \
-                              protobuf-compiler-grpc \
                              screenfetch \
                              wget

-          # install etcd
-          wget https://github.com/etcd-io/etcd/releases/download/v3.4.13/etcd-v3.4.13-linux-amd64.tar.gz
-          tar zxvf etcd-v3.4.13-linux-amd64.tar.gz
-          sudo mv etcd-v3.4.13-linux-amd64/etcd /usr/local/bin/
-          sudo mv etcd-v3.4.13-linux-amd64/etcdctl /usr/local/bin/
+          # install cmake
+          wget https://github.com/Kitware/CMake/releases/download/v3.19.3/cmake-3.19.3-Linux-x86_64.sh
+          sudo bash cmake-3.19.3-Linux-x86_64.sh --prefix /usr --skip-license

-          lsb_release -a
+      - name: Install grpc v1.27.x for Ubuntu 18.04
+        if: matrix.os == 'ubuntu-18.04'
+        run: |
+          # from grpc/grpc#18948 and grpc/grpc#21989, on Ubuntu-18.04 the apt-get installed grpc doesn't
+          # work for any program that uses grpc.
+          #
+          git clone https://github.com/grpc/grpc.git --depth 1 --branch v1.27.x
+          cd grpc/
+          git submodule update --init
+          mkdir cmake-build
+          cd cmake-build/
+          cmake .. -DBUILD_SHARED_LIBS=ON \
+            -DgRPC_INSTALL=ON \
+            -DgRPC_BUILD_TESTS=OFF \
+            -DgRPC_BUILD_CSHARP_EXT=OFF \
+            -DgRPC_BUILD_GRPC_CSHARP_PLUGIN=OFF \
+            -DgRPC_BUILD_GRPC_NODE_PLUGIN=OFF \
+            -DgRPC_BUILD_GRPC_OBJECTIVE_C_PLUGIN=OFF \
+            -DgRPC_BUILD_GRPC_PHP_PLUGIN=OFF \
+            -DgRPC_BUILD_GRPC_PYTHON_PLUGIN=OFF \
+            -DgRPC_BUILD_GRPC_RUBY_PLUGIN=OFF \
+            -DgRPC_BACKWARDS_COMPATIBILITY_MODE=ON \
+            -DgRPC_ZLIB_PROVIDER=package \
+            -DgRPC_SSL_PROVIDER=package
+          make -j`nproc`
+          sudo make install
+
+      - name: Install grpc for Ubuntu 20.04
+        if: matrix.os == 'ubuntu-20.04'
+        run: |
+          sudo apt install -y libcurl4-openssl-dev \
+                              libprotobuf-dev \
+                              libprotoc-dev \
+                              libgrpc-dev \
+                              libgrpc++-dev \
+                              protobuf-compiler-grpc
+
+      - name: Install dependencies for Mac
+        if: runner.os == 'macOS'
+        run: |
+          brew install ccache cmake boost curl grpc protobuf openssl zlib unzip wget screenfetch
+
+      - name: Screen fetch
+        run: |
          screenfetch

+      - name: Install etcd for Linux
+        if: runner.os == 'Linux'
+        run: |
+          # install etcd
+          wget https://github.com/etcd-io/etcd/releases/download/${{ matrix.etcd }}/etcd-${{ matrix.etcd }}-linux-amd64.tar.gz
+          tar zxvf etcd-${{ matrix.etcd }}-linux-amd64.tar.gz
+          sudo mv etcd-${{ matrix.etcd }}-linux-amd64/etcd /usr/local/bin/
+          sudo mv etcd-${{ matrix.etcd }}-linux-amd64/etcdctl /usr/local/bin/
+
+      - name: Install etcd for Mac
+        if: runner.os == 'macOS'
+        run: |
+          # install etcd
+          wget https://github.com/etcd-io/etcd/releases/download/${{ matrix.etcd }}/etcd-${{ matrix.etcd }}-darwin-amd64.zip
+          unzip etcd-${{ matrix.etcd }}-darwin-amd64.zip
+          sudo mv etcd-${{ matrix.etcd }}-darwin-amd64/etcd /usr/local/bin/
+          sudo mv etcd-${{ matrix.etcd }}-darwin-amd64/etcdctl /usr/local/bin/
+
      - name: Install cpprestsdk
        run: |
          mkdir -p build
@ -68,26 +115,39 @@ jobs:
          git clone https://github.com/microsoft/cpprestsdk.git
          mkdir -p cpprestsdk/build
          cd cpprestsdk/build
-          cmake .. -DBUILD_TESTS=OFF \
+          cmake .. -DCMAKE_BUILD_TYPE=Debug \
+                   -DBUILD_TESTS=OFF \
                   -DBUILD_SAMPLES=OFF \
                   -DCPPREST_EXCLUDE_WEBSOCKETS=ON \
                   -DCMAKE_C_COMPILER_LAUNCHER=ccache \
                   -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
-          make -j2
+          make -j`nproc`
          sudo make install

      - name: Build
        run: |
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
+
          mkdir -p build
          cd build
-          cmake .. -DBUILD_ETCD_TESTS=ON \
+          cmake .. -DCMAKE_BUILD_TYPE=Debug \
+                   -DBUILD_ETCD_TESTS=ON \
                   -DCMAKE_C_COMPILER_LAUNCHER=ccache \
                   -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
          make -j2
          sudo make install

+      - name: Setup tmate session
+        if: false
+        uses: mxschmitt/action-tmate@v2
+
      - name: Test
        run: |
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
+
+          # use etcd v3 api
+          export ETCDCTL_API="3"
+
          cd build
          /usr/local/bin/etcd &

@ -98,13 +158,34 @@ jobs:
          ./bin/WatcherTest

          # tests with auth
-          /usr/local/bin/etcdctl user add root --new-user-password="root" || true
+
+          # for etcd v3.2, v3.3
+          if [[ "${{ matrix.etcd }}" == v3.2* ]] || [[ "${{ matrix.etcd }}" == v3.3* ]];
+          then
+              printf 'root\nroot\n' | /usr/local/bin/etcdctl user add root || true
+          fi
+          # for etcd v3.4
+          if [[ "${{ matrix.etcd }}" == v3.4* ]];
+          then
+              /usr/local/bin/etcdctl user add root --new-user-password="root" || true
+          fi
+
          /usr/local/bin/etcdctl auth enable || true

          ./bin/AuthTest

-          /usr/local/bin/etcdctl auth disable --user="root" --password="root" || true
+          # for etcd v3.2
+          if [[ "${{ matrix.etcd }}" == v3.2* ]] || [[ "${{ matrix.etcd }}" == v3.3* ]];
+          then
+              /usr/local/bin/etcdctl --user="root:root" auth disable || true
+          fi
+          # for etcd v3.4
+          if [[ "${{ matrix.etcd }}" == v3.4* ]];
+          then
+              /usr/local/bin/etcdctl auth disable --user="root" --password="root" || true
+          fi

      - name: Check ccache
        run: |
          ccache --show-stats
+
--- a/README.md
+++ b/README.md
@ -4,6 +4,25 @@ etcd-cpp-apiv3
 The _etcd-cpp-apiv3_ is a C++ API for [etcd](https://etcd.io/)'s v3 client API,
 i.e., `ETCDCTL_API=3`.

+[![Build and Test](https://github.com/etcd-cpp-apiv3/etcd-cpp-apiv3/workflows/Build%20and%20Test/badge.svg)](https://github.com/etcd-cpp-apiv3/etcd-cpp-apiv3/actions?workflow=Build+and+Test)
+
+### Supported OS environments
+
+ **Linux**
+  - Ubuntu 18.04, requires upgrade boost and grpc libraries.
+  - Ubuntu 20.04
+ **MacOS**
+  - MacOS 10.15
+  - MacOS 11.0
+ **Windows**
+  - Windows 10, with [vcpkg](https://github.com/microsoft/vcpkg)
+
+### Supported etcd versions:
+
+ etcd 3.2, tested with [v3.2.26](https://github.com/etcd-io/etcd/releases/v3.2.26)
+ etcd 3.3, tested with [v3.3.11](https://github.com/etcd-io/etcd/releases/v3.3.11)
+ etcd 3.4, tested with [v3.4.13](https://github.com/etcd-io/etcd/releases/v3.4.13)
+
 ## Requirements

 1. boost
@ -125,6 +144,27 @@ the authentication properly.
  etcd::Client etcd("http://127.0.0.1:2379", "root", "root");
 ```

+Enabling v3 authentication requires a bit more work for older versions etcd (etcd 3.2.x and etcd 3.3.x).
+First you need to set the `ETCDCTL_API=3`, then
+
+ add a user, and type the password:
+
+```bash
+printf 'root\nroot\n' | /usr/local/bin/etcdctl user add root
+```
+
+ enabling authentication:
+
+```bash
+/usr/local/bin/etcdctl auth enable
+```
+
+ disable authentication:
+
+```bash
+/usr/local/bin/etcdctl --user="root:root" auth disable
+```
+
 ### Reading a value

 You can read a value with the ```get``` method of the clinent instance. The only parameter is the
--- a/src/v3/Action.cpp
+++ b/src/v3/Action.cpp
@ -5,10 +5,10 @@ etcdv3::Action::Action(etcdv3::ActionParameters params)
 {
  parameters = params;
  if (!parameters.auth_token.empty()) {
-    // use `authorization` as the key also works, see:
+    // use `token` as the key, see:
    //
    //  etcd/etcdserver/api/v3rpc/rpctypes/metadatafields.go
-    context.AddMetadata("authorization", parameters.auth_token);
+    context.AddMetadata("token", parameters.auth_token);
  }
  start_timepoint = std::chrono::high_resolution_clock::now();
 }