Move SpaceSummary into v7action package

A small refactor to enforce a clearer separation between the `resources`
package and the `v7action` package. Per our new architecture goals,
structs defined in `resources` are 1:1 with API resources. Any structs
that include additional information (summary-like structs) should be
defined and populated in the actor layer (`v7action` package).

Will write down these architecture goals in a future ADR.

[#171119141]

Authored-by: Reid Mitchell <[email protected]>

Author: reidmit

actor/v7action/space.go

@@ -11,6 +11,18 @@ import (
 	"code.cloudfoundry.org/cli/resources"
 )
 
+type SpaceSummary struct {
+	Space                 resources.Space
+	Name                  string
+	OrgName               string
+	AppNames              []string
+	ServiceInstanceNames  []string
+	IsolationSegmentName  string
+	QuotaName             string
+	RunningSecurityGroups []resources.SecurityGroup
+	StagingSecurityGroups []resources.SecurityGroup
+}
+
 func (actor Actor) CreateSpace(spaceName, orgGUID string) (resources.Space, Warnings, error) {
 	allWarnings := Warnings{}
 
@@ -82,25 +94,25 @@ func (actor Actor) GetSpaceByNameAndOrganization(spaceName string, orgGUID strin
 	return resources.Space(ccv3Spaces[0]), Warnings(warnings), nil
 }
 
-func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (resources.SpaceSummary, Warnings, error) {
+func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (SpaceSummary, Warnings, error) {
 	var allWarnings Warnings
 
 	org, warnings, err := actor.GetOrganizationByGUID(orgGUID)
 	allWarnings = append(allWarnings, warnings...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	space, warnings, err := actor.GetSpaceByNameAndOrganization(spaceName, org.GUID)
 	allWarnings = append(allWarnings, warnings...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	apps, warnings, err := actor.GetApplicationsBySpace(space.GUID)
 	allWarnings = append(allWarnings, warnings...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	appNames := make([]string, len(apps))
@@ -116,7 +128,7 @@ func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUI
 		})
 	allWarnings = append(allWarnings, Warnings(ccv3Warnings)...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	serviceInstanceNames := make([]string, len(serviceInstances))
@@ -128,7 +140,7 @@ func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUI
 	isoSegRelationship, ccv3Warnings, err := actor.CloudControllerClient.GetSpaceIsolationSegment(space.GUID)
 	allWarnings = append(allWarnings, Warnings(ccv3Warnings)...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	isoSegName := ""
@@ -139,7 +151,7 @@ func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUI
 		defaultIsoSeg, ccv3Warnings, err := actor.CloudControllerClient.GetOrganizationDefaultIsolationSegment(org.GUID)
 		allWarnings = append(allWarnings, Warnings(ccv3Warnings)...)
 		if err != nil {
-			return resources.SpaceSummary{}, allWarnings, err
+			return SpaceSummary{}, allWarnings, err
 		}
 		isoSegGUID = defaultIsoSeg.GUID
 		if isoSegGUID != "" {
@@ -151,7 +163,7 @@ func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUI
 		isoSeg, ccv3warnings, err := actor.CloudControllerClient.GetIsolationSegment(isoSegGUID)
 		allWarnings = append(allWarnings, Warnings(ccv3warnings)...)
 		if err != nil {
-			return resources.SpaceSummary{}, allWarnings, err
+			return SpaceSummary{}, allWarnings, err
 		}
 		if isDefaultIsoSeg {
 			isoSegName = fmt.Sprintf("%s (org default)", isoSeg.Name)
@@ -168,23 +180,23 @@ func (actor Actor) GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUI
 		allWarnings = append(allWarnings, Warnings(ccv3Warnings)...)
 
 		if err != nil {
-			return resources.SpaceSummary{}, allWarnings, err
+			return SpaceSummary{}, allWarnings, err
 		}
 	}
 
 	runningSecurityGroups, ccv3Warnings, err := actor.CloudControllerClient.GetRunningSecurityGroups(space.GUID)
 	allWarnings = append(allWarnings, ccv3Warnings...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
 	stagingSecurityGroups, ccv3Warnings, err := actor.CloudControllerClient.GetStagingSecurityGroups(space.GUID)
 	allWarnings = append(allWarnings, ccv3Warnings...)
 	if err != nil {
-		return resources.SpaceSummary{}, allWarnings, err
+		return SpaceSummary{}, allWarnings, err
 	}
 
-	spaceSummary := resources.SpaceSummary{
+	spaceSummary := SpaceSummary{
 		OrgName:               org.Name,
 		Name:                  space.Name,
 		Space:                 space,

command/v7/actor.go

@@ -146,7 +146,7 @@ type Actor interface {
 	GetSpaceLabels(spaceName string, orgGUID string) (map[string]types.NullString, v7action.Warnings, error)
 	GetSpaceQuotaByName(spaceQuotaName string, orgGUID string) (resources.SpaceQuota, v7action.Warnings, error)
 	GetSpaceQuotasByOrgGUID(orgGUID string) ([]resources.SpaceQuota, v7action.Warnings, error)
-	GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (resources.SpaceSummary, v7action.Warnings, error)
+	GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (v7action.SpaceSummary, v7action.Warnings, error)
 	GetSpaceUsersByRoleType(spaceGuid string) (map[constant.RoleType][]resources.User, v7action.Warnings, error)
 	GetStackByName(stackName string) (v7action.Stack, v7action.Warnings, error)
 	GetStackLabels(stackName string) (map[string]types.NullString, v7action.Warnings, error)

command/v7/space_command.go

@@ -4,6 +4,7 @@ import (
 	"sort"
 	"strings"
 
+	"code.cloudfoundry.org/cli/actor/v7action"
 	"code.cloudfoundry.org/cli/command/flag"
 	"code.cloudfoundry.org/cli/resources"
 	"code.cloudfoundry.org/cli/util/ui"
@@ -90,7 +91,7 @@ func formatSecurityGroupNames(groups []resources.SecurityGroup) string {
 	return strings.Join(names, ", ")
 }
 
-func (cmd SpaceCommand) displaySecurityGroupRulesTable(spaceSummary resources.SpaceSummary) {
+func (cmd SpaceCommand) displaySecurityGroupRulesTable(spaceSummary v7action.SpaceSummary) {
 	tableHeaders := []string{"security group", "destination", "ports", "protocol", "lifecycle", "description"}
 	table := [][]string{tableHeaders}
 
@@ -113,7 +114,7 @@ func (cmd SpaceCommand) displaySecurityGroupRulesTable(spaceSummary resources.Sp
 	cmd.UI.DisplayTableWithHeader("", table, ui.DefaultTableSpacePadding)
 }
 
-func collectSecurityGroupRuleRows(spaceSummary resources.SpaceSummary) [][]string {
+func collectSecurityGroupRuleRows(spaceSummary v7action.SpaceSummary) [][]string {
 	var rows [][]string
 
 	for _, securityGroup := range spaceSummary.RunningSecurityGroups {

command/v7/space_command_test.go

@@ -167,7 +167,7 @@ var _ = Describe("space command", func() {
 				cmd.SecurityGroupRules = true
 
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{
+					v7action.SpaceSummary{
 						Name:                  "some-space",
 						OrgName:               "some-org",
 						AppNames:              []string{"app1", "app2", "app3"},
@@ -212,7 +212,7 @@ var _ = Describe("space command", func() {
 			When("there are no security groups to show", func() {
 				BeforeEach(func() {
 					fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-						resources.SpaceSummary{},
+						v7action.SpaceSummary{},
 						v7action.Warnings{"some-warning"},
 						nil,
 					)
@@ -229,7 +229,7 @@ var _ = Describe("space command", func() {
 		When("fetching the space summary succeeds with an isolation segment", func() {
 			BeforeEach(func() {
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{
+					v7action.SpaceSummary{
 						Name:                  "some-space",
 						OrgName:               "some-org",
 						AppNames:              []string{"app1", "app2", "app3"},
@@ -265,7 +265,7 @@ var _ = Describe("space command", func() {
 		When("fetching the space summary succeeds without an isolation segment", func() {
 			BeforeEach(func() {
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{
+					v7action.SpaceSummary{
 						Name:                  "some-space",
 						OrgName:               "some-org",
 						AppNames:              []string{"app1", "app2", "app3"},
@@ -300,7 +300,7 @@ var _ = Describe("space command", func() {
 		When("fetching a space with an applied quota", func() {
 			BeforeEach(func() {
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{
+					v7action.SpaceSummary{
 						Name:                 "some-space",
 						OrgName:              "some-org",
 						AppNames:             []string{"app1", "app2", "app3"},
@@ -321,7 +321,7 @@ var _ = Describe("space command", func() {
 		When("fetching a space that has no quota applied", func() {
 			BeforeEach(func() {
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{
+					v7action.SpaceSummary{
 						Name:                 "some-space",
 						OrgName:              "some-org",
 						AppNames:             []string{"app1", "app2", "app3"},
@@ -340,7 +340,7 @@ var _ = Describe("space command", func() {
 		When("fetching the space summary fails", func() {
 			BeforeEach(func() {
 				fakeActor.GetSpaceSummaryByNameAndOrganizationReturns(
-					resources.SpaceSummary{},
+					v7action.SpaceSummary{},
 					v7action.Warnings{"some-warning"},
 					errors.New("get-summary-error"),
 				)

command/v7/v7fakes/fake_actor.go

@@ -11,15 +11,3 @@ type Space struct {
 	// Metadata is used for custom tagging of API resources
 	Metadata *Metadata `json:"metadata,omitempty"`
 }
-
-type SpaceSummary struct {
-	Space                 Space
-	Name                  string
-	OrgName               string
-	AppNames              []string
-	ServiceInstanceNames  []string
-	IsolationSegmentName  string
-	QuotaName             string
-	RunningSecurityGroups []SecurityGroup
-	StagingSecurityGroups []SecurityGroup
-}