|
| 1 | +package main |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "io/ioutil" |
| 6 | + "os" |
| 7 | + "path/filepath" |
| 8 | + "testing" |
| 9 | + |
| 10 | + "github.com/google/go-cmp/cmp" |
| 11 | +) |
| 12 | + |
| 13 | +func TestReadConfig(t *testing.T) { |
| 14 | + tests := []struct { |
| 15 | + name string |
| 16 | + fileContents *config |
| 17 | + envToken string |
| 18 | + envEndpoint string |
| 19 | + flagEndpoint string |
| 20 | + want *config |
| 21 | + wantErr string |
| 22 | + }{ |
| 23 | + { |
| 24 | + name: "defaults", |
| 25 | + want: &config{ |
| 26 | + Endpoint: "https://sourcegraph.com", |
| 27 | + }, |
| 28 | + }, |
| 29 | + { |
| 30 | + name: "config file, no overrides, trim slash", |
| 31 | + fileContents: &config{ |
| 32 | + Endpoint: "https://example.com/", |
| 33 | + AccessToken: "deadbeef", |
| 34 | + }, |
| 35 | + want: &config{ |
| 36 | + Endpoint: "https://example.com", |
| 37 | + AccessToken: "deadbeef", |
| 38 | + }, |
| 39 | + }, |
| 40 | + { |
| 41 | + name: "config file, token override only", |
| 42 | + fileContents: &config{ |
| 43 | + Endpoint: "https://example.com/", |
| 44 | + AccessToken: "deadbeef", |
| 45 | + }, |
| 46 | + envToken: "abc", |
| 47 | + want: nil, |
| 48 | + wantErr: errConfigMerge.Error(), |
| 49 | + }, |
| 50 | + { |
| 51 | + name: "config file, endpoint override only", |
| 52 | + fileContents: &config{ |
| 53 | + Endpoint: "https://example.com/", |
| 54 | + AccessToken: "deadbeef", |
| 55 | + }, |
| 56 | + envEndpoint: "https://exmaple2.com", |
| 57 | + want: nil, |
| 58 | + wantErr: errConfigMerge.Error(), |
| 59 | + }, |
| 60 | + { |
| 61 | + name: "config file, both override", |
| 62 | + fileContents: &config{ |
| 63 | + Endpoint: "https://example.com/", |
| 64 | + AccessToken: "deadbeef", |
| 65 | + }, |
| 66 | + envToken: "abc", |
| 67 | + envEndpoint: "https://override.com", |
| 68 | + want: &config{ |
| 69 | + Endpoint: "https://override.com", |
| 70 | + AccessToken: "abc", |
| 71 | + }, |
| 72 | + }, |
| 73 | + { |
| 74 | + name: "no config file, token from environment", |
| 75 | + envToken: "abc", |
| 76 | + want: &config{ |
| 77 | + Endpoint: "https://sourcegraph.com", |
| 78 | + AccessToken: "abc", |
| 79 | + }, |
| 80 | + }, |
| 81 | + { |
| 82 | + name: "no config file, endpoint from environment", |
| 83 | + envEndpoint: "https://example.com", |
| 84 | + want: &config{ |
| 85 | + Endpoint: "https://example.com", |
| 86 | + AccessToken: "", |
| 87 | + }, |
| 88 | + }, |
| 89 | + { |
| 90 | + name: "no config file, both variables", |
| 91 | + envEndpoint: "https://example.com", |
| 92 | + envToken: "abc", |
| 93 | + want: &config{ |
| 94 | + Endpoint: "https://example.com", |
| 95 | + AccessToken: "abc", |
| 96 | + }, |
| 97 | + }, |
| 98 | + { |
| 99 | + name: "endpoint flag should override config", |
| 100 | + flagEndpoint: "https://override.com/", |
| 101 | + fileContents: &config{ |
| 102 | + Endpoint: "https://example.com/", |
| 103 | + AccessToken: "deadbeef", |
| 104 | + }, |
| 105 | + want: &config{ |
| 106 | + Endpoint: "https://override.com", |
| 107 | + AccessToken: "deadbeef", |
| 108 | + }, |
| 109 | + }, |
| 110 | + { |
| 111 | + name: "endpoint flag should override environment", |
| 112 | + flagEndpoint: "https://override.com/", |
| 113 | + envEndpoint: "https://example.com", |
| 114 | + envToken: "abc", |
| 115 | + want: &config{ |
| 116 | + Endpoint: "https://override.com", |
| 117 | + AccessToken: "abc", |
| 118 | + }, |
| 119 | + }, |
| 120 | + } |
| 121 | + |
| 122 | + for _, test := range tests { |
| 123 | + t.Run(test.name, func(t *testing.T) { |
| 124 | + setEnv := func(name, val string) { |
| 125 | + old := os.Getenv(name) |
| 126 | + if err := os.Setenv(name, val); err != nil { |
| 127 | + t.Fatal(err) |
| 128 | + } |
| 129 | + t.Cleanup(func() { os.Setenv(name, old) }) |
| 130 | + } |
| 131 | + setEnv("SRC_ACCESS_TOKEN", test.envToken) |
| 132 | + setEnv("SRC_ENDPOINT", test.envEndpoint) |
| 133 | + |
| 134 | + if test.flagEndpoint != "" { |
| 135 | + val := test.flagEndpoint |
| 136 | + endpoint = &val |
| 137 | + t.Cleanup(func() { endpoint = nil }) |
| 138 | + } |
| 139 | + |
| 140 | + if test.fileContents != nil { |
| 141 | + oldConfigPath := *configPath |
| 142 | + t.Cleanup(func() { *configPath = oldConfigPath }) |
| 143 | + |
| 144 | + data, err := json.Marshal(*test.fileContents) |
| 145 | + if err != nil { |
| 146 | + t.Fatal(err) |
| 147 | + } |
| 148 | + tmpDir, err := ioutil.TempDir("", "") |
| 149 | + if err != nil { |
| 150 | + t.Fatal(err) |
| 151 | + } |
| 152 | + t.Cleanup(func() { os.RemoveAll(tmpDir) }) |
| 153 | + filePath := filepath.Join(tmpDir, "config.json") |
| 154 | + err = ioutil.WriteFile(filePath, data, 0600) |
| 155 | + if err != nil { |
| 156 | + t.Fatal(err) |
| 157 | + } |
| 158 | + *configPath = filePath |
| 159 | + } |
| 160 | + |
| 161 | + config, err := readConfig() |
| 162 | + if diff := cmp.Diff(test.want, config); diff != "" { |
| 163 | + t.Errorf("config: %v", diff) |
| 164 | + } |
| 165 | + var errMsg string |
| 166 | + if err != nil { |
| 167 | + errMsg = err.Error() |
| 168 | + } |
| 169 | + if diff := cmp.Diff(test.wantErr, errMsg); diff != "" { |
| 170 | + t.Errorf("err: %v", diff) |
| 171 | + } |
| 172 | + }) |
| 173 | + } |
| 174 | +} |
0 commit comments