feat: implement organization context in the cli #12259

Emyrk · 2024-02-21T23:27:57Z

What this does

The cli now uses the config files to store what organization it is currently referencing.

Adds coder organizations current to display the currently selected organization.

This is a hidden command until we finish all related commands

Discussion

Currently I have this under coder organizations { current | switch | ... }. Should we name this something else? Like coder ctx current, coder ctx switch` etc?

This could maybe include different deployments and logins if we do ctx.

`coder organizations current`

Below is all the format options.

$ go install && coder organizations current                                                                                                                                
Current organization: admin (3736ca3e-840f-4473-88ad-7056f1a9d22a)

$ coder organizations show current --output=json
[
  {
    "id": "3736ca3e-840f-4473-88ad-7056f1a9d22a",
    "name": "admin",
    "created_at": "2024-02-21T23:22:42.667305Z",
    "updated_at": "2024-02-21T23:22:42.667305Z",
    "is_default": true
  }
]

$ coder organizations show current --output=table
ID                                    NAME   DEFAULT  
3736ca3e-840f-4473-88ad-7056f1a9d22a  admin  true   

# coder organizations show current --only-id
3736ca3e-840f-4473-88ad-7056f1a9d22a

Emyrk · 2024-02-22T16:39:10Z

cli/organization.go

+		Use:         "organizations { current }",
+		Short:       "Organization related commands",
+		Aliases:     []string{"organization", "org", "orgs"},


Should we instead do something like coder ctx current?

I'd be interested in discussing this further, ultimately I'd like for us to support config files for the CLI too, you might not want same behavior across all orgs. Having this support those use-cases as well would be nice.

Good point. This command is marked as hidden, so we can tweak it before we release.

Multi orgs is still a bit out, but this is going to be really helpful in development.

Emyrk · 2024-02-22T16:39:38Z

cli/organization.go

+		Use:         "organizations { current }",
+		Short:       "Organization related commands",
+		Aliases:     []string{"organization", "org", "orgs"},
+		Hidden:      true, // Hidden until these commands are complete.


I marked this as hidden, I think we can defer the actual command name discussion and get the code in. Don't want to bikeshed and prevent code progress.

cli/organization.go

cli/root.go

mafredri · 2024-02-23T15:26:49Z

cli/templatecreate_test.go

-			}
-		}
-
+		pty.ExpectMatch("context canceled")


Why this change?

Emyrk · 2024-02-23T16:10:56Z

cli/root.go

-		return codersdk.Organization{}, nil
+		return codersdk.Organization{}, err


@mafredri The unit test expecting context cancelled had to be changed because of this change. (#12259 (comment))

Before, if you failed to fetch the orgs, we'd return a nil uuid. I made this api failure fail the command now. So the unit tests fails differently now.

I wouldn't expect TestTemplateCreate/WithVariablesFileWithoutRequiredValue to be testing for org failure though 🤔

I didn't write the test, but there is a comment indicating this cli error is expected. We cancel the context before running the command.

coder/cli/templatecreate_test.go

Lines 238 to 244 in 98666fd

// We expect the cli to return an error, so we have to handle it

// ourselves.

go func() {

cancel()

err := inv.Run()

assert.Error(t, err)

}()

If we're testing against a cancelled context, that test is useless. I think it should either be removed or fixed. 😅 It's definitely not testing what the test name is indicating.

mafredri

I'm not happy with that test that tests for context cancellation, but not letting that block this PR, so approved. 👍🏻

Emyrk · 2024-02-26T16:02:40Z

I'm not happy with that test that tests for context cancellation, but not letting that block this PR, so approved. 👍🏻

Yea, I'm not 100% sure what the test is intended to do because the prior behavior makes little sense to me as well.

github-actions bot assigned Emyrk Feb 21, 2024

Emyrk changed the title ~~feat: begin work to implement switching orgs in the cli~~ feat: implement switching organizations in the CLI Feb 21, 2024

Emyrk mentioned this pull request Feb 21, 2024

feat: switch organization context in coder organizations #12265

Merged

Emyrk changed the title ~~feat: implement switching organizations in the CLI~~ feat: implement organization context in the cli Feb 22, 2024

Emyrk added 2 commits February 22, 2024 08:57

feat: begin work to implement switching orgs in the cli

31a8541

add only-id option

1ac16cf

Emyrk force-pushed the stevenmasley/select-org branch from d4d20af to 1ac16cf Compare February 22, 2024 14:57

Emyrk added 7 commits February 22, 2024 08:58

Mark hidden

6a99a37

linting

d88d7be

fix test assert

5df951b

linting

a2f68ea

Lint

50cdb32

Add unit test

438e69d

linting

f32c78c

Emyrk commented Feb 22, 2024

View reviewed changes

fix use

cad75c2

Emyrk marked this pull request as ready for review February 22, 2024 17:01

Emyrk requested a review from mafredri February 22, 2024 17:04

Emyrk mentioned this pull request Feb 23, 2024

CLI Org support #11927

Closed

mafredri reviewed Feb 23, 2024

View reviewed changes

Emyrk commented Feb 23, 2024

View reviewed changes

Emyrk added 5 commits February 23, 2024 10:30

implement more general organizations show

f8b97d9

fix short desc

405afc9

fix help msg

a9da679

Fix test

510dbb8

whoops, fix the unit test

c74106b

Emyrk requested a review from mafredri February 26, 2024 15:25

mafredri approved these changes Feb 26, 2024

View reviewed changes

Emyrk merged commit d2998c6 into main Feb 26, 2024

Emyrk deleted the stevenmasley/select-org branch February 26, 2024 16:03

github-actions bot locked and limited conversation to collaborators Feb 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: implement organization context in the cli #12259

feat: implement organization context in the cli #12259

Uh oh!

Emyrk commented Feb 21, 2024 •

edited

Loading

Uh oh!

Emyrk Feb 22, 2024

Uh oh!

mafredri Feb 23, 2024

Uh oh!

Emyrk Feb 26, 2024

Uh oh!

Emyrk Feb 22, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mafredri Feb 23, 2024

Uh oh!

Emyrk Feb 23, 2024

Uh oh!

mafredri Feb 23, 2024

Uh oh!

Emyrk Feb 26, 2024

Uh oh!

mafredri Feb 26, 2024

Uh oh!

mafredri left a comment

Uh oh!

Emyrk commented Feb 26, 2024

Uh oh!

Uh oh!

		return codersdk.Organization{}, nil
		return codersdk.Organization{}, err

	// We expect the cli to return an error, so we have to handle it
	// ourselves.
	go func() {
	cancel()
	err := inv.Run()
	assert.Error(t, err)
	}()

feat: implement organization context in the cli #12259

feat: implement organization context in the cli #12259

Uh oh!

Conversation

Emyrk commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this does

Discussion

coder organizations current

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mafredri left a comment

Choose a reason for hiding this comment

Uh oh!

Emyrk commented Feb 26, 2024

Uh oh!

Uh oh!

Emyrk commented Feb 21, 2024 •

edited

Loading

`coder organizations current`