Update mariadb plugin

.github/workflows/pr-symfony-tests.yml

@@ -19,6 +19,7 @@ jobs:
           - examples/symfony-export
           - examples/symfony-import
           - examples/symfony-init
+          - examples/symfony-mariadb
           - examples/symfony-mysql8
           - examples/symfony-nginx
         lando-version:

CHANGELOG.md

@@ -1,11 +1,17 @@
+## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})
+
+* Updated mariadb plugin [#51](https://github.com/lando/mariadb/issues/51)
+* Cleaned up test comments
+
 ## v1.5.0 - [March 8, 2024](https://github.com/lando/symfony/releases/tag/v1.5.0)
-  * Updated to latest database services.
+
+* Updated to latest database services.
 
 ## v1.4.1 - [March 4, 2024](https://github.com/lando/symfony/releases/tag/v1.4.1)
 
 ### Fixes
 
-* Improved `database` selection for purposes of `config` loading, fixes some `database` bootup issues when the `database` type is overriden downstream
+* Improved `database` selection for purposes of `config` loading, fixes some `database` bootup issues when the `database` type is overridden downstream
 
 ## v1.4.0 - [February 22, 2024](https://github.com/lando/symfony/releases/tag/v1.4.0)
 

builders/symfony.js

@@ -135,8 +135,10 @@ const getDbTooling = database => {
   // Make sure we strip out any version number
   database = database.split(':')[0];
   // Choose wisely
-  if (_.includes(['mysql', 'mariadb'], database)) {
+  if (database === 'mysql') {
     return {mysql: mysqlCli};
+  } else if (database === 'mariadb') {
+    return {mariadb: mariadbCli};
   } else if (database === 'postgres') {
     return {psql: postgresCli};
   } else if (database === 'mongo') {
@@ -147,7 +149,20 @@ const getDbTooling = database => {
   }
 };
 
-// Default DB cli commands
+// MariaDB cli commands
+const mariadbCli = {
+  service: ':host',
+  description: 'Drops into a MariaDB shell on a database service',
+  cmd: 'mariadb -uroot',
+  options: {
+    host: {
+      description: 'The database service to use',
+      default: 'database',
+      alias: ['h'],
+    },
+  },
+};
+// MySQL DB cli commands
 const mysqlCli = {
   service: ':host',
   description: 'Drops into a MySQL shell on a database service',
@@ -160,6 +175,7 @@ const mysqlCli = {
     },
   },
 };
+// Postgres cli commands
 const postgresCli = {
   service: ':host',
   description: 'Drops into a psql shell on a database service',

docs/.vitepress/config.mjs

@@ -55,4 +55,5 @@ function sidebar() {
       ],
     },
   ];
-};
+};
+

examples/symfony-downstreamer-1/README.md

@@ -27,7 +27,7 @@ lando mysql -V | grep 8.0
 # Should use the default database connection info
 lando mysql -usymfony -psymfony symfony -e quit
 
-# Should use the defauly mysql8 config file
+# Should use the default mysql8 config file
 lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOSYMFONYMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
 ```

examples/symfony-downstreamer-2/README.md

@@ -27,7 +27,7 @@ lando mysql -V | grep 8.0
 # Should use the default database connection info
 lando mysql -usymfony -psymfony symfony -e quit
 
-# Should use the defauly mysql8 config file
+# Should use the default mysql8 config file
 lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOSYMFONYMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
 ```

examples/symfony-mariadb/.lando.yml

@@ -0,0 +1,10 @@
+name: symfony-mariadb
+recipe: symfony
+config:
+  webroot: web
+  php: 8.3
+  database: mariadb:11.3
+
+# do not remove this
+plugins:
+  "@lando/symfony": ../..

examples/symfony-mariadb/README.md

@@ -0,0 +1,54 @@
+# Symfony MariaDB Example
+
+This example exists primarily to test the following documentation:
+
+* [Symfony Recipe](https://docs.lando.dev/symfony/config.html)
+
+Start up tests
+--------------
+
+Run the following commands to get up and running with this example.
+
+```bash
+# Should start up successfully
+lando poweroff
+lando start
+```
+
+Verification commands
+---------------------
+
+Run the following commands to validate things are rolling as they should.
+
+```bash
+# Should serve from web folder
+lando ssh -s appserver -c "curl -L localhost" | grep "MariaDB"
+
+# Should be running apache 2.4 by default
+lando ssh -s appserver -c "apachectl -V | grep 2.4"
+lando ssh -s appserver -c "curl -IL localhost" | grep Server | grep 2.4
+
+# Should use php 8.3 if specified by user
+lando php -v | grep "PHP 8.3."
+
+# Should be running mariadb 11.3.x if specified by user
+lando mariadb -V | grep "mariadb" | grep "11.3."
+
+# Should be able to connect to the database with the default creds
+lando mariadb symfony -e quit
+
+# Should use the default mariadb config file
+lando ssh -s database -c "cat /opt/bitnami/mariadb/conf/my_custom.cnf" | grep "innodb_lock_wait_timeout = 121"
+lando mariadb -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 121
+```
+
+Destroy tests
+-------------
+
+Run the following commands to trash this app like nothing ever happened.
+
+```bash
+# Should be destroyed with success
+lando destroy -y
+lando poweroff
+```

examples/symfony-mariadb/web/index.php

@@ -0,0 +1 @@
+MariaDB

examples/symfony-mariadb/web/info.php

@@ -0,0 +1 @@
+<?php phpinfo(); ?>

examples/symfony-mysql8/README.md

@@ -1,4 +1,4 @@
-# Symfony MySQL 8Example
+# Symfony MySQL 8 Example
 
 This example exists primarily to test the following documentation:
 
@@ -31,13 +31,13 @@ lando ssh -s appserver -c "curl -IL localhost" | grep Server | grep 2.4
 # Should use php 5.6 if specified by user
 lando php -v | grep "PHP 5.6"
 
-# Should be running mysql 8 if specified by user
+# Should be running mysql8 if specified by user
 lando mysql -V | grep "mysql"| grep "Ver 8.0.22"
 
 # Should be able to connect to the database with the default creds
 lando mysql symfony -e quit
 
-# Should use the defauly mysql8 config file
+# Should use the default mysql8 config file
 lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOSYMFONYMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
 ```

examples/symfony-nginx/README.md

@@ -27,7 +27,7 @@ lando ssh -s appserver -c "curl -L appserver_nginx" | grep "NGINX"
 # Should run using nginx if specified
 lando ssh -s appserver -c "curl -IL appserver_nginx" | grep Server | grep nginx
 
-# Should use nginx 1.25 by defualt
+# Should use nginx 1.25 by default
 lando nginx -v 2>&1 | grep "nginx version" | grep "nginx/1.25"
 
 # Should use the php version specified by the user eg 7.4