refactor(config): make server configuration optional with smart defaults

Author: yarlson

cmd/deploy.go

@@ -41,7 +41,7 @@ func runDeploy(cmd *cobra.Command, args []string) {
 		return
 	}
 
-	if err := deployToServer(cfg.Project.Name, cfg, cfg.Server, pDeploy); err != nil {
+	if err := deployToServer(cfg.Project.Name, cfg, pDeploy); err != nil {
 		pDeploy.Fail(fmt.Sprintf("Deployment failed: %v", err))
 		return
 	}
@@ -63,7 +63,8 @@ func parseConfig(filename string) (*config.Config, error) {
 	return cfg, nil
 }
 
-func deployToServer(project string, cfg *config.Config, server config.Server, spinner *pin.Pin) error {
+func deployToServer(project string, cfg *config.Config, spinner *pin.Pin) error {
+	server := cfg.Server
 	hostname := server.Host
 
 	spinner.UpdateMessage("Connecting to server " + hostname + "...")
@@ -101,7 +102,7 @@ func deployToServer(project string, cfg *config.Config, server config.Server, sp
 	return nil
 }
 
-func connectToServer(server config.Server) (*remote.Runner, error) {
+func connectToServer(server *config.Server) (*remote.Runner, error) {
 	sshKeyPath := filepath.Join(os.Getenv("HOME"), ".ssh", filepath.Base(server.SSHKey))
 	sshClient, _, err := ssh.FindKeyAndConnectWithUser(server.Host, server.Port, server.User, sshKeyPath)
 	if err != nil {

pkg/config/config.go

@@ -20,7 +20,7 @@ import (
 
 type Config struct {
 	Project      Project      `yaml:"project" validate:"required"`
-	Server       Server       `yaml:"server" validate:"required"`
+	Server       *Server      `yaml:"server" validate:"omitempty"`
 	Services     []Service    `yaml:"services" validate:"required,dive"`
 	Dependencies []Dependency `yaml:"dependencies" validate:"dive"`
 	Volumes      []string     `yaml:"volumes" validate:"dive"`
@@ -319,6 +319,11 @@ func ParseConfig(data []byte) (*Config, error) {
 		return nil, fmt.Errorf("error parsing YAML: %v", err)
 	}
 
+	// Set empty server if not specified
+	if config.Server == nil {
+		config.Server = &Server{}
+	}
+
 	// Set default host to project.domain if not specified
 	if config.Server.Host == "" {
 		config.Server.Host = config.Project.Domain

pkg/config/config_test.go

@@ -585,7 +585,7 @@ services:
 					Domain: "example.com",
 					Email:  "admin@example.com",
 				},
-				Server: Server{
+				Server: &Server{
 					Host:   "server.example.com",
 					Port:   22,
 					User:   "deploy",
@@ -625,7 +625,7 @@ services:
 					Domain: "example.com",
 					Email:  "admin@example.com",
 				},
-				Server: Server{
+				Server: &Server{
 					Host:   "example.com",
 					Port:   22,
 					User:   "deploy",
@@ -674,7 +674,7 @@ services:
 					Domain: "example.com",
 					Email:  "admin@example.com",
 				},
-				Server: Server{
+				Server: &Server{
 					Host:   "server.example.com",
 					Port:   22,
 					User:   "deploy",
@@ -729,7 +729,7 @@ dependencies:
 					Domain: "example.com",
 					Email:  "admin@example.com",
 				},
-				Server: Server{
+				Server: &Server{
 					Host:   "server.example.com",
 					Port:   22,
 					User:   "deploy",
@@ -816,7 +816,7 @@ services:
 					Domain: "example.com",
 					Email:  "admin@example.com",
 				},
-				Server: Server{
+				Server: &Server{
 					Host: "server.example.com",
 					Port: 22,
 					User: "deploy",
@@ -1133,3 +1133,24 @@ func TestFindDefaultSSHKey(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, filepath.Join(sshDir, "id_rsa"), foundKey)
 }
+
+func TestNilServer(t *testing.T) {
+	yamlData := []byte(`
+project:
+  name: test-project
+  domain: example.com
+  email: admin@example.com
+services:
+  - name: web
+    image: nginx:latest
+    port: 80
+    routes:
+      - path: /
+`)
+
+	config, err := ParseConfig(yamlData)
+	assert.NoError(t, err)
+	assert.NotNil(t, config)
+	assert.NotNil(t, config.Server)
+	assert.Equal(t, "example.com", config.Server.Host)
+}

pkg/server/server.go

@@ -31,7 +31,7 @@ func Setup(ctx context.Context, cfg *config.Config, dockerCreds DockerCredential
 	return nil
 }
 
-func setupServer(ctx context.Context, cfg config.Server, dockerCreds DockerCredentials, newUserPassword string, spinner *pin.Pin) error {
+func setupServer(ctx context.Context, cfg *config.Server, dockerCreds DockerCredentials, newUserPassword string, spinner *pin.Pin) error {
 	spinner.UpdateMessage("Establishing SSH connection to server " + cfg.Host + " as root...")
 	sshClient, rootKey, err := ssh.FindKeyAndConnectWithUser(cfg.Host, cfg.Port, "root", cfg.SSHKey)
 	if err != nil {
@@ -118,7 +118,7 @@ func createUser(ctx context.Context, runner *remote.Runner, user, password strin
 	return runner.RunCommands(ctx, commands)
 }
 
-func setupSSHKey(ctx context.Context, runner *remote.Runner, server config.Server) error {
+func setupSSHKey(ctx context.Context, runner *remote.Runner, server *config.Server) error {
 	keyData, err := readSSHKey(server.SSHKey)
 	if err != nil {
 		return err