Windows support (#21)

* Fixes for Windows

  - Update path
  - Tests running on Windows 🎉

* Update all the things

* Removing linter

Author: AnHeuermann

.github/linters/.markdown-lint.yml

@@ -12,7 +12,12 @@ on:
 jobs:
   test-typescript:
     name: TypeScript Tests
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
     permissions:
       contents: read
 
@@ -28,7 +33,21 @@ jobs:
 
       - name: Update pip
         run: |
-          pip install --upgrade pip
+          python -m pip install --upgrade pip
+
+      - name: Install Python packages (Windows only)
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: |
+          pip install --user `
+            datetime `
+            matplotlib `
+            monotonic `
+            natsort `
+            joblib `
+            ompython `
+            simplejson `
+            psutil
 
       - name: Cache pip dependencies
         uses: actions/cache@v4
@@ -66,12 +85,16 @@ jobs:
         run: npm run lint
 
       - name: Test
-        id: npm-ci-test
-        run: npm run ci-test
+        id: npm-test
+        run: npm run test
 
   test-action:
     name: GitHub Actions Test
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
     timeout-minutes: 60
     permissions:
       contents: write

.github/linters/.yaml-lint.yml

@@ -102,5 +102,8 @@ __tests__/runner/*
 .vscode
 *.code-workspace
 
+# Python
+/.venv/
+
 /OpenModelicaLibraryTesting/
-/html/
+/html/

.github/workflows/ci.yml

@@ -10,6 +10,17 @@ the test report.
 The action will set output variables that can be checked how many tests passed
 simulation and verification. It will fail if at least one test is failing.
 
+## Table of Contents
+
+- [Inputs](#inputs)
+- [Outputs](#outputs)
+- [Example usage](#example-usage)
+- [Artifacts](#artifacts)
+- [Demo](#demo)
+- [Development](#development)
+- [License](#license)
+- [Acknowledgments](#acknowledgments)
+
 ## Inputs
 
 ### `library`
@@ -59,6 +70,27 @@ Character to separate model names in reference files.
 E.g. for `Modelica.Blocks.Examples.PID_Controller.mat` it would be `'.'`\
 Default: `'.'`
 
+## Outputs
+
+The action will fail if one test fails. In addition the following outputs can be
+used to determine the testing results.
+
+### `simulation-tests-passing`
+
+`'True'` if all simulation tests are passing, `'False'` otherwise.
+
+### `n-simulation-passing`
+
+Number of successful simulation tests.
+
+### `verification-tests-passing`
+
+`'True'` if all verification tests are passing, `'False'` otherwise.
+
+### `n-verification-passing`
+
+Number of successful verification tests.
+
 ## Example usage
 
 ```yaml
@@ -97,27 +129,6 @@ jobs:
           pages-root-url: 'https://USERNAME.github.io/REPOSITORY/'
 ```
 
-## Outputs
-
-The action will fail if one test fails. In addition the following outputs can be
-used to determine the testing results.
-
-## `simulation-tests-passing`
-
-`'True'` if all simulation tests are passing, `'False'` otherwise.
-
-## `n-simulation-passing`
-
-Number of successful simulation tests.
-
-## `verification-tests-passing`
-
-`'True'` if all verification tests are passing, `'False'` otherwise.
-
-## `n-verification-passing`
-
-Number of successful verification tests.
-
 ## Artifacts
 
 ### HTML Results
@@ -128,7 +139,7 @@ pages.
 
 ```bash
 unzip MyLibrary.html.zip -d html
-python3 -m http.server -d html
+python -m http.server -d html
 ```
 
 #### GitHub Pages
@@ -169,7 +180,7 @@ jobs:
 
 ### SQlite
 
-For future test the SQlite data base `sqlite3.db` is achieved.
+For future tests the SQlite data base `sqlite3.db` is archived.
 
 ## Demo
 
@@ -203,6 +214,30 @@ The HTML results can be hosted with GitHub Pages, for this example they can be
 found at
 [OpenModelica.github.io/openmodelica-library-testing-action][gh-pages-link].
 
+## Development
+
+To install and build run:
+
+```bash
+npm install
+npm run package
+```
+
+Testing will install some Python packages. It's useful to setup a virtual Python
+environment in your shell before starting the tests:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+npm run test
+```
+
+> [!TIP]
+> On Windows use Conda to choose a Python interpreter and then setup a virtual
+> environment.
+> Use PowerShell to activate `.\.venv\Scripts\activate` the environment.
+> Msys2 doesn't install Python packages via pip, so it won't work with this script.
+
 ## License
 
 This action is licensed with the OSMC Public License v1.8, see

.github/workflows/linter.yml

@@ -1,5 +1,6 @@
 /clone/
 /tmp-collect/
 /tmp-configs/
+/tmp-msys/
 github_step_summary.md
-MyLibrary_0.1.0.html
+MyLibrary_0.1.0.html

.gitignore

@@ -2,6 +2,7 @@
  * Unit tests for src/config.ts
  */
 
+import * as os from 'os'
 import * as fs from 'fs'
 import * as path from 'path'
 import { expect } from '@jest/globals'
@@ -14,36 +15,42 @@ describe('config.ts', () => {
   afterEach(() => fs.rmSync(tempTestDir, { recursive: true, force: true }))
 
   it('Generate minimal configuration', async () => {
-    const modelicaFile = '/path/to/MyLibrary/package.mo'
-    const config: Configuration = {
-      library: 'MyLibrary',
-      libraryVersion: 'main',
-      loadFileCommands: [`loadFile("${path.resolve(modelicaFile)}")`]
+    let modelicaFile: string
+    if (os.platform() === 'win32') {
+      modelicaFile = path.join('C:', 'path', 'to', 'MyLibrary', 'package.mo')
+    } else {
+      modelicaFile = path.join('/path', 'to', 'MyLibrary', 'package.mo')
     }
-
-    expect(config).toEqual({
+    const config = new Configuration({
       library: 'MyLibrary',
       libraryVersion: 'main',
-      loadFileCommands: ['loadFile("/path/to/MyLibrary/package.mo")']
+      loadFileCommands: [`loadFile("${modelicaFile}")`]
     })
+
+    const expectedPath =
+      os.platform() === 'win32'
+        ? 'C:/path/to/MyLibrary/package.mo'
+        : '/path/to/MyLibrary/package.mo'
+    expect(config.loadFileCommands).toEqual([`loadFile("${expectedPath}")`])
   })
 
   it('Generate minimal configuration file', async () => {
     const file = path.join(tempTestDir, 'testConfigSimple.json')
-    const modelicaFile = '/path/to/MyLibrary/package.mo'
-    const config: Configuration = {
+    const modelicaFile = path.join('path', 'to', 'MyLibrary', 'package.mo')
+    const config = new Configuration({
       library: 'MyLibrary',
       libraryVersion: 'main',
-      loadFileCommands: [`loadFile("${path.resolve(modelicaFile)}")`]
-    }
+      loadFileCommands: [`loadFile("${modelicaFile}")`]
+    })
 
     await genConfigFile(file, [config])
     expect(fs.existsSync(file)).toBe(true)
   })
 
   it('Generate extensive configuration file', async () => {
     const file = path.join(tempTestDir, 'testConfig.json')
-    const config: Configuration = {
+    const modelicaFile = path.join('path', 'to', 'MyLibrary', 'package.mo')
+    const config = new Configuration({
       library: 'MyLibrary',
       libraryVersion: 'main',
       libraryVersionNameForTests: 'v1.0.0-def',
@@ -69,7 +76,7 @@ describe('config.ts', () => {
       optlevel: '-Os -march=native',
       alarmFlag: '--alarm',
       abortSlowSimulation: '',
-      loadFileCommands: ['loadFile("${resolve(modelicaFile)}")'],
+      loadFileCommands: [`loadFile("${modelicaFile}")`],
       extraCustomCommands: ['setCommandLineOptions("-d=-NLSanalyticJacobian")'],
       environmentSimulation: [
         ['publicData', '$libraryLocation/Tables/'],
@@ -84,7 +91,7 @@ describe('config.ts', () => {
         ]
       ],
       configExtraName: 'noopt'
-    }
+    })
 
     await genConfigFile(file, [config])
     expect(fs.existsSync(file)).toBe(true)