Run VSCode extension's tests on top of che-theia #864
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| #!/bin/bash | ||
| # shellcheck disable=SC2016 | ||
| # | ||
| # Copyright (c) 2012-2021 Red Hat, Inc. | ||
| # This program and the accompanying materials are made | ||
| # available under the terms of the Eclipse Public License 2.0 | ||
| # which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| # | ||
| # SPDX-License-Identifier: EPL-2.0 | ||
| # | ||
| # Contributors: | ||
| # Red Hat, Inc. - initial API and implementation | ||
|
|
||
| set -e | ||
|
|
||
| sudo pip install yq | ||
|
|
||
| CHANGED_LINES=$(git diff -U0 HEAD "$(git merge-base HEAD origin/master)" che-theia-plugins.yaml | grep @@ | cut -d ' ' -f 3 | sed 's/+//') | ||
| echo "$CHANGED_LINES" | ||
| for number in $CHANGED_LINES | ||
| do | ||
| LINE=$(sed "$number!d" che-theia-plugins.yaml | xargs) | ||
| if [[ $LINE == *"revision:"* ]]; then | ||
| break | ||
| fi | ||
| exit 0 | ||
| done | ||
| EXTENSION_REVISION=$(echo "$LINE" | cut -d ' ' -f 2) | ||
| EXTENSION_REPO=$(yq -r --arg EXTENSION_REVISION "$EXTENSION_REVISION" '[.plugins[] | select(.repository.revision == $EXTENSION_REVISION )] | .[0] | .repository.url' che-theia-plugins.yaml) | ||
|
|
||
| if [[ $EXTENSION_REPO == null ]]; then | ||
| EXTENSION_REPO='' | ||
| fi | ||
|
|
||
| echo "Extension revision: $EXTENSION_REVISION" | ||
| echo "Extension repository: $EXTENSION_REPO" | ||
|
|
||
| echo "::set-env name=EXTENSION_REVISION::$EXTENSION_REVISION" | ||
| echo "::set-env name=EXTENSION_REPO::$EXTENSION_REPO" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| #!/bin/bash | ||
| # shellcheck disable=SC2016 | ||
| # | ||
| # Copyright (c) 2012-2021 Red Hat, Inc. | ||
| # This program and the accompanying materials are made | ||
| # available under the terms of the Eclipse Public License 2.0 | ||
| # which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| # | ||
| # SPDX-License-Identifier: EPL-2.0 | ||
| # | ||
| # Contributors: | ||
| # Red Hat, Inc. - initial API and implementation | ||
|
|
||
| set -e | ||
|
|
||
| function installDeps() { | ||
| sudo pip install selenium | ||
|
There was a problem hiding this comment. It might be better to create a user level virtual environment. |
||
| wget https://github.com/mozilla/geckodriver/releases/download/v0.29.0/geckodriver-v0.29.0-linux64.tar.gz | ||
|
There was a problem hiding this comment. Please create an variable for the geckodriver version, and use that variable in the URL. This makes it easier to read and update. |
||
| tar -xvzf geckodriver* | ||
| chmod +x geckodriver | ||
| sudo mv geckodriver /usr/local/bin/ | ||
| } | ||
|
|
||
| function cloneExtension() { | ||
| EXTENSION_PROJECT_NAME=$(basename "$EXTENSION_REPO") | ||
| export EXTENSION_PROJECT_NAME | ||
|
|
||
| mkdir -p /tmp/projects/"$EXTENSION_PROJECT_NAME" | ||
| git clone "${EXTENSION_REPO}" /tmp/projects/"$EXTENSION_PROJECT_NAME" | ||
| cd /tmp/projects/"$EXTENSION_PROJECT_NAME" | ||
| git checkout tags/"${EXTENSION_REVISION}" | ||
| git status | ||
| } | ||
|
|
||
| function prepareDevfile() { | ||
|
There was a problem hiding this comment. let's move all the logic of this file to a github action There was a problem hiding this comment. @benoitf do you mean to create more steps in the action and each step will execute some part of this script? There was a problem hiding this comment. I was not clear enough today you're using that script by doing: but if you turn it to a github action, then we could just invoke it by calling (so plug-in registry is only a client of the action hosted elsewhere) There was a problem hiding this comment. and with github actions it's easy to get unit tests / code coverage / etc. |
||
| # Get Extension's ID | ||
| EXTENSION_ID=$(yq -r --arg EXTENSION_REPO "$EXTENSION_REPO" '[.plugins[] | select(.repository.url == $EXTENSION_REPO)] | .[1] | .id' "$GITHUB_WORKSPACE"/che-theia-plugins.yaml) | ||
| if [ "$EXTENSION_ID" == null ]; | ||
| then | ||
| # If ID wasn't set in che-theia-plugins.yaml let's parse package.json and build ID as publisher/name | ||
| PACKAGE_JSON=/tmp/projects/$EXTENSION_PROJECT_NAME/package.json | ||
| EXTENSION_NAME=$(jq -r '.name' "$PACKAGE_JSON") | ||
| EXTENSION_PUBLISHER=$(jq -r '.publisher' "$PACKAGE_JSON") | ||
| EXTENSION_ID=$EXTENSION_PUBLISHER/$EXTENSION_NAME | ||
| fi | ||
| EXTENSION_ID=$EXTENSION_ID/latest | ||
|
|
||
| # Add Extension's ID into devfile template | ||
| sed -i -e "s|@|$EXTENSION_ID|g" "$GITHUB_WORKSPACE"/.ci/templates/extension-tests-devfile.yaml | ||
| echo ----- Devfile ----- | ||
| cat "$GITHUB_WORKSPACE"/.ci/templates/extension-tests-devfile.yaml | ||
| } | ||
|
|
||
| function compileExtension() { | ||
| yarn install | ||
| yarn compile | ||
| } | ||
|
|
||
| function prepareWorkspace() { | ||
| chectl workspace:create --start --devfile=https://raw.githubusercontent.com/svor/che-vscode-extension-tests/main/devfile.yaml > workspace_url.txt | ||
| WORKSPACE_URL=$(tail -n 1 workspace_url.txt) | ||
| export WORKSPACE_URL | ||
| echo Workspace URL is "$WORKSPACE_URL" | ||
|
|
||
| pods=$(kubectl get pod -n admin-che -l che.workspace_id --field-selector=status.phase==Running 2>&1) | ||
| while [ "$pods" == 'No resources found in admin-che namespace.' ]; | ||
| do | ||
| chectl workspace:list | ||
| echo "Workspace is not ready" | ||
| kubectl get pod -n admin-che | ||
| sleep 10 | ||
| pods=$(kubectl get pod -n admin-che -l che.workspace_id --field-selector=status.phase==Running 2>&1) | ||
| done | ||
|
|
||
| kubectl get pods -n admin-che -l che.workspace_id | ||
|
|
||
| ### Find workspace name and theia-ide container | ||
| WORKSPACE_NAME=$(kubectl get pod -n admin-che -l che.workspace_id -o json | jq '.items[0].metadata.name' | tr -d \") | ||
| THEIA_IDE_CONTAINER_NAME=$(kubectl get pod -n admin-che -l che.workspace_id -o json | jq '.items[0].metadata.annotations[]' | grep -P "theia-ide" | tr -d \") | ||
|
|
||
| echo "Workspace name is: " | ||
| echo "$WORKSPACE_NAME" | ||
| echo "Theia IDE Container Name is: " | ||
| echo "$THEIA_IDE_CONTAINER_NAME" | ||
|
|
||
| ### Copy extension's sources into theia container | ||
| copySources | ||
|
|
||
| sleep 10 | ||
|
|
||
| # Start the python3 selenium script that will connect to the workspace to run tests | ||
| python3 "$GITHUB_WORKSPACE"/.ci/tests-runner.py "${WORKSPACE_URL}" | ||
| } | ||
|
|
||
| function copySources() { | ||
| echo "----- Copy Sources --------" | ||
| kubectl cp /tmp/projects/"$EXTENSION_PROJECT_NAME" admin-che/"${WORKSPACE_NAME}":/projects -c "$THEIA_IDE_CONTAINER_NAME" | ||
| echo "----- Sources were copied --------" | ||
| ### Check if copy | ||
| kubectl exec "${WORKSPACE_NAME}" -n admin-che -c "$THEIA_IDE_CONTAINER_NAME" -- ls -la /projects | ||
| } | ||
|
|
||
| function checkTestsLogs() { | ||
| kubectl cp admin-che/"${WORKSPACE_NAME}":/projects/test.log /tmp/test.log -c "${THEIA_IDE_CONTAINER_NAME}" | ||
| while ! grep -q "TESTS PASSED" /tmp/test.log && ! grep -q "TESTS FAILED" /tmp/test.log; | ||
| do | ||
| echo "Waiting for log file to be created and have TESTS FAILED or TESTS PASSED" | ||
| sleep 10 | ||
| kubectl cp admin-che/"${WORKSPACE_NAME}":/projects/test.log /tmp/test.log -c "${THEIA_IDE_CONTAINER_NAME}" | ||
| done | ||
|
|
||
| cat /tmp/test.log | ||
|
|
||
| # Test to see if the tests failed | ||
| if grep -q "TESTS FAILED" /tmp/test.log; | ||
| then | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| installDeps | ||
| cloneExtension | ||
| compileExtension | ||
| prepareDevfile | ||
| prepareWorkspace | ||
| checkTestsLogs | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| apiVersion: 1.0.0 | ||
| metadata: | ||
| name: extension-test-sample | ||
| components: | ||
| - mountSources: true | ||
| memoryLimit: 3Gi | ||
| type: dockerimage | ||
| image: 'quay.io/eclipse/che-theia-dev:next' | ||
| alias: che-dev | ||
| - type: chePlugin | ||
| reference: 'https://raw.githubusercontent.com/svor/che-vscode-extension-tests/main/meta.yaml' | ||
|
There was a problem hiding this comment. Is there a central place we can put this, i.e. not your fork? There was a problem hiding this comment. @ericwill I think we can move this extension into che-incubator, but when eclipse-che/che#19172 will be resolved. I'm still working on this extension. |
||
| - type: chePlugin | ||
| id: @ | ||
| - id: eclipse/che-theia/next | ||
| memoryLimit: 1024Mi | ||
| type: cheEditor | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # | ||
| # Copyright (c) 2021 Red Hat, Inc. | ||
| # This program and the accompanying materials are made | ||
| # available under the terms of the Eclipse Public License 2.0 | ||
| # which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| # | ||
| # SPDX-License-Identifier: EPL-2.0 | ||
| # | ||
|
|
||
| name: VSCode Extension's Tests | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - 'che-theia-plugins.yaml' | ||
| jobs: | ||
| test-extension: | ||
| runs-on: ubuntu-20.04 | ||
| env: | ||
| ACTIONS_ALLOW_UNSECURE_COMMANDS: true | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: ${{ github.event.pull_request.head.sha }} | ||
| - name: Get changes | ||
| run: | | ||
| ./.ci/get-changed-plugin.sh | ||
| - uses: actions/setup-node@v1 | ||
| if: env.EXTENSION_REPO != '' | ||
| with: | ||
| node-version: '12' | ||
| - name: Build image | ||
| if: env.EXTENSION_REPO != '' | ||
| run: | | ||
| export SKIP_FORMAT=true | ||
| export SKIP_LINT=true | ||
| export SKIP_TEST=true | ||
| docker pull quay.io/eclipse/che-plugin-registry:nightly | ||
| BUILDER=docker ./build.sh --tag vscode-extension | ||
| # save locally built image | ||
| docker save -o docker-image.tar quay.io/eclipse/che-plugin-registry:vscode-extension | ||
|
There was a problem hiding this comment. Let's try a better name than |
||
| - name: Start minikube | ||
| if: env.EXTENSION_REPO != '' | ||
| uses: che-incubator/setup-minikube-action@next | ||
| - name: Load image | ||
| if: env.EXTENSION_REPO != '' | ||
| run: | | ||
| # load image in the docker registry | ||
| eval $(minikube docker-env) | ||
| docker load --input=docker-image.tar | ||
| # display images | ||
| docker images | ||
| - name: Deploy Eclipse Che | ||
| if: env.EXTENSION_REPO != '' | ||
| uses: che-incubator/che-deploy-action@next | ||
| with: | ||
| # use custom image built by this PR | ||
| plugin-registry-image: quay.io/eclipse/che-plugin-registry:vscode-extension | ||
| - name: Run VSCode extension's tests | ||
| if: env.EXTENSION_REPO != '' | ||
| run: | | ||
| ./.ci/run-extension-tests.sh | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be good to extract out the arguments for
git diffinto arguments for the script. That way it's not hardcoded in the script, but takes input from the GitHub action job.For example:
https://github.com/eclipse/che-plugin-registry/blob/master/.ci/sidecar-build-publish.sh#L16
https://github.com/eclipse/che-plugin-registry/blob/master/.github/workflows/sidecar-build-push.yaml#L48