Skip to content

Feat: add webhook runbook triggers #412

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.

Sign up for GitHub

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

Draft
Rose-Northey wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Feat: add webhook runbook triggers #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
94e04fd
WIP adding test broken
Rose-Northey Apr 20, 2026
f102747
chore: regenerate filter enum
benPearce1 Apr 20, 2026
c057611
Correct type of secret
Rose-Northey Apr 20, 2026
6fe608b
fix runbook webhook test
Rose-Northey Apr 20, 2026
5278269
Change the client pattern to new standards
Rose-Northey Apr 20, 2026
631519b
Change all "client" names to "octopusClient" due to an import clash
Rose-Northey Apr 20, 2026
0320c39
delete unused code
Rose-Northey Apr 20, 2026
1429a09
refactor repeated code into a helper function
Rose-Northey Apr 20, 2026
ef35c5c
Merge branch 'main' into fnm/add-webhook-runbook-triggers
Rose-Northey Apr 20, 2026
1b748df
add skipping if feature toggle is not present and enabled
Rose-Northey Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/filters/filter_type.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ const (
OnceDailySchedule
FeedFilter
GitFilter
WebhookFilter
)
14 changes: 9 additions & 5 deletions pkg/filters/filter_type_string.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions pkg/filters/json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ func FromJson(rawMessage *json.RawMessage) (ITriggerFilter, error) {
var filter *GitTriggerFilter
err := json.Unmarshal(*rawMessage, &filter)
return filter, err
case WebhookFilter:
var filter *WebhookTriggerFilter
err := json.Unmarshal(*rawMessage, &filter)
return filter, err
}

return nil, fmt.Errorf("unable to unmarshal filter from JSON")
Expand Down
28 changes: 28 additions & 0 deletions pkg/filters/webhook_trigger_filter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package filters

import "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/core"

type WebhookTriggerFilter struct {
Secret core.SensitiveValue `json:"Secret"`
WebhookId string `json:"WebhookId,omitempty"`

triggerFilter
}

func NewWebhookTriggerFilter(secret core.SensitiveValue) *WebhookTriggerFilter {

return &WebhookTriggerFilter{
triggerFilter: *newTriggerFilter(WebhookFilter),
Secret: secret,
}
}

func (t *WebhookTriggerFilter) GetFilterType() FilterType {
return t.Type
}

func (t *WebhookTriggerFilter) SetFilterType(filterType FilterType) {
t.Type = filterType
}

var _ ITriggerFilter = &WebhookTriggerFilter{}
211 changes: 61 additions & 150 deletions test/e2e/project_trigger_test.go
View file
Open in desktop
Copy link
Copy Markdown
Contributor Author

@Rose-Northey Rose-Northey Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • A new test was added to test the webhook triggers
  • a helper function was created to setup the space for trigger creation
  • "client" was replaced with "octopusClient" due to a conflict with imports
  • the triggers.XXX pattern was used rather than the previous pattern
  • unused tests were removed from the file

Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ import (
"github.com/OctopusDeploy/go-octopusdeploy/v2/internal"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/actions"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/configuration"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/core"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/filters"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/lifecycles"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projectgroups"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/triggers"
"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -39,7 +42,7 @@ func AssertEqualProjectTriggers(t *testing.T, expected *triggers.ProjectTrigger,
assert.Equal(t, expected.SpaceID, actual.SpaceID)
}

func CreateTestProjectTrigger(t *testing.T, client *client.Client, project *projects.Project, environment *environments.Environment) *triggers.ProjectTrigger {
func CreateTestScheduledProjectTriggerWithOnceDailyFilter(t *testing.T, client *client.Client, project *projects.Project) *triggers.ProjectTrigger {
require.NotNil(t, project)

if client == nil {
Expand All @@ -65,13 +68,13 @@ func CreateTestProjectTrigger(t *testing.T, client *client.Client, project *proj
require.NotNil(t, projectTrigger)
require.NoError(t, projectTrigger.Validate())

createdProjectTrigger, err := client.ProjectTriggers.Add(projectTrigger)
createdProjectTrigger, err := triggers.Add(client, projectTrigger)
require.NoError(t, err)
require.NotNil(t, createdProjectTrigger)
require.NotEmpty(t, createdProjectTrigger.GetID())

// verify the add operation was successful
projectTriggerToCompare, err := client.ProjectTriggers.GetByID(createdProjectTrigger.GetID())
projectTriggerToCompare, err := triggers.GetById(client, project.SpaceID, createdProjectTrigger.GetID())
require.NoError(t, err)
require.NotNil(t, projectTriggerToCompare)
AssertEqualProjectTriggers(t, createdProjectTrigger, projectTriggerToCompare)
Expand All @@ -87,11 +90,11 @@ func DeleteTestProjectTrigger(t *testing.T, client *client.Client, projectTrigge
}
require.NotNil(t, client)

err := client.ProjectTriggers.Delete(projectTrigger)
err := triggers.DeleteById(client, projectTrigger.SpaceID, projectTrigger.ID)
assert.NoError(t, err)

// verify the delete operation was successful
deletedProjectTrigger, err := client.ProjectTriggers.GetByID(projectTrigger.GetID())
deletedProjectTrigger, err := triggers.GetById(client, projectTrigger.SpaceID, projectTrigger.GetID())
assert.Error(t, err)
assert.Nil(t, deletedProjectTrigger)
}
Expand All @@ -111,189 +114,97 @@ func UpdateTestProjectTrigger(t *testing.T, client *client.Client, projectTrigge
return projectTrigger
}

func TestProjectTriggerAddGetUpdateDelete(t *testing.T) {
client := getOctopusClient()
require.NotNil(t, client)
func SetupClientAndProjectAndLifecycleAndProjectGroup(t *testing.T) (*client.Client, *projects.Project, *lifecycles.Lifecycle,
*projectgroups.ProjectGroup) {

octopusClient := getOctopusClient()
require.NotNil(t, octopusClient)

space := GetDefaultSpace(t, client)
space := GetDefaultSpace(t, octopusClient)
require.NotNil(t, space)

lifecycle := CreateTestLifecycle(t, client)
lifecycle := CreateTestLifecycle(t, octopusClient)
require.NotNil(t, lifecycle)
defer DeleteTestLifecycle(t, client, lifecycle)
t.Cleanup(func() { DeleteTestLifecycle(t, octopusClient, lifecycle) })

projectGroup := CreateTestProjectGroup(t, client)
projectGroup := CreateTestProjectGroup(t, octopusClient)
require.NotNil(t, projectGroup)
defer DeleteTestProjectGroup(t, client, projectGroup)
t.Cleanup(func() { DeleteTestProjectGroup(t, octopusClient, projectGroup) })

project := CreateTestProject(t, client, space, lifecycle, projectGroup)
project := CreateTestProject(t, octopusClient, space, lifecycle,
projectGroup)
require.NotNil(t, project)
defer DeleteTestProject(t, client, project)
t.Cleanup(func() { DeleteTestProject(t, octopusClient, project) })

return octopusClient, project, lifecycle, projectGroup
}

func TestProjectTriggerAddGetUpdateDelete(t *testing.T) {
octopusClient, project, lifecycle, _ := SetupClientAndProjectAndLifecycleAndProjectGroup(t)

environment := CreateTestEnvironment(t, client)
environment := CreateTestEnvironment(t, octopusClient)
require.NotNil(t, environment)
defer DeleteTestEnvironment(t, client, environment)
defer DeleteTestEnvironment(t, octopusClient, environment)

projectTrigger := CreateTestProjectTrigger(t, client, project, environment)
projectTrigger := CreateTestScheduledProjectTriggerWithOnceDailyFilter(t, octopusClient, project)
require.NotNil(t, lifecycle)
defer DeleteTestProjectTrigger(t, client, projectTrigger)
defer DeleteTestProjectTrigger(t, octopusClient, projectTrigger)

projectTrigger.Name = GetRandomName()
updatedProjectTrigger := UpdateTestProjectTrigger(t, client, projectTrigger)
updatedProjectTrigger := UpdateTestProjectTrigger(t, octopusClient, projectTrigger)
require.NotNil(t, updatedProjectTrigger)
}

func TestProjectTriggerGetAll(t *testing.T) {
client := getOctopusClient()
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)

lifecycle := CreateTestLifecycle(t, client)
require.NotNil(t, lifecycle)
defer DeleteTestLifecycle(t, client, lifecycle)

projectGroup := CreateTestProjectGroup(t, client)
require.NotNil(t, projectGroup)
defer DeleteTestProjectGroup(t, client, projectGroup)

project := CreateTestProject(t, client, space, lifecycle, projectGroup)
require.NotNil(t, project)
defer DeleteTestProject(t, client, project)

projectTriggers, err := client.ProjectTriggers.GetAll()
octopusClient, project, _, _ := SetupClientAndProjectAndLifecycleAndProjectGroup(t)
projectTriggers, err := triggers.GetAll(octopusClient, project.SpaceID)
require.NoError(t, err)
require.NotNil(t, projectTriggers)
}

// ----- new -----
func TestProjectWebhookRunbookTrigger(t *testing.T) {

func New_CreateTestProjectTrigger(t *testing.T, client *client.Client, project *projects.Project) *triggers.ProjectTrigger {
require.NotNil(t, project)
octopusClient, project, lifecycle, projectGroup := SetupClientAndProjectAndLifecycleAndProjectGroup(t)

if client == nil {
client = getOctopusClient()
//feature toggle must be present and enabled to run this test, otherwise skip it
webhookTriggersFeatureToggle, err := configuration.Get(octopusClient, &configuration.FeatureToggleConfigurationQuery{Name: "webhook-triggers"})
if err != nil {
t.Skip("Could not get feature toggle configuration")
} else if len(webhookTriggersFeatureToggle.FeatureToggles) == 0 {
t.Skip("WebhookTriggers feature toggle is not present")
} else if webhookTriggersFeatureToggle.FeatureToggles[0].IsEnabled == false {
t.Skip("WebhookTriggers feature toggle is not enabled")
}
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)
environment := CreateTestEnvironment(t, octopusClient)
require.NotNil(t, environment)
defer DeleteTestEnvironment(t, octopusClient, environment)

now := time.Now()
start := time.Date(now.Year(), now.Month(), now.Day(), 9, 0, 0, 0, time.UTC)
runbook := CreateTestRunbook(t, octopusClient, lifecycle, projectGroup, project)
require.NotNil(t, runbook)
defer DeleteTestRunbook(t, octopusClient, runbook)

action := actions.NewAutoDeployAction(createRandomBoolean())
filter := filters.NewOnceDailyScheduledTriggerFilter([]filters.Weekday{filters.Tuesday}, start)
action := actions.NewRunRunbookAction()
action.Runbook = runbook.GetID()
action.Environments = []string{environment.GetID()}

password := getShortRandomName()
secret := core.SensitiveValue{HasValue: true, NewValue: &password}

filter := filters.NewWebhookTriggerFilter(secret)

projectTrigger := triggers.NewProjectTrigger(internal.GetRandomName(), internal.GetRandomName(), createRandomBoolean(), project, action, filter)
require.NotNil(t, projectTrigger)
require.NoError(t, projectTrigger.Validate())

createdProjectTrigger, err := client.ProjectTriggers.Add(projectTrigger)
createdProjectTrigger, err := triggers.Add(octopusClient, projectTrigger)
require.NoError(t, err)
require.NotNil(t, createdProjectTrigger)
require.NotEmpty(t, createdProjectTrigger.GetID())

// verify the add operation was successful
projectTriggerToCompare, err := triggers.GetById(client, space.ID, createdProjectTrigger.GetID())
projectTriggerToCompare, err := triggers.GetById(octopusClient, project.SpaceID, createdProjectTrigger.GetID())
require.NoError(t, err)
require.NotNil(t, projectTriggerToCompare)
AssertEqualProjectTriggers(t, createdProjectTrigger, projectTriggerToCompare)

return createdProjectTrigger
}

func New_DeleteTestProjectTrigger(t *testing.T, client *client.Client, projectTrigger *triggers.ProjectTrigger) {
require.NotNil(t, projectTrigger)

if client == nil {
client = getOctopusClient()
}
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)

err := triggers.DeleteById(client, space.ID, projectTrigger.ID)
assert.NoError(t, err)

// verify the delete operation was successful
deletedProjectTrigger, err := triggers.GetById(client, space.ID, projectTrigger.GetID())
assert.Error(t, err)
assert.Nil(t, deletedProjectTrigger)
}

func New_UpdateTestProjectTrigger(t *testing.T, client *client.Client, projectTrigger *triggers.ProjectTrigger) *triggers.ProjectTrigger {
require.NotNil(t, projectTrigger)

if client == nil {
client = getOctopusClient()
}
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)

projectTrigger, err := triggers.Update(client, projectTrigger)
assert.NoError(t, err)
assert.NotNil(t, projectTrigger)

return projectTrigger
}

func New_TestProjectTriggerAddGetUpdateDelete(t *testing.T) {
client := getOctopusClient()
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)

lifecycle := CreateTestLifecycle(t, client)
require.NotNil(t, lifecycle)
defer DeleteTestLifecycle(t, client, lifecycle)

projectGroup := CreateTestProjectGroup(t, client)
require.NotNil(t, projectGroup)
defer DeleteTestProjectGroup(t, client, projectGroup)

project := CreateTestProject(t, client, space, lifecycle, projectGroup)
require.NotNil(t, project)
defer DeleteTestProject(t, client, project)

environment := CreateTestEnvironment(t, client)
require.NotNil(t, environment)
defer DeleteTestEnvironment(t, client, environment)

projectTrigger := New_CreateTestProjectTrigger(t, client, project)
require.NotNil(t, lifecycle)
defer New_DeleteTestProjectTrigger(t, client, projectTrigger)

projectTrigger.Name = GetRandomName()
updatedProjectTrigger := New_UpdateTestProjectTrigger(t, client, projectTrigger)
require.NotNil(t, updatedProjectTrigger)
}

func New_TestProjectTriggerGetAll(t *testing.T) {
client := getOctopusClient()
require.NotNil(t, client)

space := GetDefaultSpace(t, client)
require.NotNil(t, space)

lifecycle := CreateTestLifecycle(t, client)
require.NotNil(t, lifecycle)
defer DeleteTestLifecycle(t, client, lifecycle)

projectGroup := CreateTestProjectGroup(t, client)
require.NotNil(t, projectGroup)
defer DeleteTestProjectGroup(t, client, projectGroup)

project := CreateTestProject(t, client, space, lifecycle, projectGroup)
require.NotNil(t, project)
defer DeleteTestProject(t, client, project)

projectTriggers, err := triggers.GetAll(client, space.ID)
require.NoError(t, err)
require.NotNil(t, projectTriggers)
}
Loading