fsutils.go

package fsutils

import (
	"fmt"
	"log"
	"os"
	"os/exec"
	"path/filepath"
	"runtime"
	"strings"
)

// ToTempFile takes a string to write to a temp file. It returns the filename and an error.
func ToTempFile(content string) (string, error) {
	f, err := os.CreateTemp("", "")
	if err != nil {
		return "", err
	}
	defer f.Close()

	n, err := f.WriteString(content)
	if err != nil {
		return "", err
	}

	if n != len(content) {
		return "", fmt.Errorf("expected to write %d bytes, actually wrote %d", len(content), n)
	}
	return f.Name(), nil
}

// IsDirectory checks the provided path is a directory by first checking something exists at that path
// and then checking that it is a directory.
func IsDirectory(dir string) bool {
	stat, err := os.Stat(dir)
	if err != nil {
		return false
	}
	return stat.IsDir()
}

// MustGetThisDir returns the absolute path to the diretory containing the .go file containing the calling function
func MustGetThisDir() string {
	_, thisFile, _, ok := runtime.Caller(1)
	if !ok {
		log.Fatalf("Failed to get runtime.Caller")
	}
	return filepath.Dir(thisFile)
}

// GoModPath returns the absolute path to the go.mod file for the current dir
func GoModPath() string {
	out, err := exec.Command("go", "env", "GOMOD").CombinedOutput()
	if err != nil {
		log.Fatal(err)
	}
	return strings.TrimSpace(string(out))
}

// GetModuleRoot returns the project root dir (based on gomod location)
func GetModuleRoot() string {
	return filepath.Dir(GoModPath())
}