Fix the path for finding the herd zip file. (#1046)

* fix

* test

* test

* Update CHANGELOG.md

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## HDMF 3.12.1 (Upcoming)
 
 ### Bug fixes
+- Fixed retrieving the correct path for a `HERD` zip file on read. [#1046](https://github.com/hdmf-dev/hdmf/pull/1046)
 - Fixed internal links in docstrings and tutorials. @stephprince [#1031](https://github.com/hdmf-dev/hdmf/pull/1031)
 - Fixed issue with creating documentation links to classes in docval arguments. @rly [#1036](https://github.com/hdmf-dev/hdmf/pull/1036)
 

src/hdmf/common/resources.py

@@ -989,14 +989,23 @@ def to_zip(self, **kwargs):
         for file in files:
             os.remove(file)
 
+    @classmethod
+    @docval({'name': 'path', 'type': str, 'doc': 'The path to the zip file.'})
+    def get_zip_directory(cls, path):
+        """
+        Return the directory of the file given.
+        """
+        directory = os.path.dirname(os.path.realpath(path))
+        return directory
+
     @classmethod
     @docval({'name': 'path', 'type': str, 'doc': 'The path to the zip file.'})
     def from_zip(cls, **kwargs):
         """
         Method to read in zipped tsv files to populate HERD.
         """
         zip_file = kwargs['path']
-        directory = os.path.dirname(zip_file)
+        directory = cls.get_zip_directory(zip_file)
 
         with zipfile.ZipFile(zip_file, 'r') as zip:
             zip.extractall(directory)

tests/unit/common/test_resources.py

@@ -52,6 +52,7 @@ def remove_er_files(self):
         remove_test_file('./keys.tsv')
         remove_test_file('./files.tsv')
         remove_test_file('./HERD.zip')
+        remove_test_file('./HERD2.zip')
 
     def child_tsv(self, external_resources):
         for child in external_resources.children:
@@ -737,6 +738,25 @@ def test_to_and_from_zip(self):
 
         self.remove_er_files()
 
+    def test_get_zip_directory(self):
+        er = HERD()
+        data = Data(name="species", data=['Homo sapiens', 'Mus musculus'])
+        er.add_ref(file=HERDManagerContainer(name='file'),
+                   container=data,
+                   key='key1',
+                   entity_id='entity_id1',
+                   entity_uri='entity1')
+
+        er.to_zip(path='./HERD.zip')
+        er.to_zip(path='HERD2.zip')
+
+        d1 = er.get_zip_directory('./HERD.zip')
+        d2 = er.get_zip_directory('HERD2.zip')
+
+        self.assertEqual(d1,d2)
+
+        self.remove_er_files()
+
     def test_to_and_from_zip_entity_value_error(self):
         er = HERD()
         data = Data(name="species", data=['Homo sapiens', 'Mus musculus'])