More tweeks to GitHub actions for faster CI (#38)

Author: DonJayamanne

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,4 +14,3 @@ For #
 -   [ ] Unit tests & system/integration tests are added/updated.
 -   [ ] [Test plan](https://github.com/Microsoft/vscode-jupyter/blob/main/.github/test_plan.md) is updated as appropriate.
 -   [ ] [`package-lock.json`](https://github.com/Microsoft/vscode-jupyter/blob/main/package-lock.json) has been regenerated by running `npm install` (if dependencies have changed).
--   [ ] The wiki is updated with any design decisions/details.

.github/workflows/insiders.yml

@@ -6,7 +6,7 @@ on:
       - main
   pull_request:
     branches:
-     - main
+      - main
   check_run:
     types: [rerequested, requested_action]
 
@@ -121,9 +121,59 @@ jobs:
       - name: Check dependencies
         run: npm run checkDependencies
 
+
+  ### Non-smoke tests
+  ts_tests:
+    name: Type Script 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-jupyter'
+    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]
+        test-suite: [ts-unit]
+    env:
+      NODE_VERSION: 12.15.0
+    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: 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: Use Node ${{env.NODE_VERSION}}
+        uses: actions/[email protected]
+        with:
+          node-version: ${{env.NODE_VERSION}}
+
+      # Run TypeScript unit tests only for Python 3.X.
+      - name: Run TypeScript unit tests
+        run: npm run test:unittests:cover
+
   ### Non-smoke tests
   tests:
-    name: Tests
+    name: Tests (with Python)
     # 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-jupyter'
@@ -135,7 +185,8 @@ jobs:
         os: [ubuntu-latest, windows-latest]
         # Run the tests on the oldest and most recent versions of Python.
         python: [2.7, 3.8]
-        test-suite: [ts-unit, python-unit, single-workspace, functional]
+        # test-suite: [python-unit, single-workspace, functional]
+        test-suite: [functional]
     env:
       # Something in Node 12.16.0 breaks the TS debug adapter, and ubuntu-latest bundles Node 12.16.1.
       # We can remove this when we switch over to the python-based DA in https://github.com/microsoft/vscode-jupyter/issues/7136.
@@ -183,11 +234,6 @@ jobs:
         with:
           node-version: ${{env.NODE_VERSION}}
 
-      # 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.)
-
     #   - name: pip install ipython requirements
     #     run: |
     #       python -m pip install numpy

.github/workflows/release.yml

@@ -298,14 +298,6 @@ jobs:
           run: npm run testSingleWorkspace
         if: matrix.test-suite == 'single-workspace'
 
-      - name: Run debugger tests
-        env:
-          CI_PYTHON_VERSION: ${{matrix.python}}
-        uses: GabrielBB/[email protected]
-        with:
-          run: npm run testDebugger
-        if: matrix.test-suite == 'debugger'
-
       - name: Run functional tests
         run: npm run test:functional
         if: matrix.test-suite == 'functional'

build/ci/templates/test_phases.yml

@@ -98,8 +98,8 @@ steps:
   # > python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
   - bash: |
       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
+    #   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
     displayName: 'pip install system test requirements'
     condition: and(succeeded(), eq(variables['NeedsPythonTestReqs'], 'true'))
 
@@ -203,13 +203,6 @@ steps:
     displayName: 'pip install jupyter'
     condition: and(succeeded(), eq(variables['NeedsIPythonReqs'], 'true'), contains(variables['TestsToRun'], 'testSmoke'))
 
-  - bash: |
-      python -m pip --disable-pip-version-check install -r build/debugger-install-requirements.txt
-      python ./pythonFiles/install_debugpy.py
-    failOnStderr: true
-    displayName: 'Install DEBUGPY wheels'
-    condition: and(eq(variables['NeedsPythonTestReqs'], 'true'), eq(variables['PythonVersion'], '3.7'))
-
     # Run the Python IPython tests in our codebase. Produces a JUnit-style log file that
   # will be uploaded after all tests are complete.
   #
@@ -258,95 +251,6 @@ steps:
       buildPlatform: '$(Agent.Os)-Py$(pythonVersion)'
       buildConfiguration: 'UnitTests'
 
-  # Venv tests: Prepare the various virtual environments and record their details into the
-  # JSON file that venvTests require to run.
-  #
-  # This task only runs if the string 'venvTests' exists in variable 'TestsToRun'
-  #
-  # This task has a bunch of steps, all of which are to fill the `EnvPath` struct found in
-  # the file:
-  # `src/test/common/terminals/environmentActionProviders/terminalActivation.testvirtualenvs.ts`
-  #
-  # Example command line (windows pwsh):
-  # // This is done in powershell. Copy/paste the code below.
-  - pwsh: |
-      # venv/bin or venv\\Scripts (windows)?
-      $environmentExecutableFolder = 'bin'
-      if ($Env:AGENT_OS -match '.*Windows.*') {
-        $environmentExecutableFolder = 'Scripts'
-      }
-
-      # pipenv
-      python -m pip install pipenv
-      python -m pipenv run python build/ci/addEnvPath.py $(PYTHON_VIRTUAL_ENVS_LOCATION) pipenvPath
-
-      # venv
-      # what happens when running under Python 2.7?
-      python -m venv .venv
-      & ".venv/$environmentExecutableFolder/python" ./build/ci/addEnvPath.py $(PYTHON_VIRTUAL_ENVS_LOCATION) venvPath
-
-      # virtualenv
-      python -m pip install virtualenv
-      python -m virtualenv .virtualenv
-      & ".virtualenv/$environmentExecutableFolder/python" ./build/ci/addEnvPath.py $(PYTHON_VIRTUAL_ENVS_LOCATION) virtualEnvPath
-
-      # conda
-
-      # 1. For `terminalActivation.testvirtualenvs.test.ts`
-
-      $condaExecPath = Join-Path -Path $Env:CONDA -ChildPath $environmentExecutableFolder | Join-Path -ChildPath conda
-      if( '$(Agent.Os)' -match '.*Windows.*' ){
-          $condaPythonPath = Join-Path -Path $Env:CONDA -ChildPath python
-      } else{
-          $condaPythonPath = Join-Path -Path $Env:CONDA -ChildPath $environmentExecutableFolder | Join-Path -ChildPath python
-          & $condaPythonPath ./build/ci/addEnvPath.py $(PYTHON_VIRTUAL_ENVS_LOCATION) condaExecPath $condaExecPath
-      }
-      & $condaPythonPath ./build/ci/addEnvPath.py $(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 "$Env:HOME/test_env3" -y python
-
-      # Set the TEST_FILES_SUFFIX
-      Write-Host '##vso[task.setvariable variable=TEST_FILES_SUFFIX;]testvirtualenvs'
-
-    displayName: 'Prepare Venv-Test Environment'
-    condition: and(succeeded(), contains(variables['TestsToRun'], 'venvTests'))
-
-  # Run the virtual environment based tests.
-  # This set of tests is simply using the `testSingleWorkspace` set of tests, but
-  # with the environment variable `TEST_FILES_SUFFIX` set to `testvirtualenvs`, which
-  # got set in the Prepare Venv-Test Environment task above.
-  # **Note**: Azure DevOps tasks set environment variables via a specially formatted
-  # string sent to stdout.
-  #
-  # This task only runs if the string 'venvTests' exists in variable 'TestsToRun'
-  #
-  # Example command line (windows pwsh):
-  # > $Env:TEST_FILES_SUFFIX=testvirtualenvs
-  # > npm run testSingleWorkspace
-  - script: |
-      cat $PYTHON_VIRTUAL_ENVS_LOCATION
-
-      npm run testSingleWorkspace
-
-    displayName: 'Run Venv-Tests'
-    condition: and(succeeded(), contains(variables['TestsToRun'], 'venvTests'))
-    env:
-      DISPLAY: :10
-
-  # Upload the test results to Azure DevOps to facilitate test reporting in their UX.
-  - task: PublishTestResults@2
-    displayName: 'Publish Venv-Tests results'
-    condition: contains(variables['TestsToRun'], 'venvTests')
-    inputs:
-      testResultsFiles: '$(MOCHA_FILE)'
-      testRunTitle: 'venvTest-$(Agent.Os)-Py$(pythonVersion)'
-      buildPlatform: '$(Agent.Os)-Py$(pythonVersion)'
-      buildConfiguration: 'SystemTests'
-
   # Set the CI_PYTHON_PATH variable that forces VS Code system tests to use
   # the specified Python interpreter.
   #
@@ -434,29 +338,6 @@ steps:
       buildPlatform: '$(Agent.Os)-Py$(pythonVersion)'
       buildConfiguration: 'SystemTests'
 
-  # Run the debugger integration tests.
-  #
-  # This task only runs if the string 'testDebugger' exists in variable `TestsToRun`.
-  #
-  # Example command line (windows pwsh):
-  # > npm run testDebugger
-  - script: |
-      npm run testDebugger
-    displayName: 'Run debugger tests'
-    condition: and(succeeded(), contains(variables['TestsToRun'], 'testDebugger'))
-    env:
-      DISPLAY: :10
-
-  # Upload the test results to Azure DevOps to facilitate test reporting in their UX.
-  - task: PublishTestResults@2
-    displayName: 'Publish debugger tests results'
-    condition: contains(variables['TestsToRun'], 'testDebugger')
-    inputs:
-      testResultsFiles: '$(MOCHA_FILE)'
-      testRunTitle: 'debugger-$(Agent.Os)-Py$(pythonVersion)'
-      buildPlatform: '$(Agent.Os)-Py$(pythonVersion)'
-      buildConfiguration: 'SystemTests'
-
   # Run the performance tests.
   #
   # This task only runs if the string 'testPerformance' exists in variable `TestsToRun`.

build/ci/vscode-python-ci-manual.yaml

@@ -44,9 +44,6 @@ stages:
               # focused on integration
               TestsToRun: 'testSingleWorkspace'
               NeedsPythonTestReqs: true
-            'Debugger':
-              TestsToRun: 'testDebugger'
-              NeedsPythonTestReqs: true
             'Smoke':
               TestsToRun: 'testSmoke'
               NeedsPythonTestReqs: true
@@ -105,10 +102,6 @@ stages:
               PythonVersion: '3.5'
               TestsToRun: 'testSingleWorkspace'
               NeedsPythonTestReqs: true
-            'Debugger':
-              PythonVersion: '3.5'
-              TestsToRun: 'testDebugger'
-              NeedsPythonTestReqs: true
           #maxParallel: 3
         pool:
           vmImage: 'ubuntu-16.04'

build/ci/vscode-python-ci.yaml

@@ -52,9 +52,6 @@ stages:
               # focused on integration
               TestsToRun: 'testSingleWorkspace'
               NeedsPythonTestReqs: true
-            'Debugger':
-              TestsToRun: 'testDebugger'
-              NeedsPythonTestReqs: true
             # 'Smoke':
             #   TestsToRun: 'testSmoke'
             #   NeedsPythonTestReqs: true

build/ci/vscode-python-pr-validation.yaml

@@ -51,13 +51,10 @@ stages:
               NeedsPythonTestReqs: true
               NeedsPythonFunctionalReqs: true
               SplitFunctionalTests: false
-            # 'Single Workspace':
-            #   TestsToRun: 'testSingleWorkspace'
+            # 'DataScience':
+            #   TestsToRun: 'testDataScience'
             #   NeedsPythonTestReqs: true
-            'DataScience':
-              TestsToRun: 'testDataScience'
-              NeedsPythonTestReqs: true
-              NeedsPythonFunctionalReqs: true
+            #   NeedsPythonFunctionalReqs: true
             # 'Smoke':
             #   TestsToRun: 'testSmoke'
             #   NeedsPythonTestReqs: true
@@ -119,11 +116,11 @@ stages:
 #         steps:
 #           - template: templates/test_phases.yml
 
-  - stage: Reports
-    dependsOn:
-      - Linux
-    #   - Mac
-    #   - Windows
-    condition: always()
-    jobs:
-      - template: templates/jobs/coverage.yml
+#   - stage: Reports
+#     dependsOn:
+#       - Linux
+#     #   - Mac
+#     #   - Windows
+#     condition: always()
+#     jobs:
+#       - template: templates/jobs/coverage.yml

package.json

@@ -2986,7 +2986,6 @@
         "test:functional:cover": "npm run test:functional",
         "test:functional:split": "node ./build/ci/scripts/runFunctionalTests.js",
         "test:cover:report": "nyc --nycrc-path build/.nycrc  report --reporter=text --reporter=html --reporter=text-summary --reporter=cobertura",
-        "testDebugger": "node ./out/test/testBootstrap.js ./out/test/debuggerTest.js",
         "testSingleWorkspace": "node ./out/test/testBootstrap.js ./out/test/standardTest.js",
         "preTestJediLSP": "node ./out/test/languageServers/jedi/lspSetup.js",
         "testJediLSP": "node ./out/test/languageServers/jedi/lspSetup.js && cross-env CODE_TESTS_WORKSPACE=src/test VSC_PYTHON_CI_TEST_GREP='Language Server:' node ./out/test/testBootstrap.js ./out/test/standardTest.js && node ./out/test/languageServers/jedi/lspTeardown.js",