feat chaotic: OpenAPI generator improvements

- add golden tests for handlers
- generate config.chaotic.yaml, merge it into the final config.yaml
- documentation on chaotic
commit_hash:8beea42a31d289d5695fbf3cd868a14b281fea41

Author: segoon

.mapping.json

@@ -3,6 +3,7 @@
 import re
 
 import jinja2
+import yaml
 
 from chaotic import cpp_format
 from chaotic import jinja_env
@@ -135,6 +136,30 @@ def render(spec: ServerSpec, context: Context, userver_namespace: str) -> list[C
     return output
 
 
+def render_config_yaml(spec: ServerSpec) -> str:
+    components = {
+        component_name(op): {
+            'path': op.path,
+            'method': op.method.upper(),
+        }
+        for op in spec.operations
+    }
+    config = {
+        'components_manager': {
+            'components': components,
+        },
+    }
+    return yaml.dump(config, default_flow_style=False, sort_keys=False)
+
+
+def save_config_yaml(content: str, output_dir: str) -> None:
+    path = os.path.join(output_dir, 'config.chaotic.yaml')
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+
+    with open(path, 'w') as ofile:
+        ofile.write(content)
+
+
 def render_views(spec: ServerSpec, context: Context, userver_namespace: str) -> list[CppOutput]:
     output = []
     for op in spec.operations:

chaotic-openapi/chaotic_openapi/back/cpp/handler/renderer.py

@@ -58,7 +58,9 @@ struct Response{{ response.status }} final {
 {% endfor %}
 
 /// All possible responses for this operation.
+{% if op.iter_error_responses() | list %}
 /// Error types (4xx/5xx) may also be thrown from Handle().
+{% endif %}
 {% if op.responses | length == 1 %}
     using Response = Response{{ op.responses[0].status }};
 {% else %}

chaotic-openapi/chaotic_openapi/back/cpp/handler/templates/responses.hpp.jinja

@@ -11,23 +11,31 @@ Response View::Handle(Request&& /*request*/, Deps&& /*deps*/) {
 {% if op.request_bodies %}
 {% if op.request_bodies[0].content_type == 'application/json' %}
 std::string View::GetRequestBodyForLogging(
-    const {{ userver }}::formats::json::Value& /*body*/) {
+    const {{ userver }}::formats::json::Value& body) {
+    (void)body;
     return {};
 }
 
 std::string View::GetInvalidRequestBodyForLogging(
-    const {{ userver }}::server::http::HttpRequest& /*request*/) {
+    const {{ userver }}::server::http::HttpRequest& request) {
+    (void)request;
     return {};
 }
 {% else %}
-std::string View::GetRequestBodyForLogging(const std::string& /*body*/) { return {}; }
+std::string View::GetRequestBodyForLogging(const std::string& body) {
+    (void)body;
+    return {};
+}
 {% endif %}
 {% endif %}
 
 std::string View::GetResponseForLogging(
-    const Response& /*response*/,
-    const std::string& /*serialized_response*/,
-    {{ userver }}::server::request::RequestContext& /*context*/) {
+    const Response& response,
+    const std::string& serialized_response,
+    {{ userver }}::server::request::RequestContext& context) {
+    (void)response;
+    (void)serialized_response;
+    (void)context;
     return {};
 }
 */

chaotic-openapi/chaotic_openapi/back/cpp/handler/templates/view.cpp.jinja

@@ -74,8 +74,13 @@ def do_main():
         ).spec()
 
         if args.gen in ('handlers', 'handlers+views'):
+            # handlers
             outputs = handler_renderer.render(spec, ctx, args.userver)
             client_renderer.CppOutput.save(outputs, args.output_dir)
+
+            # config.yaml
+            config_content = handler_renderer.render_config_yaml(spec)
+            handler_renderer.save_config_yaml(config_content, args.output_dir)
         if args.gen in ('handlers+views', 'views'):
             view_outputs = handler_renderer.render_views(spec, ctx, args.userver)
             handler_renderer.save_views(view_outputs, args.src_dir)

chaotic-openapi/chaotic_openapi/main.py

@@ -4,19 +4,30 @@ include(GoogleTest)
 include(ChaoticGen)
 
 file(GLOB_RECURSE SCHEMAS "${CMAKE_CURRENT_SOURCE_DIR}/schemas/*.yaml")
+
 userver_target_generate_openapi_client(
-    ${PROJECT_NAME}-chgen
+    ${PROJECT_NAME}-chgen-client
+    NAME test
+    OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/src/client"
+    SCHEMAS ${SCHEMAS}
+)
+
+userver_target_generate_openapi_handlers(
+    ${PROJECT_NAME}-chgen-handlers
     NAME test
-    OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/src"
+    OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/src/handlers"
+    SRC_DIR "${CMAKE_CURRENT_BINARY_DIR}/src/handlers"
     SCHEMAS ${SCHEMAS}
 )
 
-add_test(NAME chaotic-openapi-golden
-         COMMAND # Diff returns 0 if files are the same, 1 if they differ
-                 diff -uNrpB "${CMAKE_CURRENT_SOURCE_DIR}/output" "${CMAKE_CURRENT_BINARY_DIR}/src"
+add_test(
+    NAME chaotic-openapi-golden
+    # Diff returns 0 if files are the same, 1 if they differ
+    COMMAND diff -uNrpB "${CMAKE_CURRENT_SOURCE_DIR}/output" "${CMAKE_CURRENT_BINARY_DIR}/src"
 )
+
 add_custom_target(
     update-openapi-golden-tests
-    DEPENDS ${PROJECT_NAME}-chgen
+    DEPENDS ${PROJECT_NAME}-chgen-client ${PROJECT_NAME}-chgen-handlers
     COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_BINARY_DIR}/src" "${CMAKE_CURRENT_SOURCE_DIR}/output"
 )