test: remove docker tests from lib

Author: nzbr

tests/README.md

@@ -1,34 +1,27 @@
 # Tests
 
-This directory contains tests that are executed against a built NixOS-WSL "legacy" tarball.
+This directory contains tests that are executed against a built NixOS-WSL tarball.
 The tests are written using the [Pester](https://pester.dev/) testing framework.
 
 ## Execute Tests
 
-The tests can be executed on both Windows or Linux.
-
-### Windows
+The tests can only be executed on Windows. Support for running the tests in an emulated WSL environment through docker has been removed.
 
 Make sure that you are able to run a distro in WSL2 before trying to run the tests.
 Please note that the tests are not compatible with Windows PowerShell, but require the new [PowerShell Core](https://apps.microsoft.com/store/detail/powershell/9MZ1SNWT0N5D?hl=en-us&gl=us).
 
-### Linux
-
-Running the tests requires Docker and PowerShell to be installed on your system. Make sure that the user you are running the tests as has permissions to run docker containers and that it is possible to access the internet from inside docker containers.
-
 ### Running the Tests
 
 If you haven't already, [install Pester](https://pester.dev/docs/introduction/installation/).  
-The tests require a "legacy" `nixos-wsl.tar.gz` to be present in the current working directory, which can be built with
-`sudo nix run .#nixosConfigurations.legacy.config.system.build.tarballBuilder -- nixos-wsl.tar.gz`.
+The tests require a "modern" `nixos-wsl.tar.gz` to be present in the current working directory, which can be built with
+`sudo nix run .#nixosConfigurations.modern.config.system.build.tarballBuilder -- nixos-wsl.tar.gz`.
 
 Once everything is in place, run the test by running the following in PowerShell at the root of this repo:
 
 ```powershell
 Invoke-Pester -Output Detailed ./tests
 ```
 
-
 ## Writing Test
 
 Please refer to [the Pester documentation](https://pester.dev/docs/quick-start) on how to write new tests.
@@ -42,10 +35,10 @@ BeforeAll {
 }
 ```
 
-- `Install-Distro`: Creates a new NixOS-WSL instance, automatically selecting the appropriate runtime (WSL or Docker) for the host OS. Returns a new `Distro` object
+- `[Distro]::new()`: Creates a new NixOS-WSL instance.
 - A Distro object has the following methods:
-  - `Launch($command)`: Runs the specified command inside the container. Returns the command output
-  - `GetPath($path)`: Returns the path inside the container, that points to the specified file on the host.
+  - `Launch($command)`: Runs the specified command inside the distro. Returns the command output
+  - `GetPath($path)`: Returns the path inside the distro, that points to the specified file on the host.
   - `InstallConfig($path)`: Installs a nix-file as the systems `configuration.nix`.
-  - `Shutdown()`: End all processes running in the container
-  - `Uninstall()`: Stop and then delete the container from the system. This should be called in an AfterEach or AfterAll block, so that the test does not leave it on the system.
+  - `Shutdown()`: End all processes running in the distro
+  - `Uninstall()`: Stop and then delete the distro from the system. This should be called in an AfterEach or AfterAll block, so that the test does not leave it on the system.

tests/basic-functionality.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Basic Functionality" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
   }
 
   It "is possible to run a command in the container" {

tests/docker/docker.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Docker (native)" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
     try {
       $distro.InstallConfig("$PSScriptRoot/docker-native.nix")
     }

tests/exit-codes.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Exit Codes" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
   }
 
   It "should return 0 when running true" {

tests/lib/Dockerfile

@@ -1,6 +1,9 @@
 if ($PSVersionTable.PSEdition -ne 'Core') {
   throw "The tests are not compatible with Windows PowerShell, please use PowerShell Core instead"
 }
+if ($IsWindows -eq $false) {
+  throw "Support for tests in an emulated WSL environment on Linux has been removed"
+}
 
 function Remove-Escapes {
   param(
@@ -15,13 +18,31 @@ function Remove-Escapes {
 # Implementation-independent base class
 class Distro {
   [string]$id
+  [string]$tempdir
+
+  Distro() {
+    $tarball = $this.FindTarball()
+
+    $this.id = $(New-Guid).ToString()
+    $this.tempdir = Join-Path $([System.IO.Path]::GetTempPath()) $this.id
+    New-Item -ItemType Directory $this.tempdir
 
-  [string]Launch() {
-    throw "Not implemented"
+    & wsl.exe --import $this.id $this.tempdir $tarball --version 2 | Write-Host
+    if ($LASTEXITCODE -ne 0) {
+      throw "Failed to import distro"
+    }
+    & wsl.exe --list -q | Should -Contain $this.id
+  }
+
+  [Array]Launch([string]$command) {
+    Write-Host "> $command"
+    $result = @()
+    Invoke-Expression "wsl.exe -d $($this.id) --% $command" | Tee-Object -Variable result | Write-Host
+    return $result | Remove-Escapes
   }
 
   [string]GetPath([string]$path) {
-    throw "Not implemented"
+    return $this.Launch("wslpath $($path -replace "\\", "/")") | Select-Object -Last 1
   }
 
   [string]FindTarball() {
@@ -48,101 +69,6 @@ class Distro {
     Write-Host "Config installed successfully"
   }
 
-  [void]Shutdown() {
-    throw "Not implemented"
-  }
-
-  [void]Uninstall() {
-    throw "Not implemented"
-  }
-}
-
-# Emulates a WSL distro using a Docker container (for Linux hosts)
-class DockerDistro : Distro {
-  static [string]$hostMount = "/mnt/c"
-  static [string]$imageName = "local:nixos-wsl"
-
-  static [bool]$imageCreated = $false
-
-  DockerDistro() {
-    $tarball = $this.FindTarball()
-
-    if (!([DockerDistro]::imageCreated)) {
-      # Build docker image from the tarball
-      $tmpdir = $(mktemp -d)
-      Copy-Item $PSScriptRoot/Dockerfile $tmpdir
-      Copy-Item $tarball $tmpdir
-      docker build -t $([DockerDistro]::imageName) $tmpdir | Write-Host
-      Remove-Item $tmpdir -Recurse -Force
-
-      [DockerDistro]::imageCreated = $true
-    }
-
-    $this.id = $(New-Guid).ToString()
-
-    docker run -di --privileged --volume "/:$([DockerDistro]::hostMount)" --name $this.id $([DockerDistro]::imageName) "/bin/sh" | Out-Null
-    if ($LASTEXITCODE -ne 0) {
-      throw "Failed to launch container"
-    }
-
-    $this.Launch("sudo nix-channel --update")
-  }
-
-  [Array]Launch([string]$command) {
-    Write-Host "> $command"
-    $result = @()
-    docker exec -t $this.id /bin/syschdemd -c $command | Tee-Object -Variable result | Write-Host
-    return $result | Remove-Escapes
-  }
-
-  [string]GetPath([string]$path) {
-    return [DockerDistro]::hostMount + $(readlink -f $path)
-  }
-
-  [void]Shutdown() {
-    docker restart $this.id # Restart instead of stop so that exec can still be used
-    if ($LASTEXITCODE -ne 0) {
-      throw "Failed to stop container"
-    }
-  }
-
-  [void]Uninstall() {
-    docker rm -f $this.id
-    if ($LASTEXITCODE -ne 0) {
-      throw "Failed to remove container"
-    }
-  }
-}
-
-# A real WSL distro (for Windows hosts)
-class WslDistro : Distro {
-  [string]$tempdir
-
-  WslDistro() {
-    $tarball = $this.FindTarball()
-
-    $this.id = $(New-Guid).ToString()
-    $this.tempdir = Join-Path $([System.IO.Path]::GetTempPath()) $this.id
-    New-Item -ItemType Directory $this.tempdir
-
-    & wsl.exe --import $this.id $this.tempdir $tarball --version 2 | Write-Host
-    if ($LASTEXITCODE -ne 0) {
-      throw "Failed to import distro"
-    }
-    & wsl.exe --list -q | Should -Contain $this.id
-  }
-
-  [Array]Launch([string]$command) {
-    Write-Host "> $command"
-    $result = @()
-    Invoke-Expression "wsl.exe -d $($this.id) --% $command" | Tee-Object -Variable result | Write-Host
-    return $result | Remove-Escapes
-  }
-
-  [string]GetPath([string]$path) {
-    return $this.Launch("wslpath $($path -replace "\\", "/")") | Select-Object -Last 1
-  }
-
   [void]Shutdown() {
     & wsl.exe -t $this.id
     if ($LASTEXITCODE -ne 0) {
@@ -158,15 +84,3 @@ class WslDistro : Distro {
     Remove-Item $this.tempdir -Recurse -Force
   }
 }
-
-# Auto-select the implementation to use
-function Install-Distro() {
-  if ($IsWindows) {
-    Write-Host "Detected Windows host, using WSL2"
-    return [WslDistro]::new()
-  }
-  else {
-    Write-Host "Detected Linux host, using Docker"
-    return [DockerDistro]::new()
-  }
-}

tests/lib/lib.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Login Shell" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
   }
 
   if ($IsWindows) {

tests/login-shell/login-shell.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Shells" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
 
     function Add-ShellTest([string]$package, [string]$executable, [string]$command) {
       $temp = New-TemporaryFile

tests/shells.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Systemd Services" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
   }
 
   It "should boot" {

tests/systemd-services.Tests.ps1

@@ -4,7 +4,7 @@ BeforeAll {
 
 Describe "Systemd User Daemon" {
   BeforeAll {
-    $distro = Install-Distro
+    $distro = [Distro]::new()
   }
 
   It "should be possible to connect to the user daemon" {