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.

test/test_entity.cpp

+/*
+ *
+ * This file is a part of the CaosDB Project.
+ *
+ * Copyright (C) 2021 Timm Fitschen <t.fitschen@indiscale.com>
+ * Copyright (C) 2021 Florian Spreckelsen <f.spreckelsen@indiscale.com>
+ * Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+#include "caosdb/entity.h"                       // for Entity, Parent, Par...
+#include "caosdb/entity/v1alpha1/main.grpc.pb.h" // for EntityTransactionSe...
+#include "caosdb/entity/v1alpha1/main.pb.h"      // for IdResponse, Message
+#include "caosdb/message_code.h"                 // for MessageCode
+#include "caosdb/protobuf_helper.h"              // for get_arena
+#include "caosdb/transaction.h"                  // for Transaction
+#include "google/protobuf/arena.h"               // for Arena
+#include "gtest/gtest-message.h"                 // for Message
+#include "gtest/gtest-test-part.h"               // for TestPartResult, Sui...
+#include "gtest/gtest_pred_impl.h"               // for Test, EXPECT_EQ
+#include <iostream>                              // for endl, basic_ostream
+#include <memory>                                // for allocator, shared_ptr
+#include <string>                                // for operator<<
+
+namespace caosdb::entity {
+using caosdb::entity::v1alpha1::IdResponse;
+using ProtoEntity = caosdb::entity::v1alpha1::Entity;
+using caosdb::utility::get_arena;
+
+TEST(test_entity, test_parent_setters) {
+  auto parent = Parent();
+  parent.SetName("RT1");
+  parent.SetId("some-id");
+
+  EXPECT_EQ(parent.GetName(), "RT1");
+  EXPECT_EQ(parent.GetId(), "some-id");
+}
+
+TEST(test_entity, test_append_parent) {
+  auto parent = Parent();
+  parent.SetId("some-id");
+
+  auto entity = Entity();
+  EXPECT_EQ(entity.GetParents().Size(), 0);
+  entity.AppendParent(parent);
+  EXPECT_EQ(entity.GetParents().Size(), 1);
+
+  auto same_parent = entity.GetParents().At(0);
+  EXPECT_EQ(same_parent.GetId(), "some-id");
+}
+
+TEST(test_entity, test_property_setters) {
+  auto prop = Property();
+  prop.SetName("prop_name");
+  prop.SetId("prop_id");
+  prop.SetImportance("prop_importance");
+  prop.SetValue("prop_value");
+  prop.SetUnit("prop_unit");
+  prop.SetDatatype("prop_dtype");
+
+  EXPECT_EQ(prop.GetName(), "prop_name");
+  EXPECT_EQ(prop.GetId(), "prop_id");
+  EXPECT_EQ(prop.GetImportance(), "prop_importance");
+  EXPECT_EQ(prop.GetValue(), "prop_value");
+  EXPECT_EQ(prop.GetUnit(), "prop_unit");
+  EXPECT_EQ(prop.GetDatatype(), "prop_dtype");
+}
+
+TEST(test_entity, test_append_property) {
+  auto entity = Entity();
+
+  auto prop = Property();
+  prop.SetName("prop_name");
+  prop.SetId("prop_id");
+  prop.SetImportance("prop_importance");
+  prop.SetValue("prop_value");
+  prop.SetUnit("prop_unit");
+  prop.SetDatatype("prop_dtype");
+
+  EXPECT_EQ(entity.GetProperties().Size(), 0);
+  entity.AppendProperty(prop);
+  EXPECT_EQ(entity.GetProperties().Size(), 1);
+
+  auto same_prop = entity.GetProperties().At(0);
+
+  EXPECT_EQ(prop.GetName(), same_prop.GetName());
+  EXPECT_EQ(prop.GetId(), same_prop.GetId());
+  EXPECT_EQ(prop.GetImportance(), same_prop.GetImportance());
+  EXPECT_EQ(prop.GetValue(), same_prop.GetValue());
+  EXPECT_EQ(prop.GetUnit(), same_prop.GetUnit());
+  EXPECT_EQ(prop.GetDatatype(), same_prop.GetDatatype());
+}
+
+TEST(test_entity, test_copy_to) {
+  auto entity = Entity();
+  entity.SetId("original_id");
+  entity.SetName("orignial_name");
+
+  auto parent = Parent();
+  parent.SetId("parent_id");
+  parent.SetName("parent_name");
+  entity.AppendParent(parent);
+
+  auto prop = Property();
+  prop.SetId("prop_id");
+  prop.SetName("prop_name");
+  entity.AppendProperty(prop);
+
+  // create protobuf entity to which all fields ae copied and then a
+  // CaoosDB entity from that protobuf entity.
+  auto *proto_copy =
+    google::protobuf::Arena::CreateMessage<ProtoEntity>(get_arena());
+  entity.CopyTo(proto_copy);
+  auto copied = Entity(proto_copy);
+
+  EXPECT_EQ(entity.GetId(), copied.GetId());
+  EXPECT_EQ(entity.GetName(), copied.GetName());
+  EXPECT_EQ(copied.GetParents().At(0).GetId(), parent.GetId());
+  EXPECT_EQ(copied.GetParents().At(0).GetName(), parent.GetName());
+  EXPECT_EQ(copied.GetProperties().At(0).GetId(), prop.GetId());
+  EXPECT_EQ(copied.GetProperties().At(0).GetName(), prop.GetName());
+}
+
+TEST(test_entity, test_insert_entity) {
+  auto transaction = caosdb::transaction::Transaction(
+    std::shared_ptr<transaction::EntityTransactionService::Stub>(nullptr));
+
+  auto entity = Entity();
+  entity.SetId("entity_id");
+  entity.SetVersionId("version_id");
+
+  EXPECT_EQ(entity.GetId(), "entity_id");
+  EXPECT_EQ(entity.GetVersionId(), "version_id");
+
+  transaction.InsertEntity(&entity);
+
+  EXPECT_EQ(entity.GetId(), "entity_id");
+  EXPECT_EQ(entity.GetVersionId(), "version_id");
+}
+
+TEST(test_entity, test_insert_with_role) {
+  auto transaction = caosdb::transaction::Transaction(
+    std::shared_ptr<transaction::EntityTransactionService::Stub>(nullptr));
+
+  auto entity = Entity();
+  entity.SetId("entity_id");
+  entity.SetVersionId("version_id");
+  entity.SetRole("Property");
+  entity.SetDatatype("DOUBLE");
+  entity.SetName("Length");
+  entity.SetUnit("m");
+  entity.SetValue("5.5");
+
+  transaction.InsertEntity(&entity);
+
+  EXPECT_EQ(entity.GetId(), "entity_id");
+  EXPECT_EQ(entity.GetVersionId(), "version_id");
+  EXPECT_EQ(entity.GetRole(), "Property");
+  EXPECT_EQ(entity.GetDatatype(), "DOUBLE");
+  EXPECT_EQ(entity.GetName(), "Length");
+  EXPECT_EQ(entity.GetUnit(), "m");
+  EXPECT_EQ(entity.GetValue(), "5.5");
+}
+
+TEST(test_entity, test_insert_with_parent) {
+  auto transaction = caosdb::transaction::Transaction(
+    std::shared_ptr<transaction::EntityTransactionService::Stub>(nullptr));
+
+  auto entity = Entity();
+  entity.SetId("entity_id");
+
+  auto parent = Parent();
+  parent.SetId("parent_id");
+  parent.SetName("parent_name");
+  EXPECT_EQ(parent.GetId(), "parent_id");
+  EXPECT_EQ(parent.GetName(), "parent_name");
+
+  entity.AppendParent(parent);
+
+  transaction.InsertEntity(&entity);
+
+  std::cout << entity.ToString() << std::endl;
+  EXPECT_EQ(entity.GetId(), "entity_id");
+  EXPECT_EQ(entity.GetParents().Size(), 1);
+  auto inserted_parent = entity.GetParents().At(0);
+  EXPECT_EQ(inserted_parent.GetId(), parent.GetId());
+  EXPECT_EQ(inserted_parent.GetName(), parent.GetName());
+}
+
+TEST(test_entity, test_insert_with_property) {
+  auto transaction = caosdb::transaction::Transaction(
+    std::shared_ptr<transaction::EntityTransactionService::Stub>(nullptr));
+
+  auto entity = Entity();
+  entity.SetId("entity_id");
+
+  auto prop = Property();
+  prop.SetName("prop_name");
+  prop.SetId("prop_id");
+  prop.SetImportance("prop_importance");
+  prop.SetValue("prop_value");
+  prop.SetUnit("prop_unit");
+  prop.SetDatatype("prop_dtype");
+
+  entity.AppendProperty(prop);
+
+  transaction.InsertEntity(&entity);
+
+  EXPECT_EQ(entity.GetProperties().Size(), 1);
+
+  auto inserted_prop = entity.GetProperties().At(0);
+
+  EXPECT_EQ(prop.GetName(), inserted_prop.GetName());
+  EXPECT_EQ(prop.GetId(), inserted_prop.GetId());
+  EXPECT_EQ(prop.GetImportance(), inserted_prop.GetImportance());
+  EXPECT_EQ(prop.GetValue(), inserted_prop.GetValue());
+  EXPECT_EQ(prop.GetUnit(), inserted_prop.GetUnit());
+  EXPECT_EQ(prop.GetDatatype(), inserted_prop.GetDatatype());
+}
+
+TEST(test_entity, test_from_id_response) {
+  IdResponse idResponse;
+  idResponse.set_id("entity_id");
+  auto *error = idResponse.add_entity_errors();
+  error->set_code(MessageCode::ENTITY_DOES_NOT_EXIST);
+  error->set_description("error_desc");
+
+  Entity entity(&idResponse);
+
+  std::cout << entity.ToString() << std::endl;
+  EXPECT_EQ(entity.GetId(), "entity_id");
+  EXPECT_TRUE(entity.HasErrors());
+  EXPECT_EQ(entity.GetErrors().Size(), 1);
+  EXPECT_EQ(entity.GetErrors().At(0).GetDescription(), "error_desc");
+  EXPECT_EQ(entity.GetErrors().At(0).GetCode(),
+            MessageCode::ENTITY_DOES_NOT_EXIST);
+
+  IdResponse idr_warnings_and_infos;
+  idr_warnings_and_infos.set_id("other_entity_id");
+  auto *warning = idr_warnings_and_infos.add_entity_warnings();
+  warning->set_description("warning_desc");
+  warning->set_code(MessageCode::ENTITY_HAS_NO_PROPERTIES);
+  auto *info = idr_warnings_and_infos.add_entity_infos();
+  info->set_description("info_desc");
+  info->set_code(MessageCode::UNSPECIFIED);
+
+  Entity other_ent(&idr_warnings_and_infos);
+
+  EXPECT_EQ(other_ent.GetId(), "other_entity_id");
+  EXPECT_EQ(other_ent.GetWarnings().Size(), 1);
+  EXPECT_TRUE(other_ent.HasWarnings());
+  EXPECT_EQ(other_ent.GetWarnings().At(0).GetDescription(), "warning_desc");
+  EXPECT_EQ(other_ent.GetWarnings().At(0).GetCode(),
+            MessageCode::ENTITY_HAS_NO_PROPERTIES);
+  EXPECT_EQ(other_ent.GetInfos().Size(), 1);
+  EXPECT_EQ(other_ent.GetInfos().At(0).GetDescription(), "info_desc");
+  EXPECT_EQ(other_ent.GetInfos().At(0).GetCode(), MessageCode::UNSPECIFIED);
+}
+
+} // namespace caosdb::entity