ENH: Allow insertion and deletion of single entities

Summary

See https://gitlab.indiscale.com/caosdb/customers/lfpb/management/-/issues/394. Implementations for entities, parents, and properties were added. The transactions were extended s.th. all objects can be inserted, retrieved, and deleted.

Focus

Most of the new stuff is in entity.cpp and entity.h. See test_entity for the new functionality.

Test Environment

Unit and integration tests should be sufficient.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related Issues
• [ ] Up-to-date CHANGELOG.md
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• [ ] Up-to-date CHANGELOG.md
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

include/caosdb/entity.h

@@ -38,6 +38,12 @@ using caosdb::entity::v1alpha1::IdResponse;
 using ProtoParent = caosdb::entity::v1alpha1::Parent;
 using ProtoEntity = caosdb::entity::v1alpha1::Entity;
 
+/**
+ * Messages convey information about the state and result of transactions.
+ *
+ * A Message object can be thought of as kinf of a generalized error object in
+ * other frameworks. Please have a look at MessageCodes for more details.
+ */
 class Message {
 public:
   [[nodiscard]] inline auto GetCode() const -> MessageCode {
@@ -48,6 +54,10 @@ public:
   }
 
   friend class Entity;
+  // TODO(fspreck) Re-enable once we have decided how messages are
+  // appended to parents and properties
+  // friend class Parent;
+  // friend class Property;
   friend class Messages;
 
 private:
@@ -68,6 +78,9 @@ public:
   }
 
   friend class Entity;
+  // TODO(fspreck) Same here.
+  // friend class Parent;
+  // friend class Property;
 
 private:
   inline Messages() : wrapped(nullptr){};
@@ -128,20 +141,32 @@ public:
     return out;
   }
 
-  // TODO(fspreck) These need implementations. See Entity::GetErrors for
-  // inspiration.
-  /**
-   * Return the error messages of this parent.
-   */
-  [[nodiscard]] inline auto GetErrors() const -> const Messages &;
-  /**
-   * Return the warning messages of this parent.
-   */
-  [[nodiscard]] inline auto GetWarnings() const -> const Messages &;
-  /**
-   * Return the info messages of this parent.
-   */
-  [[nodiscard]] inline auto GetInfos() const -> const Messages &;
+  // TODO(fspreck) Finish the following implementations once we have
+  // decided how to attach messages to parents.
+  // /**
+  //  * Return the error messages of this parent.
+  //  */
+  // [[nodiscard]] inline auto GetErrors() const -> const Messages & {
+  //   return errors;
+  // }
+  // [[nodiscard]] inline auto HasErrors() const -> bool {
+  //   return this->errors.wrapped->size() > 0;
+  // }
+  // /**
+  //  * Return the warning messages of this parent.
+  //  */
+  // [[nodiscard]] inline auto GetWarnings() const -> const Messages & {
+  //   return warnings;
+  // }
+  // [[nodiscard]] inline auto HasWarnings() const -> bool {
+  //   return this->warnings.wrapped->size() > 0;
+  // }
+  // /**
+  //  * Return the info messages of this parent.
+  //  */
+  // [[nodiscard]] inline auto GetInfos() const -> const Messages & {
+  //   return infos;
+  // }
 
   friend class Entity;
   friend class Parents;
@@ -163,6 +188,9 @@ private:
    * Message which serves as storage backend.
    */
   mutable caosdb::entity::v1alpha1::Parent *wrapped;
+  // Messages errors;
+  // Messages warnings;
+  // Messages infos;
 };
 
 /**
@@ -213,8 +241,6 @@ private:
  *
  * This is a property which belongs to another entity. Don't confuse it with
  * an Entity with the "Property" role.
- *
- * @brief Property of an Entity.
  */
 class Property {
 public:
@@ -229,9 +255,11 @@ public:
   [[nodiscard]] auto GetValue() const -> const std::string &;
   [[nodiscard]] auto GetUnit() const -> const std::string &;
   [[nodiscard]] auto GetDatatype() const -> const std::string &;
-  [[nodiscard]] auto GetErrors() const -> const Messages &;
-  [[nodiscard]] auto GetWarnings() const -> const Messages &;
-  [[nodiscard]] auto GetInfos() const -> const Messages &;
+  // TODO(fspreck) Implement these when we have decided how to attach
+  // messages to properties.
+  // [[nodiscard]] auto GetErrors() const -> const Messages &;
+  // [[nodiscard]] auto GetWarnings() const -> const Messages &;
+  // [[nodiscard]] auto GetInfos() const -> const Messages &;
 
   auto SetId(const std::string &id) -> void;
   auto SetName(const std::string &name) -> void;
@@ -310,6 +338,9 @@ public:
   [[nodiscard]] inline auto GetUnit() const -> const std::string & {
     return wrapped->unit();
   };
+  [[nodiscard]] inline auto GetValue() const -> const std::string & {
+    return wrapped->value();
+  };
 
   [[nodiscard]] auto GetParents() const -> const Parents &;
   [[nodiscard]] auto GetProperties() const -> const Properties &;
@@ -322,6 +353,9 @@ public:
   [[nodiscard]] auto GetWarnings() const -> const Messages & {
     return warnings;
   }
+  [[nodiscard]] inline auto HasWarnings() const -> bool {
+    return this->warnings.wrapped->size() > 0;
+  }
   [[nodiscard]] auto GetInfos() const -> const Messages & { return infos; }
 
   inline auto ToString() const -> const std::string {
@@ -337,7 +371,6 @@ public:
   auto SetName(const std::string &name) -> void;
   auto SetVersionId(const std::string &id) -> void;
 
-  // TODO(fspreck) ... and also these
   auto SetValue(const std::string &value) -> void;
   auto SetUnit(const std::string &unit) -> void;
   // Currently no references or lists.