feat: activity tracker region check and parallel test improvement (#144)

Author: toddgiguere

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2022-10-20T23:05:05Z",
+  "generated_at": "2022-10-24T12:33:25Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -82,15 +82,15 @@
         "hashed_secret": "892bd503fb45f6fcafb1c7003d88291fc0b20208",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 102,
+        "line_number": 104,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 163,
+        "line_number": 165,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -106,7 +106,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.54.dss",
+  "version": "0.13.1+ibm.52.dss",
   "word_list": {
     "file": null,
     "hash": null

cloudinfo/powersystems.go

@@ -9,7 +9,6 @@ import (
 	ibmpiinstance "github.com/IBM-Cloud/power-go-client/clients/instance"
 	"github.com/IBM-Cloud/power-go-client/ibmpisession"
 	ibmpimodels "github.com/IBM-Cloud/power-go-client/power/models"
-	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/IBM/platform-services-go-sdk/resourcecontrollerv2"
 )
 
@@ -24,48 +23,7 @@ type PowerCloudConnectionDetail struct {
 // This function will loop through ALL resources of type "service_instance" in the account
 // and then filter by looking for "power-iaas" in the CRN.
 func (infoSvc *CloudInfoService) ListPowerWorkspaces() ([]resourcecontrollerv2.ResourceInstance, error) {
-
-	listOptions := infoSvc.resourceControllerService.NewListResourceInstancesOptions()
-	listOptions.SetType("service_instance")
-	listOptions.SetLimit(int64(100))
-
-	// this API is paginated, but there is no pager support in the library at this time.
-	// we are compensating by inspecting the NextURL and Start values supplied by the API
-	// to keep looping through pages
-	maxPages := 100
-	countPages := 0
-	listPowerInstance := []resourcecontrollerv2.ResourceInstance{}
-	moreData := true
-
-	for moreData {
-		listPage, _, err := infoSvc.resourceControllerService.ListResourceInstances(listOptions)
-		if err != nil {
-			return nil, fmt.Errorf("error listing PowerVS instances: %w", err)
-		}
-		countPages += 1
-
-		// search through instances on current page looking for only power-iaas
-		for _, svcInstance := range listPage.Resources {
-			if strings.Contains(*svcInstance.CRN, "power-iaas") {
-				listPowerInstance = append(listPowerInstance, svcInstance)
-			}
-		}
-
-		// get next page of results if necessary
-		// see: https://cloud.ibm.com/apidocs/resource-controller/resource-controller?code=go#list-resource-instances
-		if (countPages < maxPages) && listPage.NextURL != nil && *listPage.NextURL != "" {
-			moreData = true
-			newStart, errNext := core.GetQueryParam(listPage.NextURL, "start")
-			if errNext != nil || newStart == nil {
-				return nil, fmt.Errorf("error in fetching start value from next_url: %w", errNext)
-			}
-			listOptions.SetStart(*newStart)
-		} else {
-			moreData = false
-		}
-	}
-
-	return listPowerInstance, nil
+	return infoSvc.ListResourcesByCrnServiceName("power-iaas")
 }
 
 // ListPowerWorkspaceConnections will return an array of CloudConnection for a given existing connection client

cloudinfo/region.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"sort"
 
+	"github.com/IBM/platform-services-go-sdk/resourcecontrollerv2"
 	"github.com/IBM/vpc-go-sdk/vpcv1"
 	"gopkg.in/yaml.v3"
 )
@@ -15,6 +16,11 @@ const (
 	maxPowerConnectionsPerZone = 2
 )
 
+type GetTestRegionOptions struct {
+	// exclude a region if it contains an Activity Tracker
+	ExcludeActivityTrackerRegions bool
+}
+
 // GetAvailableVpcRegions is a method for receiver CloudInfoService that will query the caller account
 // for all regions that support the VPC resource type and are available in the account.
 // Returns an array of vpcv1.Region and error.
@@ -44,12 +50,34 @@ func (infoSvc *CloudInfoService) GetAvailableVpcRegions() ([]vpcv1.Region, error
 }
 
 // GetLeastVpcTestRegion is a method for receiver CloudInfoService that will determine a region available
+// to the caller account that currently contains the least amount of deployed VPCs, using default options.
+// Returns a string representing an IBM Cloud region name, and error.
+func (infoSvc *CloudInfoService) GetLeastVpcTestRegion() (string, error) {
+	// Set up default
+	options := NewGetTestRegionOptions()
+	return infoSvc.GetLeastVpcTestRegionO(*options)
+}
+
+// GetLeastVpcTestRegionWithoutActivityTracker is a method for receiver CloudInfoService that will determine a
+// region available to the caller account that currently contains the least amount of deployed VPCs and does
+// not currently contain an active Activity Tracker instance (can only have one per region).
+// Returns a string representing an IBM Cloud region name, and error.
+func (infoSvc *CloudInfoService) GetLeastVpcTestRegionWithoutActivityTracker() (string, error) {
+	// get default options
+	options := NewGetTestRegionOptions()
+	// change activity tracker setting
+	options.ExcludeActivityTrackerRegions = true
+
+	return infoSvc.GetLeastVpcTestRegionO(*options)
+}
+
+// GetLeastVpcTestRegionO is a method for receiver CloudInfoService that will determine a region available
 // to the caller account that currently contains the least amount of deployed VPCs.
-// The determination can be influenced by specifying CloudInfoService.regionsData.
+// The determination can be influenced by specifying CloudInfoService.regionsData and supplying appropriate options.
 // If no CloudInfoService.regionsData exists, it will simply loop through all available regions for the caller account
 // and choose a region with lowest VPC count.
 // Returns a string representing an IBM Cloud region name, and error.
-func (infoSvc *CloudInfoService) GetLeastVpcTestRegion() (string, error) {
+func (infoSvc *CloudInfoService) GetLeastVpcTestRegionO(options GetTestRegionOptions) (string, error) {
 
 	var bestregion RegionData
 
@@ -58,7 +86,27 @@ func (infoSvc *CloudInfoService) GetLeastVpcTestRegion() (string, error) {
 		return "", err
 	}
 
-	for i, region := range regions {
+	// if we need to filter out regions by activity tracker existence, prepare a list of those regions
+	// NOTE: we only want to do this once at beginning and then use results below
+	var atInstanceList []resourcecontrollerv2.ResourceInstance
+	var atListErr error
+	if options.ExcludeActivityTrackerRegions {
+		atInstanceList, atListErr = infoSvc.ListResourcesByCrnServiceName("logdnaat")
+		if atListErr != nil {
+			log.Println("WARNING: Error retrieving Activity Tracker instances! Ignoring when selecting.")
+			atInstanceList = []resourcecontrollerv2.ResourceInstance{}
+		}
+	}
+
+	for _, region := range regions {
+		// if option is set, ignore region if there is existing activity tracker
+		if options.ExcludeActivityTrackerRegions {
+			if regionHasActivityTracker(region.Name, atInstanceList) {
+				log.Println("Region", region.Name, "skipped due to Activity Tracker present")
+				continue // ignore and move to next region
+			}
+		}
+
 		setErr := infoSvc.vpcService.SetServiceURL(region.Endpoint)
 		if setErr != nil {
 			log.Println("Failed to set a service url in vpc service")
@@ -78,8 +126,8 @@ func (infoSvc *CloudInfoService) GetLeastVpcTestRegion() (string, error) {
 			bestregion = region
 			log.Println("--- new best region is", bestregion.Name)
 			break
-		} else if i == 0 {
-			bestregion = region // always use first region in list
+		} else if len(bestregion.Name) == 0 {
+			bestregion = region // always use first valid region in list
 			log.Println("--- new best region is", bestregion.Name)
 		} else if region.ResourceCount < bestregion.ResourceCount {
 			bestregion = region // use if lower count
@@ -100,6 +148,25 @@ func (infoSvc *CloudInfoService) GetLeastVpcTestRegion() (string, error) {
 	return bestregion.Name, nil
 }
 
+// regionHasActivityTracker is a helper function to determine if a given region is represented in an array
+// of existing ActivityTracker resource instances.
+// Returns boolean true if region found
+func regionHasActivityTracker(region string, activityTrackerList []resourcecontrollerv2.ResourceInstance) bool {
+
+	// don't bother looping if empty
+	if len(activityTrackerList) == 0 {
+		return false
+	}
+
+	for _, at := range activityTrackerList {
+		if *at.RegionID == region {
+			return true
+		}
+	}
+
+	return false
+}
+
 // GetTestRegionsByPriority is a method for receiver CloudInfoService that will use the service regionsData
 // to determine a priorty order and region eligibility for test resources to be deployed.
 // The returned array will then be used by various methods to determine best region to use for different test scenarios.
@@ -216,22 +283,24 @@ func (infoSvc *CloudInfoService) GetLeastPowerConnectionZone() (string, error) {
 
 	for _, region := range regions {
 
-		connCount := countPowerConnectionsInZone(region.Name, connections)
-		region.ResourceCount = connCount
-		log.Println("Region", region.Name, "Resource count:", region.ResourceCount)
-
-		// region list is sorted by priority, so if resource count is zero then short circuit and return, it is the best region
-		// NOTE: we will also make sure each region is not at total limit of connections, if it is we will move on to next
-		if region.ResourceCount == 0 {
-			bestregion = region
-			log.Println("--- new best region is", bestregion.Name)
-			break
-		} else if region.ResourceCount < maxPowerConnectionsPerZone && len(bestregion.Name) == 0 {
-			bestregion = region // always use first VALID region found in list
-			log.Println("--- new best region is", bestregion.Name)
-		} else if region.ResourceCount < maxPowerConnectionsPerZone && region.ResourceCount < bestregion.ResourceCount {
-			bestregion = region // use if valid AND lower count than previous best
-			log.Println("--- new best region is", bestregion.Name)
+		if region.UseForTest {
+			connCount := countPowerConnectionsInZone(region.Name, connections)
+			region.ResourceCount = connCount
+			log.Println("Region", region.Name, "Resource count:", region.ResourceCount)
+
+			// region list is sorted by priority, so if resource count is zero then short circuit and return, it is the best region
+			// NOTE: we will also make sure each region is not at total limit of connections, if it is we will move on to next
+			if region.ResourceCount == 0 {
+				bestregion = region
+				log.Println("--- new best region is", bestregion.Name)
+				break
+			} else if region.ResourceCount < maxPowerConnectionsPerZone && len(bestregion.Name) == 0 {
+				bestregion = region // always use first VALID region found in list
+				log.Println("--- new best region is", bestregion.Name)
+			} else if region.ResourceCount < maxPowerConnectionsPerZone && region.ResourceCount < bestregion.ResourceCount {
+				bestregion = region // use if valid AND lower count than previous best
+				log.Println("--- new best region is", bestregion.Name)
+			}
 		}
 	}
 
@@ -243,6 +312,28 @@ func (infoSvc *CloudInfoService) GetLeastPowerConnectionZone() (string, error) {
 	return bestregion.Name, nil
 }
 
+// HasRegionData is a method for receiver CloudInfoService that will respond with a boolean to verify that the service instance
+// has region data loaded. You can use this method to determine if you need to load preference data.
+func (infoSvc *CloudInfoService) HasRegionData() bool {
+	if len(infoSvc.regionsData) > 0 {
+		return true
+	} else {
+		return false
+	}
+}
+
+// RemoveRegionForTest is a method for receiver CloudInfoService  that will remove a given region for use in test considerations
+// by setting the UseForTest property for the region to false
+func (infoSvc *CloudInfoService) RemoveRegionForTest(regionID string) {
+	// loop through region data looking for given region
+	for i, regionData := range infoSvc.regionsData {
+		if regionData.Name == regionID {
+			infoSvc.regionsData[i].UseForTest = false
+			break
+		}
+	}
+}
+
 // countPowerConnectionsInZone is a private helper function that will return a count of occurances of
 // the provided zone in a list of existing Powercloud connections.
 func countPowerConnectionsInZone(zone string, connections []*PowerCloudConnectionDetail) int {
@@ -256,3 +347,10 @@ func countPowerConnectionsInZone(zone string, connections []*PowerCloudConnectio
 
 	return count
 }
+
+// NewGetTestRegionOptions will return the option struct with defaults
+func NewGetTestRegionOptions() *GetTestRegionOptions {
+	return &GetTestRegionOptions{
+		ExcludeActivityTrackerRegions: false,
+	}
+}