Fix code coverage upload (#14821)

* Run subset of tests (enough for code coverage)
* Checking Linux-${{env.COVERAGE_REPORTS}}
* Force coverage step checkout path same as tests
* codecov fix paths
* Download reports to special-working-directory
* Move codecov to root
* wrong env var syntax
* Ok move the file to the actual root
* no path fixing, yolo
* Re-add path fixing
* Undo testing changes
* Fix copy-paste errors
* Upload code coverage in the insiders build
* Try uploading as part of insiders
* Delete env vars (moved up)
* Add checkout comment in the coverage step
* Revert "Try uploading as part of insiders"
This reverts commit f3ffbe6.
* Forgot a copy-paste
* Upload coverage report for forks as wel
Co-authored-by: Brett Cannon <[email protected]>

Co-authored-by: Brett Cannon <[email protected]>

Author: kimadeline

.github/codecov.yml

@@ -29,3 +29,6 @@ comment:
   layout: 'diff, files'
   behavior: default
   require_changes: no
+
+fixes:
+  - "path with spaces/::"

.github/workflows/insiders.yml

@@ -15,6 +15,10 @@ env:
   VSIX_NAME: ms-python-insiders.vsix
   COVERAGE_REPORTS: tests-coverage-reports
   TEST_RESULTS_DIRECTORY: .
+  # Force a path with spaces and to test extension works in these scenarios
+  # Unicode characters are causing 2.7 failures so skip that for now.
+  special-working-directory: './path with spaces'
+  special-working-directory-relative: 'path with spaces'
 
 jobs:
   build-vsix:
@@ -105,10 +109,6 @@ jobs:
       # See https://github.com/microsoft/ptvsd/issues/2068
       # At this point pinning is only needed for consistency. We no longer have TS debug adapter.
       NODE_VERSION: 12.15.0
-      # Force a path with spaces and to test extension works in these scenarios
-      # Unicode characters are causing 2.7 failures so skip that for now.
-      special-working-directory: './path with spaces'
-      special-working-directory-relative: 'path with spaces'
     defaults:
       run:
         working-directory: ${{env.special-working-directory}}
@@ -454,9 +454,16 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository == 'microsoft/vscode-python'
     needs: [tests, smoke-tests]
+    defaults:
+      run:
+        working-directory: ${{env.special-working-directory}}
     steps:
+      # Checkout the repo in the same way as how the tests are run, 
+      # or nyc won't know how to reconcile the reports generated by the tests.
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          path: ${{env.special-working-directory-relative}}
 
       - name: Use Node ${{env.NODE_VERSION}}
         uses: actions/[email protected]
@@ -472,24 +479,31 @@ jobs:
       - name: Download Ubuntu test coverage artifacts
         uses: actions/download-artifact@v2
         with:
-          name: Linux-${{env.COVERAGE_REPORTS}}
-          path: Linux-${{env.COVERAGE_REPORTS}}
+          name: Linux-${{ env.COVERAGE_REPORTS }}
+          path: ${{env.special-working-directory}}/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}}
+          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
 
+      # The only location supported by the codecov action is the workspace root.
+      # See https://github.com/codecov/codecov-action#arguments
+      - name: Move codecov.yml to root
+        run: |
+          mkdir $GITHUB_WORKSPACE/.github
+          mv .github/codecov.yml $GITHUB_WORKSPACE
+
       - name: Upload coverage to codecov
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./coverage/cobertura-coverage.xml
+          file: ${{env.special-working-directory}}/coverage/cobertura-coverage.xml
 
   upload:
     name: Upload VSIX to Azure Blob Storage

.github/workflows/pr-check.yml

@@ -17,6 +17,10 @@ env:
   VSIX_NAME: ms-python-insiders.vsix
   COVERAGE_REPORTS: tests-coverage-reports
   TEST_RESULTS_DIRECTORY: .
+  # Force a path with spaces and to test extension works in these scenarios
+  # Unicode characters are causing 2.7 failures so skip that for now.
+  special-working-directory: './path with spaces'
+  special-working-directory-relative: 'path with spaces'
 
 jobs:
   build-vsix:
@@ -105,10 +109,6 @@ jobs:
       # See https://github.com/microsoft/ptvsd/issues/2068
       # At this point pinning is only needed for consistency. We no longer have TS debug adapter.
       NODE_VERSION: 12.15.0
-      # Force a path with spaces and to test extension works in these scenarios
-      # Unicode characters are causing 2.7 failures so skip that for now.
-      special-working-directory: './path with spaces'
-      special-working-directory-relative: 'path with spaces'
     defaults:
       run:
         working-directory: ${{env.special-working-directory}}
@@ -452,13 +452,18 @@ jobs:
 
   coverage:
     name: Coverage reports upload
-    # Don't' assume external contributors want to upload the coverage report.
-    if: github.repository == 'microsoft/vscode-python'
     runs-on: ubuntu-latest
     needs: [tests, smoke-tests]
+    defaults:
+      run:
+        working-directory: ${{env.special-working-directory}}
     steps:
+      # Checkout the repo in the same way as how the tests are run, 
+      # or nyc won't know how to reconcile the reports generated by the tests.
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          path: ${{env.special-working-directory-relative}}
 
       - name: Use Node ${{env.NODE_VERSION}}
         uses: actions/[email protected]
@@ -475,7 +480,7 @@ jobs:
         uses: actions/download-artifact@v2
         with:
           name: Linux-${{ env.COVERAGE_REPORTS }}
-          path: Linux-${{ env.COVERAGE_REPORTS }}
+          path: ${{env.special-working-directory}}/Linux-${{ env.COVERAGE_REPORTS }}
 
       - name: Extract Ubuntu coverage artifacts to ./nyc_output
         run: |
@@ -487,9 +492,16 @@ jobs:
         run: npm run test:cover:report
         continue-on-error: true
 
+      # The only location supported by the codecov action is the workspace root.
+      # See https://github.com/codecov/codecov-action#arguments
+      - name: Move codecov.yml to root
+        run: |
+          mkdir $GITHUB_WORKSPACE/.github
+          mv .github/codecov.yml $GITHUB_WORKSPACE
+
       - name: Upload coverage to codecov
         uses: codecov/codecov-action@v1
         with:
           # Can't use the token to disambiguate since secrets aren't available from PR-triggered runs.
           #token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./coverage/cobertura-coverage.xml
+          file: ${{env.special-working-directory}}/coverage/cobertura-coverage.xml