Port can be created with incorrect name

[mdbooth]

/kind bug

This is from code inspection. In CreatePorts we generate the port's name by index:

cluster-api-provider-openstack/pkg/cloud/services/networking/port.go

Lines 335 to 337 in 654d714

	portName := GetPortName(instanceName, portOpts, i)
	// Events are recorded in CreatePort
	port, err := s.CreatePort(eventObject, clusterName, portName, portOpts, instanceSecurityGroups, iTags)

However, this index is not absolute. It is relative to the number of ports which were previously created:

cluster-api-provider-openstack/controllers/openstackmachine_controller.go

Lines 501 to 512 in 654d714

	desiredPorts := openStackMachine.Status.ReferencedResources.Ports
	portsToCreate := networking.MissingPorts(openStackMachine.Status.DependentResources.Ports, desiredPorts)
	// Sanity check that the number of desired ports is equal to the addition of ports to create and ports that already exist.
	if len(desiredPorts) != len(portsToCreate)+len(openStackMachine.Status.DependentResources.Ports) {
	return fmt.Errorf("length of desired ports (%d) is not equal to the length of ports to create (%d) + the length of ports that already exist (%d)", len(desiredPorts), len(portsToCreate), len(openStackMachine.Status.DependentResources.Ports))
	}
	if len(portsToCreate) > 0 {
	instanceTags := getInstanceTags(openStackMachine, openStackCluster)
	managedSecurityGroups := getManagedSecurityGroups(openStackCluster, machine, openStackMachine)
	machinePortsStatus, err = networkingService.CreatePorts(openStackMachine, clusterName, portsToCreate, managedSecurityGroups, instanceTags, openStackMachine.Name)

This means that if we declare 2 ports, create 1, fail, then create the other one on the next reconcile, they will both get the index 1.

This is not just untidy, it is also something we rely on in port adoption:

cluster-api-provider-openstack/pkg/cloud/services/networking/port.go

Lines 553 to 557 in 654d714

	portName := GetPortName(openStackMachine.Name, portOpts, i)
	ports, err := s.client.ListPort(ports.ListOpts{
	Name: portName,
	NetworkID: port.Network.ID,
	})