github.com/loafoe/cli@v7.1.0+incompatible/command/v7/actor.go (about) 1 package v7 2 3 import ( 4 "context" 5 "io" 6 "time" 7 8 "code.cloudfoundry.org/cli/actor/sharedaction" 9 "code.cloudfoundry.org/cli/actor/v7action" 10 "code.cloudfoundry.org/cli/api/cloudcontroller/ccv3" 11 "code.cloudfoundry.org/cli/api/cloudcontroller/ccv3/constant" 12 uaa "code.cloudfoundry.org/cli/api/uaa/constant" 13 "code.cloudfoundry.org/cli/cf/configuration/coreconfig" 14 "code.cloudfoundry.org/cli/resources" 15 "code.cloudfoundry.org/cli/types" 16 "github.com/SermoDigital/jose/jwt" 17 ) 18 19 //go:generate counterfeiter . Actor 20 21 type Actor interface { 22 ApplyOrganizationQuotaByName(quotaName string, orgGUID string) (v7action.Warnings, error) 23 ApplySpaceQuotaByName(quotaName string, spaceGUID string, orgGUID string) (v7action.Warnings, error) 24 AssignIsolationSegmentToSpaceByNameAndSpace(isolationSegmentName string, spaceGUID string) (v7action.Warnings, error) 25 Authenticate(credentials map[string]string, origin string, grantType uaa.GrantType) error 26 BindSecurityGroupToSpaces(securityGroupGUID string, spaces []resources.Space, lifecycle constant.SecurityGroupLifecycle) (v7action.Warnings, error) 27 CancelDeployment(deploymentGUID string) (v7action.Warnings, error) 28 CheckRoute(domainName string, hostname string, path string, port int) (bool, v7action.Warnings, error) 29 ClearTarget() 30 CloudControllerAPIVersion() string 31 CopyPackage(sourceApp resources.Application, targetApp resources.Application) (v7action.Package, v7action.Warnings, error) 32 CreateAndUploadBitsPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (v7action.Package, v7action.Warnings, error) 33 CreateApplicationDroplet(appGUID string) (resources.Droplet, v7action.Warnings, error) 34 CreateApplicationInSpace(app resources.Application, spaceGUID string) (resources.Application, v7action.Warnings, error) 35 CreateBitsPackageByApplication(appGUID string) (v7action.Package, v7action.Warnings, error) 36 CreateBuildpack(buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error) 37 CreateDeploymentByApplicationAndDroplet(appGUID string, dropletGUID string) (string, v7action.Warnings, error) 38 CreateDeploymentByApplicationAndRevision(appGUID string, revisionGUID string) (string, v7action.Warnings, error) 39 CreateDockerPackageByApplication(appGUID string, dockerImageCredentials v7action.DockerImageCredentials) (v7action.Package, v7action.Warnings, error) 40 CreateDockerPackageByApplicationNameAndSpace(appName string, spaceGUID string, dockerImageCredentials v7action.DockerImageCredentials) (v7action.Package, v7action.Warnings, error) 41 CreateIsolationSegmentByName(isolationSegment v7action.IsolationSegment) (v7action.Warnings, error) 42 CreateOrgRole(roleType constant.RoleType, orgGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error) 43 CreateOrganization(orgName string) (resources.Organization, v7action.Warnings, error) 44 CreateOrganizationQuota(name string, limits v7action.QuotaLimits) (v7action.Warnings, error) 45 CreatePrivateDomain(domainName string, orgName string) (v7action.Warnings, error) 46 CreateRoute(spaceGUID, domainName, hostname, path string, port int) (resources.Route, v7action.Warnings, error) 47 CreateSecurityGroup(name, filePath string) (v7action.Warnings, error) 48 CreateServiceBroker(model resources.ServiceBroker) (v7action.Warnings, error) 49 CreateSharedDomain(domainName string, internal bool, routerGroupName string) (v7action.Warnings, error) 50 CreateSpace(spaceName, orgGUID string) (resources.Space, v7action.Warnings, error) 51 CreateSpaceQuota(spaceQuotaName string, orgGuid string, limits v7action.QuotaLimits) (v7action.Warnings, error) 52 CreateSpaceRole(roleType constant.RoleType, orgGUID string, spaceGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error) 53 CreateUser(username string, password string, origin string) (resources.User, v7action.Warnings, error) 54 DeleteApplicationByNameAndSpace(name, spaceGUID string, deleteRoutes bool) (v7action.Warnings, error) 55 DeleteBuildpackByNameAndStack(buildpackName string, buildpackStack string) (v7action.Warnings, error) 56 DeleteDomain(domain resources.Domain) (v7action.Warnings, error) 57 DeleteInstanceByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, instanceIndex int) (v7action.Warnings, error) 58 DeleteOrgRole(roleType constant.RoleType, orgGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error) 59 DeleteOrganization(orgName string) (v7action.Warnings, error) 60 DeleteOrganizationQuota(quotaName string) (v7action.Warnings, error) 61 DeleteOrphanedRoutes(spaceGUID string) (v7action.Warnings, error) 62 DeleteRoute(domainName, hostname, path string, port int) (v7action.Warnings, error) 63 DeleteSecurityGroup(securityGroupName string) (v7action.Warnings, error) 64 DeleteServiceBroker(serviceBrokerGUID string) (v7action.Warnings, error) 65 DeleteSpaceByNameAndOrganizationName(spaceName string, orgName string) (v7action.Warnings, error) 66 DeleteSpaceQuotaByName(quotaName string, orgGUID string) (v7action.Warnings, error) 67 DeleteSpaceRole(roleType constant.RoleType, spaceGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error) 68 DeleteUser(userGuid string) (v7action.Warnings, error) 69 DeleteIsolationSegmentByName(name string) (v7action.Warnings, error) 70 DeleteIsolationSegmentOrganizationByName(isolationSegmentName string, orgName string) (v7action.Warnings, error) 71 DisableFeatureFlag(flagName string) (v7action.Warnings, error) 72 DisableServiceAccess(offeringName, brokerName, orgName, planName string) (v7action.SkippedPlans, v7action.Warnings, error) 73 DownloadCurrentDropletByAppName(appName string, spaceGUID string) ([]byte, string, v7action.Warnings, error) 74 DownloadDropletByGUIDAndAppName(dropletGUID string, appName string, spaceGUID string) ([]byte, v7action.Warnings, error) 75 EnableFeatureFlag(flagName string) (v7action.Warnings, error) 76 EnableServiceAccess(offeringName, brokerName, orgName, planName string) (v7action.SkippedPlans, v7action.Warnings, error) 77 EntitleIsolationSegmentToOrganizationByName(isolationSegmentName string, orgName string) (v7action.Warnings, error) 78 GetAppFeature(appGUID string, featureName string) (resources.ApplicationFeature, v7action.Warnings, error) 79 GetAppSummariesForSpace(spaceGUID string, labels string) ([]v7action.ApplicationSummary, v7action.Warnings, error) 80 GetApplicationByNameAndSpace(appName string, spaceGUID string) (resources.Application, v7action.Warnings, error) 81 GetApplicationDroplets(appName string, spaceGUID string) ([]resources.Droplet, v7action.Warnings, error) 82 GetApplicationLabels(appName string, spaceGUID string) (map[string]types.NullString, v7action.Warnings, error) 83 GetApplicationPackages(appName string, spaceGUID string) ([]v7action.Package, v7action.Warnings, error) 84 GetApplicationProcessHealthChecksByNameAndSpace(appName string, spaceGUID string) ([]v7action.ProcessHealthCheck, v7action.Warnings, error) 85 GetApplicationRoutes(appGUID string) ([]resources.Route, v7action.Warnings, error) 86 GetApplicationTasks(appName string, sortOrder v7action.SortOrder) ([]v7action.Task, v7action.Warnings, error) 87 GetApplicationsByNamesAndSpace(appNames []string, spaceGUID string) ([]resources.Application, v7action.Warnings, error) 88 GetBuildpackLabels(buildpackName string, buildpackStack string) (map[string]types.NullString, v7action.Warnings, error) 89 GetBuildpacks(labelSelector string) ([]v7action.Buildpack, v7action.Warnings, error) 90 GetDefaultDomain(orgGUID string) (resources.Domain, v7action.Warnings, error) 91 GetDetailedAppSummary(appName string, spaceGUID string, withObfuscatedValues bool) (v7action.DetailedApplicationSummary, v7action.Warnings, error) 92 GetDomain(domainGUID string) (resources.Domain, v7action.Warnings, error) 93 GetDomainByName(domainName string) (resources.Domain, v7action.Warnings, error) 94 GetDomainLabels(domainName string) (map[string]types.NullString, v7action.Warnings, error) 95 GetEffectiveIsolationSegmentBySpace(spaceGUID string, orgDefaultIsolationSegmentGUID string) (v7action.IsolationSegment, v7action.Warnings, error) 96 GetEnvironmentVariableGroup(group constant.EnvironmentVariableGroupName) (v7action.EnvironmentVariableGroup, v7action.Warnings, error) 97 GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (v7action.EnvironmentVariableGroups, v7action.Warnings, error) 98 GetFeatureFlagByName(featureFlagName string) (v7action.FeatureFlag, v7action.Warnings, error) 99 GetFeatureFlags() ([]v7action.FeatureFlag, v7action.Warnings, error) 100 GetGlobalRunningSecurityGroups() ([]resources.SecurityGroup, v7action.Warnings, error) 101 GetGlobalStagingSecurityGroups() ([]resources.SecurityGroup, v7action.Warnings, error) 102 GetIsolationSegmentsByOrganization(orgName string) ([]v7action.IsolationSegment, v7action.Warnings, error) 103 GetIsolationSegmentByName(isoSegmentName string) (v7action.IsolationSegment, v7action.Warnings, error) 104 GetIsolationSegmentSummaries() ([]v7action.IsolationSegmentSummary, v7action.Warnings, error) 105 GetLatestActiveDeploymentForApp(appGUID string) (v7action.Deployment, v7action.Warnings, error) 106 GetLogCacheEndpoint() (string, v7action.Warnings, error) 107 GetLoginPrompts() map[string]coreconfig.AuthPrompt 108 GetNewestReadyPackageForApplication(app resources.Application) (v7action.Package, v7action.Warnings, error) 109 GetOrgUsersByRoleType(orgGUID string) (map[constant.RoleType][]resources.User, v7action.Warnings, error) 110 GetOrganizationByName(orgName string) (resources.Organization, v7action.Warnings, error) 111 GetOrganizationDomains(string, string) ([]resources.Domain, v7action.Warnings, error) 112 GetOrganizationLabels(orgName string) (map[string]types.NullString, v7action.Warnings, error) 113 GetOrganizationQuotaByName(orgQuotaName string) (resources.OrganizationQuota, v7action.Warnings, error) 114 GetOrganizationQuotas() ([]resources.OrganizationQuota, v7action.Warnings, error) 115 GetOrganizationSpaces(orgGUID string) ([]resources.Space, v7action.Warnings, error) 116 GetOrganizationSpacesWithLabelSelector(orgGUID string, labelSelector string) ([]resources.Space, v7action.Warnings, error) 117 GetOrganizationSummaryByName(orgName string) (v7action.OrganizationSummary, v7action.Warnings, error) 118 GetOrganizations(labelSelector string) ([]resources.Organization, v7action.Warnings, error) 119 GetProcessByTypeAndApplication(processType string, appGUID string) (v7action.Process, v7action.Warnings, error) 120 GetRawApplicationManifestByNameAndSpace(appName string, spaceGUID string) ([]byte, v7action.Warnings, error) 121 GetRecentEventsByApplicationNameAndSpace(appName string, spaceGUID string) ([]v7action.Event, v7action.Warnings, error) 122 GetRecentLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client sharedaction.LogCacheClient) ([]sharedaction.LogMessage, v7action.Warnings, error) 123 GetRevisionByApplicationAndVersion(appGUID string, revisionVersion int) (resources.Revision, v7action.Warnings, error) 124 GetRevisionsByApplicationNameAndSpace(appName string, spaceGUID string) ([]resources.Revision, v7action.Warnings, error) 125 GetRouteByAttributes(domain resources.Domain, hostname string, path string, port int) (resources.Route, v7action.Warnings, error) 126 GetRouteDestinationByAppGUID(route resources.Route, appGUID string) (resources.RouteDestination, error) 127 GetRouteLabels(routeName string, spaceGUID string) (map[string]types.NullString, v7action.Warnings, error) 128 GetRouterGroups() ([]v7action.RouterGroup, error) 129 GetRouteSummaries([]resources.Route) ([]v7action.RouteSummary, v7action.Warnings, error) 130 GetRoutesByOrg(orgGUID string, labels string) ([]resources.Route, v7action.Warnings, error) 131 GetRoutesBySpace(spaceGUID string, labels string) ([]resources.Route, v7action.Warnings, error) 132 GetSSHEnabled(appGUID string) (ccv3.SSHEnabled, v7action.Warnings, error) 133 GetSSHEnabledByAppName(appName string, spaceGUID string) (ccv3.SSHEnabled, v7action.Warnings, error) 134 GetSSHPasscode() (string, error) 135 GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, processIndex uint) (v7action.SSHAuthentication, v7action.Warnings, error) 136 GetSecurityGroup(securityGroupName string) (resources.SecurityGroup, v7action.Warnings, error) 137 GetSecurityGroupSummary(securityGroupName string) (v7action.SecurityGroupSummary, v7action.Warnings, error) 138 GetSecurityGroups() ([]v7action.SecurityGroupSummary, v7action.Warnings, error) 139 GetServiceAccess(offeringName, brokerName, orgName string) ([]v7action.ServicePlanAccess, v7action.Warnings, error) 140 GetServiceBrokerByName(serviceBrokerName string) (resources.ServiceBroker, v7action.Warnings, error) 141 GetServiceBrokerLabels(serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error) 142 GetServiceBrokers() ([]resources.ServiceBroker, v7action.Warnings, error) 143 GetServiceOfferingLabels(serviceOfferingName, serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error) 144 GetServicePlanLabels(servicePlanName, serviceOfferingName, serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error) 145 GetSpaceByNameAndOrganization(spaceName string, orgGUID string) (resources.Space, v7action.Warnings, error) 146 GetSpaceFeature(spaceName string, orgGUID string, feature string) (bool, v7action.Warnings, error) 147 GetSpaceLabels(spaceName string, orgGUID string) (map[string]types.NullString, v7action.Warnings, error) 148 GetSpaceQuotaByName(spaceQuotaName string, orgGUID string) (resources.SpaceQuota, v7action.Warnings, error) 149 GetSpaceQuotasByOrgGUID(orgGUID string) ([]resources.SpaceQuota, v7action.Warnings, error) 150 GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (v7action.SpaceSummary, v7action.Warnings, error) 151 GetSpaceUsersByRoleType(spaceGuid string) (map[constant.RoleType][]resources.User, v7action.Warnings, error) 152 GetStackByName(stackName string) (v7action.Stack, v7action.Warnings, error) 153 GetStackLabels(stackName string) (map[string]types.NullString, v7action.Warnings, error) 154 GetStacks(string) ([]v7action.Stack, v7action.Warnings, error) 155 GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client sharedaction.LogCacheClient) (<-chan sharedaction.LogMessage, <-chan error, context.CancelFunc, v7action.Warnings, error) 156 GetTaskBySequenceIDAndApplication(sequenceID int, appGUID string) (v7action.Task, v7action.Warnings, error) 157 GetUnstagedNewestPackageGUID(appGuid string) (string, v7action.Warnings, error) 158 GetUser(username, origin string) (resources.User, error) 159 MapRoute(routeGUID string, appGUID string) (v7action.Warnings, error) 160 Marketplace(filter v7action.MarketplaceFilter) ([]v7action.ServiceOfferingWithPlans, v7action.Warnings, error) 161 ParseAccessToken(accessToken string) (jwt.JWT, error) 162 PollBuild(buildGUID string, appName string) (resources.Droplet, v7action.Warnings, error) 163 PollPackage(pkg v7action.Package) (v7action.Package, v7action.Warnings, error) 164 PollStart(app resources.Application, noWait bool, handleProcessStats func(string)) (v7action.Warnings, error) 165 PollStartForRolling(app resources.Application, deploymentGUID string, noWait bool, handleProcessStats func(string)) (v7action.Warnings, error) 166 PollUploadBuildpackJob(jobURL ccv3.JobURL) (v7action.Warnings, error) 167 PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader v7action.Downloader) (string, error) 168 PurgeServiceOfferingByNameAndBroker(serviceOfferingName, serviceBrokerName string) (v7action.Warnings, error) 169 RefreshAccessToken() (string, error) 170 RenameApplicationByNameAndSpaceGUID(oldAppName, newAppName, spaceGUID string) (resources.Application, v7action.Warnings, error) 171 RenameOrganization(oldOrgName, newOrgName string) (resources.Organization, v7action.Warnings, error) 172 RenameSpaceByNameAndOrganizationGUID(oldSpaceName, newSpaceName, orgGUID string) (resources.Space, v7action.Warnings, error) 173 ResetOrganizationDefaultIsolationSegment(orgGUID string) (v7action.Warnings, error) 174 ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, v7action.Warnings, error) 175 ResourceMatch(resources []sharedaction.V3Resource) ([]sharedaction.V3Resource, v7action.Warnings, error) 176 RestartApplication(appGUID string, noWait bool) (v7action.Warnings, error) 177 RevokeAccessAndRefreshTokens() error 178 RunTask(appGUID string, task v7action.Task) (v7action.Task, v7action.Warnings, error) 179 ScaleProcessByApplication(appGUID string, process v7action.Process) (v7action.Warnings, error) 180 ScheduleTokenRefresh(func(time.Duration) <-chan time.Time, chan struct{}, chan struct{}) (<-chan error, error) 181 SetApplicationDroplet(appGUID string, dropletGUID string) (v7action.Warnings, error) 182 SetApplicationDropletByApplicationNameAndSpace(appName string, spaceGUID string, dropletGUID string) (v7action.Warnings, error) 183 SetApplicationManifest(appGUID string, rawManifest []byte) (v7action.Warnings, error) 184 SetApplicationProcessHealthCheckTypeByNameAndSpace(appName string, spaceGUID string, healthCheckType constant.HealthCheckType, httpEndpoint string, processType string, invocationTimeout int64) (resources.Application, v7action.Warnings, error) 185 SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair v7action.EnvironmentVariablePair) (v7action.Warnings, error) 186 SetEnvironmentVariableGroup(group constant.EnvironmentVariableGroupName, envVars ccv3.EnvironmentVariables) (v7action.Warnings, error) 187 SetOrganizationDefaultIsolationSegment(orgGUID string, isoSegGUID string) (v7action.Warnings, error) 188 SetSpaceManifest(spaceGUID string, rawManifest []byte) (v7action.Warnings, error) 189 SetTarget(settings v7action.TargetSettings) (v7action.Warnings, error) 190 SharePrivateDomain(domainName string, orgName string) (v7action.Warnings, error) 191 StageApplicationPackage(pkgGUID string) (v7action.Build, v7action.Warnings, error) 192 StagePackage(packageGUID, appName, spaceGUID string) (<-chan resources.Droplet, <-chan v7action.Warnings, <-chan error) 193 StartApplication(appGUID string) (v7action.Warnings, error) 194 StopApplication(appGUID string) (v7action.Warnings, error) 195 TerminateTask(taskGUID string) (v7action.Task, v7action.Warnings, error) 196 UAAAPIVersion() string 197 UnbindSecurityGroup(securityGroupName string, orgGUID string, spaceGUID string, lifecycle constant.SecurityGroupLifecycle) (v7action.Warnings, error) 198 UnmapRoute(routeGUID string, destinationGUID string) (v7action.Warnings, error) 199 UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, EnvironmentVariableName string) (v7action.Warnings, error) 200 UnsetSpaceQuota(spaceQuotaName, spaceName, orgGUID string) (v7action.Warnings, error) 201 UnsharePrivateDomain(domainName string, orgName string) (v7action.Warnings, error) 202 UpdateAppFeature(app resources.Application, enabled bool, featureName string) (v7action.Warnings, error) 203 UpdateApplication(app resources.Application) (resources.Application, v7action.Warnings, error) 204 UpdateApplicationLabelsByApplicationName(string, string, map[string]types.NullString) (v7action.Warnings, error) 205 UpdateBuildpackByNameAndStack(buildpackName string, buildpackStack string, buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error) 206 UpdateBuildpackLabelsByBuildpackNameAndStack(string, string, map[string]types.NullString) (v7action.Warnings, error) 207 UpdateDomainLabelsByDomainName(string, map[string]types.NullString) (v7action.Warnings, error) 208 UpdateOrganizationLabelsByOrganizationName(string, map[string]types.NullString) (v7action.Warnings, error) 209 UpdateOrganizationQuota(quotaName string, newName string, limits v7action.QuotaLimits) (v7action.Warnings, error) 210 UpdateProcessByTypeAndApplication(processType string, appGUID string, updatedProcess v7action.Process) (v7action.Warnings, error) 211 UpdateRouteLabels(string, string, map[string]types.NullString) (v7action.Warnings, error) 212 UpdateSecurityGroup(name, filePath string) (v7action.Warnings, error) 213 UpdateSecurityGroupGloballyEnabled(securityGroupName string, lifecycle constant.SecurityGroupLifecycle, enabled bool) (v7action.Warnings, error) 214 UpdateServiceBroker(serviceBrokerGUID string, model resources.ServiceBroker) (v7action.Warnings, error) 215 UpdateServiceBrokerLabelsByServiceBrokerName(string, map[string]types.NullString) (v7action.Warnings, error) 216 UpdateServiceOfferingLabels(serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error) 217 UpdateServicePlanLabels(servicePlanName string, serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error) 218 UpdateSpaceFeature(spaceName string, orgGUID string, enableds bool, feature string) (v7action.Warnings, error) 219 UpdateSpaceLabelsBySpaceName(string, string, map[string]types.NullString) (v7action.Warnings, error) 220 UpdateSpaceQuota(quotaName, orgGUID, newName string, limits v7action.QuotaLimits) (v7action.Warnings, error) 221 UpdateStackLabelsByStackName(string, map[string]types.NullString) (v7action.Warnings, error) 222 UpdateUserPassword(userGUID string, oldPassword string, newPassword string) error 223 UploadBitsPackage(pkg v7action.Package, matchedResources []sharedaction.V3Resource, newResources io.Reader, newResourcesLength int64) (v7action.Package, v7action.Warnings, error) 224 UploadBuildpack(guid string, pathToBuildpackBits string, progressBar v7action.SimpleProgressBar) (ccv3.JobURL, v7action.Warnings, error) 225 UploadDroplet(dropletGUID string, dropletPath string, progressReader io.Reader, fileSize int64) (v7action.Warnings, error) 226 }