[cleanup] plugin framework: rename rootDir to projectDir (#448)

savil · web-flow · commit aa9f515c0eda · 2023-01-10T14:10:45.000-08:00
## Summary

For the plugin framework, this renames rootDir to projectDir. This
change
makes it consistent with the rest of the devbox codebase.

did not change this one, because it may break users. Or are we early
enough that
we can change it?
```
docs/app/docs/devbox_examples/servers/apache.md:HTTPD_DEVBOX_CONFIG_DIR={PROJECT_DIR}
```

## How was it tested?

automated tests
diff --git a/internal/plugin/files.go b/internal/plugin/files.go
@@ -8,7 +8,7 @@ import (
 	"go.jetpack.io/devbox/plugins"
 )
 
-func getConfigIfAny(pkg, rootDir string) (*config, error) {
+func getConfigIfAny(pkg, projectDir string) (*config, error) {
 	configFiles, err := plugins.BuiltIn.ReadDir(".")
 	if err != nil {
 		return nil, errors.WithStack(err)
@@ -24,7 +24,7 @@ func getConfigIfAny(pkg, rootDir string) (*config, error) {
 			return nil, errors.WithStack(err)
 		}
 
-		cfg, err := buildConfig(pkg, rootDir, string(content))
+		cfg, err := buildConfig(pkg, projectDir, string(content))
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
diff --git a/internal/plugin/hooks.go b/internal/plugin/hooks.go
@@ -1,9 +1,9 @@
 package plugin
 
-func InitHooks(pkgs []string, rootDir string) ([]string, error) {
+func InitHooks(pkgs []string, projectDir string) ([]string, error) {
 	hooks := []string{}
 	for _, pkg := range pkgs {
-		c, err := getConfigIfAny(pkg, rootDir)
+		c, err := getConfigIfAny(pkg, projectDir)
 		if err != nil {
 			return nil, err
 		}
diff --git a/internal/plugin/info.go b/internal/plugin/info.go
@@ -9,11 +9,11 @@ import (
 )
 
 func PrintReadme(
-	pkg, rootDir string,
+	pkg, projectDir string,
 	w io.Writer,
 	showSourceEnv, markdown bool,
 ) error {
-	cfg, err := getConfigIfAny(pkg, rootDir)
+	cfg, err := getConfigIfAny(pkg, projectDir)
 
 	if err != nil {
 		return err
@@ -46,7 +46,7 @@ func PrintReadme(
 	}
 
 	if showSourceEnv {
-		err = printSourceEnvMessage(pkg, rootDir, w)
+		err = printSourceEnvMessage(pkg, projectDir, w)
 	}
 	return err
 }
@@ -132,8 +132,8 @@ func printInfoInstructions(pkg string, w io.Writer) error {
 	return errors.WithStack(err)
 }
 
-func printSourceEnvMessage(pkg, rootDir string, w io.Writer) error {
-	env, err := Env([]string{pkg}, rootDir)
+func printSourceEnvMessage(pkg, projectDir string, w io.Writer) error {
+	env, err := Env([]string{pkg}, projectDir)
 	if err != nil {
 		return err
 	}
diff --git a/internal/plugin/pkgcfg.go b/internal/plugin/pkgcfg.go
@@ -38,8 +38,8 @@ type config struct {
 	} `json:"shell,omitempty"`
 }
 
-func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {
-	cfg, err := getConfigIfAny(pkg, rootDir)
+func (m *Manager) CreateFilesAndShowReadme(pkg, projectDir string) error {
+	cfg, err := getConfigIfAny(pkg, projectDir)
 	if err != nil {
 		return err
 	}
@@ -77,11 +77,11 @@ func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {
 		}
 		var buf bytes.Buffer
 		if err = t.Execute(&buf, map[string]string{
-			"DevboxConfigDir":      rootDir,
-			"DevboxDir":            filepath.Join(rootDir, devboxDirName, pkg),
-			"DevboxDirRoot":        filepath.Join(rootDir, devboxDirName),
-			"DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),
-			"Virtenv":              filepath.Join(rootDir, devboxHiddenDirName, "virtenv", pkg),
+			"DevboxConfigDir":      projectDir,
+			"DevboxDir":            filepath.Join(projectDir, devboxDirName, pkg),
+			"DevboxDirRoot":        filepath.Join(projectDir, devboxDirName),
+			"DevboxProfileDefault": filepath.Join(projectDir, nix.ProfilePath),
+			"Virtenv":              filepath.Join(projectDir, devboxHiddenDirName, "virtenv", pkg),
 		}); err != nil {
 			return errors.WithStack(err)
 		}
@@ -94,19 +94,19 @@ func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {
 			return errors.WithStack(err)
 		}
 		if fileMode == 0755 {
-			if err := createSymlink(rootDir, filePath); err != nil {
+			if err := createSymlink(projectDir, filePath); err != nil {
 				return err
 			}
 		}
 	}
-	return createEnvFile(pkg, rootDir)
+	return createEnvFile(pkg, projectDir)
 
 }
 
-func Env(pkgs []string, rootDir string) (map[string]string, error) {
+func Env(pkgs []string, projectDir string) (map[string]string, error) {
 	env := map[string]string{}
 	for _, pkg := range pkgs {
-		cfg, err := getConfigIfAny(pkg, rootDir)
+		cfg, err := getConfigIfAny(pkg, projectDir)
 		if err != nil {
 			return nil, err
 		}
@@ -120,8 +120,8 @@ func Env(pkgs []string, rootDir string) (map[string]string, error) {
 	return env, nil
 }
 
-func createEnvFile(pkg, rootDir string) error {
-	envVars, err := Env([]string{pkg}, rootDir)
+func createEnvFile(pkg, projectDir string) error {
+	envVars, err := Env([]string{pkg}, projectDir)
 	if err != nil {
 		return err
 	}
@@ -133,7 +133,7 @@ func createEnvFile(pkg, rootDir string) error {
 		}
 		env += fmt.Sprintf("export %s=%s\n", k, escaped)
 	}
-	filePath := filepath.Join(rootDir, VirtenvPath, pkg, "/env")
+	filePath := filepath.Join(projectDir, VirtenvPath, pkg, "/env")
 	if err = createDir(filepath.Dir(filePath)); err != nil {
 		return err
 	}
@@ -143,19 +143,19 @@ func createEnvFile(pkg, rootDir string) error {
 	return nil
 }
 
-func buildConfig(pkg, rootDir, content string) (*config, error) {
+func buildConfig(pkg, projectDir, content string) (*config, error) {
 	cfg := &config{}
 	t, err := template.New(pkg + "-template").Parse(content)
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
 	var buf bytes.Buffer
 	if err = t.Execute(&buf, map[string]string{
-		"DevboxConfigDir":      rootDir,
-		"DevboxDir":            filepath.Join(rootDir, devboxDirName, pkg),
-		"DevboxDirRoot":        filepath.Join(rootDir, devboxDirName),
-		"DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),
-		"Virtenv":              filepath.Join(rootDir, devboxHiddenDirName, "virtenv", pkg),
+		"DevboxProjectDir":     projectDir,
+		"DevboxDir":            filepath.Join(projectDir, devboxDirName, pkg),
+		"DevboxDirRoot":        filepath.Join(projectDir, devboxDirName),
+		"DevboxProfileDefault": filepath.Join(projectDir, nix.ProfilePath),
+		"Virtenv":              filepath.Join(projectDir, devboxHiddenDirName, "virtenv", pkg),
 	}); err != nil {
 		return nil, errors.WithStack(err)
 	}
diff --git a/internal/plugin/rm.go b/internal/plugin/rm.go
@@ -7,17 +7,17 @@ import (
 	"github.com/pkg/errors"
 )
 
-func Remove(rootDir string, pkgs []string) error {
+func Remove(projectDir string, pkgs []string) error {
 	for _, pkg := range pkgs {
-		if err := os.RemoveAll(filepath.Join(rootDir, VirtenvPath, pkg)); err != nil {
+		if err := os.RemoveAll(filepath.Join(projectDir, VirtenvPath, pkg)); err != nil {
 			return errors.WithStack(err)
 		}
 	}
 	return nil
 }
 
-func RemoveInvalidSymlinks(rootDir string) error {
-	binPath := filepath.Join(rootDir, VirtenvBinPath)
+func RemoveInvalidSymlinks(projectDir string) error {
+	binPath := filepath.Join(projectDir, VirtenvBinPath)
 	if _, err := os.Stat(binPath); errors.Is(err, os.ErrNotExist) {
 		return nil
 	}
@@ -26,9 +26,9 @@ func RemoveInvalidSymlinks(rootDir string) error {
 		return errors.WithStack(err)
 	}
 	for _, entry := range dirEntry {
-		_, err := os.Stat(filepath.Join(rootDir, VirtenvPath, "bin", entry.Name()))
+		_, err := os.Stat(filepath.Join(projectDir, VirtenvPath, "bin", entry.Name()))
 		if errors.Is(err, os.ErrNotExist) {
-			os.Remove(filepath.Join(rootDir, VirtenvPath, "bin", entry.Name()))
+			os.Remove(filepath.Join(projectDir, VirtenvPath, "bin", entry.Name()))
 		}
 	}
 	return nil
diff --git a/internal/plugin/services.go b/internal/plugin/services.go
@@ -17,10 +17,10 @@ type service struct {
 	Stop  string `json:"stop"`
 }
 
-func GetServices(pkgs []string, rootDir string) (Services, error) {
+func GetServices(pkgs []string, projectDir string) (Services, error) {
 	services := map[string]service{}
 	for _, pkg := range pkgs {
-		c, err := getConfigIfAny(pkg, rootDir)
+		c, err := getConfigIfAny(pkg, projectDir)
 		if err != nil {
 			return nil, err
 		}
diff --git a/plugins/apacheHttpd.json b/plugins/apacheHttpd.json
@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "readme": "If you with to edit the config file, please copy it out of the .devbox directory.",
   "env": {
-    "HTTPD_DEVBOX_CONFIG_DIR": "{{ .DevboxConfigDir }}",
+    "HTTPD_DEVBOX_CONFIG_DIR": "{{ .DevboxProjectDir }}",
     "HTTPD_CONFDIR": "{{ .DevboxDir }}",
     "HTTPD_ERROR_LOG_FILE": "{{ .Virtenv }}/error.log",
     "HTTPD_PORT": "8080"

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"go.jetpack.io/devbox/plugins"`
`9`	`9`	`)`
`10`	`10`
`11`		`-func getConfigIfAny(pkg, rootDir string) (*config, error) {`
	`11`	`+func getConfigIfAny(pkg, projectDir string) (*config, error) {`
`12`	`12`	`configFiles, err := plugins.BuiltIn.ReadDir(".")`
`13`	`13`	`if err != nil {`
`14`	`14`	`return nil, errors.WithStack(err)`
`@@ -24,7 +24,7 @@ func getConfigIfAny(pkg, rootDir string) (*config, error) {`
`24`	`24`	`return nil, errors.WithStack(err)`
`25`	`25`	`}`
`26`	`26`
`27`		`- cfg, err := buildConfig(pkg, rootDir, string(content))`
	`27`	`+ cfg, err := buildConfig(pkg, projectDir, string(content))`
`28`	`28`	`if err != nil {`
`29`	`29`	`return nil, errors.WithStack(err)`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,11 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func PrintReadme(`
`12`		`- pkg, rootDir string,`
	`12`	`+ pkg, projectDir string,`
`13`	`13`	`w io.Writer,`
`14`	`14`	`showSourceEnv, markdown bool,`
`15`	`15`	`) error {`
`16`		`- cfg, err := getConfigIfAny(pkg, rootDir)`
	`16`	`+ cfg, err := getConfigIfAny(pkg, projectDir)`
`17`	`17`
`18`	`18`	`if err != nil {`
`19`	`19`	`return err`
`@@ -46,7 +46,7 @@ func PrintReadme(`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`if showSourceEnv {`
`49`		`- err = printSourceEnvMessage(pkg, rootDir, w)`
	`49`	`+ err = printSourceEnvMessage(pkg, projectDir, w)`
`50`	`50`	`}`
`51`	`51`	`return err`
`52`	`52`	`}`
`@@ -132,8 +132,8 @@ func printInfoInstructions(pkg string, w io.Writer) error {`
`132`	`132`	`return errors.WithStack(err)`
`133`	`133`	`}`
`134`	`134`
`135`		`-func printSourceEnvMessage(pkg, rootDir string, w io.Writer) error {`
`136`		`- env, err := Env([]string{pkg}, rootDir)`
	`135`	`+func printSourceEnvMessage(pkg, projectDir string, w io.Writer) error {`
	`136`	`+ env, err := Env([]string{pkg}, projectDir)`
`137`	`137`	`if err != nil {`
`138`	`138`	`return err`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,8 @@ type config struct {`
`38`	`38`	} `json:"shell,omitempty"`
`39`	`39`	`}`
`40`	`40`
`41`		`-func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {`
`42`		`- cfg, err := getConfigIfAny(pkg, rootDir)`
	`41`	`+func (m *Manager) CreateFilesAndShowReadme(pkg, projectDir string) error {`
	`42`	`+ cfg, err := getConfigIfAny(pkg, projectDir)`
`43`	`43`	`if err != nil {`
`44`	`44`	`return err`
`45`	`45`	`}`
`@@ -77,11 +77,11 @@ func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {`
`77`	`77`	`}`
`78`	`78`	`var buf bytes.Buffer`
`79`	`79`	`if err = t.Execute(&buf, map[string]string{`
`80`		`- "DevboxConfigDir": rootDir,`
`81`		`- "DevboxDir": filepath.Join(rootDir, devboxDirName, pkg),`
`82`		`- "DevboxDirRoot": filepath.Join(rootDir, devboxDirName),`
`83`		`- "DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),`
`84`		`- "Virtenv": filepath.Join(rootDir, devboxHiddenDirName, "virtenv", pkg),`
	`80`	`+ "DevboxConfigDir": projectDir,`
	`81`	`+ "DevboxDir": filepath.Join(projectDir, devboxDirName, pkg),`
	`82`	`+ "DevboxDirRoot": filepath.Join(projectDir, devboxDirName),`
	`83`	`+ "DevboxProfileDefault": filepath.Join(projectDir, nix.ProfilePath),`
	`84`	`+ "Virtenv": filepath.Join(projectDir, devboxHiddenDirName, "virtenv", pkg),`
`85`	`85`	`}); err != nil {`
`86`	`86`	`return errors.WithStack(err)`
`87`	`87`	`}`
`@@ -94,19 +94,19 @@ func (m *Manager) CreateFilesAndShowReadme(pkg, rootDir string) error {`
`94`	`94`	`return errors.WithStack(err)`
`95`	`95`	`}`
`96`	`96`	`if fileMode == 0755 {`
`97`		`- if err := createSymlink(rootDir, filePath); err != nil {`
	`97`	`+ if err := createSymlink(projectDir, filePath); err != nil {`
`98`	`98`	`return err`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`	`}`
`102`		`- return createEnvFile(pkg, rootDir)`
	`102`	`+ return createEnvFile(pkg, projectDir)`
`103`	`103`
`104`	`104`	`}`
`105`	`105`
`106`		`-func Env(pkgs []string, rootDir string) (map[string]string, error) {`
	`106`	`+func Env(pkgs []string, projectDir string) (map[string]string, error) {`
`107`	`107`	`env := map[string]string{}`
`108`	`108`	`for _, pkg := range pkgs {`
`109`		`- cfg, err := getConfigIfAny(pkg, rootDir)`
	`109`	`+ cfg, err := getConfigIfAny(pkg, projectDir)`
`110`	`110`	`if err != nil {`
`111`	`111`	`return nil, err`
`112`	`112`	`}`
`@@ -120,8 +120,8 @@ func Env(pkgs []string, rootDir string) (map[string]string, error) {`
`120`	`120`	`return env, nil`
`121`	`121`	`}`
`122`	`122`
`123`		`-func createEnvFile(pkg, rootDir string) error {`
`124`		`- envVars, err := Env([]string{pkg}, rootDir)`
	`123`	`+func createEnvFile(pkg, projectDir string) error {`
	`124`	`+ envVars, err := Env([]string{pkg}, projectDir)`
`125`	`125`	`if err != nil {`
`126`	`126`	`return err`
`127`	`127`	`}`
`@@ -133,7 +133,7 @@ func createEnvFile(pkg, rootDir string) error {`
`133`	`133`	`}`
`134`	`134`	`env += fmt.Sprintf("export %s=%s\n", k, escaped)`
`135`	`135`	`}`
`136`		`- filePath := filepath.Join(rootDir, VirtenvPath, pkg, "/env")`
	`136`	`+ filePath := filepath.Join(projectDir, VirtenvPath, pkg, "/env")`
`137`	`137`	`if err = createDir(filepath.Dir(filePath)); err != nil {`
`138`	`138`	`return err`
`139`	`139`	`}`
`@@ -143,19 +143,19 @@ func createEnvFile(pkg, rootDir string) error {`
`143`	`143`	`return nil`
`144`	`144`	`}`
`145`	`145`
`146`		`-func buildConfig(pkg, rootDir, content string) (*config, error) {`
	`146`	`+func buildConfig(pkg, projectDir, content string) (*config, error) {`
`147`	`147`	`cfg := &config{}`
`148`	`148`	`t, err := template.New(pkg + "-template").Parse(content)`
`149`	`149`	`if err != nil {`
`150`	`150`	`return nil, errors.WithStack(err)`
`151`	`151`	`}`
`152`	`152`	`var buf bytes.Buffer`
`153`	`153`	`if err = t.Execute(&buf, map[string]string{`
`154`		`- "DevboxConfigDir": rootDir,`
`155`		`- "DevboxDir": filepath.Join(rootDir, devboxDirName, pkg),`
`156`		`- "DevboxDirRoot": filepath.Join(rootDir, devboxDirName),`
`157`		`- "DevboxProfileDefault": filepath.Join(rootDir, nix.ProfilePath),`
`158`		`- "Virtenv": filepath.Join(rootDir, devboxHiddenDirName, "virtenv", pkg),`
	`154`	`+ "DevboxProjectDir": projectDir,`
	`155`	`+ "DevboxDir": filepath.Join(projectDir, devboxDirName, pkg),`
	`156`	`+ "DevboxDirRoot": filepath.Join(projectDir, devboxDirName),`
	`157`	`+ "DevboxProfileDefault": filepath.Join(projectDir, nix.ProfilePath),`
	`158`	`+ "Virtenv": filepath.Join(projectDir, devboxHiddenDirName, "virtenv", pkg),`
`159`	`159`	`}); err != nil {`
`160`	`160`	`return nil, errors.WithStack(err)`
`161`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,17 +7,17 @@ import (`
`7`	`7`	`"github.com/pkg/errors"`
`8`	`8`	`)`
`9`	`9`
`10`		`-func Remove(rootDir string, pkgs []string) error {`
	`10`	`+func Remove(projectDir string, pkgs []string) error {`
`11`	`11`	`for _, pkg := range pkgs {`
`12`		`- if err := os.RemoveAll(filepath.Join(rootDir, VirtenvPath, pkg)); err != nil {`
	`12`	`+ if err := os.RemoveAll(filepath.Join(projectDir, VirtenvPath, pkg)); err != nil {`
`13`	`13`	`return errors.WithStack(err)`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`return nil`
`17`	`17`	`}`
`18`	`18`
`19`		`-func RemoveInvalidSymlinks(rootDir string) error {`
`20`		`- binPath := filepath.Join(rootDir, VirtenvBinPath)`
	`19`	`+func RemoveInvalidSymlinks(projectDir string) error {`
	`20`	`+ binPath := filepath.Join(projectDir, VirtenvBinPath)`
`21`	`21`	`if _, err := os.Stat(binPath); errors.Is(err, os.ErrNotExist) {`
`22`	`22`	`return nil`
`23`	`23`	`}`
`@@ -26,9 +26,9 @@ func RemoveInvalidSymlinks(rootDir string) error {`
`26`	`26`	`return errors.WithStack(err)`
`27`	`27`	`}`
`28`	`28`	`for _, entry := range dirEntry {`
`29`		`- _, err := os.Stat(filepath.Join(rootDir, VirtenvPath, "bin", entry.Name()))`
	`29`	`+ _, err := os.Stat(filepath.Join(projectDir, VirtenvPath, "bin", entry.Name()))`
`30`	`30`	`if errors.Is(err, os.ErrNotExist) {`
`31`		`- os.Remove(filepath.Join(rootDir, VirtenvPath, "bin", entry.Name()))`
	`31`	`+ os.Remove(filepath.Join(projectDir, VirtenvPath, "bin", entry.Name()))`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,10 @@ type service struct {`
`17`	`17`	Stop string `json:"stop"`
`18`	`18`	`}`
`19`	`19`
`20`		`-func GetServices(pkgs []string, rootDir string) (Services, error) {`
	`20`	`+func GetServices(pkgs []string, projectDir string) (Services, error) {`
`21`	`21`	`services := map[string]service{}`
`22`	`22`	`for _, pkg := range pkgs {`
`23`		`- c, err := getConfigIfAny(pkg, rootDir)`
	`23`	`+ c, err := getConfigIfAny(pkg, projectDir)`
`24`	`24`	`if err != nil {`
`25`	`25`	`return nil, err`
`26`	`26`	`}`