Method GetSpacedClient

pkg/apiclient/client_factory.go:271–359

(requester Requester)

}

func (c *Client) GetSpacedClient(requester Requester) (*octopusApiClient.Client, error) {
	if c.SpaceScopedClient != nil {
		return c.SpaceScopedClient, nil
	}

	// logic here is a bit fiddly:
	// We could have been given either a space name, or a space ID, so we need to use the SystemClient to go look it up.
	systemClient, err := c.GetSystemClient(requester)
	if err != nil {
		return nil, err
	}

	// if the caller has not specified a space, prompt interactively
	var foundSpaceID string
	// if c.Ask is nil it means we're in automation mode.
	if c.SpaceNameOrID == "" {
		if !c.Ask.IsInteractive() {
			return nil, errors.New("space must be specified when not running interactively; please set the OCTOPUS_SPACE environment variable or specify --space on the command line")
		}

		allSpaces, err := systemClient.Spaces.GetAll()
		if err != nil {
			return nil, err
		}

		switch len(allSpaces) {
		case 0:
			return nil, errors.New("no spaces found")
		case 1:
			selectedSpace := allSpaces[0]
			c.ActiveSpace = selectedSpace
			c.SpaceNameOrID = selectedSpace.ID
			foundSpaceID = selectedSpace.ID
		default:
			selectedSpace, err := question.SelectMap(
				c.Ask.Ask,
				"You have not specified a Space. Please select one:", allSpaces, func(item *spaces.Space) string { return item.GetName() })

			if err != nil {
				return nil, err
			}
			c.ActiveSpace = selectedSpace
			c.SpaceNameOrID = selectedSpace.ID
			foundSpaceID = selectedSpace.ID
		}
	}

	if foundSpaceID == "" {
		// https://github.com/OctopusDeploy/cli/issues/30
		// we prefer to match on Name first, and then fallback to ID; The server doesn't have direct support
		// for that logic so the most pragmatic way to achieve that is to iterate the list of spaces client-side
		allSpaces, err := systemClient.Spaces.GetAll()
		if err != nil {
			return nil, fmt.Errorf("cannot load spaces. Error: %v", err)
		}

		var foundSpace *spaces.Space = nil
		var foundSpaceByID *spaces.Space = nil // second-tier match, only use this if foundSpace is nilt