name: Insiders Build

on:

push:

branches:

- main

- temp

env:

PYTHON_VERSION: 3.8

NODE_VERSION: 12.15.0

MOCHA_REPORTER_JUNIT: true # Use the mocha-multi-reporters and send output to both console (spec) and JUnit (mocha-junit-reporter). Also enables a reporter which exits the process running the tests if it haven't already.

CACHE_NPM_DEPS: cache-npm

CACHE_OUT_DIRECTORY: cache-out-directory

CACHE_PIP_DEPS: cache-pip

# Key for the cache created at the end of the the 'Cache ./pythonFiles/lib/python' step.

CACHE_PYTHONFILES: cache-pvsc-pythonFiles

ARTIFACT_NAME_VSIX: ms-python-insiders-vsix

VSIX_NAME: ms-python-insiders.vsix

COVERAGE_REPORTS: tests-coverage-reports

TEST_RESULTS_DIRECTORY: .

jobs:

build-vsix:

name: Build VSIX

runs-on: ubuntu-latest

# if: github.repository == 'microsoft/vscode-python'

steps:

- name: Checkout

uses: actions/checkout@v2

- name: Cache pip files

uses: actions/cache@v2

with:

path: ~/.cache/pip

key: ${{runner.os}}-${{env.CACHE_PIP_DEPS}}-${{env.PYTHON_VERSION}}-${{hashFiles('requirements.txt')}}-${{hashFiles('build/debugger-install-requirements.txt')}}

- name: Cache npm files

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{runner.os}}-${{env.CACHE_NPM_DEPS}}-${{hashFiles('package-lock.json')}}

- name: Use Python ${{env.PYTHON_VERSION}}

uses: actions/setup-python@v2

with:

python-version: ${{env.PYTHON_VERSION}}

- name: Upgrade pip

run: python -m pip install -U pip

- name: Build VSIX

uses: ./.github/actions/build-vsix

id: build-vsix

- name: Rename VSIX

if: steps.build-vsix.outputs.path != env.VSIX_NAME

run: mv ${{ steps.build-vsix.outputs.path }} ${{ env.VSIX_NAME }}

- uses: actions/upload-artifact@v2

with:

name: ${{env.ARTIFACT_NAME_VSIX}}

path: ${{env.VSIX_NAME}}

lint:

name: Lint

runs-on: ubuntu-latest

if: github.repository == 'microsoft/vscode-python'

steps:

- name: Checkout

uses: actions/checkout@v2

- name: Cache pip files

uses: actions/cache@v2

with:

path: ~/.cache/pip

key: ${{runner.os}}-${{env.CACHE_PIP_DEPS}}-${{env.PYTHON_VERSION}}-${{hashFiles('requirements.txt')}}-${{hashFiles('build/debugger-install-requirements.txt')}}

- name: Cache npm files

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{runner.os}}-${{env.CACHE_NPM_DEPS}}-${{hashFiles('package-lock.json')}}

- name: Install dependencies (npm ci)

run: npm ci --prefer-offline

- name: Run gulp prePublishNonBundle

run: npx gulp prePublishNonBundle

- name: Cache the out/ directory

uses: actions/cache@v2

with:

path: ./out

key: ${{runner.os}}-${{env.CACHE_OUT_DIRECTORY}}-${{hashFiles('src/**')}}

- name: Check dependencies

run: npm run checkDependencies

- name: Run linting on TypeScript code

run: npx tslint --project tsconfig.json

- name: Run prettier on TypeScript code

run: npx prettier 'src/**/*.ts*' --check

- name: Run prettier on JavaScript code

run: npx prettier 'build/**/*.js' --check

- name: Use Python ${{env.PYTHON_VERSION}}

uses: actions/setup-python@v2

with:

python-version: ${{env.PYTHON_VERSION}}

- name: Run Black on Python code

run: |

python -m pip install -U black

python -m black . --check

working-directory: pythonFiles

### Non-smoke tests

tests:

name: Tests

# The value of runs-on is the OS of the current job (specified in the strategy matrix below) instead of being hardcoded.

runs-on: ${{ matrix.os }}

# if: github.repository == 'microsoft/vscode-python'

strategy:

fail-fast: false

matrix:

# We're not running CI on macOS for now because it's one less matrix entry to lower the number of runners used,

# macOS runners are expensive, and we assume that Ubuntu is enough to cover the UNIX case.

os: [ubuntu-latest, windows-latest, macos-latest]

# Run the tests on the oldest and most recent versions of Python.

python: [3.8]

# python: [2.7, 3.8]

test-suite: [ts-unit, python-unit, single-workspace, functional]

steps:

- name: Checkout

uses: actions/checkout@v2

- name: Use Node ${{env.NODE_VERSION}}

uses: actions/setup-node@v2.1.1

with:

node-version: ${{env.NODE_VERSION}}

- name: Use Python ${{matrix.python}}

uses: actions/setup-python@v2

with:

python-version: ${{matrix.python}}

- name: Upgrade pip

run: python -m pip install -U pip

# 1. Cache Python Dependencies.

# Caching (https://github.com/actions/cache/blob/main/examples.md#python---pip

- name: Cache pip on linux

uses: actions/cache@v2

# if: startsWith(runner.os, 'Linux')

if: matrix.test-suite == 'functional' && matrix.os == 'ubuntu-latest'

with:

path: ~/.cache/pip

key: ${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-${{ hashFiles('requirements.txt') }}

restore-keys: |

${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-

- name: Cache pip on mac

uses: actions/cache@v2

if: matrix.test-suite == 'functional' && matrix.os == 'macos-latest'

with:

path: ~/Library/Caches/pip

key: ${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-${{ hashFiles('requirements.txt') }}

restore-keys: |

${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-

- name: Cache pip on windows

uses: actions/cache@v2

# if: startsWith(runner.os, 'Windows')

if: matrix.test-suite == 'functional' && matrix.os == 'windows-latest'

with:

path: ~\AppData\Local\pip\Cache

key: ${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-${{ hashFiles('requirements.txt') }}

restore-keys: |

${{ runner.os }}-pip-${{env.PYTHON_VERSION}}-

# 2. Install Python Dependencies.

# For faster/better builds of sdists.

- run: python -m pip install wheel

if: matrix.test-suite == 'functional'

shell: bash

- run: python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt

shell: bash

if: matrix.test-suite == 'functional'

# debugpy is not shipped, only installed for local tests.

# In production, we get debugpy from python extension.

- name: Install functional test requirements

if: matrix.test-suite == 'functional'

run: |

python -m pip --disable-pip-version-check install -r build/debugger-install-requirements.txt

python ./pythonFiles/install_debugpy.py

python -m pip install numpy

python -m pip install --upgrade -r ./build/functional-test-requirements.txt

python -m pip install --upgrade -r ./build/conda-functional-requirements.txt

# 3. Caching of npm packages (https://github.com/actions/cache/blob/main/examples.md#node---npm)

- name: Cache npm on linux/mac

uses: actions/cache@v2

if: matrix.os != 'windows-latest'

with:

path: ~/.npm

key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

restore-keys: |

${{ runner.os }}-node-

- name: Get npm cache directory

if: matrix.os == 'windows-latest'

id: npm-cache

run: |

echo "::set-output name=dir::$(npm config get cache)"

- name: Cache npm on windows

uses: actions/cache@v2

if: matrix.os == 'windows-latest'

with:

path: ${{ steps.npm-cache.outputs.dir }}

key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

restore-keys: |

${{ runner.os }}-node-

# 4. Install npm Dependencies.

- run: npm ci --prefer-offline

shell: bash

# End Setup

- name: Cache compiled TS files

# Use an id for this step so that its cache-hit output can be accessed and checked in the next step.

id: out-cache

uses: actions/cache@v2

with:

path: ./out

key: ${{runner.os}}-${{env.CACHE_OUT_DIRECTORY}}-${{hashFiles('src/**')}}

# - name: Install dependencies (npm ci)

# run: npm ci

- name: Compile if not cached

run: npx gulp prePublishNonBundle

if: steps.out-cache.outputs.cache-hit == false

- name: Install Python requirements

run: |

python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt --no-user

# We need to have debugpy so that tests relying on it keep passing, but we don't need install_debugpy's logic in the test phase.

python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy

- name: Install test requirements

run: python -m pip install --upgrade -r build/test-requirements.txt

- name: pip install ipython requirements

run: |

python -m pip install numpy

python -m pip install --upgrade -r ./build/ipython-test-requirements.txt

if: matrix.test-suite == 'python-unit'

# - name: Install debugpy wheels (python 3.8)

# run: |

# python -m pip install wheel

# python -m pip --disable-pip-version-check install -r build/debugger-install-requirements.txt

# python ./pythonFiles/install_debugpy.py

# shell: bash

# if: matrix.test-suite == 'debugger' && matrix.python == 3.8

# - name: Install debugpy (python 2.7)

# run: |

# python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy

# shell: bash

# if: matrix.test-suite == 'debugger' && matrix.python == 2.7

- name: Install functional test requirements

run: |

python -m pip install numpy

python -m pip install --upgrade -r ./build/functional-test-requirements.txt

if: matrix.test-suite == 'functional'

# - name: Prepare pipenv for venv tests

# env:

# TEST_FILES_SUFFIX: testvirtualenvs

# PYTHON_VIRTUAL_ENVS_LOCATION: './src/tmp/envPaths.json'

# shell: pwsh

# if: matrix.test-suite == 'venv'

# run: |

# python -m pip install pipenv

# python -m pipenv run python ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} pipenvPath

# - name: Prepare virtualenv for venv tests

# env:

# TEST_FILES_SUFFIX: testvirtualenvs

# PYTHON_VIRTUAL_ENVS_LOCATION: './src/tmp/envPaths.json'

# shell: pwsh

# if: matrix.test-suite == 'venv'

# run: |

# python -m pip install virtualenv

# python -m virtualenv .virtualenv/

# if ('${{matrix.os}}' -match 'windows-latest') {

# & ".virtualenv/Scripts/python.exe" ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} virtualEnvPath

# } else {

# & ".virtualenv/bin/python" ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} virtualEnvPath

# }

# - name: Prepare venv for venv tests

# env:

# TEST_FILES_SUFFIX: testvirtualenvs

# PYTHON_VIRTUAL_ENVS_LOCATION: './src/tmp/envPaths.json'

# shell: pwsh

# if: matrix.test-suite == 'venv' && startsWith(matrix.python, 3.)

# run: |

# python -m venv .venv

# if ('${{matrix.os}}' -match 'windows-latest') {

# & ".venv/Scripts/python.exe" ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} venvPath

# } else {

# & ".venv/bin/python" ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} venvPath

# }

# - name: Prepare conda for venv tests

# env:

# TEST_FILES_SUFFIX: testvirtualenvs

# PYTHON_VIRTUAL_ENVS_LOCATION: './src/tmp/envPaths.json'

# shell: pwsh

# if: matrix.test-suite == 'venv'

# run: |

# # 1. For `terminalActivation.testvirtualenvs.test.ts`

# if ('${{matrix.os}}' -match 'windows-latest') {

# $condaPythonPath = Join-Path -Path $Env:CONDA -ChildPath python.exe

# $condaExecPath = Join-Path -Path $Env:CONDA -ChildPath Scripts | Join-Path -ChildPath conda

# } else{

# $condaPythonPath = Join-Path -Path $Env:CONDA -ChildPath bin | Join-Path -ChildPath python

# $condaExecPath = Join-Path -Path $Env:CONDA -ChildPath bin | Join-Path -ChildPath conda

# }

# & $condaPythonPath ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} condaExecPath $condaExecPath

# & $condaPythonPath ./build/ci/addEnvPath.py ${{env.PYTHON_VIRTUAL_ENVS_LOCATION}} condaPath

# # 2. For `interpreterLocatorService.testvirtualenvs.ts`

# & $condaExecPath create -n "test_env1" -y python

# & $condaExecPath create -p "./test_env2" -y python

# & $condaExecPath create -p "~/test_env3" -y python

- name: Set CI_PYTHON_PATH and CI_DISABLE_AUTO_SELECTION

run: |

echo "::set-env name=CI_PYTHON_PATH::python"

echo "::set-env name=CI_DISABLE_AUTO_SELECTION::1"

shell: bash

if: matrix.test-suite != 'ts-unit'

# Run TypeScript unit tests only for Python 3.X.

- name: Run TypeScript unit tests

run: npm run test:unittests:cover

if: matrix.test-suite == 'ts-unit' && startsWith(matrix.python, 3.)

# Upload unit test coverage reports for later use in the "reports" job.

- name: Upload unit test coverage reports

uses: actions/upload-artifact@v1

with:

name: ${{runner.os}}-${{env.COVERAGE_REPORTS}}

path: .nyc_output

if: matrix.test-suite == 'ts-unit' && startsWith(matrix.python, 3.)

# Run the Python and IPython tests in our codebase.

- name: Run Python and IPython unit tests

run: |

python pythonFiles/tests/run_all.py

python -m IPython pythonFiles/tests/run_all.py

if: matrix.test-suite == 'python-unit'

# # The virtual environment based tests use the `testSingleWorkspace` set of tests

# # with the environment variable `TEST_FILES_SUFFIX` set to `testvirtualenvs`,

# # which is set in the "Prepare environment for venv tests" step.

# # We also use a third-party GitHub Action to install xvfb on Linux,

# # run tests and then clean up the process once the tests ran.

# # See https://github.com/GabrielBB/xvfb-action

# - name: Run venv tests

# env:

# TEST_FILES_SUFFIX: testvirtualenvs

# CI_PYTHON_VERSION: ${{matrix.python}}

# uses: GabrielBB/xvfb-action@v1.4

# with:

# run: npm run testSingleWorkspace

# if: matrix.test-suite == 'venv'

- name: Run single-workspace tests

env:

CI_PYTHON_VERSION: ${{matrix.python}}

uses: GabrielBB/xvfb-action@v1.4

with:

run: npm run testSingleWorkspace

if: matrix.test-suite == 'single-workspace'

# - name: Run multi-workspace tests

# env:

# CI_PYTHON_VERSION: ${{matrix.python}}

# uses: GabrielBB/xvfb-action@v1.4

# with:

# run: npm run testMultiWorkspace

# if: matrix.test-suite == 'multi-workspace'

# - name: Run debugger tests

# env:

# CI_PYTHON_VERSION: ${{matrix.python}}

# uses: GabrielBB/xvfb-action@v1.4

# with:

# run: npm run testDebugger

# if: matrix.test-suite == 'debugger'

- name: Run functional tests

run: npm run test:functional

if: matrix.test-suite == 'functional'

- name: Run functional tests with Python

run: npm run test:functional

if: matrix.test-suite == 'functional' && startsWith(matrix.python, 3.)

env:

VSCODE_PYTHON_ROLLING: 1

VSC_PYTHON_FORCE_LOGGING: 1

CI_PYTHON_PATH: python

smoke-tests:

name: Smoke tests

# The value of runs-on is the OS of the current job (specified in the strategy matrix below) instead of being hardcoded.

runs-on: ${{ matrix.os }}

# if: github.repository == 'microsoft/vscode-python'

needs: [build-vsix]

strategy:

fail-fast: false

matrix:

# We're not running CI on macOS for now because it's one less matrix entry to lower the number of runners used,

# macOS runners are expensive, and we assume that Ubuntu is enough to cover the UNIX case.

os: [ubuntu-latest, windows-latest]

python: [3.8]

steps:

# Need the source to have the tests available.

- name: Checkout

uses: actions/checkout@v2

- name: Cache pip files

uses: actions/cache@v2

with:

path: ~/.cache/pip

key: ${{runner.os}}-${{env.CACHE_PIP_DEPS}}-${{env.PYTHON_VERSION}}-${{hashFiles('requirements.txt')}}-${{hashFiles('build/debugger-install-requirements.txt')}}

- name: Cache npm files

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{runner.os}}-${{env.CACHE_NPM_DEPS}}-${{hashFiles('package-lock.json')}}

- name: Use Python ${{matrix.python}}

uses: actions/setup-python@v2

with:

python-version: ${{matrix.python}}

- name: Install dependencies (npm ci)

run: npm ci --prefer-offline

- name: pip install system test requirements

run: |

python -m pip install --upgrade -r build/test-requirements.txt

python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt

python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy

shell: bash

- name: pip install ipython requirements

run: |

python -m pip install numpy

python -m pip install --upgrade -r ./build/ipython-test-requirements.txt

- name: pip install jupyter

run: |

python -m pip install --upgrade jupyter

# Save time by reusing bits from the VSIX.

- name: Download VSIX

uses: actions/download-artifact@v2

with:

name: ${{env.ARTIFACT_NAME_VSIX}}

# Compile the test files.

- name: Prepare for smoke tests

run: npx tsc -p ./

shell: bash

- name: Set CI_PYTHON_PATH and CI_DISABLE_AUTO_SELECTION

run: |

echo "::set-env name=CI_PYTHON_PATH::python"

echo "::set-env name=CI_DISABLE_AUTO_SELECTION::1"

shell: bash

- name: Run smoke tests

env:

DISPLAY: 10

uses: GabrielBB/xvfb-action@v1.4

with:

run: node --no-force-async-hooks-checks ./out/test/smokeTest.js

coverage:

name: Coverage reports upload

runs-on: ubuntu-latest

if: github.repository == 'microsoft/vscode-python'

needs: [tests, smoke-tests]

steps:

- name: Checkout

uses: actions/checkout@v2

- name: Cache npm files

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{runner.os}}-${{env.CACHE_NPM_DEPS}}-${{hashFiles('package-lock.json')}}

- name: Install dependencies (npm ci)

run: npm ci --prefer-offline

# It isn't possible to specify a regex for artifact names, so we have to download each artifact manually.

# The name pattern is ${{runner.os}}-${{env.COVERAGE_REPORTS}}, and possible values for runner.os are `Linux`, `Windows`, or `macOS`.

# See https://help.github.com/en/actions/reference/contexts-and-expression-syntax-for-github-actions#runner-context

- name: Download Ubuntu test coverage artifacts

uses: actions/download-artifact@v1

with:

name: Linux-${{env.COVERAGE_REPORTS}}

- name: Extract Ubuntu coverage artifacts to ./nyc_output

run: |

mkdir .nyc_output

mv Linux-${{env.COVERAGE_REPORTS}}/* .nyc_output

rm -r Linux-${{env.COVERAGE_REPORTS}}

- name: Generate coverage reports

run: npm run test:cover:report

continue-on-error: true

- name: Upload coverage to codecov

uses: codecov/codecov-action@v1

with:

token: ${{ secrets.CODECOV_TOKEN }}

file: ./coverage/cobertura-coverage.xml

upload:

name: Upload VSIX to Azure Blob Storage

runs-on: ubuntu-latest

if: github.repository == 'microsoft/vscode-python'

needs: [tests, smoke-tests, build-vsix]

env:

BLOB_CONTAINER_NAME: extension-builds

BLOB_NAME: ms-python-gha-insiders.vsix # So named to avoid clobbering Azure Pipelines upload.

steps:

- name: Download VSIX

uses: actions/download-artifact@v2

with:

name: ${{ env.ARTIFACT_NAME_VSIX }}

- name: Azure Login

uses: azure/login@v1

with:

creds: ${{ secrets.AZURE_CREDENTIALS }}

- name: Upload to Blob Storage

run: az storage blob upload --file ${{ env.VSIX_NAME }} --account-name pvsc --container-name ${{ env.BLOB_CONTAINER_NAME }} --name ${{ env.BLOB_NAME }} --auth-mode login

- name: Get URL to uploaded VSIX

run: az storage blob url --account-name pvsc --container-name ${{ env.BLOB_CONTAINER_NAME }} --name ${{ env.BLOB_NAME }} --auth-mode login