Propose CI infrastructures in github action

.github/workflows/actions/merge-cov/action.yml

@@ -0,0 +1,46 @@
+# Encapsulate the steps to merge code coverage reports
+# You can call this action wit the following:
+# 
+# steps:
+#   ...
+#   # make sure to checkout the code before running the local action
+#   - uses: actions/checkout@v2
+#   - uses: ./.github/workflows/actions/merge-cov
+
+name: 'Merge code coverage reports'
+description: 'Merge the coverage reports from all of the different test runs.'
+
+outputs:
+  # return the filename of the final coverage report (if needed by downstream)
+  cov-report-filename:
+    description: "Filename of the code coverage report"
+    value: ${{ steps.show-final-report.outputs.cov-report-final }}
+
+runs:
+  using: "composite"
+  steps:
+  - name: Install dev-dependencies
+    shell: bash
+    run: |
+      pip install --upgrade pip setuptools wheel
+      python -m pip install coverage
+
+  - name: Show downloaded coverage reports
+    shell: bash
+    run: ls .coverage*
+
+  # Merge code coverage reports so the coverage numbers are accurate across
+  # different parallelized runs
+  - name: Merge coverage reports
+    shell: bash
+    run: |
+      python -m coverage combine .coverage*
+      python -m coverage report
+      python -m coverage xml
+
+  - name: Show merged report
+    id: show-final-report
+    shell: bash
+    run: |
+      echo "Final code coverage report: '$(ls *.xml)'"
+      echo "::set-output name=cov-report-final::$(echo $(ls *.xml))"

.github/workflows/actions/run-tests/action.yml

@@ -0,0 +1,60 @@
+# Encapsulate the steps to run pytests
+# You can call this action wit the following:
+# 
+# steps:
+#   ...
+#   # make sure to checkout the code before running the local action
+#   - uses: actions/checkout@v2
+#   - uses: ./.github/workflows/actions/run-tests
+#     with:
+#       test-kind: 'unit'
+#       test-marker: 'spark and notebooks'
+
+name: 'Run Python tests'
+description: 'Specify parameters to configure test subsets to run and collect test report for.'
+inputs:
+  test-kind:
+    description:
+      "The kinds of tests to run. EX) unit|integration|smoke
+      This maps to those in the 'tests/<unit|integration|smoke>' folder"
+    required: true
+    default: 'unit'
+  test-marker:
+    description: 
+      "Finer filter for selecting the tests to run with pytest markers.
+      See https://docs.pytest.org/en/6.2.x/example/markers.html"
+    default: 'not gpu and not notebooks and not spark'
+outputs:
+  cov-report-filename:
+    description: "Filename of the code coverage report"
+    value: ${{ steps.rename-cov-report.outputs.cov-report-filename }}
+
+runs:
+  using: "composite"
+  steps:
+  ################# Run Python tests #################
+  - name: Install build dependencies (tox)
+    shell: bash
+    run: |
+      python -m pip install --upgrade pip setuptools wheel
+      pip install tox
+
+  - name: Run ${{ inputs.test-kind }} tests ('${{ inputs.test-marker }}')
+    shell: bash
+    # '-e py' will use the default 'python' executable found in system path
+    # for why using tox, see: https://tox.readthedocs.io/en/latest/index.html
+    # tox will do:
+    #   1. build and install source distribution (sdist)
+    #   2. run static analysis on the code (not implemented yet)
+    #   3. run all of the specified test environment (i.e. run tests in different py-versions, etc)
+    #   4. show test reports
+    run: |
+      tox -e py -- tests/${{ inputs.test-kind }} -m '${{ inputs.test-marker }}'
+
+  - name: Prepare Code Coverage Report
+    id: rename-cov-report
+    shell: bash
+    run: |
+        mv .coverage '.coverage_${{ inputs.test-marker }}_${{ inputs.test-kind }}_${{ github.sha }}'
+        echo "Coverage report renamed to: '$(ls .coverage*)'"
+        echo "::set-output name=cov-report-filename::$(echo $(ls .coverage*))"

.github/workflows/pr-gate.yml

@@ -0,0 +1,164 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+# ---------------------------------------------------------
+name: pr-gate
+
+on:
+  push:
+    branches: [ laserprec/ghaction-ci, laserprec/ghaction-sandbox2]
+
+# This file defines following CI workflow:
+#
+#  ┌──────────┐   ┌─────────┐   ┌────────┐
+#  │  static  ├─┬─►  build* ├─┬─►  test  │
+#  │ analysis │ │ │  (cpu)  │ │ │ report │
+#  └──────────┘ │ └─────────┘ │ └────────┘         
+#               │ ┌─────────┐ │
+#               ├─►  build* ├─┤
+#               │ │ (spark) │ │
+#               │ └─────────┘ │
+#               │ ┌─────────┐ │
+#               └─►  build* ├─┘
+#                 │  (gpu)  │   <-- TODO: Coming Soon
+#                 └─────────┘
+#                    ....
+# *each runs in PARALLEL the different combinations
+#  of python version, OS, test subsets, etc
+#
+#  ASCII chart created via https://asciiflow.com/
+
+jobs:
+###############################################
+############### STATIC-ANALYSIS ###############
+###############################################
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Python 3.6
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.6
+
+    - name: Install dependencies (tox)
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        pip install tox
+
+    - name: Run flake8
+      # TODO: re-enable this flake8 blocks (turned off to get a draft of the pipeline infrastracture)
+      continue-on-error: true
+      run: |
+       tox -e flake8
+
+###############################################
+################## CPU-BUILD ##################
+###############################################
+  build-cpu:
+    runs-on: ${{ matrix.os }}
+    needs: static-analysis
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: [3.6]
+        # different kind of tests are located in tests/<unit|integration|smoke> folders
+        test-kind: ['unit'] 
+        # pytest markers configured in tox.ini. See https://docs.pytest.org/en/6.2.x/example/markers.html
+        test-marker: ['not gpu and not spark and not notebooks', 'not gpu and notebooks and not spark']
+
+    steps:
+    - uses: actions/checkout@v2
+    ################# Run Python tests #################
+    - name: Use Python ${{ matrix.python }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+    # There are little documentation on how to call **local** actions
+    # https://docs.github.com/en/actions/creating-actions/about-actions#choosing-a-location-for-your-action
+    # but there is some working insights from this discussion:
+    # https://github.jparrowsec.cnmunity/t/path-to-action-in-the-same-repository-as-workflow/16952/2
+    - name: Run ${{ matrix.test-kind }} tests ('${{ matrix.test-marker }}')
+      uses: ./.github/workflows/actions/run-tests
+      with:
+        test-kind: ${{ matrix.test-kind }}
+        test-marker: ${{ matrix.test-marker }}
+    # Currently GitHub workflow cannot call an action from another action
+    # https://github.jparrowsec.cnmunity/t/call-an-action-from-another-action/17524
+    # Else this shared step can also be move to the local action: .github/workflows/actions/run-tests
+    - name: Upload Code Coverage
+      uses: actions/upload-artifact@v2
+      with:
+        name: code-cov
+        path: .coverage*
+
+###############################################
+################# SPARK-BUILD #################
+###############################################
+  build-spark:
+    runs-on: ${{ matrix.os }}
+    needs: static-analysis
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        java: [8]
+        python: [3.6]
+        # different kind of tests are located in tests/<unit|integration|smoke> folders
+        test-kind: ['unit'] 
+        # pytest markers configured in tox.ini. See https://docs.pytest.org/en/6.2.x/example/markers.html
+        test-marker: ['notebooks and spark and not gpu', 'spark and not notebooks and not gpu']
+
+    steps:
+    - uses: actions/checkout@v2
+    ################# Install spark dependencies (java) #################
+    - name: Setup Java JDK
+      uses: actions/[email protected]
+      with:
+        java-version: ${{ matrix.java }}
+        distribution: 'adopt'
+
+    ################# Run Python tests #################
+    - name: Use Python ${{ matrix.python }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+
+    - name: Run ${{ matrix.test-kind }} tests ('${{ matrix.test-marker }}')
+      uses: ./.github/workflows/actions/run-tests
+      with:
+        test-kind: ${{ matrix.test-kind }}
+        test-marker: ${{ matrix.test-marker }}
+
+    - name: Upload Code Coverage
+      uses: actions/upload-artifact@v2
+      with:
+        name: code-cov
+        path: .coverage*
+
+###############################################
+############ TEST COVERAGE SUMMARY ############
+###############################################
+  collect-code-cov:
+    runs-on: ubuntu-latest
+    needs: [build-cpu, build-spark]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/[email protected]
+        with:
+          python-version: '3.6'
+
+      - name: Download coverage reports from all previous jobs
+        uses: actions/download-artifact@v2
+        with:
+          name: code-cov
+
+      - name: Merge coverage reports
+        uses: ./.github/workflows/actions/merge-cov
+
+      - name: Upload code coverage report to CodeCov
+        uses: codecov/[email protected]
+        with:
+          fail_ci_if_error: true
+          # comes from the last 'Merge coverage reports' step
+          files: ./coverage.xml

.gitignore

@@ -24,6 +24,7 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
+license.txt
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -37,6 +38,7 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
+junit
 .tox/
 .coverage
 .coverage.*

setup.py

@@ -73,7 +73,7 @@
         "cmake>=3.18.4.post1",
         "xlearn==0.40a1",
     ],
-    "dev": ["black>=18.6b4,<21", "pytest>=3.6.4"],
+    "dev": ["black>=18.6b4,<21", "pytest>=3.6.4", "pytest-cov>=2.12.1"],
 }
 # for the brave of heart
 extras_require["all"] = list(set(sum([*extras_require.values()], [])))

tests/ci/azure_pipeline_test/dsvm_linux_template.yml

@@ -84,6 +84,7 @@ jobs:
 
         conda activate ${{ parameters.conda_env }}
         pip install pytest>=3.6.4 || exit -1
+        pip install pytest-cov
 
         if [[ "${{ parameters.conda_env }}" == *"spark"* ]]; then
           export PYSPARK_PYTHON=`which python`

tox.ini

@@ -0,0 +1,67 @@
+[tox]
+# py will use whatever the basepython `python` maps to from PATH
+# you can use py38, for example, to chosse a different version
+# See https://tox.readthedocs.io/en/latest/config.html#tox-environments
+envlist = py
+
+
+[testenv]
+# Reading additional dependencies to run the test
+# https://tox.readthedocs.io/en/latest/example/basic.html#depending-on-requirements-txt-or-defining-constraints
+; deps = -rrequirements-dev.txt
+# similar to 'pip install recommenders-*.whl[test]'
+extras = all
+commands = 
+    # {posargs} will be substituded by arguments after the `--` when running.
+    # This will allow running subset of the test suite via tox. 
+    #
+    # EX: tox -- -m "not spark and not gpu" 
+    #     will pass {-m "not spark and not gpu"} to `pytest`
+    # See https://tox.readthedocs.io/en/latest/example/general.html for more details
+    pytest {posargs}
+
+
+[testenv:flake8]
+deps = flake8
+skip_install = True
+commands = flake8 .
+
+
+# Configurations for running pytest
+[pytest]
+log_cli = False
+log_format = %(asctime)s %(levelname)s %(message)s
+junit_family = xunit2
+# This enable custom marker as decorator "@pytest.mark.gpu"
+markers = 
+    # markers allow to us to run faster subset of the test:
+    # EX: pytest -m "not spark and not gpu"
+    # See https://docs.pytest.org/en/stable/example/markers.html#registering-markers
+    deeprec: test deeprec model
+    sequential: test sequential model
+    notebooks: mark a test as notebooks test
+    smoke: mark a test as smoke test
+    integration: mark a test as integration test
+    gpu: mark a test as gpu test
+    spark: mark a test as spark test
+    vw: mark a test as vowpal wabbit test
+testpaths =
+    tests
+addopts =
+    # reports all (except passed tests). See https://docs.pytest.org/en/latest/usage.html#detailed-summary-report
+    -ra
+    --durations 0 
+    --cov-append --cov=recommenders --cov-report=html --cov-report=term-missing --cov-report=xml --junitxml=junit/test-results.xml
+
+
+[flake8]
+; # Configs for flake8-import-order, see https://pypi.org/project/flake8-import-order/ for more info.
+; import-order-style=edited
+; application-import-names=recommenders, tests
+# Native flake8 configs
+max-line-length = 140
+exclude = 
+    build, dist, docs, examples,
+    tests
+    .env*,.venv* # local virtual environments
+    .tox