config_test.go 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. package guerrilla
  2. import (
  3. "github.com/flashmob/go-guerrilla/backends"
  4. "github.com/flashmob/go-guerrilla/log"
  5. "github.com/flashmob/go-guerrilla/tests/testcert"
  6. "io/ioutil"
  7. "os"
  8. "strings"
  9. "testing"
  10. "time"
  11. )
  12. // a configuration file with a dummy backend
  13. //
  14. var configJsonA = `
  15. {
  16. "log_file" : "./tests/testlog",
  17. "log_level" : "debug",
  18. "pid_file" : "tests/go-guerrilla.pid",
  19. "allowed_hosts": ["spam4.me","grr.la"],
  20. "backend_config" :
  21. {
  22. "log_received_mails" : true
  23. },
  24. "servers" : [
  25. {
  26. "is_enabled" : true,
  27. "host_name":"mail.guerrillamail.com",
  28. "max_size": 100017,
  29. "timeout":160,
  30. "listen_interface":"127.0.0.1:2526",
  31. "max_clients": 2,
  32. "tls" : {
  33. "start_tls_on":false,
  34. "tls_always_on":false,
  35. "private_key_file":"config_test.go",
  36. "public_key_file":"config_test.go"
  37. }
  38. },
  39. {
  40. "is_enabled" : true,
  41. "host_name":"mail2.guerrillamail.com",
  42. "max_size":1000001,
  43. "timeout":180,
  44. "listen_interface":"127.0.0.1:2527",
  45. "max_clients":1,
  46. "tls" : {
  47. "private_key_file":"./tests/mail2.guerrillamail.com.key.pem",
  48. "public_key_file":"./tests/mail2.guerrillamail.com.cert.pem",
  49. "tls_always_on":false,
  50. "start_tls_on":true
  51. }
  52. },
  53. {
  54. "is_enabled" : true,
  55. "host_name":"mail.stopme.com",
  56. "max_size": 100017,
  57. "timeout":160,
  58. "listen_interface":"127.0.0.1:9999",
  59. "max_clients": 2,
  60. "tls" : {
  61. "private_key_file":"config_test.go",
  62. "public_key_file":"config_test.go",
  63. "start_tls_on":false,
  64. "tls_always_on":false
  65. }
  66. },
  67. {
  68. "is_enabled" : true,
  69. "host_name":"mail.disableme.com",
  70. "max_size": 100017,
  71. "timeout":160,
  72. "listen_interface":"127.0.0.1:3333",
  73. "max_clients": 2,
  74. "tls" : {
  75. "private_key_file":"config_test.go",
  76. "public_key_file":"config_test.go",
  77. "start_tls_on":false,
  78. "tls_always_on":false
  79. }
  80. }
  81. ]
  82. }
  83. `
  84. // B is A's configuration with different values from B
  85. // 127.0.0.1:4654 will be added
  86. // A's 127.0.0.1:3333 is disabled
  87. // B's 127.0.0.1:9999 is removed
  88. var configJsonB = `
  89. {
  90. "log_file" : "./tests/testlog",
  91. "log_level" : "debug",
  92. "pid_file" : "tests/different-go-guerrilla.pid",
  93. "allowed_hosts": ["spam4.me","grr.la","newhost.com"],
  94. "backend_config" :
  95. {
  96. "log_received_mails" : true
  97. },
  98. "servers" : [
  99. {
  100. "is_enabled" : true,
  101. "host_name":"mail.guerrillamail.com",
  102. "max_size": 100017,
  103. "timeout":161,
  104. "listen_interface":"127.0.0.1:2526",
  105. "max_clients": 3,
  106. "tls" : {
  107. "private_key_file":"./tests/mail2.guerrillamail.com.key.pem",
  108. "public_key_file": "./tests/mail2.guerrillamail.com.cert.pem",
  109. "start_tls_on":false,
  110. "tls_always_on":true
  111. }
  112. },
  113. {
  114. "is_enabled" : true,
  115. "host_name":"mail2.guerrillamail.com",
  116. "max_size": 100017,
  117. "timeout":160,
  118. "listen_interface":"127.0.0.1:2527",
  119. "log_file" : "./tests/testlog",
  120. "max_clients": 2,
  121. "tls" : {
  122. "private_key_file":"./tests/mail2.guerrillamail.com.key.pem",
  123. "public_key_file": "./tests/mail2.guerrillamail.com.cert.pem",
  124. "start_tls_on":true,
  125. "tls_always_on":false
  126. }
  127. },
  128. {
  129. "is_enabled" : true,
  130. "host_name":"mail.guerrillamail.com",
  131. "max_size":1000001,
  132. "timeout":180,
  133. "listen_interface":"127.0.0.1:4654",
  134. "max_clients":1,
  135. "tls" : {
  136. "private_key_file":"config_test.go",
  137. "public_key_file":"config_test.go",
  138. "start_tls_on":false,
  139. "tls_always_on":false
  140. }
  141. },
  142. {
  143. "is_enabled" : false,
  144. "host_name":"mail.disbaleme.com",
  145. "max_size": 100017,
  146. "timeout":160,
  147. "listen_interface":"127.0.0.1:3333",
  148. "max_clients": 2,
  149. "tls" : {
  150. "private_key_file":"config_test.go",
  151. "public_key_file":"config_test.go",
  152. "start_tls_on":false,
  153. "tls_always_on":false
  154. }
  155. }
  156. ]
  157. }
  158. `
  159. func TestConfigLoad(t *testing.T) {
  160. if err := testcert.GenerateCert("mail2.guerrillamail.com", "", 365*24*time.Hour, false, 2048, "P256", "./tests/"); err != nil {
  161. t.Error(err)
  162. }
  163. defer func() {
  164. if err := deleteIfExists("../tests/mail2.guerrillamail.com.cert.pem"); err != nil {
  165. t.Error(err)
  166. }
  167. if err := deleteIfExists("../tests/mail2.guerrillamail.com.key.pem"); err != nil {
  168. t.Error(err)
  169. }
  170. }()
  171. ac := &AppConfig{}
  172. if err := ac.Load([]byte(configJsonA)); err != nil {
  173. t.Error("Cannot load config |", err)
  174. t.SkipNow()
  175. }
  176. expectedLen := 4
  177. if len(ac.Servers) != expectedLen {
  178. t.Error("len(ac.Servers), expected", expectedLen, "got", len(ac.Servers))
  179. t.SkipNow()
  180. }
  181. // did we got the timestamps?
  182. if ac.Servers[0].TLS._privateKeyFileMtime <= 0 {
  183. t.Error("failed to read timestamp for _privateKeyFileMtime, got", ac.Servers[0].TLS._privateKeyFileMtime)
  184. }
  185. }
  186. // Test the sample config to make sure a valid one is given!
  187. func TestSampleConfig(t *testing.T) {
  188. fileName := "goguerrilla.conf.sample"
  189. if jsonBytes, err := ioutil.ReadFile(fileName); err == nil {
  190. ac := &AppConfig{}
  191. if err := ac.Load(jsonBytes); err != nil {
  192. // sample config can have broken tls certs
  193. if strings.Index(err.Error(), "cannot use TLS config for [127.0.0.1:25") != 0 {
  194. t.Error("Cannot load config", fileName, "|", err)
  195. t.FailNow()
  196. }
  197. }
  198. } else {
  199. t.Error("Error reading", fileName, "|", err)
  200. }
  201. }
  202. // make sure that we get all the config change events
  203. func TestConfigChangeEvents(t *testing.T) {
  204. if err := testcert.GenerateCert("mail2.guerrillamail.com", "", 365*24*time.Hour, false, 2048, "P256", "./tests/"); err != nil {
  205. t.Error(err)
  206. }
  207. defer func() {
  208. if err := deleteIfExists("../tests/mail2.guerrillamail.com.cert.pem"); err != nil {
  209. t.Error(err)
  210. }
  211. if err := deleteIfExists("../tests/mail2.guerrillamail.com.key.pem"); err != nil {
  212. t.Error(err)
  213. }
  214. }()
  215. oldconf := &AppConfig{}
  216. if err := oldconf.Load([]byte(configJsonA)); err != nil {
  217. t.Error(err)
  218. }
  219. logger, _ := log.GetLogger(oldconf.LogFile, oldconf.LogLevel)
  220. bcfg := backends.BackendConfig{"log_received_mails": true}
  221. backend, err := backends.New(bcfg, logger)
  222. if err != nil {
  223. t.Error("cannot create backend", err)
  224. }
  225. app, err := New(oldconf, backend, logger)
  226. if err != nil {
  227. t.Error("cannot create daemon", err)
  228. }
  229. // simulate timestamp change
  230. time.Sleep(time.Second + time.Millisecond*500)
  231. if err := os.Chtimes(oldconf.Servers[1].TLS.PrivateKeyFile, time.Now(), time.Now()); err != nil {
  232. t.Error(err)
  233. }
  234. if err := os.Chtimes(oldconf.Servers[1].TLS.PublicKeyFile, time.Now(), time.Now()); err != nil {
  235. t.Error(err)
  236. }
  237. newconf := &AppConfig{}
  238. if err := newconf.Load([]byte(configJsonB)); err != nil {
  239. t.Error(err)
  240. }
  241. newconf.Servers[0].LogFile = log.OutputOff.String() // test for log file change
  242. newconf.LogLevel = log.InfoLevel.String()
  243. newconf.LogFile = "off"
  244. expectedEvents := map[Event]bool{
  245. EventConfigPidFile: false,
  246. EventConfigLogFile: false,
  247. EventConfigLogLevel: false,
  248. EventConfigAllowedHosts: false,
  249. EventConfigServerNew: false, // 127.0.0.1:4654 will be added
  250. EventConfigServerRemove: false, // 127.0.0.1:9999 server removed
  251. EventConfigServerStop: false, // 127.0.0.1:3333: server (disabled)
  252. EventConfigServerLogFile: false, // 127.0.0.1:2526
  253. EventConfigServerLogReopen: false, // 127.0.0.1:2527
  254. EventConfigServerTimeout: false, // 127.0.0.1:2526 timeout
  255. //"server_change:tls_config": false, // 127.0.0.1:2526
  256. EventConfigServerMaxClients: false, // 127.0.0.1:2526
  257. EventConfigServerTLSConfig: false, // 127.0.0.1:2527 timestamp changed on certificates
  258. }
  259. toUnsubscribe := map[Event]func(c *AppConfig){}
  260. toUnsubscribeSrv := map[Event]func(c *ServerConfig){}
  261. for event := range expectedEvents {
  262. // Put in anon func since range is overwriting event
  263. func(e Event) {
  264. if strings.Contains(e.String(), "config_change") {
  265. f := func(c *AppConfig) {
  266. expectedEvents[e] = true
  267. }
  268. _ = app.Subscribe(event, f)
  269. toUnsubscribe[event] = f
  270. } else {
  271. // must be a server config change then
  272. f := func(c *ServerConfig) {
  273. expectedEvents[e] = true
  274. }
  275. _ = app.Subscribe(event, f)
  276. toUnsubscribeSrv[event] = f
  277. }
  278. }(event)
  279. }
  280. // emit events
  281. newconf.EmitChangeEvents(oldconf, app)
  282. // unsubscribe
  283. for unevent, unfun := range toUnsubscribe {
  284. _ = app.Unsubscribe(unevent, unfun)
  285. }
  286. for unevent, unfun := range toUnsubscribeSrv {
  287. _ = app.Unsubscribe(unevent, unfun)
  288. }
  289. for event, val := range expectedEvents {
  290. if val == false {
  291. t.Error("Did not fire config change event:", event)
  292. t.FailNow()
  293. }
  294. }
  295. // don't forget to reset
  296. if err := os.Truncate(oldconf.LogFile, 0); err != nil {
  297. t.Error(err)
  298. }
  299. }