Adding GUI pytest mark (#1269)

* Implement the option to run inplace. Using original jobname.

* Making sure the start_parameter is updated and stored.

* Added MAPDLdidnotstart exception class.

* Using new error class.

* Updated docstring.

* removing error classes.

* small fix.

* Making sure there is no edge cases in args

* Fixing coverage and adding unit tests to error classes.

* Updating docstrings

* Added '--gui' and '--only_gui' command line options

* Adding function to test.

* Adding unit test and changing flag option

* fixing static

* Update tests/test_launcher.py

Co-authored-by: Alex Kaszynski <[email protected]>

Author: germa89

pytest.ini

@@ -11,4 +11,5 @@ filterwarnings =
 markers =
     skip_grpc: skip tests using grpc
     corba: skip tests using the CORBA interface
+    gui: skip tests that launch the GUI interface
 testpaths = tests

tests/conftest.py

@@ -125,6 +125,10 @@ def pytest_addoption(parser):
     parser.addoption(
         "--console", action="store_true", default=False, help="run console tests"
     )
+    parser.addoption("--gui", action="store_true", default=False, help="run GUI tests")
+    parser.addoption(
+        "--only-gui", action="store_true", default=False, help="run only GUI tests"
+    )
 
 
 def pytest_collection_modifyitems(config, items):
@@ -148,6 +152,21 @@ def pytest_collection_modifyitems(config, items):
             if "skip_grpc" in item.keywords:
                 item.add_marker(skip_grpc)
 
+    only_gui_filter = config.getoption("--only-gui")
+    if only_gui_filter:
+        new_items = []
+        for item in items:
+            mark = item.get_closest_marker("requires_gui")
+            if mark and mark.name == "requires_gui":
+                new_items.append(item)
+        items[:] = new_items
+
+    if not config.getoption("--gui") and not only_gui_filter:
+        skip_gui = pytest.mark.skip(reason="Requires to launch MAPDL GUI interface.")
+        for item in items:
+            if "requires_gui" in item.keywords:
+                item.add_marker(skip_gui)
+
 
 @pytest.fixture(scope="session")
 def mapdl_console(request):

tests/test_launcher.py

@@ -299,3 +299,20 @@ def test_warn_uncommon_executable_path():
         UserWarning, match="does not match the usual ansys executable path style"
     ):
         warn_uncommon_executable_path("")
+
+
+@pytest.mark.requires_gui
+def test_open_gui(mapdl):
+
+    mapdl.open_gui()
+    mapdl.open_gui(include_result=True)
+    mapdl.open_gui(inplace=True)
+
+    mapdl.open_gui(include_result=False)
+    mapdl.open_gui(inplace=False)
+
+    mapdl.open_gui(include_result=True, inplace=False)
+    mapdl.open_gui(include_result=False, inplace=True)
+
+    mapdl.open_gui(include_result=False, inplace=False)
+    mapdl.open_gui(include_result=True, inplace=True)