Running Tests Locally

This guide walks you through setting up and running the NullOpsDevs.LibSsh test suite on your local machine.

Prerequisites

Before running tests, ensure you have the following installed:

.NET 8.0 or 9.0 SDK - Download
Docker Desktop - Download
- Windows: Docker Desktop with WSL 2 backend
- Linux: Docker Engine and Docker Compose
- macOS: Docker Desktop

Quick Start

1. Clone the Repository

git clone https://github.com/NullOpsDevs/LibSshNet.git
cd LibSshNet

2. Start the SSH Test Server

The test suite requires a Docker-based SSH server to be running:

cd src/NullOpsDevs.LibSsh.Test
docker compose up -d

Wait for the container to be healthy (usually takes 5-10 seconds):

docker compose ps

You should see:

NAME                  IMAGE                      STATUS
libssh-test-server    libssh-test-server:latest  Up (healthy)

3. Run the Tests

From the test project directory, simply run:

dotnet run

The test runner will:

Load the native libssh2 library
Wait for Docker containers to be ready
Run all test categories
Display a summary of results

Test Categories

The test suite includes the following categories:

Authentication Tests

Retrieve negotiated methods
Host key retrieval
Host key hash retrieval
Password authentication
Public key authentication (with and without passphrase)
Public key from memory
SSH agent authentication

Command Execution Tests

Basic command execution
Command with exit codes
Command with stderr output
Commands with PTY allocation
Long-running commands

File Transfer Tests

SCP upload (small, medium, large files)
SCP download (small, medium, large files)
File transfer error handling

Terminal Features Tests

PTY allocation
Terminal modes configuration
Window size configuration

Error Handling Tests

Authentication failures
Connection timeouts
Invalid commands
File transfer errors

Edge Case Tests

Multiple sequential operations
Timeout handling
Large output handling
Connection with deprecated methods
Parallel sessions (15 concurrent connections)

Running Stress Tests

For performance testing with 2,000 parallel connections:

CRAZY_LOAD_TEST=1 dotnet run

$env:CRAZY_LOAD_TEST="1"
dotnet run

set CRAZY_LOAD_TEST=1
dotnet run

Test Server Configuration

The Docker-based SSH test server is configured with:

Port: 2222 (mapped to host)
Username: user
Password: 12345
SSH Keys: Located in docker/test-keys/
Test Files: Pre-generated in /test-files/ inside the container
- small.txt - Small text file
- medium.bin - 1MB binary file
- large.dat - 10MB binary file

Server Limits

The test server is configured to handle high connection loads:

MaxStartups: 1000:30:2000
MaxSessions: 1000
File descriptors: 65536
Max processes: 32768

Troubleshooting

Docker Container Not Starting

Check Docker daemon status:

docker ps

View container logs:

docker compose logs ssh-server

Rebuild the container if needed:

docker compose down
docker compose build --no-cache
docker compose up -d

Connection Refused Errors

Ensure the SSH server is listening on port 2222:

docker compose exec ssh-server nc -z localhost 2222

If the connection fails, restart the container:

docker compose restart

Tests Timing Out

The test runner waits up to 60 seconds for containers to be ready. If tests still time out:

Check Docker resource allocation (CPU/memory)
Verify no firewall is blocking port 2222
Manually test SSH connection:

ssh -p 2222 user@localhost
# Password: 12345

Native Library Load Failures

If you see "Failed to load native library":

Ensure the NullOpsDevs.LibSsh package is properly restored
Check that your platform is supported (Windows x64, Linux x64/ARM64, macOS x64/ARM64)
Try cleaning and rebuilding:

dotnet clean
dotnet restore
dotnet build
dotnet run

The native libraries are automatically copied to the output directory (bin/Debug/net9.0/native/) during build from the NuGet package.

Port 2222 Already in Use

If port 2222 is already in use:

# Find what's using the port
lsof -i :2222  # macOS/Linux
netstat -ano | findstr :2222  # Windows

# Stop the conflicting service or change the port in docker-compose.yml

Cleaning Up

Stop the Test Server

docker compose down

Remove Test Container and Images

docker compose down --rmi all

Full Cleanup (including volumes)

docker compose down --rmi all --volumes

CI/CD Integration

The test suite is designed to run in CI/CD environments. See .github/workflows/ for GitHub Actions examples.

Environment Variables

CRAZY_LOAD_TEST - Set to 1 to enable stress testing with 2,000 parallel connections

Example GitHub Actions Workflow

- name: Start SSH Test Server
  run: |
    cd src/NullOpsDevs.LibSsh.Test
    docker compose up -d

- name: Run Tests
  run: |
    cd src/NullOpsDevs.LibSsh.Test
    dotnet run

- name: Cleanup
  if: always()
  run: |
    cd src/NullOpsDevs.LibSsh.Test
    docker compose down

Test Output

Successful test runs will display colorful output using Spectre.Console:

  _     _ _   ____ ____  _   _ ____    _____         _
 | |   (_) |_/ ___/ ___|| | | |___ \  |_   _|__  ___| |_ ___
 | |   | | __\___ \___ \| |_| | __) |   | |/ _ \/ __| __/ __|
 | |___| | |_ ___) |__) |  _  |/ __/    | |  __/\__ \ |_\__ \
 |_____|_|\__|____/____/|_| |_|_____|   |_|\___||___/\__|___/

✓ Passed: 25
✗ Failed: 0
- Skipped: 0

LibSshNet Help