2025-09-04 17:37:16 -04:00
package cli_test
import (
"bytes"
"fmt"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/cli/clitest"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbfake"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
func TestSharingShare ( t * testing . T ) {
t . Parallel ()
t . Run ( "ShareWithUsers_Simple" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
2025-09-04 17:37:16 -04:00
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toShareWithUser = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
)
ctx := testutil . Context ( t , testutil . WaitMedium )
2025-09-11 16:22:25 -04:00
inv , root := clitest . New ( t , "sharing" , "add" , workspace . Name , "--user" , toShareWithUser . Username )
2025-09-04 17:37:16 -04:00
clitest . SetupConfig ( t , workspaceOwnerClient , root )
2025-09-11 16:22:25 -04:00
out := new ( bytes . Buffer )
2025-09-04 17:37:16 -04:00
inv . Stdout = out
err := inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
acl , err := workspaceOwnerClient . WorkspaceACL ( inv . Context (), workspace . ID )
require . NoError ( t , err )
assert . Contains ( t , acl . Users , codersdk . WorkspaceUser {
MinimalUser : codersdk . MinimalUser {
ID : toShareWithUser . ID ,
Username : toShareWithUser . Username ,
2025-10-22 16:18:31 +11:00
Name : toShareWithUser . Name ,
2025-09-04 17:37:16 -04:00
AvatarURL : toShareWithUser . AvatarURL ,
},
Role : codersdk . WorkspaceRole ( "use" ),
})
assert . Contains ( t , out . String (), toShareWithUser . Username )
assert . Contains ( t , out . String (), codersdk . WorkspaceRoleUse )
})
t . Run ( "ShareWithUsers_Multiple" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
orgOwner = coderdtest . CreateFirstUser ( t , client )
2025-09-04 17:37:16 -04:00
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toShareWithUser1 = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
_ , toShareWithUser2 = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
)
ctx := testutil . Context ( t , testutil . WaitMedium )
inv , root := clitest . New ( t ,
"sharing" ,
2025-09-11 16:22:25 -04:00
"add" , workspace . Name ,
2025-09-04 17:37:16 -04:00
fmt . Sprintf ( "--user=%s,%s" , toShareWithUser1 . Username , toShareWithUser2 . Username ),
)
clitest . SetupConfig ( t , workspaceOwnerClient , root )
2025-09-11 16:22:25 -04:00
out := new ( bytes . Buffer )
2025-09-04 17:37:16 -04:00
inv . Stdout = out
err := inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
acl , err := workspaceOwnerClient . WorkspaceACL ( inv . Context (), workspace . ID )
require . NoError ( t , err )
assert . Contains ( t , acl . Users , codersdk . WorkspaceUser {
MinimalUser : codersdk . MinimalUser {
ID : toShareWithUser1 . ID ,
Username : toShareWithUser1 . Username ,
2025-10-22 16:18:31 +11:00
Name : toShareWithUser1 . Name ,
2025-09-04 17:37:16 -04:00
AvatarURL : toShareWithUser1 . AvatarURL ,
},
Role : codersdk . WorkspaceRoleUse ,
})
assert . Contains ( t , acl . Users , codersdk . WorkspaceUser {
MinimalUser : codersdk . MinimalUser {
ID : toShareWithUser2 . ID ,
Username : toShareWithUser2 . Username ,
2025-10-22 16:18:31 +11:00
Name : toShareWithUser2 . Name ,
2025-09-04 17:37:16 -04:00
AvatarURL : toShareWithUser2 . AvatarURL ,
},
Role : codersdk . WorkspaceRoleUse ,
})
assert . Contains ( t , out . String (), toShareWithUser1 . Username )
assert . Contains ( t , out . String (), toShareWithUser2 . Username )
})
t . Run ( "ShareWithUsers_Roles" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
2025-09-04 17:37:16 -04:00
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toShareWithUser = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
)
ctx := testutil . Context ( t , testutil . WaitMedium )
inv , root := clitest . New ( t , "sharing" , "add" , workspace . Name ,
"--user" , fmt . Sprintf ( "%s:admin" , toShareWithUser . Username ),
)
clitest . SetupConfig ( t , workspaceOwnerClient , root )
2025-09-11 16:22:25 -04:00
out := new ( bytes . Buffer )
2025-09-04 17:37:16 -04:00
inv . Stdout = out
err := inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
acl , err := workspaceOwnerClient . WorkspaceACL ( inv . Context (), workspace . ID )
require . NoError ( t , err )
assert . Contains ( t , acl . Users , codersdk . WorkspaceUser {
MinimalUser : codersdk . MinimalUser {
ID : toShareWithUser . ID ,
Username : toShareWithUser . Username ,
2025-10-22 16:18:31 +11:00
Name : toShareWithUser . Name ,
2025-09-04 17:37:16 -04:00
AvatarURL : toShareWithUser . AvatarURL ,
},
Role : codersdk . WorkspaceRoleAdmin ,
})
found := false
for _ , line := range strings . Split ( out . String (), "\n" ) {
if strings . Contains ( line , toShareWithUser . Username ) && strings . Contains ( line , string ( codersdk . WorkspaceRoleAdmin )) {
found = true
break
}
}
assert . True ( t , found , fmt . Sprintf ( "expected to find the username %s and role %s in the command: %s" , toShareWithUser . Username , codersdk . WorkspaceRoleAdmin , out . String ()))
})
}
2025-09-08 09:30:08 -04:00
func TestSharingStatus ( t * testing . T ) {
t . Parallel ()
t . Run ( "ListSharedUsers" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
2025-09-08 09:30:08 -04:00
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toShareWithUser = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
ctx = testutil . Context ( t , testutil . WaitMedium )
)
2026-01-22 08:12:15 -08:00
err := client . UpdateWorkspaceACL ( ctx , workspace . ID , codersdk . UpdateWorkspaceACL {
2025-09-08 09:30:08 -04:00
UserRoles : map [ string ] codersdk . WorkspaceRole {
toShareWithUser . ID . String (): codersdk . WorkspaceRoleUse ,
},
})
require . NoError ( t , err )
2025-09-11 16:22:25 -04:00
inv , root := clitest . New ( t , "sharing" , "status" , workspace . Name )
2025-09-08 09:30:08 -04:00
clitest . SetupConfig ( t , workspaceOwnerClient , root )
2025-09-11 16:22:25 -04:00
out := new ( bytes . Buffer )
2025-09-08 09:30:08 -04:00
inv . Stdout = out
err = inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
found := false
for _ , line := range strings . Split ( out . String (), "\n" ) {
if strings . Contains ( line , toShareWithUser . Username ) && strings . Contains ( line , string ( codersdk . WorkspaceRoleUse )) {
found = true
break
}
}
assert . True ( t , found , "expected to find username %s with role %s in the output: %s" , toShareWithUser . Username , codersdk . WorkspaceRoleUse , out . String ())
})
2026-06-23 11:58:00 -05:00
t . Run ( "ListSharedGroups" , func ( t * testing . T ) {
t . Parallel ()
var (
client , db = coderdtest . NewWithDatabase ( t , nil )
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
ctx = testutil . Context ( t , testutil . WaitMedium )
)
// The Everyone group always exists for an organization and shares the
// organization's ID. The workspace ACL endpoint no longer returns the
// group's member roster, so the CLI must still list the group itself.
err := client . UpdateWorkspaceACL ( ctx , workspace . ID , codersdk . UpdateWorkspaceACL {
GroupRoles : map [ string ] codersdk . WorkspaceRole {
orgOwner . OrganizationID . String (): codersdk . WorkspaceRoleUse ,
},
})
require . NoError ( t , err )
inv , root := clitest . New ( t , "sharing" , "status" , workspace . Name )
clitest . SetupConfig ( t , workspaceOwnerClient , root )
out := new ( bytes . Buffer )
inv . Stdout = out
err = inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
found := false
for _ , line := range strings . Split ( out . String (), "\n" ) {
if strings . Contains ( line , database . EveryoneGroup ) && strings . Contains ( line , string ( codersdk . WorkspaceRoleUse )) {
found = true
break
}
}
assert . True ( t , found , "expected to find group %s with role %s in the output: %s" , database . EveryoneGroup , codersdk . WorkspaceRoleUse , out . String ())
})
2025-09-08 09:30:08 -04:00
}
2025-09-11 16:22:25 -04:00
func TestSharingRemove ( t * testing . T ) {
t . Parallel ()
t . Run ( "RemoveSharedUser_Simple" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
2025-09-11 16:22:25 -04:00
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toRemoveUser = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
_ , toShareWithUser = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
)
ctx := testutil . Context ( t , testutil . WaitMedium )
// Share the workspace with a user to later remove
2026-01-22 08:12:15 -08:00
err := client . UpdateWorkspaceACL ( ctx , workspace . ID , codersdk . UpdateWorkspaceACL {
2025-09-11 16:22:25 -04:00
UserRoles : map [ string ] codersdk . WorkspaceRole {
toShareWithUser . ID . String (): codersdk . WorkspaceRoleUse ,
toRemoveUser . ID . String (): codersdk . WorkspaceRoleUse ,
},
})
require . NoError ( t , err )
inv , root := clitest . New ( t ,
"sharing" ,
"remove" ,
workspace . Name ,
"--user" , toRemoveUser . Username ,
)
clitest . SetupConfig ( t , workspaceOwnerClient , root )
out := new ( bytes . Buffer )
inv . Stdout = out
err = inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
acl , err := workspaceOwnerClient . WorkspaceACL ( inv . Context (), workspace . ID )
require . NoError ( t , err )
removedCorrectUser := true
keptOtherUser := false
for _ , user := range acl . Users {
if user . ID == toRemoveUser . ID {
removedCorrectUser = false
}
if user . ID == toShareWithUser . ID {
keptOtherUser = true
}
}
assert . True ( t , removedCorrectUser )
assert . True ( t , keptOtherUser )
})
t . Run ( "RemoveSharedUser_Multiple" , func ( t * testing . T ) {
t . Parallel ()
var (
2026-02-23 08:30:32 -08:00
client , db = coderdtest . NewWithDatabase ( t , nil )
2025-09-11 16:22:25 -04:00
orgOwner = coderdtest . CreateFirstUser ( t , client )
workspaceOwnerClient , workspaceOwner = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID , rbac . ScopedRoleOrgAuditor ( orgOwner . OrganizationID ))
workspace = dbfake . WorkspaceBuild ( t , db , database . WorkspaceTable {
OwnerID : workspaceOwner . ID ,
OrganizationID : orgOwner . OrganizationID ,
}). Do (). Workspace
_ , toRemoveUser1 = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
_ , toRemoveUser2 = coderdtest . CreateAnotherUser ( t , client , orgOwner . OrganizationID )
)
ctx := testutil . Context ( t , testutil . WaitMedium )
// Share the workspace with a user to later remove
2026-01-22 08:12:15 -08:00
err := client . UpdateWorkspaceACL ( ctx , workspace . ID , codersdk . UpdateWorkspaceACL {
2025-09-11 16:22:25 -04:00
UserRoles : map [ string ] codersdk . WorkspaceRole {
toRemoveUser2 . ID . String (): codersdk . WorkspaceRoleUse ,
toRemoveUser1 . ID . String (): codersdk . WorkspaceRoleUse ,
},
})
require . NoError ( t , err )
inv , root := clitest . New ( t ,
"sharing" ,
"remove" ,
workspace . Name ,
fmt . Sprintf ( "--user=%s,%s" , toRemoveUser1 . Username , toRemoveUser2 . Username ),
)
clitest . SetupConfig ( t , workspaceOwnerClient , root )
out := new ( bytes . Buffer )
inv . Stdout = out
err = inv . WithContext ( ctx ). Run ()
require . NoError ( t , err )
acl , err := workspaceOwnerClient . WorkspaceACL ( inv . Context (), workspace . ID )
require . NoError ( t , err )
assert . Empty ( t , acl . Users )
})
}