fix: Add Beeep action to protobuf definitions and UI components #679
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,3 +5,4 @@ __debug_bin | |
| cmd/backrest/backrest | ||
| *.exe | ||
| .DS_Store | ||
| .idea/ | ||
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
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,67 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| v1 "github.com/garethgeorge/backrest/gen/go/v1" | ||
| "github.com/garethgeorge/backrest/internal/hook/hookutil" | ||
| "github.com/garethgeorge/backrest/internal/orchestrator/tasks" | ||
| "github.com/gen2brain/beeep" | ||
| "log" | ||
| "reflect" | ||
| ) | ||
|
|
||
| type beeepHandler struct{} | ||
|
|
||
| func (beeepHandler) Execute(ctx context.Context, h *v1.Hook, vars interface{}, runner tasks.TaskRunner, event v1.Hook_Condition) error { | ||
| b := h.GetActionBeeep() | ||
|
|
||
| message, err := hookutil.RenderTemplateOrDefault(b.GetTemplate(), hookutil.DefaultTemplate, vars) | ||
| if err != nil { | ||
| return fmt.Errorf("template rendering: %w", err) | ||
| } | ||
|
|
||
| title, err := hookutil.RenderTemplateOrDefault(b.GetTitleTemplate(), "Backrest Event", vars) | ||
| if err != nil { | ||
| return fmt.Errorf("title template rendering: %w", err) | ||
| } | ||
|
|
||
| frequency := b.GetFrequency() | ||
| if frequency == 0 { | ||
| frequency = beeep.DefaultFreq | ||
| } | ||
|
|
||
| duration := b.GetDuration() | ||
| if duration == 0 { | ||
| duration = int32(beeep.DefaultDuration) | ||
| } | ||
|
|
||
| icon := b.GetIcon() | ||
| if icon == "" { | ||
| icon = "assets/information.png" | ||
| } | ||
|
|
||
| log.Printf("Sending beeep notification icon %s", icon) | ||
| err = beeep.Alert(title, message, icon) | ||
| if err != nil { | ||
| return fmt.Errorf("beeep: %w", err) | ||
| } | ||
|
|
||
| err = beeep.Beep(b.GetFrequency(), int(b.GetDuration())) | ||
| if err != nil { | ||
| return fmt.Errorf("beeep: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (beeepHandler) Name() string { | ||
| return "beeep" | ||
| } | ||
|
|
||
| func (beeepHandler) ActionType() reflect.Type { | ||
| return reflect.TypeOf(&v1.Hook_ActionBeeep{}) | ||
| } | ||
|
|
||
| func init() { | ||
| DefaultRegistry().RegisterHandler(&beeepHandler{}) | ||
| } |
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,81 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| v1 "github.com/garethgeorge/backrest/gen/go/v1" | ||
| "github.com/garethgeorge/backrest/internal/orchestrator/tasks" | ||
| "github.com/gen2brain/beeep" | ||
| ) | ||
|
|
||
| type mockTaskRunner struct { | ||
| tasks.TaskRunner | ||
| } | ||
|
|
||
| func TestBeeepHandler_Execute(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| hook *v1.Hook | ||
| vars interface{} | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "basic notification", | ||
| hook: &v1.Hook{ | ||
| Action: &v1.Hook_ActionBeeep{ | ||
| ActionBeeep: &v1.Hook_Beeep{ | ||
| Template: "test message", | ||
| TitleTemplate: "test title", | ||
| Frequency: beeep.DefaultFreq, | ||
| Duration: int32(beeep.DefaultDuration), | ||
| Icon: "", | ||
| }, | ||
| }, | ||
| }, | ||
| vars: map[string]interface{}{"test": "value"}, | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "custom frequency and duration", | ||
| hook: &v1.Hook{ | ||
| Action: &v1.Hook_ActionBeeep{ | ||
| ActionBeeep: &v1.Hook_Beeep{ | ||
| Template: "test message", | ||
| TitleTemplate: "test title", | ||
| Frequency: 1000, | ||
| Duration: 2000, | ||
| Icon: "assets/information.png", | ||
| }, | ||
| }, | ||
| }, | ||
| vars: map[string]interface{}{"test": "value"}, | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "with template variables", | ||
| hook: &v1.Hook{ | ||
| Action: &v1.Hook_ActionBeeep{ | ||
| ActionBeeep: &v1.Hook_Beeep{ | ||
| Template: "{{.test}} message", | ||
| TitleTemplate: "{{.test}} title", | ||
| }, | ||
| }, | ||
| }, | ||
| vars: map[string]interface{}{"test": "value"}, | ||
| wantErr: false, | ||
| }, | ||
| } | ||
|
|
||
| handler := &beeepHandler{} | ||
| runner := &mockTaskRunner{} | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := handler.Execute(context.Background(), tt.hook, tt.vars, runner, v1.Hook_CONDITION_SNAPSHOT_SUCCESS) | ||
| if (err != nil) != tt.wantErr { | ||
| t.Errorf("Execute() error = %v, wantErr %v", err, tt.wantErr) | ||
| } | ||
| }) | ||
| } | ||
| } |
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
Binary file not shown.
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.
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.
Naming note: it may make more sense to name this after the capability e.g. OsNotification or such rather than the library beeep on the off chance that we need to migrate in the future.
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.
Agree, I will update.