F consolidation

test/test_transaction.cpp

@@ -19,6 +19,7 @@
  *
  */
 #include "caosdb/connection.h" // for Connection, ConnectionManager
+#include "caosdb/data_type.h"  // for AtomicDataType
 #include "caosdb/entity.h"     // for Entity, Messages, Message
 #include "caosdb/file_transmission/file_reader.h" // for FileReader
 #include "caosdb/file_transmission/file_writer.h" // for FileWriter
@@ -39,10 +40,13 @@
 
 namespace fs = boost::filesystem;
 namespace caosdb::transaction {
+using caosdb::entity::AtomicDataType;
 using caosdb::entity::Entity;
+using caosdb::entity::Importance;
 using caosdb::entity::MessageCode;
 using caosdb::entity::Parent;
 using caosdb::entity::Property;
+using caosdb::entity::Role;
 
 class test_transaction : public ::testing::Test {
 protected:
@@ -53,6 +57,7 @@ protected:
     test_upload_file_1 = fs::path("test_upload_file_1_delete_me.dat");
     test_download_file_1 = fs::path("test_download_file_1_delete_me.dat");
 
+    // fill the file that shall be uploaded
     FileWriter writer(test_upload_file_1);
     std::string buffer(1024, 'c');
     for (int i = 0; i < 8; i++) {
@@ -61,9 +66,11 @@ protected:
   }
 
   void TearDown() override {
+    // delete files
     fs::remove(test_upload_file_1);
     fs::remove(test_download_file_1);
 
+    // delete all entities
     const auto &connection =
         caosdb::connection::ConnectionManager::GetDefaultConnection();
     auto query_transaction(connection->CreateTransaction());
@@ -79,30 +86,12 @@ protected:
   }
 };
 
-TEST_F(test_transaction, DISABLED_retrieve_manufacturer_by_id) {
-  const auto &connection =
-      caosdb::connection::ConnectionManager::GetDefaultConnection();
-
-  const auto *id = "107";
-  const auto *role = "RecordType";
-  const auto *name = "Manufacturer";
-  const auto *description = "A generic manufacturer of all kinds of products";
-  const auto *version = "0bea8f7b17f0130fa5701a6c3849b9f8bfa0651b";
-
-  auto transaction(connection->CreateTransaction());
-  transaction->RetrieveById(id);
-  transaction->Execute();
-
-  const auto &result_set = transaction->GetResultSet();
-
-  const auto &entity = result_set.at(0);
-  EXPECT_EQ(id, entity.GetId());
-  EXPECT_EQ(name, entity.GetName());
-  EXPECT_EQ(role, entity.GetRole());
-  EXPECT_EQ(description, entity.GetDescription());
-  EXPECT_EQ(version, entity.GetVersionId());
-}
-
+/*
+ * Test the retrieval of a non-existing entity
+ *
+ * The transaction returns an error code and the entity has the appropriate
+ * error message
+ */
 TEST_F(test_transaction, retrieve_non_existing) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -127,6 +116,12 @@ TEST_F(test_transaction, retrieve_non_existing) {
             MessageCode::ENTITY_DOES_NOT_EXIST);
 }
 
+/*
+ * Testing the insertion of a basic entity
+ * Transaction should terminate without errors.
+ * Returned entity should have an id, no errors and a warning since no property
+ * is set.
+ */
 TEST_F(test_transaction, insert_without_delete) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -134,7 +129,7 @@ TEST_F(test_transaction, insert_without_delete) {
   auto insert_transaction(connection->CreateTransaction());
 
   Entity entity;
-  entity.SetRole("RecordType");
+  entity.SetRole(Role::RECORD_TYPE);
   entity.SetName("RT1");
   insert_transaction->InsertEntity(&entity);
   insert_transaction->ExecuteAsynchronously();
@@ -156,14 +151,20 @@ TEST_F(test_transaction, insert_without_delete) {
             MessageCode::ENTITY_HAS_NO_PROPERTIES);
 }
 
+/*
+ * Test deletion of an entity
+ * Insert an entity first.
+ */
 TEST_F(test_transaction, insert_delete) {
+  // same as in insert_without_delete
+  // until marked  END SAME
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   auto insert_transaction(connection->CreateTransaction());
 
   Entity entity;
-  entity.SetRole("RecordType");
+  entity.SetRole(Role::RECORD_TYPE);
   entity.SetName("RT1");
   insert_transaction->InsertEntity(&entity);
   insert_transaction->ExecuteAsynchronously();
@@ -177,12 +178,7 @@ TEST_F(test_transaction, insert_delete) {
 
   const auto &new_entity = insert_result_set.at(0);
   EXPECT_FALSE(new_entity.GetId().empty());
-  EXPECT_FALSE(new_entity.HasErrors());
-  // Should have a warning since it has no properties
-  EXPECT_TRUE(new_entity.HasWarnings());
-  EXPECT_EQ(new_entity.GetWarnings().size(), 1);
-  EXPECT_EQ(new_entity.GetWarnings().at(0).GetCode(),
-            MessageCode::ENTITY_HAS_NO_PROPERTIES);
+  // END SAME
 
   auto delete_transaction(connection->CreateTransaction());
 
@@ -201,14 +197,20 @@ TEST_F(test_transaction, insert_delete) {
   EXPECT_FALSE(deleted_entity.HasErrors());
 }
 
+/*
+ * Insert a Record with a parent, retrieve and delete it again
+ */
 TEST_F(test_transaction, insert_delete_with_parent) {
+  // same as in insert_without_delete
+  // until marked  END SAME
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   auto insert_transaction(connection->CreateTransaction());
 
+  // insert RT
   Entity rt;
-  rt.SetRole("RecordType");
+  rt.SetRole(Role::RECORD_TYPE);
   rt.SetName("TestRT");
   insert_transaction->InsertEntity(&rt);
   insert_transaction->ExecuteAsynchronously();
@@ -221,9 +223,11 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   const auto &insert_result_set = insert_transaction->GetResultSet();
 
   const auto &inserted_rt = insert_result_set.at(0);
+  // END SAME
 
+  // create Record with parent
   Entity rec;
-  rec.SetRole("Record");
+  rec.SetRole(Role::RECORD);
   rec.SetName("TestRec");
 
   Parent parent;
@@ -231,6 +235,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   parent.SetId(inserted_rt.GetId());
   rec.AppendParent(parent);
 
+  // insert Record
   auto rec_transaction(connection->CreateTransaction());
   rec_transaction->InsertEntity(&rec);
   rec_transaction->ExecuteAsynchronously();
@@ -246,6 +251,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
 
   EXPECT_FALSE(inserted_rec.GetId().empty());
 
+  // retrieve inserted Record
   auto retrieve_transaction(connection->CreateTransaction());
   retrieve_transaction->RetrieveById(inserted_rec.GetId());
 
@@ -259,11 +265,13 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   const auto &retrieve_result_set = retrieve_transaction->GetResultSet();
   const auto &retrieved_rec = retrieve_result_set.at(0);
 
+  // compare retrieved record with the one that was inserted
   EXPECT_EQ(retrieved_rec.GetName(), rec.GetName());
   EXPECT_EQ(retrieved_rec.GetParents().size(), 1);
   EXPECT_EQ(retrieved_rec.GetParents().at(0).GetId(), inserted_rt.GetId());
   EXPECT_EQ(retrieved_rec.GetParents().at(0).GetName(), rt.GetName());
 
+  // delete the inserted record again
   auto rec_deletion(connection->CreateTransaction());
 
   rec_deletion->DeleteById(retrieved_rec.GetId());
@@ -274,6 +282,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   ASSERT_TRUE(rec_delete_status.IsTerminated());
   ASSERT_FALSE(rec_delete_status.IsError());
 
+  // delete the record type again
   auto rt_deletion(connection->CreateTransaction());
 
   rt_deletion->DeleteById(inserted_rt.GetId());
@@ -285,15 +294,18 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   ASSERT_FALSE(rt_delete_status.IsError());
 }
 
+/*
+ * insert a property, record type with that property and a record with it
+ */
 TEST_F(test_transaction, insert_delete_with_property) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   // Create and insert property
   Entity prop_ent;
-  prop_ent.SetRole("Property");
+  prop_ent.SetRole(Role::PROPERTY);
   prop_ent.SetName("TestProperty");
-  prop_ent.SetDatatype("TEXT");
+  prop_ent.SetDataType(AtomicDataType::TEXT);
 
   auto prop_insertion(connection->CreateTransaction());
   prop_insertion->InsertEntity(&prop_ent);
@@ -313,10 +325,10 @@ TEST_F(test_transaction, insert_delete_with_property) {
   Property prop_rt;
   prop_rt.SetName(prop_ent.GetName());
   prop_rt.SetId(inserted_prop.GetId());
-  prop_rt.SetImportance("SUGGESTED");
+  prop_rt.SetImportance(Importance::SUGGESTED);
 
   Entity rt;
-  rt.SetRole("RecordType");
+  rt.SetRole(Role::RECORD_TYPE);
   rt.SetName("TestRT");
   rt.SetDescription("Some description");
   rt.AppendProperty(prop_rt);
@@ -355,7 +367,7 @@ TEST_F(test_transaction, insert_delete_with_property) {
   const auto &retrieved_prop_rt = retrieved_rt.GetProperties().at(0);
   EXPECT_EQ(retrieved_prop_rt.GetName(), prop_ent.GetName());
   EXPECT_EQ(retrieved_prop_rt.GetId(), inserted_prop.GetId());
-  EXPECT_EQ(retrieved_prop_rt.GetDatatype(), prop_ent.GetDatatype());
+  EXPECT_EQ(retrieved_prop_rt.GetDataType(), prop_ent.GetDataType());
   EXPECT_EQ(retrieved_prop_rt.GetImportance(), prop_rt.GetImportance());
 
   // create and insert record of the above record type with a property
@@ -367,11 +379,11 @@ TEST_F(test_transaction, insert_delete_with_property) {
   Property prop_rec;
   prop_rec.SetName(prop_ent.GetName());
   prop_rec.SetId(inserted_prop.GetId());
-  prop_rec.SetValue("Test");
+  prop_rec.SetValue(std::string("Test"));
 
   Entity rec;
   rec.SetName("TestRec");
-  rec.SetRole("Record");
+  rec.SetRole(Role::RECORD);
   rec.AppendParent(parent);
   rec.AppendProperty(prop_rec);
 
@@ -389,7 +401,7 @@ TEST_F(test_transaction, insert_delete_with_property) {
   const auto &inserted_rec = rec_result_set.at(0);
   EXPECT_FALSE(inserted_rec.GetId().empty());
 
-  // Retrieve the record and verify paretn and property
+  // Retrieve the record and verify parent and property
   auto rec_retrieval(connection->CreateTransaction());
   rec_retrieval->RetrieveById(inserted_rec.GetId());
   rec_retrieval->ExecuteAsynchronously();
@@ -414,10 +426,13 @@ TEST_F(test_transaction, insert_delete_with_property) {
   const auto &retrieved_prop_rec = retrieved_rec.GetProperties().at(0);
   EXPECT_EQ(retrieved_prop_rec.GetName(), prop_ent.GetName());
   EXPECT_EQ(retrieved_prop_rec.GetId(), inserted_prop.GetId());
-  EXPECT_EQ(retrieved_prop_rec.GetDatatype(), prop_ent.GetDatatype());
+  EXPECT_EQ(retrieved_prop_rec.GetDataType(), prop_ent.GetDataType());
   EXPECT_EQ(retrieved_prop_rec.GetValue(), prop_rec.GetValue());
 }
 
+/*
+ * test retrieving multiple entities at once
+ */
 TEST_F(test_transaction, test_multi_retrieve) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -449,6 +464,9 @@ TEST_F(test_transaction, test_multi_retrieve) {
             MessageCode::ENTITY_DOES_NOT_EXIST);
 }
 
+/*
+ * test insert, then update and then delete a RecordType
+ */
 TEST_F(test_transaction, insert_update_delete) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -457,7 +475,7 @@ TEST_F(test_transaction, insert_update_delete) {
   auto insert_transaction(connection->CreateTransaction());
 
   Entity entity;
-  entity.SetRole("RecordType");
+  entity.SetRole(Role::RECORD_TYPE);
   entity.SetName("RT1");
   insert_transaction->InsertEntity(&entity);
   insert_transaction->ExecuteAsynchronously();
@@ -514,6 +532,9 @@ TEST_F(test_transaction, insert_update_delete) {
   EXPECT_FALSE(deleted_entity.HasErrors());
 }
 
+/*
+ * test insert a RecordType and then submit a find and a count query
+ */
 TEST_F(test_transaction, test_query) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -521,7 +542,7 @@ TEST_F(test_transaction, test_query) {
   auto insert_transaction(connection->CreateTransaction());
 
   Entity entity;
-  entity.SetRole("RecordType");
+  entity.SetRole(Role::RECORD_TYPE);
   entity.SetName("RT1");
   insert_transaction->InsertEntity(&entity);
   insert_transaction->ExecuteAsynchronously();
@@ -556,13 +577,17 @@ TEST_F(test_transaction, test_query) {
   EXPECT_EQ(count_query_trans->GetCountResult(), 1);
 }
 
+/*
+ * insert three recordtypes and the submit multiple queries in different
+ * combinations
+ */
 TEST_F(test_transaction, test_query_with_retrieve) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   // rt1
   Entity rt1;
-  rt1.SetRole("RecordType");
+  rt1.SetRole(Role::RECORD_TYPE);
   rt1.SetName("TestRT1");
 
   auto insert_rt1_transaction(connection->CreateTransaction());
@@ -582,7 +607,7 @@ TEST_F(test_transaction, test_query_with_retrieve) {
 
   // rt2
   Entity rt2;
-  rt2.SetRole("RecordType");
+  rt2.SetRole(Role::RECORD_TYPE);
   rt2.SetName("TestRT2");
 
   auto insert_rt2_transaction(connection->CreateTransaction());
@@ -602,7 +627,7 @@ TEST_F(test_transaction, test_query_with_retrieve) {
 
   // rt3
   Entity rt3;
-  rt3.SetRole("RecordType");
+  rt3.SetRole(Role::RECORD_TYPE);
   rt3.SetName("TestRT3");
 
   auto insert_rt3_transaction(connection->CreateTransaction());
@@ -668,12 +693,15 @@ TEST_F(test_transaction, test_query_with_retrieve) {
   EXPECT_EQ(count_and_retrieve->GetCountResult(), 3);
 }
 
+/*
+ * create a file object and upload it
+ */
 TEST_F(test_transaction, test_file_upload) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   Entity file;
-  file.SetRole("File");
+  file.SetRole(Role::FILE);
   file.SetFilePath("test.txt");
   file.SetLocalPath(test_upload_file_1);
 
@@ -702,12 +730,15 @@ TEST_F(test_transaction, test_file_upload) {
   EXPECT_EQ(count_query->GetCountResult(), 1);
 }
 
+/*
+ * create a file object, upload and then download it
+ */
 TEST_F(test_transaction, test_file_up_n_download) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
   Entity file;
-  file.SetRole("File");
+  file.SetRole(Role::FILE);
   file.SetFilePath("test.txt");
   file.SetLocalPath(test_upload_file_1);
 
@@ -745,4 +776,131 @@ TEST_F(test_transaction, test_file_up_n_download) {
   }
 }
 
+/*
+ * Test a small worklfow
+ */
+TEST_F(test_transaction, test_full_workflow) {
+  const auto &connection =
+      caosdb::connection::ConnectionManager::GetDefaultConnection();
+
+  // ######  Create Data Model  ######
+  Entity dataRT;
+  dataRT.SetRole(Role::RECORD_TYPE);
+  dataRT.SetName("DataRT");
+
+  Entity voltage;
+  voltage.SetRole(Role::PROPERTY);
+  voltage.SetName("voltage");
+  voltage.SetUnit("V");
+  voltage.SetDataType(AtomicDataType::DOUBLE);
+
+  Entity notes;
+  notes.SetRole(Role::PROPERTY);
+  notes.SetName("notes");
+  notes.SetDataType(AtomicDataType::TEXT);
+
+  Entity participants;
+  participants.SetRole(Role::PROPERTY);
+  participants.SetName("participants");
+  participants.SetDataType(AtomicDataType::INTEGER);
+  // participants.SetDataType(ListDataType::);
+
+  Entity success;
+  success.SetRole(Role::PROPERTY);
+  success.SetName("success");
+  success.SetDataType(AtomicDataType::BOOLEAN);
+
+  Entity experiment;
+  experiment.SetRole(Role::RECORD_TYPE);
+  experiment.SetName("Experiment");
+  // TODO(henrik): creating this extra Property (additionally to the Entity
+  // above) is VERY clumsy
+  Property volt_for_rt;
+  volt_for_rt.SetName(voltage.GetName());
+  volt_for_rt.SetImportance(Importance::RECOMMENDED);
+  experiment.AppendProperty(volt_for_rt);
+  Property notes_for_rt2;
+  notes_for_rt2.SetName(notes.GetName());
+  notes_for_rt2.SetImportance(Importance::RECOMMENDED);
+  experiment.AppendProperty(notes_for_rt2);
+  Property part_for_rt3;
+  part_for_rt3.SetName(participants.GetName());
+  part_for_rt3.SetImportance(Importance::SUGGESTED);
+  experiment.AppendProperty(part_for_rt3);
+  Property succ_for_rt;
+  succ_for_rt.SetName(success.GetName());
+  succ_for_rt.SetImportance(Importance::SUGGESTED);
+  experiment.AppendProperty(succ_for_rt);
+
+  auto insert_transaction(connection->CreateTransaction());
+  insert_transaction->InsertEntity(&dataRT);
+  auto insert_status = insert_transaction->Execute();
+  const auto &insert_results = insert_transaction->GetResultSet();
+  const auto &inserted_ent = insert_results.at(0);
+  ASSERT_FALSE(inserted_ent.GetId().empty());
+  ASSERT_FALSE(inserted_ent.HasErrors());
+
+  insert_transaction = connection->CreateTransaction();
+  insert_transaction->InsertEntity(&voltage);
+  insert_status = insert_transaction->Execute();
+  insert_transaction = connection->CreateTransaction();
+  insert_transaction->InsertEntity(&notes);
+  insert_status = insert_transaction->Execute();
+  insert_transaction = connection->CreateTransaction();
+  insert_transaction->InsertEntity(&participants);
+  insert_status = insert_transaction->Execute();
+  insert_transaction = connection->CreateTransaction();
+  insert_transaction->InsertEntity(&success);
+  insert_status = insert_transaction->Execute();
+  insert_transaction = connection->CreateTransaction();
+  insert_transaction->InsertEntity(&experiment);
+  insert_status = insert_transaction->Execute();
+
+  auto retr_transaction(connection->CreateTransaction());
+  retr_transaction->Query("FIND Experiment");
+  retr_transaction->Execute();
+  EXPECT_EQ(retr_transaction->GetResultSet().size(), 1);
+
+  Parent experiment_parent;
+  experiment_parent.SetName("Experiment");
+
+  for (int i = 0; i < 8; i++) {
+    Entity experiment_rec;
+    experiment_rec.SetRole(Role::RECORD);
+    experiment_rec.AppendParent(experiment_parent);
+    volt_for_rt.SetValue(1.6);
+    experiment_rec.AppendProperty(volt_for_rt);
+    notes_for_rt2.SetValue("This is important!");
+    experiment_rec.AppendProperty(notes_for_rt2);
+    part_for_rt3.SetValue(static_cast<int64_t>(6));
+    experiment_rec.AppendProperty(part_for_rt3);
+    succ_for_rt.SetValue(true);
+    experiment_rec.AppendProperty(succ_for_rt);
+    auto rec_insert_transaction(connection->CreateTransaction());
+    rec_insert_transaction->InsertEntity(&experiment_rec);
+    std::cout << "before ..." << std::endl;
+    insert_status = rec_insert_transaction->Execute();
+    std::cout << "after ..." << std::endl;
+  }
+
+  retr_transaction = connection->CreateTransaction();
+  retr_transaction->Query("FIND Record Experiment");
+  retr_transaction->Execute();
+  EXPECT_EQ(retr_transaction->GetResultSet().size(), 8);
+
+  auto to_be_updated = retr_transaction->GetResultSet().at(0);
+  // TODO(henrik) using the index for deletion is very inconvenient
+  to_be_updated.RemoveProperty(0);
+  to_be_updated.SetName("changedone");
+
+  auto update_transaction(connection->CreateTransaction());
+  update_transaction->UpdateEntity(&to_be_updated);
+  update_transaction->Execute();
+
+  retr_transaction = connection->CreateTransaction();
+  retr_transaction->Query("FIND Record Experiment with name=changedone");
+  retr_transaction->Execute();
+  EXPECT_EQ(retr_transaction->GetResultSet().size(), 1);
+}
+
 } // namespace caosdb::transaction