[plugins] Move conf files out of .devbox and more DEV-1259 DEV-1258 (#362)

## Summary

This changes how some plugins work (FKA package configuration) and makes a few related improvements. 

Specifically:

* conf files are moved out of `.devbox/conf` and moved to `./devbox.d`. (or `.DevboxDir`)
* Files created outside of `.devbox` directory are never overridden.
* Hidden files are now saved in `.devbox/virtenv` (or `.Virtenv`)
* mariadb plugin has been disabled (not yet ready for prime time, it's the only plugin that requires shims)
* Added service to postgresql (I forget it in previous PR)
* Only files stored in `bin` get file mode 755 and sym links. Everything else gets 644 and no link.
* Updated all plugins to use new variables.
* Added `web/index.html` example file to nginx and apache plugins.

Everything is still hidden behind flag so no user change.

TODO (in follow up):

* Only create non-`.devbox` files when doing `devbox add` (vs now they get created on `shell`, `run`, `generate` etc) (DEV-1260)

## How was it tested?

Added: `postgresql`, `nginx`, and `php`. 

* Inspected configs in `./devbox.d` directory. 
* Inspected .devbox/virtenv directory.
* Started all services. 
* Created simple `web/index.html` for nginx and curled it. All working.

Author: mikeland73

devbox.json

@@ -4,7 +4,10 @@
     "golangci-lint"
   ],
   "shell": {
-    "init_hook": "export \"GOROOT=$(go env GOROOT)\""
+    "init_hook": "export \"GOROOT=$(go env GOROOT)\"",
+    "scripts": {
+      "build": "go build -o dist/devbox cmd/devbox/main.go"
+    }
   },
   "nixpkgs": {
     "commit": "d01cb18be494e3d860fcfe6be4ad63614360333c"

internal/boxcli/usererr/usererr.go

@@ -59,7 +59,7 @@ func (c *combined) Error() string {
 	if c.source == nil {
 		return c.userMessage
 	}
-	return c.userMessage + ": " + c.source.Error()
+	return c.userMessage + "\nsource: " + c.source.Error()
 }
 
 // Is uses the source error for comparisons

internal/impl/devbox.go

@@ -211,7 +211,7 @@ func (d *Devbox) Shell() error {
 		opts = append(
 			opts,
 			nix.WithEnvVariables(env),
-			nix.WithPKGConfigDir(filepath.Join(d.configDir, ".devbox/conf/bin")),
+			nix.WithPKGConfigDir(filepath.Join(d.configDir, pkgcfg.VirtenvBinPath)),
 		)
 	}
 
@@ -299,7 +299,7 @@ func (d *Devbox) RunScript(scriptName string) error {
 		opts = append(
 			opts,
 			nix.WithEnvVariables(env),
-			nix.WithPKGConfigDir(filepath.Join(d.configDir, ".devbox/conf/bin")),
+			nix.WithPKGConfigDir(filepath.Join(d.configDir, pkgcfg.VirtenvBinPath)),
 		)
 	}
 
@@ -335,7 +335,7 @@ func (d *Devbox) Exec(cmds ...string) error {
 	}
 
 	env := []string{}
-	confBinPath := ""
+	virtenvBinPath := ""
 	if featureflag.PKGConfig.Enabled() {
 		envMap, err := pkgcfg.Env(d.cfg.Packages, d.configDir)
 		if err != nil {
@@ -344,9 +344,9 @@ func (d *Devbox) Exec(cmds ...string) error {
 		for k, v := range envMap {
 			env = append(env, fmt.Sprintf("%s=%s", k, v))
 		}
-		confBinPath = filepath.Join(d.configDir, ".devbox/conf/bin") + ":"
+		virtenvBinPath = filepath.Join(d.configDir, pkgcfg.VirtenvBinPath) + ":"
 	}
-	pathWithProfileBin := fmt.Sprintf("PATH=%s%s:$PATH", confBinPath, profileBinDir)
+	pathWithProfileBin := fmt.Sprintf("PATH=%s%s:$PATH", virtenvBinPath, profileBinDir)
 	cmds = append([]string{pathWithProfileBin}, cmds...)
 
 	nixDir := filepath.Join(d.configDir, ".devbox/gen/shell.nix")

internal/pkgcfg/files.go

@@ -31,7 +31,7 @@ func getConfig(pkg, rootDir string) (*config, error) {
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
-		cfg, err := buildConfig(&config{}, pkg, rootDir, string(content))
+		cfg, err := buildConfig(pkg, rootDir, string(content))
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}

internal/pkgcfg/info.go

@@ -93,7 +93,7 @@ func printCreateFiles(cfg *config, w io.Writer, markdown bool) error {
 
 	_, err := fmt.Fprintf(
 		w,
-		"%sThis configuration creates the following helper files:\n%s\n",
+		"%sThis plugin creates the following helper files:\n%s\n",
 		lo.Ternary(markdown, "### ", ""),
 		shims,
 	)
@@ -112,7 +112,7 @@ func printEnv(cfg *config, w io.Writer, markdown bool) error {
 
 	_, err := fmt.Fprintf(
 		w,
-		"%sThis configuration sets the following environment variables:\n%s\n",
+		"%sThis plugin sets the following environment variables:\n%s\n",
 		lo.Ternary(markdown, "### ", ""),
 		envVars,
 	)
@@ -137,7 +137,7 @@ func printSourceEnvMessage(pkg, rootDir string, w io.Writer) error {
 		_, err = fmt.Fprintf(
 			w,
 			"To ensure environment is set, run `source %s/%s/env`\n\n",
-			confPath,
+			VirtenvPath,
 			pkg,
 		)
 	}

internal/pkgcfg/package-configuration/apache/httpd.conf

@@ -26,8 +26,8 @@ LoadModule alias_module modules/mod_alias.so
     Require all denied
 </Directory>
 
-DocumentRoot  "${PWD}/web"
-<Directory "${PWD}/web">
+DocumentRoot  "{{ .DevboxDirRoot }}/web"
+<Directory "{{ .DevboxDirRoot }}/web">
     Options Indexes FollowSymLinks
     AllowOverride None
     Require all granted
@@ -46,9 +46,9 @@ ErrorLog "${HTTPD_CONFDIR}/error.log"
     ServerName  php_localhost
 
     UseCanonicalName    Off
-    DocumentRoot "${PWD}/web"
+    DocumentRoot "{{ .DevboxDirRoot }}/web"
 
-    <Directory "${PWD}/web">
+    <Directory "{{ .DevboxDirRoot }}/web">
         Options All
         AllowOverride All
         <IfModule mod_authz_host.c>
@@ -57,7 +57,7 @@ ErrorLog "${HTTPD_CONFDIR}/error.log"
     </Directory>
 
     ## Added for php-fpm
-    ProxyPassMatch ^/(.*\.php(/.*)?)$ fcgi://127.0.0.1:8082/${PWD}/web/$1
+    ProxyPassMatch ^/(.*\.php(/.*)?)$ fcgi://127.0.0.1:8082/{{ .DevboxDirRoot }}/web/$1
     DirectoryIndex index.html 
 
 </VirtualHost>

internal/pkgcfg/package-configuration/apacheHttpd.json

@@ -3,11 +3,12 @@
   "version": "0.0.1",
   "readme": "If you with to edit the config file, please copy it out of the .devbox directory.",
   "env": {
-    "HTTPD_CONFDIR": "{{ .DevboxRoot }}/conf/apache",
+    "HTTPD_CONFDIR": "{{ .DevboxDir }}",
     "HTTPD_PORT": "8080"
   },
   "create_files": {
-    ".devbox/conf/apache/httpd.conf": "apache/httpd.conf"
+    "{{ .DevboxDir }}/httpd.conf": "apache/httpd.conf",
+    "{{ .DevboxDirRoot }}/web/index.html": "web/index.html"
   },
   "services": {
     "apache": {

internal/pkgcfg/package-configuration/mariadb.json

@@ -1,20 +1,21 @@
 {
   "name": "mariadb",
   "version": "0.0.1",
-  "readme": "* This package creates shims and stores them in .devbox/conf/mariadb/bin\n* Use mysql_install_db to initialize data directory\n* Use mysqld to start the server",
+  "match": "disabled",
+  "readme": "* This package creates shims and stores them in .devbox/virtenv/mariadb/bin\n* Use mysql_install_db to initialize data directory\n* Use mysqld to start the server",
   "env": {
     "MYSQL_BASEDIR": "{{ .DevboxProfileDefault }}",
-    "MYSQL_HOME": "{{ .DevboxRoot }}/conf/mariadb/run",
-    "MYSQL_DATADIR": "{{ .DevboxRoot }}/conf/mariadb/data",
-    "MYSQL_UNIX_PORT": "{{ .DevboxRoot }}/conf/mariadb/run/mysql.sock",
-    "MYSQL_PID_FILE": "{{ .DevboxRoot }}/conf/mariadb/run/mysql.pid"
+    "MYSQL_HOME": "{{ .Virtenv }}/run",
+    "MYSQL_DATADIR": "{{ .Virtenv }}/data",
+    "MYSQL_UNIX_PORT": "{{ .Virtenv }}/run/mysql.sock",
+    "MYSQL_PID_FILE": "{{ .Virtenv }}/run/mysql.pid"
   },
   "create_files": {
-    ".devbox/conf/mariadb/data": "",
-    ".devbox/conf/mariadb/run": "",
-    ".devbox/conf/mariadb/bin/mysql": "mariadb/mysql",
-    ".devbox/conf/mariadb/bin/mysql_install_db": "mariadb/mysql_install_db",
-    ".devbox/conf/mariadb/bin/mysqladmin": "mariadb/mysqladmin",
-    ".devbox/conf/mariadb/bin/mysqld": "mariadb/mysqld"
+    "{{ .Virtenv }}/data": "",
+    "{{ .Virtenv }}/run": "",
+    "{{ .Virtenv }}/bin/mysql": "mariadb/mysql",
+    "{{ .Virtenv }}/bin/mysql_install_db": "mariadb/mysql_install_db",
+    "{{ .Virtenv }}/bin/mysqladmin": "mariadb/mysqladmin",
+    "{{ .Virtenv }}/bin/mysqld": "mariadb/mysqld"
   }
 }

internal/pkgcfg/package-configuration/nginx.json

@@ -1,18 +1,21 @@
 {
   "name": "nginx",
   "version": "0.0.1",
-  "readme": "nginx is configured to use .devbox/conf/nginx.conf\n\nTo customize:\n* Use $NGINX_CONFDIR to change the configuration directory\n* Use $NGINX_LOGDIR to change the log directory\n* Use $NGINX_PIDDIR to change the pid directory\n* Use $NGINX_RUNDIR to change the run directory\n* Use $NGINX_SITESDIR to change the sites directory\n* Use $NGINX_TMPDIR to change the tmp directory. Use $NGINX_USER to change the user\n* Use $NGINX_GROUP to customize.",
+  "readme": "nginx can be configured with env variables\n\nTo customize:\n* Use $NGINX_CONFDIR to change the configuration directory\n* Use $NGINX_LOGDIR to change the log directory\n* Use $NGINX_PIDDIR to change the pid directory\n* Use $NGINX_RUNDIR to change the run directory\n* Use $NGINX_SITESDIR to change the sites directory\n* Use $NGINX_TMPDIR to change the tmp directory. Use $NGINX_USER to change the user\n* Use $NGINX_GROUP to customize.",
   "env": {
-    "NGINX_CONFDIR": "{{ .DevboxRoot }}/conf/nginx"
+    "NGINX_CONFDIR": "{{ .DevboxDir }}/nginx.conf",
+    "NGINX_PATH_PREFIX": "{{ .Virtenv }}",
+    "NGINX_TMPDIR": "{{ .Virtenv }}/temp"
   },
   "create_files": {
-    ".devbox/conf/nginx/temp": "",
-    ".devbox/conf/nginx/nginx.conf": "nginx/nginx.conf",
-    ".devbox/conf/nginx/fastcgi.conf": "nginx/fastcgi.conf"
+    "{{ .Virtenv }}/temp": "",
+    "{{ .DevboxDir }}/nginx.conf": "nginx/nginx.conf",
+    "{{ .DevboxDir }}/fastcgi.conf": "nginx/fastcgi.conf",
+    "{{ .DevboxDirRoot }}/web/index.html": "web/index.html"
   },
   "services": {
     "nginx": {
-      "start": "nginx -p $NGINX_CONFDIR -c nginx.conf -e error.log -g \"pid nginx.pid;\"",
+      "start": "nginx -p $NGINX_PATH_PREFIX -c $NGINX_CONFDIR -e error.log -g \"pid nginx.pid;\"",
       "stop": "pkill nginx"
     }
   }

internal/pkgcfg/package-configuration/nginx/nginx.conf

@@ -4,7 +4,7 @@ server {
          listen       80;
          listen       [::]:80;
          server_name  localhost;
-         root         {{ .UserRoot }}/web;
+         root         {{ .DevboxDirRoot }}/web;
 
          error_log error.log error;
          access_log access.log;