Switch to GitHub action for testing (jupyterlab#738)

fcollonval · web-flow · commit a046b66415c6 · 2020-08-23T22:13:42.000+02:00
* Switch to GitHub action for testing

* Install python before using pip

* Add python version in pip cache key

* Correct unit test

* Correct format error

* Slight improvements to CI script
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,91 @@
+name: Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: "*"
+
+jobs:
+  test-3x:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.5', '3.6', '3.7', '3.8']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: 'x64'
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+      
+      - name: pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.python-version }}-
+            ${{ runner.os }}-pip-
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Setup yarn cache
+        uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        env:
+          # Increase this value to reset cache
+          CACHE_NUMBER: 0
+        with:
+          path: |
+            ${{ steps.yarn-cache-dir-path.outputs.dir }}
+            **/node_modules
+          key: ${{ runner.os }}-yarn-${{ env.CACHE_NUMBER }}-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-${{ env.CACHE_NUMBER }}
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: |
+          pip install wheel
+          pip install --upgrade --upgrade-strategy=eager pytest pytest-asyncio "jupyterlab~=2.0"
+
+      - name: Test the extension
+        run: |
+          # Build the sdist (identical to what will be uploaded to eg pypi on release)
+          python setup.py sdist
+          # Linter checks
+          jlpm run eslint-check
+        
+          # Install the extension from the sdist ensuring the cache is unused
+          pip install jupyterlab_git[test] --pre --no-index --find-links=dist --no-deps --no-cache-dir -v
+          # Install the extension dependencies based on the current setup.py
+          pip install jupyterlab_git[test]
+        
+          # Run the Python tests
+          pytest jupyterlab_git -r ap
+          # Run the TS/JS tests
+          jlpm run test
+        
+          # Log the current state of jupyterlab's extensions
+          jupyter labextension list
+          # Rebuild jupyterlab to include our extension
+          jupyter lab build
+          # Run the standard jupyterlab browser integration test
+          jupyter serverextension list 1>serverextensions 2>&1
+          cat serverextensions | grep "jupyterlab_git.*OK"
+          jupyter labextension list 1>labextensions 2>&1
+          cat labextensions | grep "@jupyterlab/git.*OK"
+          python -m jupyterlab.browser_check
+          # Run our extension-specific browser integration test
+          python tests/test-browser/run_browser_test.py
diff --git a/.gitignore b/.gitignore
@@ -123,3 +123,4 @@ node_modules/
 # vim stuff
 *.swp
 .devcontainer/
+src/version.ts
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # jupyterlab-git
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-git/master?urlpath=lab/tree/examples/demo.ipynb) [![Build Status](https://travis-ci.org/jupyterlab/jupyterlab-git.svg?branch=master)](https://travis-ci.org/jupyterlab/jupyterlab-git) [![Version](https://img.shields.io/npm/v/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/pypi/v/jupyterlab-git.svg)](https://pypi.org/project/jupyterlab-git/) [![Downloads](https://img.shields.io/npm/dm/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git) [![Downloads](https://img.shields.io/conda/dn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-git/master?urlpath=lab/tree/examples/demo.ipynb) [![Github Actions Status](https://github.com/jupyterlab/jupyterlab-git/workflows/Test/badge.svg)](https://github.com/jupyterlab/jupyterlab-git/actions?query=workflow%3ATest) [![Version](https://img.shields.io/npm/v/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/pypi/v/jupyterlab-git.svg)](https://pypi.org/project/jupyterlab-git/) [![Downloads](https://img.shields.io/npm/dm/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git) [![Downloads](https://img.shields.io/conda/dn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
diff --git a/package.json b/package.json
@@ -81,28 +81,28 @@
     "@jupyterlab/testutils": "^2.0.0",
     "@types/codemirror": "^0.0.79",
     "@types/diff-match-patch": "^1.0.32",
-    "@types/enzyme": "3.1.15",
+    "@types/enzyme": "^3.1.15",
     "@types/jest": "^24",
     "@types/react": "~16.8.13",
     "@types/react-dom": "~16.0.5",
     "@types/react-textarea-autosize": "^4.3.5",
     "@typescript-eslint/eslint-plugin": "^2.25.0",
     "@typescript-eslint/parser": "^2.25.0",
-    "all-contributors-cli": "6.14.0",
-    "enzyme": "3.7.0",
-    "enzyme-adapter-react-16": "1.7.0",
+    "all-contributors-cli": "^6.14.0",
+    "enzyme": "^3.7.0",
+    "enzyme-adapter-react-16": "^1.7.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.1",
     "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-react": "^7.19.0",
     "genversion": "^2.2.1",
-    "husky": "1.3.1",
+    "husky": "^1.3.1",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^24",
     "jest-fetch-mock": "^1.6.6",
-    "lint-staged": "8.1.5",
+    "lint-staged": "^8.1.5",
     "mkdirp": "^1.0.3",
-    "prettier": "1.16.4",
+    "prettier": "^1.16.4",
     "puppeteer": "^1.10.0",
     "rimraf": "^2.6.1",
     "ts-jest": "^24",
diff --git a/src/components/GitPanel.tsx b/src/components/GitPanel.tsx
@@ -171,9 +171,9 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
   refreshHistory = async () => {
     if (this.props.model.pathRepository !== null) {
       // Get git log for current branch
-      const logData = await this.props.model.log(this.props.settings.composite[
-        'historyCount'
-      ] as number);
+      const logData = await this.props.model.log(
+        this.props.settings.composite['historyCount'] as number
+      );
       let pastCommits = new Array<Git.ISingleCommitInfo>();
       if (logData.code === 0) {
         pastCommits = logData.commits;
diff --git a/src/components/SinglePastCommitInfo.tsx b/src/components/SinglePastCommitInfo.tsx
@@ -135,9 +135,7 @@ export class SinglePastCommitInfo extends React.Component<
       log = await this.props.model.detailedLog(this.props.commit.commit);
     } catch (err) {
       console.error(
-        `Error while getting detailed log for commit ${
-          this.props.commit.commit
-        } and path ${this.props.model.pathRepository}`,
+        `Error while getting detailed log for commit ${this.props.commit.commit} and path ${this.props.model.pathRepository}`,
         err
       );
       this.setState({ loadingState: 'error' });
diff --git a/src/model.ts b/src/model.ts
@@ -465,10 +465,9 @@ export class GitExtension implements IGitExtension {
 
       if (response.ok) {
         if (body.checkout_branch) {
-          const files = (await this.changedFiles(
-            this._currentBranch.name,
-            body.branchname
-          ))['files'];
+          const files = (
+            await this.changedFiles(this._currentBranch.name, body.branchname)
+          )['files'];
           if (files) {
             files.forEach(file => this._revertFile(file));
           }
diff --git a/tests/test-components/NBDiff.spec.tsx b/tests/test-components/NBDiff.spec.tsx
@@ -22,8 +22,9 @@ describe('NBDiff', () => {
       }
     };
 
-    const jsonResult: Promise<any> = Promise.resolve({
-      message: 'TEST_ERROR_MESSAGE'
+    let resolveJson: (value?: any) => void;
+    const jsonResult = new Promise<any>(resolve => {
+      resolveJson = resolve;
     });
 
     (httpGitRequest as jest.Mock).mockReturnValue(
@@ -32,20 +33,29 @@ describe('NBDiff', () => {
 
     // When
     const node = shallow<NBDiff>(<NBDiff {...props} />);
+    resolveJson({
+      message: 'TEST_ERROR_MESSAGE'
+    });
 
     // Then
-    await jsonResult;
-    node.update();
-
-    expect(httpGitRequest).toHaveBeenCalled();
-    expect(httpGitRequest).toBeCalledWith('/nbdime/api/gitdiff', 'POST', {
-      file_path: 'top/repo/path/path/to/File.ipynb',
-      ref_remote: { special: 'WORKING' },
-      ref_local: { git: '83baee' }
+    let resolveTest: () => void;
+    const terminateTest = new Promise(resolve => {resolveTest = resolve});
+    setImmediate(() => {
+      expect(httpGitRequest).toHaveBeenCalled();
+      expect(httpGitRequest).toBeCalledWith('/nbdime/api/gitdiff', 'POST', {
+        file_path: 'top/repo/path/path/to/File.ipynb',
+        ref_remote: { special: 'WORKING' },
+        ref_local: { git: '83baee' }
+      });
+      expect(
+        node
+          .update()
+          .find('.jp-git-diff-error')
+          .text()
+      ).toContain('TEST_ERROR_MESSAGE');
+      resolveTest();
     });
-    expect(node.find('.jp-git-diff-error').text()).toContain(
-      'TEST_ERROR_MESSAGE'
-    );
+    await terminateTest;
   });
 
   it('should render header and cell diff components in success case', async () => {
@@ -59,27 +69,35 @@ describe('NBDiff', () => {
       }
     };
 
-    const jsonResult: Promise<any> = Promise.resolve(diffResponse);
+    let resolveJson: (value?: any) => void;
+    const jsonResult: Promise<any> = new Promise<any>(resolve => {
+      resolveJson = resolve;
+    });
 
     (httpGitRequest as jest.Mock).mockReturnValue(
       createTestResponse(200, jsonResult)
     );
 
     // When
     const node = shallow<NBDiff>(<NBDiff {...props} />);
+    resolveJson(diffResponse);
 
     // Then
-    await jsonResult;
-    node.update();
-
-    expect(httpGitRequest).toHaveBeenCalled();
-    expect(httpGitRequest).toBeCalledWith('/nbdime/api/gitdiff', 'POST', {
-      file_path: 'top/repo/path/path/to/File.ipynb',
-      ref_remote: { special: 'WORKING' },
-      ref_local: { git: '83baee' }
+    let resolveTest: () => void;
+    const terminateTest = new Promise(resolve => {resolveTest = resolve});
+    setImmediate(() => {
+      expect(httpGitRequest).toHaveBeenCalled();
+      expect(httpGitRequest).toBeCalledWith('/nbdime/api/gitdiff', 'POST', {
+        file_path: 'top/repo/path/path/to/File.ipynb',
+        ref_remote: { special: 'WORKING' },
+        ref_local: { git: '83baee' }
+      });
+      node.update();
+      expect(node.find('.jp-git-diff-error')).toHaveLength(0);
+      expect(node.find(NBDiffHeader)).toHaveLength(1);
+      expect(node.find(CellDiff)).toHaveLength(3);
+      resolveTest();
     });
-    expect(node.find('.jp-git-diff-error')).toHaveLength(0);
-    expect(node.find(NBDiffHeader)).toHaveLength(1);
-    expect(node.find(CellDiff)).toHaveLength(3);
+    await terminateTest;
   });
 });
diff --git a/tests/test-components/PlainTextDiff.spec.tsx b/tests/test-components/PlainTextDiff.spec.tsx
diff --git a/yarn.lock b/yarn.lock
