Remove virtualenv data xdg directory symlinks (#1148)

## Summary
Remove virtualenv data xdg directory symlinks. The current state is
quite hard to reason about for the following reason:

### Diverging source of truth
We have `.devbox/virtualenv` which supposedly should be the source of
truth for plugins. However, upon inspection, it looks like the paths and
variables set for `{{ .Virtualenv }}` is pointing at my XDG directory.

Because of such divergence, any operations that directly modifies the
XDG directory is not reflected in the `.devbox/virtualenv` directory.

However, the rest of the devbox CLI regards `.devbox/virtualenv` as the
source of truth.

This is the root cause of quite a few plugin errors such as mariadb,
drupal, and python venv.

### Obscure XDG path
The reason we have a hash directory in our XDG path is to avoid path
collision. But since I use devbox so often, my XDG paths become a clown
show:
<img width="920" alt="Screenshot 2023-06-13 at 12 18 10 PM"
src="https://github.com/jetpack-io/devbox/assets/2292093/b539362e-bfd7-4594-a7da-6bf76ad2e11c">

This makes it impossible to debug plugins.

To get around the paths too long error described in
#874, I override the env
variable that points to the `.sock` path in our `run_test` scripts.

### TODO

- [x]  Clean up symlink creation functions
- [x] Remove symlink tests

## How was it tested?
```
devbox run build
cd examples/databases/mariadb
devbox install
devbox services up
```

Author: LucilleH

docs/app/docs/devbox_examples/databases/mariadb.md

@@ -60,3 +60,10 @@ These files are used to setup your database and service, and should not be modif
 * This plugin wraps mysqld and mysql_install_db to work in your local project. For more information, see the `flake.nix` created in your `.devbox/virtenv/mariadb` folder.
 * This plugin will create a new database for your project in MYSQL_DATADIR if one doesn't exist on shell init.
 * You can use `mysqld` to manually start the server, and `mysqladmin -u root shutdown` to manually stop it
+* `.sock` filepath can only be maximum 100 characters long. You can point to a different path by setting the `MYSQL_UNIX_PORT` env variable in your `devbox.json` as follows:
+
+```json
+"env": {
+    "MYSQL_UNIX_PORT": "/<some-other-path>/mysql.sock"
+}
+```

docs/app/docs/devbox_examples/stacks/lapp.md

@@ -21,8 +21,8 @@ This example shows how to build a simple application using Apache, PHP, and Post
 1. Add the packages using the command below. Installing the packages with `devbox add` will ensure that the plugins are activated:
 
 ```bash
-devbox add postgres php81 php81Extensions.pgsql apacheHttpd
+devbox add postgresql@14 [email protected] php81Extensions.pgsql@latest [email protected]
 ```
 
-1. Update `devbox.d/apacheHttpd/httpd.conf` to point to the directory with your PHP files. You'll need to update the `DocumentRoot` and `Directory` directives.
+1. Update `devbox.d/apache/httpd.conf` to point to the directory with your PHP files. You'll need to update the `DocumentRoot` and `Directory` directives.
 1. Follow the instructions above in the How to Run section to initialize your project

docs/app/docs/devbox_examples/stacks/lepp.md

@@ -19,7 +19,7 @@ In this directory, run:
 
 This will run `initdb` automatically on initialization. To start the Servers + Postgres service, run:
 
-`devbox services start`
+`devbox services up`
 
 ### Creating the DB
 
@@ -35,8 +35,16 @@ You can query Nginx on port 80, which will route to the PHP example.
 1. Add the packages using the command below. Installing the packages with `devbox add` will ensure that the plugins are activated:
 
 ```bash
-devbox add postgres php81 php81Extensions.pgsql nginx
+devbox add postgresql@14 [email protected] php81Extensions.pgsql@latest nginx@1.24
 ```
 
 1. Update `devbox.d/nginx/httpd.conf` to point to the directory with your PHP files. You'll need to update the `root` directive to point to your project folder
 2. Follow the instructions above in the How to Run section to initialize your project.
+
+Note that the `.sock` filepath can only be maximum 100 characters long. You can point to a different path by setting the `PGHOST` env variable in your `devbox.json` as follows:
+
+```json
+"env": {
+    "PGHOST": "/<some-shorter-path>"
+}
+```

examples/databases/mariadb/README.md

@@ -0,0 +1,31 @@
+# mariadb
+
+## mariadb Notes
+
+1. Start the mariadb server using `devbox services up`
+1. Create a database using `"mysql -u root < setup_db.sql"`
+1. You can now connect to the database from the command line by running `devbox run connect_db`
+
+## Services
+
+* mariadb
+
+Use `devbox services start|stop [service]` to interact with services
+
+## This plugin sets the following environment variables
+
+* MYSQL_BASEDIR=/<projectDir>/.devbox/nix/profile/default
+* MYSQL_HOME=/<projectDir>/.devbox/virtenv/mariadb/run
+* MYSQL_DATADIR=/<projectDir>/.devbox/virtenv/mariadb/data
+* MYSQL_UNIX_PORT=/<projectDir>/.devbox/virtenv/mariadb/run/mysql.sock
+* MYSQL_PID_FILE=/<projectDir>/.devbox/virtenv/mariadb/run/mysql.pid
+
+To show this information, run `devbox info mariadb`
+
+Note that the `.sock` filepath can only be maximum 100 characters long. You can point to a different path by setting the `MYSQL_UNIX_PORT` env variable in your `devbox.json` as follows:
+
+```
+"env": {
+    "MYSQL_UNIX_PORT": "/<some-other-path>/mysql.sock"
+}
+```

examples/databases/mariadb/devbox.json

@@ -9,6 +9,8 @@
         "mysql -u devbox_user -p -D devbox_lamp"
       ],
       "test_db_setup": [
+        "mkdir -p /tmp/devbox/mariadb/run",
+        "export MYSQL_UNIX_PORT=/tmp/devbox/mariadb/run/mysql.sock",
         "devbox services up -b",
         "sleep 5",
         "mysql -u root < setup_db.sql",

examples/databases/mariadb/devbox.lock

@@ -1,9 +1,6 @@
 {
   "lockfile_version": "1",
   "packages": {
-    "mariadb": {
-      "resolved": "github:NixOS/nixpkgs/f80ac848e3d6f0c12c52758c0f25c10c97ca3b62#mariadb"
-    },
     "mariadb@latest": {
       "last_modified": "2023-05-01T16:53:22Z",
       "plugin_version": "0.0.1",

examples/databases/postgres/README.md

@@ -5,9 +5,9 @@
 You need to initialize and create a database as part of your setup.
 
 1. Initialize a DB by running `initdb`
-2. Start the Postgres server using `devbox services start`
-3. Create a database using `createdb <name_of_db>`
-4. You can now connect to the database from the command line by running `psql <name_of_db>`
+1. Start the Postgres server using `devbox services up`
+1. Create a database using `createdb <name_of_db>`
+1. You can now connect to the database from the command line by running `psql <name_of_db>`
 
 To start the database manually run `pg_ctl -l .devbox/conf/postgresql/logfile start`.
 To stop use `pg_ctl stop`.
@@ -18,9 +18,9 @@ To stop use `pg_ctl stop`.
 
 Use `devbox services start|stop [service]` to interact with services
 
-## This configuration sets the following environment variables
+## This plugin sets the following environment variables
 
-* PGDATA=/Users/johnlago/src/devbox-examples/databases/postgres/.devbox/conf/postgresql/data
-* PGHOST=/Users/johnlago/src/devbox-examples/databases/postgres/.devbox/virtenv/postgresql
+* PGDATA=/<projectDir>/.devbox/conf/postgresql/data
+* PGHOST=/<projectDir>/.devbox/virtenv/postgresql
 
-To show this information, run `devbox info postgresql`
+To show this information, run `devbox info postgresql`

examples/databases/postgres/devbox.json

@@ -1,8 +1,8 @@
 {
   "packages": [
-    "postgresql"
+    "postgresql@latest"
   ],
   "shell": {
     "init_hook": null
   }
-}
+}

examples/databases/postgres/devbox.lock

@@ -0,0 +1,10 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "postgresql@latest": {
+      "last_modified": "2023-05-01T16:53:22Z",
+      "resolved": "github:NixOS/nixpkgs/8670e496ffd093b60e74e7fa53526aa5920d09eb#postgresql",
+      "version": "14.7"
+    }
+  }
+}

examples/stacks/drupal/devbox.json

@@ -10,6 +10,8 @@
     "init_hook": [],
     "scripts": {
       "run_test": [
+        "mkdir -p /tmp/devbox/mariadb/run",
+        "export MYSQL_UNIX_PORT=/tmp/devbox/mariadb/run/mysql.sock",
         "devbox services up -b",
         "echo 'Waiting for services to start' && sleep 2",
         "./install-drupal.sh",
@@ -18,4 +20,4 @@
       ]
     }
   }
-}
+}