Fix/filename and paths in cdread (#631)

* Added missing extension argument in fname.

Added a check to make sure the fname is the complete file path.

* Added test

* Now pyansys will look for both possible options. (python and mapdl execution folders)

* small things.

* Adding the possibility of using fname + extension in cdread.

* Added skipif for the test which requires to create a folder.

* Format fixing.

* Format fixing.

* Format fixing.

* Apply suggestions from code review

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

* Fixing test in CICD.

* Format fixing.

* Added more test to increase test coverage.

* Fixing default extension issue and adding more test cases.

* Fixng style.

* Update test_mapdl.py

Grammar fixing.

* Update test_mapdl.py

Fixing whitespacing.

* changed parameter testing name.

* Simplified input file name checks.

* fixing database extension convention.

* Fixing parsav on local.

* Fxing database file extension.

* Fixing linux path issue.

* Fixing style.

* Fixing cdb extensions.

* Trying to fix linux path issue.

* address remote edge-case

* simply assume that file must be remote

* provide full path

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

Author: germa89

ansys/mapdl/core/_commands/apdl/parameter_definition.py

@@ -377,13 +377,19 @@ def parres(self, lab="", fname="", ext="", **kwargs):
 
         if "Grpc" in self.__class__.__name__:  # grpc mode
             if self._local:
-                if not os.path.isfile(fname):
-                    raise FileNotFoundError('Unable to locate filename "%s"' % fname)
-
-                if not os.path.dirname(fname):
+                # It must be a file!
+                if os.path.isfile(fname):
+                    # And it exist!
                     filename = os.path.join(os.getcwd(), fname)
+                elif fname in self.list_files(): #
+                    # It exists in the Mapdl working directory
+                    filename = os.path.join(self.directory, fname)
+                elif os.path.dirname(fname):
+                    raise ValueError(f"'{fname}' appears to be an incomplete directory path rather than a filename.")
                 else:
-                    filename = fname
+                    # Finally
+                    raise FileNotFoundError(f"Unable to locate filename '{fname}'")
+
             else:
                 if not os.path.dirname(fname):
                     # might be trying to run a local file.  Check if the

ansys/mapdl/core/mapdl_grpc.py

@@ -989,8 +989,19 @@ def cdread(self, *args, **kwargs):
                 "Input the geometry and mesh files separately "
                 r'with "\INPUT" or ``mapdl.input``'
             )
-
+        # the old behaviour is to supplied the name and the extension separatelly.
+        # to make it easier let's going to allow names with extensions
         fname = kwargs.get("fname", args[1])
+        basename = os.path.basename(fname)
+        if len(basename.split('.')) == 1:
+            # there is no extension in the main name.
+            if len(args) > 2:
+                # if extension is an input as an option (old APDL style)
+                fname = kwargs.get("fname", args[1])  + '.' + kwargs.get("ext", args[2])
+            else:
+                # Using default .db
+                fname = kwargs.get("fname", args[1])  + '.' + 'cdb'
+
         kwargs.setdefault("verbose", False)
         kwargs.setdefault("progress_bar", False)
         self.input(fname, **kwargs)
@@ -1049,22 +1060,37 @@ def input(
         # always check if file is present as the grpc and MAPDL errors
         # are unclear
         if self._local:
-            if not os.path.isfile(fname):
-                raise FileNotFoundError('Unable to locate filename "%s"' % fname)
-
-            if not os.path.dirname(fname):
-                filename = os.path.join(os.getcwd(), fname)
+            if os.path.isdir(fname):
+                raise ValueError(f"`fname` should be a full file path or name, not the directory '{fname}'.")
             else:
-                filename = fname
+                # It must be a file!
+                if os.path.isfile(fname):
+                    # And it exist!
+                    filename = os.path.join(os.getcwd(), fname)
+                elif fname in self.list_files(): #
+                    # It exists in the Mapdl working directory
+                    filename = os.path.join(self.directory, fname)
+                elif os.path.dirname(fname):
+                    raise ValueError(f"'{fname}' appears to be an incomplete directory path rather than a filename.")
+                else:
+                    # Finally
+                    raise FileNotFoundError(f"Unable to locate filename '{fname}'")
+
         else:
             if not os.path.dirname(fname):
                 # might be trying to run a local file.  Check if the
                 # file exists remotely.
                 if fname not in self.list_files():
                     self.upload(fname, progress_bar=progress_bar)
+                filename = fname
             else:
-                self.upload(fname, progress_bar=progress_bar)
-            filename = os.path.basename(fname)
+                # upload the file if it exists locally
+                if os.path.isfile(fname):
+                    self.upload(fname, progress_bar=progress_bar)
+                    filename = os.path.basename(fname)
+                else:
+                    # Otherwise, it must be remote.  Use full path.
+                    filename = fname
 
         if time_step_stream is not None:
             if time_step_stream <= 0:

tests/conftest.py

@@ -38,6 +38,7 @@
 
 
 # determine if we can launch an instance of MAPDL locally
+# start with ``False`` and always assume the remote case
 local = [False]
 
 # check if the user wants to permit pytest to start MAPDL

tests/test_mapdl.py

@@ -12,10 +12,17 @@
 from pyvista.plotting import system_supports_plotting
 from pyvista.plotting.renderer import CameraPosition
 
+from ansys.mapdl.core.launcher import get_start_instance
+
 skip_no_xserver = pytest.mark.skipif(
     not system_supports_plotting(), reason="Requires active X Server"
 )
 
+skip_in_cloud = pytest.mark.skipif(
+    not get_start_instance(),
+    reason="Must be able to launch MAPDL locally. Cloud does not allow create folders."
+)
+
 
 CMD_BLOCK = """/prep7
 ! Mat
@@ -32,6 +39,65 @@
 vmesh,all
 """
 
+## Testing CDREAD and CDWRITE
+# DB file generated locally with ANSYS.
+# Many of the commands could be deleted, but for the sake of good
+# testing we are going to leave them.
+
+CDB_FILE = """/COM,ANSYS RELEASE 2021 R2           BUILD 21.2
+/PREP7
+/NOPR
+/TITLE,'CDREAD and CDWRITE tests
+*IF,_CDRDOFF,EQ,1,THEN     !if solid model was read in
+_CDRDOFF=             !reset flag, numoffs already performed
+*ELSE              !offset database for the following FE model
+*ENDIF
+*SET,T_PAR,'asdf1234'
+*SET,_RETURN ,  0.000000000000
+*SET,_STATUS ,  0.000000000000
+*SET,_UIQR   ,  1.000000000000
+DOF,DELETE
+EXTOPT,ATTR,      0,      0,      0
+EXTOPT,ESIZE,  0,  0.0000
+EXTOPT,ACLEAR,      0
+TREF,  0.00000000
+IRLF,  0
+BFUNIF,TEMP,_TINY
+ACEL,  0.00000000    ,  0.00000000    ,  0.00000000
+OMEGA,  0.00000000    ,  0.00000000    ,  0.00000000
+DOMEGA,  0.00000000    ,  0.00000000    ,  0.00000000
+CGLOC,  0.00000000    ,  0.00000000    ,  0.00000000
+CGOMEGA,  0.00000000    ,  0.00000000    ,  0.00000000
+DCGOMG,  0.00000000    ,  0.00000000    ,  0.00000000
+
+KUSE,     0
+TIME,  0.00000000
+ALPHAD,  0.00000000
+BETAD,  0.00000000
+DMPRAT,  0.00000000
+DMPSTR,  0.00000000
+CRPLIM, 0.100000000    ,   0
+CRPLIM,  0.00000000    ,   1
+NCNV,     1,  0.00000000    ,     0,  0.00000000    ,  0.00000000
+NEQIT,     0
+
+ERESX,DEFA
+/GO
+FINISH
+"""
+
+
+def clearing_cdread_cdwrite_tests(mapdl):
+    mapdl.finish(mute=True)
+    # *MUST* be NOSTART.  With START fails after 20 calls...
+    # this has been fixed in later pymapdl and MAPDL releases
+    mapdl.clear("NOSTART", mute=True)
+    mapdl.prep7(mute=True)
+
+
+def asserting_cdread_cdwrite_tests(mapdl):
+    return 'asdf1234' in mapdl.parameters['T_PAR']  # Using in because of the padding APDL does on strings.
+
 
 @pytest.fixture(scope="function")
 def make_block(mapdl, cleared):
@@ -612,6 +678,113 @@ def test_coriolis(mapdl, cleared):
     assert "PRINT ROTOR MASS SUMMARY ACTIVATED" in resp
 
 
+def test_title(mapdl, cleared):
+    title = 'title1'  # the title cannot be longer than 7 chars. Check *get,parm,active,0,title for more info.
+    mapdl.title(title)
+    assert title == mapdl.get('par', 'active', '0', 'title')
+
+
+def test_cdread(mapdl, cleared):
+    random_letters = mapdl.directory.split('/')[0][-3:0]
+
+    mapdl.run(f"parmtest='{random_letters}'")
+    mapdl.cdwrite('all', 'model2', 'cdb')
+
+    mapdl.clear()
+    mapdl.cdread("db", 'model2', 'cdb')
+
+    assert random_letters == mapdl.parameters['parmtest']
+
+
+# CDREAD tests are actually a good way to test 'input' command.
+@skip_in_cloud
+def test_cdread_different_location(mapdl, cleared, tmpdir):
+    random_letters = mapdl.directory.split('/')[0][-3:0]
+    dirname = 'tt' + random_letters
+
+    curdir = mapdl.directory
+    subdir = tmpdir.mkdir(dirname)
+
+    mapdl.run(f"parmtest='{random_letters}'")
+    mapdl.cdwrite('all', subdir.join('model2'), 'cdb')
+
+    mapdl.clear()
+    mapdl.cwd(subdir)
+    mapdl.cdread("db", 'model2', "cdb")
+    mapdl.cwd(curdir)  #Going back
+
+    assert random_letters == mapdl.parameters['parmtest']
+
+
+def test_cdread_in_python_directory(mapdl, cleared):
+    # Writing db file in python directory.
+    # Pyansys should upload it when it detects it is not in the APDL directory.
+    with open('model.cdb', 'w') as file:
+        file.write(CDB_FILE)
+
+    mapdl.cdread('cdb', 'model', 'cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    mapdl.cdread('cdb', 'model.cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    mapdl.cdread('cdb', 'model')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(os.getcwd(), 'model.cdb')
+    mapdl.cdread('cdb', fullpath)
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(os.getcwd(), 'model')
+    mapdl.cdread('cdb', fullpath, 'cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(os.getcwd(), 'model')
+    mapdl.cdread('cdb', fullpath)
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+
+def test_cdread_in_apdl_directory(mapdl, cleared):
+    # Writing a db file in apdl directory, using APDL.
+    # Using APDL to write the archive as there are be cases where the
+    # python code cannot reach the APDL execution directory because it
+    # is remote.
+    mapdl.run("*SET,T_PAR,'asdf1234'")
+    mapdl.run("CDWRITE,'DB','model','cdb'")
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    mapdl.cdread('db', 'model', 'cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    mapdl.cdread('db', 'model.cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    mapdl.cdread('db', 'model')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(mapdl.directory, 'model.cdb')
+    mapdl.cdread('db', fullpath)
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(mapdl.directory, 'model')
+    mapdl.cdread('db', fullpath, 'cdb')
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+    clearing_cdread_cdwrite_tests(mapdl)
+    fullpath = os.path.join(mapdl.directory, 'model')
+    mapdl.cdread('db', fullpath)
+    assert asserting_cdread_cdwrite_tests(mapdl)
+
+
 def test_inval_commands(mapdl, cleared):
     """Test the output of invalid commands"""
     cmds = ["*END", "*vwrite", "/eof", "cmatrix"]