Migrate CI to GitHub Actions and extend SSH features

Fixes #7

Fixes #9

Fixes #11

Fixes #12

Author: Jord-JD

.coveralls.yml

@@ -0,0 +1,80 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - php: '7.0'
+            composer: 'v1'
+          - php: '7.4'
+            composer: 'v2'
+          - php: '8.0'
+            composer: 'v2'
+          - php: '8.4'
+            composer: 'v2'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer:${{ matrix.composer }}
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --no-interaction --prefer-dist --no-progress
+
+      - name: Configure SSH integration server
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y openssh-server
+
+          sudo userdel -r ci-test >/dev/null 2>&1 || true
+          sudo useradd -m -s /bin/bash ci-test
+          echo 'ci-test:ci-test-password' | sudo chpasswd
+
+          mkdir -p "$HOME/.ssh"
+          ssh-keygen -q -t rsa -b 4096 -N '' -f "$HOME/.ssh/php_ssh_connection_ci_key"
+
+          sudo mkdir -p /home/ci-test/.ssh
+          cat "$HOME/.ssh/php_ssh_connection_ci_key.pub" | sudo tee /home/ci-test/.ssh/authorized_keys >/dev/null
+          sudo chown -R ci-test:ci-test /home/ci-test/.ssh
+          sudo chmod 700 /home/ci-test/.ssh
+          sudo chmod 600 /home/ci-test/.ssh/authorized_keys
+
+          if grep -q '^#\?PasswordAuthentication ' /etc/ssh/sshd_config; then
+            sudo sed -i 's/^#\?PasswordAuthentication .*/PasswordAuthentication yes/' /etc/ssh/sshd_config
+          else
+            echo 'PasswordAuthentication yes' | sudo tee -a /etc/ssh/sshd_config >/dev/null
+          fi
+
+          if grep -q '^#\?PubkeyAuthentication ' /etc/ssh/sshd_config; then
+            sudo sed -i 's/^#\?PubkeyAuthentication .*/PubkeyAuthentication yes/' /etc/ssh/sshd_config
+          else
+            echo 'PubkeyAuthentication yes' | sudo tee -a /etc/ssh/sshd_config >/dev/null
+          fi
+
+          sudo service ssh restart
+
+      - name: Run tests
+        env:
+          RUN_SSH_INTEGRATION_TESTS: '1'
+          SSH_TEST_HOST: 127.0.0.1
+          SSH_TEST_PORT: '22'
+          SSH_TEST_USER: ci-test
+          SSH_TEST_PASSWORD: ci-test-password
+        run: |
+          export SSH_TEST_PRIVATE_KEY_PATH="$HOME/.ssh/php_ssh_connection_ci_key"
+          vendor/bin/phpunit

.github/workflows/tests.yml

@@ -1,55 +1,86 @@
 # PHP SSH Connection
 
-[![Build Status](https://travis-ci.com/Jord-JD/php-ssh-connection.svg?branch=master)](https://travis-ci.com/Jord-JD/php-ssh-connection)
-[![Coverage Status](https://coveralls.io/repos/github/Jord-JD/php-ssh-connection/badge.svg?branch=master)](https://coveralls.io/github/Jord-JD/php-ssh-connection?branch=master)
+[![Tests](https://github.com/Jord-JD/php-ssh-connection/actions/workflows/tests.yml/badge.svg)](https://github.com/Jord-JD/php-ssh-connection/actions/workflows/tests.yml)
 
-The PHP SSH Connection package provides an elegant syntax to connect to SSH servers and execute commands. It supports both password and public-private keypair authentication, and can easily capture command output and errors.
+The PHP SSH Connection package provides an elegant syntax to connect to SSH servers and execute commands. It supports password and public-private key authentication, and can capture command output and errors.
 
 ## Installation
 
-You can install the PHP SSH Connection package by running the following Composer command.
+Install with Composer:
 
 ```bash
 composer require jord-jd/php-ssh-connection
 ```
 
 ## Usage
 
-See the following basic usage instructions.
-
 ```php
 $connection = (new SSHConnection())
             ->to('test.rebex.net')
             ->onPort(22)
             ->as('demo')
             ->withPassword('password')
          // ->withPrivateKey($privateKeyPath)
-         // ->timeout(0)
+         // ->withPrivateKeyString($privateKeyContents)
+         // ->timeout(30)
             ->connect();
 
 $command = $connection->run('echo "Hello world!"');
 
-$command->getOutput();  // 'Hello World'
+$command->getOutput();  // 'Hello world!'
 $command->getError();   // ''
 
 $connection->upload($localPath, $remotePath);
-$connection->download($remotePath, $localPath);
+$connection->download($remotePath, $localPath); // supports recursive directory downloads
 ```
 
-For security, you can fingerprint the remote server and verify the fingerprint remains the same 
-upon each subsequent connection.
+### Running multiple commands
+
+Each `run()` call executes in a fresh shell context. If you need stateful command execution (for example `cd` then `touch`), use `runCommands()`:
+
+```php
+$connection->runCommands([
+    'cd /var/www/html',
+    'mkdir -p app',
+    'cd app',
+    'touch index.php',
+]);
+```
+
+### Fingerprint verification
+
+For security, you can fingerprint the remote server and verify it remains the same across connections.
 
 ```php
-$fingerprint = $connection->fingerprint();
+$fingerprint = $connection->fingerprint(); // defaults to MD5 for backward compatibility
 
-if ($newConnection->fingerprint() != $fingerprint) {
+if ($newConnection->fingerprint() !== $fingerprint) {
     throw new Exception('Fingerprint does not match!');
 }
 ```
 
-If you wish, you can specify the type of fingerprint you wish to retrieve.
+Available fingerprint types:
 
 ```php
-$md5Fingerprint  = $connection->fingerprint(SSHConnection::FINGERPRINT_MD5); // default
-$sha1Fingerprint = $connection->fingerprint(SSHConnection::FINGERPRINT_SHA1);
+$md5Fingerprint    = $connection->fingerprint(SSHConnection::FINGERPRINT_MD5);
+$sha1Fingerprint   = $connection->fingerprint(SSHConnection::FINGERPRINT_SHA1);
+$sha256Fingerprint = $connection->fingerprint(SSHConnection::FINGERPRINT_SHA256);
+$sha512Fingerprint = $connection->fingerprint(SSHConnection::FINGERPRINT_SHA512);
+```
+
+## Testing
+
+The package test suite includes SSH integration tests. Set these variables before running tests:
+
+- `RUN_SSH_INTEGRATION_TESTS=1`
+- `SSH_TEST_HOST`
+- `SSH_TEST_PORT`
+- `SSH_TEST_USER`
+- `SSH_TEST_PRIVATE_KEY_PATH` or `SSH_TEST_PRIVATE_KEY_CONTENTS`
+- `SSH_TEST_PASSWORD` (only required for password-auth test)
+
+Then run:
+
+```bash
+vendor/bin/phpunit
 ```

.travis.yml

@@ -10,11 +10,11 @@
     }
   ],
   "require": {
-    "php": ">=7.1",
+    "php": ">=7.0",
     "phpseclib/phpseclib": "^2.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.6"
+    "phpunit/phpunit": "^6.5 || ^7.5 || ^8.5 || ^9.6 || ^10.5 || ^11.5"
   },
   "autoload": {
     "psr-4": {
@@ -26,7 +26,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "3.0-dev"
+      "dev-master": "3.1-dev"
     }
   }
 }

README.md

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="vendor/autoload.php"
-         colors="true"
-         cacheResult="false">
+         colors="true">
     <testsuites>
         <testsuite name="Unit Tests">
             <directory suffix="Test.php">./tests/Integration</directory>