-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Test CheckForServiceAvailability (#25)
* Comment the function * Add tests for reading the YAML file * Remove unused lib * Fix a test * Fix the GitHubMainLocation address * Refactor CheckForServiceAvailability * Write a test for logServiceUnavailability * Refactor handleServiceUnavailability to use Error instead of os.Exit(1) Add a unit test too * Add a test for determineStatusAndEnv
- Loading branch information
Showing
2 changed files
with
306 additions
and
34 deletions.
There are no files selected for viewing
This file contains 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 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,219 @@ | ||
| package datasetUtils | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
| "bytes" | ||
| "gopkg.in/yaml.v2" | ||
| "log" | ||
| "os" | ||
| "strings" | ||
| "reflect" | ||
| ) | ||
|
|
||
| func TestReadYAMLFile(t *testing.T) { | ||
| // Create a mock HTTP server | ||
| server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| switch r.URL.Path { | ||
| case "/repos/paulscherrerinstitute/scicat-cli/releases/latest": | ||
| // Respond with a mock release | ||
| fmt.Fprintln(w, `{"tag_name": "v1.0.0"}`) | ||
| case "/paulscherrerinstitute/scicat-cli/releases/download/v1.0.0/cmd/datasetIngestor/datasetIngestorServiceAvailability.yml": | ||
| // Respond with a mock YAML file | ||
| fmt.Fprintln(w, "mock: YAML file") | ||
| default: | ||
| http.NotFound(w, r) | ||
| } | ||
| })) | ||
| defer server.Close() | ||
|
|
||
| // Update the GitHubAPI and GitHubMainLocation variables to point to the mock server | ||
| oldGitHubAPI := GitHubAPI | ||
| oldGitHubMainLocation := GitHubMainLocation | ||
| GitHubAPI = server.URL + "/repos/paulscherrerinstitute/scicat-cli/releases/latest" | ||
| GitHubMainLocation = server.URL + "/paulscherrerinstitute/scicat-cli/releases/download/v1.0.0" | ||
| defer func() { | ||
| // Restore the original variables after the test | ||
| GitHubAPI = oldGitHubAPI | ||
| GitHubMainLocation = oldGitHubMainLocation | ||
| }() | ||
|
|
||
| // Create a new HTTP client | ||
| client := &http.Client{} | ||
|
|
||
| // Call the function | ||
| yamlFile, err := readYAMLFile(client) | ||
| if err != nil { | ||
| t.Fatalf("Expected no error, got %v", err) | ||
| } | ||
|
|
||
| // Check that the function returned the expected YAML file | ||
| expected := []byte("mock: YAML file\n") | ||
| if !bytes.Equal(yamlFile, expected) { | ||
| t.Errorf("Expected %q, got %q", expected, yamlFile) | ||
| } | ||
| } | ||
|
|
||
| func TestReadYAMLFileIntegration(t *testing.T) { | ||
| // Create a new HTTP client | ||
| client := &http.Client{} | ||
|
|
||
| // Call the function | ||
| yamlFile, err := readYAMLFile(client) | ||
| if err != nil { | ||
| t.Fatalf("Expected no error, got %v", err) | ||
| } | ||
|
|
||
| // Check that the function returned a non-empty file | ||
| if len(yamlFile) == 0 { | ||
| t.Errorf("Expected a non-empty YAML file, got an empty file") | ||
| } | ||
| } | ||
|
|
||
| func TestYAMLStructure(t *testing.T) { | ||
| // The test will fail if the indentation of yamlFile is not correct | ||
| yamlFile := []byte(` | ||
| production: | ||
| ingest: | ||
| status: on | ||
| archive: | ||
| status: on | ||
| qa: | ||
| ingest: | ||
| status: on | ||
| archive: | ||
| status: on | ||
| `) | ||
|
|
||
| var serviceAvailability ServiceAvailability | ||
|
|
||
| err := yaml.Unmarshal(yamlFile, &serviceAvailability) | ||
| if err != nil { | ||
| t.Fatalf("Expected no error, got %v", err) | ||
| } | ||
|
|
||
| checkService := func(service Availability, serviceName string) { | ||
| if service.Status != "on" { | ||
| if service.Downfrom == "" { | ||
| t.Errorf("Expected 'downfrom' for %s when status is 'down'", serviceName) | ||
| } | ||
|
|
||
| if service.Downto == "" { | ||
| t.Errorf("Expected 'downto' for %s when status is 'down'", serviceName) | ||
| } | ||
|
|
||
| if service.Comment == "" { | ||
| t.Errorf("Expected 'comment' for %s when status is 'down'", serviceName) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| checkService(serviceAvailability.Production.Ingest, "production ingest") | ||
| checkService(serviceAvailability.Production.Archive, "production archive") | ||
| checkService(serviceAvailability.Qa.Ingest, "qa ingest") | ||
| checkService(serviceAvailability.Qa.Archive, "qa archive") | ||
| } | ||
|
|
||
| func TestLogServiceUnavailability(t *testing.T) { | ||
| var buf bytes.Buffer | ||
| log.SetOutput(&buf) | ||
| defer func() { | ||
| log.SetOutput(os.Stderr) | ||
| }() | ||
|
|
||
| serviceName := "ingest" | ||
| env := "test" | ||
| availability := Availability{ | ||
| Status: "off", | ||
| Downfrom: "2022-01-01T00:00:00Z", | ||
| Downto: "2022-01-02T00:00:00Z", | ||
| Comment: "Maintenance", | ||
| } | ||
|
|
||
| logServiceUnavailability(serviceName, env, availability) | ||
|
|
||
| want := "The test data catalog is currently not available for ingesting new datasets" | ||
| if got := buf.String(); !strings.Contains(got, want) { | ||
| t.Errorf("logServiceUnavailability() = %q, want %q", got, want) | ||
| } | ||
|
|
||
| want = "Planned downtime until 2022-01-02T00:00:00Z. Reason: Maintenance" | ||
| if got := buf.String(); !strings.Contains(got, want) { | ||
| t.Errorf("logServiceUnavailability() = %q, want %q", got, want) | ||
| } | ||
| } | ||
|
|
||
| func TestHandleServiceUnavailability(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| status OverallAvailability | ||
| env string | ||
| autoarchiveFlag bool | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "ingest service unavailable", | ||
| status: OverallAvailability{ | ||
| Ingest: Availability{Status: "off"}, | ||
| Archive: Availability{Status: "on"}, | ||
| }, | ||
| env: "test", | ||
| autoarchiveFlag: false, | ||
| wantErr: true, | ||
| }, | ||
| // Add more test cases here. | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := handleServiceUnavailability(tt.status, tt.env, tt.autoarchiveFlag) | ||
| if (err != nil) != tt.wantErr { | ||
| t.Errorf("handleServiceUnavailability() error = %v, wantErr %v", err, tt.wantErr) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestDetermineStatusAndEnv(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| s ServiceAvailability | ||
| testenvFlag bool | ||
| wantStatus OverallAvailability | ||
| wantEnv string | ||
| }{ | ||
| { | ||
| name: "test environment", | ||
| s: ServiceAvailability{ | ||
| Qa: OverallAvailability{ | ||
| Ingest: Availability{Status: "off"}, | ||
| Archive: Availability{Status: "on"}, | ||
| }, | ||
| Production: OverallAvailability{ | ||
| Ingest: Availability{Status: "on"}, | ||
| Archive: Availability{Status: "on"}, | ||
| }, | ||
| }, | ||
| testenvFlag: true, | ||
| wantStatus: OverallAvailability{ | ||
| Ingest: Availability{Status: "off"}, | ||
| Archive: Availability{Status: "on"}, | ||
| }, | ||
| wantEnv: "test", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| gotStatus, gotEnv := determineStatusAndEnv(tt.s, tt.testenvFlag) | ||
| if !reflect.DeepEqual(gotStatus, tt.wantStatus) { | ||
| t.Errorf("determineStatusAndEnv() gotStatus = %v, want %v", gotStatus, tt.wantStatus) | ||
| } | ||
| if gotEnv != tt.wantEnv { | ||
| t.Errorf("determineStatusAndEnv() gotEnv = %v, want %v", gotEnv, tt.wantEnv) | ||
| } | ||
| }) | ||
| } | ||
| } |