Merge branch 'main' into patch-6

Author: simonLeary42

.github/workflows/functional.yml

@@ -0,0 +1,27 @@
+name: docker-compose-phpunit-functional
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  docker-compose-phpunit-functional:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: "8.3"
+        tools: composer
+    - name: install composer dependencies
+      run: composer update
+    - name: Run docker compose
+      uses: hoverkraft-tech/[email protected]
+      with:
+        compose-file: "./tools/docker-dev/docker-compose.yml"
+    - name: Execute tests in the running services
+      run: docker compose -f ./tools/docker-dev/docker-compose.yml exec -w '/var/www/unity-web-portal' web ./vendor/bin/phpunit --testsuite=functional

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: phpunit
+
+on: [push]
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: "8.3"
+        # php extensions also listed in tools/docker-dev/web/Dockerfile and README.md
+        extensions: curl,mysql,ldap,pdo,redis,intl
+        tools: composer:v2
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+    - name: Run PHPUnit tests
+      run: vendor/bin/phpunit --colors=always --testsuite unit

.github/workflows/phpunit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - uses: actions/setup-python@v3
+    - name: setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: "8.3"
+        tools: composer, phpcs, phpcbf
+    - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yml

@@ -16,3 +16,5 @@ composer.lock
 deployment/*
 !deployment/**/README.md
 !deployment/deploy.sh
+
+.phpunit.result.cache

.gitignore

@@ -0,0 +1,3 @@
+[submodule "hakasapl/phpopenldaper"]
+	path = resources/lib/phpopenldaper
+	url = https://github.com/hakasapl/phpopenldaper.git

.gitmodules

@@ -0,0 +1,56 @@
+# intentionally malformed files
+# pre-commit automatically excludes submodules
+exclude: |
+  (?x)^(
+      test/.*|
+  )$
+
+repos:
+  # auto formatters (no work required) #############################################################
+  # - repo: https://github.com/pre-commit/pre-commit-hooks
+  #   rev: v5.0.0
+  #   hooks:
+  #     - id: trailing-whitespace
+  #     - id: end-of-file-fixer
+  - repo: local
+    hooks:
+      - id: phpcbf
+        name: PHP Code Beautifier and Fixer
+        entry: phpcbf
+        language: system
+        files: \.php$
+        args: [--standard=PSR2, --colors]
+
+  # linters (work required) ########################################################################
+  # - repo: https://github.com/pre-commit/pre-commit-hooks
+  #   rev: v5.0.0
+  #   hooks:
+  #     - id: check-yaml
+  #     - id: check-json
+  #     - id: check-xml
+  #     - id: check-added-large-files
+  #     - id: check-executables-have-shebangs
+  # - repo: https://github.com/gitleaks/gitleaks
+  #   rev: v8.23.1
+  #   hooks:
+  #     - id: gitleaks
+  - repo: local
+    hooks:
+      - id: phpcs
+        name: PHP CodeSniffer
+        entry: phpcs
+        language: system
+        files: \.php$
+        args: [--standard=PSR2, --colors]
+      - id: php-l
+        name: php -l
+        entry: php
+        language: system
+        files: \.php$
+        args: [-l]
+      - id: assert-no-die-exit
+        name: Assert no die()/exit()
+        entry: ./test/assert-no-die-exit.bash
+        language: system
+        files: \.php$
+        exclude: resources/lib/UnitySite\.php$

.pre-commit-config.yaml

@@ -51,4 +51,4 @@ The following users are available for testing:
 
 ### Changes to Dev Environment
 
-Should the default schema of the web portal change, the `ldap/bootstrap.ldif` and `sql/bootstrap.sql` must be updated for the LDAP server and the MySQL server, respectively.
+Should the default schema of the web portal change, the `ldap/bootstrap.ldif` and `sql/bootstrap.sql` must be updated for the LDAP server and the MySQL server, respectively.

CONTRIBUTING.md

@@ -21,15 +21,19 @@ Unity Web Portal is a PHP application built in top of MariaDB and LDAP which act
     1. Some HTTP Authentication mechanism (such as Shibboleth SP)
     1. Composer (`apt install composer` on Ubuntu)
     1. PHP Extensions
+        1. `php-cli`
+        1. `php-curl`
+        1. `php-intl`
         1. `php-ldap`
-        2. `php-curl`
-        3. `php-redis`
-        4. `php-cli`
-        5. `php-mysql`
-        6. `php-pdo`
+        1. `php-mbstring`
+        1. `php-mysql`
+        1. `php-pdo`
+        1. `php-redis`
+        1. `php-xml`
 2. Composer packages
     1. `cd` to this repository
-    2. Install packages `composer update`
+    1. Setup git submodules `git submodule update --init --checkout`
+    1. Install packages `composer update`
 3. Setup config file `config/config.ini` according to your site deployment
 4. Setup branding file `config/branding/config.ini` according to your site deployment
 5. Point your web server's document root to `webroot` in this repo

README.md

@@ -1,8 +1,10 @@
 {
     "require": {
         "psr/log": "1.1.4",
-        "phpseclib/phpseclib": "3.0.16",
-        "phpmailer/phpmailer": "6.6.4",
-        "hakasapl/phpopenldaper": "1.0.5"
+        "phpseclib/phpseclib": "3.0.43",
+        "phpmailer/phpmailer": "6.6.4"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "<12.1"
     }
 }