github.com/vmware/govmomi@v0.43.0/simulator/session_manager_test.go

/*
Copyright (c) 2017-2018 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 simulator

import (
	"context"
	"crypto/tls"
	"log"
	"strings"
	"testing"

	"github.com/vmware/govmomi"
	"github.com/vmware/govmomi/object"
	"github.com/vmware/govmomi/property"
	"github.com/vmware/govmomi/session"
	"github.com/vmware/govmomi/simulator/vpx"
	"github.com/vmware/govmomi/vim25/methods"
	"github.com/vmware/govmomi/vim25/mo"
	"github.com/vmware/govmomi/vim25/soap"
	"github.com/vmware/govmomi/vim25/types"
)

func isNotAuthenticated(err error) bool {
	if soap.IsSoapFault(err) {
		switch soap.ToSoapFault(err).VimFault().(type) {
		case types.NotAuthenticated:
			return true
		}
	}
	return false
}

func TestSessionManagerAuth(t *testing.T) {
	ctx := context.Background()

	m := VPX()

	defer m.Remove()

	err := m.Create()
	if err != nil {
		t.Fatal(err)
	}

	s := m.Service.NewServer()
	defer s.Close()

	u := s.URL.User
	s.URL.User = nil // skip Login()

	c, err := govmomi.NewClient(ctx, s.URL, true)
	if err != nil {
		t.Fatal(err)
	}

	session, err := c.SessionManager.UserSession(ctx)
	if err != nil {
		t.Fatal(err)
	}

	if session != nil {
		t.Error("expected nil session")
	}

	opts := object.NewOptionManager(c.Client, *c.ServiceContent.Setting)
	var content []types.ObjectContent
	err = opts.Properties(ctx, opts.Reference(), []string{"setting"}, &content)
	if err != nil {
		t.Fatal(err)
	}

	if len(content) != 1 {
		t.Error("expected content len=1")
	}

	if len(content[0].PropSet) != 0 {
		t.Error("non-empty PropSet")
	}

	if len(content[0].MissingSet) != 1 {
		t.Error("expected MissingSet len=1")
	}

	if _, ok := content[0].MissingSet[0].Fault.Fault.(*types.NotAuthenticated); !ok {
		t.Error("expected NotAuthenticated")
	}

	_, err = methods.GetCurrentTime(ctx, c)
	if !isNotAuthenticated(err) {
		t.Error("expected NotAuthenticated")
	}

	err = c.SessionManager.Login(ctx, u)
	if err != nil {
		t.Fatal(err)
	}

	c.UserAgent = "vcsim/x.x"

	session, err = c.SessionManager.UserSession(ctx)
	if err != nil {
		t.Fatal(err)
	}

	if session == nil {
		t.Error("expected session")
	}

	if session.UserAgent != c.UserAgent {
		t.Errorf("UserAgent=%s", session.UserAgent)
	}

	active, err := c.SessionManager.SessionIsActive(ctx)
	if err != nil {
		t.Fatal(err)
	}

	if active == false {
		t.Error("not active")
	}

	{
		req := types.SessionIsActive{
			This:      c.SessionManager.Reference(),
			SessionID: "enoent",
			UserName:  "",
		}

		active, err := methods.SessionIsActive(ctx, c, &req)
		if err != nil {
			t.Fatal(err)
		}

		if active.Returnval {
			t.Error("active")
		}
	}

	{
		req := types.SessionIsActive{
			This:      c.SessionManager.Reference(),
			SessionID: session.Key,
			UserName:  "enoent",
		}

		active, err := methods.SessionIsActive(ctx, c, &req)
		if err != nil {
			t.Fatal(err)
		}

		if active.Returnval {
			t.Error("active")
		}
	}

	content = nil
	err = opts.Properties(ctx, opts.Reference(), []string{"setting"}, &content)
	if err != nil {
		t.Fatal(err)
	}

	if len(content) != 1 {
		t.Error("expected content len=1")
	}

	if len(content[0].PropSet) != 1 {
		t.Error("PropSet len=1")
	}

	if len(content[0].MissingSet) != 0 {
		t.Error("expected MissingSet len=0")
	}

	last := session.LastActiveTime

	_, err = methods.GetCurrentTime(ctx, c)
	if err != nil {
		t.Error(err)
	}

	pc, err := property.DefaultCollector(c.Client).Create(ctx)
	if err != nil {
		t.Fatal(err)
	}

	session, _ = c.SessionManager.UserSession(ctx)

	if session.LastActiveTime.Equal(last) {
		t.Error("LastActiveTime was not updated")
	}

	if !strings.Contains(pc.Reference().Value, session.Key) {
		t.Errorf("invalid ref=%s", pc.Reference())
	}

	ticket, err := c.SessionManager.AcquireCloneTicket(ctx)
	if err != nil {
		t.Fatal(err)
	}

	c, err = govmomi.NewClient(ctx, s.URL, true)
	if err != nil {
		t.Fatal(err)
	}

	err = c.SessionManager.CloneSession(ctx, ticket)
	if err != nil {
		t.Fatal(err)
	}

	err = c.SessionManager.CloneSession(ctx, ticket)
	if err == nil {
		t.Error("expected error")
	}

	_, err = methods.GetCurrentTime(ctx, c)
	if err != nil {
		t.Error(err)
	}
}

func TestSessionManagerLoginExtension(t *testing.T) {
	ctx := context.Background()

	s := New(NewServiceInstance(SpoofContext(), vpx.ServiceContent, vpx.RootFolder))
	s.TLS = new(tls.Config)
	ts := s.NewServer()
	defer ts.Close()

	if terr := ts.StartTunnel(); terr != nil {
		t.Fatal(terr)
	}

	u := ts.URL.User
	ts.URL.User = nil // skip Login()

	c, err := govmomi.NewClient(ctx, ts.URL, true)
	if err != nil {
		t.Fatal(err)
	}

	err = session.NewManager(c.Client).LoginExtensionByCertificate(ctx, u.Username())
	if err == nil {
		t.Error("expected error") // client cert not set
	}

	c.SetCertificate(ts.TLS.Certificates[0]) // any cert is ok with vcsim
	err = session.NewManager(c.Client).LoginExtensionByCertificate(ctx, u.Username())
	if err != nil {
		t.Fatal(err)
	}

	_, err = methods.GetCurrentTime(ctx, c)
	if err != nil {
		t.Error(err)
	}
}

// Test WaitForUpdates against the PropertyCollector singleton.
// Includes test for issue 1172, where a 2nd session use of the PropertyCollector singleton followed by Logout()
// unregistered the 1st session's update listener as the PC singleton has the same moref regardless of session instance.
func TestSessionManagerPropertyCollector(t *testing.T) {
	ctx := context.Background()

	m := VPX()

	defer m.Remove()

	err := m.Create()
	if err != nil {
		t.Fatal(err)
	}

	s := m.Service.NewServer()
	defer s.Close()

	c, err := govmomi.NewClient(ctx, s.URL, true)
	if err != nil {
		t.Fatal(err)
	}

	pc := property.DefaultCollector(c.Client)
	root := object.NewRootFolder(c.Client)

	filter := types.CreateFilter{
		This: pc.Reference(),
		Spec: types.PropertyFilterSpec{
			PropSet: []types.PropertySpec{
				{
					Type:    "Datacenter",
					All:     types.NewBool(false),
					PathSet: []string{"name"},
				},
			},
			ObjectSet: []types.ObjectSpec{
				{
					Obj:  root.Reference(),
					Skip: (*bool)(nil),
					SelectSet: []types.BaseSelectionSpec{
						&types.TraversalSpec{
							SelectionSpec: types.SelectionSpec{
								Name: "folder2childEntity",
							},
							Type: "Folder",
							Path: "childEntity",
							Skip: types.NewBool(false),
							SelectSet: []types.BaseSelectionSpec{
								&types.SelectionSpec{
									Name: "folder2childEntity",
								},
							},
						},
					},
				},
			},
			ReportMissingObjectsInResults: (*bool)(nil),
		},
		PartialUpdates: true,
	}

	if _, err = pc.CreateFilter(ctx, filter); err != nil {
		t.Fatal(err)
	}

	updates, _ := pc.WaitForUpdates(ctx, "") // disregard first result
	// add DC and poll
	dc, _ := root.CreateDatacenter(ctx, "DC-A")
	updates, _ = pc.WaitForUpdates(ctx, updates.Version)
	set := updates.FilterSet[0].ObjectSet[0]
	if set.Obj.Type != "Datacenter" {
		t.Errorf("obj=%s", set.Obj)
	}
	if set.Kind != types.ObjectUpdateKindEnter {
		t.Errorf("kind=%s", set.Kind)
	}

	// create a new session and a call to the PropertyCollector singleton
	c2, err := govmomi.NewClient(ctx, s.URL, true)
	if err != nil {
		log.Fatal(err)
	}
	var folder mo.Folder
	property.DefaultCollector(c2.Client).RetrieveOne(ctx, root.Reference(), []string{"name"}, &folder)
	_ = c2.Logout(ctx)

	// remove DC and poll
	_, _ = dc.Destroy(ctx)
	updates, _ = pc.WaitForUpdates(ctx, updates.Version)
	set = updates.FilterSet[0].ObjectSet[0]
	if set.Obj.Type != "Datacenter" {
		t.Errorf("obj=%s", set.Obj)
	}
	if set.Kind != types.ObjectUpdateKindLeave {
		t.Errorf("kind=%s", set.Kind)
	}
}