fmt.Errorf to xerrors

coder · Emyrk · May 15, 2024 · May 15, 2024 · May 15, 2024 · May 15, 2024
commit 1eec6e2cb3c21c404283f63a41ee5e6e3a2a66d6
diff --git a/coderd/rbac/object.go b/coderd/rbac/object.go
@@ -36,10 +36,10 @@ type Object struct {
 func (z Object) ValidAction(action policy.Action) error {
 	perms, ok := policy.RBACPermissions[z.Type]
 	if !ok {
-		return fmt.Errorf("invalid type %q", z.Type)
+		return xerrors.Errorf("invalid type %q", z.Type)
 	}
 	if _, ok := perms.Actions[action]; !ok {
-		return fmt.Errorf("invalid action %q for type %q", action, z.Type)
+		return xerrors.Errorf("invalid action %q for type %q", action, z.Type)
 	}
 
 	return nil

diff --git a/coderd/rbac/roles.go b/coderd/rbac/roles.go
@@ -387,13 +387,13 @@ func (perm Permission) Valid() error {
 
 	resource, ok := policy.RBACPermissions[perm.ResourceType]
 	if !ok {
-		return fmt.Errorf("invalid resource type %q", perm.ResourceType)
+		return xerrors.Errorf("invalid resource type %q", perm.ResourceType)
 	}
 
 	if perm.Action != policy.WildcardSymbol {
 		_, ok := resource.Actions[perm.Action]
 		if !ok {
-			return fmt.Errorf("invalid action %q for resource %q", perm.Action, perm.ResourceType)
+			return xerrors.Errorf("invalid action %q for resource %q", perm.Action, perm.ResourceType)
 		}
 	}
 	return nil
@@ -430,21 +430,21 @@ func (role Role) Valid() error {
 	var errs []error
 	for _, perm := range role.Site {
 		if err := perm.Valid(); err != nil {
-			errs = append(errs, fmt.Errorf("site: %w", err))
+			errs = append(errs, xerrors.Errorf("site: %w", err))
 		}
 	}
 
 	for orgID, permissions := range role.Org {
 		for _, perm := range permissions {
 			if err := perm.Valid(); err != nil {
-				errs = append(errs, fmt.Errorf("org=%q: %w", orgID, err))
+				errs = append(errs, xerrors.Errorf("org=%q: %w", orgID, err))
 			}
 		}
 	}
 
 	for _, perm := range role.User {
 		if err := perm.Valid(); err != nil {
-			errs = append(errs, fmt.Errorf("user: %w", err))
+			errs = append(errs, xerrors.Errorf("user: %w", err))
 		}
 	}
 

diff --git a/coderd/rbac/roles_test.go b/coderd/rbac/roles_test.go
@@ -389,7 +389,7 @@ func TestRolePermissions(t *testing.T) {
 		},
 		// Some admin style resources
 		{
-			Name:     "Licences",
+			Name:     "Licenses",
 			Actions:  []policy.Action{policy.ActionCreate, policy.ActionRead, policy.ActionDelete},
 			Resource: rbac.ResourceLicense,
 			AuthorizeMap: map[bool][]authSubject{

diff --git a/enterprise/coderd/roles_test.go b/enterprise/coderd/roles_test.go
@@ -35,7 +35,7 @@ func TestCustomRole(t *testing.T) {
 
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
-		//nolint:gocritic -- owner is required for this
+		//nolint:gocritic // owner is required for this
 		role, err := owner.UpsertCustomSiteRole(ctx, codersdk.Role{
 			Name:        "test-role",
 			DisplayName: "Testing Purposes",

diff --git a/scripts/rbacgen/main.go b/scripts/rbacgen/main.go
@@ -148,7 +148,7 @@ func generateRbacObjects(templateSource string) ([]byte, error) {
 	// Parse the policy.go file for the action enums
 	f, err := parser.ParseFile(token.NewFileSet(), "./coderd/rbac/policy/policy.go", nil, parser.ParseComments)
 	if err != nil {
-		return nil, fmt.Errorf("parsing policy.go: %w", err)
+		return nil, xerrors.Errorf("parsing policy.go: %w", err)
 	}
 	actionMap := fileActions(f)
 	actionList := make([]ActionDetails, 0)
@@ -176,14 +176,14 @@ func generateRbacObjects(templateSource string) ([]byte, error) {
 			x++
 			v, ok := actionMap[string(action)]
 			if !ok {
-				errorList = append(errorList, fmt.Errorf("action value %q does not have a constant a matching enum constant", action))
+				errorList = append(errorList, xerrors.Errorf("action value %q does not have a constant a matching enum constant", action))
 			}
 			return v
 		},
 		"concat": func(strs ...string) string { return strings.Join(strs, "") },
 	}).Parse(templateSource)
 	if err != nil {
-		return nil, fmt.Errorf("parse template: %w", err)
+		return nil, xerrors.Errorf("parse template: %w", err)
 	}
 
 	// Convert to sorted list for autogen consistency.
@@ -203,7 +203,7 @@ func generateRbacObjects(templateSource string) ([]byte, error) {
 
 	err = tpl.Execute(&out, list)
 	if err != nil {
-		return nil, fmt.Errorf("execute template: %w", err)
+		return nil, xerrors.Errorf("execute template: %w", err)
 	}
 
 	if len(errorList) > 0 {