chore: expose API Token and BaseURL (#252)

jawnsy · web-flow · commit 5bdd9fe159e7 · 2021-02-24T17:34:06.000-08:00
This adds accessors to retrieve the Client's active Session Token
and Base URL.
diff --git a/coder-sdk/client.go b/coder-sdk/client.go
@@ -116,3 +116,13 @@ type DefaultClient struct {
 	// token is the API Token credential.
 	token string
 }
+
+// Token returns the API Token used to authenticate.
+func (c *DefaultClient) Token() string {
+	return c.token
+}
+
+// BaseURL returns the BaseURL configured for this Client.
+func (c *DefaultClient) BaseURL() url.URL {
+	return *c.baseURL
+}
diff --git a/coder-sdk/client_test.go b/coder-sdk/client_test.go
@@ -18,6 +18,7 @@ func TestAuthentication(t *testing.T) {
 	t.Parallel()
 
 	const token = "g4mtIPUaKt-pPl9Q0xmgKs7acSypHt4Jf"
+
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		gotToken := r.Header.Get("Session-Token")
 		require.Equal(t, token, gotToken, "token does not match")
@@ -37,28 +38,35 @@ func TestAuthentication(t *testing.T) {
 	})
 	require.NoError(t, err, "failed to create coder.Client")
 
+	require.Equal(t, token, client.Token(), "expected Token to match")
+	require.EqualValues(t, *u, client.BaseURL(), "expected BaseURL to match")
+
 	_, err = client.APIVersion(context.Background())
 	require.NoError(t, err, "failed to get API version information")
 }
 
 func TestPasswordAuthentication(t *testing.T) {
 	t.Parallel()
 
+	const email = "user@coder.com"
+	const password = "coder4all"
+	const token = "g4mtIPUaKt-pPl9Q0xmgKs7acSypHt4Jf"
+
 	mux := http.NewServeMux()
 	mux.HandleFunc("/auth/basic/login", func(w http.ResponseWriter, r *http.Request) {
 		require.Equal(t, r.Method, http.MethodPost, "login is a POST")
 
 		expected := map[string]interface{}{
-			"email":    "user@coder.com",
-			"password": "coder4all",
+			"email":    email,
+			"password": password,
 		}
 		var request map[string]interface{}
 		err := json.NewDecoder(r.Body).Decode(&request)
 		require.NoError(t, err, "error decoding JSON")
 		require.EqualValues(t, expected, request, "unexpected request data")
 
 		response := map[string]interface{}{
-			"session_token": "g4mtIPUaKt-pPl9Q0xmgKs7acSypHt4Jf",
+			"session_token": token,
 		}
 
 		w.WriteHeader(http.StatusOK)
@@ -68,11 +76,11 @@ func TestPasswordAuthentication(t *testing.T) {
 	mux.HandleFunc("/api/v0/users/me", func(w http.ResponseWriter, r *http.Request) {
 		require.Equal(t, http.MethodGet, r.Method, "Users is a GET")
 
-		require.Equal(t, "g4mtIPUaKt-pPl9Q0xmgKs7acSypHt4Jf", r.Header.Get("Session-Token"), "expected session token to match return of login")
+		require.Equal(t, token, r.Header.Get("Session-Token"), "expected session token to match return of login")
 
 		user := map[string]interface{}{
 			"id":                 "default",
-			"email":              "user@coder.com",
+			"email":              email,
 			"username":           "charlie",
 			"name":               "Charlie Root",
 			"roles":              []coder.Role{coder.SiteAdmin},
@@ -99,14 +107,15 @@ func TestPasswordAuthentication(t *testing.T) {
 	client, err := coder.NewClient(coder.ClientOptions{
 		BaseURL:    u,
 		HTTPClient: server.Client(),
-		Email:      "user@coder.com",
-		Password:   "coder4all",
+		Email:      email,
+		Password:   password,
 	})
 	require.NoError(t, err, "failed to create Client")
+	require.Equal(t, token, client.Token(), "expected token to match")
 
 	user, err := client.Me(context.Background())
 	require.NoError(t, err, "failed to get information about current user")
-	require.Equal(t, "user@coder.com", user.Email, "expected test user")
+	require.Equal(t, email, user.Email, "expected test user")
 }
 
 func TestContextRoot(t *testing.T) {
diff --git a/coder-sdk/interface.go b/coder-sdk/interface.go
@@ -213,4 +213,10 @@ type Client interface {
 
 	// DeleteWorkspaceProviderByID deletes a workspace provider entity from the Coder control plane.
 	DeleteWorkspaceProviderByID(ctx context.Context, id string) error
+
+	// Token returns the API Token used to authenticate.
+	Token() string
+
+	// BaseURL returns the BaseURL configured for this Client.
+	BaseURL() url.URL
 }
diff --git a/coder-sdk/users_test.go b/coder-sdk/users_test.go
@@ -17,6 +17,9 @@ import (
 func TestUsers(t *testing.T) {
 	t.Parallel()
 
+	const username = "root"
+	const name = "Charlie Root"
+
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		require.Equal(t, http.MethodGet, r.Method, "Users is a GET")
 		require.Equal(t, "/api/v0/users", r.URL.Path)
@@ -25,8 +28,8 @@ func TestUsers(t *testing.T) {
 			{
 				"id":                 "default",
 				"email":              "root@user.com",
-				"username":           "root",
-				"name":               "Charlie Root",
+				"username":           username,
+				"name":               name,
 				"roles":              []coder.Role{coder.SiteAdmin},
 				"temporary_password": false,
 				"login_type":         coder.LoginTypeBuiltIn,
@@ -56,20 +59,23 @@ func TestUsers(t *testing.T) {
 	users, err := client.Users(context.Background())
 	require.NoError(t, err, "error getting Users")
 	require.Len(t, users, 1, "users should return a single user")
-	require.Equal(t, "Charlie Root", users[0].Name)
-	require.Equal(t, "root", users[0].Username)
+	require.Equal(t, name, users[0].Name)
+	require.Equal(t, username, users[0].Username)
 }
 
 func TestUserUpdatePassword(t *testing.T) {
 	t.Parallel()
 
+	const oldPassword = "vt9g9rxsptrq"
+	const newPassword = "wmf39jw2f7pk"
+
 	server := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		require.Equal(t, http.MethodPatch, r.Method, "Users is a PATCH")
 		require.Equal(t, "/api/v0/users/me", r.URL.Path)
 
 		expected := map[string]interface{}{
-			"old_password": "vt9g9rxsptrq",
-			"password":     "wmf39jw2f7pk",
+			"old_password": oldPassword,
+			"password":     newPassword,
 		}
 		var request map[string]interface{}
 		err := json.NewDecoder(r.Body).Decode(&request)
@@ -94,8 +100,8 @@ func TestUserUpdatePassword(t *testing.T) {
 
 	err = client.UpdateUser(context.Background(), "me", coder.UpdateUserReq{
 		UserPasswordSettings: &coder.UserPasswordSettings{
-			OldPassword: "vt9g9rxsptrq",
-			Password:    "wmf39jw2f7pk",
+			OldPassword: oldPassword,
+			Password:    newPassword,
 			Temporary:   false,
 		},
 	})
