Merge pull request #19 from cloudbase/revert-17-lower-case-fqnd

Revert "Allow forcing lower case runner names"

Author: gabriel-samfira

config/config.go

@@ -118,9 +118,6 @@ type Incus struct {
 
 	// InstanceType allows you to choose between a virtual machine and a container
 	InstanceType IncusImageType `toml:"instance_type" json:"instance-type"`
-
-	// UseLowerCaseHostnames makes the runner name all lowercase before sending it to incus.
-	UseLowerCaseHostnames bool `toml:"use_lowercase_hostnames" json:"use_lowercase_hostnames"`
 }
 
 func (l *Incus) GetInstanceType() IncusImageType {

provider/incus.go

@@ -18,7 +18,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"strings"
 	"sync"
 	"time"
 
@@ -54,9 +53,6 @@ const (
 	// architecture a runner is supposed to have. This value is defined in the pool and
 	// passed into the provider as bootstrap params.
 	osArchKeyNAme = "user.os-arch"
-
-	// runnerInstanceName is the ID of the runner in GRAM.
-	runnerInstanceKeyName = "user.runner-name"
 )
 
 var (
@@ -234,23 +230,17 @@ func (l *Incus) getCreateInstanceArgs(ctx context.Context, bootstrapParams commo
 	}
 
 	configMap := map[string]string{
-		"user.user-data":      cloudCfg,
-		osTypeKeyName:         string(bootstrapParams.OSType),
-		osArchKeyNAme:         string(bootstrapParams.OSArch),
-		controllerIDKeyName:   l.controllerID,
-		poolIDKey:             bootstrapParams.PoolID,
-		runnerInstanceKeyName: bootstrapParams.Name,
+		"user.user-data":    cloudCfg,
+		osTypeKeyName:       string(bootstrapParams.OSType),
+		osArchKeyNAme:       string(bootstrapParams.OSArch),
+		controllerIDKeyName: l.controllerID,
+		poolIDKey:           bootstrapParams.PoolID,
 	}
 
 	if instanceType == config.IncusImageVirtualMachine {
 		configMap["security.secureboot"] = l.secureBootEnabled()
 	}
 
-	instanceName := bootstrapParams.Name
-	if specs.UseLowerCaseHostnames {
-		instanceName = strings.ToLower(instanceName)
-	}
-
 	args := api.InstancesPost{
 		InstancePut: api.InstancePut{
 			Architecture: arch,
@@ -259,7 +249,7 @@ func (l *Incus) getCreateInstanceArgs(ctx context.Context, bootstrapParams commo
 			Config:       configMap,
 		},
 		Source: instanceSource,
-		Name:   instanceName,
+		Name:   bootstrapParams.Name,
 		Type:   api.InstanceType(instanceType),
 	}
 	return args, nil
@@ -331,16 +321,6 @@ func (l *Incus) GetInstance(ctx context.Context, instanceName string) (commonPar
 		return commonParams.ProviderInstance{}, errors.Wrap(err, "fetching client")
 	}
 	instance, _, err := cli.GetInstanceFull(instanceName)
-	if err == nil {
-		return incusInstanceToAPIInstance(instance), nil
-	}
-
-	if !isNotFoundError(err) {
-		return commonParams.ProviderInstance{}, errors.Wrap(err, "fetching instance")
-	}
-
-	asLower := strings.ToLower(instanceName)
-	instance, _, err = cli.GetInstanceFull(asLower)
 	if err != nil {
 		if isNotFoundError(err) {
 			return commonParams.ProviderInstance{}, errors.Wrapf(runnerErrors.ErrNotFound, "fetching instance: %q", err)

provider/incus_test.go

@@ -17,7 +17,6 @@ package provider
 
 import (
 	"context"
-	"encoding/json"
 	"testing"
 
 	commonParams "github.com/cloudbase/garm-provider-common/params"
@@ -185,12 +184,11 @@ func TestGetCreateInstanceArgsContainer(t *testing.T) {
 					Profiles:     []string{"default", "container"},
 					Description:  "Github runner provisioned by garm",
 					Config: map[string]string{
-						"user.user-data":      `#cloud-config`,
-						osTypeKeyName:         "linux",
-						osArchKeyNAme:         "amd64",
-						controllerIDKeyName:   "controller",
-						poolIDKey:             "default",
-						runnerInstanceKeyName: "test-instance",
+						"user.user-data":    `#cloud-config`,
+						osTypeKeyName:       "linux",
+						osArchKeyNAme:       "amd64",
+						controllerIDKeyName: "controller",
+						poolIDKey:           "default",
 					},
 				},
 				Source: api.InstanceSource{
@@ -261,6 +259,7 @@ func TestGetCreateInstanceArgsVM(t *testing.T) {
 	cli.On("GetImageAliasArchitectures", config.IncusImageType("virtual-machine").String(), "windows").Return(aliases, nil)
 	cli.On("GetImage", aliases["x86_64"].Target).Return(&api.Image{Fingerprint: "123abc"}, "", nil)
 	cli.On("GetProfileNames").Return([]string{"default", "virtual-machine"}, nil)
+	specs := extraSpecs{}
 	tests := []struct {
 		name            string
 		bootstrapParams commonParams.BootstrapInstance
@@ -276,7 +275,7 @@ func TestGetCreateInstanceArgsVM(t *testing.T) {
 		{
 			name: "success vm instance",
 			bootstrapParams: commonParams.BootstrapInstance{
-				Name:    "test-InStAnCe",
+				Name:    "test-instance",
 				Tools:   tools,
 				Image:   "windows",
 				Flavor:  "virtual-machine",
@@ -285,43 +284,6 @@ func TestGetCreateInstanceArgsVM(t *testing.T) {
 				OSArch:  commonParams.Amd64,
 				OSType:  commonParams.Windows,
 			},
-			expected: api.InstancesPost{
-				Name: "test-InStAnCe",
-				InstancePut: api.InstancePut{
-					Architecture: "x86_64",
-					Profiles:     []string{"default", "virtual-machine"},
-					Description:  "Github runner provisioned by garm",
-					Config: map[string]string{
-						"user.user-data":      "#ps1_sysnative\n" + "#cloud-config",
-						osTypeKeyName:         "windows",
-						osArchKeyNAme:         "amd64",
-						controllerIDKeyName:   "controller",
-						poolIDKey:             "default",
-						runnerInstanceKeyName: "test-InStAnCe",
-						"security.secureboot": "false",
-					},
-				},
-				Source: api.InstanceSource{
-					Type:        "image",
-					Fingerprint: "123abc",
-				},
-				Type: "virtual-machine",
-			},
-			errString: "",
-		},
-		{
-			name: "success vm instance with lower case name",
-			bootstrapParams: commonParams.BootstrapInstance{
-				Name:       "test-InStAnCe",
-				Tools:      tools,
-				Image:      "windows",
-				Flavor:     "virtual-machine",
-				RepoURL:    "mock-repo-url",
-				PoolID:     "default",
-				OSArch:     commonParams.Amd64,
-				OSType:     commonParams.Windows,
-				ExtraSpecs: json.RawMessage(`{"use_lowercase_hostnames": true}`),
-			},
 			expected: api.InstancesPost{
 				Name: "test-instance",
 				InstancePut: api.InstancePut{
@@ -334,7 +296,6 @@ func TestGetCreateInstanceArgsVM(t *testing.T) {
 						osArchKeyNAme:         "amd64",
 						controllerIDKeyName:   "controller",
 						poolIDKey:             "default",
-						runnerInstanceKeyName: "test-InStAnCe",
 						"security.secureboot": "false",
 					},
 				},
@@ -350,9 +311,6 @@ func TestGetCreateInstanceArgsVM(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			specs, err := parseExtraSpecsFromBootstrapParams(tt.bootstrapParams)
-			require.NoError(t, err)
-
 			ret, err := l.getCreateInstanceArgs(ctx, tt.bootstrapParams, specs)
 			if tt.errString != "" {
 				require.Error(t, err)

provider/specs.go

@@ -26,10 +26,9 @@ import (
 )
 
 type extraSpecs struct {
-	ExtraPackages         []string `json:"extra_packages,omitempty" jsonschema:"description=A list of packages that cloud-init should install on the instance."`
-	DisableUpdates        bool     `json:"disable_updates,omitempty" jsonschema:"description=Whether to disable updates when cloud-init comes online."`
-	EnableBootDebug       bool     `json:"enable_boot_debug,omitempty" jsonschema:"description=Allows providers to set the -x flag in the runner install script."`
-	UseLowerCaseHostnames bool     `json:"use_lowercase_hostnames,omitempty" jsonschema:"description=Instructs the provider to make the hostname of the runner all lowercase."`
+	ExtraPackages   []string `json:"extra_packages,omitempty" jsonschema:"description=A list of packages that cloud-init should install on the instance."`
+	DisableUpdates  bool     `json:"disable_updates,omitempty" jsonschema:"description=Whether to disable updates when cloud-init comes online."`
+	EnableBootDebug bool     `json:"enable_boot_debug,omitempty" jsonschema:"description=Allows providers to set the -x flag in the runner install script."`
 	cloudconfig.CloudConfigSpec
 }
 

provider/specs_test.go

@@ -33,12 +33,11 @@ var testCases = []struct {
 }{
 	{
 		name:  "full specs",
-		input: json.RawMessage(`{"use_lowercase_hostnames": false, "disable_updates": true, "extra_packages": ["package1", "package2"], "enable_boot_debug": true, "runner_install_template": "IyEvYmluL2Jhc2gKZWNobyBJbnN0YWxsaW5nIHJ1bm5lci4uLg==", "pre_install_scripts": {"setup.sh": "IyEvYmluL2Jhc2gKZWNobyBTZXR1cCBzY3JpcHQuLi4="}, "extra_context": {"key": "value"}}`),
+		input: json.RawMessage(`{"disable_updates": true, "extra_packages": ["package1", "package2"], "enable_boot_debug": true, "runner_install_template": "IyEvYmluL2Jhc2gKZWNobyBJbnN0YWxsaW5nIHJ1bm5lci4uLg==", "pre_install_scripts": {"setup.sh": "IyEvYmluL2Jhc2gKZWNobyBTZXR1cCBzY3JpcHQuLi4="}, "extra_context": {"key": "value"}}`),
 		expectedOutput: extraSpecs{
-			DisableUpdates:        true,
-			ExtraPackages:         []string{"package1", "package2"},
-			EnableBootDebug:       true,
-			UseLowerCaseHostnames: false,
+			DisableUpdates:  true,
+			ExtraPackages:   []string{"package1", "package2"},
+			EnableBootDebug: true,
 			CloudConfigSpec: cloudconfig.CloudConfigSpec{
 				RunnerInstallTemplate: []byte("#!/bin/bash\necho Installing runner..."),
 				PreInstallScripts: map[string][]byte{

provider/util.go

@@ -66,15 +66,12 @@ func incusInstanceToAPIInstance(instance *api.InstanceFull) commonParams.Provide
 	incusOS := instance.ExpandedConfig["image.os"]
 
 	osType, _ := util.OSToOSType(incusOS)
+
 	if osType == "" {
 		osTypeFromTag := instance.ExpandedConfig[osTypeKeyName]
 		osType = commonParams.OSType(osTypeFromTag)
 	}
 	osRelease := instance.ExpandedConfig["image.release"]
-	runnerName := instance.Name
-	if instance.ExpandedConfig[runnerInstanceKeyName] != "" {
-		runnerName = instance.ExpandedConfig[runnerInstanceKeyName]
-	}
 
 	state := instance.State
 	addresses := []commonParams.Address{}
@@ -96,7 +93,7 @@ func incusInstanceToAPIInstance(instance *api.InstanceFull) commonParams.Provide
 	return commonParams.ProviderInstance{
 		OSArch:     instanceArch,
 		ProviderID: instance.Name,
-		Name:       runnerName,
+		Name:       instance.Name,
 		OSType:     osType,
 		OSName:     strings.ToLower(incusOS),
 		OSVersion:  osRelease,