Add debugging makefile targets (#1114)

- Fix forklift-controller missing certs when running locally
- Added a DEBUG_VARS block with default values for key configuration
variables.
- Implemented `build-debug-%` target for building binaries with
debugging flags.
- Implemented `debug-%` target to run Delve debugger in headless mode.

Signed-off-by: Martin Necas <[email protected]>

Makefile

@@ -112,10 +112,36 @@ e2e-sanity-ova:
 forklift-controller: generate fmt vet
 	go build -o bin/forklift-controller github.com/konveyor/forklift-controller/cmd/forklift-controller
 
+# Define variables with default values for debug
+define DEBUG_VARS
+ROLE ?= main
+VIRT_V2V_IMAGE ?= quay.io/virt-v2v/forklift-virt-v2v:latest
+API_HOST ?= localhost
+API_PORT ?= 443
+DLV_PORT ?= 5432
+BLOCK_OVERHEAD ?= 0
+FILESYSTEM_OVERHEAD ?= 10
+MAX_VM_INFLIGHT ?= 2
+CLEANUP_RETRIES ?= 10
+SNAPSHOT_STATUS_CHECK_RATE_SECONDS ?= 10
+SNAPSHOT_REMOVAL_TIMEOUT_MINUTES ?= 120
+VDDK_JOB_ACTIVE_DEADLINE ?= 300
+PRECOPY_INTERVAL ?= 60
+OPENSHIFT ?= true
+METRICS_PORT ?= 8081
+KUBEVIRT_CLIENT_GO_SCHEME_REGISTRATION_VERSION ?= v1
+FEATURE_VSPHERE_INCREMENTAL_BACKUP ?= true
+VSPHERE_OS_MAP ?= forklift-virt-customize
+OVIRT_OS_MAP ?= forklift-ovirt-osmap
+VIRT_CUSTOMIZE_MAP ?= forklift-virt-customize
+endef
+$(eval $(DEBUG_VARS))
+
+build-debug-%: fmt vet
+	go build -o bin/$* -gcflags=all="-N -l" github.com/konveyor/forklift-controller/cmd/$*
 
-# Build manager binary with compiler optimizations disabled
-debug: generate fmt vet
-	go build -o bin/forklift-controller -gcflags=all="-N -l" github.com/konveyor/forklift-controller/cmd/forklift-controller
+debug-%: build-debug-%
+	dlv --listen=:$(DLV_PORT) --headless=true --api-version=2 exec bin/$*
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 run: generate fmt vet

docs/debugging.md

@@ -0,0 +1,61 @@
+# Debugging
+
+This documentation provides an overview of the `Makefile` used to build and debug the `forklift-controller` project. The `Makefile` defines a set of default variables used for debugging, and includes targets to build and run the application using the `dlv` (Delve) debugger.
+
+## Variables
+
+### List of Variables for Controller
+
+Important:
+- **ROLE**: The role of the process being run. Defaults to `main` alternative `inventory`.
+- **VIRT_V2V_IMAGE**: The image used for virtualization conversion. Defaults to `quay.io/virt-v2v/forklift-virt-v2v:latest`.
+- **API_HOST**: The host address of the API for the inventory. Defaults to `localhost`.
+- **API_PORT**: The port on which the API is served. Defaults to `443`.
+- **DLV_PORT**: The port on which the Delve debugger will listen. Defaults to `5432`
+
+Misc:
+- **BLOCK_OVERHEAD**: The block storage overhead percentage. Defaults to `0`.
+- **FILESYSTEM_OVERHEAD**: The filesystem overhead percentage. Defaults to `10`.
+- **MAX_VM_INFLIGHT**: Maximum number of VMs that can be migrated in parallel. Defaults to `2`.
+- **CLEANUP_RETRIES**: Number of retries during resource cleanup. Defaults to `10`.
+- **SNAPSHOT_STATUS_CHECK_RATE_SECONDS**: The rate in seconds to check snapshot status. Defaults to `10`.
+- **SNAPSHOT_REMOVAL_TIMEOUT_MINUTES**: The timeout in minutes for snapshot removal. Defaults to `120`.
+- **VDDK_JOB_ACTIVE_DEADLINE**: The deadline in seconds for the VDDK job to remain active. Defaults to `300`.
+- **PRECOPY_INTERVAL**: The interval in seconds for precopying data. Defaults to `60`.
+- **OPENSHIFT**: Boolean indicating if the environment is OpenShift. Defaults to `true`.
+- **METRICS_PORT**: The port on which metrics are exposed. Defaults to `8081`.
+- **KUBEVIRT_CLIENT_GO_SCHEME_REGISTRATION_VERSION**: The version used for KubeVirt client registration. Defaults to `v1`.
+- **FEATURE_VSPHERE_INCREMENTAL_BACKUP**: Boolean to enable the vSphere incremental backup feature. Defaults to `true`.
+- **VSPHERE_OS_MAP**: The vSphere OS map. Defaults to `forklift-virt-customize`.
+- **OVIRT_OS_MAP**: The oVirt OS map. Defaults to `forklift-ovirt-osmap`.
+- **VIRT_CUSTOMIZE_MAP**: The Virt Customize map. Defaults to `forklift-virt-customize`.
+
+## Build and Debug Targets
+
+The `Makefile` contains two primary targets for building and debugging the application: `build-debug-%` and `debug-%`.
+
+### `build-debug-%`
+
+This target compiles the Go project for the specified command (e.g., `forklift-controller`) and outputs the binary to the `bin/` directory. It also includes the `-N -l` flags for disabling optimizations and inlining, making the binary more suitable for debugging.
+
+Usage:
+```bash
+make build-debug-<command>
+```
+
+## Example Usage
+
+To build and debug the `forklift-controller` command:
+
+1. Run the build and debug process using the following command:
+```bash
+make debug-forklift-controller
+```
+
+2. Delve will start in headless mode, and you can connect to the debugger using a Go debugging client, pointing it to the specified `DLV_PORT` (default: `5432`).
+
+To override any of the default variables (e.g., changing `DLV_PORT`), you can specify them on the command line:
+
+```bash
+make debug-forklift-controller DLV_PORT=5555 API_HOST="forklift-inventory-openshift-mtv.apps.yourcluster.local"
+```

pkg/controller/provider/controller.go

@@ -72,10 +72,12 @@ func Add(mgr manager.Manager) error {
 	container := libcontainer.New()
 	web := libweb.New(container, web.All(container)...)
 	web.Port = Settings.Inventory.Port
-	web.TLS.Enabled = true
-	web.TLS.Certificate = Settings.Inventory.TLS.Certificate
-	web.TLS.Key = Settings.Inventory.TLS.Key
-	web.AllowedOrigins = Settings.Inventory.CORS.AllowedOrigins
+	if Settings.Inventory.TLS.Key != "" {
+		web.TLS.Enabled = true
+		web.TLS.Certificate = Settings.Inventory.TLS.Certificate
+		web.TLS.Key = Settings.Inventory.TLS.Key
+		web.AllowedOrigins = Settings.Inventory.CORS.AllowedOrigins
+	}
 	reconciler := &Reconciler{
 		Reconciler: base.Reconciler{
 			EventRecorder: mgr.GetEventRecorderFor(Name),

pkg/controller/provider/web/base/client.go

@@ -296,15 +296,17 @@ func (c *RestClient) buildTransport() (err error) {
 		TLSHandshakeTimeout:   10 * time.Second,
 		ExpectContinueTimeout: 1 * time.Second,
 	}
-	pool := x509.NewCertPool()
-	ca, xErr := os.ReadFile(Settings.Inventory.TLS.CA)
-	if xErr != nil {
-		err = liberr.Wrap(xErr)
-		return
-	}
-	pool.AppendCertsFromPEM(ca)
-	transport.TLSClientConfig = &tls.Config{
-		RootCAs: pool,
+	if Settings.Inventory.TLS.CA != "" {
+		pool := x509.NewCertPool()
+		ca, xErr := os.ReadFile(Settings.Inventory.TLS.CA)
+		if xErr != nil {
+			err = liberr.Wrap(xErr)
+			return
+		}
+		pool.AppendCertsFromPEM(ca)
+		transport.TLSClientConfig = &tls.Config{
+			RootCAs: pool,
+		}
 	}
 
 	c.Transport = transport

pkg/settings/inventory.go

@@ -1,6 +1,7 @@
 package settings
 
 import (
+	"errors"
 	"os"
 	"strconv"
 	"strings"
@@ -96,7 +97,9 @@ func (r *Inventory) Load() error {
 	if s, found := os.LookupEnv(TLSCa); found {
 		r.TLS.CA = s
 	} else {
-		r.TLS.CA = ServiceCAFile
+		if _, err := os.Stat(ServiceCAFile); !errors.Is(err, os.ErrNotExist) {
+			r.TLS.CA = ServiceCAFile
+		}
 	}
 
 	return nil