Update mariadb plugin (#62)

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

@@ -27,6 +27,8 @@ jobs:
           - examples/laravel-export
           - examples/laravel-import
           - examples/laravel-init
+          - examples/laravel-mariadb
+          - examples/laravel-mariadb-mysql
           - examples/laravel-mysql8
           - examples/laravel-nginx
 

CHANGELOG.md

@@ -1,12 +1,18 @@
+## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})
+
+* Updated mariadb plugin [#51](https://github.com/lando/mariadb/issues/51)
+* Use mysql command for MariaDB 10.3.x and below
+* Cleaned up test comments
+
 ## v1.4.0 - [March 8, 2024](https://github.com/lando/laravel/releases/tag/v1.4.0)
-  * Updated to latest database services.
 
+* Updated to latest database services.
 
 ## v1.3.1 - [February 29, 2024](https://github.com/lando/laravel/releases/tag/v1.3.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.3.0 - [February 27, 2024](https://github.com/lando/laravel/releases/tag/v1.3.0)
 
@@ -49,8 +55,9 @@
 * Add compatibility for MySQL 8.x [lando/lando#1426](https://github.com/lando/lando/issues/1462)
 
 ## v0.7.0 - [December 12, 2022](https://github.com/lando/laravel/releases/tag/v0.7.0)
-  * Added bundle-dependencies to release process.
-  * Fixed bug in plugin dogfooding test.
+
+* Added bundle-dependencies to release process.
+* Fixed bug in plugin dogfooding test.
 
 ## v0.6.0 - [September 8, 2022](https://github.com/lando/laravel/releases/tag/v0.6.0)
 

builders/laravel.js

@@ -78,7 +78,20 @@ const toolingDefaults = {
   },
 };
 
-// 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 cli commands
 const mysqlCli = {
   service: ':host',
   description: 'Drops into a MySQL shell on a database service',
@@ -91,6 +104,7 @@ const mysqlCli = {
     },
   },
 };
+// Postgres cli commands
 const postgresCli = {
   service: ':host',
   description: 'Drops into a psql shell on a database service',
@@ -171,13 +185,19 @@ const getServices = options => ({
  */
 const getDbTooling = database => {
   // Make sure we strip out any version number
-  database = database.split(':')[0];
+  const db = database.split(':')[0];
+  const ver = database.split(':')[1];
   // Choose wisely
-  if (_.includes(['mysql', 'mariadb'], database)) {
+  if (db === 'mysql') {
+    return {mysql: mysqlCli};
+  } else if (db === 'mariadb' && ver < 10.4) {
+    // Use mysql command for MariaDB 10.3.x and below
     return {mysql: mysqlCli};
-  } else if (database === 'postgres') {
+  } else if (db === 'mariadb') {
+    return {mariadb: mariadbCli};
+  } else if (db === 'postgres') {
     return {psql: postgresCli};
-  } else if (database === 'mongo') {
+  } else if (db === 'mongo') {
     return {mongo: {
       service: 'database',
       description: 'Drop into the mongo shell',

docs/.vitepress/config.mjs

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

examples/7.1/README.md

@@ -19,7 +19,7 @@ rm -rf laravel && mkdir -p laravel && cd laravel
 cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
 lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel --option cache=redis --option php='7.1' --option composer_version='1-latest'
 
-# Should compose create-project a new laravel app
+# Should composer create-project a new laravel app
 cd laravel
 lando composer create-project --prefer-dist laravel/laravel app
 
@@ -42,7 +42,7 @@ lando ssh -s appserver -c "curl -L localhost" | grep "Laravel"
 cd laravel
 lando ssh -s appserver -c 'cd /var/www/.composer && composer show laravel/installer' | grep 'v2.'
 
-# Should use 7.4 as the default php version
+# Should use 7.1 as the default php version
 cd laravel
 lando php -v | grep "PHP 7.1"
 

examples/7.2/README.md

@@ -16,10 +16,10 @@ lando poweroff
 
 # Initialize an empty laravel recipe
 rm -rf laravel && mkdir -p laravel && cd laravel
-lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel --option cache=redis --option php='7.2' --option composer_version='1-latest'
 cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
+lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel --option cache=redis --option php='7.2' --option composer_version='1-latest'
 
-# Should compose create-project a new laravel app
+# Should composer create-project a new laravel app
 cd laravel
 lando composer create-project --prefer-dist laravel/laravel app
 
@@ -42,7 +42,7 @@ lando ssh -s appserver -c "curl -L localhost" | grep "Laravel"
 cd laravel
 lando ssh -s appserver -c 'cd /var/www/.composer && composer show laravel/installer' | grep 'v3.'
 
-# Should use 7.4 as the default php version
+# Should use 7.2 as the default php version
 cd laravel
 lando php -v | grep "PHP 7.2"
 

examples/laravel-downstreamer-1/README.md

@@ -27,7 +27,7 @@ lando mysql -V | grep 8.0
 # Should use the default database connection info
 lando mysql -ularavel -plaravel laravel -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 "LANDOLARAVELMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
 ```

examples/laravel-downstreamer-2/README.md

@@ -27,7 +27,7 @@ lando mysql -V | grep 8.0
 # Should use the default database connection info
 lando mysql -ularavel -plaravel laravel -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 "LANDOLARAVELMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
 ```

examples/laravel-init/README.md

@@ -19,7 +19,7 @@ rm -rf laravel && mkdir -p laravel && cd laravel
 lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel --option cache=redis
 cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
 
-# Should compose create-project a new laravel app
+# Should composer create-project a new laravel app
 cd laravel
 lando composer create-project --prefer-dist laravel/laravel app
 

examples/laravel-mariadb-mysql/.gitignore

@@ -0,0 +1 @@
+mariadb

examples/laravel-mariadb-mysql/README.md

@@ -0,0 +1,92 @@
+Laravel MariaDB/MySQL Example
+=============================
+
+This example exists primarily to test the following documentation:
+
+* [Laravel Recipe](https://docs.devwithlando.io/tutorials/laravel.html)
+
+Versions of MariaDB 10.3.x and lower do not have the mariadb command and must use the mysql executable.
+
+Start up tests
+--------------
+
+Run the following commands to get up and running with this example.
+
+```bash
+# Should poweroff
+lando poweroff
+
+# Initialize an empty laravel recipe
+rm -rf mariadb && mkdir -p mariadb && cd mariadb
+lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel-mariadb --option cache=redis --option php='8.3' --option database=mariadb:10.3
+cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
+
+# Should composer create-project a new laravel app
+cd mariadb
+lando composer create-project --prefer-dist laravel/laravel app
+
+# Should start up successfully
+cd mariadb
+lando start
+```
+
+Verification commands
+---------------------
+
+Run the following commands to validate things are rolling as they should.
+
+```bash
+# Should return the laravel default page
+cd mariadb
+lando ssh -s appserver -c "curl -L localhost" | grep "Laravel"
+
+# Should install 4.x version of laravel/installer
+cd mariadb
+lando ssh -s appserver -c 'cd /var/www/.composer && composer show laravel/installer' | grep 'v4.'
+
+# Should use 8.3 as the default php version
+cd mariadb
+lando php -v | grep "PHP 8.3"
+
+# Should be running apache 2.4 by default
+cd mariadb
+lando ssh -s appserver -c "apachectl -V | grep 2.4"
+lando ssh -s appserver -c "curl -IL localhost" | grep Server | grep 2.4
+
+# Should be running mariadb 10.3.x by default
+cd mariadb
+lando mysql -V | grep "MariaDB" | grep 10.3.
+
+# Should not enable xdebug by default
+cd mariadb
+lando php -m | grep xdebug || echo $? | grep 1
+
+# Should have redis running
+cd mariadb
+lando ssh -s cache -c "redis-cli CONFIG GET databases"
+
+# Should use the default database connection info
+cd mariadb
+lando mysql -ularavel -plaravel laravel -e quit
+
+# Should use the default mariadb config file
+cd mariadb
+lando ssh -s database -c "cat /opt/bitnami/mariadb/conf/my_custom.cnf" | grep "innodb_lock_wait_timeout = 121"
+lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 121
+
+# Should have artisan available
+cd mariadb
+lando artisan env
+```
+
+Destroy tests
+-------------
+
+Run the following commands to trash this app like nothing ever happened.
+
+```bash
+# Should be destroyed with success
+cd mariadb
+lando destroy -y
+lando poweroff
+```

examples/laravel-mariadb/.gitignore

@@ -0,0 +1 @@
+mariadb

examples/laravel-mariadb/README.md

@@ -0,0 +1,90 @@
+Laravel MariaDB Example
+=======================
+
+This example exists primarily to test the following documentation:
+
+* [Laravel Recipe](https://docs.devwithlando.io/tutorials/laravel.html)
+
+Start up tests
+--------------
+
+Run the following commands to get up and running with this example.
+
+```bash
+# Should poweroff
+lando poweroff
+
+# Initialize an empty laravel recipe
+rm -rf mariadb && mkdir -p mariadb && cd mariadb
+lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel-mariadb --option cache=redis --option php='8.3' --option database=mariadb:11.3
+cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
+
+# Should composer create-project a new laravel app
+cd mariadb
+lando composer create-project --prefer-dist laravel/laravel app
+
+# Should start up successfully
+cd mariadb
+lando start
+```
+
+Verification commands
+---------------------
+
+Run the following commands to validate things are rolling as they should.
+
+```bash
+# Should return the laravel default page
+cd mariadb
+lando ssh -s appserver -c "curl -L localhost" | grep "Laravel"
+
+# Should install 4.x version of laravel/installer
+cd mariadb
+lando ssh -s appserver -c 'cd /var/www/.composer && composer show laravel/installer' | grep 'v4.'
+
+# Should use 8.3 as the default php version
+cd mariadb
+lando php -v | grep "PHP 8.3"
+
+# Should be running apache 2.4 by default
+cd mariadb
+lando ssh -s appserver -c "apachectl -V | grep 2.4"
+lando ssh -s appserver -c "curl -IL localhost" | grep Server | grep 2.4
+
+# Should be running mariadb 11.3.x by default
+cd mariadb
+lando mariadb -V | grep 11.3.
+
+# Should not enable xdebug by default
+cd mariadb
+lando php -m | grep xdebug || echo $? | grep 1
+
+# Should have redis running
+cd mariadb
+lando ssh -s cache -c "redis-cli CONFIG GET databases"
+
+# Should use the default database connection info
+cd mariadb
+lando mariadb -ularavel -plaravel laravel -e quit
+
+# Should use the default mariadb config file
+cd mariadb
+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
+
+# Should have artisan available
+cd mariadb
+lando artisan env
+```
+
+Destroy tests
+-------------
+
+Run the following commands to trash this app like nothing ever happened.
+
+```bash
+# Should be destroyed with success
+cd mariadb
+lando destroy -y
+lando poweroff
+```

examples/laravel-mysql8/README.md

@@ -1,5 +1,5 @@
-Laravel PHP 8.1 Example
-===============
+Laravel MySQL 8 Example
+=======================
 
 This example exists primarily to test the following documentation:
 
@@ -19,7 +19,7 @@ rm -rf mysql8 && mkdir -p mysql8 && cd mysql8
 lando init --source cwd --recipe laravel --webroot app/public --name lando-laravel-mysql8 --option cache=redis --option php='8.1' --option database=mysql:8.0.22
 cp -f ../../.lando.upstream.yml .lando.upstream.yml && cat .lando.upstream.yml
 
-# Should compose create-project a new laravel app
+# Should composer create-project a new laravel app
 cd mysql8
 lando composer create-project --prefer-dist laravel/laravel app
 
@@ -42,7 +42,7 @@ lando ssh -s appserver -c "curl -L localhost" | grep "Laravel"
 cd mysql8
 lando ssh -s appserver -c 'cd /var/www/.composer && composer show laravel/installer' | grep 'v4.'
 
-# Should use 7.4 as the default php version
+# Should use 8.1 as the default php version
 cd mysql8
 lando php -v | grep "PHP 8.1"
 
@@ -67,7 +67,7 @@ lando ssh -s cache -c "redis-cli CONFIG GET databases"
 cd mysql8
 lando mysql -ularavel -plaravel laravel -e quit
 
-# Should use the defauly mysql8 config file
+# Should use the default mysql8 config file
 cd mysql8
 lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOLARAVELMYSQL8CNF"
 lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127