Merge remote-tracking branch 'origin/master' into ds/custom_editor

Author: rchiodo

.env

@@ -14,7 +14,9 @@ env:
   # 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
+  COVERAGE_REPORTS: tests-coverage-reports
   TEST_RESULTS_DIRECTORY: .
+  LKG_TAG: ci-lkg
 
 jobs:
   ### Initialization: retrieve, install and cache dependencies
@@ -161,6 +163,12 @@ jobs:
       - name: Clean directory
         run: npm run clean
 
+      # Use the GITHUB_RUN_ID environment variable to update the build number.
+      # GITHUB_RUN_ID is a unique number for each run within a repository.
+      # This number does not change if you re-run the workflow run.
+      - name: Update build number
+        run: npm run updateBuildNumber -- --buildNumber $GITHUB_RUN_ID
+
       - name: Package the VSIX
         run: npm run package
 
@@ -180,7 +188,7 @@ jobs:
       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]
+        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, venv, single-workspace, multi-workspace, debugger, functional]
@@ -305,12 +313,19 @@ jobs:
         run: npm run test:unittests:cover
         if: matrix.test-suite == 'ts-unit' && startsWith(matrix.python, 3.)
 
-      # Run the Python IPython tests in our codebase.
-      # Produce JUnit-style log files that will be uploaded after all tests are complete.
+      # 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 --junit-xml=${{env.TEST_RESULTS_DIRECTORY}}/python-tests-junit.xml
-          python -m IPython pythonFiles/tests/run_all.py -- --junit-xml=${{env.TEST_RESULTS_DIRECTORY}}/ipython-tests-junit.xml
+          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
@@ -346,3 +361,117 @@ jobs:
       - name: Run functional tests
         run: npm run test:functional
         if: matrix.test-suite == 'functional'
+
+  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 }}
+    needs: [build-vsix]
+    if: github.repository == 'microsoft/vscode-python'
+    strategy:
+      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:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Retrieve cached npm files
+        uses: actions/cache@v1
+        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: Download VSIX
+        uses: actions/download-artifact@v1
+        with:
+          name: ${{env.ARTIFACT_NAME_VSIX}}
+
+      # Extract the artifact from its download folder (./${{env.ARTIFACT_NAME_VSIX}}) to the repo root,
+      # then delete the download folder and compile the source code.
+      - name: Prepare for smoke tests
+        run: |
+          mv ${{env.ARTIFACT_NAME_VSIX}}/* .
+          rm -r ${{env.ARTIFACT_NAME_VSIX}}
+          npx tsc -p ./
+        shell: bash
+
+      - name: Run smoke tests
+        env:
+          DISPLAY: 10
+        uses: GabrielBB/[email protected]
+        with:
+          run: node ./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: Retrieve cached npm files
+        uses: actions/cache@v1
+        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:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+          file: ./coverage/cobertura-coverage.xml
+
+  lkg-tag:
+    # LKG = last known good
+    name: Tag successful build as CI LKG
+    runs-on: ubuntu-latest
+    needs: [tests, smoke-tests]
+    if: github.repository == 'microsoft/vscode-python'
+    steps:
+      - name: Delete existing tag
+        run: |
+          curl -s -X DELETE https://api.github.com/repos/microsoft/vscode-python/git/refs/tags/${{env.LKG_TAG}} \
+          -H "Authorization: token ${{secrets.GITHUB_TOKEN}}"
+
+      # We only need to create a tag reference for lightweight tags.
+      # See https://developer.github.com/v3/git/tags/#create-a-tag-object
+      # And https://developer.github.com/v3/git/refs/#create-a-reference
+      - name: Create a tag reference
+        run: |
+          curl -s -X POST "https://api.github.com/repos/microsoft/vscode-python/git/refs" \
+          -H "Authorization: token ${{secrets.GITHUB_TOKEN}}"  \
+          -d @- << EOF
+          {
+            "ref": "refs/tags/${{env.LKG_TAG}}",
+            "sha": "${{github.sha}}"
+          }
+          EOF

.github/workflows/ci.yml

@@ -27,17 +27,13 @@ pythonFiles/lib/**
 debug_coverage*/**
 languageServer/**
 languageServer.*/**
-!uitests/features/languageServer/**
-!uitests/src/languageServer/**
-!uitests/code/**/languageServer/**
 bin/**
 obj/**
 .pytest_cache
 tmp/**
 .python-version
 .vs/
 test-results.xml
-uitests/out/**
 !build/
 debug*.log
 ptvsd*.log

.gitignore

@@ -265,23 +265,6 @@
             "skipFiles": [
                 "<node_internals>/**"
             ]
-        },
-        {
-            "name": "Behave Smoke Tests",
-            "type": "python",
-            "request": "launch",
-            "program": "${workspaceFolder}/uitests/__main__.py",
-            "args": [
-                "test",
-                "--",
-                "--format",
-                "progress3",
-                // Change the tag `@wip` to what ever you want to run.
-                // Default is assumed to be somethign that's a work in progress (wip).
-                "--tags=@wip"
-            ],
-            "justMyCode": false,
-            "console": "internalConsole"
         }
     ],
     "compounds": [

.vscode/launch.json

@@ -2,7 +2,6 @@
 {
     "files.exclude": {
         "out": true, // set this to true to hide the "out" folder with the compiled JS files
-        "uitests/out": true,
         "**/*.pyc": true,
         ".nyc_output": true,
         "obj": true,
@@ -16,7 +15,6 @@
     },
     "search.exclude": {
         "out": true, // set this to false to include "out" folder in search results
-        "uitests/out": true,
         "**/node_modules": true,
         "coverage": true,
         "languageServer*/**": true,
@@ -41,7 +39,7 @@
     "typescript.preferences.quoteStyle": "single",
     "javascript.preferences.quoteStyle": "single",
     "typescriptHero.imports.stringQuoteStyle": "'",
-    "prettier.printWidth": 180,
+    "prettier.printWidth": 120,
     "prettier.singleQuote": true,
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true,
@@ -54,7 +52,8 @@
     "python.linting.flake8Enabled": true,
     "cucumberautocomplete.skipDocStringsFormat": true,
     "python.linting.flake8Args": [
-        "--max-line-length=120"
+        // Match what black does.
+        "--max-line-length=88"
     ],
     "typescript.preferences.importModuleSpecifier": "relative"
 }

.vscode/settings.json

@@ -106,4 +106,3 @@ tmp/**
 tpn/**
 typings/**
 types/**
-uitests/**

.vscodeignore

@@ -1,6 +1,6 @@
-# Trouble shooting the Python Interactive Window
+# Troubleshooting Jupyter issues in the Python Interactive Window or Notebook Editor
 
-This document is intended to help troubleshoot problems in the Python Interactive Window.
+This document is intended to help troubleshoot problems with starting Jupyter in the Python Interactive Window or Notebook Editor.
 
 ---
 ## Jupyter Not Starting
@@ -10,12 +10,21 @@ This error can happen when
 * Jupyter is not installed
 * You picked the wrong Python environment (one that doesn't have Jupyter installed).
 
-### The first step is to verify you are running the Python environment you want.
+### The first step is to verify you are running the Python environment that you have Jupyter installed into.
 
-The Python you're using is picked with the selection dropdown on the bottom left of the VS Code window:
+The first time that you start the Interactive Window or the Notebook Editor VS Code will attempt to locate a Python environment that has Jupyter installed in it and can start a notebook. 
+
+The first Python interpreter to check will be the one selected with the selection dropdown on the bottom left of the VS Code window:
 
 ![selector](resources/PythonSelector.png)
 
+Once a suitable interpreter with Jupyter has been located, VS Code will continue to use that interpreter for starting up Jupyter servers.
+If no interpreters are found with Jupyter installed a popup message will ask if you would like to install Jupyter into the current interpreter.
+
+![install Jupyter](resources/InstallJupyter.png)
+
+If you would like to change from using the saved Python interpreter to a new interpreter for launching Jupyter just use the "Python: Select interpreter to start Jupyter server" VS Code command to change it.
+
 ### The second step is to check that jupyter isn't giving any errors on startup.
 
 Run the following command from an environment that matches the Python you selected: