startup.flags_test.go 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. package main
  2. import (
  3. "encoding/json"
  4. "flag"
  5. "testing"
  6. )
  7. func testDefaultBootFlags() bootFlags {
  8. return bootFlags{
  9. Hostname: "My ArOZ",
  10. MaxUploadSize: 8192,
  11. MaxFileUploadBuff: 25,
  12. FileIOBuffer: 1024,
  13. DisableIPResolver: false,
  14. EnableHomePage: true,
  15. EnableDirListing: true,
  16. EnableGzip: true,
  17. }
  18. }
  19. func testStoredBootFlags(t *testing.T, fields map[string]interface{}) map[string]json.RawMessage {
  20. t.Helper()
  21. js, err := json.Marshal(fields)
  22. if err != nil {
  23. t.Fatalf("marshal stored fields: %v", err)
  24. }
  25. stored := map[string]json.RawMessage{}
  26. if err := json.Unmarshal(js, &stored); err != nil {
  27. t.Fatalf("unmarshal stored fields: %v", err)
  28. }
  29. return stored
  30. }
  31. func TestMergeBootFlags(t *testing.T) {
  32. fullStored := map[string]interface{}{
  33. "Hostname": "Saved Host",
  34. "MaxUploadSize": 1024,
  35. "MaxFileUploadBuff": 50,
  36. "FileIOBuffer": 4096,
  37. "DisableIPResolver": true,
  38. "EnableHomePage": false,
  39. "EnableDirListing": false,
  40. "EnableGzip": false,
  41. }
  42. tests := []struct {
  43. name string
  44. runtime bootFlags
  45. stored map[string]interface{}
  46. explicit map[string]bool
  47. want bootFlags
  48. }{
  49. {
  50. name: "nothing stored keeps runtime defaults",
  51. runtime: testDefaultBootFlags(),
  52. stored: map[string]interface{}{},
  53. want: testDefaultBootFlags(),
  54. },
  55. {
  56. name: "stored values restored when no start flag given",
  57. runtime: testDefaultBootFlags(),
  58. stored: fullStored,
  59. want: bootFlags{
  60. Hostname: "Saved Host",
  61. MaxUploadSize: 1024,
  62. MaxFileUploadBuff: 50,
  63. FileIOBuffer: 4096,
  64. DisableIPResolver: true,
  65. EnableHomePage: false,
  66. EnableDirListing: false,
  67. EnableGzip: false,
  68. },
  69. },
  70. {
  71. name: "explicit start flags win over stored values",
  72. runtime: bootFlags{
  73. Hostname: "Flag Host",
  74. MaxUploadSize: 8192,
  75. MaxFileUploadBuff: 25,
  76. FileIOBuffer: 1024,
  77. EnableHomePage: true,
  78. EnableDirListing: true,
  79. EnableGzip: true,
  80. },
  81. stored: fullStored,
  82. explicit: map[string]bool{"hostname": true, "homepage": true, "gzip": true},
  83. want: bootFlags{
  84. Hostname: "Flag Host",
  85. MaxUploadSize: 1024,
  86. MaxFileUploadBuff: 50,
  87. FileIOBuffer: 4096,
  88. DisableIPResolver: true,
  89. EnableHomePage: true,
  90. EnableDirListing: false,
  91. EnableGzip: true,
  92. },
  93. },
  94. {
  95. name: "partial stored config only restores its fields",
  96. runtime: testDefaultBootFlags(),
  97. stored: map[string]interface{}{"MaxUploadSize": 2048},
  98. want: func() bootFlags {
  99. c := testDefaultBootFlags()
  100. c.MaxUploadSize = 2048
  101. return c
  102. }(),
  103. },
  104. {
  105. name: "invalid stored values fall back to runtime",
  106. runtime: testDefaultBootFlags(),
  107. stored: map[string]interface{}{
  108. "Hostname": " ",
  109. "MaxUploadSize": 0,
  110. "MaxFileUploadBuff": -1,
  111. "FileIOBuffer": "not a number",
  112. },
  113. want: testDefaultBootFlags(),
  114. },
  115. }
  116. for _, tt := range tests {
  117. t.Run(tt.name, func(t *testing.T) {
  118. got := mergeBootFlags(tt.runtime, testStoredBootFlags(t, tt.stored), tt.explicit)
  119. if got != tt.want {
  120. t.Errorf("mergeBootFlags() = %+v, want %+v", got, tt.want)
  121. }
  122. })
  123. }
  124. }
  125. func TestValidateBootFlags(t *testing.T) {
  126. tests := []struct {
  127. name string
  128. mutate func(c *bootFlags)
  129. wantErr bool
  130. }{
  131. {name: "defaults are valid", mutate: func(c *bootFlags) {}},
  132. {name: "host name is trimmed", mutate: func(c *bootFlags) { c.Hostname = " Box " }},
  133. {name: "empty host name", mutate: func(c *bootFlags) { c.Hostname = " " }, wantErr: true},
  134. {name: "zero upload size", mutate: func(c *bootFlags) { c.MaxUploadSize = 0 }, wantErr: true},
  135. {name: "negative upload buffer", mutate: func(c *bootFlags) { c.MaxFileUploadBuff = -5 }, wantErr: true},
  136. {name: "zero io buffer", mutate: func(c *bootFlags) { c.FileIOBuffer = 0 }, wantErr: true},
  137. }
  138. for _, tt := range tests {
  139. t.Run(tt.name, func(t *testing.T) {
  140. c := testDefaultBootFlags()
  141. tt.mutate(&c)
  142. err := validateBootFlags(&c)
  143. if (err != nil) != tt.wantErr {
  144. t.Fatalf("validateBootFlags() error = %v, wantErr %v", err, tt.wantErr)
  145. }
  146. if err == nil && c.Hostname != "My ArOZ" && c.Hostname != "Box" {
  147. t.Errorf("unexpected host name after validation: %q", c.Hostname)
  148. }
  149. })
  150. }
  151. }
  152. func TestBootFlagNamesCoverFlags(t *testing.T) {
  153. for field, name := range bootFlagNames {
  154. if flag.Lookup(name) == nil {
  155. t.Errorf("field %s maps to unknown start flag -%s", field, name)
  156. }
  157. }
  158. if len(bootFlagNames) != 8 {
  159. t.Errorf("expected 8 mapped fields, got %d", len(bootFlagNames))
  160. }
  161. }