|
4 | 4 |
|
5 | 5 | import os |
6 | 6 | import pytest |
| 7 | +import time |
7 | 8 |
|
8 | 9 | import platform |
9 | 10 | from logging import ERROR |
@@ -218,6 +219,143 @@ def check_command_output(command, expected_retcode, expected_stdout): |
218 | 219 | assert pydm_shell_command.process is None |
219 | 220 |
|
220 | 221 |
|
| 222 | +def test_long_running_command_shows_currently_running_text(qtbot): |
| 223 | + """ |
| 224 | + Test that the button is updated to indicate when a command is currently running. |
| 225 | + These indications are: |
| 226 | + - Prepend "(Running...) " to the button's text |
| 227 | + - Make button text italic |
| 228 | + - Disable button while cmd is running (unless allowMultipleExecutions is set True) |
| 229 | + - Set button icon to hourglass symbol |
| 230 | + And the button should be reset back to it's original state after the command is done. |
| 231 | + """ |
| 232 | + pydm_shell_command = PyDMShellCommand() |
| 233 | + qtbot.addWidget(pydm_shell_command) |
| 234 | + pydm_shell_command.stdout = TermOutputMode.HIDE |
| 235 | + |
| 236 | + # Long running cmd, which we will kill after checking button state while its running |
| 237 | + pydm_shell_command.commands = ["for i in {1..100}; do echo $i; sleep 1; done"] |
| 238 | + |
| 239 | + original_text = "Run Long Cmd" |
| 240 | + pydm_shell_command.setText(original_text) |
| 241 | + pydm_shell_command.runCommandsInFullShell = True |
| 242 | + |
| 243 | + # Execute the cmd |
| 244 | + qtbot.mouseClick(pydm_shell_command, QtCore.Qt.LeftButton) |
| 245 | + # Give the command some time to start |
| 246 | + qtbot.wait(100) # wait 0.1 seconds |
| 247 | + |
| 248 | + # Check icon is updated while cmd is running |
| 249 | + icon_size = QSize(16, 16) |
| 250 | + default_icon = IconFont().icon("hourglass-start") |
| 251 | + default_icon_pixmap = default_icon.pixmap(icon_size) |
| 252 | + curr_icon_pixmap = pydm_shell_command.icon().pixmap(icon_size) |
| 253 | + assert curr_icon_pixmap.toImage() == default_icon_pixmap.toImage() |
| 254 | + |
| 255 | + assert pydm_shell_command.font().italic() |
| 256 | + assert pydm_shell_command.text() == f"(Running...) {original_text}" |
| 257 | + |
| 258 | + assert not pydm_shell_command.isEnabled() |
| 259 | + |
| 260 | + # End process since we are done checking the 'running' state of the button |
| 261 | + if pydm_shell_command.process: |
| 262 | + pydm_shell_command.process.kill() |
| 263 | + |
| 264 | + # Wait a bit for things to update |
| 265 | + qtbot.wait(100) # Wait 0.1 seconds |
| 266 | + |
| 267 | + # Check icon is reverted back after cmd stops running |
| 268 | + default_icon = IconFont().icon("cog") |
| 269 | + default_icon_pixmap = default_icon.pixmap(icon_size) |
| 270 | + curr_icon_pixmap = pydm_shell_command.icon().pixmap(icon_size) |
| 271 | + assert curr_icon_pixmap.toImage() == default_icon_pixmap.toImage() |
| 272 | + |
| 273 | + assert not pydm_shell_command.font().italic() |
| 274 | + assert pydm_shell_command.text() == original_text |
| 275 | + |
| 276 | + assert pydm_shell_command.isEnabled() |
| 277 | + |
| 278 | + |
| 279 | +def test_long_running_command_shows_currently_running_text_dropdown(qtbot): |
| 280 | + """ |
| 281 | + Test that A button with multiple-cmds (so it has a drop-down menu) is updated to indicate |
| 282 | + a drop-down menu command is currently running. |
| 283 | + These indications are: |
| 284 | + - Prepend "(Submenu cmd running...) " to the button's text |
| 285 | + - Prepend "(Running...) " to the curr running drop-down item |
| 286 | + - Make button and curr running drop-down text italic |
| 287 | + - Disable button and all drop-down menu items while cmd is running (unless allowMultipleExecutions is set True) |
| 288 | + - Set both button and curr running drop-down icons to hourglass symbol |
| 289 | + And the button should be reset back to it's original state after the command is done. |
| 290 | + """ |
| 291 | + pydm_shell_command = PyDMShellCommand() |
| 292 | + qtbot.addWidget(pydm_shell_command) |
| 293 | + pydm_shell_command.stdout = TermOutputMode.SHOW |
| 294 | + |
| 295 | + original_button_text = "Run Long Cmd" |
| 296 | + # Text of the specific item in drop-down we want to check the state of |
| 297 | + original_action_text = "for i in {1..50}; do echo $i; sleep 1; done" |
| 298 | + pydm_shell_command.setText(original_button_text) |
| 299 | + pydm_shell_command.runCommandsInFullShell = True |
| 300 | + |
| 301 | + pydm_shell_command.commands = ["echo 'command 1'", "echo 'command 2'", original_action_text] |
| 302 | + |
| 303 | + # We need to execute the shell-cmd's mousePressEvent() so it can build the drop-down menu, |
| 304 | + # and right-click since left-click seems to cause this test to then display the drop-down menu |
| 305 | + # and just pauses waiting for user interaction. |
| 306 | + qtbot.mouseClick(pydm_shell_command, QtCore.Qt.RightButton) |
| 307 | + |
| 308 | + actions = pydm_shell_command.menu().actions() |
| 309 | + assert len(actions) >= 3 |
| 310 | + |
| 311 | + # Activate drop-down menu button cmd |
| 312 | + actions[2].trigger() |
| 313 | + # Wait a bit for things to update |
| 314 | + qtbot.wait(100) # Wait 0.1 seconds |
| 315 | + |
| 316 | + # Check button icon is changed while cmd is running |
| 317 | + icon_size = QSize(16, 16) |
| 318 | + default_icon = IconFont().icon("hourglass-start") |
| 319 | + default_icon_pixmap = default_icon.pixmap(icon_size) |
| 320 | + curr_icon_pixmap = pydm_shell_command.icon().pixmap(icon_size) |
| 321 | + assert curr_icon_pixmap.toImage() == default_icon_pixmap.toImage() |
| 322 | + |
| 323 | + assert pydm_shell_command.text() == f"(Submenu cmd running...) {original_button_text}" |
| 324 | + assert pydm_shell_command.font().italic() |
| 325 | + |
| 326 | + # Check state of action buttons in drop-down menu |
| 327 | + # Check icon is changed on curr running action button while cmd is running |
| 328 | + default_icon = IconFont().icon("hourglass-start") |
| 329 | + default_icon_pixmap = default_icon.pixmap(icon_size) |
| 330 | + curr_icon_pixmap = actions[2].icon().pixmap(icon_size) |
| 331 | + assert curr_icon_pixmap.toImage() == default_icon_pixmap.toImage() |
| 332 | + |
| 333 | + assert actions[2].text() == f"(Running...) {original_action_text}" |
| 334 | + assert actions[2].font().italic() |
| 335 | + |
| 336 | + assert all(not action.isEnabled() for action in actions) |
| 337 | + |
| 338 | + # End process since we are done checking the 'running' state of the button |
| 339 | + if pydm_shell_command.process: |
| 340 | + pydm_shell_command.process.kill() |
| 341 | + |
| 342 | + # Wait a bit for things to update |
| 343 | + qtbot.wait(100) # wait 0.1 seconds |
| 344 | + |
| 345 | + # Check button icon is reverted back after cmd stops running |
| 346 | + default_icon = IconFont().icon("cog") |
| 347 | + default_icon_pixmap = default_icon.pixmap(icon_size) |
| 348 | + curr_icon_pixmap = pydm_shell_command.icon().pixmap(icon_size) |
| 349 | + assert curr_icon_pixmap.toImage() == default_icon_pixmap.toImage() |
| 350 | + |
| 351 | + assert pydm_shell_command.text() == original_button_text |
| 352 | + assert not pydm_shell_command.font().italic() |
| 353 | + |
| 354 | + # Check drop-down menu icon is reverted |
| 355 | + actions[2].icon().isNull() # Drop-down menu cmds have no icon by default |
| 356 | + assert all(action.isEnabled() for action in actions) |
| 357 | + |
| 358 | + |
221 | 359 | @pytest.mark.parametrize( |
222 | 360 | "allow_multiple", |
223 | 361 | [ |
|
0 commit comments