Fix early project resolve

- Add deployment file writing
- Add Sentry integration for deployments
- Refactor command creation for Sentry and Git

Author: chapterjason

commands/deployment.go

@@ -11,14 +11,27 @@ import (
 var deploymentCommand = &console.Command{
 	Name:        "deployment",
 	Description: "Deploy the application",
-	Action: func(c *console.Context) error {
+	Args: []*console.Arg{
+		{
+			Name:        "repository",
+			Description: "The repository to read the release information from.",
+			Optional:    true,
+		},
+	},
+	Action: func(ctx *console.Context) error {
 		p := project.GetProject()
 		env := p.GetEnvironment()
 
 		if !env.IsProd() {
 			return errors.New("Deployment can only be run in production environment")
 		}
 
+		repo := ctx.Args().Get("repository")
+
+		if repo != "" {
+			macro.WriteDeploymentInfo(repo)
+		}
+
 		macro.ComposerInstall()
 		macro.CheckRequirements()
 		macro.ComposerDumpEnv()
@@ -39,7 +52,11 @@ var deploymentCommand = &console.Command{
 		// start
 		macro.SoureCodeScreenStart()
 
-		shell.GetLogger().LogDuration()
+		start, stop := shell.GetLogger().LogDuration()
+
+		if repo != "" {
+			macro.SentryDeploysNew(repo, start, stop)
+		}
 
 		return nil
 	},

env/environment.go

@@ -1,6 +1,7 @@
 package env
 
 import (
+	"github.com/pkg/errors"
 	"os"
 )
 
@@ -63,13 +64,13 @@ func NewEnvironment(directory string) (*Environment, error) {
 	err := loadFile(envMap, directory, ".env")
 
 	if err != nil {
-		return nil, err
+		return nil, errors.Wrap(err, "error loading environment file")
 	}
 
 	err = loadFile(envMap, directory, ".env.local")
 
 	if err != nil {
-		return nil, err
+		return nil, errors.Wrap(err, "failed to load local environment file")
 	}
 
 	envName := os.Getenv("APP_ENV")
@@ -97,7 +98,7 @@ func NewEnvironment(directory string) (*Environment, error) {
 	err = loadPHPFile(envMap, directory, ".env.local.php")
 
 	if err != nil {
-		return nil, err
+		return nil, errors.Wrap(err, "failed to load PHP environment file")
 	}
 
 	return &Environment{

env/load_php_file.go

@@ -1,52 +1,18 @@
 package env
 
 import (
-	"fmt"
-	"os"
-	"os/exec"
+	"github.com/SoureCode/kyx/internal/php"
 	"path/filepath"
 
-	"github.com/joho/godotenv"
 	"github.com/pkg/errors"
 )
 
 func loadPHPFile(envMap map[string]string, directory string, filename string) error {
 	filePath := filepath.Join(directory, filename)
+	parsedEnvMap, err := php.LoadFileDump(filePath)
 
-	info, err := os.Stat(filePath)
 	if err != nil {
-		if os.IsNotExist(err) {
-			return nil
-		}
-
-		return errors.Wrapf(err, "failed to stat file %s", filePath)
-	}
-
-	if info.IsDir() {
-		return errors.Errorf("expected file but found directory at %s", filePath)
-	}
-
-	script := fmt.Sprintf(`$entries = include %q; if (!is_array($entries)) exit(1); foreach ($entries as $key => $value) { echo "$key=$value\n"; }`, filePath)
-	cmd := exec.Command("php", "-r", script)
-	cmd.Dir = directory
-
-	stdout, err := cmd.StdoutPipe()
-	if err != nil {
-		return errors.Wrapf(err, "failed to create stdout pipe for reading %s", filePath)
-	}
-
-	if err := cmd.Start(); err != nil {
-		return errors.Wrapf(err, "failed to start command for reading %s", filePath)
-	}
-
-	parsedEnvMap, err := godotenv.Parse(stdout)
-
-	if err != nil {
-		return errors.Wrapf(err, "failed to parse environment variables from %s", filePath)
-	}
-
-	if err := cmd.Wait(); err != nil {
-		return errors.Wrapf(err, "PHP script execution failed for %s", filePath)
+		return errors.Wrapf(err, "failed to load PHP file: %s", filePath)
 	}
 
 	mergeEnvMaps(envMap, parsedEnvMap)

internal/php/load_file_dump.go

@@ -0,0 +1,54 @@
+package php
+
+import (
+	"bytes"
+	"fmt"
+	"github.com/joho/godotenv"
+	"github.com/pkg/errors"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+)
+
+func LoadFileDump(f string) (map[string]string, error) {
+	info, err := os.Stat(f)
+
+	if err != nil {
+		if os.IsNotExist(err) {
+			return map[string]string{}, nil
+		}
+
+		return nil, errors.Wrap(err, "failed to stat file")
+	}
+
+	if info.IsDir() {
+		return nil, errors.Errorf("expected file but found directory")
+	}
+
+	dir := filepath.Dir(f)
+
+	var buf bytes.Buffer
+
+	script := fmt.Sprintf(`$entries = include %q; if (!is_array($entries)) exit(1); foreach ($entries as $key => $value) { echo "$key=$value\n"; }`, f)
+	cmd := exec.Command("php", "-r", script)
+	cmd.Dir = dir
+	cmd.Stdout = &buf
+	cmd.Stderr = &buf
+
+	if err := cmd.Start(); err != nil {
+		return nil, errors.Wrap(err, "failed to start php command")
+	}
+
+	if err := cmd.Wait(); err != nil {
+		return nil, errors.Wrapf(err, "PHP script execution failed: %s", strings.TrimSpace(buf.String()))
+	}
+
+	parsedEnvMap, err := godotenv.UnmarshalBytes(buf.Bytes())
+
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to parse environment variables")
+	}
+
+	return parsedEnvMap, nil
+}

internal/php/write_file_dump.go

@@ -0,0 +1,27 @@
+package php
+
+import (
+	"os"
+	"strings"
+)
+
+func WriteFileDump(file string, data map[string]string) error {
+	content := formatData(data)
+	return os.WriteFile(file, []byte(content), 0644)
+}
+
+func formatData(data map[string]string) string {
+	lines := []string{
+		"<?php",
+		"",
+		"return [",
+	}
+
+	for key, value := range data {
+		lines = append(lines, "    '"+key+"' => '"+value+"',")
+	}
+
+	lines = append(lines, "];")
+
+	return strings.Join(lines, "\n") + "\n"
+}

macro/sentry_deploys_new.go

@@ -0,0 +1,121 @@
+package macro
+
+import (
+	"fmt"
+	"github.com/SoureCode/kyx/project"
+	"github.com/SoureCode/kyx/shell"
+	"os"
+	"path/filepath"
+	"strings"
+	"time"
+)
+
+func SentryDeploysNew(repo string, startedAt, stoppedAt time.Time) {
+	p := project.GetProject()
+	dir := p.GetDirectory()
+	logger := shell.GetLogger()
+
+	if !filepath.IsAbs(repo) {
+		repo = filepath.Clean(filepath.Join(dir, repo))
+	}
+
+	cmd := shell.NewGitCommand("-C", repo, "rev-parse", "HEAD").
+		WithLogger(logger).
+		WithLogLevel(3)
+
+	if err := cmd.Run(); err != nil {
+		logger.Errorln("Error getting git commit hash:", err)
+		os.Exit(1)
+	}
+
+	hash := strings.TrimSpace(cmd.Stdout())
+	env := p.GetEnvironment()
+
+	// Only run if Sentry is configured
+	sentryUrl, ok := env.Lookup("SENTRY_URL")
+	if !ok {
+		logger.Infoln("Sentry url not configured, skipping sentry integration")
+		return
+	}
+
+	if strings.HasSuffix(sentryUrl, "/") {
+		sentryUrl = strings.TrimSuffix(sentryUrl, "/")
+	}
+
+	sentryOrg, ok := env.Lookup("SENTRY_ORG")
+	if !ok {
+		logger.Infoln("Sentry organization not configured, skipping sentry integration")
+		return
+	}
+
+	sentryProject, ok := env.Lookup("SENTRY_PROJECT")
+	if !ok {
+		logger.Infoln("Sentry project not configured, skipping sentry integration")
+		return
+	}
+
+	_, ok = env.Lookup("SENTRY_AUTH_TOKEN")
+	if !ok {
+		logger.Infoln("Sentry auth token not configured, skipping sentry integration")
+		return
+	}
+
+	appEnv, ok := env.Lookup("APP_ENV")
+	if !ok {
+		logger.Infoln("APP_ENV not configured, skipping sentry integration")
+		return
+	}
+
+	cmd = shell.NewSentryCommand(
+		"--url="+sentryUrl,
+		"releases", "list",
+		"--raw",
+		"--org="+sentryOrg,
+		"--project="+sentryProject,
+	).
+		WithLogger(logger).
+		WithLogLevel(0)
+
+	if err := cmd.Run(); err != nil {
+		logger.Errorln("Error listing Sentry releases:", err)
+		os.Exit(1)
+	}
+
+	releases := strings.TrimSpace(cmd.Stdout())
+
+	if !strings.Contains(releases, hash) {
+		cmd = shell.NewSentryCommand(
+			"releases", "new",
+			"--url="+sentryUrl,
+			"--org="+sentryOrg,
+			"--project="+sentryProject,
+			hash,
+		).
+			WithLogger(logger).
+			WithLogLevel(0)
+
+		if err := cmd.Run(); err != nil {
+			logger.Errorln("Error creating new Sentry release:", err)
+			os.Exit(1)
+		}
+	}
+
+	cmd = shell.NewSentryCommand(
+		"--url="+sentryUrl,
+		"deploys", "new",
+		// "--url="+filepath.Base(filepath.Dir(dir)), // @todo strategy to get the URL
+		"--org="+sentryOrg,
+		"--project="+sentryProject,
+		"--started="+startedAt.Format(time.RFC3339),
+		"--finished="+stoppedAt.Format(time.RFC3339),
+		"--release="+hash,
+		"--env="+appEnv,
+	).
+		WithLogger(logger).
+		WithLogLevel(0)
+
+	if err := cmd.Run(); err != nil {
+		fmt.Fprintf(os.Stderr, "Error executing sentry-cli: %v\n", err)
+		os.Exit(cmd.ExitCode())
+	}
+}

macro/write_deployment_info.go

@@ -0,0 +1,47 @@
+package macro
+
+import (
+	"github.com/SoureCode/kyx/internal/php"
+	"github.com/SoureCode/kyx/project"
+	"github.com/SoureCode/kyx/shell"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+func WriteDeploymentInfo(repo string) {
+	p := project.GetProject()
+	dir := p.GetDirectory()
+	logger := shell.GetLogger()
+
+	if !filepath.IsAbs(repo) {
+		repo = filepath.Clean(filepath.Join(dir, repo))
+	}
+
+	deploymentFile := filepath.Join(dir, "deployment.php")
+	deploymentInfo, err := php.LoadFileDump(deploymentFile)
+
+	if err != nil {
+		logger.Errorln("Error loading deployment info:", err)
+		// fail as the deployment info is required
+		os.Exit(1)
+	}
+
+	cmd := shell.NewGitCommand("-C", repo, "rev-parse", "HEAD").
+		WithLogger(logger).
+		WithLogLevel(0)
+
+	if err := cmd.Run(); err != nil {
+		logger.Errorln("Error getting git commit hash:", err)
+		os.Exit(1)
+	}
+
+	deploymentInfo["git_commit"] = strings.TrimSpace(cmd.Stdout())
+
+	if err := php.WriteFileDump(deploymentFile, deploymentInfo); err != nil {
+		logger.Errorln("Error writing deployment info:", err)
+		os.Exit(1)
+	} else {
+		logger.Infoln("Deployment info written to", deploymentFile)
+	}
+}