[pkg-config] Implement basic mariadb config (#263)

## Summary

* Adds golang template interpolation to the config and any files it
creates
* Creates a basic v0.0.1 config for mariafb (can be greatly improved)

## How was it tested?

```bash
devbox add mariadb
devbox shell
mysqld
mysql
# success!
```

Author: mikeland73

devbox.go

@@ -31,11 +31,6 @@ const (
 	// configFilename is name of the JSON file that defines a devbox environment.
 	configFilename = "devbox.json"
 
-	// profileDir contains the contents of the profile generated via `nix-env --profile profileDir <command>`
-	// Instead of using directory, prefer using the devbox.profileDir() function that ensures the directory exists.
-	// TODO savil. Rename to profilePath. This is the symlink of the profile, and not a directory.
-	profileDir = ".devbox/nix/profile/default"
-
 	// shellHistoryFile keeps the history of commands invoked inside devbox shell
 	shellHistoryFile = ".devbox/shell_history"
 )
@@ -236,7 +231,7 @@ func (d *Devbox) Shell() error {
 	}
 
 	if featureflag.Get(featureflag.PKGConfig).Enabled() {
-		env, err := pkgcfg.Env(plan.DevPackages)
+		env, err := pkgcfg.Env(plan.DevPackages, d.srcDir)
 		if err != nil {
 			return err
 		}
@@ -343,7 +338,7 @@ func (d *Devbox) generateBuildFiles() error {
 }
 
 func (d *Devbox) profileDir() (string, error) {
-	absPath := filepath.Join(d.srcDir, profileDir)
+	absPath := filepath.Join(d.srcDir, nix.ProfilePath)
 	if err := os.MkdirAll(filepath.Dir(absPath), 0755); err != nil {
 		return "", errors.WithStack(err)
 	}

nix/nix.go

@@ -14,6 +14,10 @@ import (
 	"github.com/pkg/errors"
 )
 
+// ProfilePath contains the contents of the profile generated via `nix-env --profile ProfilePath <command>`
+// Instead of using directory, prefer using the devbox.ProfilePath() function that ensures the directory exists.
+const ProfilePath = ".devbox/nix/profile/default"
+
 func PkgExists(pkg string) bool {
 	_, found := PkgInfo(pkg)
 	return found

pkgcfg/package-configuration/dummy-config/echo.sh

@@ -0,0 +1,19 @@
+{
+  "name": "mariadb",
+  "version": "0.0.1",
+  "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"
+  },
+  "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"
+  }
+}

pkgcfg/package-configuration/dummy-config/go_1_19.json

@@ -0,0 +1 @@
+{{ .DevboxProfileDefault }}/bin/mysql --socket=$MYSQL_UNIX_PORT "$@"

pkgcfg/package-configuration/mariadb.json

@@ -0,0 +1 @@
+{{ .DevboxProfileDefault }}/bin/mysql_install_db --auth-root-authentication-method=normal --datadir=$MYSQL_DATADIR --basedir=$MYSQL_BASEDIR --pid-file=$MYSQL_PID_FILE "$@"

pkgcfg/package-configuration/mariadb/mysql

@@ -0,0 +1 @@
+{{ .DevboxProfileDefault }}/bin/mysqld --datadir=$MYSQL_DATADIR --pid-file=$MYSQL_PID_FILE --socket=$MYSQL_UNIX_PORT "$@"

pkgcfg/package-configuration/mariadb/mysql_install_db

@@ -0,0 +1 @@
+{{ .DevboxProfileDefault }}/bin/mysqld --datadir=$MYSQL_DATADIR --pid-file=$MYSQL_PID_FILE --socket=$MYSQL_UNIX_PORT "$@" 2> $MYSQL_HOME/mysql.log & MYSQL_PID=$!

pkgcfg/package-configuration/mariadb/mysqladmin

@@ -1,12 +1,15 @@
 package pkgcfg
 
 import (
+	"bytes"
 	"encoding/json"
+	"html/template"
 	"os"
 	"path/filepath"
 
 	"github.com/pkg/errors"
 	"go.jetpack.io/devbox/debug"
+	"go.jetpack.io/devbox/nix"
 )
 
 const localPkgConfigPath = "DEVBOX_LOCAL_PKG_CONFIG"
@@ -19,34 +22,57 @@ type config struct {
 	localConfigPath string            `json:"-"`
 }
 
-func CreateFiles(pkg, basePath string) error {
-	cfg, err := get(pkg)
+func CreateFiles(pkg, rootDir string) error {
+	cfg, err := get(pkg, rootDir)
 	if err != nil {
 		return err
 	}
+	debug.Log("Creating files for package %q create files", pkg)
 	for name, contentPath := range cfg.CreateFiles {
-		filePath := filepath.Join(basePath, name)
+		filePath := filepath.Join(rootDir, name)
+
+		dirPath := filepath.Dir(filePath)
+		if contentPath == "" {
+			dirPath = filePath
+		}
+		if err = createDir(dirPath); err != nil {
+			return errors.WithStack(err)
+		}
+
+		if contentPath == "" {
+			continue
+		}
+
+		debug.Log("Creating file %q", filePath)
 		content, err := os.ReadFile(filepath.Join(cfg.localConfigPath, contentPath))
 		if err != nil {
 			return errors.WithStack(err)
 		}
-		if err = createDir(filepath.Dir(filePath)); err != nil {
-			return err
+		t, err := template.New(name + "-template").Parse(string(content))
+		if err != nil {
+			return errors.WithStack(err)
+		}
+		var buf bytes.Buffer
+		if err = t.Execute(&buf, map[string]string{
+			"DevboxRoot":           filepath.Join(rootDir, ".devbox"),
+			"DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),
+		}); err != nil {
+			return errors.WithStack(err)
 		}
-		if err := os.WriteFile(filePath, content, 0744); err != nil {
+		if err := os.WriteFile(filePath, buf.Bytes(), 0744); err != nil {
 			return errors.WithStack(err)
 		}
-		if err := createSymlink(basePath, filePath); err != nil {
+		if err := createSymlink(rootDir, filePath); err != nil {
 			return err
 		}
 	}
 	return nil
 }
 
-func Env(pkgs []string) (map[string]string, error) {
+func Env(pkgs []string, rootDir string) (map[string]string, error) {
 	env := map[string]string{}
 	for _, pkg := range pkgs {
-		cfg, err := get(pkg)
+		cfg, err := get(pkg, rootDir)
 		if err != nil {
 			return nil, err
 		}
@@ -57,15 +83,15 @@ func Env(pkgs []string) (map[string]string, error) {
 	return env, nil
 }
 
-func get(pkg string) (*config, error) {
+func get(pkg, rootDir string) (*config, error) {
 	if configPath := os.Getenv(localPkgConfigPath); configPath != "" {
 		debug.Log("Using local package config at %q", configPath)
-		return getLocalConfig(configPath, pkg)
+		return getLocalConfig(configPath, pkg, rootDir)
 	}
 	return &config{}, nil
 }
 
-func getLocalConfig(configPath, pkg string) (*config, error) {
+func getLocalConfig(configPath, pkg, rootDir string) (*config, error) {
 	pkgConfigPath := filepath.Join(configPath, pkg+".json")
 	if _, err := os.Stat(pkgConfigPath); errors.Is(err, os.ErrNotExist) {
 		// We don't need config for all packages and that's fine
@@ -77,11 +103,23 @@ func getLocalConfig(configPath, pkg string) (*config, error) {
 		return nil, errors.WithStack(err)
 	}
 	cfg := &config{localConfigPath: configPath}
-	if err = json.Unmarshal(content, cfg); err != nil {
+	t, err := template.New(pkg + "-template").Parse(string(content))
+	if err != nil {
+		return nil, errors.WithStack(err)
+	}
+	var buf bytes.Buffer
+	if err = t.Execute(&buf, map[string]string{
+		"DevboxRoot":           filepath.Join(rootDir, ".devbox"),
+		"DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),
+	}); err != nil {
+		return nil, errors.WithStack(err)
+	}
+	if err = json.Unmarshal(buf.Bytes(), cfg); err != nil {
 		return nil, errors.WithStack(err)
 	}
 	return cfg, nil
 }
+
 func createDir(path string) error {
 	if path == "" {
 		return nil