Migrate possible ICD test back to backend unit test

[kswang1029]

This is a step of making the automated test robust and informative. Detailed list of which ICD tests to be migrated is TBD (work-in-progress list here)

todo list based on the C column of the above spreadsheet (each should be a separate PR):

• [x] ACCESS_CARTA
• [x] ANIMATION
• [x] REGION_REGISTER
• [x] GET_FILELIST_DEFAULT_PATH, GET_FILELIST_UNKNOWN_PATH, FILETYPE_PARSER
• [x] FILE_INFO*
• [ ] REGION_LIST, REGION_INFO
• [ ] CASA_REGION*
• [ ] DS9_REGION*
• [ ] CATALOG_LIST
• [ ] CATALOG_FITS_VOT, CATALOG_GENERAL
• [ ] CHECK_RASTER_TILE_DATA
• [x] CONTOUR_IMAGE_DATA, CONTOUR_IMAGE_DATA_NAN
• [ ] CURSOR_SPATIAL_PROFILE, CURSOR_SPATIAL_PROFILE_NAN
• [ ] POINT_REGION_SPATIAL_PROFILE, POINT_REGION_SPATIAL_PROFILE_NAN
• [ ] CURSOR_SPECTRAL_PROFILE, CURSOR_SPECTRAL_PROFILE_NAN
• [ ] POINT_REGION_SPECTRAL_PROFILE, POINT_REGION_SPECTRAL_PROFILE_NAN
• [ ] REGION_SPECTRAL*
• [ ] REGION_STATISTICS*
• [ ] MATCH_*
• [ ] MOMENTGENERATOR*
• [ ] OPENFILE_CASA_BEAMTABLE, OPENFILE_FITS_BEAMTABLE, OPEN_IMAGE_APPEND, OPEN_IMAGE_PV, OPEN_IMAGE_CASA_VARIENTS
• [ ] PER_CUBE_HISTOGRAM, PER_CUBE_HISTOGRAM_CANCELLATION, PER_CUBE_HISTOGRAM_HDF5

[veggiesaurus]

My feeling on the migration is that we should rely on unit tests for:

• Checking the validity of calculations
• Comparing results between different file formats
• Ensuring we handle edge cases correctly

If we use external data for the unit tests (e.g. images, tables, region files), they should either be small or auto-generated, so that they can be included in the repo.

[veggiesaurus]

@confluence and I have had a few discussions on how to actually implement some of these tests. One of the difficulties is mocking up some of the classes, so that we can test things in isolation.

[confluence]

I think we should review some existing libraries that may be able to do this for us, to avoid reinventing the wheel.

[veggiesaurus]

unless I'm mistaken, we can create a Frame without mocking anything else. That should allow us to do a large number of these tests with limited mocking

[veggiesaurus]

@markccchiang we can ask @jolopezl to implement some tests as well. We should not try to implement all the tests in a single PR, but rather chip away at them bit-by-bit.

I suggest we leave things that involve mocking up a Session class until the end.

[kswang1029]

@markccchiang @veggiesaurus I modified the issue description a bit with a list of sub-tasks (not in particular order). This should help to avoid having a giant PR in the end. Does it make sense?

[markccchiang]

@markccchiang @veggiesaurus I modified the issue description a bit with a list of sub-tasks (not in particular order). This should help to avoid having a giant PR in the end. Does it make sense?

Thank you! That is helpful for me.

[kswang1029]

@markccchiang @veggiesaurus I modified the issue description a bit with a list of sub-tasks (not in particular order). This should help to avoid having a giant PR in the end. Does it make sense?

Thank you! That is helpful for me.

@markccchiang please let me know if you have any questions per test migration. I guess there might be some that can be simplified 🤔

[markccchiang]

I think creating a TestSession class that inherits the Session class is a way to do (relatively) low-level unit tests. Now all Session functions are either public or protected, so the TestSession can call these functions to do the test for some cases. If we can not only use Frame or the other low-level classes for testing.

[veggiesaurus]

@markccchiang if you'd prefer to make separate issues for the remaining tests and story point them, that would be fine. I know it can get a bit frustrating endlessly working on one giant issue :smile:

[Kechil]

@markccchiang please go ahead and make separate issues for the remaining tests, and create an Epic for them to go under. Thank you. We can then close this giant task.

[kswang1029]

@markccchiang @acdo2002 @ajm-asiaa could you compile a list about

1. what ICD tests have been migrated to CPP unit tests?
2. what ICD tests are still activated in CI?

Once we have the two lists, we can close this issue and I will make separate issues to continue the migration process.

[ajm-ska]

@kswang1029 Good idea. Here is the current list if ICD tests that are currently active in Jenkinsfile-full:

ACCESS_WEBSOCKET.test.ts GET_FILELIST_ROOTPATH_CONCURRENT.test.ts FILEINFO_FITS_MULTIHDU.test.ts FILEINFO_EXCEPTIONS.test.ts

ANIMATOR_DATA_STREAM.test.ts ANIMATOR_NAVIGATION.test.ts ANIMATOR_CONTOUR_MATCH.test.ts ANIMATOR_CONTOUR.test.ts

REGION_STATISTICS_RECTANGLE.test.ts REGION_STATISTICS_ELLIPSE.test.ts REGION_STATISTICS_POLYGON.test.ts

CASA_REGION_INFO.test.ts CASA_REGION_IMPORT_INTERNAL.test.ts CASA_REGION_IMPORT_EXPORT.test.ts CASA_REGION_IMPORT_EXCEPTION.test.ts CASA_REGION_EXPORT.test.ts DS9_REGION_EXPORT.test.ts DS9_REGION_IMPORT_EXCEPTION.test.ts DS9_REGION_IMPORT_EXPORT.test.ts

PER_CUBE_HISTOGRAM.test.ts PER_CUBE_HISTOGRAM_HDF5.test.ts PER_CUBE_HISTOGRAM_CANCELLATION.test.ts

PV_GENERATOR_CANCEL.test.ts PV_GENERATOR_CASA.test.ts PV_GENERATOR_FITS.test.ts PV_GENERATOR_HDF5_COMPARED_FITS.test.ts PV_GENERATOR_MATCH_SPATIAL.test.ts PV_GENERATOR_NaN.test.ts PV_GENERATOR_WIDE.test.ts

CHECK_RASTER_TILE_DATA.test.ts TILE_DATA_REQUEST.test.ts

CATALOG_GENERAL.test.ts

MOMENTS_GENERATOR_CASA.test.ts MOMENTS_GENERATOR_EXCEPTION.test.ts MOMENTS_GENERATOR_SAVE.test.ts MOMENTS_GENERATOR_CANCEL.test.ts MOMENTS_GENERATOR_FITS.test.ts MOMENTS_GENERATOR_HDF5.test.ts

RESUME_CATALOG.test.ts RESUME_CONTOUR.test.ts RESUME_IMAGE.test.ts RESUME_REGION.test.ts

MATCH_SPATIAL.test.ts MATCH_STATS.test.ts

CLOSE_FILE_SINGLE.test.ts CLOSE_FILE_ANIMATION.test.ts CLOSE_FILE_ERROR.test.ts CLOSE_FILE_SPECTRAL_PROFILE.test.ts CLOSE_FILE_TILE.test.ts