Merge pull request #468 from cloudfoundry/user-tests

User missing tests from prior PRs and fix a few lint errors

Author: sneal

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v2
         with:
-          go-version: ^1.16
+          go-version: ^1.23
       - name: Run Test
         run: make test
         shell: bash

client/filter.go

@@ -26,8 +26,9 @@ func (r FilterModifier) String() string {
 		return "lt"
 	case FilterModifierLessThanOrEqual:
 		return "lte"
+	default:
+		return ""
 	}
-	return ""
 }
 
 type TimestampFilterList []TimestampFilter
@@ -124,7 +125,7 @@ type ExclusionFilter struct {
 }
 
 func (e *ExclusionFilter) NotEqualTo(v ...string) {
-	e.Filter.Values = v
+	e.Values = v
 	e.Not = true
 }
 

client/polling.go

@@ -6,7 +6,7 @@ import (
 	"time"
 )
 
-var AsyncProcessTimeoutError = errors.New("timed out after waiting for async process")
+var ErrAsyncProcessTimeout = errors.New("timed out after waiting for async process")
 
 type PollingOptions struct {
 	Timeout       time.Duration
@@ -36,7 +36,7 @@ func PollForStateOrTimeout(getState getStateFunc, successState string, opts *Pol
 	for {
 		select {
 		case <-timeout:
-			return AsyncProcessTimeoutError
+			return ErrAsyncProcessTimeout
 		case <-ticker.C:
 			state, cfError, err := getState()
 			if err != nil {

client/polling_test.go

@@ -39,5 +39,5 @@ func TestPollForStateOrTimeout(t *testing.T) {
 	require.NoError(t, err)
 
 	err = PollForStateOrTimeout(timeoutFn, "SUCCESS", noWaitOpts)
-	require.Equal(t, AsyncProcessTimeoutError, err)
+	require.Equal(t, ErrAsyncProcessTimeout, err)
 }

client/user.go

@@ -46,7 +46,7 @@ func (c *UserClient) Create(ctx context.Context, r *resource.UserCreate) (*resou
 	return c.createUserCall(ctx, r)
 }
 
-// Create a new user via Username and Origin
+// CreateWithUsername creates a new user via Username and Origin
 func (c *UserClient) CreateWithUsername(ctx context.Context, r *resource.UserCreateWithUsername) (*resource.User, error) {
 	return c.createUserCall(ctx, r)
 }

client/user_test.go

@@ -26,12 +26,25 @@ func TestUsers(t *testing.T) {
 			},
 			Expected: user,
 			Action: func(c *Client, t *testing.T) (any, error) {
-				r := &resource.UserCreate{
-					GUID: "3ebeaa8b-fd55-4724-a764-9f2231d8f7db",
-				}
+				r := resource.NewUserCreateWithGUID("3ebeaa8b-fd55-4724-a764-9f2231d8f7db")
 				return c.Users.Create(context.Background(), r)
 			},
 		},
+		{
+			Description: "Create UAA shadow user",
+			Route: testutil.MockRoute{
+				Method:   "POST",
+				Endpoint: "/v3/users",
+				Output:   g.Single(user),
+				Status:   http.StatusCreated,
+				PostForm: `{ "username": "sneal", "origin": "ldap" }`,
+			},
+			Expected: user,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				r := resource.NewUserCreateWithUsername("sneal", "ldap")
+				return c.Users.CreateWithUsername(context.Background(), r)
+			},
+		},
 		{
 			Description: "Delete user",
 			Route: testutil.MockRoute{

operation/push.go

@@ -2,6 +2,7 @@ package operation
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -73,10 +74,10 @@ func (p *AppPushOperation) pushWithStrategyApp(ctx context.Context, space *resou
 
 func (p *AppPushOperation) pushBlueGreenApp(ctx context.Context, space *resource.Space, manifest *AppManifest, zipFile io.Reader) (*resource.App, error) {
 	originalApp, err := p.findApp(ctx, manifest.Name, space)
-	if err != nil && err != client.ErrExactlyOneResultNotReturned {
+	if err != nil && !errors.Is(err, client.ErrExactlyOneResultNotReturned) {
 		return nil, err
 	}
-	if err == client.ErrExactlyOneResultNotReturned || originalApp.State != "STARTED" {
+	if errors.Is(err, client.ErrExactlyOneResultNotReturned) || originalApp.State != "STARTED" {
 		return p.pushApp(ctx, space, manifest, zipFile)
 	}
 
@@ -96,7 +97,7 @@ func (p *AppPushOperation) pushBlueGreenApp(ctx context.Context, space *resource
 		Name: tempAppName,
 	})
 	if err != nil {
-		return nil, fmt.Errorf("failed to update app name failed with: %s", err.Error())
+		return nil, fmt.Errorf("failed to update app name failed with: %w", err)
 	}
 
 	// Apply the manifest
@@ -107,23 +108,23 @@ func (p *AppPushOperation) pushBlueGreenApp(ctx context.Context, space *resource
 			Name: originalApp.Name,
 		})
 		if err != nil {
-			return nil, fmt.Errorf("failed to update app name back to original name: failed with %s", err.Error())
+			return nil, fmt.Errorf("failed to update app name back to original name: failed with %w", err)
 		}
-		return nil, fmt.Errorf("blue green deployment failed with: %s", err.Error())
+		return nil, fmt.Errorf("blue green deployment failed with: %w", err)
 	}
 	if newApp.State == "STARTED" {
 		err = p.gracefulDeletion(ctx, originalApp)
 		return newApp, err
 	}
-	return newApp, fmt.Errorf("failed to verify application start: %s", err.Error())
+	return newApp, fmt.Errorf("failed to verify application start: %w", err)
 }
 
 func (p *AppPushOperation) pushRollingApp(ctx context.Context, space *resource.Space, manifest *AppManifest, zipFile io.Reader) (*resource.App, error) {
 	originalApp, err := p.findApp(ctx, manifest.Name, space)
-	if err != nil && err != client.ErrExactlyOneResultNotReturned {
+	if err != nil && !errors.Is(err, client.ErrExactlyOneResultNotReturned) {
 		return nil, err
 	}
-	if err == client.ErrExactlyOneResultNotReturned || originalApp.State != "STARTED" {
+	if errors.Is(err, client.ErrExactlyOneResultNotReturned) || originalApp.State != "STARTED" {
 		return p.pushApp(ctx, space, manifest, zipFile)
 	}
 	// Get the fallback revision in case of rollback
@@ -151,7 +152,7 @@ func (p *AppPushOperation) pushRollingApp(ctx context.Context, space *resource.S
 
 	deployment, err := p.createNewDeployment(ctx, originalApp, droplet)
 	if err != nil {
-		return nil, fmt.Errorf("failed to deploy with: %s", err.Error())
+		return nil, fmt.Errorf("failed to deploy with: %w", err)
 	}
 	// In case application crashed due to new deployment, deployment will be stuck with value "ACTIVE" and reason "DEPLOYING"
 	// This will be considered as deployment failed after timeout
@@ -160,18 +161,18 @@ func (p *AppPushOperation) pushRollingApp(ctx context.Context, space *resource.S
 	// Check the app state if app not started or deployment failed rollback the deployment
 	originalApp, err = p.findApp(ctx, manifest.Name, space)
 	if err != nil {
-		return nil, fmt.Errorf("failed to verify application status with: %s", err.Error())
+		return nil, fmt.Errorf("failed to verify application status with: %w", err)
 	}
 	if originalApp.State != "STARTED" || depPollErr != nil {
 		rollBackDeployment, rollBackErr := p.rollBackDeployment(ctx, originalApp, fallbackRevision)
 		if rollBackErr != nil {
-			return nil, fmt.Errorf("failed to confirm rollback deployment with: %s", rollBackErr.Error())
+			return nil, fmt.Errorf("failed to confirm rollback deployment with: %w", rollBackErr)
 		}
 		depRollPollErr := p.waitForDeployment(ctx, rollBackDeployment.GUID, *manifest.Instances)
 		if depRollPollErr != nil {
-			return nil, fmt.Errorf("failed to deploy with: %s \nfailed to confirm roll back to last deployment with: %s", depPollErr.Error(), depRollPollErr.Error())
+			return nil, fmt.Errorf("failed to deploy with: %w \nfailed to confirm roll back to last deployment with: %w", depPollErr, depRollPollErr)
 		}
-		return nil, fmt.Errorf("failed to deploy with: %s \nrolled back to last deployment", depPollErr.Error())
+		return nil, fmt.Errorf("failed to deploy with: %w \nrolled back to last deployment", depPollErr)
 	}
 
 	return originalApp, nil
@@ -232,7 +233,7 @@ func (p *AppPushOperation) rollBackDeployment(ctx context.Context, originalApp *
 func (p *AppPushOperation) gracefulDeletion(ctx context.Context, app *resource.App) error {
 	app, err := p.client.Applications.Stop(ctx, app.GUID)
 	if err != nil {
-		return fmt.Errorf("failed to stop the application with: %s", err.Error())
+		return fmt.Errorf("failed to stop the application with: %w", err)
 	}
 	jobId, err := p.client.Applications.Delete(ctx, app.GUID)
 	if err != nil {

resource/package.go

@@ -131,22 +131,24 @@ func (d *Package) UnmarshalJSON(data []byte) error {
 	}
 
 	// post-processing based on type
-	if d.Type == "bits" {
+	switch d.Type {
+	case "bits":
 		var p BitsPackage
 		err = json.Unmarshal(d.DataRaw, &p)
 		if err != nil {
 			return err
 		}
 		d.Data.Bits = &p
 		return nil
-	} else if d.Type == "docker" {
+	case "docker":
 		var p DockerPackage
 		err = json.Unmarshal(d.DataRaw, &p)
 		if err != nil {
 			return err
 		}
 		d.Data.Docker = &p
 		return nil
+	default:
+		return fmt.Errorf("could not unmarshal data as bits or docker package: %w", err)
 	}
-	return fmt.Errorf("could not unmarshal data as bits or docker package: %w", err)
 }

testutil/template/org_usage_summary.json

@@ -1,7 +1,13 @@
 {
   "usage_summary": {
     "started_instances": 3,
-    "memory_in_mb": 50
+    "memory_in_mb": 50,
+    "routes": 4,
+    "service_instances": 2,
+    "reserved_ports": 1,
+    "domains": 4,
+    "per_app_tasks": 2,
+    "service_keys": 1
   },
   "links": {
     "self": {