feat: add Linux support

Makefile

@@ -22,12 +22,11 @@ LIMA_EXTENSION := .tar.gz
 LIMA_VDE_SUDOERS_FILE := /etc/sudoers.d/finch-lima
 # Final installation prefix for vde created by CLI after installation, only used in uninstall step
 VDE_INSTALL ?= /opt/finch
-UNAME := $(shell uname -m)
-ARCH ?= $(UNAME)
+ARCH ?= $(shell uname -m)
 SUPPORTED_ARCH = false
 LICENSEDIR := $(OUTDIR)/license-files
 VERSION ?= $(shell git describe --match 'v[0-9]*' --dirty='.modified' --always --tags)
-GITCOMMIT := $(shell git rev-parse HEAD)$(shell test -z "$(git status --porcelain)" || echo .m)
+GITCOMMIT ?= $(shell git rev-parse HEAD)$(shell test -z "$(git status --porcelain)" || echo .m)
 LDFLAGS = "-w -X $(PACKAGE)/pkg/version.Version=$(VERSION) -X $(PACKAGE)/pkg/version.GitCommit=$(GITCOMMIT)"
 MIN_MACOS_VERSION ?= 11.0
 
@@ -52,16 +51,29 @@ endif
 arch-test:
 	@if [ $(SUPPORTED_ARCH) != "true" ]; then echo "Unsupported architecture: $(ARCH)"; exit "1"; fi
 
+# OS will be set on Windows (to Windows_NT), and undefined otherwise unless
+# it is explicity specified on the commandline.
+# On Unix (or, not-Windows), query OS and set it using uname -s
 BUILD_OS ?= $(OS)
+ifeq ($(BUILD_OS),)
+BUILD_OS = $(shell uname -s)
+endif
+
 FINCH_CORE_DIR := $(CURDIR)/deps/finch-core
+
+remote-all: arch-test finch install.finch-core-dependencies finch.yaml networks.yaml config.yaml
+
 ifeq ($(BUILD_OS), Windows_NT)
 include Makefile.windows
-else
+all: remote-all
+else ifeq ($(BUILD_OS), Darwin)
 include Makefile.darwin
+all: remote-all
+else ifeq ($(BUILD_OS), Linux)
+# on Linux, we only need to build "finch"
+all: finch
 endif
 
-all: arch-test finch install.finch-core-dependencies finch.yaml networks.yaml config.yaml
-
 .PHONY: install.finch-core-dependencies
 install.finch-core-dependencies:
 	OUTDIR=$(OUTDIR) ARCH=$(ARCH) "$(MAKE)" -C $(FINCH_CORE_DIR) install.dependencies
@@ -106,11 +118,13 @@ uninstall: uninstall.finch
 
 .PHONY: finch
 ifeq ($(GOOS),windows)
-finch: finch-windows finch-general
+finch: finch-windows finch-all
 else ifeq ($(GOOS),darwin)
 finch: finch-macos
+else ifeq ($(NATIVE_BUILD),true)
+finch: finch-native
 else
-finch: finch-unix
+finch: finch-all
 endif
 
 finch-windows:
@@ -121,10 +135,13 @@ finch-macos: export CGO_CFLAGS := -mmacosx-version-min=$(MIN_MACOS_VERSION)
 finch-macos: export CGO_LDFLAGS := -mmacosx-version-min=$(MIN_MACOS_VERSION)
 finch-macos: finch-unix
 
-finch-unix: finch-general
+finch-unix: finch-all
+
+finch-native: GO_BUILD_TAGS += native
+finch-native: finch-all
 
-finch-general:
-	$(GO) build -ldflags $(LDFLAGS) -o $(OUTDIR)/bin/$(BINARYNAME) $(PACKAGE)/cmd/finch
+finch-all:
+	$(GO) build -ldflags $(LDFLAGS) -tags "$(GO_BUILD_TAGS)" -o $(OUTDIR)/bin/$(BINARYNAME) $(PACKAGE)/cmd/finch
 
 .PHONY: release
 release: check-licenses all download-licenses

cmd/finch/main.go

@@ -17,11 +17,8 @@ import (
 	"github.com/runfinch/finch/pkg/config"
 	"github.com/runfinch/finch/pkg/flog"
 	"github.com/runfinch/finch/pkg/fmemory"
-	"github.com/runfinch/finch/pkg/lima/wrapper"
 	"github.com/runfinch/finch/pkg/path"
-	"github.com/runfinch/finch/pkg/support"
 	"github.com/runfinch/finch/pkg/system"
-	"github.com/runfinch/finch/pkg/version"
 )
 
 const finchRootCmd = "finch"
@@ -83,77 +80,14 @@ func xmain(logger flog.Logger,
 	).Execute()
 }
 
-var newApp = func(
-	logger flog.Logger,
-	fp path.Finch,
-	fs afero.Fs,
-	fc *config.Finch,
-	stdOut io.Writer,
-	home,
-	finchRootPath string,
-	ecc command.Creator,
-) *cobra.Command {
-	usage := fmt.Sprintf("%v <command>", finchRootCmd)
-	rootCmd := &cobra.Command{
-		Use:           usage,
-		Short:         "Finch: open-source container development tool",
-		SilenceUsage:  true,
-		SilenceErrors: true,
-		Version:       version.Version,
-	}
-	// TODO: Decide when to forward --debug to the dependencies
-	// (e.g. nerdctl for container commands and limactl for VM commands).
-	rootCmd.PersistentFlags().Bool("debug", false, "running under debug mode")
-	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, _ []string) error {
-		// running commands under debug mode will print out debug logs
-		debugMode, _ := cmd.Flags().GetBool("debug")
-		if debugMode {
-			logger.SetLevel(flog.Debug)
-		}
-		return nil
-	}
-
-	lcc := command.NewLimaCmdCreator(ecc,
-		logger,
-		fp.LimaHomePath(),
-		fp.LimactlPath(),
-		fp.QEMUBinDir(),
-		system.NewStdLib(),
-	)
-	lima := wrapper.NewLimaWrapper()
-	supportBundleBuilder := support.NewBundleBuilder(
-		logger,
-		fs,
-		support.NewBundleConfig(fp, finchRootPath),
-		fp,
-		ecc,
-		lcc,
-		lima,
-	)
-
-	// append nerdctl commands
-	allCommands := initializeNerdctlCommands(lcc, ecc, logger, fs, fc)
-	// append finch specific commands
-	allCommands = append(allCommands,
-		newVersionCommand(lcc, logger, stdOut),
-		virtualMachineCommands(logger, fp, lcc, ecc, fs, fc, home, finchRootPath),
-		newSupportBundleCommand(logger, supportBundleBuilder, lcc),
-		newGenDocsCommand(rootCmd, logger, fs, system.NewStdLib()),
-	)
-
-	rootCmd.AddCommand(allCommands...)
-
-	return rootCmd
-}
-
 func initializeNerdctlCommands(
-	lcc command.LimaCmdCreator,
+	ncc command.NerdctlCmdCreator,
 	ecc command.Creator,
 	logger flog.Logger,
 	fs afero.Fs,
 	fc *config.Finch,
 ) []*cobra.Command {
-	nerdctlCommandCreator := newNerdctlCommandCreator(lcc, ecc, system.NewStdLib(), logger, fs, fc)
+	nerdctlCommandCreator := newNerdctlCommandCreator(ncc, ecc, system.NewStdLib(), logger, fs, fc)
 	var allNerdctlCommands []*cobra.Command
 	for cmdName, cmdDescription := range nerdctlCmds {
 		allNerdctlCommands = append(allNerdctlCommands, nerdctlCommandCreator.create(cmdName, cmdDescription))

cmd/finch/main_darwin.go

@@ -23,7 +23,7 @@ func dependencies(
 	fc *config.Finch,
 	fp path.Finch,
 	fs afero.Fs,
-	lcc command.LimaCmdCreator,
+	ncc command.NerdctlCmdCreator,
 	logger flog.Logger,
 	finchRootPath string,
 ) []*dependency.Group {
@@ -37,6 +37,6 @@ func dependencies(
 			finchRootPath,
 			system.NewStdLib().Arch(),
 		),
-		vmnet.NewDependencyGroup(ecc, lcc, fs, fp, logger),
+		vmnet.NewDependencyGroup(ecc, ncc, fs, fp, logger),
 	}
 }

cmd/finch/main_native.go

@@ -0,0 +1,85 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build linux
+
+package main
+
+import (
+	"fmt"
+	"io"
+
+	"github.com/spf13/afero"
+	"github.com/spf13/cobra"
+
+	"github.com/runfinch/finch/pkg/command"
+	"github.com/runfinch/finch/pkg/config"
+	"github.com/runfinch/finch/pkg/flog"
+	"github.com/runfinch/finch/pkg/lima/wrapper"
+	"github.com/runfinch/finch/pkg/path"
+	"github.com/runfinch/finch/pkg/support"
+	"github.com/runfinch/finch/pkg/system"
+	"github.com/runfinch/finch/pkg/version"
+)
+
+var newApp = func(
+	logger flog.Logger,
+	fp path.Finch,
+	fs afero.Fs,
+	fc *config.Finch,
+	stdOut io.Writer,
+	_,
+	finchRootPath string,
+	ecc command.Creator,
+) *cobra.Command {
+	usage := fmt.Sprintf("%v <command>", finchRootCmd)
+	rootCmd := &cobra.Command{
+		Use:           usage,
+		Short:         "Finch: open-source container development tool",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+		Version:       version.Version,
+	}
+	// TODO: Decide when to forward --debug to the dependencies
+	// (e.g. nerdctl for container commands and limactl for VM commands).
+	rootCmd.PersistentFlags().Bool("debug", false, "running under debug mode")
+	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, _ []string) error {
+		// running commands under debug mode will print out debug logs
+		debugMode, _ := cmd.Flags().GetBool("debug")
+		if debugMode {
+			logger.SetLevel(flog.Debug)
+		}
+		return nil
+	}
+
+	ncc := command.NewNerdctlCmdCreator(ecc,
+		logger,
+		fp.NerdctlConfigFilePath(finchRootPath),
+		fp.BuildkitSocketPath(),
+		fp.FinchDependencyBinDir(),
+		system.NewStdLib(),
+	)
+	lima := wrapper.NewLimaWrapper()
+	supportBundleBuilder := support.NewBundleBuilder(
+		logger,
+		fs,
+		support.NewBundleConfig(fp, finchRootPath),
+		fp,
+		ecc,
+		ncc,
+		lima,
+	)
+
+	// append nerdctl commands
+	allCommands := initializeNerdctlCommands(ncc, ecc, logger, fs, fc)
+	// append finch specific commands
+	allCommands = append(allCommands,
+		newVersionCommand(ncc, logger, stdOut),
+		newSupportBundleCommand(logger, supportBundleBuilder, ncc),
+		newGenDocsCommand(rootCmd, logger, fs, system.NewStdLib()),
+	)
+
+	rootCmd.AddCommand(allCommands...)
+
+	return rootCmd
+}

cmd/finch/main_remote.go

@@ -0,0 +1,86 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build darwin || windows
+
+package main
+
+import (
+	"fmt"
+	"io"
+
+	"github.com/spf13/afero"
+	"github.com/spf13/cobra"
+
+	"github.com/runfinch/finch/pkg/command"
+	"github.com/runfinch/finch/pkg/config"
+	"github.com/runfinch/finch/pkg/flog"
+	"github.com/runfinch/finch/pkg/lima/wrapper"
+	"github.com/runfinch/finch/pkg/path"
+	"github.com/runfinch/finch/pkg/support"
+	"github.com/runfinch/finch/pkg/system"
+	"github.com/runfinch/finch/pkg/version"
+)
+
+var newApp = func(
+	logger flog.Logger,
+	fp path.Finch,
+	fs afero.Fs,
+	fc *config.Finch,
+	stdOut io.Writer,
+	home,
+	finchRootPath string,
+	ecc command.Creator,
+) *cobra.Command {
+	usage := fmt.Sprintf("%v <command>", finchRootCmd)
+	rootCmd := &cobra.Command{
+		Use:           usage,
+		Short:         "Finch: open-source container development tool",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+		Version:       version.Version,
+	}
+	// TODO: Decide when to forward --debug to the dependencies
+	// (e.g. nerdctl for container commands and limactl for VM commands).
+	rootCmd.PersistentFlags().Bool("debug", false, "running under debug mode")
+	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, _ []string) error {
+		// running commands under debug mode will print out debug logs
+		debugMode, _ := cmd.Flags().GetBool("debug")
+		if debugMode {
+			logger.SetLevel(flog.Debug)
+		}
+		return nil
+	}
+
+	ncc := command.NewNerdctlCmdCreator(ecc,
+		logger,
+		fp.LimaHomePath(),
+		fp.LimactlPath(),
+		fp.QEMUBinDir(),
+		system.NewStdLib(),
+	)
+	lima := wrapper.NewLimaWrapper()
+	supportBundleBuilder := support.NewBundleBuilder(
+		logger,
+		fs,
+		support.NewBundleConfig(fp, finchRootPath),
+		fp,
+		ecc,
+		ncc,
+		lima,
+	)
+
+	// append nerdctl commands
+	allCommands := initializeNerdctlCommands(ncc, ecc, logger, fs, fc)
+	// append finch specific commands
+	allCommands = append(allCommands,
+		newVersionCommand(ncc, logger, stdOut),
+		virtualMachineCommands(logger, fp, ncc, ecc, fs, fc, home, finchRootPath),
+		newSupportBundleCommand(logger, supportBundleBuilder, ncc),
+		newGenDocsCommand(rootCmd, logger, fs, system.NewStdLib()),
+	)
+
+	rootCmd.AddCommand(allCommands...)
+
+	return rootCmd
+}

cmd/finch/main_windows.go

@@ -24,7 +24,7 @@ func dependencies(
 	fc *config.Finch,
 	fp path.Finch,
 	fs afero.Fs,
-	_ command.LimaCmdCreator,
+	_ command.NerdctlCmdCreator,
 	logger flog.Logger,
 	finchDir string,
 ) []*dependency.Group {