Make CI run multiple combinations of OS and OpenVINO versions

Author: abrown

.github/workflows/main.yml

@@ -19,9 +19,11 @@ jobs:
         submodules: true
     - run: rustup component add rustfmt
     - run: cargo fmt --all -- --check
+    - run: cd crates/openvino-tensor-converter && cargo fmt --all -- --check
 
-  build:
-    name: Build from OpenVINO source
+  # Build and test from the git-submodule-included OpenVINO source code. 
+  source:
+    name: From source
     runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v2
@@ -31,15 +33,25 @@ jobs:
     - name: Checkout LFS obects
       run: git lfs checkout
     - name: Install system dependencies
-      run: sudo apt update && sudo apt install -y clang cmake libclang-dev gnupg2 libdrm2 libglib2.0-0 libusb-1.0-0-dev lsb-release libgtk-3-0 libtool libopencv-dev libopencv-core4.2 udev unzip dos2unix
+      run: sudo apt update && sudo apt install -y clang cmake libclang-dev gnupg2 libdrm2 libglib2.0-0 libusb-1.0-0-dev lsb-release libgtk-3-0 libtool udev unzip dos2unix
     - name: Build (openvino-sys from source)
       run: cargo build --verbose
     - name: Run tests
       run: cargo test --verbose
 
+  # Build and test from an existing OpenVINO installation inside a Docker image (i.e. download the
+  # binaries, then compile against these).
   docker:
-    name: Build from OpenVINO installation inside a Docker image
+    name: From binaries
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu18, ubuntu20]
+        version: [2020.4, 2021.1, 2021.2, 2021.3]
+        exclude:
+        - os: ubuntu20
+          version: 2020.4
     steps:
     - uses: actions/checkout@v2
       with:
@@ -48,10 +60,13 @@ jobs:
     - name: Checkout LFS obects
       run: git lfs checkout
     - name: Build the Docker image
-      run: docker build . --tag openvino-rs:$(date +%s)
+      run: docker build . --tag openvino-rs:${{ matrix.OS }}-${{ matrix.version }}-$(date +%s) --build-arg OS=${{ matrix.os }} --build-arg VERSION=${{ matrix.version }}
 
+  # Build and test the openvino-tensor-converter tool separately from the regular library builds;
+  # the OpenCV dependency is a bit fragile so the crate is not included by the default workspace
+  # commands.
   converter:
-    name: Build and test the openvino-tensor-converter tool
+    name: Converter tool
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -61,7 +76,7 @@ jobs:
       with:
         submodules: recursive
     - name: Install OpenCV
-      run: sudo apt update && sudo apt install libopencv-dev libopencv-core4.2
+      run: sudo apt update && sudo apt install libclang-dev libopencv-dev libopencv-core4.2
     - name: Build
       run: cargo build -v
     - name: test

Dockerfile

@@ -1,38 +1,28 @@
-# This Dockerfile demonstrates how to build the openvino bindings using an installation of OpenVINO. For instructions
-# to install OpenVINO see the OpenVINO documentation, e.g.
+# This Dockerfile demonstrates how to build the openvino bindings using an installation of OpenVINO.
+# For instructions to install OpenVINO see the OpenVINO documentation, e.g.
 # https://docs.openvinotoolkit.org/latest/openvino_docs_install_guides_installing_openvino_apt.html.
-FROM rust:1.50
+ARG OS=ubuntu18
+ARG VERSION=2020.4
+FROM openvino/${OS}_runtime:${VERSION} AS builder
 
-# Setup Rust.
-RUN rustup component add rustfmt
+# OpenVINO's images use a default user, `openvino`, that disallows root access.
+USER root
 
-# Install OpenVINO.
-WORKDIR /tmp
-RUN wget https://apt.repos.intel.com/openvino/2020/GPG-PUB-KEY-INTEL-OPENVINO-2020 && \
-    echo '5f5cff8a2d26ba7de91942bd0540fa4d  GPG-PUB-KEY-INTEL-OPENVINO-2020' > CHECKSUM && \
-    md5sum --check CHECKSUM && \
-    apt-key add GPG-PUB-KEY-INTEL-OPENVINO-2020 && \
-    echo "deb https://apt.repos.intel.com/openvino/2020 all main" | tee /etc/apt/sources.list.d/intel-openvino-2020.list && \
-    apt update && \
-    apt install -y intel-openvino-runtime-ubuntu18-2020.4.287
+# Install Rust.
+RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --profile minimal
+ENV PATH=/root/.cargo/bin:$PATH
+RUN rustup component add rustfmt
 
 # Install build dependencies (for bindgen).
-RUN apt install -y clang libclang-dev
+RUN apt update && apt install -y clang libclang-dev
 
-# Install OpenCV (for openvino-tensor-converter).
-RUN apt install -y libopencv-dev libopencv-core3.2
-
-# Copy in OpenVINO source
-WORKDIR /usr/src/openvino
+# Copy in source code.
+WORKDIR /usr/src/openvino-rs
 COPY . .
 
-# Hack to allow the opencv crate to build with an older version of the OpenCV libraries (FIXME).
-RUN sed -i 's/"opencv-4"/"opencv-32"/g' crates/openvino-tensor-converter/Cargo.toml
-
 # Build openvino libraries.
-WORKDIR /usr/src/openvino/inference-engine/ie_bridges/rust
 RUN OPENVINO_INSTALL_DIR=/opt/intel/openvino cargo build -vv
 
-# Test; note that we need to setup the library paths before using them since the OPENVINO_INSTALL_DIR can only affect
-# the build library search path.
+# Test; note that we need to setup the library paths before using them since the
+# OPENVINO_INSTALL_DIR can only affect the build library search path.
 RUN ["/bin/bash", "-c", "source /opt/intel/openvino/bin/setupvars.sh && OPENVINO_INSTALL_DIR=/opt/intel/openvino cargo test -v"]

README.md

@@ -67,7 +67,8 @@ cargo test
 ```
 
 [openvino] and [openvino-sys] can also be built directly from OpenVINO™'s source code using CMake.
-This build process can be quite slow and there are quite a few dependencies. Some notes:
+This is not tested across all OS and OpenVINO™ versions--use at your own risk! Also, this build
+process can be quite slow and there are quite a few dependencies. Some notes:
  - first, install the necessary packages to build OpenVINO™; steps are included in the [CI
    workflow](.github/workflows)
    but reference the [OpenVINO™ build documentation](https://github.com/openvinotoolkit/openvino/blob/master/build-instruction.md)