Add cmdline process darwin (NR-155368) (#1731)

* Fix CmdLine extraction in Darwin

Author: alvarocabanas

.github/workflows/security.yml

@@ -63,5 +63,5 @@ jobs:
           exit-code: '1'
           ignore-unfixed: true
           vuln-type: 'os,library'
-          severity: "high,critical"
+          severity: "HIGH,CRITICAL"
           skip-dirs: "/var"

pkg/metrics/process/harvester_darwin_test.go

@@ -5,6 +5,9 @@ package process
 
 import (
 	"bytes"
+	"math"
+	"testing"
+
 	"github.com/newrelic/infrastructure-agent/internal/agent/mocks"
 	"github.com/newrelic/infrastructure-agent/pkg/config"
 	"github.com/newrelic/infrastructure-agent/pkg/log"
@@ -15,8 +18,6 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
-	"math"
-	"testing"
 )
 
 func Test_newHarvester(t *testing.T) {
@@ -420,6 +421,7 @@ func TestDarwinHarvester_Do_NoError(t *testing.T) {
 	proc.ShouldReturnCPUPercent(34.45, nil)
 	proc.ShouldReturnTimes(&cpu.TimesStat{User: 34, System: 0.45}, nil)
 	proc.ShouldReturnUsername("some username", nil)
+	proc.ShouldReturnCmdLine("a command", nil)
 
 	h := newHarvester(ctx)
 	h.processRetriever = func(int32) (Process, error) {
@@ -438,7 +440,7 @@ func TestDarwinHarvester_Do_NoError(t *testing.T) {
 	assert.Equal(t, 34.45, sample.CPUPercent)
 	assert.Equal(t, 34.0, math.Round(sample.CPUUserPercent*100)/100)
 	assert.Equal(t, 0.45, math.Round(sample.CPUSystemPercent*100)/100)
-	assert.Equal(t, "", sample.CmdLine)
+	assert.Equal(t, "a command", sample.CmdLine)
 	assert.Equal(t, "some status", sample.Status)
 	assert.Equal(t, int32(0), sample.ParentProcessID)
 	assert.Equal(t, int32(3), sample.ThreadCount)

pkg/metrics/process/snapshot_darwin.go

@@ -5,9 +5,12 @@ package process
 import (
 	"os"
 	"runtime"
+	"strings"
 	"time"
 
 	"github.com/shirou/gopsutil/v3/process"
+
+	"github.com/newrelic/infrastructure-agent/pkg/helpers"
 )
 
 // darwinProcess is an implementation of the process.Snapshot interface for darwin hosts.
@@ -217,5 +220,29 @@ func (pw *darwinProcess) Command() string {
 // CmdLine is taken from ps. As commands can have spaces, it's difficult parse parameters
 // so no params for now
 func (pw *darwinProcess) CmdLine(withArgs bool) (string, error) {
+	if pw.cmdLine != "" {
+		return pw.cmdLine, nil
+	}
+
+	procCmdline, err := pw.process.Cmdline()
+	if err != nil {
+		return "", nil
+	}
+
+	if len(procCmdline) == 0 {
+		return "", nil // zombie process
+	}
+
+	// Ignoring dash on session commands
+	if procCmdline[0] == '-' {
+		procCmdline = procCmdline[1:]
+	}
+
+	if !withArgs {
+		parts := strings.Split(procCmdline, " ")
+		procCmdline = parts[0]
+	}
+
+	pw.cmdLine = helpers.SanitizeCommandLine(procCmdline)
 	return pw.cmdLine, nil
 }

pkg/metrics/process/snapshot_darwin_test.go

@@ -4,11 +4,12 @@ package process
 
 import (
 	"errors"
+	"testing"
+
 	"github.com/shirou/gopsutil/v3/cpu"
 	"github.com/shirou/gopsutil/v3/process"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
-	"testing"
 )
 
 func Test_collectProcStats_NameError(t *testing.T) {
@@ -367,3 +368,64 @@ func Test_calculatePercent(t *testing.T) {
 		})
 	}
 }
+
+//nolint:exhaustruct
+func Test_Calculate_Process_CmdLine(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name     string
+		cmdLine  string
+		args     bool
+		expected string
+	}{
+		{
+			name:     "empty",
+			cmdLine:  "",
+			expected: "",
+		},
+		{
+			name:     "ignoring dash on session commands",
+			cmdLine:  "-zsh",
+			expected: "zsh",
+		},
+		{
+			name:     "no arguments & args enabled",
+			cmdLine:  "/sbin/launchd",
+			args:     true,
+			expected: "/sbin/launchd",
+		},
+		{
+			name:     "no arguments & args disabled",
+			cmdLine:  "/sbin/launchd",
+			args:     false,
+			expected: "/sbin/launchd",
+		},
+		{
+			name:     "arguments & args enabled",
+			cmdLine:  "/sbin/launchd -arg_a=1 -arg_b 2",
+			args:     true,
+			expected: "/sbin/launchd -arg_a=1 -arg_b 2",
+		},
+		{
+			name:     "arguments & args disabled",
+			cmdLine:  "/sbin/launchd -arg_a=1 -arg_b 2",
+			args:     false,
+			expected: "/sbin/launchd",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			process := &ProcessMock{}
+			process.ShouldReturnCmdLine(tt.cmdLine, nil)
+			darwinProcess := darwinProcess{
+				process: process,
+			}
+
+			result, err := darwinProcess.CmdLine(tt.args)
+			assert.NoError(t, err)
+			assert.Equal(t, tt.expected, result)
+		})
+	}
+}