Cmldev 531 implement pcl support for lab autostart feature #172

BregaladTaran · 2025-10-23T10:13:27Z

Added support for lab_autostart feature.
Currently using the already existing PATH /labs/{lab_id}

…ostart;

marpauli-cisco · 2025-11-06T12:47:30Z

virl2_client/virl2_client.py

    ) -> Lab:
        """
-        Create a new lab with optional title, description, and notes.
+        Create a new lab with optional title, description, notes, and autostart configuration.


You should not be able to create new lab and set autostart at the same time. You need to create lab and after that (if you are admin), you can setup autostart.
So, when lab is created, you cannot set values, so all the code below could be removed

marpauli-cisco

autostart_config changed to autostart
Can not set autostart parameters during lab create, therefore you can remove it along with tests from lab creation

marpauli-cisco · 2025-11-06T13:01:18Z

virl2_client/models/lab.py

        self._title = title
        self._description = ""
        self._notes = ""
+        self._autostart_config = {


Suggested change

self._autostart_config = {

self._autostart = {

marpauli-cisco · 2025-11-06T13:01:41Z

virl2_client/models/lab.py

+    def autostart_enabled(self) -> bool:
+        """Return whether autostart is enabled for the lab."""
+        self.sync_topology_if_outdated()
+        return self._autostart_config["enabled"]


Suggested change

return self._autostart_config["enabled"]

return self._autostart["enabled"]

marpauli-cisco · 2025-11-06T13:02:38Z

virl2_client/models/lab.py

+    def autostart_priority(self) -> int | None:
+        """Return the autostart priority of the lab."""
+        self.sync_topology_if_outdated()
+        return self._autostart_config["priority"]


Suggested change

return self._autostart_config["priority"]

return self._autostart["priority"]

marpauli-cisco · 2025-11-06T13:03:23Z

virl2_client/models/lab.py

+    def autostart_delay(self) -> int | None:
+        """Return the autostart delay of the lab."""
+        self.sync_topology_if_outdated()
+        return self._autostart_config["delay"]


Suggested change

return self._autostart_config["delay"]

return self._autostart["delay"]

marpauli-cisco · 2025-11-06T13:04:44Z

virl2_client/models/lab.py

+            self._autostart_config = lab_dict.get(
+                "autostart_config",


Suggested change

self._autostart_config = lab_dict.get(

"autostart_config",

self._autostart = lab_dict.get(

"autostart",

marpauli-cisco · 2025-11-06T13:20:37Z

tests/test_client_library.py

+        ("autostart_delay", -1, "between 0 and 84600"),
+    ],
+)
+def test_create_lab_autostart_validation(


as mentioned elsewhere, this test can be removed, because you cannot create lab and set autostart at the same time. As a metter of fact, I think, all tests in this file can be removed

marpauli-cisco · 2025-11-06T13:24:02Z

tests/test_client_library_labs.py

+        lab.set_autostart_config(enabled=True, priority=500, delay=120)
+
+        assert lab._autostart_config == {
+            "enabled": True,
+            "priority": 500,
+            "delay": 120,
+        }
+        assert lab.autostart_enabled is True
+        assert lab.autostart_priority == 500
+        assert lab.autostart_delay == 120
+
+        # Test validation in convenience method
+        with pytest.raises(
+            ValueError, match="autostart_priority must be between 0 and 10000"
+        ):
+            lab.set_autostart_config(enabled=True, priority=15000)
+
+        with pytest.raises(
+            ValueError, match="autostart_delay must be between 0 and 84600"
+        ):
+            lab.set_autostart_config(enabled=True, delay=100000)


Suggested change

lab.set_autostart_config(enabled=True, priority=500, delay=120)

assert lab._autostart_config == {

"enabled": True,

"priority": 500,

"delay": 120,

}

assert lab.autostart_enabled is True

assert lab.autostart_priority == 500

assert lab.autostart_delay == 120

# Test validation in convenience method

with pytest.raises(

ValueError, match="autostart_priority must be between 0 and 10000"

):

lab.set_autostart_config(enabled=True, priority=15000)

with pytest.raises(

ValueError, match="autostart_delay must be between 0 and 84600"

):

lab.set_autostart_config(enabled=True, delay=100000)

lab.set_autostart(enabled=True, priority=500, delay=120)

assert lab._autostart == {

"enabled": True,

"priority": 500,

"delay": 120,

}

assert lab.autostart_enabled is True

assert lab.autostart_priority == 500

assert lab.autostart_delay == 120

# Test validation in convenience method

with pytest.raises(

ValueError, match="autostart_priority must be between 0 and 10000"

):

lab.set_autostart(enabled=True, priority=15000)

with pytest.raises(

ValueError, match="autostart_delay must be between 0 and 84600"

):

lab.set_autostart(enabled=True, delay=100000)

marpauli-cisco · 2025-11-06T13:24:40Z

tests/test_client_library_labs.py

+    }
+
+    if has_autostart:
+        topology["lab"]["autostart_config"] = {


Suggested change

topology["lab"]["autostart_config"] = {

topology["lab"]["autostart"] = {

marpauli-cisco · 2025-11-06T13:24:49Z

tests/test_client_library_labs.py

+        expected = {"enabled": False, "priority": None, "delay": None}
+
+    lab._import_lab(topology)
+    assert lab._autostart_config == expected


Suggested change

assert lab._autostart_config == expected

assert lab._autostart == expected

marpauli-cisco · 2025-11-06T13:25:15Z

tests/test_client_library_labs.py

+    lab._autostart_config = {"enabled": False, "priority": 100, "delay": 200}
+
+    properties = {
+        "title": "Updated Lab",
+        "autostart_config": {"enabled": True, "priority": 300},
+    }
+
+    lab.update_lab_properties(properties)
+
+    assert lab._title == "Updated Lab"
+    assert lab._autostart_config == {"enabled": True, "priority": 300, "delay": 200}


Suggested change

lab._autostart_config = {"enabled": False, "priority": 100, "delay": 200}

properties = {

"title": "Updated Lab",

"autostart_config": {"enabled": True, "priority": 300},

}

lab.update_lab_properties(properties)

assert lab._title == "Updated Lab"

assert lab._autostart_config == {"enabled": True, "priority": 300, "delay": 200}

lab._autostart = {"enabled": False, "priority": 100, "delay": 200}

properties = {

"title": "Updated Lab",

"autostart": {"enabled": True, "priority": 300},

}

lab.update_lab_properties(properties)

assert lab._title == "Updated Lab"

assert lab._autostart == {"enabled": True, "priority": 300, "delay": 200}

tmikuska · 2025-11-21T22:53:13Z

virl2_client/models/lab.py

+    @autostart_priority.setter
+    def autostart_priority(self, value: int | None) -> None:
+        """Set the autostart priority of the lab."""
+        if value is not None and not (0 <= value <= 10000):


Suggested change

if value is not None and not (0 <= value <= 10000):

if not (value is None or 0 <= value <= 10000):

tmikuska · 2025-11-21T22:53:32Z

virl2_client/models/lab.py

+    def autostart_priority(self, value: int | None) -> None:
+        """Set the autostart priority of the lab."""
+        if value is not None and not (0 <= value <= 10000):
+            raise ValueError("autostart_priority must be between 0 and 10000")


Suggested change

raise ValueError("autostart_priority must be between 0 and 10000")

raise ValueError("autostart_priority must be between 0 and 10000, or None")

tmikuska · 2025-11-21T23:01:12Z

virl2_client/models/lab.py

+    @autostart_delay.setter
+    def autostart_delay(self, value: int | None) -> None:
+        """Set the autostart delay of the lab."""
+        if value is not None and (value < 0 or value > 84600):


I like this better, but the original is fine too except that it's 86400

Suggested change

if value is not None and (value < 0 or value > 84600):

if not (value is None or 0 <= value <= 86400):

@marpauli-cisco 84600 -> 86400 needs to be changed in API and UI as well

tmikuska · 2025-11-21T23:07:47Z

virl2_client/models/lab.py

+                    "priority": None,
+                    "delay": None,
+                },
+            )


this can be moved out of if/else and if autostart is not present, we shouldn't set it

tmikuska · 2025-11-21T23:08:23Z

virl2_client/virl2_client.py

        """
        url = self._url_for("labs")
        body = {"title": title, "description": description, "notes": notes}
+


Suggested change

tmikuska · 2025-11-21T23:09:01Z

virl2_client/models/lab.py

+            "priority": priority,
+            "delay": delay,
+        }
+        self._set_property("autostart", self._autostart)


I made the same comment in the node staging, this method is imo sufficient (we can add a getter) and we don't need the individual getters/setters @marpauli-cisco thoughts?

tmikuska

the delay max needs to be changed and we shouldn't reset autostart on update if it's not present in the lab_dict (not sure if that's possible)

BregaladTaran added 3 commits October 21, 2025 11:25

CMLDEV-531: Initial implementation of lab_autostart support;

eb4c7d8

CMLDEV-531: Added test coverage; Minor updates to parameters;

33e80eb

CMLDEV-531: Test coverage updated; Convenience method for setting aut…

ade03e0

…ostart;

BregaladTaran requested review from PatrikMosko, marpauli-cisco, tmikuska, virlos and xorrkaz October 23, 2025 10:13

marpauli-cisco reviewed Nov 6, 2025

View reviewed changes

marpauli-cisco requested changes Nov 6, 2025

View reviewed changes

BregaladTaran added 2 commits November 11, 2025 13:59

CMLDEV-531: Updated to fit latest lab_autostart implementation.

63936f2

CMLDEV-531: Updated lab creation; Further updated code to correct cmt;

f8dc6c1

marpauli-cisco approved these changes Nov 18, 2025

View reviewed changes

tmikuska reviewed Nov 21, 2025

View reviewed changes

tmikuska requested changes Nov 21, 2025

View reviewed changes

	return self._autostart_config["enabled"]
	return self._autostart["enabled"]

	return self._autostart_config["priority"]
	return self._autostart["priority"]

	return self._autostart_config["delay"]
	return self._autostart["delay"]

	topology["lab"]["autostart_config"] = {
	topology["lab"]["autostart"] = {

	assert lab._autostart_config == expected
	assert lab._autostart == expected

	if value is not None and not (0 <= value <= 10000):
	if not (value is None or 0 <= value <= 10000):

	raise ValueError("autostart_priority must be between 0 and 10000")
	raise ValueError("autostart_priority must be between 0 and 10000, or None")

	if value is not None and (value < 0 or value > 84600):
	if not (value is None or 0 <= value <= 86400):

Cmldev 531 implement pcl support for lab autostart feature #172

Are you sure you want to change the base?

Cmldev 531 implement pcl support for lab autostart feature #172

Uh oh!

Conversation

BregaladTaran commented Oct 23, 2025

Uh oh!

marpauli-cisco Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marpauli-cisco left a comment

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!

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!

tmikuska Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

tmikuska left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

marpauli-cisco Nov 6, 2025 •

edited

Loading

tmikuska Nov 21, 2025 •

edited

Loading