F dot in username

Summary

Adds a very simple User class and methods for creation, retrieval and deletion. This allows us to test the user creation/deletion of the GRPC API.

The User class and the methods are only available when the newly introduced "BUILD_ACM" macro is set. The make files and the pipeline has been updated for this.

Focus

The User class is designed after the delegator/wrapper pattern where UserImpl is the delegate. The UserImpl class is a wrapper for protobuf's User message objects. This might look clumsy at first but it has the advantage that the grpc/protobuf code is encapsuled and hidden in the *.cpp file. This is a first test which demonstrates how we can remove the grpc/protobuf dependency from the headers altogether (which will make it easier to compile the library as a shared library on windows).

Test Environment

• See unit test in test_user
• See integration tests in caosdb-cppinttest!23 (merged)

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 (or not necessary)
• 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 (or not necessary)
• 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 specifications? Are they satisfied?

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

include/caosdb/acm/user.h

+/*
+ * This file is a part of the CaosDB Project.
+ *
+ * Copyright (C) 2022 Timm Fitschen <t.fitschen@indiscale.com>
+ * Copyright (C) 2022 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/>.
+ *
+ */
+
+/**
+ * @brief Users, together with roles, and permissions are a fundamental concept
+ * of the access controll management of CaosDB.
+ *
+ * @file caosdb/acm/user.h
+ * @author Timm Fitchen
+ * @date 2022-06-29
+ */
+#ifdef BUILD_ACM
+#ifndef CAOSDB_ACM_USER_H
+#define CAOSDB_ACM_USER_H
+
+#include <memory> // for unique_ptr
+#include <string> // for string
+
+namespace caosdb::connection {
+class Connection;
+}
+
+namespace caosdb::acm {
+
+/**
+ * The UserImpl class is the delegate of the User class. It hides the
+ * implementation details from the clients.
+ */
+class UserImpl;
+
+/**
+ * The User class is a delegator. The actual data is stored in a wrapped
+ * UserImpl object.
+ */
+class User {
+public:
+  /**
+   * Default constructor.
+   *
+   * Initialize a user without any name, realm, password...
+   */
+  User();
+  /**
+   * Constructor. Initialize a user in the given realm with the given name.
+   */
+  explicit User(std::string realm, std::string name);
+  /**
+   * Constructor. Initialize a user with the given name.
+   */
+  explicit User(std::string name);
+  /**
+   * Copy constructor.
+   */
+  User(const User &user);
+  /**
+   * Move constructor.
+   *
+   * The moved-from user is empty, but still usable.
+   */
+  User(User &&user) noexcept;
+  /**
+   * Copy assignment.
+   */
+  auto operator=(const User &user) -> User &;
+  /**
+   * Move assignment.
+   *
+   * The moved-from user is empty, but still usable.
+   */
+  auto operator=(User &&user) noexcept -> User &;
+  /**
+   * Dtor.
+   */
+  ~User();
+
+  /**
+   * Return a string representation of this user.
+   */
+  auto ToString() const -> std::string;
+  /**
+   * Return the name of this user or the empty string.
+   */
+  [[nodiscard]] auto GetName() const -> const std::string &;
+  /**
+   * Set the name of this user.
+   */
+  auto SetName(const std::string &name) -> void;
+  /**
+   * Return the realm of this user or the empty.
+   */
+  [[nodiscard]] auto GetRealm() const -> const std::string &;
+  /**
+   * Set the realm of this user.
+   */
+  auto SetRealm(const std::string &realm) -> void;
+  /**
+   * Return the password of this user or the empty string.
+   */
+  [[nodiscard]] auto GetPassword() const -> const std::string &;
+  /**
+   * Set the password of this user.
+   */
+  auto SetPassword(const std::string &password) -> void;
+
+  friend class caosdb::connection::Connection;
+
+private:
+  /**
+   * Constructor. Create a user object from the given UserImpl delegate.
+   */
+  explicit User(std::unique_ptr<UserImpl> wrapped);
+  /**
+   * The UserImpl delegate.
+   */
+  std::unique_ptr<UserImpl> wrapped;
+};
+
+} // namespace caosdb::acm
+#endif
+#endif