load_failure_issues_test.go 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. package config_test
  2. import (
  3. "os"
  4. "path/filepath"
  5. "testing"
  6. "github.com/OliveTin/OliveTin/internal/config"
  7. "github.com/OliveTin/OliveTin/internal/configissues"
  8. "github.com/knadh/koanf/parsers/yaml"
  9. "github.com/knadh/koanf/providers/file"
  10. "github.com/knadh/koanf/v2"
  11. "github.com/stretchr/testify/assert"
  12. "github.com/stretchr/testify/require"
  13. )
  14. func appendSourceFromFile(t *testing.T, basePath string) {
  15. t.Helper()
  16. k := koanf.New(".")
  17. require.NoError(t, k.Load(file.Provider(basePath), yaml.Parser()))
  18. config.AppendSource(config.DefaultConfig(), k, basePath)
  19. }
  20. func findStickyIssue(code string) *configissues.Issue {
  21. for _, issue := range configissues.CopySticky() {
  22. if issue.Code == code {
  23. return &issue
  24. }
  25. }
  26. return nil
  27. }
  28. func TestAppendSourceReportsUnparseableIncludeFile(t *testing.T) {
  29. dir := t.TempDir()
  30. includeDir := filepath.Join(dir, "config.d")
  31. require.NoError(t, os.Mkdir(includeDir, 0o755))
  32. basePath := filepath.Join(dir, "config.yaml")
  33. require.NoError(t, os.WriteFile(basePath, []byte("include: config.d\n"), 0o644))
  34. includePath := filepath.Join(includeDir, "10-broken.yaml")
  35. require.NoError(t, os.WriteFile(includePath, []byte("actions: [\n - title: broken\n"), 0o644))
  36. appendSourceFromFile(t, basePath)
  37. issue := findStickyIssue(configissues.CodeIncludeParse)
  38. require.NotNil(t, issue)
  39. assert.Equal(t, configissues.SeverityError, issue.Severity)
  40. assert.Equal(t, includePath, issue.ConfigFile)
  41. }
  42. func TestAppendSourceReportsDecodeFailure(t *testing.T) {
  43. basePath := filepath.Join(t.TempDir(), "config.yaml")
  44. require.NoError(t, os.WriteFile(basePath, []byte("actions: not-a-list-of-actions\n"), 0o644))
  45. appendSourceFromFile(t, basePath)
  46. issue := findStickyIssue(configissues.CodeConfigDecode)
  47. require.NotNil(t, issue)
  48. assert.Equal(t, configissues.SeverityError, issue.Severity)
  49. assert.True(t, hasLiveIssue(configissues.CodeConfigDecode), "decode failure should be visible without a rebuild")
  50. }
  51. func hasLiveIssue(code string) bool {
  52. for _, issue := range configissues.List() {
  53. if issue.Code == code {
  54. return true
  55. }
  56. }
  57. return false
  58. }
  59. func TestAppendSourceClearsLoadFailuresOnSuccessfulLoad(t *testing.T) {
  60. basePath := filepath.Join(t.TempDir(), "config.yaml")
  61. require.NoError(t, os.WriteFile(basePath, []byte("actions: not-a-list-of-actions\n"), 0o644))
  62. appendSourceFromFile(t, basePath)
  63. require.NotNil(t, findStickyIssue(configissues.CodeConfigDecode))
  64. require.NoError(t, os.WriteFile(basePath, []byte("pageTitle: Fixed\n"), 0o644))
  65. appendSourceFromFile(t, basePath)
  66. assert.Nil(t, findStickyIssue(configissues.CodeConfigDecode))
  67. }