Move identifierutil → instance/hostname

Part of the crusade against gratuituous use of `util` package suffix.

The package only contains a single `HostnameFromInstName()` function.

It can't be moved into the `instance` package because that would create
a circular dependency between `instance` and `cidata`.

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

pkg/cidata/cidata.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/docker/go-units"
 	"github.com/lima-vm/lima/pkg/debugutil"
-	"github.com/lima-vm/lima/pkg/identifierutil"
+	instance "github.com/lima-vm/lima/pkg/instance/hostname"
 	"github.com/lima-vm/lima/pkg/iso9660util"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/localpathutil"
@@ -123,7 +123,7 @@ func templateArgs(bootScripts bool, instDir, name string, instConfig *limayaml.L
 		Debug:              debugutil.Debug,
 		BootScripts:        bootScripts,
 		Name:               name,
-		Hostname:           identifierutil.HostnameFromInstName(name), // TODO: support customization
+		Hostname:           instance.HostnameFromInstName(name), // TODO: support customization
 		User:               *instConfig.User.Name,
 		Comment:            *instConfig.User.Comment,
 		Home:               *instConfig.User.Home,

pkg/hostagent/hostagent.go

@@ -31,7 +31,7 @@ import (
 	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
 	"github.com/lima-vm/lima/pkg/hostagent/dns"
 	"github.com/lima-vm/lima/pkg/hostagent/events"
-	"github.com/lima-vm/lima/pkg/identifierutil"
+	instance "github.com/lima-vm/lima/pkg/instance/hostname"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/lima-vm/lima/pkg/osutil"
@@ -288,7 +288,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 	if limayaml.FirstUsernetIndex(a.instConfig) == -1 && *a.instConfig.HostResolver.Enabled {
 		hosts := a.instConfig.HostResolver.Hosts
 		hosts["host.lima.internal"] = networks.SlirpGateway
-		hostname := identifierutil.HostnameFromInstName(a.instName) // TODO: support customization
+		hostname := instance.HostnameFromInstName(a.instName) // TODO: support customization
 		hosts[hostname] = networks.SlirpIPAddress
 		srvOpts := dns.ServerOptions{
 			UDPPort: a.udpDNSLocalPort,

pkg/identifierutil/identifierutil_test.go

@@ -1,10 +1,13 @@
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package identifierutil
+package instance
 
 import "strings"
 
+// HostnameFromInstName generates a hostname from an instance name by prefixing
+// it with "lima-" and replacing all dots and underscores with dashes.
+// E.g. "my_example.com" becomes "lima-my-example-com".
 func HostnameFromInstName(instName string) string {
 	s := strings.ReplaceAll(instName, ".", "-")
 	s = strings.ReplaceAll(s, "_", "-")

pkg/identifierutil/identifierutil.go renamed to pkg/instance/hostname/hostname.go

@@ -0,0 +1,17 @@
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package instance_test
+
+import (
+	"testing"
+
+	instance "github.com/lima-vm/lima/pkg/instance/hostname"
+	"gotest.tools/v3/assert"
+)
+
+func TestHostnameFromInstName(t *testing.T) {
+	assert.Equal(t, instance.HostnameFromInstName("default"), "lima-default")
+	assert.Equal(t, instance.HostnameFromInstName("ubuntu-24.04"), "lima-ubuntu-24-04")
+	assert.Equal(t, instance.HostnameFromInstName("foo_bar.baz"), "lima-foo-bar-baz")
+}

pkg/instance/hostname/hostname_test.go

@@ -24,21 +24,20 @@ import (
 	"github.com/coreos/go-semver/semver"
 	"github.com/docker/go-units"
 	"github.com/goccy/go-yaml"
+	instance "github.com/lima-vm/lima/pkg/instance/hostname"
 	"github.com/lima-vm/lima/pkg/ioutilx"
-	"github.com/lima-vm/lima/pkg/version"
-	"github.com/pbnjay/memory"
-	"github.com/sirupsen/logrus"
-	"golang.org/x/sys/cpu"
-
-	"github.com/lima-vm/lima/pkg/identifierutil"
 	"github.com/lima-vm/lima/pkg/localpathutil"
 	. "github.com/lima-vm/lima/pkg/must"
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/lima-vm/lima/pkg/osutil"
 	"github.com/lima-vm/lima/pkg/ptr"
 	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/store/filenames"
+	"github.com/lima-vm/lima/pkg/version"
 	"github.com/lima-vm/lima/pkg/version/versionutil"
+	"github.com/pbnjay/memory"
+	"github.com/sirupsen/logrus"
+	"golang.org/x/sys/cpu"
 )
 
 const (
@@ -944,7 +943,7 @@ func executeGuestTemplate(format, instDir string, user User, param map[string]st
 		name := filepath.Base(instDir)
 		data := map[string]any{
 			"Name":     name,
-			"Hostname": identifierutil.HostnameFromInstName(name), // TODO: support customization
+			"Hostname": instance.HostnameFromInstName(name), // TODO: support customization
 			"UID":      *user.UID,
 			"User":     *user.Name,
 			"Home":     *user.Home,

pkg/limayaml/defaults.go

@@ -8,7 +8,7 @@ import (
 	"io"
 	"strings"
 
-	"github.com/lima-vm/lima/pkg/identifierutil"
+	instance "github.com/lima-vm/lima/pkg/instance/hostname"
 )
 
 // FormatT specifies the format type.
@@ -42,11 +42,11 @@ const (
 	//	  Port 60022
 	FormatConfig = FormatT("config")
 
-// TODO: consider supporting "url" format (ssh://USER@HOSTNAME:PORT)
-//
-// TODO: consider supporting "json" format
-// It is unclear whether we can just map ssh "config" into JSON, as "config" has duplicated keys.
-// (JSON supports duplicated keys too, but not all JSON implementations expect JSON with duplicated keys)
+	// TODO: consider supporting "url" format (ssh://USER@HOSTNAME:PORT).
+	//
+	// TODO: consider supporting "json" format.
+	// It is unclear whether we can just map ssh "config" into JSON, as "config" has duplicated keys.
+	// (JSON supports duplicated keys too, but not all JSON implementations expect JSON with duplicated keys).
 )
 
 // Formats is the list of the supported formats.
@@ -62,7 +62,7 @@ func quoteOption(o string) string {
 
 // Format formats the ssh options.
 func Format(w io.Writer, sshPath, instName string, format FormatT, opts []string) error {
-	fakeHostname := identifierutil.HostnameFromInstName(instName) // TODO: support customization
+	fakeHostname := instance.HostnameFromInstName(instName) // TODO: support customization
 	switch format {
 	case FormatCmd:
 		args := []string{sshPath}

pkg/sshutil/format.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/docker/go-units"
 	hostagentclient "github.com/lima-vm/lima/pkg/hostagent/api/client"
-	"github.com/lima-vm/lima/pkg/identifierutil"
+	instancehostname "github.com/lima-vm/lima/pkg/instance/hostname"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/store/filenames"
@@ -73,7 +73,7 @@ func Inspect(instName string) (*Instance, error) {
 	inst := &Instance{
 		Name: instName,
 		// TODO: support customizing hostname
-		Hostname: identifierutil.HostnameFromInstName(instName),
+		Hostname: instancehostname.HostnameFromInstName(instName),
 		Status:   StatusUnknown,
 	}
 	// InstanceDir validates the instName but does not check whether the instance exists