Skip to content

fix: Handle scenario where environment name query field isn't respected #771

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

Merged
APErebus merged 5 commits into from
Oct 19, 2026
Merged

fix: Handle scenario where environment name query field isn't respected #771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0f08519
fix: Try get environment by partial name when promoting
APErebus Oct 19, 2026
4b99c27
Tweak logic
APErebus Oct 19, 2026
5db3059
Add some extra checks
APErebus Oct 19, 2026
f54b411
Fix tests
APErebus Oct 19, 2026
5fa8d16
Change to case-insensitive name checks
APErebus Oct 19, 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
24 changes: 12 additions & 12 deletions pkg/cmd/release/promote/promote_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -151,7 +151,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -212,7 +212,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -261,7 +261,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -310,7 +310,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -371,7 +371,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -420,7 +420,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -469,7 +469,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -518,7 +518,7 @@ func TestPromoteRelease_Success(t *testing.T) {
})

// Lookup from environment by ID
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down Expand Up @@ -606,7 +606,7 @@ func TestPromoteRelease_Errors(t *testing.T) {
RespondWith(resources.Resources[*projects.Project]{
Items: []*projects.Project{fireProject},
})
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=NonExistent&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=NonExistent&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand All @@ -628,7 +628,7 @@ func TestPromoteRelease_Errors(t *testing.T) {
RespondWith(resources.Resources[*projects.Project]{
Items: []*projects.Project{fireProject},
})
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand All @@ -653,7 +653,7 @@ func TestPromoteRelease_Errors(t *testing.T) {
RespondWith(resources.Resources[*projects.Project]{
Items: []*projects.Project{fireProject},
})
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=2147483647").
api.ExpectRequest(t, "GET", "/api/"+spaceID+"/environments/v2?name=&skip=0&ids=Development&take=1").
RespondWith(resources.Resources[*environments.Environment]{
Items: []*environments.Environment{},
})
Expand Down
72 changes: 51 additions & 21 deletions pkg/executor/release.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,30 +276,13 @@ func releasePromote(octopus *client.Client, space *spaces.Space, input any) erro
return fmt.Errorf("project not found. %v", err)
}

envs, err := environments.Get(octopus, space.ID, environments.EnvironmentQuery{
IDs: []string{params.FromEnvironment},
Skip: 0,
Take: math.MaxInt32,
})
fromEnv, err := getEnvironment(octopus, space, err, params.FromEnvironment)
if err != nil {
return fmt.Errorf("environment not found. %v", err)
}
//
if len(envs.Items) == 0 {
envs, err = environments.Get(octopus, space.ID, environments.EnvironmentQuery{
Name: params.FromEnvironment,
Skip: 0,
Take: math.MaxInt32,
})
if err != nil || len(envs.Items) == 0 {
return fmt.Errorf("environment not found. %v", err)
}
return err
}
// just grab the first environment
sourceEnv := envs.Items[0]

dashboardQuery := dashboard.DashboardDynamicQuery{
Environments: []string{sourceEnv.ID},
Environments: []string{fromEnv.ID},
Projects: []string{proj.ID},
// If using latest successful, we need previous dashboard items as well
// so that we can ensure we get a previous successful deployment
Expand All @@ -315,7 +298,7 @@ func releasePromote(octopus *client.Client, space *spaces.Space, input any) erro
// this is probably unnecessary, but it mimics the existing logic
var dashboardItems []*dashboard.DashboardItem
for _, item := range dynamicDashboard.Items {
if item.EnvironmentID == sourceEnv.ID && item.ProjectID == proj.ID {
if item.EnvironmentID == fromEnv.ID && item.ProjectID == proj.ID {
dashboardItems = append(dashboardItems, item)
}
}
Expand Down Expand Up @@ -376,3 +359,50 @@ func compareDashboardItemsByRelease(a, b *dashboard.DashboardItem) int {
// we multiply by -1 to order by descending
return versioning.Compare(aVersion, bVersion, (*versioning.OctopusVersion).Compare) * -1
}

func getEnvironment(octopus *client.Client, space *spaces.Space, err error, nameOrID string) (*environments.Environment, error) {
envResponse, err := environments.Get(octopus, space.ID, environments.EnvironmentQuery{
IDs: []string{nameOrID},
Skip: 0,
Take: 1, // we are matching on ID, so there should only be one
})
if err != nil {
return nil, fmt.Errorf("environment not found. %v", err)
}

// double check the ID and return if true
if len(envResponse.Items) == 1 && envResponse.Items[0].ID == nameOrID {

@APErebus APErebus Oct 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

this is case sensitive because ID's should be case-sensitive

return envResponse.Items[0], nil
}

// fallback on checking by name
if len(envResponse.Items) == 0 {
envResponse, err = environments.Get(octopus, space.ID, environments.EnvironmentQuery{
Name: nameOrID,
Skip: 0,
Take: math.MaxInt32,
})
if err != nil {
return nil, fmt.Errorf("environment not found. %v", err)
}
}

// if we have multiple responses, this means that the `Name` filter didn't work
// so we do the filtering ourselves
switch {
case len(envResponse.Items) == 0:
return nil, fmt.Errorf("environment not found")
case len(envResponse.Items) == 1 && strings.EqualFold(envResponse.Items[0].Name, nameOrID):

@APErebus APErebus Oct 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

these checks are case-insensitive to match Octopus Server's case-insensitive DB query

return envResponse.Items[0], nil
case len(envResponse.Items) > 1:
for _, item := range envResponse.Items {
// find an exact match to the partial match responses
if strings.EqualFold(item.Name, nameOrID) {
return item, nil
}
}
}

// final fallback
return nil, fmt.Errorf("environment not found")
}
Loading