Merge pull request #1586 from dougm/rest-session

vapi: return info with current session query

Author: dougm

vapi/rest/client.go

@@ -25,6 +25,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"net/url"
+	"time"
 
 	"github.com/vmware/govmomi/vapi/internal"
 	"github.com/vmware/govmomi/vim25"
@@ -36,6 +37,13 @@ type Client struct {
 	*soap.Client
 }
 
+// Session information
+type Session struct {
+	User         string    `json:"user"`
+	Created      time.Time `json:"created_time"`
+	LastAccessed time.Time `json:"last_accessed_time"`
+}
+
 // LocalizableMessage represents a localizable error
 type LocalizableMessage struct {
 	Args           []string `json:"args,omitempty"`
@@ -64,6 +72,14 @@ func (c *Client) WithSigner(ctx context.Context, s Signer) context.Context {
 	return context.WithValue(ctx, signerContext{}, s)
 }
 
+type statusError struct {
+	res *http.Response
+}
+
+func (e *statusError) Error() string {
+	return fmt.Sprintf("%s %s: %s", e.res.Request.Method, e.res.Request.URL, e.res.Status)
+}
+
 // Do sends the http.Request, decoding resBody if provided.
 func (c *Client) Do(ctx context.Context, req *http.Request, resBody interface{}) error {
 	switch req.Method {
@@ -90,7 +106,7 @@ func (c *Client) Do(ctx context.Context, req *http.Request, resBody interface{})
 			}
 			return fmt.Errorf("%s: %s", res.Status, bytes.TrimSpace(detail))
 		default:
-			return fmt.Errorf("%s %s: %s", req.Method, req.URL, res.Status)
+			return &statusError{res}
 		}
 
 		if resBody == nil {
@@ -129,10 +145,21 @@ func (c *Client) LoginByToken(ctx context.Context) error {
 	return c.Login(ctx, nil)
 }
 
-// Get returns an error if the current session is invalid.
-func (c *Client) Get(ctx context.Context) error {
+// Session returns the user's current session.
+// Nil is returned if the session is not authenticated.
+func (c *Client) Session(ctx context.Context) (*Session, error) {
+	var s Session
 	req := internal.URL(c, internal.SessionPath).WithAction("get").Request(http.MethodPost)
-	return c.Do(ctx, req, nil)
+	err := c.Do(ctx, req, &s)
+	if err != nil {
+		if e, ok := err.(*statusError); ok {
+			if e.res.StatusCode == http.StatusUnauthorized {
+				return nil, nil
+			}
+		}
+		return nil, err
+	}
+	return &s, nil
 }
 
 // Logout deletes the current session.

vapi/rest/client_test.go

@@ -0,0 +1,57 @@
+/*
+Copyright (c) 2019 VMware, Inc. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package rest_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/vmware/govmomi/simulator"
+	"github.com/vmware/govmomi/vapi/rest"
+	"github.com/vmware/govmomi/vim25"
+
+	_ "github.com/vmware/govmomi/vapi/simulator"
+)
+
+func TestSession(t *testing.T) {
+	simulator.Test(func(ctx context.Context, vc *vim25.Client) {
+		c := rest.NewClient(vc)
+
+		session, err := c.Session(ctx)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		if session != nil {
+			t.Fatal("expected nil session")
+		}
+
+		err = c.Login(ctx, simulator.DefaultLogin)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		session, err = c.Session(ctx)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		if session == nil {
+			t.Fatal("expected non-nil session")
+		}
+	})
+}

vapi/simulator/simulator.go

@@ -52,12 +52,6 @@ import (
 	vim "github.com/vmware/govmomi/vim25/types"
 )
 
-type session struct {
-	User         string    `json:"user"`
-	Created      time.Time `json:"created_time"`
-	LastAccessed time.Time `json:"last_accessed_time"`
-}
-
 type item struct {
 	*library.Item
 	File []library.File
@@ -87,7 +81,7 @@ type handler struct {
 	Category    map[string]*tags.Category
 	Tag         map[string]*tags.Tag
 	Association map[string]map[internal.AssociatedObject]bool
-	Session     map[string]*session
+	Session     map[string]*rest.Session
 	Library     map[string]content
 	Update      map[string]update
 	Download    map[string]download
@@ -110,7 +104,7 @@ func New(u *url.URL, settings []vim.BaseOptionValue) (string, http.Handler) {
 		Category:    make(map[string]*tags.Category),
 		Tag:         make(map[string]*tags.Tag),
 		Association: make(map[string]map[internal.AssociatedObject]bool),
-		Session:     make(map[string]*session),
+		Session:     make(map[string]*rest.Session),
 		Library:     make(map[string]content),
 		Update:      make(map[string]update),
 		Download:    make(map[string]download),
@@ -332,8 +326,8 @@ func (s *handler) session(w http.ResponseWriter, r *http.Request) {
 	switch r.Method {
 	case http.MethodPost:
 		if s.action(r) != "" {
-			if _, ok := s.Session[id]; ok {
-				s.ok(w)
+			if session, ok := s.Session[id]; ok {
+				s.ok(w, session)
 			} else {
 				w.WriteHeader(http.StatusUnauthorized)
 			}
@@ -346,7 +340,7 @@ func (s *handler) session(w http.ResponseWriter, r *http.Request) {
 		}
 		id = uuid.New().String()
 		now := time.Now()
-		s.Session[id] = &session{user, now, now}
+		s.Session[id] = &rest.Session{User: user, Created: now, LastAccessed: now}
 		http.SetCookie(w, &http.Cookie{
 			Name:  internal.SessionCookieName,
 			Value: id,