Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 1 | # Copyright 2020 The Pigweed Authors |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | # use this file except in compliance with the License. You may obtain a copy of |
| 5 | # the License at |
| 6 | # |
| 7 | # https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | # License for the specific language governing permissions and limitations under |
| 13 | # the License. |
| 14 | |
| 15 | import("$dir_pw_docgen/docs.gni") |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 16 | import("$dir_pw_protobuf_compiler/proto.gni") |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 17 | import("$dir_pw_unit_test/test.gni") |
| 18 | |
| 19 | config("default_config") { |
| 20 | include_dirs = [ "public" ] |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 21 | visibility = [ ":*" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 22 | } |
| 23 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 24 | # pw_rpc servers depend on the protobuf library used to encode and decode |
| 25 | # requests and responses when invoking methods. This template is used to create |
| 26 | # instances of the pw_rpc server library with different implementations. |
| 27 | # |
| 28 | # The implementation parameter must refer to a library that provides the |
| 29 | # definition of the Method class in pw_rpc/internal/method.h. The Method class |
| 30 | # provides the Invoke function, which handles the server use to call into the |
| 31 | # RPC functions themselves. |
| 32 | template("_pw_rpc_server_library") { |
| 33 | assert(defined(invoker.implementation), |
| 34 | "_pw_rpc_server_library requires an implementation to be set") |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 35 | _target_name = target_name |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 36 | |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 37 | source_set(_target_name) { |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 38 | forward_variables_from(invoker, "*") |
| 39 | |
| 40 | public_configs = [ ":default_config" ] |
| 41 | public_deps = [ |
| 42 | ":common", |
| 43 | dir_pw_span, |
| 44 | dir_pw_status, |
| 45 | implementation, |
| 46 | ] |
| 47 | deps = [ |
| 48 | dir_pw_assert, |
| 49 | dir_pw_log, |
| 50 | ] |
| 51 | public = [ |
| 52 | "public/pw_rpc/server.h", |
| 53 | "public/pw_rpc/server_context.h", |
| 54 | ] |
| 55 | sources = [ |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 56 | "base_server_writer.cc", |
| 57 | "public/pw_rpc/internal/base_server_writer.h", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 58 | "public/pw_rpc/internal/service.h", |
| 59 | "public/pw_rpc/internal/service_registry.h", |
| 60 | "server.cc", |
| 61 | "service.cc", |
| 62 | "service_registry.cc", |
| 63 | ] |
| 64 | allow_circular_includes_from = [ implementation ] |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 65 | friend = [ "./*" ] |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 66 | } |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 67 | |
| 68 | source_set("test_utils_$_target_name") { |
| 69 | public = [ "pw_rpc_private/test_utils.h" ] |
| 70 | public_configs = [ ":private_includes" ] |
| 71 | public_deps = [ |
| 72 | ":$_target_name", |
| 73 | ":common", |
| 74 | dir_pw_span, |
| 75 | ] |
| 76 | visibility = [ "./*" ] |
| 77 | } |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | # Classes with no dependencies on the protobuf library for method invocations. |
| 81 | source_set("common") { |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 82 | public_configs = [ ":default_config" ] |
| 83 | public_deps = [ |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 84 | ":protos_pwpb", |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 85 | dir_pw_assert, |
| 86 | dir_pw_span, |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 87 | dir_pw_status, |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 88 | ] |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 89 | public = [ "public/pw_rpc/channel.h" ] |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 90 | sources = [ |
| 91 | "channel.cc", |
| 92 | "packet.cc", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 93 | "public/pw_rpc/internal/base_method.h", |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 94 | "public/pw_rpc/internal/call.h", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 95 | "public/pw_rpc/internal/packet.h", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 96 | ] |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 97 | friend = [ "./*" ] |
| 98 | visibility = [ "./*" ] |
| 99 | } |
| 100 | |
| 101 | # RPC server that uses Nanopb to encode and decode protobufs. RPCs use Nanopb |
| 102 | # structs as their requests and responses. |
| 103 | _pw_rpc_server_library("nanopb_server") { |
| 104 | implementation = "nanopb" |
| 105 | } |
| 106 | |
| 107 | config("private_includes") { |
| 108 | include_dirs = [ "." ] |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 109 | visibility = [ ":*" ] |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 110 | } |
| 111 | |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 112 | pw_proto_library("protos") { |
| 113 | sources = [ "pw_rpc_protos/packet.proto" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | pw_doc_group("docs") { |
| 117 | sources = [ "docs.rst" ] |
| 118 | } |
| 119 | |
| 120 | pw_test_group("tests") { |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 121 | tests = [ |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 122 | ":base_server_writer_test", |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 123 | "nanopb:method_test", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 124 | ":packet_test", |
| 125 | ":server_test", |
| 126 | ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 129 | # RPC server for tests only. A mock method implementation is used. |
| 130 | _pw_rpc_server_library("test_server") { |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 131 | implementation = "test_impl" |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 132 | visibility = [ ":*" ] |
| 133 | } |
| 134 | |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 135 | pw_proto_library("test_protos") { |
| 136 | sources = [ "pw_rpc_test_protos/test.proto" ] |
| 137 | visibility = [ "./*" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 138 | } |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 139 | |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 140 | pw_test("base_server_writer_test") { |
| 141 | deps = [ |
| 142 | ":test_server", |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 143 | ":test_utils_test_server", |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 144 | ] |
| 145 | sources = [ "base_server_writer_test.cc" ] |
| 146 | } |
| 147 | |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 148 | pw_test("packet_test") { |
| 149 | deps = [ |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 150 | ":common", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 151 | dir_pw_protobuf, |
| 152 | ] |
| 153 | sources = [ "packet_test.cc" ] |
| 154 | } |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 155 | |
| 156 | pw_test("server_test") { |
| 157 | deps = [ |
| 158 | ":protos_pwpb", |
| 159 | ":test_server", |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame^] | 160 | ":test_utils_test_server", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 161 | dir_pw_assert, |
| 162 | ] |
| 163 | sources = [ "server_test.cc" ] |
| 164 | } |