Merge pull request #11378 from lubitchv/11377-empty-frequency

EditDDI API empty frequency bug

Author: ofahimIQSS

src/main/java/edu/harvard/iq/dataverse/api/EditDDI.java

@@ -110,12 +110,16 @@ public Response edit(@Context ContainerRequestContext crc, InputStream body, @Pa
         Map<Long, VariableMetadata> mapVarToVarMet = new HashMap<Long, VariableMetadata>();
         Map<Long,VarGroup> varGroupMap = new HashMap<Long, VarGroup>();
         try {
-            readXML(body, mapVarToVarMet,varGroupMap);
+            readXML(body, mapVarToVarMet, varGroupMap);
+        } catch (NullPointerException e) {
+                return error(Response.Status.BAD_REQUEST,e.getMessage() );
         } catch (XMLStreamException e) {
             logger.warning(e.getMessage());
-            return error(Response.Status.NOT_ACCEPTABLE, "bad xml file" );
+            return error(Response.Status.BAD_REQUEST, "bad xml file");
         }
 
+
+
         DatasetVersion latestVersion = dataFile.getOwner().getLatestVersion();
         Dataset dataset = latestVersion.getDataset();
 
@@ -349,12 +353,14 @@ private boolean updateDraftVersion(ArrayList<VariableMetadata> neededToUpdateVM,
         return true;
     }
 
-    private  void readXML(InputStream body, Map<Long,VariableMetadata> mapVarToVarMet, Map<Long,VarGroup> varGroupMap) throws XMLStreamException {
+    private void readXML(InputStream body, Map<Long,VariableMetadata> mapVarToVarMet, Map<Long,VarGroup> varGroupMap) throws XMLStreamException, NullPointerException {
+
         XMLInputFactory factory=XMLInputFactory.newInstance();
         XMLStreamReader xmlr=factory.createXMLStreamReader(body);
+
         VariableMetadataDDIParser vmdp = new VariableMetadataDDIParser();
 
-        vmdp.processDataDscr(xmlr,mapVarToVarMet, varGroupMap);
+        vmdp.processDataDscr(xmlr, mapVarToVarMet, varGroupMap);
 
     }
 

src/main/java/edu/harvard/iq/dataverse/datavariable/VariableMetadataDDIParser.java

@@ -229,13 +229,21 @@ private CategoryMetadata processCatStat(XMLStreamReader xmlr, VariableCategory c
                         String _freq = parseText(xmlr);
                         if (_freq != null && !_freq.isEmpty()) {
                             cat.setFrequency(new Double(_freq));
+                        } else {
+                            //If frequency is declared it cannot be missing
+                            // throw exception
+                            throw new NullPointerException("Frequency is declared but missing");
                         }
         } else if (wgtd != null && type != null && CAT_STAT_TYPE_FREQUENCY.equalsIgnoreCase(type) &&
                             CAT_STAT_WGTD_FREQUENCY.equalsIgnoreCase(wgtd)) {
                         cm = new CategoryMetadata();
                         String wfreq = parseText(xmlr);
                         if (wfreq != null && !wfreq.isEmpty()) {
                             cm.setWfreq(new Double(wfreq));
+                        } else {
+                            //if weighted frequency is declared it cannot be empty
+                            //through exception
+                            throw new NullPointerException("Weighted Frequency is declared but missing");
                         }
         }
         return cm;

src/test/java/edu/harvard/iq/dataverse/api/EditDDIIT.java

@@ -156,6 +156,18 @@ public void testUpdateVariableMetadata() throws InterruptedException {
         Response editDDINotAuthResponse = UtilIT.editDDI(updatedContent, origFileId, null);
         assertEquals(401, editDDINotAuthResponse.getStatusCode());
 
+        //bad request
+        String updatedContentBadFreq = updatedContent.replace("<catStat type=\"freq\">0</catStat>",
+                "<catStat type=\"freq\"/>");
+        Response editDDIBadRequestFreq = UtilIT.editDDI(updatedContentBadFreq, origFileId, apiToken);
+        assertEquals(400, editDDIBadRequestFreq.getStatusCode());
+
+        //bad request
+        String updatedContentBadWFreq = updatedContent.replace("<catStat wgtd=\"wgtd\" type=\"freq\">0</catStat>",
+                "<catStat wgtd=\"wgtd\" type=\"freq\"></catStat>");
+        Response editDDIBadRequestWFreq = UtilIT.editDDI(updatedContentBadWFreq, origFileId, apiToken);
+        assertEquals(400, editDDIBadRequestWFreq.getStatusCode());
+
 
         //cleanup
         Response makeSuperUser = UtilIT.makeSuperUser(username);