feat: Pre-requiste sanity checks for installation of SUSE Manager by katara-Jayprakash · Pull Request #741 · uyuni-project/uyuni-tools

katara-Jayprakash · 2026-03-10T14:48:29Z

What does this PR change?

add description
this pr try to add prerequisite sanity checks before podman installation for both mgradm and mgrpxy. its include minimum memory and disk space, required network port availability, and detection of conflicting running containers on the uyuni network.

Codespace

Check if you already have a running container clicking on

Test coverage

No tests: add explanation
No tests: already covered
Unit tests were added
DONE

Links

Issue(s): #355

DONE

Changelogs

Make sure the changelogs entries you are adding are compliant with https://github.com/uyuni-project/uyuni/wiki/Contributing#changelogs and https://github.com/uyuni-project/uyuni/wiki/Contributing#uyuni-projectuyuni-repository

If you don't need a changelog check, please mark this checkbox:

No changelog needed

If you uncheck the checkbox after the PR is created, you will need to re-run changelog_test (see below)

Before you merge

Check How to branch and merge properly!

sonarqubecloud · 2026-03-10T15:02:00Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

cbosdo · 2026-03-31T07:05:34Z

+}
+
+func checkPrerequisites() error {
+	if err := utils.CheckMemory(8); err != nil {


The memory, and storage minimums should be extracted as constants.
8GB is also a bit tight for production environment thought most of the devs use this… Getting a proper value here is not easy.

cbosdo · 2026-03-31T07:06:58Z

+	if err := utils.CheckMemory(8); err != nil {
+		return err
+	}
+	if err := utils.CheckStorage("/var/lib", 50); err != nil {


/var/lib is too large to check. You should find the podman storage root instead. Note that this shouldn't be hard coded as users can configure it in podman's config files.

cbosdo · 2026-03-31T07:08:05Z

+		return err
+	}
+
+	for _, port := range []int{80, 443, 4505, 4506} {


The ports are already defined in the shared/utils module. Please use it instead of hardcoding them here again. The ports list is also a bit too short…

cbosdo · 2026-03-31T07:08:35Z

 }
+
+func checkPrerequisites() error {
+	if err := shared_utils.CheckMemory(4); err != nil {


Same here about the magic numbers

cbosdo · 2026-03-31T07:15:19Z

+
+// CheckPort checks if a given port is available.
+func CheckPort(port int) error {
+	l, err := net.Listen("tcp", fmt.Sprintf(":%d", port))


This should be moved to a file that is built for all OSes instead of duplicating it.

cbosdo · 2026-03-31T07:16:20Z

@@ -0,0 +1,51 @@
+// SPDX-FileCopyrightText: 2024 SUSE LLC


Copyright issue again

cbosdo · 2026-03-31T07:17:15Z

+)
+
+func getFreePort() (int, error) {
+	addr, err := net.ResolveTCPAddr("tcp", "localhost:0")


Such a test highly depends on where it is running: mock or drop the test!

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

katara-Jayprakash · 2026-04-24T05:35:29Z

@cbosdo i think its done now! could you review it. sir

sonarqubecloud · 2026-04-24T05:37:48Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

cbosdo · 2026-05-04T08:24:15Z

+	if err != nil {
+		// binary is not installed, skip
+		return nil
+	}
+	// the binary is installed
+	return utils.Error(utils.RunCmdStdMapping(zerolog.DebugLevel, path), L("failed to extract payg data"))


Your code is not behaving as before and would lead to issues. This would be correct and more readable:

Suggested change

if err != nil {

// binary is not installed, skip

return nil

}

// the binary is installed

return utils.Error(utils.RunCmdStdMapping(zerolog.DebugLevel, path), L("failed to extract payg data"))

if err == nil {

if utils.RunCmdStdMapping(zerolog.DebugLevel, path) != nil {

return utils.Error(err, L("failed to extract payg data"))

}

}

return nil

cbosdo · 2026-05-05T07:28:28Z

+}
+
+const (
+	minMemoryGB  = 16 // Minimum memory in GB for production


We need to be able to bypass that for dev environments: some run with less memory than that.

cbosdo · 2026-05-05T07:30:23Z

+
+	storageRoot, err := shared_podman.GetPodmanVolumeBasePath()
+	if err != nil || storageRoot == "" {
+		storageRoot = "/var/lib" // fallback if detection fails


This would fit the default path on several distros:

Suggested change

storageRoot = "/var/lib" // fallback if detection fails

storageRoot = "/var/lib/containers/storage" // fallback if detection fails

cbosdo · 2026-05-05T07:31:51Z

+
+	storageRoot, err := shared_podman.GetPodmanVolumeBasePath()
+	if err != nil || storageRoot == "" {
+		storageRoot = "/var/lib" // fallback if detection fails


This could be shared with the code for the server. The default path should rather be `/var/lib/containers/storage' too.

cbosdo · 2026-05-05T07:32:47Z

+	for _, portMap := range shared_utils.GetProxyPorts() {
+		if err := shared_utils.CheckPort(portMap.Exposed); err != nil {
+			return err
+		}
+	}


You could share the loop with the server code too.

cbosdo · 2026-05-05T07:35:12Z

+	}
+
+	if len(strings.TrimSpace(string(out))) > 0 {
+		return errors.New(L("there are running containers on the uyuni network. Please stop them before installing or upgrading (see issue #323)."))


Stopping the containers before the upgrade is not needed. Only before install is that needed.
Don't mention the issue in user-facing messages: they wouldn't care and it can only confuse them.

cbosdo · 2026-05-05T07:39:50Z

+	oldRunner := runner
+	defer func() { runner = oldRunner }()
+
+	runner = testutils.FakeRunnerGenerator("", nil)


You should use data-driven tests here: this test and the next are the same with different initialization of the fake runner. You can find examples of how to do this in https://github.com/uyuni-project/uyuni-tools/blob/main/mgradm/shared/templates/templates_test.go

katara-Jayprakash commented Mar 10, 2026

View reviewed changes

Comment thread mgradm/cmd/install/utils.go

cbosdo requested changes Mar 31, 2026

View reviewed changes

katara-Jayprakash force-pushed the Pre-requiste-sanity-checks branch from 0d82af8 to 0e7ad4f Compare April 24, 2026 05:25

katara-Jayprakash added 9 commits April 24, 2026 10:59

implemented podman check

e82007f

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

implemented test for podman check

d55a3e3

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

implemented resource checking for linux system

879929c

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

implemented resource checking for macOs and window

6ea05f9

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

introduce checkPrerequisites function in utils.go

2b69302

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

fix comments in podman file

dbf758a

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

refactor the uyuni-payg-extract-data

f782b42

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

fix: address review feedback

418fb6a

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

fixing rebase

69f79e3

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

katara-Jayprakash force-pushed the Pre-requiste-sanity-checks branch from 0e7ad4f to 69f79e3 Compare April 24, 2026 05:37

katara-Jayprakash requested a review from cbosdo April 24, 2026 14:43

cbosdo requested changes May 5, 2026

View reviewed changes

	storageRoot = "/var/lib" // fallback if detection fails
	storageRoot = "/var/lib/containers/storage" // fallback if detection fails

Conversation

katara-Jayprakash commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR change?

Codespace

Test coverage

Links

Changelogs

Before you merge

Uh oh!

sonarqubecloud Bot commented Mar 10, 2026

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

katara-Jayprakash commented Apr 24, 2026

Uh oh!

sonarqubecloud Bot commented Apr 24, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

katara-Jayprakash commented Mar 10, 2026 •

edited

Loading