-
Notifications
You must be signed in to change notification settings - Fork 1
feat: Teams notifications #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alex289
wants to merge
2
commits into
main
Choose a base branch
from
feature/teams_notifications
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,58 @@ | ||
| package provider | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "net/url" | ||
| "strings" | ||
|
|
||
| "github.com/nicholas-fedor/shoutrrr/pkg/services/chat/teams" | ||
| ) | ||
|
|
||
| type TeamsProvider struct{} | ||
|
|
||
| type teamsConfig struct { | ||
| Host string `json:"host"` | ||
| Title string `json:"title"` | ||
| } | ||
|
|
||
| func (TeamsProvider) BuildShoutrrrUrls(rawConfig string) ([]string, error) { | ||
| trimmed, err := normalizeRawConfig(rawConfig) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cfg, err := decodeConfigJSON[teamsConfig](trimmed, "invalid JSON teams config") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| host := strings.TrimSpace(cfg.Host) | ||
| if host == "" { | ||
| return nil, errors.New("teams config requires host") | ||
| } | ||
|
|
||
| webhookURL, err := url.Parse(host) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid teams host: %w", err) | ||
| } | ||
| if webhookURL.Scheme != "https" { | ||
| return nil, errors.New("teams host must be a valid HTTPS Teams webhook URL") | ||
| } | ||
|
|
||
| serviceConfig, err := teams.ConfigFromWebhookURL(webhookURL) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid teams host: %w", err) | ||
| } | ||
|
|
||
| if title := strings.TrimSpace(cfg.Title); title != "" { | ||
| serviceConfig.Title = title | ||
| } | ||
|
|
||
| serviceURL := serviceConfig.GetURL() | ||
| if serviceURL == nil { | ||
| return nil, errors.New("invalid teams host") | ||
| } | ||
|
|
||
| return []string{serviceURL.String()}, nil | ||
| } | ||
146 changes: 146 additions & 0 deletions
146
backend/internal/hub/notifications/provider/teams_test.go
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,146 @@ | ||
| package provider | ||
|
|
||
| import ( | ||
| "net/url" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/nicholas-fedor/shoutrrr" | ||
| ) | ||
|
|
||
| const validTeamsWebhookURL = "https://contoso.webhook.office.com/webhookb2/11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/IncomingWebhook/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05" | ||
|
|
||
| func TestTeamsProviderBuildShoutrrrUrls(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| raw string | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "empty config", | ||
| raw: " \n ", | ||
| wantErr: "notification config is empty", | ||
| }, | ||
| { | ||
| name: "invalid json object", | ||
| raw: "{", | ||
| wantErr: "invalid JSON teams config", | ||
| }, | ||
| { | ||
| name: "missing host", | ||
| raw: `{"title":"Deploy done"}`, | ||
| wantErr: "teams config requires host", | ||
| }, | ||
| { | ||
| name: "non-https scheme must be rejected", | ||
| raw: `{"host":"http://contoso.webhook.office.com/webhookb2/11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/IncomingWebhook/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05"}`, | ||
| wantErr: "teams host must be a valid HTTPS Teams webhook URL", | ||
| }, | ||
| { | ||
| name: "invalid webhook domain", | ||
| raw: `{"host":"https://example.com/webhookb2/11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/IncomingWebhook/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05"}`, | ||
| wantErr: "invalid teams host", | ||
| }, | ||
| { //nolint:gosec | ||
| name: "direct target string instead of json", | ||
| raw: "teams://11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05?host=contoso.webhook.office.com", | ||
| wantErr: "invalid JSON teams config", | ||
| }, | ||
| { //nolint:gosec | ||
| name: "json array instead of object", | ||
| raw: `[{"host":"` + validTeamsWebhookURL + `"}]`, | ||
| wantErr: "invalid JSON teams config", | ||
| }, | ||
| } | ||
|
|
||
| provider := TeamsProvider{} | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| got, err := provider.BuildShoutrrrUrls(tt.raw) | ||
| if tt.wantErr != "" { | ||
| if err == nil { | ||
| t.Fatalf("expected error containing %q", tt.wantErr) | ||
| } | ||
| if !strings.Contains(err.Error(), tt.wantErr) { | ||
| t.Fatalf("expected error containing %q, got %q", tt.wantErr, err.Error()) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("BuildShoutrrrUrls() error = %v", err) | ||
| } | ||
| if len(got) != 1 { | ||
| t.Fatalf("expected one URL, got %v", got) | ||
| } | ||
| if !strings.HasPrefix(got[0], "teams://") { | ||
| t.Fatalf("expected teams URL, got %q", got[0]) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestTeamsProviderBuildsStructuredURL(t *testing.T) { | ||
| provider := TeamsProvider{} | ||
|
|
||
| urls, err := provider.BuildShoutrrrUrls(`{"host":"` + validTeamsWebhookURL + `","title":"Deploy done"}`) | ||
| if err != nil { | ||
| t.Fatalf("BuildShoutrrrUrls() error = %v", err) | ||
| } | ||
| if len(urls) != 1 { | ||
| t.Fatalf("expected 1 URL, got %d", len(urls)) | ||
| } | ||
|
|
||
| parsed, err := url.Parse(urls[0]) | ||
| if err != nil { | ||
| t.Fatalf("failed to parse URL %q: %v", urls[0], err) | ||
| } | ||
|
|
||
| if parsed.Scheme != "teams" { | ||
| t.Fatalf("expected scheme teams, got %q", parsed.Scheme) | ||
| } | ||
| if parsed.User == nil || parsed.User.Username() != "11111111-4444-4444-8444-cccccccccccc" { | ||
| t.Fatalf("expected group in URL user, got %v", parsed.User) | ||
| } | ||
| if parsed.Host != "22222222-4444-4444-8444-cccccccccccc" { | ||
| t.Fatalf("expected tenant in URL host, got %q", parsed.Host) | ||
| } | ||
| if parsed.Path != "/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05" { | ||
| t.Fatalf("expected webhook path components, got %q", parsed.Path) | ||
| } | ||
|
|
||
| query := parsed.Query() | ||
| if query.Get("host") != "contoso.webhook.office.com" { | ||
| t.Fatalf("expected host query parameter, got %q", query.Get("host")) | ||
| } | ||
| if query.Get("title") != "Deploy done" { | ||
| t.Fatalf("expected title query parameter, got %q", query.Get("title")) | ||
| } | ||
|
|
||
| if _, err := shoutrrr.CreateSender(urls...); err != nil { | ||
| t.Fatalf("expected Shoutrrr to accept Teams URL: %v", err) | ||
| } | ||
| } | ||
|
|
||
| func TestTeamsProviderMinimalConfig(t *testing.T) { | ||
| provider := TeamsProvider{} | ||
|
|
||
| urls, err := provider.BuildShoutrrrUrls(`{"host":"` + validTeamsWebhookURL + `"}`) | ||
| if err != nil { | ||
| t.Fatalf("BuildShoutrrrUrls() error = %v", err) | ||
| } | ||
| if len(urls) != 1 { | ||
| t.Fatalf("expected 1 URL, got %d", len(urls)) | ||
| } | ||
|
|
||
| parsed, err := url.Parse(urls[0]) | ||
| if err != nil { | ||
| t.Fatalf("failed to parse URL %q: %v", urls[0], err) | ||
| } | ||
|
|
||
| query := parsed.Query() | ||
| if query.Get("title") != "" { | ||
| t.Fatalf("expected no title, got %q", query.Get("title")) | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.