Adding code to address docker healthcheck issue #1285
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,55 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| "log" | ||
| "net/http" | ||
| "os" | ||
| "strconv" | ||
| ) | ||
|
|
||
| // validatePort checks if the port configuration is valid | ||
| func validatePort(port string) error { | ||
|
|
||
| portInt, err := strconv.Atoi(port) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid port: %w", err) | ||
| } | ||
| if portInt < 1 || portInt > 65535 { | ||
| return fmt.Errorf("port outside of range [1;65535]: %d", portInt) | ||
| } | ||
| return nil | ||
|
|
||
| } | ||
|
|
||
| func main() { | ||
| const host = "127.0.0.1" // default host | ||
| usedPort := "13133" // default port | ||
| const path = "/" //default path | ||
| generateCmd := flag.NewFlagSet("generate", flag.ExitOnError) | ||
| port := generateCmd.String("port", usedPort, "Specify collector health-check port") | ||
|
|
||
| if len(os.Args) > 1 { | ||
| err := generateCmd.Parse(os.Args[1:]) | ||
| if err != nil { | ||
| log.Fatalf("%s", err) | ||
| } | ||
| } | ||
|
|
||
| validationErr := validatePort(*port) | ||
| if validationErr != nil { | ||
| log.Fatalf("%s", validationErr) | ||
| } | ||
|
|
||
| resp, err := http.Get(fmt.Sprint("http://", host, ":", *port, path)) | ||
| if err != nil { | ||
| log.Fatalf("Unable to retrieve health status: %s", err.Error()) | ||
bryan-aguilar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| if resp != nil && resp.StatusCode == 200 { | ||
| log.Printf("STATUS: %d", resp.StatusCode) | ||
| } else { | ||
bryan-aguilar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| log.Fatalf("STATUS: %d", resp.StatusCode) | ||
| } | ||
|
|
||
| } | ||
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,139 @@ | ||||||
| package main | ||||||
|
|
||||||
| import ( | ||||||
| "fmt" | ||||||
| "github.com/stretchr/testify/assert" | ||||||
| "io/ioutil" | ||||||
| "net" | ||||||
| "net/http" | ||||||
| "net/http/httptest" | ||||||
| "os" | ||||||
| "os/exec" | ||||||
| "testing" | ||||||
| ) | ||||||
|
|
||||||
| func TestHealthStatusHealthy(t *testing.T) { | ||||||
| if os.Getenv("FLAG") == "1" { | ||||||
bryan-aguilar marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| server := setUpMockCollector("127.0.0.1:13133", http.StatusOK) | ||||||
| os.Args = []string{"-port=13133"} | ||||||
| defer server.Close() | ||||||
| main() | ||||||
| return | ||||||
| } // Run the test in a subprocess | ||||||
| cmd := exec.Command(os.Args[0], "-test.run=TestHealthStatusHealthy") //nolint:gosec | ||||||
| cmd.Env = append(os.Environ(), "FLAG=1") | ||||||
|
|
||||||
| stdout, _ := cmd.StderrPipe() | ||||||
| er := cmd.Start() | ||||||
| if er != nil { | ||||||
| t.Fatal("Unable to start the testing sub-process.") | ||||||
| } | ||||||
|
|
||||||
| gotBytes, _ := ioutil.ReadAll(stdout) | ||||||
| got := string(gotBytes) | ||||||
| expectedErrorString := "STATUS: 200" | ||||||
|
|
||||||
| assert.Contains(t, got[:len(got)-1], expectedErrorString, | ||||||
| fmt.Sprintf("Unexpected log message. Got %s but should contain %s", got, expectedErrorString)) | ||||||
|
|
||||||
| err := cmd.Wait() | ||||||
| e, _ := err.(*exec.ExitError) | ||||||
| assert.Nil(t, e) | ||||||
|
|
||||||
| } | ||||||
|
|
||||||
| func TestHealthStatusUnhealthy(t *testing.T) { | ||||||
| if os.Getenv("FLAG") == "1" { | ||||||
| server := setUpMockCollector("127.0.0.1:13133", http.StatusInternalServerError) | ||||||
| os.Args = []string{"-port=13133"} | ||||||
| defer server.Close() | ||||||
| main() | ||||||
| return | ||||||
| } // Run the test in a subprocess | ||||||
| cmd := exec.Command(os.Args[0], "-test.run=TestHealthStatusUnhealthy") //nolint:gosec | ||||||
| cmd.Env = append(os.Environ(), "FLAG=1") | ||||||
|
|
||||||
| stdout, _ := cmd.StderrPipe() | ||||||
| er := cmd.Start() | ||||||
| if er != nil { | ||||||
| t.Fatal("Unable to start the testing sub-process.") | ||||||
| } | ||||||
|
|
||||||
| gotBytes, _ := ioutil.ReadAll(stdout) | ||||||
| got := string(gotBytes) | ||||||
| expectedErrorString := "STATUS: 500" | ||||||
|
|
||||||
| assert.Contains(t, got[:len(got)-1], expectedErrorString, | ||||||
| fmt.Sprintf("Unexpected log message. Got %s but should contain %s", got, expectedErrorString)) | ||||||
|
|
||||||
| err := cmd.Wait() | ||||||
| expectedErrorStatus := "exit status 1" | ||||||
| e, ok := err.(*exec.ExitError) | ||||||
| assert.Equal(t, true, ok) | ||||||
| assert.Equal(t, expectedErrorStatus, e.Error()) | ||||||
|
|
||||||
| } | ||||||
| func TestHealthStatusServerDown(t *testing.T) { | ||||||
| if os.Getenv("FLAG") == "1" { | ||||||
| server := setUpMockCollector("127.0.0.1:13132", http.StatusInternalServerError) | ||||||
| os.Args = []string{"-port=13133"} | ||||||
| defer server.Close() | ||||||
| main() | ||||||
| return | ||||||
| } // Run the test in a subprocess | ||||||
| cmd := exec.Command(os.Args[0], "-test.run=TestHealthStatusServerDown") //nolint:gosec | ||||||
| cmd.Env = append(os.Environ(), "FLAG=1") | ||||||
|
|
||||||
| stdout, _ := cmd.StderrPipe() | ||||||
| er := cmd.Start() | ||||||
| if er != nil { | ||||||
| t.Fatal("Unable to start the testing sub-process.") | ||||||
| } | ||||||
|
|
||||||
| gotBytes, _ := ioutil.ReadAll(stdout) | ||||||
| got := string(gotBytes) | ||||||
| expectedErrorString := "Unable to retrieve health status" | ||||||
|
|
||||||
| assert.Contains(t, got[:len(got)-1], expectedErrorString, | ||||||
| fmt.Sprintf("Unexpected log message. Got %s but should contain %s", got, expectedErrorString)) | ||||||
|
|
||||||
| err := cmd.Wait() | ||||||
| expectedErrorStatus := "exit status 1" | ||||||
| e, ok := err.(*exec.ExitError) | ||||||
| assert.Equal(t, true, ok) | ||||||
| assert.Equal(t, expectedErrorStatus, e.Error()) | ||||||
|
|
||||||
| } | ||||||
|
|
||||||
| func TestValidatePortWithWrongString(t *testing.T) { | ||||||
|
There was a problem hiding this comment. These next three test cases would be better suited off using a Table DrivenTesting format. I believe the There was a problem hiding this comment. Assert on There was a problem hiding this comment. Could we also add a test case for an empty string. There was a problem hiding this comment. thanks. Updated. |
||||||
| expectedErrorString := "invalid port" | ||||||
| actual := validatePort("wrongPort") | ||||||
|
|
||||||
| assert.Contains(t, actual.Error(), expectedErrorString, | ||||||
| fmt.Sprintf("Unexpected log message. Got %s but should contain %s", actual, expectedErrorString)) | ||||||
| } | ||||||
|
|
||||||
| func TestValidatePortWithWrongPort(t *testing.T) { | ||||||
| expectedErrorString := "port outside of range" | ||||||
| actual := validatePort("65536") | ||||||
|
|
||||||
| assert.Contains(t, actual.Error(), expectedErrorString, | ||||||
| fmt.Sprintf("Unexpected log message. Got %s but should contain %s", actual, expectedErrorString)) | ||||||
| } | ||||||
|
|
||||||
| func TestValidatePortWithValidPort(t *testing.T) { | ||||||
| actual := validatePort("65535") | ||||||
|
|
||||||
| assert.Nil(t, actual) | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Thanks. Updated. |
||||||
| } | ||||||
|
|
||||||
| func setUpMockCollector(healthCheckDefaultEndpoint string, statusCode int) *httptest.Server { | ||||||
| l, _ := net.Listen("tcp", healthCheckDefaultEndpoint) | ||||||
|
There was a problem hiding this comment. Do not ignore the error here. Instead use a There was a problem hiding this comment. Thanks. Updated. There was a problem hiding this comment. I do not see the update here. Has the change been pushed? There was a problem hiding this comment. Oh.. may be it was not pushed that time. Its added on line 59. |
||||||
| server := httptest.NewUnstartedServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { | ||||||
| rw.WriteHeader(statusCode) | ||||||
| })) | ||||||
| server.Listener.Close() | ||||||
| server.Listener = l | ||||||
| server.Start() | ||||||
| return server | ||||||
| } | ||||||
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
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
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.
When does this get utilized?
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.
As per your initial comment I added build commands for other architectures..