EHSTSWRQ-54: tests with temporary paths

Author: jespinosaar

astroquery/esa/integral/core.py

@@ -348,7 +348,8 @@ def download_science_windows(self, *, science_windows=None, observation_id=None,
 
         Returns
         -------
-        The path and filename of the file with science windows
+        If read_fits=True, a list with objects containing filename, path and FITS file opened with the
+        science windows. If read_fits=False, the path of the downloaded file
         """
 
         # Validate and retrieve the correct value
@@ -469,7 +470,7 @@ def get_long_term_timeseries(self, target_name, *, instrument=None, band=None, p
         Returns
         -------
         If read_fits=True, a list with objects containing filename, path and FITS file opened with long
-        term timeseries. If read_fits=False, return the path of the downloaded file
+        term timeseries. If read_fits=False, the path of the downloaded file
         """
 
         value = self.__get_instrument_or_band(instrument=instrument, band=band)
@@ -516,7 +517,7 @@ def get_short_term_timeseries(self, target_name, epoch, instrument=None, band=No
         Returns
         -------
         If read_fits=True, a list with objects containing filename, path and FITS file opened with short
-        term timeseries. If read_fits=False, return the path of the downloaded file
+        term timeseries. If read_fits=False, the path of the downloaded file
 
         """
 
@@ -569,7 +570,7 @@ def get_spectra(self, target_name, epoch, instrument=None, band=None, *, path=''
         Returns
         -------
         If read_fits=True, a list with objects containing filename, path and FITS file opened with spectra.
-        If read_fits=False, return a list of paths of the downloaded files
+        If read_fits=False, a list of paths of the downloaded files
         """
 
         value = self.__get_instrument_or_band(instrument=instrument, band=band)
@@ -633,7 +634,7 @@ def get_mosaic(self, epoch, instrument=None, band=None, *, path='', filename=Non
         Returns
         -------
         If read_fits=True, a list with objects containing filename, path and FITS file opened with mosaics.
-        If read_fits=False, return a list of paths of the downloaded files
+        If read_fits=False, a list of paths of the downloaded files
         """
 
         self.__validate_epoch(epoch=epoch,

astroquery/esa/integral/tests/test_isla_remote.py

@@ -9,7 +9,9 @@
 
 """
 import os
+import tempfile
 
+from astropy.coordinates import SkyCoord
 from astroquery.esa.integral import IntegralClass
 import pytest
 from pyvo import DALQueryError
@@ -29,6 +31,10 @@ def close_files(file_list):
         close_file(file['fits'])
 
 
+def create_temp_folder():
+    return tempfile.TemporaryDirectory()
+
+
 @pytest.mark.remote_data
 class TestIntegralRemote:
 
@@ -54,10 +60,13 @@ def test_query_tap(self):
         assert 'Unknown table' in err.value.args[0]
 
         # Store the result in a file
-        filename = 'query_tap.votable'
+        temp_folder = create_temp_folder()
+        filename = os.path.join(temp_folder.name, 'query_tap.votable')
         isla.query_tap('select top 10 * from ivoa.obscore;', output_file=filename)
         assert os.path.exists(filename)
 
+        temp_folder.cleanup()
+
     def test_get_sources(self):
         isla = IntegralClass()
         sources = isla.get_sources(target_name='crab')
@@ -118,9 +127,13 @@ def test_get_observations(self):
     def test_download_science_windows(self):
         # Simple download
         isla = IntegralClass()
-        sc = isla.download_science_windows(science_windows='008100430010')
+        temp_folder = create_temp_folder()
+        output_file = os.path.join(temp_folder.name, 'sc')
+        sc = isla.download_science_windows(science_windows='008100430010', output_file=output_file)
         assert len(sc) > 1
 
+        close_files(sc)
+
         # Only one parameter is allowed
         with pytest.raises(ValueError) as err:
             isla.download_science_windows(science_windows='008100430010', observation_id='03200490001')
@@ -131,17 +144,21 @@ def test_download_science_windows(self):
             isla.download_science_windows(revolution=12)
         assert 'Input parameters are wrong' in err.value.args[0]
 
+        temp_folder.cleanup()
+
     def test_get_timeline(self):
         isla = IntegralClass()
-        timeline = isla.get_timeline(coordinates='83.63320922851562 22.01447105407715')
+        coords = SkyCoord(ra=83.63320922851562, dec=22.01447105407715, unit="deg")
+        timeline = isla.get_timeline(coordinates=coords)
 
         assert timeline is not None
         assert 'timeline' in timeline
         assert timeline['total_items'] == len(timeline['timeline'])
 
         # No timeline has been found
+        zero_coords = SkyCoord(ra=0, dec=0, unit="deg")
         with pytest.raises(ValueError) as err:
-            isla.get_timeline(coordinates='0 0', radius=0.8)
+            isla.get_timeline(coordinates=zero_coords, radius=0.8)
         assert 'No timeline is available for the current coordinates and radius.' in err.value.args[0]
 
     def test_get_epochs(self):
@@ -167,12 +184,16 @@ def test_get_epochs(self):
         assert len(epochs) == 0
 
     def test_get_long_term_timeseries(self):
+        temp_folder = create_temp_folder()
+
         isla = IntegralClass()
-        ltt = isla.get_long_term_timeseries(target_name='J174537.0-290107', instrument='jem-x')
+        ltt = isla.get_long_term_timeseries(target_name='J174537.0-290107', instrument='jem-x', path=temp_folder.name)
 
         assert len(ltt) > 0
         assert 'fits' in ltt[0]
 
+        close_files(ltt)
+
         # No correct instrument or band
         with pytest.raises(ValueError) as err:
             isla.get_long_term_timeseries(target_name='J174537.0-290107', instrument='test')
@@ -182,21 +203,26 @@ def test_get_long_term_timeseries(self):
         ltt = isla.get_long_term_timeseries(target_name='star', instrument='jem-x')
         assert ltt is None
 
+        temp_folder.cleanup()
+
     def test_get_short_term_timeseries(self):
+        temp_folder = create_temp_folder()
+
         isla = IntegralClass()
-        stt = isla.get_short_term_timeseries(target_name='J011705.1-732636', band='28_40', epoch='0745_06340000001')
+        stt = isla.get_short_term_timeseries(target_name='J011705.1-732636', band='28_40', epoch='0745_06340000001',
+                                             path=temp_folder.name)
 
         assert len(stt) > 0
         assert 'fits' in stt[0]
 
+        close_files(stt)
+
         # No correct instrument or band
-        print('error instrument')
         with pytest.raises(ValueError) as err:
             isla.get_short_term_timeseries(target_name='J011705.1-732636', band='1234', epoch='0745_06340000001')
         assert 'This is not a valid value for instrument or band.' in err.value.args[0]
 
         # No correct epoch
-        print('error band')
         with pytest.raises(ValueError) as err:
             isla.get_short_term_timeseries(target_name='J011705.1-732636', band='28_40', epoch='123456')
         assert 'Epoch 123456 is not available for this target and instrument/band.' in err.value.args[0]
@@ -206,13 +232,20 @@ def test_get_short_term_timeseries(self):
             isla.get_short_term_timeseries(target_name='star', band='28_40', epoch='0745_06340000001')
         assert 'Epoch 0745_06340000001 is not available for this target and instrument/band.' in err.value.args[0]
 
+        temp_folder.cleanup()
+
     def test_get_spectra(self):
+        temp_folder = create_temp_folder()
+
         isla = IntegralClass()
-        spectra = isla.get_spectra(target_name='J011705.1-732636', instrument='ibis', epoch='0745_06340000001')
+        spectra = isla.get_spectra(target_name='J011705.1-732636', instrument='ibis', epoch='0745_06340000001',
+                                   path=temp_folder.name)
 
         assert len(spectra) > 0
         assert 'fits' in spectra[0]
 
+        close_files(spectra)
+
         # No correct instrument or band
         with pytest.raises(ValueError) as err:
             isla.get_spectra(target_name='J011705.1-732636', instrument='camera', epoch='0745_06340000001')
@@ -228,13 +261,19 @@ def test_get_spectra(self):
             isla.get_spectra(target_name='star', instrument='ibis', epoch='0745_06340000001')
         assert 'Epoch 0745_06340000001 is not available for this target and instrument/band.' in err.value.args[0]
 
+        temp_folder.cleanup()
+
     def test_get_mosaics(self):
+        temp_folder = create_temp_folder()
+
         isla = IntegralClass()
-        mosaics = isla.get_mosaic(epoch='0727_88601650001', instrument='ibis')
+        mosaics = isla.get_mosaic(epoch='0727_88601650001', instrument='ibis', path=temp_folder.name)
 
         assert len(mosaics) > 0
         assert 'fits' in mosaics[0]
 
+        close_files(mosaics)
+
         # No correct instrument or band
         with pytest.raises(ValueError) as err:
             isla.get_mosaic(epoch='0727_88601650001', instrument='camera')
@@ -244,3 +283,5 @@ def test_get_mosaics(self):
         with pytest.raises(ValueError) as err:
             isla.get_mosaic(epoch='123456', instrument='ibis')
         assert 'Epoch 123456 is not available for this target and instrument/band.' in err.value.args[0]
+
+        temp_folder.cleanup()

astroquery/esa/integral/tests/test_isla_tap.py

@@ -9,6 +9,8 @@
 
 """
 import os
+import shutil
+import tempfile
 
 from astropy.coordinates import SkyCoord
 from astroquery.esa.integral import IntegralClass
@@ -30,6 +32,16 @@ def data_path(filename):
     return os.path.join(data_dir, filename)
 
 
+def create_temp_folder():
+    return tempfile.TemporaryDirectory()
+
+
+def copy_to_temporal_path(data_path, temp_folder, filename):
+    temp_data_dir = os.path.join(temp_folder.name, filename)
+    shutil.copy(data_path, temp_data_dir)
+    return temp_data_dir
+
+
 def close_file(file):
     file.close()
 
@@ -325,7 +337,6 @@ def test_download_science_windows_error(self, instrument_band_mock, download_moc
     @patch('astroquery.esa.integral.core.IntegralClass.get_instrument_band_map')
     def test_download_science_windows(self, instrument_band_mock, download_mock):
         instrument_band_mock.return_value = mocks.get_instrument_bands()
-        download_mock.return_value = 'file.test'
 
         isla = IntegralClass()
         with pytest.raises(ValueError) as err:
@@ -336,11 +347,19 @@ def test_download_science_windows(self, instrument_band_mock, download_mock):
             isla.download_science_windows(science_windows='sc', observation_id='obs')
         assert 'Only one parameter can be provided at a time.' in err.value.args[0]
 
-        isla.download_science_windows(science_windows='sc')
+        temp_path = create_temp_folder()
+        temp_file = copy_to_temporal_path(data_path=data_path('zip_file.zip'), temp_folder=temp_path,
+                                          filename='zip_file.zip')
+        download_mock.return_value = temp_file
+
+        sc = isla.download_science_windows(science_windows='sc')
 
         args, kwargs = download_mock.call_args
         assert kwargs['params']['RETRIEVAL_TYPE'] == 'SCW'
 
+        close_files(sc)
+        temp_path.cleanup()
+
     @patch('astroquery.esa.integral.core.pyvo.dal.TAPService.capabilities', [])
     @patch('astroquery.esa.utils.utils.execute_servlet_request')
     @patch('astroquery.esa.integral.core.IntegralClass.get_instrument_band_map')
@@ -349,7 +368,8 @@ def test_get_timeline(self, instrument_band_mock, servlet_mock):
         servlet_mock.return_value = mocks.get_mock_timeline()
 
         isla = IntegralClass()
-        timeline = isla.get_timeline(coordinates='83.63320922851562 22.01447105407715')
+        coords = SkyCoord(ra=83.63320922851562, dec=22.01447105407715, unit="deg")
+        timeline = isla.get_timeline(coordinates=coords)
 
         assert len(timeline['timeline']['scwRevs']) > 0
 
@@ -412,7 +432,11 @@ def test_get_long_term_timeseries_exception(self, instrument_band_mock, log_mock
     @patch('astroquery.esa.integral.core.IntegralClass.get_instrument_band_map')
     def test_get_long_term_timeseries(self, instrument_band_mock, download_mock):
         instrument_band_mock.return_value = mocks.get_instrument_bands()
-        download_mock.return_value = data_path('zip_file.zip')
+
+        temp_path = create_temp_folder()
+        temp_file = copy_to_temporal_path(data_path=data_path('zip_file.zip'), temp_folder=temp_path,
+                                          filename='zip_file.zip')
+        download_mock.return_value = temp_file
 
         isla = IntegralClass()
         mock_instrument_bands(isla_module=isla)
@@ -423,6 +447,7 @@ def test_get_long_term_timeseries(self, instrument_band_mock, download_mock):
                                                                       read_fits=False)
         assert type(lt_timeseries_list_compressed) is str
         close_files(lt_timeseries_list_extracted)
+        temp_path.cleanup()
 
     @patch('astroquery.esa.integral.core.pyvo.dal.TAPService.capabilities', [])
     @patch('astroquery.esa.integral.core.log')
@@ -482,7 +507,10 @@ def test_get_short_term_timeseries(self, instrument_band_mock, epoch_mock, downl
 
         instrument_band_mock.return_value = mocks.get_instrument_bands()
         epoch_mock.return_value = {'epoch': ['time']}
-        download_mock.return_value = data_path('tar_file.tar')
+        temp_path = create_temp_folder()
+        temp_file = copy_to_temporal_path(data_path=data_path('tar_file.tar'), temp_folder=temp_path,
+                                          filename='tar_file.tar')
+        download_mock.return_value = temp_file
 
         isla = IntegralClass()
         mock_instrument_bands(isla_module=isla)
@@ -495,6 +523,7 @@ def test_get_short_term_timeseries(self, instrument_band_mock, epoch_mock, downl
         assert type(st_timeseries_list_compressed) is str
 
         close_files(st_timeseries_list_extracted)
+        temp_path.cleanup()
 
     @patch('astroquery.esa.integral.core.pyvo.dal.TAPService.capabilities', [])
     @patch('astroquery.esa.integral.core.log')
@@ -558,7 +587,10 @@ def test_get_spectra(self, instrument_band_mock, servlet_mock, epoch_mock, downl
         instrument_band_mock.return_value = mocks.get_instrument_bands()
         servlet_mock.return_value = mocks.get_mock_spectra()
         epoch_mock.return_value = {'epoch': ['today']}
-        download_mock.return_value = data_path('tar_file.tar')
+        temp_path = create_temp_folder()
+        temp_file = copy_to_temporal_path(data_path=data_path('tar_file.tar'), temp_folder=temp_path,
+                                          filename='tar_file.tar')
+        download_mock.return_value = temp_file
 
         isla = IntegralClass()
         mock_instrument_bands(isla_module=isla)
@@ -571,6 +603,7 @@ def test_get_spectra(self, instrument_band_mock, servlet_mock, epoch_mock, downl
         assert type(spectra_list_compressed) is list
 
         close_files(spectra_list_extracted)
+        temp_path.cleanup()
 
     @patch('astroquery.esa.integral.core.pyvo.dal.TAPService.capabilities', [])
     @patch('astroquery.esa.integral.core.log')
@@ -614,7 +647,10 @@ def test_get_mosaic(self, instrument_band_mock, servlet_mock, epoch_mock, downlo
         instrument_band_mock.return_value = mocks.get_instrument_bands()
         servlet_mock.return_value = mocks.get_mock_mosaic()
         epoch_mock.return_value = {'epoch': ['today']}
-        download_mock.return_value = data_path('tar_gz_file.gz')
+        temp_path = create_temp_folder()
+        temp_file = copy_to_temporal_path(data_path=data_path('tar_gz_file.gz'), temp_folder=temp_path,
+                                          filename='tar_gz_file.gz')
+        download_mock.return_value = temp_file
 
         isla = IntegralClass()
         mock_instrument_bands(isla_module=isla)
@@ -625,6 +661,7 @@ def test_get_mosaic(self, instrument_band_mock, servlet_mock, epoch_mock, downlo
 
         assert type(mosaics_compressed) is list
         close_files(mosaics_extracted)
+        temp_path.cleanup()
 
     @patch('astroquery.esa.integral.core.pyvo.dal.TAPService.capabilities', [])
     @patch('astroquery.esa.utils.utils.execute_servlet_request')