config: Adding support to read configuration from http endpoint #5405
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| // Copyright The Prometheus Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package app | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/prometheus/common/promslog" | ||
| "github.com/prometheus/exporter-toolkit/web" | ||
|
|
||
| "github.com/prometheus/alertmanager/featurecontrol" | ||
| ) | ||
|
|
||
| func TestStartupWithHTTPConfig(t *testing.T) { | ||
| // Start a HTTP server that returns a minimal valid config. | ||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| w.Write([]byte("route:\n receiver: test\nreceivers:\n- name: test")) | ||
| })) | ||
| defer srv.Close() | ||
|
|
||
| // Create a temporary data directory. | ||
| dir := t.TempDir() | ||
|
|
||
| // Build minimal options for HTTP source. | ||
| webCfg := web.FlagConfig{} | ||
| webCfg.WebListenAddresses = &[]string{"127.0.0.1:0"} | ||
| webCfgFile := "" | ||
| webCfg.WebConfigFile = &webCfgFile | ||
|
|
||
| ff, err := featurecontrol.NewFlags(promslog.NewNopLogger(), "") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| opts := Options{ | ||
| ConfigHTTPURL: srv.URL, | ||
| DataDir: dir, | ||
| Retention: DefaultRetention, | ||
| MaintenanceInterval: DefaultMaintenanceInterval, | ||
| AlertGCInterval: DefaultAlertGCInterval, | ||
| DispatchMaintenanceInterval: DefaultDispatchMaintenanceInterval, | ||
| WebConfig: &webCfg, | ||
| Logger: promslog.NewNopLogger(), | ||
| Registerer: prometheus.NewRegistry(), | ||
| Flagger: ff, | ||
| } | ||
|
|
||
| // Try to create the app (setup). | ||
| app, err := New(opts) | ||
| if err != nil { | ||
| t.Fatalf("failed to create app with HTTP config: %v", err) | ||
| } | ||
| defer func() { _ = app.Stop(context.Background()) }() | ||
|
|
||
| // Start the app. | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| go func() { _ = app.Start() }() | ||
|
|
||
| // Verify it started without error. | ||
| select { | ||
| case <-ctx.Done(): | ||
| t.Fatal("app stopped unexpectedly") | ||
| default: | ||
| } | ||
|
Comment on lines
+73
to
+82
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Observe the The context is canceled only in deferred cleanup. Both
📍 Affects 1 file
🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| func TestStartupWithFileConfig(t *testing.T) { | ||
| // Create a temporary config file. | ||
| dir := t.TempDir() | ||
| configPath := filepath.Join(dir, "alertmanager.yml") | ||
| data := []byte("route:\n receiver: test\nreceivers:\n- name: test") | ||
| if err := os.WriteFile(configPath, data, 0o600); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| webCfg := web.FlagConfig{} | ||
| webCfg.WebListenAddresses = &[]string{"127.0.0.1:0"} | ||
| webCfgFile := "" | ||
| webCfg.WebConfigFile = &webCfgFile | ||
|
|
||
| ff, err := featurecontrol.NewFlags(promslog.NewNopLogger(), "") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| opts := Options{ | ||
| ConfigFile: configPath, | ||
| DataDir: dir, | ||
| Retention: DefaultRetention, | ||
| MaintenanceInterval: DefaultMaintenanceInterval, | ||
| AlertGCInterval: DefaultAlertGCInterval, | ||
| DispatchMaintenanceInterval: DefaultDispatchMaintenanceInterval, | ||
| WebConfig: &webCfg, | ||
| Logger: promslog.NewNopLogger(), | ||
| Registerer: prometheus.NewRegistry(), | ||
| Flagger: ff, | ||
| } | ||
|
|
||
| app, err := New(opts) | ||
| if err != nil { | ||
| t.Fatalf("failed to create app with file config: %v", err) | ||
| } | ||
| defer func() { _ = app.Stop(context.Background()) }() | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| go func() { _ = app.Start() }() | ||
|
|
||
| select { | ||
| case <-ctx.Done(): | ||
| t.Fatal("app stopped unexpectedly") | ||
| default: | ||
| } | ||
| } | ||
|
|
||
| func TestStartupWithBothSources(t *testing.T) { | ||
| // Create a temporary config file. | ||
| dir := t.TempDir() | ||
| configPath := filepath.Join(dir, "alertmanager.yml") | ||
| data := []byte("route:\n receiver: test\nreceivers:\n- name: test") | ||
| if err := os.WriteFile(configPath, data, 0o600); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| webCfg := web.FlagConfig{} | ||
| webCfg.WebListenAddresses = &[]string{"127.0.0.1:0"} | ||
| webCfgFile := "" | ||
| webCfg.WebConfigFile = &webCfgFile | ||
| ff, _ := featurecontrol.NewFlags(promslog.NewNopLogger(), "") | ||
| opts := Options{ | ||
| ConfigFile: configPath, | ||
| ConfigHTTPURL: "http://example.com/config", | ||
| DataDir: dir, | ||
| Retention: DefaultRetention, | ||
| MaintenanceInterval: DefaultMaintenanceInterval, | ||
| AlertGCInterval: DefaultAlertGCInterval, | ||
| DispatchMaintenanceInterval: DefaultDispatchMaintenanceInterval, | ||
| WebConfig: &webCfg, | ||
| Logger: promslog.NewNopLogger(), | ||
| Registerer: prometheus.NewRegistry(), | ||
| Flagger: ff, | ||
| } | ||
|
|
||
| _, err := New(opts) | ||
| if err == nil { | ||
| t.Fatal("expected error when both config sources are set") | ||
| } | ||
| if err.Error() != "alertmanager/app: Options.ConfigFile and Options.ConfigHTTPURL are mutually exclusive" { | ||
| t.Fatalf("unexpected error message: %v", err) | ||
| } | ||
| } | ||
|
|
||
| func TestStartupWithNeitherSource(t *testing.T) { | ||
| webCfg := web.FlagConfig{} | ||
| webCfg.WebListenAddresses = &[]string{"127.0.0.1:0"} | ||
| webCfgFile := "" | ||
| webCfg.WebConfigFile = &webCfgFile | ||
| ff, _ := featurecontrol.NewFlags(promslog.NewNopLogger(), "") | ||
| opts := Options{ | ||
| DataDir: t.TempDir(), | ||
| Retention: DefaultRetention, | ||
| MaintenanceInterval: DefaultMaintenanceInterval, | ||
| AlertGCInterval: DefaultAlertGCInterval, | ||
| DispatchMaintenanceInterval: DefaultDispatchMaintenanceInterval, | ||
| WebConfig: &webCfg, | ||
| Logger: promslog.NewNopLogger(), | ||
| Registerer: prometheus.NewRegistry(), | ||
| Flagger: ff, | ||
| } | ||
|
|
||
| _, err := New(opts) | ||
| if err == nil { | ||
| t.Fatal("expected error when no config source is set") | ||
| } | ||
| if err.Error() != "alertmanager/app: exactly one of Options.ConfigFile or Options.ConfigHTTPURL must be set" { | ||
| t.Fatalf("unexpected error message: %v", err) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small nitpick: this seems to be tests for all sorts of config loading, not just
http_config- I think it would make more sense for this file to be calledconfig_loader_test.goor something along those lines.