Merge pull request #55 from lf-lang/check-versions

Dependency checks and environment setup assistance

.github/actions/build/action.yml

@@ -0,0 +1,16 @@
+name: Build
+description: Set up repository and install dependencies required to build extension.
+
+runs:
+  using: "composite"
+  steps:
+    - name: Check out vscode-lingua-franca repository
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        fetch-depth: 1
+    - name: Prepare LF build environment
+      uses: ./lingua-franca/.github/actions/prepare-build-env
+    - name: Build the VS Code extension
+      run: npm install --ignore-scripts
+      shell: bash

.github/workflows/ci.yml

@@ -9,20 +9,77 @@ on:
   # Trigger this workflow also on pull_request events.
   pull_request:
 
-jobs:  
-  build:
-    runs-on: ubuntu-latest
+jobs:
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+        rust: [nightly]
+    runs-on: ${{ matrix.platform }}
     steps:
-      - name: Check out vscode-lingua-franca repository
-        uses: actions/checkout@v3
+      - uses: lf-lang/vscode-lingua-franca/.github/actions/build@check-versions
+      - name: Install pylint
+        run: python3 -m pip install pylint
+      - name: Install pnpm
+        run: npm i -g pnpm
+      - name: Setup Rust
+        uses: ATiltedTree/setup-rust@v1
         with:
-          submodules: recursive
-          fetch-depth: 0
-      - name: Prepare LF build environment
-        uses: ./lingua-franca/.github/actions/prepare-build-env
-      - name: Install VS Code
-        uses: ./.github/actions/install-code
-      - name: Build, deploy, and test the VS Code extension
+          rust-version: ${{ matrix.rust }}
+          components: clippy
+      - name: Install RTI
         run: |
-          npm install
-          npm run test
+          cd lingua-franca
+          .github/actions/install-rti/install.sh
+          cd ..
+        shell: bash
+        if: ${{ runner.os == 'macOS' || runner.os == 'Linux' }}
+      - name: Run tests (Linux)
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run test
+        if: ${{ runner.os == 'Linux' }}
+      - name: Run tests (non-Linux)
+        run: npm run test
+        if: ${{ runner.os != 'Linux' }}
+  test-dependencies-outdated:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: lf-lang/vscode-lingua-franca/.github/actions/build@check-versions
+      - name: Downgrade dependencies
+        run: |
+          pip install -I pylint==2.10.0
+          rustup default 1.26.0
+      - name: Run tests (Linux)
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run test-dependencies-outdated
+        if: ${{ runner.os == 'Linux' }}
+      - name: Run tests (non-Linux)
+        run: npm run test-dependencies-outdated
+        if: ${{ runner.os != 'Linux' }}
+  test-dependencies-missing-extended:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: lf-lang/vscode-lingua-franca/.github/actions/build@check-versions
+      - name: Run tests (Linux)
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run test-dependencies-missing-extended
+        if: ${{ runner.os == 'Linux' }}
+      - name: Run tests (non-Linux)
+        run: npm run test-dependencies-missing-extended
+        if: ${{ runner.os != 'Linux' }}
+  test-dependencies-missing-basic:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: lf-lang/vscode-lingua-franca/.github/actions/build@check-versions
+      - name: Run tests (Linux)
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run test-dependencies-missing-basic
+        if: ${{ runner.os == 'Linux' }}
+      - name: Run tests (non-Linux)
+        run: npm run test-dependencies-missing-basic
+        if: ${{ runner.os != 'Linux' }}

.gitignore

@@ -1,6 +1,6 @@
 *.jar
 *.vsix
-.vscode
+.vscode-test
 node_modules/*
 out/*
 .gradle/*

.vscode/launch.json

@@ -0,0 +1,67 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}"
+            ],
+            "name": "Launch Extension",
+            "outFiles": [
+                "${workspaceFolder}/out/**/*.js"
+            ],
+            "request": "launch",
+            "type": "extensionHost"
+        },
+        {
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionTestsPath=${workspaceFolder}/out/test/test/index"
+            ],
+            "env": {
+                "dependencies": "present"
+            },
+            "name": "Tests",
+            "outFiles": [
+                "${workspaceFolder}/out/test/**/*.js"
+            ],
+            "preLaunchTask": "npm: compile-tests",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "type": "extensionHost"
+        },
+        {
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionTestsPath=${workspaceFolder}/out/test/test/index"
+            ],
+            "env": {
+                "dependencies": "missing1"
+            },
+            "name": "Tests: Dependencies Missing1",
+            "outFiles": [
+                "${workspaceFolder}/out/test/**/*.js"
+            ],
+            "preLaunchTask": "npm: compile-tests",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "type": "extensionHost"
+        },
+        {
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionTestsPath=${workspaceFolder}/out/test/test/index"
+            ],
+            "env": {
+                "dependencies": "outdated"
+            },
+            "name": "Tests: Dependencies Outdated",
+            "outFiles": [
+                "${workspaceFolder}/out/test/**/*.js"
+            ],
+            "preLaunchTask": "npm: compile-tests",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "type": "extensionHost"
+        },
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,9 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "npm",
+            "script": "compile-tests"
+        }
+    ]
+}

.vscodeignore

@@ -5,6 +5,7 @@ node_modules/
 lingua-franca/
 __pycache__/*
 src/**
+out/test/**
 
 *.vsix
 .gitignore

CONTRIBUTING.md

@@ -38,7 +38,7 @@ npm run test
 ```
 
 ## Adding tests
-Tests are located in the `src` directory and are marked using the `.test.ts` extension. We use [Jest](https://jestjs.io/) as our testing framework.
+Tests are located in the `src` directory and are marked using the `.test.ts` extension. We use [Mocha](https://mochajs.org/) as our testing framework.
 
 ## Submitting a Pull Request (PR)
 Please keep your PRs manageable and easy to review.