Skip to content

feat: Go implement GetDebugInfo #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2025
Merged

feat: Go implement GetDebugInfo #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions entrypoint/internal/utils/host/host.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ package host

import (
"context"
"fmt"
"strings"

"github.com/Mellanox/doca-driver-build/entrypoint/internal/utils/cmd"
"github.com/Mellanox/doca-driver-build/entrypoint/internal/wrappers"
Expand Down Expand Up @@ -57,8 +59,33 @@ func (h *host) GetOSType(ctx context.Context) (string, error) {

// GetDebugInfo is the default implementation of the host.Interface.
func (h *host) GetDebugInfo(ctx context.Context) (string, error) {
// TODO: add implementation
return "", nil
var debugInfo strings.Builder

// Get OS release information
osReleaseContent, err := h.os.ReadFile("/etc/os-release")
if err != nil {
debugInfo.WriteString(fmt.Sprintf("[os-release]: Error reading /etc/os-release: %v\n", err))
} else {
debugInfo.WriteString(fmt.Sprintf("[os-release]: %s\n", string(osReleaseContent)))
}

// Get kernel information
stdout, stderr, err := h.cmd.RunCommand(ctx, "uname", "-a")
if err != nil {
debugInfo.WriteString(fmt.Sprintf("[uname -a]: Error executing uname -a: %v (stderr: %s)\n", err, stderr))
} else {
debugInfo.WriteString(fmt.Sprintf("[uname -a]: %s\n", stdout))
}

// Get memory information
stdout, stderr, err = h.cmd.RunCommand(ctx, "free", "-m")
if err != nil {
debugInfo.WriteString(fmt.Sprintf("[free -m]: Error executing free -m: %v (stderr: %s)\n", err, stderr))
} else {
debugInfo.WriteString(fmt.Sprintf("[free -m]: %s\n", stdout))
}

return debugInfo.String(), nil
}

// LoadedModule contains information about loaded kernel module.
Expand Down
29 changes: 29 additions & 0 deletions entrypoint/internal/utils/host/host_suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
Copyright 2025, NVIDIA CORPORATION & AFFILIATES

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package host

import (
"testing"

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)

func TestHost(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Host Suite")
}
203 changes: 203 additions & 0 deletions entrypoint/internal/utils/host/host_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
/*
Copyright 2025, NVIDIA CORPORATION & AFFILIATES

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package host

import (
"context"

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/stretchr/testify/assert"

cmdMockPkg "github.com/Mellanox/doca-driver-build/entrypoint/internal/utils/cmd/mocks"
osMockPkg "github.com/Mellanox/doca-driver-build/entrypoint/internal/wrappers/mocks"
)

var _ = Describe("Host", func() {
Context("GetDebugInfo", func() {
var (
h Interface
cmdMock *cmdMockPkg.Interface
osMock *osMockPkg.OSWrapper
)

BeforeEach(func() {
cmdMock = cmdMockPkg.NewInterface(GinkgoT())
osMock = osMockPkg.NewOSWrapper(GinkgoT())
h = New(cmdMock, osMock)
})

It("should return debug info with all successful operations", func() {
osReleaseContent := `PRETTY_NAME="Ubuntu 22.04.3 LTS"
NAME="Ubuntu"
VERSION_ID="22.04"
ID=ubuntu`
unameOutput := "Linux hostname 5.15.0-91-generic #101-Ubuntu SMP Thu Nov 16 18:13:39 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux"
freeOutput := ` total used free shared buff/cache available
Mem: 15947 1234 5678 123 8901 14000
Swap: 2048 0 2048`

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return(unameOutput, "", nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return(freeOutput, "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: " + unameOutput))
Expect(debugInfo).To(ContainSubstring("[free -m]: " + freeOutput))
})

It("should handle os-release read error gracefully", func() {
unameOutput := "Linux hostname 5.15.0-91-generic #101-Ubuntu SMP Thu Nov 16 18:13:39 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux"
freeOutput := ` total used free shared buff/cache available
Mem: 15947 1234 5678 123 8901 14000
Swap: 2048 0 2048`

osMock.EXPECT().ReadFile("/etc/os-release").Return(nil, assert.AnError)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return(unameOutput, "", nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return(freeOutput, "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: Error reading /etc/os-release: assert.AnError general error for testing"))
Expect(debugInfo).To(ContainSubstring("[uname -a]: " + unameOutput))
Expect(debugInfo).To(ContainSubstring("[free -m]: " + freeOutput))
})

It("should handle uname command error gracefully", func() {
osReleaseContent := `PRETTY_NAME="Ubuntu 22.04.3 LTS"
NAME="Ubuntu"
ID=ubuntu`
freeOutput := ` total used free shared buff/cache available
Mem: 15947 1234 5678 123 8901 14000
Swap: 2048 0 2048`

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return("", "command not found", assert.AnError)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return(freeOutput, "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: Error executing uname -a: assert.AnError general error for testing (stderr: command not found)"))
Expect(debugInfo).To(ContainSubstring("[free -m]: " + freeOutput))
})

It("should handle free command error gracefully", func() {
osReleaseContent := `PRETTY_NAME="Ubuntu 22.04.3 LTS"
NAME="Ubuntu"
ID=ubuntu`
unameOutput := "Linux hostname 5.15.0-91-generic #101-Ubuntu SMP Thu Nov 16 18:13:39 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux"

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return(unameOutput, "", nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return("", "permission denied", assert.AnError)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: " + unameOutput))
Expect(debugInfo).To(ContainSubstring("[free -m]: Error executing free -m: assert.AnError general error for testing (stderr: permission denied)"))
})

It("should handle all operations failing gracefully", func() {
osMock.EXPECT().ReadFile("/etc/os-release").Return(nil, assert.AnError)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return("", "command not found", assert.AnError)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return("", "permission denied", assert.AnError)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: Error reading /etc/os-release: assert.AnError general error for testing"))
Expect(debugInfo).To(ContainSubstring("[uname -a]: Error executing uname -a: assert.AnError general error for testing (stderr: command not found)"))
Expect(debugInfo).To(ContainSubstring("[free -m]: Error executing free -m: assert.AnError general error for testing (stderr: permission denied)"))
})

It("should handle empty outputs from commands", func() {
osReleaseContent := `PRETTY_NAME="Ubuntu 22.04.3 LTS"
NAME="Ubuntu"
ID=ubuntu`

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return("", "", nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return("", "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: \n"))
Expect(debugInfo).To(ContainSubstring("[free -m]: \n"))
})

It("should handle multiline os-release content", func() {
osReleaseContent := `PRETTY_NAME="Red Hat Enterprise Linux 9.2 (Plow)"
NAME="Red Hat Enterprise Linux"
VERSION="9.2 (Plow)"
ID="rhel"
ID_LIKE="fedora"
VERSION_ID="9.2"
PLATFORM_ID="platform:el9"
PRETTY_NAME="Red Hat Enterprise Linux 9.2 (Plow)"
ANSI_COLOR="0;31"
LOGO="fedora-logo-icon"
CPE_NAME="cpe:/o:redhat:enterprise_linux:9::baseos"
HOME_URL="https://www.redhat.com/"
DOCUMENTATION_URL="https://access.redhat.com/documentation/red_hat_enterprise_linux/9/"
SUPPORT_URL="https://access.redhat.com/support"
BUG_REPORT_URL="https://bugzilla.redhat.com/"
REDHAT_BUGZILLA_PRODUCT="Red Hat Enterprise Linux 9"
REDHAT_BUGZILLA_PRODUCT_VERSION=9.2
REDHAT_SUPPORT_PRODUCT="Red Hat Enterprise Linux"
REDHAT_SUPPORT_PRODUCT_VERSION="9.2"`
unameOutput := "Linux rhel-host 5.14.0-284.11.1.el9_2.x86_64 #1 SMP PREEMPT_DYNAMIC Tue May 9 10:23:07 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux"
freeOutput := ` total used free shared buff/cache available
Mem: 32000 8000 12000 500 12000 23000
Swap: 4096 0 4096`

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return(unameOutput, "", nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return(freeOutput, "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: " + unameOutput))
Expect(debugInfo).To(ContainSubstring("[free -m]: " + freeOutput))
})

It("should handle commands with stderr output but no error", func() {
osReleaseContent := `PRETTY_NAME="Ubuntu 22.04.3 LTS"
NAME="Ubuntu"
ID=ubuntu`
unameOutput := "Linux hostname 5.15.0-91-generic #101-Ubuntu SMP Thu Nov 16 18:13:39 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux"
unameStderr := "warning: some warning message"
freeOutput := ` total used free shared buff/cache available
Mem: 15947 1234 5678 123 8901 14000
Swap: 2048 0 2048`

osMock.EXPECT().ReadFile("/etc/os-release").Return([]byte(osReleaseContent), nil)
cmdMock.EXPECT().RunCommand(context.Background(), "uname", "-a").Return(unameOutput, unameStderr, nil)
cmdMock.EXPECT().RunCommand(context.Background(), "free", "-m").Return(freeOutput, "", nil)

debugInfo, err := h.GetDebugInfo(context.Background())
Expect(err).ToNot(HaveOccurred())
Expect(debugInfo).To(ContainSubstring("[os-release]: " + osReleaseContent))
Expect(debugInfo).To(ContainSubstring("[uname -a]: " + unameOutput))
Expect(debugInfo).To(ContainSubstring("[free -m]: " + freeOutput))
})
})
})
Loading