feat: edit org display names and descriptions (#13474)

coderd/organizations_test.go

@@ -20,7 +20,8 @@ func TestMultiOrgFetch(t *testing.T) {
 	makeOrgs := []string{"foo", "bar", "baz"}
 	for _, name := range makeOrgs {
 		_, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: name,
+			Name:        name,
+			DisplayName: name,
 		})
 		require.NoError(t, err)
 	}
@@ -45,7 +46,8 @@ func TestOrganizationsByUser(t *testing.T) {
 
 	// Make an extra org, and it should not be defaulted.
 	notDefault, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-		Name: "another",
+		Name:        "another",
+		DisplayName: "Another",
 	})
 	require.NoError(t, err)
 	require.False(t, notDefault.IsDefault, "only 1 default org allowed")
@@ -73,7 +75,8 @@ func TestOrganizationByUserAndName(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitLong)
 
 		org, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "another",
+			Name:        "another",
+			DisplayName: "Another",
 		})
 		require.NoError(t, err)
 		_, err = other.OrganizationByUserAndName(ctx, codersdk.Me, org.Name)
@@ -106,23 +109,58 @@ func TestPostOrganizationsByUser(t *testing.T) {
 		org, err := client.Organization(ctx, user.OrganizationID)
 		require.NoError(t, err)
 		_, err = client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: org.Name,
+			Name:        org.Name,
+			DisplayName: org.DisplayName,
 		})
 		var apiErr *codersdk.Error
 		require.ErrorAs(t, err, &apiErr)
 		require.Equal(t, http.StatusConflict, apiErr.StatusCode())
 	})
 
+	t.Run("InvalidName", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		_ = coderdtest.CreateFirstUser(t, client)
+		ctx := testutil.Context(t, testutil.WaitLong)
+
+		_, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+			Name:        "A name which is definitely not url safe",
+			DisplayName: "New",
+		})
+		var apiErr *codersdk.Error
+		require.ErrorAs(t, err, &apiErr)
+		require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
+	})
+
 	t.Run("Create", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, nil)
 		_ = coderdtest.CreateFirstUser(t, client)
 		ctx := testutil.Context(t, testutil.WaitLong)
 
-		_, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+			Name:        "new",
+			DisplayName: "New",
+			Description: "A new organization to love and cherish forever.",
+		})
+		require.NoError(t, err)
+		require.Equal(t, "new", o.Name)
+		require.Equal(t, "New", o.DisplayName)
+		require.Equal(t, "A new organization to love and cherish forever.", o.Description)
+	})
+
+	t.Run("CreateWithoutExplicitDisplayName", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		_ = coderdtest.CreateFirstUser(t, client)
+		ctx := testutil.Context(t, testutil.WaitLong)
+
+		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
 			Name: "new",
 		})
 		require.NoError(t, err)
+		require.Equal(t, "new", o.Name)
+		require.Equal(t, "new", o.DisplayName) // should match the given `Name`
 	})
 }
 
@@ -137,7 +175,8 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		originalOrg, err := client.Organization(ctx, user.OrganizationID)
 		require.NoError(t, err)
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "something-unique",
+			Name:        "something-unique",
+			DisplayName: "Something Unique",
 		})
 		require.NoError(t, err)
 
@@ -156,7 +195,8 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "something-unique",
+			Name:        "something-unique",
+			DisplayName: "Something Unique",
 		})
 		require.NoError(t, err)
 
@@ -168,6 +208,26 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
 	})
 
+	t.Run("InvalidName", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		_ = coderdtest.CreateFirstUser(t, client)
+		ctx := testutil.Context(t, testutil.WaitMedium)
+
+		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+			Name:        "something-unique",
+			DisplayName: "Something Unique",
+		})
+		require.NoError(t, err)
+
+		_, err = client.UpdateOrganization(ctx, o.ID.String(), codersdk.UpdateOrganizationRequest{
+			Name: "something unique but not url safe",
+		})
+		var apiErr *codersdk.Error
+		require.ErrorAs(t, err, &apiErr)
+		require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
+	})
+
 	t.Run("UpdateById", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, nil)
@@ -175,7 +235,8 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "new",
+			Name:        "new",
+			DisplayName: "New",
 		})
 		require.NoError(t, err)
 
@@ -193,7 +254,8 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "new",
+			Name:        "new",
+			DisplayName: "New",
 		})
 		require.NoError(t, err)
 
@@ -202,6 +264,49 @@ func TestPatchOrganizationsByUser(t *testing.T) {
 		})
 		require.NoError(t, err)
 		require.Equal(t, "new-new", o.Name)
+		require.Equal(t, "New", o.DisplayName) // didn't change
+	})
+
+	t.Run("UpdateDisplayName", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		_ = coderdtest.CreateFirstUser(t, client)
+		ctx := testutil.Context(t, testutil.WaitMedium)
+
+		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+			Name:        "new",
+			DisplayName: "New",
+		})
+		require.NoError(t, err)
+
+		o, err = client.UpdateOrganization(ctx, o.Name, codersdk.UpdateOrganizationRequest{
+			DisplayName: "The Newest One",
+		})
+		require.NoError(t, err)
+		require.Equal(t, "new", o.Name) // didn't change
+		require.Equal(t, "The Newest One", o.DisplayName)
+	})
+
+	t.Run("UpdateDescription", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		_ = coderdtest.CreateFirstUser(t, client)
+		ctx := testutil.Context(t, testutil.WaitMedium)
+
+		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
+			Name:        "new",
+			DisplayName: "New",
+		})
+		require.NoError(t, err)
+
+		o, err = client.UpdateOrganization(ctx, o.Name, codersdk.UpdateOrganizationRequest{
+			Description: "wow, this organization description is so updated!",
+		})
+
+		require.NoError(t, err)
+		require.Equal(t, "new", o.Name)        // didn't change
+		require.Equal(t, "New", o.DisplayName) // didn't change
+		require.Equal(t, "wow, this organization description is so updated!", o.Description)
 	})
 }
 
@@ -229,7 +334,8 @@ func TestDeleteOrganizationsByUser(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "doomed",
+			Name:        "doomed",
+			DisplayName: "Doomed",
 		})
 		require.NoError(t, err)
 
@@ -244,7 +350,8 @@ func TestDeleteOrganizationsByUser(t *testing.T) {
 		ctx := testutil.Context(t, testutil.WaitMedium)
 
 		o, err := client.CreateOrganization(ctx, codersdk.CreateOrganizationRequest{
-			Name: "doomed",
+			Name:        "doomed",
+			DisplayName: "Doomed",
 		})
 		require.NoError(t, err)