local_test.go

package nova_test

import (
	"bytes"
	"log"
	"net/http"
	"net/http/httptest"
	"strings"

	gc "gopkg.in/check.v1"

	"github.com/go-goose/goose/v5/client"
	"github.com/go-goose/goose/v5/errors"
	goosehttp "github.com/go-goose/goose/v5/http"
	"github.com/go-goose/goose/v5/identity"
	"github.com/go-goose/goose/v5/nova"
	"github.com/go-goose/goose/v5/testservices"
	"github.com/go-goose/goose/v5/testservices/hook"
	"github.com/go-goose/goose/v5/testservices/identityservice"
	"github.com/go-goose/goose/v5/testservices/openstackservice"
)

func registerLocalTests() {
	// Test using numeric ids.
	gc.Suite(&localLiveSuite{
		useNumericIds: true,
	})
	// Test using string ids.
	gc.Suite(&localLiveSuite{
		useNumericIds: false,
	})
}

// localLiveSuite runs tests from LiveTests using a fake
// nova server that runs within the test process itself.
type localLiveSuite struct {
	LiveTests
	useNumericIds bool
	// The following attributes are for using testing doubles.
	Server                *httptest.Server
	Mux                   *http.ServeMux
	oldHandler            http.Handler
	openstack             *openstackservice.Openstack
	retryErrorCount       int  // The current retry error count.
	retryErrorCountToSend int  // The number of retry errors to send.
	noMoreIPs             bool // If true, addFloatingIP will return ErrNoMoreFloatingIPs
	ipLimitExceeded       bool // If true, addFloatingIP will return ErrIPLimitExceeded
	badTokens             int  // If > 0, authHook will set an invalid token in the AccessResponse data.
}

func (s *localLiveSuite) SetUpSuite(c *gc.C) {
	var idInfo string
	if s.useNumericIds {
		idInfo = "with numeric ids"
	} else {
		idInfo = "with string ids"
	}
	c.Logf("Using identity and nova service test doubles %s", idInfo)
	nova.UseNumericIds(s.useNumericIds)

	// Set up an Openstack service.
	s.cred = &identity.Credentials{
		User:       "fred",
		Secrets:    "secret",
		Region:     "some region",
		TenantName: "tenant",
	}
	var logMsg []string
	s.openstack, logMsg = openstackservice.NewNoSwift(s.cred, identity.AuthUserPass, false)
	for _, msg := range logMsg {
		c.Logf(msg)
	}
	s.openstack.SetupHTTP(nil)

	s.testFlavor = "m1.small"
	s.testImageId = "1"
	s.testNetwork = "1" // per neutronmodel setup
	s.LiveTests.SetUpSuite(c)
}

func (s *localLiveSuite) TearDownSuite(c *gc.C) {
	s.LiveTests.TearDownSuite(c)
	s.openstack.Stop()
}

func (s *localLiveSuite) SetUpTest(c *gc.C) {
	s.retryErrorCount = 0
	s.LiveTests.SetUpTest(c)
}

func (s *localLiveSuite) TearDownTest(c *gc.C) {
	s.LiveTests.TearDownTest(c)
}

// Additional tests to be run against the service double only go here.

func (s *localLiveSuite) retryAfterHook(sc hook.ServiceControl, err error) hook.ControlProcessor {
	return func(sc hook.ServiceControl, args ...interface{}) error {
		sendError := s.retryErrorCount < s.retryErrorCountToSend
		if sendError {
			s.retryErrorCount++
			return err
		}
		return nil
	}
}

func (s *localLiveSuite) setupClient(c *gc.C, logger *log.Logger) *nova.Client {
	client := client.NewClient(s.cred, identity.AuthUserPass, logger)
	client.SetRequiredServiceTypes([]string{"compute"})
	return nova.New(client)
}

func (s *localLiveSuite) setupRetryErrorTest(c *gc.C, logger *log.Logger) (*nova.Client, *nova.SecurityGroup) {
	novaClient := s.setupClient(c, logger)
	// Delete the artifact if it already exists.
	testGroup, err := novaClient.SecurityGroupByName("test_group")
	if err != nil {
		c.Assert(errors.IsNotFound(err), gc.Equals, true)
	} else {
		novaClient.DeleteSecurityGroup(testGroup.Id)
		c.Assert(err, gc.IsNil)
	}
	testGroup, err = novaClient.CreateSecurityGroup("test_group", "test")
	c.Assert(err, gc.IsNil)
	return novaClient, testGroup
}

func (s *localLiveSuite) makeRateLimitRetryTests() []error {
	return []error{
		testservices.TooManyRequestsError,
		testservices.ServiceUnavailRateLimitError,
		testservices.ForbiddenRateLimitError,
		testservices.RateLimitExceededError,
	}
}

// TestRateLimitRetry checks that when we make too many requests and receive
// a Retry-After response, the retry occurs and the request ultimately succeeds.
func (s *localLiveSuite) TestRateLimitRetry(c *gc.C) {
	tests := s.makeRateLimitRetryTests()
	testCount := len(tests)
	defer s.openstack.Nova.RegisterControlPoint("removeSecurityGroup", nil)
	for i, t := range tests {
		c.Logf("#%d of %d, %q", i+1, testCount, t)

		// Capture the logged output so we can check for retry messages.
		var logout bytes.Buffer
		logger := log.New(&logout, "", log.LstdFlags)
		novaClient, testGroup := s.setupRetryErrorTest(c, logger)
		s.retryErrorCount = 0
		s.retryErrorCountToSend = goosehttp.MaxSendAttempts - 1

		s.openstack.Nova.RegisterControlPoint("removeSecurityGroup", s.retryAfterHook(s.openstack.Nova, t))
		err := novaClient.DeleteSecurityGroup(testGroup.Id)
		c.Assert(err, gc.IsNil)
		// Ensure we got at least one retry message.
		output := logout.String()
		c.Assert(strings.Contains(output, "Too many requests, retrying in"), gc.Equals, true)
	}
}

// TestRateLimitRetryExceeded checks that an error is raised if too many
// retry responses are received from the server.
func (s *localLiveSuite) TestRateLimitRetryExceeded(c *gc.C) {
	tests := s.makeRateLimitRetryTests()
	testCount := len(tests)
	defer s.openstack.Nova.RegisterControlPoint("removeSecurityGroup", nil)

	for i, t := range tests {
		c.Logf("#%d of %d, %q", i+1, testCount, t)
		novaClient, testGroup := s.setupRetryErrorTest(c, nil)
		s.retryErrorCount = 0
		s.retryErrorCountToSend = goosehttp.MaxSendAttempts
		s.openstack.Nova.RegisterControlPoint("removeSecurityGroup", s.retryAfterHook(s.openstack.Nova, t))
		err := novaClient.DeleteSecurityGroup(testGroup.Id)
		c.Assert(err, gc.Not(gc.IsNil))
		c.Assert(err.Error(), gc.Matches, "(.|\n)*Maximum number of attempts.*")
	}
}

func (s *localLiveSuite) addFloatingIPHook(sc hook.ServiceControl) hook.ControlProcessor {
	return func(sc hook.ServiceControl, args ...interface{}) error {
		if s.noMoreIPs {
			return testservices.NoMoreFloatingIPs
		} else if s.ipLimitExceeded {
			return testservices.IPLimitExceeded
		}
		return nil
	}
}

func (s *localLiveSuite) TestAddFloatingIPErrors(c *gc.C) {
	novaClient := s.setupClient(c, nil)
	fips, err := novaClient.ListFloatingIPs()
	c.Assert(err, gc.IsNil)
	c.Assert(fips, gc.HasLen, 0)
	cleanup := s.openstack.Nova.RegisterControlPoint("addFloatingIP", s.addFloatingIPHook(s.openstack.Nova))
	defer cleanup()
	s.noMoreIPs = true
	fip, err := novaClient.AllocateFloatingIP()
	c.Assert(err, gc.ErrorMatches, "(.|\n)*Zero floating ips available.*")
	c.Assert(fip, gc.IsNil)
	s.noMoreIPs = false
	s.ipLimitExceeded = true
	fip, err = novaClient.AllocateFloatingIP()
	c.Assert(err, gc.ErrorMatches, "(.|\n)*Maximum number of floating ips exceeded.*")
	c.Assert(fip, gc.IsNil)
	s.ipLimitExceeded = false
	fip, err = novaClient.AllocateFloatingIP()
	c.Assert(err, gc.IsNil)
	c.Assert(fip.IP, gc.Not(gc.Equals), "")
}

func (s *localLiveSuite) authHook(sc hook.ServiceControl) hook.ControlProcessor {
	return func(sc hook.ServiceControl, args ...interface{}) error {
		res := args[0].(*identityservice.AccessResponse)
		if s.badTokens > 0 {
			res.Access.Token.Id = "xxx"
			s.badTokens--
		}
		return nil
	}
}

func (s *localLiveSuite) TestReauthenticate(c *gc.C) {
	novaClient := s.setupClient(c, nil)
	up := s.openstack.Identity.(*identityservice.UserPass)
	cleanup := up.RegisterControlPoint("authorisation", s.authHook(up))
	defer cleanup()

	// An invalid token is returned after the first authentication step, resulting in the ListServers call
	// returning a 401. Subsequent authentication calls return the correct token so the auth retry does it's job.
	s.badTokens = 1
	_, err := novaClient.ListServers(nil)
	c.Assert(err, gc.IsNil)
}

func (s *localLiveSuite) TestReauthenticateFailure(c *gc.C) {
	novaClient := s.setupClient(c, nil)
	up := s.openstack.Identity.(*identityservice.UserPass)
	cleanup := up.RegisterControlPoint("authorisation", s.authHook(up))
	defer cleanup()

	// If the re-authentication fails, ensure an Unauthorised error is returned.
	s.badTokens = 2
	_, err := novaClient.ListServers(nil)
	c.Assert(errors.IsUnauthorised(err), gc.Equals, true)
}

func (s *localLiveSuite) TestListAvailabilityZonesUnimplemented(c *gc.C) {
	// When the test service has no availability zones registered,
	// the /os-availability-zone API will return 404. We swallow
	// that error.
	s.openstack.Nova.SetAvailabilityZones()
	listedZones, err := s.nova.ListAvailabilityZones()
	c.Assert(err, gc.ErrorMatches, "the server does not support availability zones(.|\n)*")
	c.Assert(listedZones, gc.HasLen, 0)
}

func (s *localLiveSuite) setAvailabilityZones() []nova.AvailabilityZone {
	zones := []nova.AvailabilityZone{
		{Name: "az1"},
		{
			Name: "az2", State: nova.AvailabilityZoneState{Available: true},
		},
	}
	s.openstack.Nova.SetAvailabilityZones(zones...)
	return zones
}

func (s *localLiveSuite) TestListAvailabilityZones(c *gc.C) {
	zones := s.setAvailabilityZones()
	listedZones, err := s.nova.ListAvailabilityZones()
	c.Assert(err, gc.IsNil)
	c.Assert(listedZones, gc.DeepEquals, zones)
}

func (s *localLiveSuite) TestRunServerAvailabilityZone(c *gc.C) {
	s.setAvailabilityZones()
	inst, err := s.runServerAvailabilityZone("az2")
	c.Assert(err, gc.IsNil)
	defer s.nova.DeleteServer(inst.Id)
	server, err := s.nova.GetServer(inst.Id)
	c.Assert(err, gc.IsNil)
	c.Assert(server.AvailabilityZone, gc.Equals, "az2")
}

func (s *localLiveSuite) TestRunServerAvailabilityZoneNotAvailable(c *gc.C) {
	s.setAvailabilityZones()
	// az1 is known, but not currently available.
	_, err := s.runServerAvailabilityZone("az1")
	c.Assert(err, gc.ErrorMatches, "(.|\n)*The requested availability zone is not available(.|\n)*")
}

func (s *localLiveSuite) TestVolumeAttachments(c *gc.C) {
	instance, err := s.createInstance("test-instance")
	c.Assert(err, gc.IsNil)

	// Test attaching a volume.
	volAttachment, err := s.nova.AttachVolume(instance.Id, "volume-id", "/dev/sda1")
	c.Assert(err, gc.IsNil)
	c.Check(volAttachment.ServerId, gc.Equals, instance.Id)
	c.Check(volAttachment.VolumeId, gc.Equals, "volume-id")

	// Test listing volumes.
	volAttachments, err := s.nova.ListVolumeAttachments(instance.Id)
	c.Assert(err, gc.IsNil)
	c.Assert(volAttachments, gc.HasLen, 1)
	c.Check(volAttachments[0].ServerId, gc.Equals, instance.Id)
	c.Check(volAttachments[0].VolumeId, gc.Equals, "volume-id")

	// Test detaching volumes.
	err = s.nova.DetachVolume(instance.Id, volAttachment.Id)
	c.Assert(err, gc.IsNil)
	volAttachments, err = s.nova.ListVolumeAttachments(instance.Id)
	c.Assert(err, gc.IsNil)
	c.Assert(volAttachments, gc.HasLen, 0)

	// Test detaching unattached volume.
	err = s.nova.DetachVolume(instance.Id, volAttachment.Id)
	c.Assert(err, gc.NotNil)
	c.Assert(errors.IsNotFound(err), gc.Equals, true)
}