Merge pull request #161 from geichelberger/add-db-port-option

Add --db-port option

Author: stronk7

docs/CHANGELOG.md

@@ -9,6 +9,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 The format of this change log follows the advice given at [Keep a CHANGELOG](http://keepachangelog.com).
 
 ## [Unreleased]
+### Added
+- `moodle-plugin-ci install` now provides an option `--db-port` to define a custom database port.
 
 ## [3.3.0] - 2022-06-28
 ### Added

docs/CLI.md

@@ -813,7 +813,7 @@ Install everything required for CI testing
 
 ### Usage
 
-* `install [--moodle MOODLE] [--data DATA] [--repo REPO] [--branch BRANCH] [--plugin PLUGIN] [--db-type DB-TYPE] [--db-user DB-USER] [--db-pass DB-PASS] [--db-name DB-NAME] [--db-host DB-HOST] [--not-paths NOT-PATHS] [--not-names NOT-NAMES] [--extra-plugins EXTRA-PLUGINS] [--no-init] [--node-version NODE-VERSION]`
+* `install [--moodle MOODLE] [--data DATA] [--repo REPO] [--branch BRANCH] [--plugin PLUGIN] [--db-type DB-TYPE] [--db-user DB-USER] [--db-pass DB-PASS] [--db-name DB-NAME] [--db-host DB-HOST] [--db-port DB-PORT] [--not-paths NOT-PATHS] [--not-names NOT-NAMES] [--extra-plugins EXTRA-PLUGINS] [--no-init] [--node-version NODE-VERSION]`
 
 Install everything required for CI testing
 
@@ -909,6 +909,15 @@ Database host
 * Is multiple: no
 * Default: `'localhost'`
 
+#### `--db-port`
+
+Database port
+
+* Accept value: yes
+* Is value required: yes
+* Is multiple: no
+* Default: `''`
+
 #### `--not-paths`
 
 CSV of file paths to exclude

psalm-baseline.xml

@@ -48,7 +48,7 @@
     </PossiblyNullIterator>
   </file>
   <file src="src/Command/InstallCommand.php">
-    <PossiblyInvalidArgument occurrences="12">
+    <PossiblyInvalidArgument occurrences="13">
       <code>$input-&gt;getOption('plugin')</code>
       <code>$pluginsDir</code>
       <code>$input-&gt;getOption('moodle')</code>
@@ -59,6 +59,7 @@
       <code>$input-&gt;getOption('db-user')</code>
       <code>$input-&gt;getOption('db-pass')</code>
       <code>$input-&gt;getOption('db-host')</code>
+      <code>$input-&gt;getOption('db-port')</code>
       <code>$input-&gt;getOption('not-paths')</code>
       <code>$input-&gt;getOption('not-names')</code>
     </PossiblyInvalidArgument>

res/template/config.php.txt

@@ -11,7 +11,9 @@ $CFG->dbname    = '{{DBNAME}}';
 $CFG->dbuser    = '{{DBUSER}}';
 $CFG->dbpass    = '{{DBPASS}}';
 $CFG->prefix    = 'mdl_';
-$CFG->dboptions = [];
+$CFG->dboptions = [
+    'dbport' => '{{DBPORT}}',
+];
 
 $CFG->wwwroot  = '{{WWWROOT}}';
 $CFG->dataroot = '{{DATAROOT}}';

src/Bridge/MoodleConfig.php

@@ -37,6 +37,7 @@ public function createContents(AbstractDatabase $database, $dataDir)
             '{{DBTYPE}}'          => $database->type,
             '{{DBLIBRARY}}'       => $database->library,
             '{{DBHOST}}'          => $database->host,
+            '{{DBPORT}}'          => $database->port,
             '{{DBNAME}}'          => $database->name,
             '{{DBUSER}}'          => $database->user,
             '{{DBPASS}}'          => $database->pass,

src/Command/InstallCommand.php

@@ -94,6 +94,7 @@ protected function configure()
             ->addOption('db-pass', null, InputOption::VALUE_REQUIRED, 'Database pass', '')
             ->addOption('db-name', null, InputOption::VALUE_REQUIRED, 'Database name', 'moodle')
             ->addOption('db-host', null, InputOption::VALUE_REQUIRED, 'Database host', 'localhost')
+            ->addOption('db-port', null, InputOption::VALUE_REQUIRED, 'Database port', '')
             ->addOption('not-paths', null, InputOption::VALUE_REQUIRED, 'CSV of file paths to exclude', $paths)
             ->addOption('not-names', null, InputOption::VALUE_REQUIRED, 'CSV of file names to exclude', $names)
             ->addOption('extra-plugins', null, InputOption::VALUE_REQUIRED, 'Directory of extra plugins to install', $extra)
@@ -174,7 +175,8 @@ public function initializeInstallerFactory(InputInterface $input)
             $input->getOption('db-name'),
             $input->getOption('db-user'),
             $input->getOption('db-pass'),
-            $input->getOption('db-host')
+            $input->getOption('db-host'),
+            $input->getOption('db-port')
         );
 
         return $factory;

src/Installer/Database/AbstractDatabase.php

@@ -45,6 +45,13 @@ abstract class AbstractDatabase
      */
     public $host = 'localhost';
 
+    /**
+     * Database port.
+     *
+     * @var string
+     */
+    public $port = '';
+
     /**
      * Moodle database type.
      *

src/Installer/Database/DatabaseResolver.php

@@ -23,10 +23,11 @@ class DatabaseResolver
      * @param string|null $user
      * @param string|null $pass
      * @param string|null $host
+     * @param string|null $port
      *
      * @return AbstractDatabase
      */
-    public function resolveDatabase($type, $name = null, $user = null, $pass = null, $host = null)
+    public function resolveDatabase($type, $name = null, $user = null, $pass = null, $host = null, $port = null)
     {
         $database = $this->resolveDatabaseType($type);
 
@@ -42,6 +43,9 @@ public function resolveDatabase($type, $name = null, $user = null, $pass = null,
         if ($host !== null) {
             $database->host = $host;
         }
+        if ($port !== null) {
+            $database->port = $port;
+        }
 
         return $database;
     }

src/Installer/Database/MySQLDatabase.php

@@ -24,8 +24,9 @@ public function getCreateDatabaseCommand()
         $passOpt  = !empty($this->pass) ? ' --password='.escapeshellarg($this->pass) : '';
         $user     = escapeshellarg($this->user);
         $host     = escapeshellarg($this->host);
+        $port     = !empty($this->port) ? ' --port='.escapeshellarg($this->port) : '';
         $createDB = escapeshellarg(sprintf('CREATE DATABASE `%s` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;', $this->name));
 
-        return sprintf('mysql -u %s%s -h %s -e %s', $user, $passOpt, $host, $createDB);
+        return sprintf('mysql -u %s%s -h %s%s -e %s', $user, $passOpt, $host, $port, $createDB);
     }
 }

src/Installer/Database/PostgresDatabase.php

@@ -25,8 +25,9 @@ public function getCreateDatabaseCommand()
         $pass     = !empty($this->pass) ? 'env PGPASSWORD='.escapeshellarg($this->pass).' ' : '';
         $user     = escapeshellarg($this->user);
         $host     = escapeshellarg($this->host);
+        $port     = !empty($this->port) ? ' --port '.escapeshellarg($this->port) : '';
         $createDB = escapeshellarg(sprintf('CREATE DATABASE "%s";', $this->name));
 
-        return sprintf('%spsql -c %s -U %s -h %s', $pass, $createDB, $user, $host);
+        return sprintf('%spsql -c %s -U %s -h %s%s', $pass, $createDB, $user, $host, $port);
     }
 }