Merge pull request #388 from GOCDB/release-5.10.0

Release 5.10.0 to master

.codeclimate.yml

@@ -0,0 +1,11 @@
+version: "2"
+plugins:
+  phpcodesniffer:
+    enabled: true
+    config:
+      standard: "phpcs.xml"
+  phpmd:
+    enabled: true
+    config:
+      file_extensions: "php"
+      rulesets: "phpmd.xml"

.github/actions/run_tests.sh

@@ -5,7 +5,7 @@ if [[ $GITHUB_ACTIONS ]]; then
     git diff --name-only --diff-filter=ACMRTUXB HEAD^ | grep '\.php$' | xargs -r -n 1 php -l || exit 1
 
     # Run test suite
-    vendor/bin/phpunit --coverage-clover=coverage.xml tests/DoctrineTestSuite1.php
+    vendor/bin/phpunit -c tests/phpunit.xml --coverage-clover=coverage.xml tests/DoctrineTestSuite1.php
 else
     echo 'ABORTED: NOT RUNNING ON GITHUB ACTIONS'
     exit 2

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+      # For GitHub Actions, "/" checks for workflow files in .github/workflows.
+    directory: "/"
+    schedule:
+      # By default, this is on Monday.
+      interval: "weekly"

.github/workflows/continuous-integration.yml

@@ -18,7 +18,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v3"
         with:
           fetch-depth: 2
 
@@ -33,7 +33,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
@@ -52,7 +52,7 @@ jobs:
         run: .github/actions/run_tests.sh
 
       - name: "Upload to Codecov"
-        uses: "codecov/codecov-action@v1"
+        uses: "codecov/codecov-action@v3"
 
 
   phpunit-mariadb:
@@ -106,7 +106,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v3"
         with:
           fetch-depth: 2
 
@@ -122,7 +122,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
@@ -141,4 +141,4 @@ jobs:
         run: .github/actions/run_tests.sh
 
       - name: "Upload to Codecov"
-        uses: "codecov/codecov-action@v1"
+        uses: "codecov/codecov-action@v3"

.gitignore

@@ -5,6 +5,7 @@
 
 # Project specific
 # ====================
+aup.pdf
 bootstrap_doctrine.php
 bootstrap_pdo.php
 bootstrap_doctrine_mysql.php
@@ -16,6 +17,7 @@ composer.bat
 composer
 gocdb.log
 tests/coverageReports/
+privacy.pdf
 /.htaccess
 
 # Eclipse: https://github.com/github/gitignore/blob/master/Global/Eclipse.gitignore

INSTALL.md

@@ -22,7 +22,7 @@ This file is best viewed using a browser-plugin for markdown `.md` files.
 
 * [Apache Http](#apache-and-x509-host-cert)
   * Version 2.2 or higher with `mod_ssl` module
-  * X509 host certificate.
+  * X.509 host certificate.
 
 * [Database server](#database-server)
   * Oracle 11g+ or MariaDB/MySQL
@@ -108,7 +108,7 @@ update your php.ini by adding `extension=[php_]timezonedb.so|dll` (note, Win pre
 * All dates are stored as UTC in the DB and converted from local timezones.
 * Do not forget to configure your timezone settings correctly.
 
-### Apache and x509 Host cert <a id="apache"></a>
+### Apache and X.509 Host cert <a id="apache"></a>
 
 A sample Apache config file is provided `config/gocdbssl.conf`. This file
 defines a sample apache virtual host for serving your GocDB portal, including URL mappings/aliases and SSL settings.
@@ -422,15 +422,23 @@ $ cd lib/Doctrine
 $ php deploy/DeployRequiredDataRunner.php requiredData
 ```
 
-### Deploy Sample Data<a id="deploy-sample-data"></a>
+### OPTIONAL: Deploy Sample Data<a id="deploy-sample-data"></a>
 
-Optional - you can deploy some sample data to seed your DB with sample users,
-sites and services.
+You can choose to deploy some sample data to seed your DB with sample users,
+sites and services. Two sample data sets are available. Choose one of -
 
-```bash
-$ cd lib/Doctrine
-$ php deploy/DeploySampleDataRunner.php sampleData
-```
+1. Minimal - just enough to get going with no real-world associations.
+
+    ```bash
+    $ cd lib/Doctrine
+    $ php deploy/DeploySampleDataRunner.php simpleSampleData
+    ```
+1. "Real World" - a small subset derived from real data.
+
+    ```bash
+    $ cd lib/Doctrine
+    $ php deploy/DeploySampleDataRunner.php sampleData
+    ```
 
 ### ORACLE ONLY: Deploy an existing DB .dmp file to populate your DB<a id="deploy-existing-dump"></a>
 
@@ -549,7 +557,7 @@ and editing which URL page mappings use the `rejectIfNotAuthenticated()` invocat
 ### Authentication
 
 Authentication is handled by the `lib/Authentication` package, and is configured
-for x509 client certificate authentication by default. Different authentication
+for X.509 client certificate authentication by default. Different authentication
 schemes can be configured using the abstractions in this package such as SAML2
 for integration with Federated Identity Management.
 See `lib/Authentication/README.md` for details.

README.md

@@ -1,14 +1,14 @@
 # GOCDB
 
-[![Build Status](https://travis-ci.org/GOCDB/gocdb.svg?branch=dev)](https://travis-ci.org/GOCDB/gocdb)
+[![_Continuous Integration](https://github.com/GOCDB/gocdb/actions/workflows/continuous-integration.yml/badge.svg?branch=dev)](https://github.com/GOCDB/gocdb/actions/workflows/continuous-integration.yml?query=branch%3Adev)
 
 Grid Operations Configuration Management Database. A Repository, Portal and REST style API for managing Grid and Cloud topology objects including; projects, administrative domains, sites, services, service-endpoints, service-groups, downtimes, users, roles and business rules.
 
 <span>
-  <img alt="STFC logo" src="htdocs/web_portal/img/UKRI_STF_Council-Logo_Horiz-RGB_crop.png" height=57/>
-  <img alt="EU flag" src="htdocs/web_portal/img/eu_flag_yellow_low_150.png" height=57 />
-  <img alt="EGI logo" src="htdocs/web_portal/img/egi_logo.jpg" height=57 />
-  <img alt="EOSC-hub logo" src="htdocs/web_portal/img/eosc-hub-v-web_150.png" height=57 />
+  <img alt="STFC logo" src="htdocs/images/UKRI_STF_Council-Logo_Horiz-RGB_crop.png" height=57/>
+  <img alt="EU flag" src="htdocs/images/eu_flag_yellow_low_150.png" height=57 />
+  <img alt="EGI logo" src="htdocs/images/egi_logo.jpg" height=57 />
+  <img alt="EOSC-hub logo" src="htdocs/images/eosc-hub-v-web_150.png" height=57 />
 </span>
 
 GOCDB is provided by [STFC](https://stfc.ukri.org/) for [EGI](https://www.egi.eu/federation/), co-funded by [EGI.eu](https://www.egi.eu/) and [EOSC-hub](https://www.eosc-hub.eu/). Licensed under the [Apache 2 License](http://www.apache.org/licenses/LICENSE-2.0).

composer.json

@@ -2,12 +2,11 @@
     "name": "stfc-egi/gocdb",
     "description": "A web portal and REST style API for e-Infrastructure topology managment",
     "require": {
-	"doctrine/orm": "2.4.8",
-	"doctrine/dbal": "2.5.4"
-    }, 
+	"doctrine/orm": "2.5.14"
+    },
     "require-dev": {
         "phpunit/phpunit": "4.8.*",
         "phpunit/dbunit": ">=1.2",
-        "taq/pdooci": "^1.0" 
+        "taq/pdooci": "^1.0"
     }
 }