Cmldev 531 implement pcl support for lab autostart feature #172
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BregaladTaran
requested review from
PatrikMosko,
marpauli-cisco,
tmikuska,
virlos and
xorrkaz
virl2_client/virl2_client.py
Outdated
| ) -> Lab: | ||
| """ | ||
| Create a new lab with optional title, description, and notes. | ||
| Create a new lab with optional title, description, notes, and autostart configuration. |
Collaborator
There was a problem hiding this comment.
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
requested changes
Nov 6, 2025
Collaborator
marpauli-cisco
left a comment
marpauli-cisco
left a comment
There was a problem hiding this comment.
autostart_config changed to autostart
Can not set autostart parameters during lab create, therefore you can remove it along with tests from lab creation
virl2_client/models/lab.py
Outdated
| self._title = title | ||
| self._description = "" | ||
| self._notes = "" | ||
| self._autostart_config = { |
Collaborator
There was a problem hiding this comment.
Suggested change
| self._autostart_config = { | |
| self._autostart = { |
virl2_client/models/lab.py
Outdated
| def autostart_enabled(self) -> bool: | ||
| """Return whether autostart is enabled for the lab.""" | ||
| self.sync_topology_if_outdated() | ||
| return self._autostart_config["enabled"] |
Collaborator
There was a problem hiding this comment.
Suggested change
| return self._autostart_config["enabled"] | |
| return self._autostart["enabled"] |
virl2_client/models/lab.py
Outdated
| def autostart_priority(self) -> int | None: | ||
| """Return the autostart priority of the lab.""" | ||
| self.sync_topology_if_outdated() | ||
| return self._autostart_config["priority"] |
Collaborator
There was a problem hiding this comment.
Suggested change
| return self._autostart_config["priority"] | |
| return self._autostart["priority"] |
virl2_client/models/lab.py
Outdated
| def autostart_delay(self) -> int | None: | ||
| """Return the autostart delay of the lab.""" | ||
| self.sync_topology_if_outdated() | ||
| return self._autostart_config["delay"] |
Collaborator
There was a problem hiding this comment.
Suggested change
| return self._autostart_config["delay"] | |
| return self._autostart["delay"] |
virl2_client/models/lab.py
Outdated
Comment on lines
1464
to
1465
| self._autostart_config = lab_dict.get( | ||
| "autostart_config", |
Collaborator
There was a problem hiding this comment.
Suggested change
| self._autostart_config = lab_dict.get( | |
| "autostart_config", | |
| self._autostart = lab_dict.get( | |
| "autostart", |
tests/test_client_library.py
Outdated
| ("autostart_delay", -1, "between 0 and 84600"), | ||
| ], | ||
| ) | ||
| def test_create_lab_autostart_validation( |
Collaborator
There was a problem hiding this comment.
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
tests/test_client_library_labs.py
Outdated
Comment on lines
579
to
599
| 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) |
Collaborator
There was a problem hiding this comment.
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) |
tests/test_client_library_labs.py
Outdated
| } | ||
|
|
||
| if has_autostart: | ||
| topology["lab"]["autostart_config"] = { |
Collaborator
There was a problem hiding this comment.
Suggested change
| topology["lab"]["autostart_config"] = { | |
| topology["lab"]["autostart"] = { |
tests/test_client_library_labs.py
Outdated
| expected = {"enabled": False, "priority": None, "delay": None} | ||
|
|
||
| lab._import_lab(topology) | ||
| assert lab._autostart_config == expected |
Collaborator
There was a problem hiding this comment.
Suggested change
| assert lab._autostart_config == expected | |
| assert lab._autostart == expected |
tests/test_client_library_labs.py
Outdated
Comment on lines
675
to
685
| 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} |
Collaborator
There was a problem hiding this comment.
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} |
marpauli-cisco
approved these changes
Nov 18, 2025
tmikuska
reviewed
Nov 21, 2025
tmikuska
reviewed
Nov 21, 2025
tmikuska
reviewed
Nov 21, 2025
tmikuska
reviewed
Nov 21, 2025
virl2_client/models/lab.py
Outdated
| "priority": None, | ||
| "delay": None, | ||
| }, | ||
| ) |
Collaborator
There was a problem hiding this comment.
this can be moved out of if/else and if autostart is not present, we shouldn't set it
tmikuska
reviewed
Nov 21, 2025
tmikuska
reviewed
Nov 21, 2025
| "priority": priority, | ||
| "delay": delay, | ||
| } | ||
| self._set_property("autostart", self._autostart) |
Collaborator
There was a problem hiding this comment.
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?
Collaborator
There was a problem hiding this comment.
Same as in Node_staging, we are not using the enabled, priority and delay separately, but as a autostart dict, so all the individual properties and setters andd all the code refering them can be removed
tmikuska
requested changes
Nov 21, 2025
Collaborator
tmikuska
left a comment
tmikuska
left a comment
There was a problem hiding this comment.
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)
Co-authored-by: tmikuska <[email protected]>
Co-authored-by: tmikuska <[email protected]>
Co-authored-by: tmikuska <[email protected]>
Co-authored-by: tmikuska <[email protected]>
tmikuska
force-pushed
the
dev
branch
2 times, most recently
from
b9d320f to
bb8b0fa
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added support for lab_autostart feature.
Currently using the already existing PATH /labs/{lab_id}