Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions pkg/releases/release_service.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ func NewReleaseService(sling *sling.Sling, uriTemplate string) *ReleaseService {
}

// Add creates a new release.
//
// Deprecated: Use releases.Add
func (s *ReleaseService) Add(release *Release) (*Release, error) {
if IsNil(release) {
return nil, internal.CreateInvalidParameterError(constants.OperationAdd, constants.ParameterRelease)
Expand All @@ -47,6 +49,8 @@ func (s *ReleaseService) Add(release *Release) (*Release, error) {
// Get returns a collection of releases based on the criteria defined by its
// input query parameter. If an error occurs, an empty collection is returned
// along with the associated error.
//
// Deprecated: Use releases.Get
func (s *ReleaseService) Get(releasesQuery ...ReleasesQuery) (*resources.Resources[*Release], error) {
v, _ := query.Values(releasesQuery[0])
path := s.BasePath
Expand All @@ -65,6 +69,8 @@ func (s *ReleaseService) Get(releasesQuery ...ReleasesQuery) (*resources.Resourc

// GetByID returns the release that matches the input ID. If one cannot be
// found, it returns nil and an error.
//
// Deprecated: Use releases.GetByID
func (s *ReleaseService) GetByID(id string) (*Release, error) {
if internal.IsEmpty(id) {
return nil, internal.CreateInvalidParameterError(constants.OperationGetByID, constants.ParameterID)
Expand All @@ -83,6 +89,7 @@ func (s *ReleaseService) GetByID(id string) (*Release, error) {
return resp.(*Release), nil
}

// Deprecated
func (s *ReleaseService) GetReleases(channel *channels.Channel, releaseQuery ...*ReleaseQuery) (*resources.Resources[*Release], error) {
if channel == nil {
return nil, internal.CreateInvalidParameterError("GetReleases", "channel")
Expand Down Expand Up @@ -116,6 +123,25 @@ func (s *ReleaseService) GetReleases(channel *channels.Channel, releaseQuery ...

// ----- Experimental ---------------------------------------------------------

const template = "/api/{spaceId}/releases{/id}{?skip,ignoreChannelRules,take,ids}"

// Add creates a new release.
func Add(client newclient.Client, release *Release) (*Release, error) {
return newclient.Add[Release](client, template, release.SpaceID, release)
}

// Get returns a collection of releases based on the criteria defined by its
// input query parameter.
func Get(client newclient.Client, spaceID string, releasesQuery ReleasesQuery) (*resources.Resources[*Release], error) {
return newclient.GetByQuery[Release](client, template, spaceID, releasesQuery)
}

// GetByID returns the release that matches the input ID. If one cannot be
// found, it returns nil and an error.
func GetByID(client newclient.Client, spaceID string, ID string) (*Release, error) {
return newclient.GetByID[Release](client, template, spaceID, ID)
}

// GetReleasesInProjectChannel is EXPERIMENTAL
func GetReleasesInProjectChannel(client newclient.Client, spaceID string, projectID string, channelID string) ([]*Release, error) {
if client == nil {
Expand Down
120 changes: 120 additions & 0 deletions test/e2e/release_service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,123 @@ func TestReleaseServiceGetByID(t *testing.T) {
AssertEqualReleases(t, release, releaseToCompare)
}
}

// --- new ---

func CreateTestRelease_New(t *testing.T, client *client.Client, channel *channels.Channel, project *projects.Project) *releases.Release {
if client == nil {
client = getOctopusClient()
}
require.NotNil(t, client)

version := "0.0.1"

release := releases.NewRelease(channel.GetID(), project.GetID(), version)

require.NotNil(t, release)
require.NoError(t, release.Validate())

createdRelease, err := releases.Add(client, release)
require.NoError(t, err)
require.NotNil(t, createdRelease)
require.NotEmpty(t, createdRelease.GetID())

// verify the add operation was successful
releaseToCompare, err := releases.GetByID(client, client.GetSpaceID(), createdRelease.GetID())
require.NoError(t, err)
require.NotNil(t, releaseToCompare)
AssertEqualReleases(t, createdRelease, releaseToCompare)

return createdRelease
}

func DeleteTestRelease_New(t *testing.T, client *client.Client, release *releases.Release) {
require.NotNil(t, release)

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

err := client.Releases.DeleteByID(release.GetID())
assert.NoError(t, err)

// verify the delete operation was successful
deletedRelease, err := releases.GetByID(client, client.GetSpaceID(), release.GetID())
assert.Error(t, err)
assert.Nil(t, deletedRelease)
}

func TestReleaseServiceAddGetDelete_New(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)

channel := CreateTestChannel(t, client, project)
require.NotNil(t, channel)
defer DeleteTestChannel(t, client, channel)

release := CreateTestRelease(t, client, channel, project)
require.NotNil(t, release)
defer DeleteTestRelease(t, client, release)

releaseToCompare, err := releases.GetByID(client, client.GetSpaceID(), release.GetID())
require.NoError(t, err)
require.NotNil(t, releaseToCompare)
AssertEqualReleases(t, release, releaseToCompare)
}

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

query := releases.ReleasesQuery{
Take: 50,
}

releases, err := releases.Get(client, client.GetSpaceID(), query)
require.NoError(t, err)
require.NotNil(t, releases)

for _, release := range releases.Items {
defer DeleteTestRelease(t, client, release)
}
}

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

id := internal.GetRandomName()
release, err := releases.GetByID(client, client.GetSpaceID(), id)
require.Error(t, err)
assert.Nil(t, release)

query := releases.ReleasesQuery{
Take: 50,
}

releaseResource, err := releases.Get(client, client.GetSpaceID(), query)
assert.NoError(t, err)
assert.NotNil(t, releaseResource)

for _, release := range releaseResource.Items {
releaseToCompare, err := releases.GetByID(client, client.GetSpaceID(), release.GetID())
assert.NoError(t, err)
AssertEqualReleases(t, release, releaseToCompare)
}
}