Shared model/query response builders (hyperledger-iroha#1072)

* Query response builder Signed-off-by: Dumitru <[email protected]> * Query response template builder Signed-off-by: Dumitru <[email protected]> * Query Response builder Signed-off-by: Dumitru <[email protected]> * Query error response builders and tests Signed-off-by: Dumitru <[email protected]> * Revert transport builder test Signed-off-by: Dumitru <[email protected]> * Query response builder test Signed-off-by: Dumitru <[email protected]> * Refactor Signed-off-by: Dumitru <[email protected]> * Refactor Signed-off-by: Dumitru <[email protected]> * reason setter Signed-off-by: Dumitru <[email protected]> * Add test for each errorResponse Signed-off-by: Dumitru <[email protected]> * Remove build type Signed-off-by: Dumitru <[email protected]> * Constexpr get reason Signed-off-by: Dumitru <[email protected]> * Builder constexpr variable reason Signed-off-by: Dumitru <[email protected]> * Add constexpr Signed-off-by: Dumitru <[email protected]>
Ignitus · Mar 30, 2018 · 8dbea33 · 8dbea33
1 parent f331350
commit 8dbea33
Show file tree

Hide file tree

Showing 4 changed files with 709 additions and 0 deletions.
diff --git a/shared_model/builders/protobuf/builder_templates/query_response_template.hpp b/shared_model/builders/protobuf/builder_templates/query_response_template.hpp
@@ -0,0 +1,262 @@
+/**
+ * Copyright Soramitsu Co., Ltd. 2018 All Rights Reserved.
+ * http://soramitsu.co.jp
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef IROHA_PROTO_QUERY_RESPONSE_BUILDER_TEMPLATE_HPP
+#define IROHA_PROTO_QUERY_RESPONSE_BUILDER_TEMPLATE_HPP
+
+#include "backend/protobuf/query_responses/proto_query_response.hpp"
+#include "builders/protobuf/helpers.hpp"
+#include "common/visitor.hpp"
+#include "interfaces/common_objects/types.hpp"
+#include "responses.pb.h"
+
+namespace shared_model {
+  namespace proto {
+
+    template <class T>
+    constexpr iroha::protocol::ErrorResponse_Reason reason =
+        iroha::protocol::ErrorResponse_Reason_STATELESS_INVALID;
+
+    /**
+     * Template query response builder for creating new types of query response
+     * builders by means of replacing template parameters
+     * @tparam S -- field counter for checking that all required fields are
+     * set
+     */
+    template <int S = 0>
+    class TemplateQueryResponseBuilder {
+     private:
+      template <int>
+      friend class TemplateQueryResponseBuilder;
+
+      enum RequiredFields { QueryResponseField, QueryHash, TOTAL };
+
+      template <int s>
+      using NextBuilder = TemplateQueryResponseBuilder<S | (1 << s)>;
+
+      using ProtoQueryResponse = iroha::protocol::QueryResponse;
+
+      template <class T>
+      using w = shared_model::detail::PolymorphicWrapper<T>;
+
+      template <int Sp>
+      TemplateQueryResponseBuilder(const TemplateQueryResponseBuilder<Sp> &o)
+          : query_response_(o.query_response_) {}
+
+      /**
+       * Make transformation on copied content
+       * @tparam Transformation - callable type for changing the copy
+       * @param t - transform function for proto object
+       * @return new builder with updated state
+       */
+      template <int Fields, typename Transformation>
+      auto transform(Transformation t) const {
+        NextBuilder<Fields> copy = *this;
+        t(copy.query_response_);
+        return copy;
+      }
+
+      /**
+       * Make query field transformation on copied object
+       * @tparam Transformation - callable type for changing query
+       * @param t - transform function for proto query
+       * @return new builder with set query
+       */
+      template <typename Transformation>
+      auto queryResponseField(Transformation t) const {
+        NextBuilder<QueryResponseField> copy = *this;
+        t(copy.query_response_);
+        return copy;
+      }
+
+     public:
+      TemplateQueryResponseBuilder() = default;
+
+      auto accountAssetResponse(
+          const interface::types::AssetIdType &asset_id,
+          const interface::types::AccountIdType &account_id,
+          const std::string &amount) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::AccountAssetResponse *query_response =
+              proto_query_response.mutable_account_assets_response();
+
+          query_response->mutable_account_asset()->set_account_id(account_id);
+          query_response->mutable_account_asset()->set_asset_id(asset_id);
+          initializeProtobufAmount(
+              query_response->mutable_account_asset()->mutable_balance(),
+              amount);
+        });
+      }
+
+      auto accountDetailResponse(
+          const interface::types::DetailType &account_detail) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::AccountDetailResponse *query_response =
+              proto_query_response.mutable_account_detail_response();
+          query_response->set_detail(account_detail);
+        });
+      }
+
+      auto accountResponse(const Account &account,
+                           const std::vector<std::string> &roles) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::AccountResponse *query_response =
+              proto_query_response.mutable_account_response();
+          query_response->mutable_account()->CopyFrom((account.getTransport()));
+          for (const auto &role : roles) {
+            query_response->add_account_roles(role);
+          }
+        });
+      }
+
+      template <class T>
+      auto errorQueryResponse() const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::ErrorResponse *query_response =
+              proto_query_response.mutable_error_response();
+          query_response->set_reason(reason<T>);
+        });
+      }
+
+      auto signatoriesResponse(
+          const std::vector<interface::types::BlobType> &signatories) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::SignatoriesResponse *query_response =
+              proto_query_response.mutable_signatories_response();
+          for (const auto &key : signatories) {
+            const auto &blob = key.blob();
+            query_response->add_keys(blob.data(), blob.size());
+          }
+        });
+      }
+
+      auto transactionsResponse(
+          const std::vector<proto::Transaction> &transactions) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::TransactionsResponse *query_response =
+              proto_query_response.mutable_transactions_response();
+          for (const auto &tx : transactions) {
+            query_response->add_transactions()->CopyFrom(tx.getTransport());
+          }
+        });
+      }
+
+      auto assetResponse(const std::string &asset_id,
+                         const std::string &domain_id,
+                         const uint32_t precision) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::AssetResponse *query_response =
+              proto_query_response.mutable_asset_response();
+          auto asset = query_response->mutable_asset();
+          asset->set_asset_id(asset_id);
+          asset->set_domain_id(domain_id);
+          asset->set_precision(precision);
+        });
+      }
+
+      auto rolesResponse(
+          const std::vector<interface::types::RoleIdType> &roles) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::RolesResponse *query_response =
+              proto_query_response.mutable_roles_response();
+          for (const auto &role : roles) {
+            query_response->add_roles(role);
+          }
+        });
+      }
+
+      auto rolePermissionsResponse(
+          const std::vector<interface::types::PermissionNameType>
+              &role_permissions) const {
+        return queryResponseField([&](auto &proto_query_response) {
+          iroha::protocol::RolePermissionsResponse *query_response =
+              proto_query_response.mutable_role_permissions_response();
+          for (const auto &perm : role_permissions) {
+            query_response->add_permissions(perm);
+          }
+        });
+      }
+
+      auto queryHash(const interface::types::HashType &query_hash) const {
+        return transform<QueryHash>([&](auto &proto_query_response) {
+          proto_query_response.set_query_hash(
+              crypto::toBinaryString(query_hash));
+        });
+      }
+
+      QueryResponse build() const {
+        static_assert(S == (1 << TOTAL) - 1, "Required fields are not set");
+        auto result =
+            QueryResponse(iroha::protocol::QueryResponse(query_response_));
+        return QueryResponse(std::move(result));
+      }
+
+      static const int total = RequiredFields::TOTAL;
+
+     private:
+      ProtoQueryResponse query_response_;
+    };
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::StatelessFailedErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_STATELESS_INVALID;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::StatefulFailedErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_STATEFUL_INVALID;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoAccountErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_ACCOUNT;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoAccountAssetsErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_ACCOUNT_ASSETS;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoAccountDetailErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_ACCOUNT_DETAIL;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoSignatoriesErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_SIGNATORIES;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NotSupportedErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NOT_SUPPORTED;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoAssetErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_ASSET;
+
+    template <>
+    constexpr iroha::protocol::ErrorResponse_Reason
+        reason<interface::NoRolesErrorResponse> =
+            iroha::protocol::ErrorResponse_Reason_NO_ROLES;
+
+  }  // namespace proto
+}  // namespace shared_model
+
+#endif  // IROHA_PROTO_QUERY_RESPONSE_BUILDER_TEMPLATE_HPP
diff --git a/test/module/shared_model/builders/common_objects/CMakeLists.txt b/test/module/shared_model/builders/common_objects/CMakeLists.txt
@@ -65,3 +65,11 @@ target_link_libraries(account_asset_builder_test
         shared_model_proto_builders
         shared_model_stateless_validation
         )
+
+addtest(query_response_builder_test
+        query_response_builder_test.cpp
+        )
+
+target_link_libraries(query_response_builder_test
+        shared_model_proto_builders
+        )