Skip to content

Commit

Permalink
[#840] config: fix: Add dagsDir config key (#850)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yohamta
yohamta authored Feb 19, 2025
1 parent 09a89c5 commit ec38f7e
Show file tree
Hide file tree
Showing 5 changed files with 226 additions and 61 deletions.
10 changes: 8 additions & 2 deletions docs/source/config.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,14 @@ Create ``config.yaml`` in ``$HOME/.config/dagu/`` to override default settings.
tz: "Asia/Tokyo" # Timezone (e.g., "America/New_York")
# Directory Configuration
dagsDir: "${HOME}/.config/dagu/dags" # DAG definitions location
workDir: "/path/to/work" # Default working directory
dagsDir: "${HOME}/.config/dagu/dags" # DAG definitions location
workDir: "/path/to/work" # Default working directory
logDir: "${HOME}/.local/share/dagu/logs" # Log files location
dataDir: "${HOME}/.local/share/dagu/history" # Application data location
suspendFlagsDir: "${HOME}/.config/dagu/suspend" # DAG suspend flags location
adminLogsDir: "${HOME}/.local/share/admin" # Admin logs location
# Common Configuration for all DAGs
baseConfig: "${HOME}/.config/dagu/base.yaml" # Base DAG config
# UI Configuration
Expand Down
15 changes: 11 additions & 4 deletions internal/config/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,18 @@ import (
)

// Config represents the server configuration with both new and legacy fields
// TODO: Separate loading struct and runtime struct
type Config struct {
// Server settings
Host string `mapstructure:"host"`
Port int `mapstructure:"port"`
Debug bool `mapstructure:"debug"`
BasePath string `mapstructure:"basePath"`
APIBasePath string `mapstructure:"apiBasePath"`
APIBaseURL string `mapstructure:"apiBaseURL"` // For backward compatibility
WorkDir string `mapstructure:"workDir"`
Headless bool `mapstructure:"headless"`
// Deprecated: Use APIBasePath instead
APIBaseURL string `mapstructure:"apiBaseURL"`
WorkDir string `mapstructure:"workDir"`
Headless bool `mapstructure:"headless"`

// Authentication
Auth Auth `mapstructure:"auth"`
Expand All @@ -30,6 +32,8 @@ type Config struct {
// Note: These fields are used for backward compatibility and should not be used in new code
// Deprecated: Use Auth.Basic.Enabled instead
DAGs string `mapstructure:"dags"`
// Deprecated: Use Paths.DAGsDir instead
DAGsDir string `mapstructure:"dagsDir"`
// Deprecated: Use Paths.Executable instead
Executable string `mapstructure:"executable"`
// Deprecated: Use Paths.LogDir instead
Expand Down Expand Up @@ -152,7 +156,7 @@ func (c *Config) MigrateLegacyConfig() {
}

func (c *Config) migrateServerSettings() {
if c.APIBaseURL != "" {
if c.APIBasePath == "" && c.APIBaseURL != "" {
c.APIBasePath = c.APIBaseURL
}
}
Expand All @@ -174,6 +178,9 @@ func (c *Config) migratePaths() {
if c.DAGs != "" {
c.Paths.DAGsDir = c.DAGs
}
if c.DAGsDir != "" {
c.Paths.DAGsDir = c.DAGsDir
}
if c.Executable != "" {
c.Paths.Executable = c.Executable
}
Expand Down
257 changes: 204 additions & 53 deletions internal/config/config_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import (
"os"
"path/filepath"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestConfig_MigrateLegacyConfig(t *testing.T) {
Expand Down Expand Up @@ -135,32 +138,133 @@ func TestConfig_MigrateLegacyConfig(t *testing.T) {
}

func TestConfigLoader_Load(t *testing.T) {
// Create temporary directory for test files
tmpDir, err := os.MkdirTemp("", "dagu-config-test")
if err != nil {
t.Fatalf("failed to create temp dir: %v", err)
}
defer os.RemoveAll(tmpDir)

// Set up test environment
os.Setenv("HOME", tmpDir)
os.Setenv("DAGU_HOST", "localhost")
os.Setenv("DAGU_PORT", "9090")
defer func() {
os.Unsetenv("HOME")
os.Unsetenv("DAGU_HOST")
os.Unsetenv("DAGU_PORT")
}()

// Create test config directory
configDir := filepath.Join(tmpDir, ".config", "dagu")
if err := os.MkdirAll(configDir, 0755); err != nil {
t.Fatalf("failed to create config dir: %v", err)
type testCase struct {
name string
data string
setup func(t *testing.T)
expectedConfig *Config
}

// Create test config file
configFile := filepath.Join(configDir, "config.yaml")
testConfig := []byte(`
tests := []testCase{
{
name: "Defaults",
data: `
dagsDir: "/dags"
logsDir: "/logs"
dataDir: "/data"
suspendFlagsDir: "/suspend"
adminLogsDir: "/admin/logs"
`,
expectedConfig: &Config{
Host: "127.0.0.1",
Port: 8080,
APIBasePath: "/api/v1",
LogFormat: "text",
TZ: "Asia/Tokyo",
UI: UI{
NavbarTitle: "Dagu",
MaxDashboardPageLimit: 100,
LogEncodingCharset: "utf-8",
},
},
},
{
name: "TopLevelFields",
data: `
dagsDir: "/dags"
logsDir: "/logs"
dataDir: "/data"
suspendFlagsDir: "/suspend"
adminLogsDir: "/admin/logs"
baseConfig: "/base.yaml"
BasePath: "/proxy"
APIBasePath: "/proxy/api/v1"
WorkDir: "/work"
Headless: true
`,
expectedConfig: &Config{
Host: "127.0.0.1",
Port: 8080,
APIBasePath: "/proxy/api/v1",
LogFormat: "text",
TZ: "Asia/Tokyo",
BasePath: "/proxy",
WorkDir: "/work",
Headless: true,
UI: UI{
NavbarTitle: "Dagu",
MaxDashboardPageLimit: 100,
LogEncodingCharset: "utf-8",
},
},
},
{
name: "Auth",
data: `
dagsDir: "/dags"
logsDir: "/logs"
dataDir: "/data"
suspendFlagsDir: "/suspend"
adminLogsDir: "/admin/logs"
auth:
basic:
enabled: true
username: "admin"
password: "password"
token:
enabled: true
value: "abc123"
`,
expectedConfig: &Config{
Host: "127.0.0.1",
Port: 8080,
APIBasePath: "/api/v1",
LogFormat: "text",
TZ: "Asia/Tokyo",
UI: UI{
NavbarTitle: "Dagu",
MaxDashboardPageLimit: 100,
LogEncodingCharset: "utf-8",
},
Auth: Auth{
Basic: AuthBasic{
Enabled: true,
Username: "admin",
Password: "password",
},
Token: AuthToken{
Enabled: true,
Value: "abc123",
},
},
},
},
{
name: "UI",
data: `
ui:
logEncodingCharset: "shift-jis"
navbarColor: "#FF0000"
navbarTitle: "Test Dashboard"
maxDashboardPageLimit: 50
`,
expectedConfig: &Config{
Host: "127.0.0.1",
Port: 8080,
APIBasePath: "/api/v1",
LogFormat: "text",
TZ: "Asia/Tokyo",
UI: UI{
NavbarTitle: "Test Dashboard",
NavbarColor: "#FF0000",
MaxDashboardPageLimit: 50,
LogEncodingCharset: "shift-jis",
},
},
},
{
name: "LoadFromEnv",
data: `
host: "127.0.0.1"
port: 8080
debug: true
Expand All @@ -172,39 +276,86 @@ auth:
ui:
navbarTitle: "Test Dashboard"
maxDashboardPageLimit: 50
`)
if err := os.WriteFile(configFile, testConfig, 0644); err != nil {
t.Fatalf("failed to write config file: %v", err)
`,
setup: func(t *testing.T) {
os.Setenv("DAGU_HOST", "localhost")
os.Setenv("DAGU_PORT", "9090")
t.Cleanup(func() {
os.Unsetenv("DAGU_HOST")
os.Unsetenv("DAGU_PORT")
})
},
expectedConfig: &Config{
Host: "localhost",
Port: 9090,
Debug: true,
APIBasePath: "/api/v1",
LogFormat: "text",
TZ: "Asia/Tokyo",
Auth: Auth{
Basic: AuthBasic{
Enabled: true,
Username: "admin",
Password: "secret",
},
},
UI: UI{
NavbarTitle: "Test Dashboard",
MaxDashboardPageLimit: 50,
LogEncodingCharset: "utf-8",
},
},
},
}

loader := NewConfigLoader()
cfg, err := loader.Load()
if err != nil {
t.Fatalf("Load() error = %v", err)
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
tmpDir, err := os.MkdirTemp("", "dagu-config-test")
require.NoError(t, err, "failed to create temp dir: %v", err)

// Verify loaded configuration
if cfg.Host != "localhost" {
t.Errorf("Host = %v, want localhost", cfg.Host)
}
if cfg.Port != 9090 {
t.Errorf("Port = %v, want 9090", cfg.Port)
}
if !cfg.Debug {
t.Error("Debug = false, want true")
}
if !cfg.Auth.Basic.Enabled {
t.Error("Auth.Basic.Enabled = false, want true")
}
if cfg.Auth.Basic.Username != "admin" {
t.Errorf("Auth.Basic.Username = %v, want admin", cfg.Auth.Basic.Username)
}
if cfg.Auth.Basic.Password != "secret" {
t.Errorf("Auth.Basic.Password = %v, want secret", cfg.Auth.Basic.Password)
}
if cfg.UI.NavbarTitle != "Test Dashboard" {
t.Errorf("UI.NavbarTitle = %v, want Test Dashboard", cfg.UI.NavbarTitle)
os.Setenv("HOME", tmpDir)
os.Setenv("DAGU_TZ", "Asia/Tokyo")

t.Cleanup(func() {
os.RemoveAll(tmpDir)
os.Unsetenv("HOME")
os.Unsetenv("DAGU_TZ")
})

if tc.setup != nil {
tc.setup(t)
}

configDir := filepath.Join(tmpDir, ".config", "dagu")
err = os.MkdirAll(configDir, 0755)
require.NoError(t, err, "failed to create config dir: %v", err)

configFile := filepath.Join(configDir, "config.yaml")
testConfig := []byte(tc.data)
err = os.WriteFile(configFile, testConfig, 0644)
require.NoError(t, err, "failed to write config file: %v", err)

cfg, err := Load()
require.NoError(t, err, "failed to load config: %v", err)

// assert.EqualValues(t, tc.expectedConfig, cfg)
assert.Equal(t, tc.expectedConfig.Host, cfg.Host, "Host = %v, want %v", cfg.Host, tc.expectedConfig.Host)
assert.Equal(t, tc.expectedConfig.Port, cfg.Port, "Port = %v, want %v", cfg.Port, tc.expectedConfig.Port)
assert.Equal(t, tc.expectedConfig.Debug, cfg.Debug, "Debug = %v, want %v", cfg.Debug, tc.expectedConfig.Debug)
assert.Equal(t, tc.expectedConfig.BasePath, cfg.BasePath, "BasePath = %v, want %v", cfg.BasePath, tc.expectedConfig.BasePath)
assert.Equal(t, tc.expectedConfig.APIBasePath, cfg.APIBasePath, "APIBasePath = %v, want %v", cfg.APIBasePath, tc.expectedConfig.APIBasePath)
assert.Equal(t, tc.expectedConfig.WorkDir, cfg.WorkDir, "WorkDir = %v, want %v", cfg.WorkDir, tc.expectedConfig.WorkDir)
assert.Equal(t, tc.expectedConfig.Headless, cfg.Headless, "Headless = %v, want %v", cfg.Headless, tc.expectedConfig.Headless)
assert.Equal(t, tc.expectedConfig.LogFormat, cfg.LogFormat, "LogFormat = %v, want %v", cfg.LogFormat, tc.expectedConfig.LogFormat)
assert.Equal(t, tc.expectedConfig.LatestStatusToday, cfg.LatestStatusToday, "LatestStatusToday = %v, want %v", cfg.LatestStatusToday, tc.expectedConfig.LatestStatusToday)
assert.Equal(t, tc.expectedConfig.TZ, cfg.TZ, "TZ = %v, want %v", cfg.TZ, tc.expectedConfig.TZ)
assert.Equal(t, tc.expectedConfig.Auth, cfg.Auth, "Auth = %v, want %v", cfg.Auth, tc.expectedConfig.Auth)
assert.Equal(t, tc.expectedConfig.UI, cfg.UI, "UI = %v, want %v", cfg.UI, tc.expectedConfig.UI)
assert.Equal(t, tc.expectedConfig.RemoteNodes, cfg.RemoteNodes, "RemoteNodes = %v, want %v", cfg.RemoteNodes, tc.expectedConfig.RemoteNodes)
assert.Equal(t, tc.expectedConfig.TLS, cfg.TLS, "TLS = %v, want %v", cfg.TLS, tc.expectedConfig.TLS)
})
}

}

func TestConfigLoader_ValidateConfig(t *testing.T) {
Expand Down
1 change: 1 addition & 0 deletions internal/config/loader.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ func (l *ConfigLoader) setDefaultValues(resolver PathResolver) {
viper.SetDefault("debug", false)
viper.SetDefault("basePath", "")
viper.SetDefault("apiBaseURL", "/api/v1")
viper.SetDefault("apiBasePath", "/api/v1")
viper.SetDefault("latestStatusToday", false)

// UI settings
Expand Down
4 changes: 2 additions & 2 deletions internal/frontend/frontend.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
func New(cfg *config.Config, cli client.Client) *server.Server {
var apiHandlers []server.Handler

dagAPIHandler := handlers.NewDAG(cli, cfg.UI.LogEncodingCharset, cfg.RemoteNodes, cfg.APIBaseURL)
dagAPIHandler := handlers.NewDAG(cli, cfg.UI.LogEncodingCharset, cfg.RemoteNodes, cfg.APIBasePath)
apiHandlers = append(apiHandlers, dagAPIHandler)

systemAPIHandler := handlers.NewSystem()
Expand All @@ -30,7 +30,7 @@ func New(cfg *config.Config, cli client.Client) *server.Server {
NavbarColor: cfg.UI.NavbarColor,
NavbarTitle: cfg.UI.NavbarTitle,
MaxDashboardPageLimit: cfg.UI.MaxDashboardPageLimit,
APIBaseURL: cfg.APIBaseURL,
APIBaseURL: cfg.APIBasePath,
TimeZone: cfg.TZ,
RemoteNodes: remoteNodes,
Headless: cfg.Headless,
Expand Down

0 comments on commit ec38f7e

Please sign in to comment.