main.yml

name: build

# Run this workflow every time a new commit pushed to your repository
on:
  push:
    branches: 
      - master
  pull_request:
    branches:
      - master
  
jobs:

  build:
    name: Build, install, and test MC2 Client
    # Define the OS to run on
    runs-on: ubuntu-18.04
    strategy:
      matrix:
        python-version: ['3.6', '3.7', '3.8']

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps: 
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          submodules: true
          path: main

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Upgrade Pip
        run: python -m pip install --upgrade pip setuptools wheel
   
      - name: Install apt package dependencies
        run: |
          # Install OpenEnclave 0.17.1
          echo 'deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu bionic main' | sudo tee /etc/apt/sources.list.d/intel-sgx.list
          wget -qO - https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo apt-key add -
          echo "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-7 main" | sudo tee /etc/apt/sources.list.d/llvm-toolchain-bionic-7.list
          wget -qO - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
          echo "deb [arch=amd64] https://packages.microsoft.com/ubuntu/18.04/prod bionic main" | sudo tee /etc/apt/sources.list.d/msprod.list
          wget -qO - https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -

          sudo apt update
          sudo apt -y install clang-8 libssl-dev gdb libsgx-enclave-common libsgx-quote-ex libprotobuf10 libsgx-dcap-ql libsgx-dcap-ql-dev az-dcap-client open-enclave=0.17.1

          # CMake
          wget https://github.com/Kitware/CMake/releases/download/v3.15.6/cmake-3.15.6-Linux-x86_64.sh

          # Mbed TLS
          sudo apt-get install -y libmbedtls-dev

      - name: Build C++
        run: | 
          # Build C++ source
          cd main
          cd src
          mkdir build
          cd build
          cmake ..
          make -j4
          cd ../..

      - name: Install Python dependencies
        run: |
          # Python packages
          # pip install setuptools wheel pytest

          cd main
          pip install -r requirements.txt 

      - name: Install mc2client Python package
        run: |
          # Install the Python package
          cd main/python-package
          python setup.py install

      - name: Checkout sequencefile Python package
        uses: actions/checkout@master
        with:
            path: sequencefile
            repository: opaque-systems/sequencefile

      - name: Install sequencefile Python package
        run: cd sequencefile; python setup.py install
        shell: bash

      - name: Run tests
        run: cd main/python-package/tests; pytest
        shell: bash

  lint:
    # Name the Job
    name: Lint code base
    # Set the type of machine to run on
    runs-on: ubuntu-18.04
  
    steps:
      # Checks out a copy of your repository on the ubuntu-18.04 machine
      - name: Checkout code
        uses: actions/checkout@v2
  
      # Runs the Super-Linter action
      - name: Run Super-Linter
        uses: github/super-linter@v4.5.1
        env:
          DEFAULT_BRANCH: master
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          FILTER_REGEX_EXCLUDE: .*src/include/(csv.hpp|json.hpp|base64.h)

          LINTER_RULES_PATH: /
          VALIDATE_CLANG_FORMAT: true
          VALIDATE_PYTHON_BLACK: true
          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
          VALIDATE_PYTHON_FLAKE8: true
          PYTHON_FLAKE8_CONFIG_FILE: .flake8

  # Build documentation
  docs:
    name: Build and check documentation
    # Define the OS to run on
    runs-on: ubuntu-18.04

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps: 
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          submodules: true
          path: main

      - name: Set up Python 3.6
        uses: actions/setup-python@v2
        with:
          python-version: 3.6

      - name: Upgrade Pip
        run: python -m pip install --upgrade pip setuptools wheel
   
      - name: Install apt package dependencies
        run: |
          # Install OpenEnclave 0.17.1
          echo 'deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu bionic main' | sudo tee /etc/apt/sources.list.d/intel-sgx.list
          wget -qO - https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo apt-key add -
          echo "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-7 main" | sudo tee /etc/apt/sources.list.d/llvm-toolchain-bionic-7.list
          wget -qO - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
          echo "deb [arch=amd64] https://packages.microsoft.com/ubuntu/18.04/prod bionic main" | sudo tee /etc/apt/sources.list.d/msprod.list
          wget -qO - https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -

          sudo apt update
          sudo apt -y install clang-8 libssl-dev gdb libsgx-enclave-common libsgx-quote-ex libprotobuf10 libsgx-dcap-ql libsgx-dcap-ql-dev az-dcap-client open-enclave=0.17.1 enchant

          # CMake
          wget https://github.com/Kitware/CMake/releases/download/v3.15.6/cmake-3.15.6-Linux-x86_64.sh

          # Mbed TLS
          sudo apt-get install -y libmbedtls-dev

      - name: Build C++
        run: | 
          # Build C++ source
          cd main
          cd src
          mkdir build
          cd build
          cmake ..
          make -j4
          cd ../..

      - name: Install Python dependencies
        run: |
          cd main
          pip install -r requirements.txt 
          pip install -r client-docs/requirements.txt

      - name: Install mc2client Python package
        run: |
          # Install the Python package
          cd main/python-package
          python setup.py install

      - name: Checkout sequencefile Python package
        uses: actions/checkout@master
        with:
            path: sequencefile
            repository: opaque-systems/sequencefile

      - name: Install sequencefile Python package
        run: cd sequencefile; python setup.py install
        shell: bash

      - name: Little hack to make this repo's docs build properly
        run: |
          cd main/client-docs
          mkdir -p _build/tmp
          cp ../mc2.py _build/tmp

      - name: Build docs
        run: |
          cd main/client-docs
          make html

      - name: Run spellcheck
        run : |
            cd main/client-docs
            sphinx-build -b spelling . _build