Return the Role struct instead of only the name

coder · BrunoQuaresma · May 6, 2022 · May 6, 2022 · May 6, 2022 · May 6, 2022
commit 85d6f69344ae923ace900caddc89de6ef266ea02
diff --git a/coderd/rbac/builtin.go b/coderd/rbac/builtin.go
@@ -156,11 +156,11 @@ func IsOrgRole(roleName string) (string, bool) {
 //
 // This should be a list in a database, but until then we build
 // the list from the builtins.
-func OrganizationRoles(organizationID uuid.UUID) []string {
-	var roles []string
+func OrganizationRoles(organizationID uuid.UUID) []Role {
+	var roles []Role
 	for _, roleF := range builtInRoles {
-		role := roleF(organizationID.String()).Name
-		_, scope, err := roleSplit(role)
+		role := roleF(organizationID.String())
+		_, scope, err := roleSplit(role.Name)
 		if err != nil {
 			// This should never happen
 			continue
@@ -177,8 +177,8 @@ func OrganizationRoles(organizationID uuid.UUID) []string {
 //
 // This should be a list in a database, but until then we build
 // the list from the builtins.
-func SiteRoles() []string {
-	var roles []string
+func SiteRoles() []Role {
+	var roles []Role
 	for _, roleF := range builtInRoles {
 		role := roleF("random")
 		_, scope, err := roleSplit(role.Name)
@@ -187,7 +187,7 @@ func SiteRoles() []string {
 			continue
 		}
 		if scope == "" {
-			roles = append(roles, role.Name)
+			roles = append(roles, role)
 		}
 	}
 	return roles

diff --git a/coderd/rbac/builtin_test.go b/coderd/rbac/builtin_test.go
@@ -65,19 +65,31 @@ func TestIsOrgRole(t *testing.T) {
 func TestListRoles(t *testing.T) {
 	t.Parallel()
 
+	siteRoles := rbac.SiteRoles()
+	siteRoleNames := make([]string, 0, len(siteRoles))
+	for _, role := range siteRoles {
+		siteRoleNames = append(siteRoleNames, role.Name)
+	}
+
 	// If this test is ever failing, just update the list to the roles
 	// expected from the builtin set.
 	require.ElementsMatch(t, []string{
 		"admin",
 		"member",
 		"auditor",
 	},
-		rbac.SiteRoles())
+		siteRoleNames)
 
 	orgID := uuid.New()
+	orgRoles := rbac.OrganizationRoles(orgID)
+	orgRoleNames := make([]string, 0, len(orgRoles))
+	for _, role := range orgRoles {
+		orgRoleNames = append(orgRoleNames, role.Name)
+	}
+
 	require.ElementsMatch(t, []string{
 		fmt.Sprintf("organization-admin:%s", orgID.String()),
 		fmt.Sprintf("organization-member:%s", orgID.String()),
 	},
-		rbac.OrganizationRoles(orgID))
+		orgRoleNames)
 }
diff --git a/coderd/roles.go b/coderd/roles.go
@@ -14,17 +14,15 @@ import (
 func (*api) assignableSiteRoles(rw http.ResponseWriter, _ *http.Request) {
 	// TODO: @emyrk in the future, allow granular subsets of roles to be returned based on the
 	// 	role of the user.
-	roleNames := rbac.SiteRoles()
-	roles := codersdk.RolesFromName(roleNames)
-	httpapi.Write(rw, http.StatusOK, roles)
+	roles := rbac.SiteRoles()
+	httpapi.Write(rw, http.StatusOK, codersdk.ConvertRoles(roles))
 }
 
 // assignableSiteRoles returns all site wide roles that can be assigned.
 func (*api) assignableOrgRoles(rw http.ResponseWriter, r *http.Request) {
 	// TODO: @emyrk in the future, allow granular subsets of roles to be returned based on the
 	// 	role of the user.
 	organization := httpmw.OrganizationParam(r)
-	roleNames := rbac.OrganizationRoles(organization.ID)
-	roles := codersdk.RolesFromName(roleNames)
-	httpapi.Write(rw, http.StatusOK, roles)
+	roles := rbac.OrganizationRoles(organization.ID)
+	httpapi.Write(rw, http.StatusOK, codersdk.ConvertRoles(roles))
 }
diff --git a/coderd/roles_test.go b/coderd/roles_test.go
@@ -84,7 +84,7 @@ func TestListRoles(t *testing.T) {
 			APICall: func() ([]codersdk.Role, error) {
 				return orgAdmin.ListOrganizationRoles(ctx, admin.OrganizationID)
 			},
-			ExpectedRoles: codersdk.RolesFromName(rbac.OrganizationRoles(admin.OrganizationID)),
+			ExpectedRoles: codersdk.ConvertRoles(rbac.OrganizationRoles(admin.OrganizationID)),
 		},
 		{
 			Name: "OrgAdminListOtherOrg",
@@ -99,14 +99,14 @@ func TestListRoles(t *testing.T) {
 			APICall: func() ([]codersdk.Role, error) {
 				return client.ListSiteRoles(ctx)
 			},
-			ExpectedRoles: codersdk.RolesFromName(rbac.SiteRoles()),
+			ExpectedRoles: codersdk.ConvertRoles(rbac.SiteRoles()),
 		},
 		{
 			Name: "AdminListOrg",
 			APICall: func() ([]codersdk.Role, error) {
 				return client.ListOrganizationRoles(ctx, admin.OrganizationID)
 			},
-			ExpectedRoles: codersdk.RolesFromName(rbac.OrganizationRoles(admin.OrganizationID)),
+			ExpectedRoles: codersdk.ConvertRoles(rbac.OrganizationRoles(admin.OrganizationID)),
 		},
 	}
 

diff --git a/codersdk/roles.go b/codersdk/roles.go
@@ -45,17 +45,13 @@ func (c *Client) ListOrganizationRoles(ctx context.Context, org uuid.UUID) ([]Ro
 	return roles, json.NewDecoder(res.Body).Decode(&roles)
 }
 
-func RolesFromName(roleNames []string) []Role {
-	roles := make([]Role, 0, len(roleNames))
-	for _, roleName := range roleNames {
-		role, err := rbac.RoleByName(roleName)
-		if err != nil {
-			continue
-		}
-		roles = append(roles, Role{
-			Name:        role.Name,
+func ConvertRoles(roles []rbac.Role) []Role {
+	converted := make([]Role, 0, len(roles))
+	for _, role := range roles {
+		converted = append(converted, Role{
 			DisplayName: role.DisplayName,
+			Name:        role.Name,
 		})
 	}
-	return roles
+	return converted
 }