Merge pull request #53 from joshuanianji/edgedb-persistence

[edgedb] Cache config dir

Author: joshuanianji

src/edgedb-cli/NOTES.md

@@ -1,3 +1,22 @@
+## Note to Users
+
+This feature mounts the edgedb config and data folder to the host machine for persistence. To do so, it makes some assumptions about `edgedb info`:
+
+```bash
+$ edgedb info
+
+EdgeDB uses the following local paths:
+┌────────────┬────────────────────────────────────────┐
+│ Cache      │ /home/<user>/.cache/edgedb/            │
+│ Config     │ /home/<user>/.config/edgedb/           │
+│ CLI Binary │ /home/<user>/.local/bin/edgedb         │
+│ Data       │ /home/<user>/.local/share/edgedb/data/ │
+│ Service    │ /home/<user>/.config/systemd/user/     │
+└────────────┴────────────────────────────────────────┘
+```
+
+**These paths may change based on the OS!**. This feature is tested on Ubuntu and Debian and the paths match up, but may not work for others.
+
 ## OS and Architecture Support
 
 Architectures: `amd` and `arm`
@@ -8,7 +27,8 @@ Shells: `bash`, `zsh`, `fish`
 
 ## Changelog
 
-| Version | Notes                  |
-| ------- | ---------------------- |
-| 1.0.1   | Fix for non-root users |
-| 1.0.0   | Initial Version        |
+| Version | Notes                      |
+| ------- | -------------------------- |
+| 1.0.2   | Cache edgedb config folder |
+| 1.0.1   | Fix for non-root users     |
+| 1.0.0   | Initial Version            |

src/edgedb-cli/devcontainer-feature.json

@@ -1,9 +1,9 @@
 {
     "name": "EdgeDB",
     "id": "edgedb-cli",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "documentationURL": "https://github.com/joshuanianji/devcontainer-features/tree/main/src/edgedb-cli",
-    "description": "EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts ~/.local/share/edgedb for data persistence.",
+    "description": "EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts the config and data folder.",
     "options": {},
     "customizations": {
         "vscode": {

src/edgedb-cli/install.sh

@@ -73,8 +73,14 @@ export DEBIAN_FRONTEND=noninteractive
 
 check_packages curl ca-certificates
 
-create_cache_dir "/dc/edgedb-cli" "${USERNAME}"
-create_symlink_dir "$_REMOTE_USER_HOME/.local/share/edgedb" "/dc/edgedb-cli" "${USERNAME}"
+# cache data directory
+create_cache_dir "/dc/edgedb-cli/data" "${USERNAME}"
+create_symlink_dir "$_REMOTE_USER_HOME/.local/share/edgedb" "/dc/edgedb-cli/data" "${USERNAME}"
+
+# cache config directory
+create_cache_dir "/dc/edgedb-cli/config" "${USERNAME}"
+create_symlink_dir "$_REMOTE_USER_HOME/.config/edgedb" "/dc/edgedb-cli/config" "${USERNAME}"
+
 install_edgedb "${USERNAME}"
 
 # Set Lifecycle scripts

test/edgedb-cli/_default.sh

@@ -11,17 +11,28 @@ source dev-container-features-test-lib
 # check that the command is available
 check "help" bash -c "edgedb --help | grep 'Usage'"
 
-# check that `.config/gh` and `/dc/github-cli` exist under the user (should be node)
+# make sure edgedb directories match up with our expectations
+check "edgedb cli data dir" bash -c "test \"$(edgedb info --get data-dir)\" = $HOME/.local/share/edgedb/data/"
+check "edgedb cli config dir" bash -c "test \"$(edgedb info --get config-dir)\" = $HOME/.config/edgedb/"
+
+# check that data directories exist
 check "~/.local/share/edgedb exists" bash -c "ls -la ~/.local/share | grep 'edgedb'"
-check "/dc/edgedb-cli exists" bash -c "ls -la /dc | grep 'edgedb-cli'"
+check "/dc/edgedb-cli/data exists" bash -c "ls -la /dc/edgedb-cli | grep 'data'"
+
+# check that config directories exist
+check "~/.config/edgedb exists" bash -c "ls -la ~/.config | grep 'edgedb'"
+check "/dc/edgedb-cli exists" bash -c "ls -la /dc/edgedb-cli | grep 'config'"
 
 # check that the folders are owned by the user
 # https://askubuntu.com/a/175060
-echo "Checking ownership of ~/.local/share/edgedb and /dc/edgedb-cli (ensure it is owned by $USER)"
-ls -al ~/.local/share/
+# $USER is empty when running as root, so we use $(whoami)
+echo "Checking ownership of ~/.local/share/edgedb/data and /dc/edgedb-cli/data (ensure it is owned by $(whoami))"
+
+check "~/.local/share/edgedb owned by user" bash -c "test \"$(stat -c "%U" ~/.local/share/edgedb)\" = $(whoami)"
+check "/dc/edgedb-cli/data owned by user" bash -c "test \"$(stat -c "%U" /dc/edgedb-cli/data)\" = $(whoami)"
 
-check "~/.local/share/edgedb owned by user" bash -c "test \"$(stat -c "%U" ~/.local/share/edgedb)\" = $USER"
-check "/dc/edgedb-cli owned by user" bash -c "test \"$(stat -c "%U" /dc/edgedb-cli)\" = $USER"
+check "~/.config/edgedb owned by user" bash -c "test \"$(stat -c "%U" ~/.config/edgedb)\" = $(whoami)"
+check "/dc/edgedb-cli/config owned by user" bash -c "test \"$(stat -c "%U" /dc/edgedb-cli/config)\" = $(whoami)"
 
 # Report result
 reportResults

test/edgedb-cli/test.sh

@@ -7,20 +7,6 @@ source dev-container-features-test-lib
 
 # NOTE: this is an "auto-generated" test, which means it will be
 # executed against an auto-generated devcontainer.json that
-# includes the 'gcloud-cli-persistence' Feature with no options.
-#
-# https://github.com/devcontainers/cli/blob/main/docs/features/test.md
-#
-# From my tests, this means the `gcloud` CLI will not be installed:
-# Thus, here, I only check basic directory existence
+# includes the feature with no options
 
-# check that `~/.config/gcloud` and `/dc/gcloud-cli` exist`
-check "config" bash -c "ls -la ~/.local/share/ | grep 'edgedb'"
-check "dc" bash -c "ls -la /dc | grep 'edgedb-cli'"
-
-# check that `~/.config/gcloud` is a symlink
-# https://unix.stackexchange.com/a/96910
-check "~/.local/share/edgedb is a symlink" bash -c "test -L ~/.local/share/edgedb && test -d ~/.local/share/edgedb"
-
-# Report result
-reportResults
+./_default.sh