refactor: Break core package into multiple packages under config/endp…

…oint (#759) * refactor: Partially break core package into dns, result and ssh packages * refactor: Move core package to config/endpoint * refactor: Fix warning about overlapping imported package name with endpoint variable * refactor: Rename EndpointStatus to Status * refactor: Merge result pkg back into endpoint pkg, because it makes more sense * refactor: Rename parameter r to result in Condition.evaluate * refactor: Rename parameter r to result * refactor: Revert accidental change to endpoint.TypeDNS * refactor: Rename parameter r to result * refactor: Merge util package into endpoint package * refactor: Rename parameter r to result
TwiN · May 10, 2024 · 9d151fc · 9d151fc
1 parent 4397dcb
commit 9d151fc
Show file tree

Hide file tree

Showing 104 changed files with 1,216 additions and 1,211 deletions.
diff --git a/alerting/alert/alert.go b/alerting/alert/alert.go
@@ -10,7 +10,7 @@ var (
  ErrAlertWithInvalidDescription = errors.New("alert description must not have \" or \\")
 )
 
-// Alert is a core.Endpoint's alert configuration
+// Alert is a endpoint.Endpoint's alert configuration
 type Alert struct {
  // Type of alert (required)
  Type Type `yaml:"type"`

diff --git a/alerting/provider/awsses/awsses.go b/alerting/provider/awsses/awsses.go
@@ -5,7 +5,7 @@ import (
  "strings"
 
  "github.com/TwiN/gatus/v5/alerting/alert"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
  "github.com/aws/aws-sdk-go/aws"
  "github.com/aws/aws-sdk-go/aws/awserr"
  "github.com/aws/aws-sdk-go/aws/credentials"
@@ -57,14 +57,14 @@ func (provider *AlertProvider) IsValid() bool {
 }
 
 // Send an alert using the provider
-func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
+func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
  sess, err := provider.createSession()
  if err != nil {
  return err
  }
  svc := ses.New(sess)
- subject, body := provider.buildMessageSubjectAndBody(endpoint, alert, result, resolved)
- emails := strings.Split(provider.getToForGroup(endpoint.Group), ",")
+ subject, body := provider.buildMessageSubjectAndBody(ep, alert, result, resolved)
+ emails := strings.Split(provider.getToForGroup(ep.Group), ",")
 
  input := &ses.SendEmailInput{
  Destination: &ses.Destination{
@@ -110,14 +110,14 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert,
 }
 
 // buildMessageSubjectAndBody builds the message subject and body
-func (provider *AlertProvider) buildMessageSubjectAndBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) (string, string) {
+func (provider *AlertProvider) buildMessageSubjectAndBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) (string, string) {
  var subject, message string
  if resolved {
- subject = fmt.Sprintf("[%s] Alert resolved", endpoint.DisplayName())
- message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", endpoint.DisplayName(), alert.SuccessThreshold)
+ subject = fmt.Sprintf("[%s] Alert resolved", ep.DisplayName())
+ message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold)
  } else {
- subject = fmt.Sprintf("[%s] Alert triggered", endpoint.DisplayName())
- message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", endpoint.DisplayName(), alert.FailureThreshold)
+ subject = fmt.Sprintf("[%s] Alert triggered", ep.DisplayName())
+ message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold)
  }
  var formattedConditionResults string
  if len(result.ConditionResults) > 0 {

diff --git a/alerting/provider/awsses/awsses_test.go b/alerting/provider/awsses/awsses_test.go
@@ -4,7 +4,7 @@ import (
  "testing"
 
  "github.com/TwiN/gatus/v5/alerting/alert"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
 )
 
 func TestAlertDefaultProvider_IsValid(t *testing.T) {
@@ -95,10 +95,10 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
  for _, scenario := range scenarios {
  t.Run(scenario.Name, func(t *testing.T) {
  subject, body := scenario.Provider.buildMessageSubjectAndBody(
- &core.Endpoint{Name: "endpoint-name"},
+ &endpoint.Endpoint{Name: "endpoint-name"},
  &scenario.Alert,
- &core.Result{
- ConditionResults: []*core.ConditionResult{
+ &endpoint.Result{
+ ConditionResults: []*endpoint.ConditionResult{
  {Condition: "[CONNECTED] == true", Success: scenario.Resolved},
  {Condition: "[STATUS] == 200", Success: scenario.Resolved},
  },

diff --git a/alerting/provider/custom/custom.go b/alerting/provider/custom/custom.go
@@ -9,7 +9,7 @@ import (
 
  "github.com/TwiN/gatus/v5/alerting/alert"
  "github.com/TwiN/gatus/v5/client"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
 )
 
 // AlertProvider is the configuration necessary for sending an alert using a custom HTTP request
@@ -50,16 +50,16 @@ func (provider *AlertProvider) GetAlertStatePlaceholderValue(resolved bool) stri
  return status
 }
 
-func (provider *AlertProvider) buildHTTPRequest(endpoint *core.Endpoint, alert *alert.Alert, resolved bool) *http.Request {
+func (provider *AlertProvider) buildHTTPRequest(ep *endpoint.Endpoint, alert *alert.Alert, resolved bool) *http.Request {
  body, url, method := provider.Body, provider.URL, provider.Method
  body = strings.ReplaceAll(body, "[ALERT_DESCRIPTION]", alert.GetDescription())
  url = strings.ReplaceAll(url, "[ALERT_DESCRIPTION]", alert.GetDescription())
- body = strings.ReplaceAll(body, "[ENDPOINT_NAME]", endpoint.Name)
- url = strings.ReplaceAll(url, "[ENDPOINT_NAME]", endpoint.Name)
- body = strings.ReplaceAll(body, "[ENDPOINT_GROUP]", endpoint.Group)
- url = strings.ReplaceAll(url, "[ENDPOINT_GROUP]", endpoint.Group)
- body = strings.ReplaceAll(body, "[ENDPOINT_URL]", endpoint.URL)
- url = strings.ReplaceAll(url, "[ENDPOINT_URL]", endpoint.URL)
+ body = strings.ReplaceAll(body, "[ENDPOINT_NAME]", ep.Name)
+ url = strings.ReplaceAll(url, "[ENDPOINT_NAME]", ep.Name)
+ body = strings.ReplaceAll(body, "[ENDPOINT_GROUP]", ep.Group)
+ url = strings.ReplaceAll(url, "[ENDPOINT_GROUP]", ep.Group)
+ body = strings.ReplaceAll(body, "[ENDPOINT_URL]", ep.URL)
+ url = strings.ReplaceAll(url, "[ENDPOINT_URL]", ep.URL)
  if resolved {
  body = strings.ReplaceAll(body, "[ALERT_TRIGGERED_OR_RESOLVED]", provider.GetAlertStatePlaceholderValue(true))
  url = strings.ReplaceAll(url, "[ALERT_TRIGGERED_OR_RESOLVED]", provider.GetAlertStatePlaceholderValue(true))
@@ -78,8 +78,8 @@ func (provider *AlertProvider) buildHTTPRequest(endpoint *core.Endpoint, alert *
  return request
 }
 
-func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
- request := provider.buildHTTPRequest(endpoint, alert, resolved)
+func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
+ request := provider.buildHTTPRequest(ep, alert, resolved)
  response, err := client.GetHTTPClient(provider.ClientConfig).Do(request)
  if err != nil {
  return err

diff --git a/alerting/provider/custom/custom_test.go b/alerting/provider/custom/custom_test.go
@@ -8,7 +8,7 @@ import (
 
  "github.com/TwiN/gatus/v5/alerting/alert"
  "github.com/TwiN/gatus/v5/client"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
  "github.com/TwiN/gatus/v5/test"
 )
 
@@ -90,10 +90,10 @@ func TestAlertProvider_Send(t *testing.T) {
  t.Run(scenario.Name, func(t *testing.T) {
  client.InjectHTTPClient(&http.Client{Transport: scenario.MockRoundTripper})
  err := scenario.Provider.Send(
- &core.Endpoint{Name: "endpoint-name"},
+ &endpoint.Endpoint{Name: "endpoint-name"},
  &scenario.Alert,
- &core.Result{
- ConditionResults: []*core.ConditionResult{
+ &endpoint.Result{
+ ConditionResults: []*endpoint.ConditionResult{
  {Condition: "[CONNECTED] == true", Success: scenario.Resolved},
  {Condition: "[STATUS] == 200", Success: scenario.Resolved},
  },
@@ -138,7 +138,7 @@ func TestAlertProvider_buildHTTPRequest(t *testing.T) {
  for _, scenario := range scenarios {
  t.Run(fmt.Sprintf("resolved-%v-with-default-placeholders", scenario.Resolved), func(t *testing.T) {
  request := customAlertProvider.buildHTTPRequest(
- &core.Endpoint{Name: "endpoint-name", Group: "endpoint-group", URL: "https://example.com"},
+ &endpoint.Endpoint{Name: "endpoint-name", Group: "endpoint-group", URL: "https://example.com"},
  &alert.Alert{Description: &alertDescription},
  scenario.Resolved,
  )
@@ -188,7 +188,7 @@ func TestAlertProvider_buildHTTPRequestWithCustomPlaceholder(t *testing.T) {
  for _, scenario := range scenarios {
  t.Run(fmt.Sprintf("resolved-%v-with-custom-placeholders", scenario.Resolved), func(t *testing.T) {
  request := customAlertProvider.buildHTTPRequest(
- &core.Endpoint{Name: "endpoint-name", Group: "endpoint-group"},
+ &endpoint.Endpoint{Name: "endpoint-name", Group: "endpoint-group"},
  &alert.Alert{Description: &alertDescription},
  scenario.Resolved,
  )

diff --git a/alerting/provider/discord/discord.go b/alerting/provider/discord/discord.go
@@ -9,7 +9,7 @@ import (
 
  "github.com/TwiN/gatus/v5/alerting/alert"
  "github.com/TwiN/gatus/v5/client"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
 )
 
 // AlertProvider is the configuration necessary for sending an alert using Discord
@@ -47,9 +47,9 @@ func (provider *AlertProvider) IsValid() bool {
 }
 
 // Send an alert using the provider
-func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
- buffer := bytes.NewBuffer(provider.buildRequestBody(endpoint, alert, result, resolved))
- request, err := http.NewRequest(http.MethodPost, provider.getWebhookURLForGroup(endpoint.Group), buffer)
+func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
+ buffer := bytes.NewBuffer(provider.buildRequestBody(ep, alert, result, resolved))
+ request, err := http.NewRequest(http.MethodPost, provider.getWebhookURLForGroup(ep.Group), buffer)
  if err != nil {
  return err
  }
@@ -85,14 +85,14 @@ type Field struct {
 }
 
 // buildRequestBody builds the request body for the provider
-func (provider *AlertProvider) buildRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) []byte {
+func (provider *AlertProvider) buildRequestBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) []byte {
  var message string
  var colorCode int
  if resolved {
- message = fmt.Sprintf("An alert for **%s** has been resolved after passing successfully %d time(s) in a row", endpoint.DisplayName(), alert.SuccessThreshold)
+ message = fmt.Sprintf("An alert for **%s** has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold)
  colorCode = 3066993
  } else {
- message = fmt.Sprintf("An alert for **%s** has been triggered due to having failed %d time(s) in a row", endpoint.DisplayName(), alert.FailureThreshold)
+ message = fmt.Sprintf("An alert for **%s** has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold)
  colorCode = 15158332
  }
  var formattedConditionResults string

diff --git a/alerting/provider/discord/discord_test.go b/alerting/provider/discord/discord_test.go
@@ -7,7 +7,7 @@ import (
 
  "github.com/TwiN/gatus/v5/alerting/alert"
  "github.com/TwiN/gatus/v5/client"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
  "github.com/TwiN/gatus/v5/test"
 )
 
@@ -127,10 +127,10 @@ func TestAlertProvider_Send(t *testing.T) {
  t.Run(scenario.Name, func(t *testing.T) {
  client.InjectHTTPClient(&http.Client{Transport: scenario.MockRoundTripper})
  err := scenario.Provider.Send(
- &core.Endpoint{Name: "endpoint-name"},
+ &endpoint.Endpoint{Name: "endpoint-name"},
  &scenario.Alert,
- &core.Result{
- ConditionResults: []*core.ConditionResult{
+ &endpoint.Result{
+ ConditionResults: []*endpoint.ConditionResult{
  {Condition: "[CONNECTED] == true", Success: scenario.Resolved},
  {Condition: "[STATUS] == 200", Success: scenario.Resolved},
  },
@@ -191,18 +191,18 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
  }
  for _, scenario := range scenarios {
  t.Run(scenario.Name, func(t *testing.T) {
- var conditionResults []*core.ConditionResult
+ var conditionResults []*endpoint.ConditionResult
  if !scenario.NoConditions {
- conditionResults = []*core.ConditionResult{
+ conditionResults = []*endpoint.ConditionResult{
  {Condition: "[CONNECTED] == true", Success: scenario.Resolved},
  {Condition: "[STATUS] == 200", Success: scenario.Resolved},
  {Condition: "[BODY] != \"\"", Success: scenario.Resolved},
  }
  }
  body := scenario.Provider.buildRequestBody(
- &core.Endpoint{Name: "endpoint-name"},
+ &endpoint.Endpoint{Name: "endpoint-name"},
  &scenario.Alert,
- &core.Result{
+ &endpoint.Result{
  ConditionResults: conditionResults,
  },
  scenario.Resolved,

diff --git a/alerting/provider/email/email.go b/alerting/provider/email/email.go
@@ -8,7 +8,7 @@ import (
 
  "github.com/TwiN/gatus/v5/alerting/alert"
  "github.com/TwiN/gatus/v5/client"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
  gomail "gopkg.in/mail.v2"
 )
 
@@ -53,17 +53,17 @@ func (provider *AlertProvider) IsValid() bool {
 }
 
 // Send an alert using the provider
-func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
+func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
  var username string
  if len(provider.Username) > 0 {
  username = provider.Username
  } else {
  username = provider.From
  }
- subject, body := provider.buildMessageSubjectAndBody(endpoint, alert, result, resolved)
+ subject, body := provider.buildMessageSubjectAndBody(ep, alert, result, resolved)
  m := gomail.NewMessage()
  m.SetHeader("From", provider.From)
- m.SetHeader("To", strings.Split(provider.getToForGroup(endpoint.Group), ",")...)
+ m.SetHeader("To", strings.Split(provider.getToForGroup(ep.Group), ",")...)
  m.SetHeader("Subject", subject)
  m.SetBody("text/plain", body)
  var d *gomail.Dialer
@@ -87,14 +87,14 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert,
 }
 
 // buildMessageSubjectAndBody builds the message subject and body
-func (provider *AlertProvider) buildMessageSubjectAndBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) (string, string) {
+func (provider *AlertProvider) buildMessageSubjectAndBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) (string, string) {
  var subject, message string
  if resolved {
- subject = fmt.Sprintf("[%s] Alert resolved", endpoint.DisplayName())
- message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", endpoint.DisplayName(), alert.SuccessThreshold)
+ subject = fmt.Sprintf("[%s] Alert resolved", ep.DisplayName())
+ message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold)
  } else {
- subject = fmt.Sprintf("[%s] Alert triggered", endpoint.DisplayName())
- message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", endpoint.DisplayName(), alert.FailureThreshold)
+ subject = fmt.Sprintf("[%s] Alert triggered", ep.DisplayName())
+ message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold)
  }
  var formattedConditionResults string
  if len(result.ConditionResults) > 0 {

diff --git a/alerting/provider/email/email_test.go b/alerting/provider/email/email_test.go
@@ -4,7 +4,7 @@ import (
  "testing"
 
  "github.com/TwiN/gatus/v5/alerting/alert"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
 )
 
 func TestAlertDefaultProvider_IsValid(t *testing.T) {
@@ -97,10 +97,10 @@ func TestAlertProvider_buildRequestBody(t *testing.T) {
  for _, scenario := range scenarios {
  t.Run(scenario.Name, func(t *testing.T) {
  subject, body := scenario.Provider.buildMessageSubjectAndBody(
- &core.Endpoint{Name: "endpoint-name"},
+ &endpoint.Endpoint{Name: "endpoint-name"},
  &scenario.Alert,
- &core.Result{
- ConditionResults: []*core.ConditionResult{
+ &endpoint.Result{
+ ConditionResults: []*endpoint.ConditionResult{
  {Condition: "[CONNECTED] == true", Success: scenario.Resolved},
  {Condition: "[STATUS] == 200", Success: scenario.Resolved},
  },

diff --git a/alerting/provider/github/github.go b/alerting/provider/github/github.go
@@ -8,7 +8,7 @@ import (
  "time"
 
  "github.com/TwiN/gatus/v5/alerting/alert"
- "github.com/TwiN/gatus/v5/core"
+ "github.com/TwiN/gatus/v5/config/endpoint"
  "github.com/google/go-github/v48/github"
  "golang.org/x/oauth2"
 )
@@ -70,12 +70,12 @@ func (provider *AlertProvider) IsValid() bool {
 
 // Send creates an issue in the designed RepositoryURL if the resolved parameter passed is false,
 // or closes the relevant issue(s) if the resolved parameter passed is true.
-func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error {
- title := "alert(gatus): " + endpoint.DisplayName()
+func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
+ title := "alert(gatus): " + ep.DisplayName()
  if !resolved {
  _, _, err := provider.githubClient.Issues.Create(context.Background(), provider.repositoryOwner, provider.repositoryName, &github.IssueRequest{
  Title: github.String(title),
- Body: github.String(provider.buildIssueBody(endpoint, alert, result)),
+ Body: github.String(provider.buildIssueBody(ep, alert, result)),
  })
  if err != nil {
  return fmt.Errorf("failed to create issue: %w", err)
@@ -104,7 +104,7 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert,
 }
 
 // buildIssueBody builds the body of the issue
-func (provider *AlertProvider) buildIssueBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result) string {
+func (provider *AlertProvider) buildIssueBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result) string {
  var formattedConditionResults string
  if len(result.ConditionResults) > 0 {
  formattedConditionResults = "\n\n## Condition results\n"
@@ -122,7 +122,7 @@ func (provider *AlertProvider) buildIssueBody(endpoint *core.Endpoint, alert *al
  if alertDescription := alert.GetDescription(); len(alertDescription) > 0 {
  description = ":\n> " + alertDescription
  }
- message := fmt.Sprintf("An alert for **%s** has been triggered due to having failed %d time(s) in a row", endpoint.DisplayName(), alert.FailureThreshold)
+ message := fmt.Sprintf("An alert for **%s** has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold)
  return message + description + formattedConditionResults
 }