Adding unit tests, golden files, and supplemental labels

pds4indextools/values.yaml

@@ -0,0 +1,20 @@
+{'version_id': '1.1',
+'title': 'Tested Index File',
+'Citation_Information': {},
+'Modification_Detail': {},
+'Internal_Reference': {},
+'External_Reference': {},
+'Source_Product_Internal': {},
+'Source_Product_External': {},
+
+
+
+}
+
+
+
+
+
+
+
+

requirements.txt

@@ -1,5 +1,5 @@
-coverage==7.4.3
-lxml==5.1.0
-pandas==2.2.1
-pytest==8.0.2
-requests==2.31.0
+coverage
+lxml
+pandas
+pytest
+requests

test_files/expected/clean_header_field_names_success_1.csv

@@ -0,0 +1,2 @@
+pds_Product_Observational__pds_Identification_Area<1>__pds_logical_identifier<1>,pds_Product_Observational__pds_Identification_Area<1>__pds_version_id<1>,pds_Product_Observational__pds_Identification_Area<1>__pds_title<1>,pds_Product_Observational__pds_Identification_Area<1>__pds_information_model_version<1>,pds_Product_Observational__pds_Observing_System<1>__pds_name<1>,pds_Product_Observational__pds_Observing_System<1>__pds_Observing_System_Component<1>__pds_name<1>,pds_Product_Observational__pds_Observing_System<1>__pds_Observing_System_Component<1>__pds_type<1>,pds_Product_Observational__pds_Observing_System<1>__pds_Observing_System_Component<1>__pds_Internal_Reference<1>__pds_lid_reference<1>,pds_Product_Observational__pds_Observing_System<1>__pds_Observing_System_Component<1>__pds_Internal_Reference<1>__pds_reference_type<1>
+urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0,Cassini ISS Image 1455200455n.img,1.11.0.0,Cassini Orbiter Imaging Science Subsystem,Cassini Orbiter,Spacecraft,urn:nasa:pds:context:instrument_host:spacecraft.co,is_instrument_host

test_files/expected/clean_header_field_names_success_1.txt

@@ -0,0 +1,9 @@
+pds_Product_Observational__pds_Identification_Area_1__pds_logical_identifier_1
+pds_Product_Observational__pds_Identification_Area_1__pds_version_id_1
+pds_Product_Observational__pds_Identification_Area_1__pds_title_1
+pds_Product_Observational__pds_Identification_Area_1__pds_information_model_version_1
+pds_Product_Observational__pds_Observing_System_1__pds_name_1
+pds_Product_Observational__pds_Observing_System_1__pds_Observing_System_Component_1__pds_name_1
+pds_Product_Observational__pds_Observing_System_1__pds_Observing_System_Component_1__pds_type_1
+pds_Product_Observational__pds_Observing_System_1__pds_Observing_System_Component_1__pds_Internal_Reference_1__pds_lid_reference_1
+pds_Product_Observational__pds_Observing_System_1__pds_Observing_System_Component_1__pds_Internal_Reference_1__pds_reference_type_1

test_files/expected/clean_header_field_names_success_2.csv

@@ -0,0 +1,3 @@
+pds_Product_Observational__pds_Identification_Area<1>__pds_logical_identifier<1>,pds_Product_Observational__pds_Identification_Area<1>__pds_version_id<1>,pds_Product_Observational__pds_Observation_Area<1>__pds_Time_Coordinates<1>__pds_start_date_time<1>,pds_Product_Observational__pds_Observation_Area<1>__pds_Time_Coordinates<1>__pds_stop_date_time<1>,pds_Product_Observational__pds_Observation_Area<1>__pds_Primary_Result_Summary<1>__pds_Science_Facets<1>__pds_wavelength_range<1>,pds_Product_Observational__pds_Observation_Area<1>__pds_Primary_Result_Summary<1>__pds_Science_Facets<2>__pds_wavelength_range<1>
+urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0,NaN,NaN,NaN,NaN
+urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0,1998-11-06T04:38:18.7028Z,1998-11-06T05:52:29.0559Z,Infrared,Infrared

test_files/expected/clean_header_field_names_success_2.txt

@@ -0,0 +1,6 @@
+pds_Product_Observational__pds_Identification_Area_1__pds_logical_identifier_1
+pds_Product_Observational__pds_Identification_Area_1__pds_version_id_1
+pds_Product_Observational__pds_Observation_Area_1__pds_Time_Coordinates_1__pds_start_date_time_1
+pds_Product_Observational__pds_Observation_Area_1__pds_Time_Coordinates_1__pds_stop_date_time_1
+pds_Product_Observational__pds_Observation_Area_1__pds_Primary_Result_Summary_1__pds_Science_Facets_1__pds_wavelength_range_1
+pds_Product_Observational__pds_Observation_Area_1__pds_Primary_Result_Summary_1__pds_Science_Facets_2__pds_wavelength_range_1

test_files/expected/elements_file_success_1.txt

@@ -0,0 +1,3 @@
+pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>
+pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>
+pds:Product_Observational/pds:Identification_Area<1>/pds:title<1>

test_files/expected/elements_file_success_2.txt

@@ -0,0 +1,5 @@
+pds:Product_Observational/pds:Observation_Area<1>/pds:Discipline_Area<1>/geom:Geometry<1>/geom:SPICE_Kernel_Files<1>/geom:SPICE_Kernel_Identification<1>/geom:spice_kernel_file_name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Discipline_Area<1>/geom:Geometry<1>/geom:SPICE_Kernel_Files<1>/geom:SPICE_Kernel_Identification<2>/geom:spice_kernel_file_name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Discipline_Area<1>/geom:Geometry<1>/geom:SPICE_Kernel_Files<1>/geom:SPICE_Kernel_Identification<3>/geom:spice_kernel_file_name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Discipline_Area<1>/geom:Geometry<1>/geom:SPICE_Kernel_Files<1>/geom:SPICE_Kernel_Identification<4>/geom:spice_kernel_file_name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Discipline_Area<1>/geom:Geometry<1>/geom:SPICE_Kernel_Files<1>/geom:SPICE_Kernel_Identification<5>/geom:spice_kernel_file_name<1>

test_files/expected/elements_file_success_3.txt

@@ -0,0 +1,5 @@
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<2>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<3>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Target_Identification<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Target_Identification<2>/pds:name<1>

test_files/expected/elements_file_success_4.txt

@@ -0,0 +1,9 @@
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<1>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<2>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<3>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<4>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<5>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<6>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<7>/pds:comment<1>
+pds:Product_Observational/pds:Reference_List<1>/pds:Internal_Reference<8>/pds:comment<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:comment<1>

test_files/expected/extra_file_info_success_1.csv

@@ -0,0 +1,2 @@
+filename,filepath,pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:title<1>
+tester_label_2.xml,labels/tester_label_2.xml,urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0,Calibrated Time Series of the Uranus System Occultation of Star u149 (2MASS 20462044-1838345) Observed from the IRTF 320cm Telescope

test_files/expected/extra_file_info_success_2.csv

@@ -0,0 +1,4 @@
+filename,pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>
+tester_label_1.xml,urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0
+tester_label_2.xml,urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0
+tester_label_3.xml,urn:nasa:pds:cassini_iss_cruise:data_raw:1357539630n,1.0

test_files/expected/extra_file_info_success_3.csv

@@ -0,0 +1,4 @@
+filename,filepath,LID,bundle,bundle_lid,pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>
+tester_label_1.xml,labels/tester_label_1.xml,urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,cassini_iss_saturn,urn:nasa:pds:cassini_iss_saturn,urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0
+tester_label_2.xml,labels/tester_label_2.xml,urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,uranus_occ_u149_irtf_320cm,urn:nasa:pds:uranus_occ_u149_irtf_320cm,urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0
+tester_label_3.xml,labels/tester_label_3.xml,urn:nasa:pds:cassini_iss_cruise:data_raw:1357539630n,cassini_iss_cruise,urn:nasa:pds:cassini_iss_cruise,urn:nasa:pds:cassini_iss_cruise:data_raw:1357539630n,1.0

test_files/expected/identical_labels_success.csv

@@ -0,0 +1,4 @@
+filename,pds:Product_Collection/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Collection/pds:Identification_Area<1>/pds:title<1>,pds:Product_Collection/pds:Identification_Area<1>/pds:Citation_Information<1>/pds:editor_list<1>,pds:Product_Collection/pds:Identification_Area<1>/pds:Citation_Information<1>/pds:description<1>,pds:Product_Collection/pds:File_Area_Inventory<1>/pds:File<1>/pds:file_name<1>,pds:Product_Collection/pds:File_Area_Inventory<1>/pds:Inventory<1>/pds:record_delimiter<1>
+identical_label_1.xml,urn:nasa:pds:bundle_1:document,Label 1,"M. W. Evans, M. K. Gordon, M. R. Showalter, and M. S. Tiscareno",This is the first of three identical labels.,some_collection_1.csv,Carriage-Return Line-Feed
+identical_label_2.xml,urn:nasa:pds:bundle_2:document,Label 2,"M. W. Evans, M. S. Tiscareno",This is the second of three identical labels.,some_collection_2.csv,Line-Feed
+identical_label_3.xml,urn:nasa:pds:bundle_3:document,Label 3,"M. R. Showalter, M. S. Tiscareno",This is the third of three identical labels.,some_collection_3.csv,Carriage-Return Line-Feed

test_files/expected/simplify_xpaths_success_1.txt

@@ -0,0 +1,9 @@
+pds:logical_identifier
+pds:version_id
+pds:title
+pds:information_model_version
+pds:Product_Observational/pds:Observing_System<1>/pds:name<1>
+pds:Product_Observational/pds:Observing_System<1>/pds:Observing_System_Component<1>/pds:name<1>
+pds:type
+pds:lid_reference
+pds:reference_type

test_files/expected/simplify_xpaths_success_2.txt

@@ -0,0 +1,24 @@
+pds:Product_Observational/pds:Observing_System<1>/pds:name<1>
+pds:Product_Observational/pds:Observing_System<1>/pds:Observing_System_Component<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Investigation_Area<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<2>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Observing_System<1>/pds:Observing_System_Component<3>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Target_Identification<1>/pds:name<1>
+pds:Product_Observational/pds:Observation_Area<1>/pds:Target_Identification<2>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<1>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<2>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<3>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<4>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<5>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<6>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<7>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<8>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<9>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<10>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<11>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<12>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<13>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<14>/pds:name<1>
+pds:Product_Observational/pds:File_Area_Observational<1>/pds:Table_Character<1>/pds:Record_Character<1>/pds:Field_Character<15>/pds:name<1>

test_files/expected/simplify_xpaths_success_3.txt

@@ -0,0 +1,31 @@
+rings:occultation_type
+rings:occultation_direction
+rings:time_series_direction
+rings:planetary_occultation_flag
+rings:data_quality_score
+rings:ring_plane
+rings:star_name
+rings:fresnel_scale
+rings:projected_star_diameter
+rings:sigma_projected_star_diameter
+rings:fractional_error_star_counts
+rings:time_constant_type
+rings:time_constant
+rings:sigma_time_constant
+rings:minimum_wavelength
+rings:maximum_wavelength
+rings:reference_time_utc
+rings:minimum_observed_event_time
+rings:maximum_observed_event_time
+rings:observed_event_start_tdb
+rings:observed_event_stop_tdb
+rings:earth_received_start_time_utc
+rings:earth_received_stop_time_utc
+rings:minimum_ring_radius
+rings:maximum_ring_radius
+rings:minimum_ring_longitude
+rings:maximum_ring_longitude
+rings:minimum_observed_ring_azimuth
+rings:maximum_observed_ring_azimuth
+rings:observed_ring_elevation
+rings:light_source_incidence_angle

test_files/expected/simplify_xpaths_success_4.txt

@@ -0,0 +1,64 @@
+cassini:mission_phase_name
+cassini:spacecraft_clock_count_partition
+cassini:spacecraft_clock_start_count
+cassini:spacecraft_clock_stop_count
+cassini:limitations
+cassini:antiblooming_state_flag
+cassini:command_file_name
+cassini:command_sequence_number
+cassini:dark_strip_mean
+cassini:data_conversion_type
+cassini:delayed_readout_flag
+cassini:detector_temperature
+cassini:electronics_bias
+cassini:expected_maximum_full_well
+cassini:expected_maximum_DN_sat
+cassini:expected_packets
+cassini:exposure_duration
+cassini:filter_name_1
+cassini:filter_name_2
+cassini:filter_temperature
+cassini:flight_software_version_id
+cassini:gain_mode_id
+cassini:ground_software_version_id
+cassini:image_mid_time
+cassini:image_number
+cassini:image_time
+cassini:image_observation_type
+cassini:instrument_data_rate
+cassini:inst_cmprs_type
+cassini:inst_cmprs_param_malgo
+cassini:inst_cmprs_param_tb
+cassini:inst_cmprs_param_blocks
+cassini:inst_cmprs_param_quant
+cassini:inst_cmprs_rate_expected_bits
+cassini:inst_cmprs_rate_actual_bits
+cassini:inst_cmprs_ratio
+cassini:light_flood_state_flag
+cassini:method_description
+cassini:missing_lines
+cassini:missing_packet_flag
+cassini:optics_temperature_front
+cassini:optics_temperature_back
+cassini:order_number
+cassini:parallel_clock_voltage_index
+cassini:pds3_product_creation_time
+cassini:pds3_product_version_type
+cassini:pds3_target_desc
+cassini:pds3_target_list
+cassini:pds3_target_name
+cassini:pre-pds_version_number
+cassini:prepare_cycle_index
+cassini:readout_cycle_index
+cassini:received_packets
+cassini:sensor_head_electronics_temperature
+cassini:sequence_id
+cassini:sequence_number
+cassini:sequence_title
+cassini:shutter_mode_id
+cassini:shutter_state_id
+cassini:start_time_doy
+cassini:stop_time_doy
+cassini:telemetry_format_id
+cassini:valid_maximum_full_well
+cassini:valid_maximum_DN_sat

test_files/expected/sort_by_success_1.csv

@@ -0,0 +1,4 @@
+pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Time_Coordinates<1>/pds:start_date_time<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Time_Coordinates<1>/pds:stop_date_time<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Primary_Result_Summary<1>/pds:Science_Facets<1>/pds:wavelength_range<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Primary_Result_Summary<1>/pds:Science_Facets<2>/pds:wavelength_range<1>
+urn:nasa:pds:cassini_iss_cruise:data_raw:1357539630n,1.0,2001-01-07T06:08:47.793Z,2001-01-07T06:08:48.013Z,Near Infrared,NaN
+urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0,NaN,NaN,NaN,NaN
+urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0,1998-11-06T04:38:18.7028Z,1998-11-06T05:52:29.0559Z,Infrared,Infrared

test_files/expected/sort_by_success_2.csv

@@ -0,0 +1,4 @@
+bundle_lid,filepath,pds:Product_Observational/pds:Identification_Area<1>/pds:logical_identifier<1>,pds:Product_Observational/pds:Identification_Area<1>/pds:version_id<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Time_Coordinates<1>/pds:start_date_time<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Time_Coordinates<1>/pds:stop_date_time<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Primary_Result_Summary<1>/pds:Science_Facets<1>/pds:wavelength_range<1>,pds:Product_Observational/pds:Observation_Area<1>/pds:Primary_Result_Summary<1>/pds:Science_Facets<2>/pds:wavelength_range<1>
+urn:nasa:pds:cassini_iss_cruise,labels/tester_label_3.xml,urn:nasa:pds:cassini_iss_cruise:data_raw:1357539630n,1.0,2001-01-07T06:08:47.793Z,2001-01-07T06:08:48.013Z,Near Infrared,NaN
+urn:nasa:pds:cassini_iss_saturn,labels/tester_label_1.xml,urn:nasa:pds:cassini_iss_saturn:data_raw:1455200455n,1.0,NaN,NaN,NaN,NaN
+urn:nasa:pds:uranus_occ_u149_irtf_320cm,labels/tester_label_2.xml,urn:nasa:pds:uranus_occ_u149_irtf_320cm:data:2200nm_counts-v-time_occult,1.0,1998-11-06T04:38:18.7028Z,1998-11-06T05:52:29.0559Z,Infrared,Infrared

test_files/expected/tester_config.ini

@@ -0,0 +1,17 @@
+[pds:ASCII_Integer]
+inapplicable=-9999
+missing=-9988
+unknown=-9977
+anticipated=-9966
+
+[pds:ASCII_Real]
+inapplicable=-9999.0
+missing=-9988.0
+unknown=-9977.0
+anticipated=-9966.0
+
+[pds:ASCII_Short_String_Collapsed]
+inapplicable=inapplicable_alt
+missing=missing_alt
+unknown=unknown_alt
+anticipated=anticipated_alt