Draft: Add ci

.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: ci
+on: [push, pull_request]
+jobs:
+
+  test-python-service:
+    name: Test Python service
+    strategy:
+      matrix:
+        os: [ubuntu-18.04, ubuntu-20.04]
+        python-version: [3.5, 3.6, 3.7, 3.8, 3.9]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: checkout code
+      uses: actions/checkout@v2
+
+    - name: set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: initialize submodules
+      run: git submodule update --init --recursive --progress --depth 1
+
+    - name: build docker image
+      run: |
+        cd python
+        ./build_docker_image.sh "${GITHUB_REF##*/}"
+
+    - name: run tests
+      run: |
+        docker run --rm dictation-client-python:"${GITHUB_REF##*/}" ./tests/test_service_with_script_for_local_usage.sh
+        ./python/tests/test_service_with_script_for_docker_usage.sh dictation-client-python:"${GITHUB_REF##*/}"
+
+
+  test-cpp-service:
+    name: Test C++ service
+    strategy:
+      matrix:
+        os: [ubuntu-18.04, ubuntu-20.04]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: checkout code
+      uses: actions/checkout@v2
+
+    - name: initialize submodules
+      run: git submodule update --init --recursive --progress --depth 1
+
+    - name: build docker image
+      run: |
+        cd cpp
+        ./build_docker_image.sh "${GITHUB_REF##*/}"
+
+    - name: run tests
+      run: |
+        docker run --rm dictation-client-cpp:"${GITHUB_REF##*/}" ./cpp/tests/test_service_with_script_for_local_usage.sh
+        ./cpp/tests/test_service_with_script_for_docker_usage.sh dictation-client-cpp:"${GITHUB_REF##*/}"

.github/workflows/publish-images.yml

@@ -0,0 +1,48 @@
+name: Publish deploy images
+on:
+  release:
+    types: [published]
+
+jobs:
+
+  python-build:
+    name: Build and publish Python image
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v2
+      - name: build docker image and push to repository
+        env:
+          REPOSITORY: jaredharet/private
+          DOCKER_LOGIN: ${{ secrets.DOCKER_USER }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASS }}
+        run: |
+          cd python
+          VERSION_TAG=$(awk < VERSION.py '/__version__/ { print $NF }' | cut -d\" -f2)
+          ./build_docker_image.sh "${VERSION_TAG}"
+          docker login -u "${DOCKER_LOGIN}" -p "${DOCKER_PASSWORD}" docker.io
+          docker tag dictation-client-python:"${VERSION_TAG}" "${REPOSITORY}":dictation-client-python-"${VERSION_TAG}"
+          docker push "${REPOSITORY}":dictation-client-python-"${VERSION_TAG}"
+
+  cpp-build:
+    name: Build and publish C++ image
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v2
+      - name: initialize submodules
+        run: git submodule update --init --recursive --progress --depth 1
+      - name: build docker image and push to repository
+        env:
+          REPOSITORY: jaredharet/private
+          DOCKER_LOGIN: ${{ secrets.DOCKER_USER }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASS }}
+        run: |
+          cd cpp
+          VERSION_TAG=$(awk < libdictation-client/VERSION.h '/LIBDICTATION_CLIENT_VERSION/ { print $NF }' | cut -d\" -f2)
+          ./build_docker_image.sh "${VERSION_TAG}"
+          docker login -u "${DOCKER_LOGIN}" -p "${DOCKER_PASSWORD}" docker.io
+          docker tag dictation-client-cpp:"${VERSION_TAG}" "${REPOSITORY}":dictation-client-cpp-"${VERSION_TAG}"
+          docker push "${REPOSITORY}":dictation-client-cpp-"${VERSION_TAG}"

CHANGELOG.md

@@ -4,6 +4,10 @@ This changelog is intended for tracking content changes in whole repository.
 We are using single version and changelog for all components.
 Dev note: Remember to synchronize version in files: `python/VERSION.py` and `cpp/libdictation-client/VERSION.h`
 
+## [2.3.4] - 2020-05-12
+### Changed
+ - [CPP, python] - renamed `ssl-dir` option [bool] to `tls-dir`.
+
 ## [2.3.3] - 2021-08-01
 ### Changed
  - [CPP] Upgrade Boost version to 1.74.0

README.md

@@ -1,4 +1,7 @@
 # dictation-client
+
+![ci Actions Status](https://github.com/JaredHaret/dictation-client/workflows/ci/badge.svg)
+
 Dictation ASR gRPC client
 
 Contents:  

cpp/CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.5)
 
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules" ${CMAKE_MODULE_PATH})
 
-project(dictation VERSION 1.0 LANGUAGES CXX)
+project(dictation-client VERSION 2.3.4 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 14)
 

Dockerfile-cpp → cpp/Dockerfile

@@ -1,7 +1,9 @@
-FROM ubuntu:20.04
+FROM ubuntu:20.04 AS build-stage
 
 ARG DEBIAN_FRONTEND=noninteractive
 
+LABEL dictation_client_cpp_build_stage_tmp=true
+
 ADD ./cpp /dictation-client/cpp
 ADD ./proto /dictation-client/proto
 ADD ./tools /dictation-client/tools
@@ -36,3 +38,19 @@ RUN ./tools/install_boost.sh 4 \
 RUN ./tools/build_googleapis.sh && cd cpp && ./make_proto.sh
 
 RUN cd cpp && cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j 4
+
+RUN strip cpp/build/dictation_client
+
+# ----------------------------------------------------------------------------------------------------- #
+
+FROM ubuntu:20.04 
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+LABEL maintainer="<jan.wozniak@techmo.pl>"
+
+COPY --from=build-stage /dictation-client/cpp/build/dictation_client /dictation-client/cpp/build/dictation_client
+COPY --from=build-stage /dictation-client/submodules/ /dictation-client/submodules/
+COPY --from=build-stage /opt /opt
+
+WORKDIR /dictation-client

cpp/README.md

@@ -23,16 +23,18 @@ In this case open project repository in web browser, go to the `submodules` dire
 
 ### Build docker image
 
-To prepare the docker image with C++ implementation of the Dictation Client, open project's main directory and run following command:
+To prepare the docker image with C++ implementation of the Dictation Client, use the building script:
 
 ```
-docker build -f Dockerfile-cpp -t dictation-client-cpp:2.3.2 . 
+./build_docker_image.sh
 ```
+(To set custom image tag, use the tag name as optional argument, e.g.: `./build_docker_image.sh custom_tag`)
+
 **Note:** The build process may take a several dozen minutes (for shorter build time use the python implementation instead).
 
 When the build process is complete, following a message will be shown:
 ```
-Successfully tagged dictation-client-cpp:2.3.2
+Successfully tagged dictation-client-cpp:2.3.4
 ```
 
 ### Run Dictation client

cpp/build_docker_image.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# coding=utf-8
+
+set -euo pipefail
+IFS=$'\n\t'
+
+SCRIPT=$(realpath "$0")
+SCRIPTPATH=$(dirname "${SCRIPT}")
+
+COMMIT_TAG=""
+
+if [[ "$#" -eq 0 ]]
+then
+    COMMIT_TAG=$(awk < "${SCRIPTPATH}"/libdictation-client/VERSION.h '/LIBDICTATION_CLIENT_VERSION/ { print $NF }' | cut -d\" -f2)
+else
+    COMMIT_TAG="$1"
+fi
+
+docker build -f "${SCRIPTPATH}/Dockerfile" -t dictation-client-cpp:"${COMMIT_TAG}" "${SCRIPTPATH}/.."
+
+docker rmi "$(docker images --filter=label=dictation_client_cpp_build_stage_tmp=true -q)"

cpp/dictation-client/main.cpp

@@ -76,8 +76,8 @@ po::options_description CreateOptionsDescription(void) {
             ("help", "Print help message.")
             ("service-address", po::value<std::string>()->required(),
              "IP address and port (address:port) of a service the client will connect to.")
-            ("ssl-dir", po::value<std::string>()->default_value(""),
-             "If set to a path with ssl credential files (client.crt, client.key, ca.crt), use ssl authentication. Otherwise use insecure channel (default).")
+            ("tls-dir", po::value<std::string>()->default_value(""),
+             "If set to a path with SSL/TLS credential files (client.crt, client.key, ca.crt), use SSL/TLS authentication. Otherwise use insecure channel (default).")
             ("wav-path", po::value<std::string>()->required(),
              "Path to wave file with audio content to be sent to service via RPC.")
             ("session-id", po::value<std::string>()->default_value(""),
@@ -129,7 +129,7 @@ int main(int argc, const char *const argv[]) {
 
         techmo::dictation::DictationClient dictation_client{
             userOptions["service-address"].as<std::string>(),
-            userOptions["ssl-dir"].as<std::string>(),
+            userOptions["tls-dir"].as<std::string>(),
         };
 
         if (userOptions.count("streaming")) {

cpp/docker/run_dictation_client_cpp.sh

@@ -4,11 +4,10 @@
 # This script sends request to dictation service using dictation client inside docker container
 # Requires "dictation-client-cpp:$IMAGE_VERSION" docker image loaded locally
 
-
 set -euo pipefail
 IFS=$'\n\t'
 
-IMAGE_VERSION=2.3.2
+IMAGE_VERSION="2.3.4"
 
 SCRIPT=$(realpath "$0")
 SCRIPTPATH=$(dirname "${SCRIPT}")
@@ -19,23 +18,26 @@ usage() {
 echo "
 Dictation ASR gRPC client ${IMAGE_VERSION}
 Dictation ASR gRPC client options:
+
   -h, --help            Print help message.
-  -s=ADDRESS, --service-address=ADDRESS   
+  --custom-image=IMAGE:TAG
+                        Uses a custom docker image instead of the default.
+  -s=ADDRESS, --service-address=ADDRESS
                         IP address and port (address:port) of a service the client will connect to.
-  --tls                 If set, uses tls authentication, otherwise use insecure channel (default). The tls credential files (client.crt, client.key, ca.crt) should be placed inside 'tls' directory.
-  -f=WAVE, --filename=WAVE        
+  --tls                 If set, uses SSL/TLS authentication, otherwise use insecure channel (default). The tls credential files (client.crt, client.key, ca.crt) should be placed inside 'tls' directory.
+  -f=WAVE, --filename=WAVE
                         Path to wave file with audio content to be sent to service via RPC.
-  --session-id=SESSION_ID                
+  --session-id=SESSION_ID
                         Session ID to be passed to the service. If not specified, the service will generate a default session ID itself.
   --grpc-timeout=GRPC_TIMEOUT
                         Timeout in milliseconds used to set gRPC deadline - how long the client is willing to wait for a reply from the server. If not specified, the service will set the deadline to a very large number.
   --streaming           If present, will perform asynchronous RPC. This is obligatory for audio content larger than 3.5 MB.
   --time-offsets        If true, returns also recognized word time offsets.
   --single-utterance    If set - the recognizer will detect a single spoken utterance.
   --interim-results     If set - messages with temporal results will be shown.
-  --service-settings=SETTINGS         
+  --service-settings=SETTINGS
                         Semicolon-separated list of key=value pairs defining settings to be sent to service via gRPC request.
-  --max-alternatives=MAX_ALTERNATIVES 
+  --max-alternatives=MAX_ALTERNATIVES
                         Maximum number of recognition hypotheses to be returned.
   --context-phrase=CONTEXT_PHRASE
                         Specifies which context model to use.
@@ -47,22 +49,25 @@ while getopts "f:hs:-:" optchar; do
     case "${optchar}" in
         -)
             case "${OPTARG}" in
-                help)   
-                    usage; exit 0 
+                custom-image=*)
+                    docker_image=${OPTARG#*=}
+                    ;;
+                help)
+                    usage; exit 0
                     ;;
-                tls)  
-                    opts+=( "--ssl-dir" "/volume/tls" )
+                tls)
+                    opts+=( "--tls-dir" "/volume/tls" )
                     ;;
-                time-offsets)  
+                time-offsets)
                     opts+=( "--time-offsets=true" )
                     ;;
-                single-utterance)  
+                single-utterance)
                     opts+=( "--single-utterance=true" )
                     ;;
-                interim-results)  
+                interim-results)
                     opts+=( "--interim-results=true" )
                     ;;
-                streaming)  
+                streaming)
                     opts+=( "--streaming" )
                     ;;
                 filename=*)
@@ -81,25 +86,25 @@ while getopts "f:hs:-:" optchar; do
                     fi
                     ;;
             esac;;
-        f)                      
+        f)
             val=${OPTARG#*=}
             opt=${OPTARG%=$val}
             opts+=( "--wav-path" "/volume/wav/${val##*/}" )
             ;;
-        h)  
-            usage; exit 0 
+        h)
+            usage; exit 0
             ;;
-        s)  
+        s)
             val=${OPTARG#*=}
             opt=${OPTARG%=$val}
             opts+=( "--service-address" "${val}" )
             ;;
         *)
-            usage 
+            usage
             exit 1
             ;;
     esac
 done
 
-docker run --rm -it -v "${SCRIPTPATH}:/volume" --network host "${docker_image}"  \
+docker run --rm -v "${SCRIPTPATH}:/volume" --network host "${docker_image}"  \
 ./cpp/build/dictation_client "${opts[@]}"

cpp/libdictation-client/VERSION.h

@@ -1 +1 @@
-static constexpr auto LIBDICTATION_CLIENT_VERSION = "2.3.3";
+static constexpr auto LIBDICTATION_CLIENT_VERSION = "2.3.4";