fix: add Google Chat to list of alert types when determining valid providers (#341)

Relevant: #336

.github/workflows/publish-experimental.yml

@@ -19,10 +19,9 @@ jobs:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
       - name: Build and push docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           platforms: linux/amd64
           pull: true
           push: true
-          tags: |
-            ${{ env.IMAGE_REPOSITORY }}:experimental
+          tags: ${{ env.IMAGE_REPOSITORY }}:experimental

.github/workflows/publish-latest.yml

@@ -4,6 +4,9 @@ on:
     workflows: ["build"]
     branches: [master]
     types: [completed]
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
 jobs:
   publish-latest:
     name: publish-latest
@@ -24,10 +27,9 @@ jobs:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
       - name: Build and push docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
           pull: true
           push: true
-          tags: |
-            ${{ env.IMAGE_REPOSITORY }}:latest
+          tags: ${{ env.IMAGE_REPOSITORY }}:latest

README.md

@@ -28,6 +28,9 @@ For more details, see [Usage](#usage)
 
 Have any feedback or questions? [Create a discussion](https://github.com/TwiN/gatus/discussions/new).
 
+Like this project? Please consider [sponsoring me](https://github.com/sponsors/TwiN).
+
+
 ## Table of Contents
 - [Why Gatus?](#why-gatus)
 - [Features](#features)
@@ -88,6 +91,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
   - [High level design overview](#high-level-design-overview)
 - [Sponsors](#sponsors)
 
+
 ## Why Gatus?
 Before getting into the specifics, I want to address the most common question:
 > Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?
@@ -119,6 +123,7 @@ The main features of Gatus are:
 
 ![Gatus dashboard dark mode](.github/assets/dashboard-dark.png)
 
+
 ## Usage
 By default, the configuration file is expected to be at `config/config.yaml`.
 
@@ -818,6 +823,7 @@ Here's an example of what the notifications look like:
 
 ![Teams notifications](.github/assets/teams-alerts.png)
 
+
 #### Configuring Telegram alerts
 | Parameter                         | Description                                                                                | Default                    |
 |:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------------|
@@ -886,6 +892,7 @@ endpoints:
         description: "healthcheck failed"
 ```
 
+
 #### Configuring custom alerts
 | Parameter                       | Description                                                                                | Default       |
 |:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
@@ -1046,6 +1053,7 @@ endpoints:
       - type: pagerduty
 ```
 
+
 ### Maintenance
 If you have maintenance windows, you may not want to be annoyed by alerts.
 To do that, you'll have to use the maintenance configuration:
@@ -1084,6 +1092,7 @@ maintenance:
 | `security.basic`                 | HTTP Basic configuration     | `{}`          |
 | `security.oidc`                  | OpenID Connect configuration | `{}`          |
 
+
 #### Basic
 | Parameter                               | Description                                                                        | Default       |
 |:----------------------------------------|:-----------------------------------------------------------------------------------|:--------------|
@@ -1102,6 +1111,7 @@ security:
 **WARNING:** Make sure to carefully select to cost of the bcrypt hash. The higher the cost, the longer it takes to compute the hash,
 and basic auth verifies the password against the hash on every request. As of 2022-01-08, I suggest a cost of 8.
 
+
 #### OIDC
 | Parameter                        | Description                                                    | Default       |
 |:---------------------------------|:---------------------------------------------------------------|:--------------|
@@ -1215,7 +1225,6 @@ and [helmfile example](https://github.com/avakarev/gatus-chart#helmfileyaml-exam
 Gatus can be deployed on Terraform by using the following module: [terraform-kubernetes-gatus](https://github.com/TwiN/terraform-kubernetes-gatus).
 
 
-
 ## Running the tests
 ```console
 go test ./... -mod vendor
@@ -1568,6 +1577,7 @@ Where:
 - `{duration}` is `7d`, `24h` or `1h`
 - `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`.
 
+
 ##### How to change the color thresholds of the response time badge  
 To change the response time badges' threshold, a corresponding configuration can be added to an endpoint.   
 The values in the array correspond to the levels [Awesome, Great, Good, Passable, Bad]  

alerting/provider/messagebird/messagebird.go

@@ -2,6 +2,7 @@ package messagebird
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@@ -33,7 +34,7 @@ func (provider *AlertProvider) IsValid() bool {
 // Send an alert using the provider
 // Reference doc for messagebird: https://developers.messagebird.com/api/sms-messaging/#send-outbound-sms
 func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
-	buffer := bytes.NewBuffer([]byte(provider.buildRequestBody(endpoint, alert, result, resolved)))
+	buffer := bytes.NewBuffer(provider.buildRequestBody(endpoint, alert, result, resolved))
 	request, err := http.NewRequest(http.MethodPost, restAPIURL, buffer)
 	if err != nil {
 		return err
@@ -51,19 +52,26 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert,
 	return err
 }
 
+type Body struct {
+	Originator string `json:"originator"`
+	Recipients string `json:"recipients"`
+	Body       string `json:"body"`
+}
+
 // buildRequestBody builds the request body for the provider
-func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) string {
+func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) []byte {
 	var message string
 	if resolved {
 		message = fmt.Sprintf("RESOLVED: %s - %s", endpoint.DisplayName(), alert.GetDescription())
 	} else {
 		message = fmt.Sprintf("TRIGGERED: %s - %s", endpoint.DisplayName(), alert.GetDescription())
 	}
-	return fmt.Sprintf(`{
-  "originator": "%s",
-  "recipients": "%s",
-  "body": "%s"
-}`, provider.Originator, provider.Recipients, message)
+	body, _ := json.Marshal(Body{
+		Originator: provider.Originator,
+		Recipients: provider.Recipients,
+		Body:       message,
+	})
+	return body
 }
 
 // GetDefaultAlert returns the provider's default alert configuration

alerting/provider/messagebird/messagebird_test.go

@@ -118,14 +118,14 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
 			Provider:     AlertProvider{AccessKey: "1", Originator: "2", Recipients: "3"},
 			Alert:        alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3},
 			Resolved:     false,
-			ExpectedBody: "{\n  \"originator\": \"2\",\n  \"recipients\": \"3\",\n  \"body\": \"TRIGGERED: endpoint-name - description-1\"\n}",
+			ExpectedBody: "{\"originator\":\"2\",\"recipients\":\"3\",\"body\":\"TRIGGERED: endpoint-name - description-1\"}",
 		},
 		{
 			Name:         "resolved",
 			Provider:     AlertProvider{AccessKey: "4", Originator: "5", Recipients: "6"},
 			Alert:        alert.Alert{Description: &secondDescription, SuccessThreshold: 5, FailureThreshold: 3},
 			Resolved:     true,
-			ExpectedBody: "{\n  \"originator\": \"5\",\n  \"recipients\": \"6\",\n  \"body\": \"RESOLVED: endpoint-name - description-2\"\n}",
+			ExpectedBody: "{\"originator\":\"5\",\"recipients\":\"6\",\"body\":\"RESOLVED: endpoint-name - description-2\"}",
 		},
 	}
 	for _, scenario := range scenarios {
@@ -141,7 +141,7 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
 				},
 				scenario.Resolved,
 			)
-			if body != scenario.ExpectedBody {
+			if string(body) != scenario.ExpectedBody {
 				t.Errorf("expected %s, got %s", scenario.ExpectedBody, body)
 			}
 			out := make(map[string]interface{})

alerting/provider/ntfy/ntfy.go

@@ -2,6 +2,7 @@ package ntfy
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@@ -56,8 +57,16 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert,
 	return err
 }
 
+type Body struct {
+	Topic    string   `json:"topic"`
+	Title    string   `json:"title"`
+	Message  string   `json:"message"`
+	Tags     []string `json:"tags"`
+	Priority int      `json:"priority"`
+}
+
 // buildRequestBody builds the request body for the provider
-func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) string {
+func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) []byte {
 	var message, tag string
 	if len(alert.GetDescription()) > 0 {
 		message = endpoint.DisplayName() + " - " + alert.GetDescription()
@@ -69,13 +78,14 @@ func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *
 	} else {
 		tag = "x"
 	}
-	return fmt.Sprintf(`{
-  "topic": "%s",
-  "title": "Gatus",
-  "message": "%s",
-  "tags": ["%s"],
-  "priority": %d
-}`, provider.Topic, message, tag, provider.Priority)
+	body, _ := json.Marshal(Body{
+		Topic:    provider.Topic,
+		Title:    "Gatus",
+		Message:  message,
+		Tags:     []string{tag},
+		Priority: provider.Priority,
+	})
+	return body
 }
 
 // GetDefaultAlert returns the provider's default alert configuration

alerting/provider/ntfy/ntfy_test.go

@@ -69,14 +69,14 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
 			Provider:     AlertProvider{URL: "https://ntfy.sh", Topic: "example", Priority: 1},
 			Alert:        alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3},
 			Resolved:     false,
-			ExpectedBody: "{\n  \"topic\": \"example\",\n  \"title\": \"Gatus\",\n  \"message\": \"endpoint-name - description-1\",\n  \"tags\": [\"x\"],\n  \"priority\": 1\n}",
+			ExpectedBody: "{\"topic\":\"example\",\"title\":\"Gatus\",\"message\":\"endpoint-name - description-1\",\"tags\":[\"x\"],\"priority\":1}",
 		},
 		{
 			Name:         "resolved",
 			Provider:     AlertProvider{URL: "https://ntfy.sh", Topic: "example", Priority: 2},
 			Alert:        alert.Alert{Description: &secondDescription, SuccessThreshold: 5, FailureThreshold: 3},
 			Resolved:     true,
-			ExpectedBody: "{\n  \"topic\": \"example\",\n  \"title\": \"Gatus\",\n  \"message\": \"endpoint-name - description-2\",\n  \"tags\": [\"white_check_mark\"],\n  \"priority\": 2\n}",
+			ExpectedBody: "{\"topic\":\"example\",\"title\":\"Gatus\",\"message\":\"endpoint-name - description-2\",\"tags\":[\"white_check_mark\"],\"priority\":2}",
 		},
 	}
 	for _, scenario := range scenarios {
@@ -92,11 +92,11 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
 				},
 				scenario.Resolved,
 			)
-			if body != scenario.ExpectedBody {
+			if string(body) != scenario.ExpectedBody {
 				t.Errorf("expected %s, got %s", scenario.ExpectedBody, body)
 			}
 			out := make(map[string]interface{})
-			if err := json.Unmarshal([]byte(body), &out); err != nil {
+			if err := json.Unmarshal(body, &out); err != nil {
 				t.Error("expected body to be valid JSON, got error:", err.Error())
 			}
 		})

config/config.go

@@ -302,6 +302,7 @@ func validateAlertingConfig(alertingConfig *alerting.Config, endpoints []*core.E
 	alertTypes := []alert.Type{
 		alert.TypeCustom,
 		alert.TypeDiscord,
+		alert.TypeGoogleChat,
 		alert.TypeEmail,
 		alert.TypeMatrix,
 		alert.TypeMattermost,