#43 : return failure if metadata is not added

sbmlteam · Jul 20, 2021 · 2f3e6e0 · 2f3e6e0
1 parent f52e483
commit 2f3e6e0
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 7 deletions.
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.2.12
+0.2.13
diff --git a/src/combine/combinearchive.cpp b/src/combine/combinearchive.cpp
@@ -190,10 +190,11 @@ std::string CombineArchive::getNextFilename(const std::string& prefix,
   return fileName;
 }
 
-void CombineArchive::addMetadataToArchive(OmexDescription& desc, Zipper *zipper)
+int
+CombineArchive::addMetadataToArchive(OmexDescription& desc, Zipper *zipper)
 {
   if (desc.isEmpty() || zipper == NULL || mpManifest == NULL)
-    return;
+    return LIBCOMBINE_OPERATION_FAILED;
 
   std::string fileName = getNextFilename("metadata", ".rdf");
   std::stringstream content; content << desc.toXML();
@@ -203,7 +204,8 @@ void CombineArchive::addMetadataToArchive(OmexDescription& desc, Zipper *zipper)
   entry->setLocation(fileName);
   entry->setFormat(KnownFormats::lookupFormat("omex"));
   entry->setMaster(false);
-
+
+  return LIBCOMBINE_OPERATION_SUCCESS;
 }
 
 bool CombineArchive::writeToFile(const std::string &fileName)
@@ -488,11 +490,16 @@ CombineArchive::addFile(std::istream &stream,
   return addFile(tempFilename, targetName, format, isMaster);
 }
 
-void
+int
 CombineArchive::addMetadata(const std::string &targetName,
                             const OmexDescription &description)
 {
+  if (description.isEmpty())
+    return LIBCOMBINE_OPERATION_FAILED;
+
   mMetadataMap[targetName] = description;
+
+  return LIBCOMBINE_OPERATION_SUCCESS;
 }
 
 bool

diff --git a/src/combine/combinearchive.h b/src/combine/combinearchive.h
@@ -123,8 +123,12 @@ class LIBCOMBINE_EXTERN CombineArchive
    *
    * @param targetName the name of the entry that the metadata is about
    * @param description the metadata description
+   * 
+   * @return status code indicating success or failure. 
+   *   @li @omexconstant{LIBCOMBINE_OPERATION_SUCCESS, OperationReturnValues_t}
+   *   @li @omexconstant{LIBCOMBINE_OPERATION_FAILED, OperationReturnValues_t}
    */
-  void addMetadata(const std::string& targetName,
+  int addMetadata(const std::string& targetName,
                    const OmexDescription& description);
 
   /**
@@ -361,8 +365,13 @@ class LIBCOMBINE_EXTERN CombineArchive
    *
    * @param desc the description to be added
    * @param zipper the zipper to be used
+   * 
+   * @return status code indicating success or failure. 
+   *   @li @omexconstant{LIBCOMBINE_OPERATION_SUCCESS, OperationReturnValues_t}
+   *   @li @omexconstant{LIBCOMBINE_OPERATION_FAILED, OperationReturnValues_t}
+   *
    */
-  void addMetadataToArchive(OmexDescription& desc, zipper::Zipper* zipper);
+  int addMetadataToArchive(OmexDescription& desc, zipper::Zipper* zipper);
 };
 
 LIBCOMBINE_CPP_NAMESPACE_END

diff --git a/src/test/combine_test_create.cpp b/src/test/combine_test_create.cpp
@@ -194,3 +194,30 @@ SCENARIO("reading an existing archive", "[combine]")
 
   }
 }
+
+SCENARIO("creating a combine archive", "[combine]")
+{
+  CombineArchive archive;
+  REQUIRE(archive.getManifest() == NULL);
+
+  GIVEN("user adds invalid omex data")
+  {
+    OmexDescription desc;
+    REQUIRE(desc.getAbout().empty());
+    REQUIRE(desc.getDescription().empty());
+    REQUIRE(desc.getCreators().size() == 0);
+
+    THEN("it can not be added to the archive")
+      {
+        REQUIRE(archive.addMetadata("file", desc) == LIBCOMBINE_OPERATION_FAILED);
+      }
+
+    AND_WHEN("a description and created date is added it can be added")
+    {
+      desc.setDescription("some description");
+      desc.setCreated(OmexDescription::getCurrentDateAndTime());
+      REQUIRE(archive.addMetadata("file", desc) == LIBCOMBINE_OPERATION_SUCCESS);
+    }
+
+  }
+}