config_test.go 24 KB

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