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/permission_rule.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 PermissionRules grant or deny permissions to roles.
+ *
+ * @file caosdb/acm/permission_rule.h
+ * @author Timm Fitchen
+ * @date 2022-02-11
+ */
+#ifdef BUILD_ACM
+#ifndef CAOSDB_ACM_PERMISSION_RULE_H
+#define CAOSDB_ACM_PERMISSION_RULE_H
+
+#include <stddef.h>      // for size_t
+#include <unordered_set> // for unordered_set
+#include <string>        // for string
+
+namespace caosdb::acm {
+
+class PermissionRuleImpl;
+
+class PermissionRule {
+public:
+  PermissionRule(std::string permission, bool isGrant, bool isPriority);
+  explicit PermissionRule(PermissionRuleImpl *wrapped);
+  PermissionRule(const PermissionRule &rule);
+  auto operator=(const PermissionRule &rule) -> PermissionRule &;
+  ~PermissionRule();
+  auto ToString() const -> std::string;
+  [[nodiscard]] auto IsGrant() const -> bool;
+  auto SetGrant(bool isGrant) -> void;
+  [[nodiscard]] auto IsPriority() const -> bool;
+  auto SetPriority(bool isPriority) -> void;
+  [[nodiscard]] auto GetPermission() const -> const std::string &;
+
+  auto operator==(const PermissionRule &other) const -> bool;
+
+private:
+  PermissionRuleImpl *impl;
+};
+
+struct HashPermissionRule {
+  auto operator()(const PermissionRule &rule) const -> size_t;
+};
+
+using PermissionRules = std::unordered_set<PermissionRule, HashPermissionRule>;
+
+} // namespace caosdb::acm
+#endif
+#endif