ci: add support for windows runner

.github/workflows/zxc-compile-code.yaml

@@ -65,17 +65,122 @@ permissions:
 jobs:
   compile:
     name: ${{ inputs.custom-job-label || 'Compiles' }}
-    runs-on: [self-hosted, Linux, medium, ephemeral]
+    runs-on: solo-windows-2022-large
     steps:
       - name: Checkout Code
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
+      - name: Update WSL
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: pwsh
+        run: |
+          wsl --update
+          wsl --install
+          wsl --set-default-version 2
+
+      - name: Set WSL Version 2
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: pwsh
+        run: |
+          wsl --status
+          wsl --update
+          wsl --list --online
+          wsl --set-default-version 2
+          wsl -l -v
+
+      - shell: wsl-bash {0}
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        run: |
+          pwd
+          ls -ltr
+          uname -a
+
+      - name: Get WSL Info
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: pwsh
+        run: |
+          wsl -l -v
+
+      - name: WSL Install Helm
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: wsl-bash {0}
+        run: |
+
+          curl https://baltocdn.com/helm/signing.asc | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
+          sudo apt-get install apt-transport-https --yes
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/helm.gpg] https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
+          sudo apt-get update
+          sudo apt-get -y install helm
+          which helm
+          helm version
+
+      - name: WSL Install Kind
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: wsl-bash {0}
+        run: |
+          [ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.22.0/kind-linux-amd64
+          chmod +x ./kind
+          sudo mv ./kind /usr/local/bin/kind
+          which kind
+          kind version
+
+      - name: WSL Install Docker
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: wsl-bash {0}
+        run: |
+
+          sudo apt-get update
+          sudo apt-get -y install ca-certificates curl
+          sudo install -m 0755 -d /etc/apt/keyrings
+          sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+          sudo chmod a+r /etc/apt/keyrings/docker.asc
+
+          # Add the repository to Apt sources:
+          echo \
+          "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+          $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+          sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt-get update
+
+          sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+          # sudo systemctl start docker
+          sudo usermod -aG docker $(whoami)
+
+      - name: WSL Install NodeJS
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: wsl-bash {0}
+        run: |
+          curl -O https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh
+          ./install.sh
+          nvm install node
+          node -v
+          npm -v      
+
+      - name: WSL Run Docker
+        if: ${{ runner.os == 'Windows' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        shell: wsl-bash {0}
+        run: |
+          echo $USER
+          ls -l /var/run/docker.sock
+          stat /var/run/docker.sock
+          sudo usermod -aG docker $USER
+          sudo service docker restart
+          sudo service docker status
+          sudo docker context ls
+          sudo ps aux | grep docker
+          sudo docker version
+          sudo docker -D run hello-world
+
+
+
+
       - name: Setup Node
         uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: ${{ inputs.node-version }}
           cache: npm
 
+
       - name: Setup Java
         uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4.1.0
         if: ${{ inputs.enable-e2e-tests && !cancelled() && !failure() }}
@@ -85,7 +190,7 @@ jobs:
 
       - name: Setup Kind
         uses: helm/kind-action@99576bfa6ddf9a8e612d83b513da5a75875caced # v1.9.0
-        if: ${{ inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        if: ${{ runner.os == 'linux' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
         with:
           install_only: true
           node_image: kindest/node:v1.27.3@sha256:3966ac761ae0136263ffdb6cfd4db23ef8a83cba8a463690e98317add2c9ba72
@@ -94,6 +199,7 @@ jobs:
           verbosity: 3
           wait: 120s
 
+
       - name: Setup Helm
         uses: azure/setup-helm@29960d0f5f19214b88e1d9ba750a9914ab0f1a2f # v4.0.0
         if: ${{ (inputs.enable-unit-tests || inputs.enable-e2e-tests) && !cancelled() && !failure() }}
@@ -102,35 +208,44 @@ jobs:
 
       - name: Install Dependencies
         id: npm-deps
-        run: npm ci
+        run:
+          npm ci
 
       - name: Check Code Style
-        if: ${{ inputs.enable-code-style-check && !cancelled() && !failure() }}
+        if: ${{ runner.os == 'linux' && inputs.enable-code-style-check && !cancelled() && !failure() }}
         run: npm run check
 
       - name: Run Unit Tests
         if: ${{ inputs.enable-unit-tests && !cancelled() && !failure() }}
         run: npm test
 
-      - name: Publish Unit Test Report
+      - name: Publish Windows Unit Test Report
+        uses: EnricoMi/publish-unit-test-result-action/windows/[email protected]
+        if: ${{ runner.os == 'Windows' && inputs.enable-unit-tests && steps.npm-deps.conclusion == 'success' && !cancelled() }}
+        with:
+          check_name: 'Unit Test Results - ${{ runner.os }}'
+          files: "junit.xml"
+
+      - name: Publish Linux Unit Test Report
         uses: EnricoMi/publish-unit-test-result-action@f355d34d53ad4e7f506f699478db2dd71da9de5f # v2.15.1
-        if: ${{ inputs.enable-unit-tests && steps.npm-deps.conclusion == 'success' && !cancelled() }}
+        if: ${{ runner.os == 'linux' && inputs.enable-unit-tests && steps.npm-deps.conclusion == 'success' && !cancelled() }}
         with:
-          check_name: 'Unit Test Results'
+          check_name: 'Unit Test Results - ${{ runner.os }}'
           files: "junit.xml"
 
       - name: Publish Unit Test Coverage Report
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
-        if: ${{ inputs.enable-unit-tests && !cancelled() }}
+        if: ${{ runner.os == 'linux' && inputs.enable-unit-tests && !cancelled() }}
         with:
-          name: Unit Test Coverage Report
+          name: Unit Test Coverage Report - ${{ runner.os }}
           path: 'coverage/unit'
 
       - name: Pull Kind Docker Image
-        if: ${{ inputs.enable-e2e-tests && !cancelled() && !failure() }}
+        if: ${{ runner.os == 'linux' && inputs.enable-e2e-tests && !cancelled() && !failure() }}
         run: docker image pull kindest/node:v1.27.3@sha256:3966ac761ae0136263ffdb6cfd4db23ef8a83cba8a463690e98317add2c9ba72
 
-      - name: Setup E2E Tests
+
+      - name: Setup E2E Tests Linux
         if: ${{ inputs.enable-e2e-tests && !cancelled() && !failure() }}
         run: | 
           npm link
@@ -153,19 +268,19 @@ jobs:
         uses: EnricoMi/publish-unit-test-result-action@f355d34d53ad4e7f506f699478db2dd71da9de5f # v2.15.1
         if: ${{ inputs.enable-e2e-tests && steps.npm-deps.conclusion == 'success' && !cancelled() }}
         with:
-          check_name: 'E2E Test Results'
+          check_name: 'E2E Test Results - ${{ runner.os }}'
           files: "junit-e2e.xml"
 
       - name: Publish E2E Coverage Report
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         if: ${{ inputs.enable-e2e-tests && !cancelled() }}
         with:
-          name: E2E Coverage Report
+          name: E2E Coverage Report - ${{ runner.os }}
           path: 'coverage/e2e'
 
       - name: Publish Test Reports
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         if: ${{ inputs.enable-unit-tests && steps.npm-deps.conclusion == 'success' && !cancelled() }}
         with:
-          name: Test Reports
+          name: Test Reports - ${{ runner.os }}
           path: "junit*.xml"

package.json

@@ -11,9 +11,9 @@
     "access": "public"
   },
   "scripts": {
-    "test": "NODE_OPTIONS=--experimental-vm-modules JEST_SUITE_NAME='Unit Tests' jest --runInBand --detectOpenHandles --forceExit --coverage --coverageDirectory='coverage/unit' --testPathIgnorePatterns=\".*/e2e/.*\"",
-    "test-e2e": "NODE_OPTIONS=--experimental-vm-modules JEST_SUITE_NAME='Jest E2E Tests' JEST_JUNIT_OUTPUT_NAME='junit-e2e.xml' jest --runInBand --detectOpenHandles --forceExit --coverage --coverageDirectory='coverage/e2e' --testPathIgnorePatterns=\\\".*/unit/.*\\\"",
-    "solo": "NODE_OPTIONS=--experimental-vm-modules node solo.mjs",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules JEST_SUITE_NAME=\"Unit Tests\" jest --runInBand --detectOpenHandles --forceExit --coverage --coverageDirectory='coverage/unit' --testPathIgnorePatterns=\".*/e2e/.*\"",
+    "test-e2e": "cross-env NODE_OPTIONS=--experimental-vm-modules JEST_SUITE_NAME=\"Jest E2E Tests\" JEST_JUNIT_OUTPUT_NAME=\"junit-e2e.xml\" jest --runInBand --detectOpenHandles --forceExit --coverage --coverageDirectory='coverage/e2e' --testPathIgnorePatterns=\\\".*/unit/.*\\\"",
+    "solo": "cross-env NODE_OPTIONS=--experimental-vm-modules node solo.mjs",
     "check": "remark . --quiet --frail && eslint .",
     "format": "remark . --quiet --frail --output && eslint --fix ."
   },
@@ -66,6 +66,7 @@
     "remark-lint-unordered-list-marker-style": "^3.1.2",
     "remark-preset-lint-consistent": "^5.1.2",
     "remark-preset-lint-recommended": "^6.1.3",
+    "cross-env": "^7.0.3",
     "seedrandom": "^3.0.5"
   },
   "repository": {
@@ -74,7 +75,8 @@
   },
   "os": [
     "darwin",
-    "linux"
+    "linux",
+    "win32"
   ],
   "engines": {
     "node": ">=18.18.2",

src/core/constants.mjs

@@ -121,8 +121,8 @@ export const CERTIFICATE_VALIDITY_YEARS = 100 // years
 
 export const PUBLIC_PFX = 'public.pfx'
 
-export const OS_WINDOWS = 'windows'
 export const OS_WIN32 = 'win32'
+export const OS_WINDOWS = 'windows'
 export const OS_DARWIN = 'darwin'
 export const OS_MAC = 'mac'
 export const OS_LINUX = 'linux'

src/core/dependency_managers/helm_dependency_manager.mjs

@@ -56,6 +56,11 @@ export class HelmDependencyManager extends ShellRunner {
     this.zippy = zippy
     this.installationDir = installationDir
     this.osPlatform = osPlatform
+
+    // Node.js uses 'win32' for windows in package.json os field, but helm uses 'windows'
+    if (osPlatform === OS_WIN32) {
+      this.osPlatform = OS_WINDOWS
+    }
     this.osArch = ['x64', 'x86-64'].includes(osArch) ? 'amd64' : osArch
     this.helmVersion = helmVersion
     this.helmPath = Templates.installationPath(constants.HELM, this.osPlatform, this.installationDir)

test/e2e/setup-e2e-windows.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+SOLO_CLUSTER_NAME=solo-e2e
+SOLO_NAMESPACE=solo-e2e
+SOLO_CLUSTER_SETUP_NAMESPACE=solo-e2e-cluster
+minikube profile list
+minikube start -p ${SOLO_CLUSTER_NAME} --driver=docker
+solo init --namespace "${SOLO_NAMESPACE}" -i node0,node1,node2 -t v0.42.5 -s "${SOLO_CLUSTER_SETUP_NAMESPACE}" || exit 1 # cache args for subsequent commands
+solo cluster setup  || exit 1
+solo network deploy || exit 1

test/unit/commands/base.test.mjs

@@ -55,7 +55,7 @@ describe('BaseCommand', () => {
       await expect(baseCmd.run('INVALID_PROGRAM')).rejects.toThrowError()
     })
     it('should succeed during valid program check', async () => {
-      await expect(baseCmd.run('date')).resolves.not.toBeNull()
+      await expect(baseCmd.run('echo')).resolves.not.toBeNull()
     })
   })
 })