Build&tests improvements

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+select = E901,E999,F821,F822,F823
+max-line-length = 100
+exclude = .git,.eggs,__pycache__,build,dist,venv,third_party,_deps
+max-complexity = 11
+show-source = true
+statistics = true
+count = true

.github/workflows/scripts/build_nix.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+pip install .

.github/workflows/scripts/install_req_macos.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+python -m pip install --upgrade pip
+pip install -r requirements_dev.txt
+brew install protobuf
+
+pip install setuptools wheel twine auditwheel

.github/workflows/scripts/install_req_ubuntu.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+
+sudo apt update -y
+sudo apt install libboost-all-dev libprotobuf-dev protobuf-compiler curl git build-essential cmake automake libtool libtool-bin -y
+
+python -m pip install --upgrade pip
+pip install -r requirements_dev.txt
+
+pip install setuptools wheel twine auditwheel

.github/workflows/scripts/lint_cpp.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+set -e
+
+# Lint files (all .cpp and .h files) inplace.
+find ./eva/  \( -iname *.h -o -iname *.cpp \) | xargs clang-format -i -style='file'
+if [ $? -ne 0 ]
+then
+    exit 1
+fi
+
+# Print changes.
+git diff
+# Already well formated if 'git diff' doesn't output anything.
+! ( git diff |  grep -q ^ ) || exit 1

.github/workflows/scripts/lint_python.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+set -e
+
+# stop the build if there are Python syntax errors or undefined names
+flake8 --config=.flake8 python/
+black --check python/ tests/
+# exit-zero treats all errors as warnings.
+flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics

.github/workflows/tests.yml

@@ -0,0 +1,61 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  Linter:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.8]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: .github/workflows/scripts/install_req_ubuntu.sh
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+      - name: Lint with flake8
+        run: .github/workflows/scripts/lint_python.sh
+      - name: Lint with clang-format
+        run: .github/workflows/scripts/lint_cpp.sh
+
+  Tests:
+    needs: [Linter]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Prepare ENV
+        run: |
+            echo "CC=clang" >> $GITHUB_ENV
+            echo "CXX=clang++" >> $GITHUB_ENV
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+      - name: Install dependencies Ubuntu
+        run: .github/workflows/scripts/install_req_ubuntu.sh
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+      - name: Install dependencies MacOS
+        run: .github/workflows/scripts/install_req_macos.sh
+        if: ${{ matrix.os == 'macos-latest' }}
+      - name: Build the library for Ubuntu/MacOS
+        run: .github/workflows/scripts/build_nix.sh
+      - name: Test
+        run: python tests/all.py

.gitignore

@@ -1,4 +1,3 @@
-/.*/
 /build/
 /dist/
 eva.egg-info/
@@ -16,4 +15,5 @@ CMakeFiles/
 *.pb.h
 *.a
 *.so
-*.whl
+*.whl
+_deps

CMakeLists.txt

@@ -21,19 +21,13 @@ if(USE_GALOIS)
   add_definitions(-DEVA_USE_GALOIS)
 endif()
 
-find_package(SEAL 3.6 REQUIRED)
 find_package(Protobuf 3.6 REQUIRED)
-find_package(Python COMPONENTS Interpreter Development)
 
-if(NOT Python_VERSION_MAJOR EQUAL 3)
-    message(FATAL_ERROR "EVA requires Python 3. Please ensure you have it
-        installed in a location searched by CMake.")
-endif()
-
-add_subdirectory(third_party/pybind11)
+include(cmake/seal.cmake)
+include(cmake/pybind11.cmake)
 if(USE_GALOIS)
-    add_subdirectory(third_party/Galois EXCLUDE_FROM_ALL)
+    include(cmake/galois.cmake)
 endif()
 
-add_subdirectory(eva)
-add_subdirectory(python)
+include(cmake/eva.cmake)
+include(cmake/python.cmake)

README.md

@@ -15,7 +15,7 @@ EVA is a native library written in C++17 with bindings for Python. Both Linux an
 
 To install dependencies on Ubuntu 20.04:
 ```
-sudo apt install cmake libboost-all-dev libprotobuf-dev protobuf-compiler
+sudo apt install cmake libboost-all-dev libprotobuf-dev protobuf-compiler libfmt-dev
 ```
 
 Clang is recommended for compilation, as SEAL is faster when compiled with it. To install clang and set it as default:
@@ -25,33 +25,18 @@ sudo update-alternatives --install /usr/bin/cc cc /usr/bin/clang 100
 sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/clang++ 100
 ```
 
-Next install Microsoft SEAL version 3.6:
-```
-git clone -b v3.6.0 https://github.com/microsoft/SEAL.git
-cd SEAL
-cmake -DSEAL_THROW_ON_TRANSPARENT_CIPHERTEXT=OFF .
-make -j
-sudo make install
-```
-*Note that SEAL has to be installed with transparent ciphertext checking turned off, as it is not possible in general to statically ensure a program will not produce a transparent ciphertext. This does not affect the security of ciphertexts encrypted with SEAL.*
-
 ### Building and Installing EVA
 
 #### Building EVA
 
-EVA builds with CMake version ≥ 3.13:
+EVA builds with CMake version ≥ 3.13. . To install the package for development with PIP:
 ```
-git submodule update --init
-cmake .
-make -j
-```
-The build process creates a `setup.py` file in `python/`. To install the package for development with PIP:
-```
-python3 -m pip install -e python/
+pip install .
 ```
+
 To create a Python Wheel package for distribution in `dist/`:
 ```
-python3 python/setup.py bdist_wheel --dist-dir='.'
+python3 setup.py bdist_wheel --dist-dir='.'
 ```
 
 To check that the installed Python package is working correctly, run all tests with:

eva/CMakeLists.txt → cmake/eva.cmake

@@ -1,11 +1,31 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT license.
+
+set(EVA_SOURCES
+    eva/seal/seal.cpp
+    eva/util/logging.cpp
+    eva/common/reference_executor.cpp
+    eva/ckks/ckks_config.cpp
 
-add_library(eva STATIC
-    eva.cpp
-    version.cpp
+    eva/ir/term.cpp
+    eva/ir/program.cpp
+    eva/ir/attribute_list.cpp
+    eva/ir/attributes.cpp
+
+    eva/eva.cpp
+    eva/version.cpp
 )
 
+if(USE_GALOIS)
+     set(EVA_SOURCES ${EVA_SOURCES}
+         eva/util/galois.cpp
+     )
+endif()
+
+add_library(eva STATIC ${EVA_SOURCES})
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/eva/serialization/)
+
 # TODO: everything except SEAL::seal should be make PRIVATE
 target_link_libraries(eva PUBLIC SEAL::seal protobuf::libprotobuf)
 if(USE_GALOIS)
@@ -18,10 +38,3 @@ target_include_directories(eva
         $<INSTALL_INTERFACE:include>
 )
 target_compile_definitions(eva PRIVATE EVA_VERSION_STR="${PROJECT_VERSION}")
-
-add_subdirectory(util)
-add_subdirectory(serialization)
-add_subdirectory(ir)
-add_subdirectory(common)
-add_subdirectory(ckks)
-add_subdirectory(seal)

cmake/galois.cmake

@@ -0,0 +1,12 @@
+include(FetchContent)
+
+FetchContent_Declare(
+  com_intelligentsoftwaresystems_galois
+  GIT_REPOSITORY https://github.com/IntelligentSoftwareSystems/Galois
+  GIT_TAG        master
+)
+FetchContent_MakeAvailable(com_intelligentsoftwaresystems_galois)
+
+include_directories(
+  ${com_intelligentsoftwaresystems_galois_SOURCE_DIR}/include
+)

cmake/pybind11.cmake

@@ -0,0 +1,12 @@
+include(FetchContent)
+
+FetchContent_Declare(
+  com_pybind_pybind11
+  GIT_REPOSITORY https://github.com/pybind/pybind11
+  GIT_TAG        v2.6.2
+)
+FetchContent_MakeAvailable(com_pybind_pybind11)
+
+include_directories(
+  ${com_pybind_pybind11_SOURCE_DIR}/include
+)

cmake/python.cmake

@@ -0,0 +1,13 @@
+ # Copyright (c) Microsoft Corporation. All rights reserved.
+ # Licensed under the MIT license.
+
+ pybind11_add_module(eva_py
+     python/eva/wrapper.cpp
+ )
+
+ target_compile_features(eva_py PUBLIC cxx_std_17)
+ target_link_libraries(eva_py PRIVATE eva)
+ if (MSVC)
+     target_link_libraries(eva_py PUBLIC bcrypt)
+ endif()
+ set_target_properties(eva_py PROPERTIES OUTPUT_NAME _eva)

cmake/seal.cmake

@@ -0,0 +1,17 @@
+include(FetchContent)
+
+set(SEAL_BUILD_DEPS ON)
+set(SEAL_USE_MSGSL ON)
+option(SEAL_THROW_ON_TRANSPARENT_CIPHERTEXT OFF)
+
+FetchContent_Declare(
+  com_microsoft_seal
+  GIT_REPOSITORY https://github.com/microsoft/SEAL
+  GIT_TAG        v3.6.4
+)
+FetchContent_MakeAvailable(com_microsoft_seal)
+
+include_directories(${com_microsoft_seal_SOURCE_DIR}/native/src)
+include_directories(${com_microsoft_seal_SOURCE_DIR}/thirdparty/msgsl-src/include/)
+include_directories(${com_microsoft_seal_SOURCE_DIR}/thirdparty/hexl-src/hexl/include/)
+include_directories(${com_microsoft_seal_BINARY_DIR}/native/src)