github.com/juju/juju@v0.0.0-20240430160146-1752b71fcf00/provider/oci/common_integration_test.go

// Copyright 2018 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

package oci_test

import (
	"context"
	stdcontext "context"
	"fmt"
	"time"

	"github.com/juju/clock/testclock"
	gitjujutesting "github.com/juju/testing"
	jc "github.com/juju/testing/checkers"
	"github.com/juju/version/v2"
	ociCore "github.com/oracle/oci-go-sdk/v65/core"
	ociIdentity "github.com/oracle/oci-go-sdk/v65/identity"
	gomock "go.uber.org/mock/gomock"
	gc "gopkg.in/check.v1"

	"github.com/juju/juju/core/arch"
	"github.com/juju/juju/environs"
	environscloudspec "github.com/juju/juju/environs/cloudspec"
	"github.com/juju/juju/environs/config"
	"github.com/juju/juju/environs/tags"
	"github.com/juju/juju/provider/oci"
	ocitesting "github.com/juju/juju/provider/oci/testing"
	jujutesting "github.com/juju/juju/testing"
	"github.com/juju/juju/tools"
)

var clk = testclock.NewClock(time.Time{})
var advancingClock = testclock.AutoAdvancingClock{clk, clk.Advance}

func makeToolsList(series string) tools.List {
	var toolsVersion version.Binary
	toolsVersion.Number = version.MustParse("2.4.0")
	toolsVersion.Arch = arch.AMD64
	toolsVersion.Release = series
	return tools.List{{
		Version: toolsVersion,
		URL:     fmt.Sprintf("http://example.com/tools/juju-%s.tgz", toolsVersion),
		SHA256:  "1234567890abcdef",
		Size:    1024,
	}}
}

func makeListSecurityListsRequestResponse(seclistDetails []ociCore.SecurityList) (ociCore.ListSecurityListsRequest, ociCore.ListSecurityListsResponse) {
	if len(seclistDetails) == 0 {
		return ociCore.ListSecurityListsRequest{}, ociCore.ListSecurityListsResponse{}
	}

	compartment := seclistDetails[0].CompartmentId
	vcnId := seclistDetails[0].VcnId
	request := ociCore.ListSecurityListsRequest{
		CompartmentId: compartment,
		VcnId:         vcnId,
	}
	response := ociCore.ListSecurityListsResponse{
		Items: seclistDetails,
	}

	return request, response
}

func makeListInternetGatewaysRequestResponse(gwDetails []ociCore.InternetGateway) (ociCore.ListInternetGatewaysRequest, ociCore.ListInternetGatewaysResponse) {
	if len(gwDetails) == 0 {
		return ociCore.ListInternetGatewaysRequest{}, ociCore.ListInternetGatewaysResponse{}
	}

	compartment := gwDetails[0].CompartmentId
	vcnId := gwDetails[0].VcnId
	request := ociCore.ListInternetGatewaysRequest{
		CompartmentId: compartment,
		VcnId:         vcnId,
	}
	response := ociCore.ListInternetGatewaysResponse{
		Items: gwDetails,
	}
	return request, response
}

func makeListRouteTableRequestResponse(routeDetails []ociCore.RouteTable) (ociCore.ListRouteTablesRequest, ociCore.ListRouteTablesResponse) {
	if len(routeDetails) == 0 {
		return ociCore.ListRouteTablesRequest{}, ociCore.ListRouteTablesResponse{}
	}

	compartment := routeDetails[0].CompartmentId
	vcnId := routeDetails[0].VcnId

	request := ociCore.ListRouteTablesRequest{
		CompartmentId: compartment,
		VcnId:         vcnId,
	}
	response := ociCore.ListRouteTablesResponse{
		Items: routeDetails,
	}
	return request, response
}

func makeListInstancesRequestResponse(instances []ociCore.Instance) (ociCore.ListInstancesRequest, ociCore.ListInstancesResponse) {

	if len(instances) == 0 {
		return ociCore.ListInstancesRequest{}, ociCore.ListInstancesResponse{}
	}

	compartment := instances[0].CompartmentId

	request := ociCore.ListInstancesRequest{
		CompartmentId: compartment,
	}

	response := ociCore.ListInstancesResponse{
		Items: instances,
	}

	return request, response
}

func makeListAvailabilityDomainsRequestResponse(azDetails []ociIdentity.AvailabilityDomain) (ociIdentity.ListAvailabilityDomainsRequest, ociIdentity.ListAvailabilityDomainsResponse) {
	if len(azDetails) == 0 {
		return ociIdentity.ListAvailabilityDomainsRequest{}, ociIdentity.ListAvailabilityDomainsResponse{}
	}

	compartment := azDetails[0].CompartmentId
	request := ociIdentity.ListAvailabilityDomainsRequest{
		CompartmentId: compartment,
	}

	response := ociIdentity.ListAvailabilityDomainsResponse{
		Items: azDetails,
	}
	return request, response
}

func makeGetVnicRequestResponse(vnicDetails []ociCore.GetVnicResponse) ([]ociCore.GetVnicRequest, []ociCore.GetVnicResponse) {
	requests := make([]ociCore.GetVnicRequest, len(vnicDetails))
	responses := make([]ociCore.GetVnicResponse, len(vnicDetails))

	for idx, val := range vnicDetails {
		requests[idx] = ociCore.GetVnicRequest{
			VnicId: val.Id,
		}

		responses[idx] = val
	}

	return requests, responses
}

func newFakeOCIInstance(Id, compartment string, state ociCore.InstanceLifecycleStateEnum) *ociCore.Instance {
	return &ociCore.Instance{
		AvailabilityDomain: makeStringPointer("fake-az"),
		Id:                 &Id,
		CompartmentId:      &compartment,
		Region:             makeStringPointer("us-phoenix-1"),
		Shape:              makeStringPointer("VM.Standard1.1"),
		DisplayName:        makeStringPointer("fakeName"),
		FreeformTags:       map[string]string{},
		LifecycleState:     state,
	}
}

func makeGetInstanceRequestResponse(instanceDetails ociCore.Instance) (ociCore.GetInstanceRequest, ociCore.GetInstanceResponse) {
	request := ociCore.GetInstanceRequest{
		InstanceId: instanceDetails.Id,
	}

	response := ociCore.GetInstanceResponse{
		Instance: instanceDetails,
	}

	return request, response
}

func makeListVnicAttachmentsRequestResponse(vnicAttachDetails []ociCore.VnicAttachment) (ociCore.ListVnicAttachmentsRequest, ociCore.ListVnicAttachmentsResponse) {
	if len(vnicAttachDetails) == 0 {
		return ociCore.ListVnicAttachmentsRequest{}, ociCore.ListVnicAttachmentsResponse{}
	}
	compartment := vnicAttachDetails[0].CompartmentId
	instanceID := vnicAttachDetails[0].InstanceId

	request := ociCore.ListVnicAttachmentsRequest{
		CompartmentId: compartment,
		InstanceId:    instanceID,
	}

	response := ociCore.ListVnicAttachmentsResponse{
		Items: vnicAttachDetails,
	}
	return request, response
}

func listShapesResponse() []ociCore.Shape {
	return []ociCore.Shape{
		{
			Shape:                    makeStringPointer("VM.Standard1.1"),
			ProcessorDescription:     makeStringPointer("2.0 GHz Intel® Xeon® Platinum 8167M (Skylake)"),
			Ocpus:                    makeFloat32Pointer(1),
			MemoryInGBs:              makeFloat32Pointer(7),
			LocalDisks:               makeIntPointer(0),
			LocalDisksTotalSizeInGBs: (*float32)(nil),
			PlatformConfigOptions: &ociCore.ShapePlatformConfigOptions{
				Type: "INTEL_VM",
			},
			IsBilledForStoppedInstance: makeBoolPointer(false),
			BillingType:                "PAID",
		},
		{
			Shape:                      makeStringPointer("VM.GPU.A10.1"),
			ProcessorDescription:       makeStringPointer("2.6 GHz Intel® Xeon® Platinum 8358 (Ice Lake)"),
			Ocpus:                      makeFloat32Pointer(15),
			MemoryInGBs:                makeFloat32Pointer(240),
			Gpus:                       makeIntPointer(1),
			GpuDescription:             makeStringPointer("NVIDIA® A10"),
			LocalDisks:                 makeIntPointer(0),
			LocalDisksTotalSizeInGBs:   (*float32)(nil),
			PlatformConfigOptions:      (*ociCore.ShapePlatformConfigOptions)(nil),
			IsBilledForStoppedInstance: makeBoolPointer(false),
			BillingType:                "PAID",
		},
		{
			Shape:                      makeStringPointer("BM.Standard.A1.160"),
			ProcessorDescription:       makeStringPointer("3.0 GHz Ampere® Altra™"),
			Ocpus:                      makeFloat32Pointer(160),
			MemoryInGBs:                makeFloat32Pointer(1024),
			LocalDisks:                 makeIntPointer(0),
			LocalDisksTotalSizeInGBs:   (*float32)(nil),
			PlatformConfigOptions:      (*ociCore.ShapePlatformConfigOptions)(nil),
			IsBilledForStoppedInstance: makeBoolPointer(false),
			BillingType:                "PAID",
		},
		{
			Shape:                makeStringPointer("VM.Standard.A1.Flex"),
			ProcessorDescription: makeStringPointer("3.0 GHz Ampere® Altra™"),
			OcpuOptions: &ociCore.ShapeOcpuOptions{
				Max: makeFloat32Pointer(80),
			},
			MemoryOptions: &ociCore.ShapeMemoryOptions{
				MaxInGBs: makeFloat32Pointer(512),
			},
			Ocpus:                      makeFloat32Pointer(1),
			MemoryInGBs:                makeFloat32Pointer(6),
			LocalDisks:                 makeIntPointer(0),
			LocalDisksTotalSizeInGBs:   (*float32)(nil),
			PlatformConfigOptions:      (*ociCore.ShapePlatformConfigOptions)(nil),
			IsBilledForStoppedInstance: makeBoolPointer(false),
			BillingType:                "LIMITED_FREE",
		},
		{
			Shape:                makeStringPointer("VM.Standard3.Flex"),
			ProcessorDescription: makeStringPointer("2.0 GHz Intel® Xeon® Platinum 8167M (Skylake)"),
			OcpuOptions: &ociCore.ShapeOcpuOptions{
				Max: makeFloat32Pointer(32),
			},
			MemoryOptions: &ociCore.ShapeMemoryOptions{
				MaxInGBs: makeFloat32Pointer(512),
			},
			Ocpus:                      makeFloat32Pointer(1),
			MemoryInGBs:                makeFloat32Pointer(6),
			LocalDisks:                 makeIntPointer(0),
			LocalDisksTotalSizeInGBs:   (*float32)(nil),
			PlatformConfigOptions:      (*ociCore.ShapePlatformConfigOptions)(nil),
			IsBilledForStoppedInstance: makeBoolPointer(false),
			BillingType:                "LIMITED_FREE",
		},
	}
}

type commonSuite struct {
	gitjujutesting.IsolationSuite

	testInstanceID  string
	testCompartment string
	controllerUUID  string

	ident   *ocitesting.MockIdentityClient
	compute *ocitesting.MockComputeClient
	netw    *ocitesting.MockNetworkingClient
	fw      *ocitesting.MockFirewallClient
	storage *ocitesting.MockStorageClient

	env         *oci.Environ
	provider    environs.EnvironProvider
	spec        environscloudspec.CloudSpec
	config      *config.Config
	ociInstance *ociCore.Instance
	tags        map[string]string
	ctrlTags    map[string]string
}

func (s *commonSuite) SetUpTest(c *gc.C) {
	s.IsolationSuite.SetUpTest(c)
	oci.SetImageCache(&oci.ImageCache{})

	s.controllerUUID = jujutesting.ControllerTag.Id()
	s.testInstanceID = "ocid1.instance.oc1.phx.abyhqljt4bl4i76iforb7wczlc4qmmmrmzvngeyzi2n45bxsee7a11rukjla"
	s.testCompartment = "ocid1.compartment.oc1..aaaaaaaaakr75vvb5yx4nkm7ag7ekvluap7afa2y4zprswuprcnehqecwqga"

	s.provider = &oci.EnvironProvider{}
	s.spec = fakeCloudSpec()

	config := newConfig(c, jujutesting.Attrs{"compartment-id": s.testCompartment})
	env, err := environs.Open(stdcontext.TODO(), s.provider, environs.OpenParams{
		Cloud:  s.spec,
		Config: config,
	})
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(env, gc.NotNil)

	s.config = config
	s.env = env.(*oci.Environ)
	s.env.SetClock(&advancingClock)

	s.ociInstance = newFakeOCIInstance(s.testInstanceID, s.testCompartment, ociCore.InstanceLifecycleStateRunning)
	s.tags = map[string]string{
		tags.JujuController: s.controllerUUID,
		tags.JujuModel:      config.UUID(),
	}
	s.ctrlTags = map[string]string{
		tags.JujuController:   s.controllerUUID,
		tags.JujuModel:        s.config.UUID(),
		tags.JujuIsController: "true",
	}
	s.ociInstance.FreeformTags = s.tags
}

func (e *commonSuite) setupListInstancesExpectations(instanceId string, state ociCore.InstanceLifecycleStateEnum, times int) {
	listInstancesRequest, listInstancesResponse := makeListInstancesRequestResponse(
		[]ociCore.Instance{
			{
				AvailabilityDomain: makeStringPointer("fakeZone1"),
				CompartmentId:      &e.testCompartment,
				Id:                 makeStringPointer(instanceId),
				LifecycleState:     state,
				Region:             makeStringPointer("us-phoenix-1"),
				Shape:              makeStringPointer("VM.Standard1.1"),
				DisplayName:        makeStringPointer("fakeName"),
				FreeformTags:       e.tags,
			},
		},
	)
	expect := e.compute.EXPECT().ListInstances(
		context.Background(), listInstancesRequest.CompartmentId).Return(
		listInstancesResponse.Items, nil)
	if times == 0 {
		expect.AnyTimes()
	} else {
		expect.Times(times)
	}
}

func (s *commonSuite) patchEnv(c *gc.C) *gomock.Controller {
	ctrl := gomock.NewController(c)
	s.compute = ocitesting.NewMockComputeClient(ctrl)
	s.ident = ocitesting.NewMockIdentityClient(ctrl)
	s.netw = ocitesting.NewMockNetworkingClient(ctrl)
	s.fw = ocitesting.NewMockFirewallClient(ctrl)
	s.storage = ocitesting.NewMockStorageClient(ctrl)

	s.env.Compute = s.compute
	s.env.Networking = s.netw
	s.env.Firewall = s.fw
	s.env.Storage = s.storage
	s.env.Identity = s.ident

	return ctrl
}