feat(api): add debug route

pkg/modules/libreoffice/api/api.go

@@ -5,6 +5,9 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"os/exec"
+	"strings"
+	"syscall"
 	"time"
 
 	"github.com/alexliesenfeld/health"
@@ -305,6 +308,23 @@ func (a *Api) Stop(ctx context.Context) error {
 	return fmt.Errorf("stop LibreOffice: %w", err)
 }
 
+// Debug returns additional debug data.
+func (a *Api) Debug() map[string]interface{} {
+	debug := make(map[string]interface{})
+
+	cmd := exec.Command(a.args.binPath, "--version") //nolint:gosec
+	cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
+
+	output, err := cmd.Output()
+	if err != nil {
+		debug["version"] = err.Error()
+		return debug
+	}
+
+	debug["version"] = strings.TrimSpace(string(output))
+	return debug
+}
+
 // Metrics returns the metrics.
 func (a *Api) Metrics() ([]gotenberg.Metric, error) {
 	return []gotenberg.Metric{
@@ -536,6 +556,7 @@ var (
 	_ gotenberg.Provisioner     = (*Api)(nil)
 	_ gotenberg.Validator       = (*Api)(nil)
 	_ gotenberg.App             = (*Api)(nil)
+	_ gotenberg.Debuggable      = (*Api)(nil)
 	_ gotenberg.MetricsProvider = (*Api)(nil)
 	_ api.HealthChecker         = (*Api)(nil)
 	_ Uno                       = (*Api)(nil)

pkg/modules/libreoffice/api/api_test.go

@@ -277,6 +277,54 @@ func TestApi_Stop(t *testing.T) {
 	}
 }
 
+func TestPdfTk_Debug(t *testing.T) {
+	for _, tc := range []struct {
+		scenario    string
+		a           *Api
+		expect      map[string]interface{}
+		doNotExpect map[string]interface{}
+	}{
+		{
+			scenario: "cannot determine version",
+			a: &Api{
+				args: libreOfficeArguments{
+					binPath: "foo",
+				},
+			},
+			expect: map[string]interface{}{
+				"version": `exec: "foo": executable file not found in $PATH`,
+			},
+		},
+		{
+			scenario: "success",
+			a: &Api{
+				args: libreOfficeArguments{
+					binPath: "echo",
+				},
+			},
+			doNotExpect: map[string]interface{}{
+				"version": `exec: "echo": executable file not found in $PATH`,
+			},
+		},
+	} {
+		t.Run(tc.scenario, func(t *testing.T) {
+			d := tc.a.Debug()
+
+			if tc.expect != nil {
+				if !reflect.DeepEqual(d, tc.expect) {
+					t.Errorf("expected '%v' but got '%v'", tc.expect, d)
+				}
+			}
+
+			if tc.doNotExpect != nil {
+				if reflect.DeepEqual(d, tc.doNotExpect) {
+					t.Errorf("did not expect '%v'", d)
+				}
+			}
+		})
+	}
+}
+
 func TestApi_Metrics(t *testing.T) {
 	a := new(Api)
 	a.supervisor = &gotenberg.ProcessSupervisorMock{