Merge topic 'adios2-vtx-misspell'

24959a33 Add protection for missing arrays in ADIOS2 VTX reader

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Reviewed-by: William F Godoy <williamfgc@yahoo.com>
Acked-by: William F Godoy <williamfgc@yahoo.com>
Merge-request: !11426

Documentation/release/dev/adios2-vtx-reader-missing-arrays.md

+Add protection for missing arrays in ADIOS2 VTX reader
+
+Previously, when the ADIOS2 VTX reader read in most data arrays from the
+ADIOS2 file, it would silently leave a null array if that array did not
+exist. This opened up the likely consequence of the program later
+crashing when the reader attempted to use this array.
+
+Instead, the reader now reports an error when an array it attempts to
+read in is missing. This prevents subsequent problems.

IO/ADIOS2/Testing/Cxx/UnitTestIOADIOS2VTX.cxx

@@ -457,6 +457,41 @@ void WriteBPFileNoPieceVTU(const std::string& fileName)
   fs.close();
 }
 
+void WriteBPFileMissingTypes(const std::string& fileName)
+{
+  const std::string unstructureGridSchema = R"(
+        <VTKFile type="UnstructuredGrid">
+          <UnstructuredGrid>
+            <Piece>
+              <Points>
+                <DataArray Name="vertices" />
+              </Points>
+              <Cells>
+                <DataArray Name="connectivity" />
+                <DataArray Name="types" />
+              </Cells>
+              <PointData>
+                <DataArray Name="sol" />
+              </PointData>
+            </Piece>
+          </UnstructuredGrid>
+        </VTKFile>)";
+
+  ADIOS_OPEN(fs, fileName);
+
+  std::vector<uint32_t> dummyConnectivity(18, 1);
+  std::vector<double> dummyVertices(9, 1.05);
+  std::vector<double> dummySol(3, -1);
+
+  fs.write("type", 1);
+  fs.write("connectivity", dummyConnectivity.data(), {}, {}, {});
+  fs.write("vertices", dummyVertices.data(), {}, {}, {});
+  fs.write("sol", dummySol.data(), {}, {}, {});
+  fs.write_attribute("vtk.xml", unstructureGridSchema);
+
+  fs.close();
+}
+
 void WriteBPFileUnsupportedShape(const std::string& fileName)
 {
   const std::string unstructureGridSchema = R"(
@@ -704,6 +739,7 @@ int UnitTestIOADIOS2VTX(int argc, char* argv[])
     ADIOS2VTK_UNIT_TEST(WriteBPFileWrongNodePC2)
     ADIOS2VTK_UNIT_TEST(WriteBPFileNoPieceVTI)
     ADIOS2VTK_UNIT_TEST(WriteBPFileNoPieceVTU)
+    ADIOS2VTK_UNIT_TEST(WriteBPFileMissingTypes)
     ADIOS2VTK_UNIT_TEST(WriteBPFileUnsupportedShape)
     ADIOS2VTK_UNIT_TEST(WriteBPFileUnsupportedType)
   }

IO/ADIOS2/VTX/schema/VTXSchema.cxx

@@ -69,6 +69,8 @@ void VTXSchema::GetDataArray(
 
   if (type.empty())
   {
+    throw std::invalid_argument(
+      "ERROR: variable `" + variableName + "` not present " + "in Engine " + this->Engine.Name());
   }
 #define declare_type(T)                                                                            \
   else if (type == adios2::GetType<T>())                                                           \