config_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736
  1. package config
  2. import (
  3. "io/ioutil"
  4. "os"
  5. "testing"
  6. "github.com/coreos/etcd/third_party/github.com/BurntSushi/toml"
  7. "github.com/coreos/etcd/third_party/github.com/stretchr/testify/assert"
  8. )
  9. // Ensures that a configuration can be deserialized from TOML.
  10. func TestConfigTOML(t *testing.T) {
  11. content := `
  12. addr = "127.0.0.1:4002"
  13. ca_file = "/tmp/file.ca"
  14. cert_file = "/tmp/file.cert"
  15. cors = ["*"]
  16. cpu_profile_file = "XXX"
  17. data_dir = "/tmp/data"
  18. discovery = "http://example.com/foobar"
  19. key_file = "/tmp/file.key"
  20. bind_addr = "127.0.0.1:4003"
  21. peers = ["coreos.com:4001", "coreos.com:4002"]
  22. peers_file = "/tmp/peers"
  23. max_cluster_size = 10
  24. max_result_buffer = 512
  25. max_retry_attempts = 5
  26. name = "test-name"
  27. snapshot = true
  28. verbose = true
  29. very_verbose = true
  30. [peer]
  31. addr = "127.0.0.1:7002"
  32. ca_file = "/tmp/peer/file.ca"
  33. cert_file = "/tmp/peer/file.cert"
  34. key_file = "/tmp/peer/file.key"
  35. bind_addr = "127.0.0.1:7003"
  36. `
  37. c := New()
  38. _, err := toml.Decode(content, &c)
  39. assert.Nil(t, err, "")
  40. assert.Equal(t, c.Addr, "127.0.0.1:4002", "")
  41. assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
  42. assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
  43. assert.Equal(t, c.CorsOrigins, []string{"*"}, "")
  44. assert.Equal(t, c.DataDir, "/tmp/data", "")
  45. assert.Equal(t, c.Discovery, "http://example.com/foobar", "")
  46. assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
  47. assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
  48. assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
  49. assert.Equal(t, c.PeersFile, "/tmp/peers", "")
  50. assert.Equal(t, c.MaxClusterSize, 10, "")
  51. assert.Equal(t, c.MaxResultBuffer, 512, "")
  52. assert.Equal(t, c.MaxRetryAttempts, 5, "")
  53. assert.Equal(t, c.Name, "test-name", "")
  54. assert.Equal(t, c.Snapshot, true, "")
  55. assert.Equal(t, c.Verbose, true, "")
  56. assert.Equal(t, c.VeryVerbose, true, "")
  57. assert.Equal(t, c.Peer.Addr, "127.0.0.1:7002", "")
  58. assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
  59. assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
  60. assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
  61. assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:7003", "")
  62. }
  63. // Ensures that a configuration can be retrieved from environment variables.
  64. func TestConfigEnv(t *testing.T) {
  65. os.Setenv("ETCD_CA_FILE", "/tmp/file.ca")
  66. os.Setenv("ETCD_CERT_FILE", "/tmp/file.cert")
  67. os.Setenv("ETCD_CPU_PROFILE_FILE", "XXX")
  68. os.Setenv("ETCD_CORS", "localhost:4001,localhost:4002")
  69. os.Setenv("ETCD_DATA_DIR", "/tmp/data")
  70. os.Setenv("ETCD_DISCOVERY", "http://example.com/foobar")
  71. os.Setenv("ETCD_KEY_FILE", "/tmp/file.key")
  72. os.Setenv("ETCD_BIND_ADDR", "127.0.0.1:4003")
  73. os.Setenv("ETCD_PEERS", "coreos.com:4001,coreos.com:4002")
  74. os.Setenv("ETCD_PEERS_FILE", "/tmp/peers")
  75. os.Setenv("ETCD_MAX_CLUSTER_SIZE", "10")
  76. os.Setenv("ETCD_MAX_RESULT_BUFFER", "512")
  77. os.Setenv("ETCD_MAX_RETRY_ATTEMPTS", "5")
  78. os.Setenv("ETCD_NAME", "test-name")
  79. os.Setenv("ETCD_SNAPSHOT", "true")
  80. os.Setenv("ETCD_VERBOSE", "1")
  81. os.Setenv("ETCD_VERY_VERBOSE", "yes")
  82. os.Setenv("ETCD_PEER_ADDR", "127.0.0.1:7002")
  83. os.Setenv("ETCD_PEER_CA_FILE", "/tmp/peer/file.ca")
  84. os.Setenv("ETCD_PEER_CERT_FILE", "/tmp/peer/file.cert")
  85. os.Setenv("ETCD_PEER_KEY_FILE", "/tmp/peer/file.key")
  86. os.Setenv("ETCD_PEER_BIND_ADDR", "127.0.0.1:7003")
  87. c := New()
  88. c.LoadEnv()
  89. assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
  90. assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
  91. assert.Equal(t, c.CorsOrigins, []string{"localhost:4001", "localhost:4002"}, "")
  92. assert.Equal(t, c.DataDir, "/tmp/data", "")
  93. assert.Equal(t, c.Discovery, "http://example.com/foobar", "")
  94. assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
  95. assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
  96. assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
  97. assert.Equal(t, c.PeersFile, "/tmp/peers", "")
  98. assert.Equal(t, c.MaxClusterSize, 10, "")
  99. assert.Equal(t, c.MaxResultBuffer, 512, "")
  100. assert.Equal(t, c.MaxRetryAttempts, 5, "")
  101. assert.Equal(t, c.Name, "test-name", "")
  102. assert.Equal(t, c.Snapshot, true, "")
  103. assert.Equal(t, c.Verbose, true, "")
  104. assert.Equal(t, c.VeryVerbose, true, "")
  105. assert.Equal(t, c.Peer.Addr, "127.0.0.1:7002", "")
  106. assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
  107. assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
  108. assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
  109. assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:7003", "")
  110. // Clear this as it will mess up other tests
  111. os.Setenv("ETCD_DISCOVERY", "")
  112. }
  113. // Ensures that the "help" flag can be parsed.
  114. func TestConfigHelpFlag(t *testing.T) {
  115. c := New()
  116. assert.Nil(t, c.LoadFlags([]string{"-help"}), "")
  117. assert.True(t, c.ShowHelp)
  118. }
  119. // Ensures that the abbreviated "help" flag can be parsed.
  120. func TestConfigAbbreviatedHelpFlag(t *testing.T) {
  121. c := New()
  122. assert.Nil(t, c.LoadFlags([]string{"-h"}), "")
  123. assert.True(t, c.ShowHelp)
  124. }
  125. // Ensures that the "version" flag can be parsed.
  126. func TestConfigVersionFlag(t *testing.T) {
  127. c := New()
  128. assert.Nil(t, c.LoadFlags([]string{"-version"}), "")
  129. assert.True(t, c.ShowVersion)
  130. }
  131. // Ensures that the "force config" flag can be parsed.
  132. func TestConfigForceFlag(t *testing.T) {
  133. c := New()
  134. assert.Nil(t, c.LoadFlags([]string{"-force"}), "")
  135. assert.True(t, c.Force)
  136. }
  137. // Ensures that the abbreviated "force config" flag can be parsed.
  138. func TestConfigAbbreviatedForceFlag(t *testing.T) {
  139. c := New()
  140. assert.Nil(t, c.LoadFlags([]string{"-f"}), "")
  141. assert.True(t, c.Force)
  142. }
  143. // Ensures that a the advertised url can be parsed from the environment.
  144. func TestConfigAddrEnv(t *testing.T) {
  145. withEnv("ETCD_ADDR", "127.0.0.1:4002", func(c *Config) {
  146. assert.Nil(t, c.LoadEnv(), "")
  147. assert.Equal(t, c.Addr, "127.0.0.1:4002", "")
  148. })
  149. }
  150. // Ensures that a the advertised flag can be parsed.
  151. func TestConfigAddrFlag(t *testing.T) {
  152. c := New()
  153. assert.Nil(t, c.LoadFlags([]string{"-addr", "127.0.0.1:4002"}), "")
  154. assert.Equal(t, c.Addr, "127.0.0.1:4002", "")
  155. }
  156. // Ensures that a the CA file can be parsed from the environment.
  157. func TestConfigCAFileEnv(t *testing.T) {
  158. withEnv("ETCD_CA_FILE", "/tmp/file.ca", func(c *Config) {
  159. assert.Nil(t, c.LoadEnv(), "")
  160. assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
  161. })
  162. }
  163. // Ensures that a the CA file flag can be parsed.
  164. func TestConfigCAFileFlag(t *testing.T) {
  165. c := New()
  166. assert.Nil(t, c.LoadFlags([]string{"-ca-file", "/tmp/file.ca"}), "")
  167. assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
  168. }
  169. // Ensures that a the CA file can be parsed from the environment.
  170. func TestConfigCertFileEnv(t *testing.T) {
  171. withEnv("ETCD_CERT_FILE", "/tmp/file.cert", func(c *Config) {
  172. assert.Nil(t, c.LoadEnv(), "")
  173. assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
  174. })
  175. }
  176. // Ensures that a the Cert file flag can be parsed.
  177. func TestConfigCertFileFlag(t *testing.T) {
  178. c := New()
  179. assert.Nil(t, c.LoadFlags([]string{"-cert-file", "/tmp/file.cert"}), "")
  180. assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
  181. }
  182. // Ensures that a the Key file can be parsed from the environment.
  183. func TestConfigKeyFileEnv(t *testing.T) {
  184. withEnv("ETCD_KEY_FILE", "/tmp/file.key", func(c *Config) {
  185. assert.Nil(t, c.LoadEnv(), "")
  186. assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
  187. })
  188. }
  189. // Ensures that a the Key file flag can be parsed.
  190. func TestConfigKeyFileFlag(t *testing.T) {
  191. c := New()
  192. assert.Nil(t, c.LoadFlags([]string{"-key-file", "/tmp/file.key"}), "")
  193. assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
  194. }
  195. // Ensures that a the Listen Host can be parsed from the environment.
  196. func TestConfigBindAddrEnv(t *testing.T) {
  197. withEnv("ETCD_BIND_ADDR", "127.0.0.1:4003", func(c *Config) {
  198. assert.Nil(t, c.LoadEnv(), "")
  199. assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
  200. })
  201. }
  202. // Ensures that a the Listen Host file flag can be parsed.
  203. func TestConfigBindAddrFlag(t *testing.T) {
  204. c := New()
  205. assert.Nil(t, c.LoadFlags([]string{"-bind-addr", "127.0.0.1:4003"}), "")
  206. assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
  207. }
  208. // Ensures that a the Listen Host port overrides the advertised port
  209. func TestConfigBindAddrOverride(t *testing.T) {
  210. c := New()
  211. assert.Nil(t, c.LoadFlags([]string{"-addr", "127.0.0.1:4009", "-bind-addr", "127.0.0.1:4010"}), "")
  212. assert.Nil(t, c.Sanitize())
  213. assert.Equal(t, c.BindAddr, "127.0.0.1:4010", "")
  214. }
  215. // Ensures that a the Listen Host inherits its port from the advertised addr
  216. func TestConfigBindAddrInheritPort(t *testing.T) {
  217. c := New()
  218. assert.Nil(t, c.LoadFlags([]string{"-addr", "127.0.0.1:4009", "-bind-addr", "127.0.0.1"}), "")
  219. assert.Nil(t, c.Sanitize())
  220. assert.Equal(t, c.BindAddr, "127.0.0.1:4009", "")
  221. }
  222. // Ensures that a port only argument errors out
  223. func TestConfigBindAddrErrorOnNoHost(t *testing.T) {
  224. c := New()
  225. assert.Nil(t, c.LoadFlags([]string{"-addr", "127.0.0.1:4009", "-bind-addr", ":4010"}), "")
  226. assert.Error(t, c.Sanitize())
  227. }
  228. // Ensures that the peers can be parsed from the environment.
  229. func TestConfigPeersEnv(t *testing.T) {
  230. withEnv("ETCD_PEERS", "coreos.com:4001,coreos.com:4002", func(c *Config) {
  231. assert.Nil(t, c.LoadEnv(), "")
  232. assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
  233. })
  234. }
  235. // Ensures that a the Peers flag can be parsed.
  236. func TestConfigPeersFlag(t *testing.T) {
  237. c := New()
  238. assert.Nil(t, c.LoadFlags([]string{"-peers", "coreos.com:4001,coreos.com:4002"}), "")
  239. assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
  240. }
  241. // Ensures that the Peers File can be parsed from the environment.
  242. func TestConfigPeersFileEnv(t *testing.T) {
  243. withEnv("ETCD_PEERS_FILE", "/tmp/peers", func(c *Config) {
  244. assert.Nil(t, c.LoadEnv(), "")
  245. assert.Equal(t, c.PeersFile, "/tmp/peers", "")
  246. })
  247. }
  248. // Ensures that a the Peers File flag can be parsed.
  249. func TestConfigPeersFileFlag(t *testing.T) {
  250. c := New()
  251. assert.Nil(t, c.LoadFlags([]string{"-peers-file", "/tmp/peers"}), "")
  252. assert.Equal(t, c.PeersFile, "/tmp/peers", "")
  253. }
  254. // Ensures that the Max Cluster Size can be parsed from the environment.
  255. func TestConfigMaxClusterSizeEnv(t *testing.T) {
  256. withEnv("ETCD_MAX_CLUSTER_SIZE", "5", func(c *Config) {
  257. assert.Nil(t, c.LoadEnv(), "")
  258. assert.Equal(t, c.MaxClusterSize, 5, "")
  259. })
  260. }
  261. // Ensures that a the Max Cluster Size flag can be parsed.
  262. func TestConfigMaxClusterSizeFlag(t *testing.T) {
  263. c := New()
  264. assert.Nil(t, c.LoadFlags([]string{"-max-cluster-size", "5"}), "")
  265. assert.Equal(t, c.MaxClusterSize, 5, "")
  266. }
  267. // Ensures that the Max Result Buffer can be parsed from the environment.
  268. func TestConfigMaxResultBufferEnv(t *testing.T) {
  269. withEnv("ETCD_MAX_RESULT_BUFFER", "512", func(c *Config) {
  270. assert.Nil(t, c.LoadEnv(), "")
  271. assert.Equal(t, c.MaxResultBuffer, 512, "")
  272. })
  273. }
  274. // Ensures that a the Max Result Buffer flag can be parsed.
  275. func TestConfigMaxResultBufferFlag(t *testing.T) {
  276. c := New()
  277. assert.Nil(t, c.LoadFlags([]string{"-max-result-buffer", "512"}), "")
  278. assert.Equal(t, c.MaxResultBuffer, 512, "")
  279. }
  280. // Ensures that the Max Retry Attempts can be parsed from the environment.
  281. func TestConfigMaxRetryAttemptsEnv(t *testing.T) {
  282. withEnv("ETCD_MAX_RETRY_ATTEMPTS", "10", func(c *Config) {
  283. assert.Nil(t, c.LoadEnv(), "")
  284. assert.Equal(t, c.MaxRetryAttempts, 10, "")
  285. })
  286. }
  287. // Ensures that a the Max Retry Attempts flag can be parsed.
  288. func TestConfigMaxRetryAttemptsFlag(t *testing.T) {
  289. c := New()
  290. assert.Nil(t, c.LoadFlags([]string{"-max-retry-attempts", "10"}), "")
  291. assert.Equal(t, c.MaxRetryAttempts, 10, "")
  292. }
  293. // Ensures that the Name can be parsed from the environment.
  294. func TestConfigNameEnv(t *testing.T) {
  295. withEnv("ETCD_NAME", "test-name", func(c *Config) {
  296. assert.Nil(t, c.LoadEnv(), "")
  297. assert.Equal(t, c.Name, "test-name", "")
  298. })
  299. }
  300. // Ensures that a the Name flag can be parsed.
  301. func TestConfigNameFlag(t *testing.T) {
  302. c := New()
  303. assert.Nil(t, c.LoadFlags([]string{"-name", "test-name"}), "")
  304. assert.Equal(t, c.Name, "test-name", "")
  305. }
  306. // Ensures that a Name gets guessed if not specified
  307. func TestConfigNameGuess(t *testing.T) {
  308. c := New()
  309. assert.Nil(t, c.LoadFlags([]string{}), "")
  310. assert.Nil(t, c.Sanitize())
  311. name, _ := os.Hostname()
  312. assert.Equal(t, c.Name, name, "")
  313. }
  314. // Ensures that a DataDir gets guessed if not specified
  315. func TestConfigDataDirGuess(t *testing.T) {
  316. c := New()
  317. assert.Nil(t, c.LoadFlags([]string{}), "")
  318. assert.Nil(t, c.Sanitize())
  319. name, _ := os.Hostname()
  320. assert.Equal(t, c.DataDir, name+".etcd", "")
  321. }
  322. // Ensures that Snapshot can be parsed from the environment.
  323. func TestConfigSnapshotEnv(t *testing.T) {
  324. withEnv("ETCD_SNAPSHOT", "1", func(c *Config) {
  325. assert.Nil(t, c.LoadEnv(), "")
  326. assert.Equal(t, c.Snapshot, true, "")
  327. })
  328. }
  329. // Ensures that a the Snapshot flag can be parsed.
  330. func TestConfigSnapshotFlag(t *testing.T) {
  331. c := New()
  332. assert.Nil(t, c.LoadFlags([]string{"-snapshot"}), "")
  333. assert.Equal(t, c.Snapshot, true, "")
  334. }
  335. // Ensures that Verbose can be parsed from the environment.
  336. func TestConfigVerboseEnv(t *testing.T) {
  337. withEnv("ETCD_VERBOSE", "true", func(c *Config) {
  338. assert.Nil(t, c.LoadEnv(), "")
  339. assert.Equal(t, c.Verbose, true, "")
  340. })
  341. }
  342. // Ensures that a the Verbose flag can be parsed.
  343. func TestConfigVerboseFlag(t *testing.T) {
  344. c := New()
  345. assert.Nil(t, c.LoadFlags([]string{"-v"}), "")
  346. assert.Equal(t, c.Verbose, true, "")
  347. }
  348. // Ensures that Very Verbose can be parsed from the environment.
  349. func TestConfigVeryVerboseEnv(t *testing.T) {
  350. withEnv("ETCD_VERY_VERBOSE", "true", func(c *Config) {
  351. assert.Nil(t, c.LoadEnv(), "")
  352. assert.Equal(t, c.VeryVerbose, true, "")
  353. })
  354. }
  355. // Ensures that a the Very Verbose flag can be parsed.
  356. func TestConfigVeryVerboseFlag(t *testing.T) {
  357. c := New()
  358. assert.Nil(t, c.LoadFlags([]string{"-vv"}), "")
  359. assert.Equal(t, c.VeryVerbose, true, "")
  360. }
  361. // Ensures that the Peer Advertised URL can be parsed from the environment.
  362. func TestConfigPeerAddrEnv(t *testing.T) {
  363. withEnv("ETCD_PEER_ADDR", "localhost:7002", func(c *Config) {
  364. assert.Nil(t, c.LoadEnv(), "")
  365. assert.Equal(t, c.Peer.Addr, "localhost:7002", "")
  366. })
  367. }
  368. // Ensures that a the Peer Advertised URL flag can be parsed.
  369. func TestConfigPeerAddrFlag(t *testing.T) {
  370. c := New()
  371. assert.Nil(t, c.LoadFlags([]string{"-peer-addr", "localhost:7002"}), "")
  372. assert.Equal(t, c.Peer.Addr, "localhost:7002", "")
  373. }
  374. // Ensures that the Peer CA File can be parsed from the environment.
  375. func TestConfigPeerCAFileEnv(t *testing.T) {
  376. withEnv("ETCD_PEER_CA_FILE", "/tmp/peer/file.ca", func(c *Config) {
  377. assert.Nil(t, c.LoadEnv(), "")
  378. assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
  379. })
  380. }
  381. // Ensures that a the Peer CA file flag can be parsed.
  382. func TestConfigPeerCAFileFlag(t *testing.T) {
  383. c := New()
  384. assert.Nil(t, c.LoadFlags([]string{"-peer-ca-file", "/tmp/peer/file.ca"}), "")
  385. assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
  386. }
  387. // Ensures that the Peer Cert File can be parsed from the environment.
  388. func TestConfigPeerCertFileEnv(t *testing.T) {
  389. withEnv("ETCD_PEER_CERT_FILE", "/tmp/peer/file.cert", func(c *Config) {
  390. assert.Nil(t, c.LoadEnv(), "")
  391. assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
  392. })
  393. }
  394. // Ensures that a the Cert file flag can be parsed.
  395. func TestConfigPeerCertFileFlag(t *testing.T) {
  396. c := New()
  397. assert.Nil(t, c.LoadFlags([]string{"-peer-cert-file", "/tmp/peer/file.cert"}), "")
  398. assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
  399. }
  400. // Ensures that the Peer Key File can be parsed from the environment.
  401. func TestConfigPeerKeyFileEnv(t *testing.T) {
  402. withEnv("ETCD_PEER_KEY_FILE", "/tmp/peer/file.key", func(c *Config) {
  403. assert.Nil(t, c.LoadEnv(), "")
  404. assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
  405. })
  406. }
  407. // Ensures that a the Peer Key file flag can be parsed.
  408. func TestConfigPeerKeyFileFlag(t *testing.T) {
  409. c := New()
  410. assert.Nil(t, c.LoadFlags([]string{"-peer-key-file", "/tmp/peer/file.key"}), "")
  411. assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
  412. }
  413. // Ensures that the Peer Listen Host can be parsed from the environment.
  414. func TestConfigPeerBindAddrEnv(t *testing.T) {
  415. withEnv("ETCD_PEER_BIND_ADDR", "localhost:7004", func(c *Config) {
  416. assert.Nil(t, c.LoadEnv(), "")
  417. assert.Equal(t, c.Peer.BindAddr, "localhost:7004", "")
  418. })
  419. }
  420. // Ensures that a bad flag returns an error.
  421. func TestConfigBadFlag(t *testing.T) {
  422. c := New()
  423. err := c.LoadFlags([]string{"-no-such-flag"})
  424. assert.Error(t, err)
  425. assert.Equal(t, err.Error(), `flag provided but not defined: -no-such-flag`)
  426. }
  427. // Ensures that a the Peer Listen Host file flag can be parsed.
  428. func TestConfigPeerBindAddrFlag(t *testing.T) {
  429. c := New()
  430. assert.Nil(t, c.LoadFlags([]string{"-peer-bind-addr", "127.0.0.1:4003"}), "")
  431. assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:4003", "")
  432. }
  433. // Ensures that a system config field is overridden by a custom config field.
  434. func TestConfigCustomConfigOverrideSystemConfig(t *testing.T) {
  435. system := `addr = "127.0.0.1:5000"`
  436. custom := `addr = "127.0.0.1:6000"`
  437. withTempFile(system, func(p1 string) {
  438. withTempFile(custom, func(p2 string) {
  439. c := New()
  440. c.SystemPath = p1
  441. assert.Nil(t, c.Load([]string{"-config", p2}), "")
  442. assert.Equal(t, c.Addr, "http://127.0.0.1:6000", "")
  443. })
  444. })
  445. }
  446. // Ensures that a custom config field is overridden by an environment variable.
  447. func TestConfigEnvVarOverrideCustomConfig(t *testing.T) {
  448. os.Setenv("ETCD_PEER_ADDR", "127.0.0.1:8000")
  449. defer os.Setenv("ETCD_PEER_ADDR", "")
  450. custom := `[peer]` + "\n" + `advertised_url = "127.0.0.1:9000"`
  451. withTempFile(custom, func(path string) {
  452. c := New()
  453. c.SystemPath = ""
  454. assert.Nil(t, c.Load([]string{"-config", path}), "")
  455. assert.Equal(t, c.Peer.Addr, "http://127.0.0.1:8000", "")
  456. })
  457. }
  458. // Ensures that an environment variable field is overridden by a command line argument.
  459. func TestConfigCLIArgsOverrideEnvVar(t *testing.T) {
  460. os.Setenv("ETCD_ADDR", "127.0.0.1:1000")
  461. defer os.Setenv("ETCD_ADDR", "")
  462. c := New()
  463. c.SystemPath = ""
  464. assert.Nil(t, c.Load([]string{"-addr", "127.0.0.1:2000"}), "")
  465. assert.Equal(t, c.Addr, "http://127.0.0.1:2000", "")
  466. }
  467. //--------------------------------------
  468. // DEPRECATED (v1)
  469. //--------------------------------------
  470. func TestConfigDeprecatedAddrFlag(t *testing.T) {
  471. _, stderr := capture(func() {
  472. c := New()
  473. err := c.LoadFlags([]string{"-c", "127.0.0.1:4002"})
  474. assert.NoError(t, err)
  475. assert.Equal(t, c.Addr, "127.0.0.1:4002")
  476. })
  477. assert.Equal(t, stderr, "[deprecated] use -addr, not -c\n")
  478. }
  479. func TestConfigDeprecatedBindAddrFlag(t *testing.T) {
  480. _, stderr := capture(func() {
  481. c := New()
  482. err := c.LoadFlags([]string{"-cl", "127.0.0.1:4003"})
  483. assert.NoError(t, err)
  484. assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
  485. })
  486. assert.Equal(t, stderr, "[deprecated] use -bind-addr, not -cl\n", "")
  487. }
  488. func TestConfigDeprecatedCAFileFlag(t *testing.T) {
  489. _, stderr := capture(func() {
  490. c := New()
  491. err := c.LoadFlags([]string{"-clientCAFile", "/tmp/file.ca"})
  492. assert.NoError(t, err)
  493. assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
  494. })
  495. assert.Equal(t, stderr, "[deprecated] use -ca-file, not -clientCAFile\n", "")
  496. }
  497. func TestConfigDeprecatedCertFileFlag(t *testing.T) {
  498. _, stderr := capture(func() {
  499. c := New()
  500. err := c.LoadFlags([]string{"-clientCert", "/tmp/file.cert"})
  501. assert.NoError(t, err)
  502. assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
  503. })
  504. assert.Equal(t, stderr, "[deprecated] use -cert-file, not -clientCert\n", "")
  505. }
  506. func TestConfigDeprecatedKeyFileFlag(t *testing.T) {
  507. _, stderr := capture(func() {
  508. c := New()
  509. err := c.LoadFlags([]string{"-clientKey", "/tmp/file.key"})
  510. assert.NoError(t, err)
  511. assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
  512. })
  513. assert.Equal(t, stderr, "[deprecated] use -key-file, not -clientKey\n", "")
  514. }
  515. func TestConfigDeprecatedPeersFlag(t *testing.T) {
  516. _, stderr := capture(func() {
  517. c := New()
  518. err := c.LoadFlags([]string{"-C", "coreos.com:4001,coreos.com:4002"})
  519. assert.NoError(t, err)
  520. assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
  521. })
  522. assert.Equal(t, stderr, "[deprecated] use -peers, not -C\n", "")
  523. }
  524. func TestConfigDeprecatedPeersFileFlag(t *testing.T) {
  525. _, stderr := capture(func() {
  526. c := New()
  527. err := c.LoadFlags([]string{"-CF", "/tmp/machines"})
  528. assert.NoError(t, err)
  529. assert.Equal(t, c.PeersFile, "/tmp/machines", "")
  530. })
  531. assert.Equal(t, stderr, "[deprecated] use -peers-file, not -CF\n", "")
  532. }
  533. func TestConfigDeprecatedMaxClusterSizeFlag(t *testing.T) {
  534. _, stderr := capture(func() {
  535. c := New()
  536. err := c.LoadFlags([]string{"-maxsize", "5"})
  537. assert.NoError(t, err)
  538. assert.Equal(t, c.MaxClusterSize, 5, "")
  539. })
  540. assert.Equal(t, stderr, "[deprecated] use -max-cluster-size, not -maxsize\n", "")
  541. }
  542. func TestConfigDeprecatedMaxResultBufferFlag(t *testing.T) {
  543. _, stderr := capture(func() {
  544. c := New()
  545. err := c.LoadFlags([]string{"-m", "512"})
  546. assert.NoError(t, err)
  547. assert.Equal(t, c.MaxResultBuffer, 512, "")
  548. })
  549. assert.Equal(t, stderr, "[deprecated] use -max-result-buffer, not -m\n", "")
  550. }
  551. func TestConfigDeprecatedMaxRetryAttemptsFlag(t *testing.T) {
  552. _, stderr := capture(func() {
  553. c := New()
  554. err := c.LoadFlags([]string{"-r", "10"})
  555. assert.NoError(t, err)
  556. assert.Equal(t, c.MaxRetryAttempts, 10, "")
  557. })
  558. assert.Equal(t, stderr, "[deprecated] use -max-retry-attempts, not -r\n", "")
  559. }
  560. func TestConfigDeprecatedNameFlag(t *testing.T) {
  561. _, stderr := capture(func() {
  562. c := New()
  563. err := c.LoadFlags([]string{"-n", "test-name"})
  564. assert.NoError(t, err)
  565. assert.Equal(t, c.Name, "test-name", "")
  566. })
  567. assert.Equal(t, stderr, "[deprecated] use -name, not -n\n", "")
  568. }
  569. func TestConfigDeprecatedPeerAddrFlag(t *testing.T) {
  570. _, stderr := capture(func() {
  571. c := New()
  572. err := c.LoadFlags([]string{"-s", "localhost:7002"})
  573. assert.NoError(t, err)
  574. assert.Equal(t, c.Peer.Addr, "localhost:7002", "")
  575. })
  576. assert.Equal(t, stderr, "[deprecated] use -peer-addr, not -s\n", "")
  577. }
  578. func TestConfigDeprecatedPeerBindAddrFlag(t *testing.T) {
  579. _, stderr := capture(func() {
  580. c := New()
  581. err := c.LoadFlags([]string{"-sl", "127.0.0.1:4003"})
  582. assert.NoError(t, err)
  583. assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:4003", "")
  584. })
  585. assert.Equal(t, stderr, "[deprecated] use -peer-bind-addr, not -sl\n", "")
  586. }
  587. func TestConfigDeprecatedPeerCAFileFlag(t *testing.T) {
  588. _, stderr := capture(func() {
  589. c := New()
  590. err := c.LoadFlags([]string{"-serverCAFile", "/tmp/peer/file.ca"})
  591. assert.NoError(t, err)
  592. assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
  593. })
  594. assert.Equal(t, stderr, "[deprecated] use -peer-ca-file, not -serverCAFile\n", "")
  595. }
  596. func TestConfigDeprecatedPeerCertFileFlag(t *testing.T) {
  597. _, stderr := capture(func() {
  598. c := New()
  599. err := c.LoadFlags([]string{"-serverCert", "/tmp/peer/file.cert"})
  600. assert.NoError(t, err)
  601. assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
  602. })
  603. assert.Equal(t, stderr, "[deprecated] use -peer-cert-file, not -serverCert\n", "")
  604. }
  605. func TestConfigDeprecatedPeerKeyFileFlag(t *testing.T) {
  606. _, stderr := capture(func() {
  607. c := New()
  608. err := c.LoadFlags([]string{"-serverKey", "/tmp/peer/file.key"})
  609. assert.NoError(t, err)
  610. assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
  611. })
  612. assert.Equal(t, stderr, "[deprecated] use -peer-key-file, not -serverKey\n", "")
  613. }
  614. //--------------------------------------
  615. // Helpers
  616. //--------------------------------------
  617. // Sets up the environment with a given environment variable set.
  618. func withEnv(key, value string, f func(c *Config)) {
  619. os.Setenv(key, value)
  620. defer os.Setenv(key, "")
  621. c := New()
  622. f(c)
  623. }
  624. // Creates a temp file and calls a function with the context.
  625. func withTempFile(content string, fn func(string)) {
  626. f, _ := ioutil.TempFile("", "")
  627. f.WriteString(content)
  628. f.Close()
  629. defer os.Remove(f.Name())
  630. fn(f.Name())
  631. }
  632. // Captures STDOUT & STDERR and returns the output as strings.
  633. func capture(fn func()) (string, string) {
  634. // Create temp files.
  635. tmpout, _ := ioutil.TempFile("", "")
  636. defer os.Remove(tmpout.Name())
  637. tmperr, _ := ioutil.TempFile("", "")
  638. defer os.Remove(tmperr.Name())
  639. stdout, stderr := os.Stdout, os.Stderr
  640. os.Stdout, os.Stderr = tmpout, tmperr
  641. // Execute function argument and then reassign stdout/stderr.
  642. fn()
  643. os.Stdout, os.Stderr = stdout, stderr
  644. // Close temp files and read them.
  645. tmpout.Close()
  646. bout, _ := ioutil.ReadFile(tmpout.Name())
  647. tmperr.Close()
  648. berr, _ := ioutil.ReadFile(tmperr.Name())
  649. return string(bout), string(berr)
  650. }