fix install: clean up installation of samples

* Now `USERVER_BUILD_SAMPLES` does not actually build samples and run their tests in-place unless `USERVER_BUILD_TESTS` is also set. `USERVER_BUILD_SAMPLES` + `USERVER_INSTALL` still installs samples.
* Moved `libraries/easy/samples` to `samples/easy` for consistency. Now they are installed even if `easy` library itself is disabled.

---

* Design decision: samples should always go into `samples/` directory. If there is a risk of cluttering the directory, then create `samples/<library>/` subdirectory with an umbrella `CMakeLists.txt` that will become the root `CMakeLists.txt` after installation. All samples are installed as a single component regardless of whether the libraries are available, following `examples` packages in Qt and other popular multi-module libraries.
commit_hash:e843d6f28a15779dd9b4768f3eaff21af321ba74

Author: Anton3

.github/workflows/ci-conan.yml

@@ -100,9 +100,9 @@ jobs:
 
           - name: Test userver conan package
             run: |-
-                mv libraries/easy/samples/0_hello_world samples/
-                mv libraries/easy/samples/1_hi samples/
-                mv libraries/easy/samples/3_json samples/
+                mv samples/easy/0_hello_world samples/
+                mv samples/easy/1_hi samples/
+                mv samples/easy/3_json samples/
                 mv scripts/tests/conanfile.py samples/
                 rm -rf userver/cmake/
                 cd samples/

.mapping.json

@@ -2999,40 +2999,6 @@
   "libraries/CMakeLists.txt":"taxi/uservices/userver/libraries/CMakeLists.txt",
   "libraries/easy/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/CMakeLists.txt",
   "libraries/easy/include/userver/easy.hpp":"taxi/uservices/userver/libraries/easy/include/userver/easy.hpp",
-  "libraries/easy/samples/0_hello_world/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/0_hello_world/CMakeLists.txt",
-  "libraries/easy/samples/0_hello_world/main.cpp":"taxi/uservices/userver/libraries/easy/samples/0_hello_world/main.cpp",
-  "libraries/easy/samples/0_hello_world/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/0_hello_world/testsuite/conftest.py",
-  "libraries/easy/samples/0_hello_world/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/0_hello_world/testsuite/test_basic.py",
-  "libraries/easy/samples/1_hi/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/1_hi/CMakeLists.txt",
-  "libraries/easy/samples/1_hi/main.cpp":"taxi/uservices/userver/libraries/easy/samples/1_hi/main.cpp",
-  "libraries/easy/samples/1_hi/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/1_hi/testsuite/conftest.py",
-  "libraries/easy/samples/1_hi/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/1_hi/testsuite/test_basic.py",
-  "libraries/easy/samples/2_key_value/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/2_key_value/CMakeLists.txt",
-  "libraries/easy/samples/2_key_value/main.cpp":"taxi/uservices/userver/libraries/easy/samples/2_key_value/main.cpp",
-  "libraries/easy/samples/2_key_value/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/2_key_value/testsuite/conftest.py",
-  "libraries/easy/samples/2_key_value/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/2_key_value/testsuite/test_basic.py",
-  "libraries/easy/samples/3_json/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/3_json/CMakeLists.txt",
-  "libraries/easy/samples/3_json/main.cpp":"taxi/uservices/userver/libraries/easy/samples/3_json/main.cpp",
-  "libraries/easy/samples/3_json/schemas/key_value.yaml":"taxi/uservices/userver/libraries/easy/samples/3_json/schemas/key_value.yaml",
-  "libraries/easy/samples/3_json/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/3_json/testsuite/conftest.py",
-  "libraries/easy/samples/3_json/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/3_json/testsuite/test_basic.py",
-  "libraries/easy/samples/4_custom_dependency/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/4_custom_dependency/CMakeLists.txt",
-  "libraries/easy/samples/4_custom_dependency/main.cpp":"taxi/uservices/userver/libraries/easy/samples/4_custom_dependency/main.cpp",
-  "libraries/easy/samples/4_custom_dependency/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/4_custom_dependency/testsuite/conftest.py",
-  "libraries/easy/samples/4_custom_dependency/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/4_custom_dependency/testsuite/test_basic.py",
-  "libraries/easy/samples/5_pg_service_template/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/CMakeLists.txt",
-  "libraries/easy/samples/5_pg_service_template/configs/static_config.yaml":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/configs/static_config.yaml",
-  "libraries/easy/samples/5_pg_service_template/postgresql/schemas/db_1.sql":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/postgresql/schemas/db_1.sql",
-  "libraries/easy/samples/5_pg_service_template/src/main.cpp":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/src/main.cpp",
-  "libraries/easy/samples/5_pg_service_template/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/testsuite/conftest.py",
-  "libraries/easy/samples/5_pg_service_template/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/5_pg_service_template/testsuite/test_basic.py",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/CMakeLists.txt",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/configs/static_config.yaml":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/configs/static_config.yaml",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/postgresql/schemas/db_1.sql":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/postgresql/schemas/db_1.sql",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/src/main.cpp":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/src/main.cpp",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/testsuite/conftest.py":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/testsuite/conftest.py",
-  "libraries/easy/samples/6_pg_service_template_no_http_with/testsuite/test_basic.py":"taxi/uservices/userver/libraries/easy/samples/6_pg_service_template_no_http_with/testsuite/test_basic.py",
-  "libraries/easy/samples/CMakeLists.txt":"taxi/uservices/userver/libraries/easy/samples/CMakeLists.txt",
   "libraries/easy/src/easy.cpp":"taxi/uservices/userver/libraries/easy/src/easy.cpp",
   "libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/impl/codegen_declarations.hpp":"taxi/uservices/userver/libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/impl/codegen_declarations.hpp",
   "libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/impl/codegen_definitions.hpp":"taxi/uservices/userver/libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/impl/codegen_definitions.hpp",
@@ -4467,6 +4433,40 @@
   "samples/dns-resolver/resolver.cpp":"taxi/uservices/userver/samples/dns-resolver/resolver.cpp",
   "samples/dns-resolver/testsuite/conftest.py":"taxi/uservices/userver/samples/dns-resolver/testsuite/conftest.py",
   "samples/dns-resolver/testsuite/test_basic.py":"taxi/uservices/userver/samples/dns-resolver/testsuite/test_basic.py",
+  "samples/easy/0_hello_world/CMakeLists.txt":"taxi/uservices/userver/samples/easy/0_hello_world/CMakeLists.txt",
+  "samples/easy/0_hello_world/main.cpp":"taxi/uservices/userver/samples/easy/0_hello_world/main.cpp",
+  "samples/easy/0_hello_world/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/0_hello_world/testsuite/conftest.py",
+  "samples/easy/0_hello_world/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/0_hello_world/testsuite/test_basic.py",
+  "samples/easy/1_hi/CMakeLists.txt":"taxi/uservices/userver/samples/easy/1_hi/CMakeLists.txt",
+  "samples/easy/1_hi/main.cpp":"taxi/uservices/userver/samples/easy/1_hi/main.cpp",
+  "samples/easy/1_hi/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/1_hi/testsuite/conftest.py",
+  "samples/easy/1_hi/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/1_hi/testsuite/test_basic.py",
+  "samples/easy/2_key_value/CMakeLists.txt":"taxi/uservices/userver/samples/easy/2_key_value/CMakeLists.txt",
+  "samples/easy/2_key_value/main.cpp":"taxi/uservices/userver/samples/easy/2_key_value/main.cpp",
+  "samples/easy/2_key_value/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/2_key_value/testsuite/conftest.py",
+  "samples/easy/2_key_value/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/2_key_value/testsuite/test_basic.py",
+  "samples/easy/3_json/CMakeLists.txt":"taxi/uservices/userver/samples/easy/3_json/CMakeLists.txt",
+  "samples/easy/3_json/main.cpp":"taxi/uservices/userver/samples/easy/3_json/main.cpp",
+  "samples/easy/3_json/schemas/key_value.yaml":"taxi/uservices/userver/samples/easy/3_json/schemas/key_value.yaml",
+  "samples/easy/3_json/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/3_json/testsuite/conftest.py",
+  "samples/easy/3_json/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/3_json/testsuite/test_basic.py",
+  "samples/easy/4_custom_dependency/CMakeLists.txt":"taxi/uservices/userver/samples/easy/4_custom_dependency/CMakeLists.txt",
+  "samples/easy/4_custom_dependency/main.cpp":"taxi/uservices/userver/samples/easy/4_custom_dependency/main.cpp",
+  "samples/easy/4_custom_dependency/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/4_custom_dependency/testsuite/conftest.py",
+  "samples/easy/4_custom_dependency/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/4_custom_dependency/testsuite/test_basic.py",
+  "samples/easy/5_pg_service_template/CMakeLists.txt":"taxi/uservices/userver/samples/easy/5_pg_service_template/CMakeLists.txt",
+  "samples/easy/5_pg_service_template/configs/static_config.yaml":"taxi/uservices/userver/samples/easy/5_pg_service_template/configs/static_config.yaml",
+  "samples/easy/5_pg_service_template/postgresql/schemas/db_1.sql":"taxi/uservices/userver/samples/easy/5_pg_service_template/postgresql/schemas/db_1.sql",
+  "samples/easy/5_pg_service_template/src/main.cpp":"taxi/uservices/userver/samples/easy/5_pg_service_template/src/main.cpp",
+  "samples/easy/5_pg_service_template/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/5_pg_service_template/testsuite/conftest.py",
+  "samples/easy/5_pg_service_template/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/5_pg_service_template/testsuite/test_basic.py",
+  "samples/easy/6_pg_service_template_no_http_with/CMakeLists.txt":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/CMakeLists.txt",
+  "samples/easy/6_pg_service_template_no_http_with/configs/static_config.yaml":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/configs/static_config.yaml",
+  "samples/easy/6_pg_service_template_no_http_with/postgresql/schemas/db_1.sql":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/postgresql/schemas/db_1.sql",
+  "samples/easy/6_pg_service_template_no_http_with/src/main.cpp":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/src/main.cpp",
+  "samples/easy/6_pg_service_template_no_http_with/testsuite/conftest.py":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/testsuite/conftest.py",
+  "samples/easy/6_pg_service_template_no_http_with/testsuite/test_basic.py":"taxi/uservices/userver/samples/easy/6_pg_service_template_no_http_with/testsuite/test_basic.py",
+  "samples/easy/CMakeLists.txt":"taxi/uservices/userver/samples/easy/CMakeLists.txt",
   "samples/embedded_files/CMakeLists.txt":"taxi/uservices/userver/samples/embedded_files/CMakeLists.txt",
   "samples/embedded_files/main.cpp":"taxi/uservices/userver/samples/embedded_files/main.cpp",
   "samples/embedded_files/src/hello_handler.cpp":"taxi/uservices/userver/samples/embedded_files/src/hello_handler.cpp",

CMakeLists.txt

@@ -345,20 +345,37 @@ _userver_export_targets()
 _userver_make_install_config()
 
 if(USERVER_BUILD_SAMPLES AND USERVER_FEATURE_CORE)
-    add_subdirectory(samples)
+    if(USERVER_BUILD_TESTS)
+        add_subdirectory(samples)
+    endif()
+
+    # Install the whole samples tree, but drop the master samples/CMakeLists.txt: it writes
+    # a fake userverConfig.cmake stub and would shadow the real installed userver. The leaf
+    # samples' own CMakeLists.txt files live in subdirectories and are kept, so the anchored
+    # "samples/CMakeLists.txt" pattern only matches the top-level file.
+    _userver_directory_install(
+        COMPONENT examples
+        DIRECTORY "${USERVER_ROOT_DIR}/samples"
+        DESTINATION share/userver
+        EXCLUDE_PATTERNS "samples/CMakeLists.txt"
+    )
+    # NON_FINDABLE: the 'examples' install/CPack component only ships sample sources.
+    _userver_install_component(COMPONENT examples NON_FINDABLE)
+    # libuserver-samples, not libuserver-samples-dev
+    set(CPACK_DEBIAN_SAMPLES_PACKAGE_NAME libuserver-examples)
 endif()
 
 if(USERVER_FEATURE_CORE)
     _userver_directory_install(
         COMPONENT core
         PROGRAMS "${USERVER_ROOT_DIR}/scripts/userver-create-service.py"
-        DESTINATION ${CMAKE_INSTALL_BINDIR}/
+        DESTINATION ${CMAKE_INSTALL_BINDIR}
         RENAME userver-create-service
     )
     _userver_directory_install(
         COMPONENT core
         DIRECTORY "${USERVER_ROOT_DIR}/service_template"
-        DESTINATION ${CMAKE_INSTALL_DATADIR}/userver/
+        DESTINATION ${CMAKE_INSTALL_DATADIR}/userver
     )
 endif()
 

libraries/easy/CMakeLists.txt

@@ -7,24 +7,3 @@ userver_module(
     UTEST_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/*_test.cpp"
     COMPONENT_DEPENDS core
 )
-
-if(USERVER_BUILD_SAMPLES)
-    # Imitate an installed userver for the leaf find_package(userver) calls.
-    file(WRITE "${CMAKE_BINARY_DIR}/package_stubs/userverConfig.cmake" "")
-
-    add_subdirectory(samples)
-
-    # Install the easy samples as a standalone project under
-    # share/userver/samples/easy (a dedicated subdirectory so they do not clutter
-    # the root userver samples). The trailing slash installs the directory
-    # contents, including samples/CMakeLists.txt which becomes the project root.
-    _userver_directory_install(
-        COMPONENT examples
-        DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/samples/"
-        DESTINATION "${CMAKE_INSTALL_DATADIR}/userver/samples/easy"
-    )
-
-    # Clean up the fake userver installation above to avoid messing with
-    # find_package(userver) in the parent project.
-    file(REMOVE "${CMAKE_BINARY_DIR}/package_stubs/userverConfig.cmake")
-endif()

libraries/easy/include/userver/easy.hpp

@@ -94,7 +94,7 @@ std::string FormatToJsonString(const T& value) {
 ///
 /// This component can be registered in the component list and used by any client. For example:
 ///
-/// @snippet libraries/easy/samples/6_pg_service_template_no_http_with/src/main.cpp  main
+/// @snippet samples/easy/6_pg_service_template_no_http_with/src/main.cpp  main
 template <class Dependencies>
 class DependenciesComponent : public impl::DependenciesBase {
 public:

samples/CMakeLists.txt

@@ -172,20 +172,10 @@ if(USERVER_FEATURE_S3API)
     add_dependencies(${PROJECT_NAME} ${PROJECT_NAME}-s3api)
 endif()
 
-# Install the whole samples tree, but drop this master CMakeLists.txt: it writes a
-# fake userverConfig.cmake stub (above) and would shadow the real installed userver.
-# The leaf samples' own CMakeLists.txt files live in subdirectories and are kept, so
-# the anchored "samples/CMakeLists.txt" pattern only matches this top-level file.
-_userver_directory_install(
-    COMPONENT examples
-    DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-    DESTINATION share/userver
-    EXCLUDE_PATTERNS "samples/CMakeLists.txt"
-)
-# NON_FINDABLE: the 'examples' install/CPack component only ships sample sources.
-_userver_install_component(COMPONENT examples NON_FINDABLE)
-# libuserver-samples, not libuserver-samples-dev
-set(CPACK_DEBIAN_SAMPLES_PACKAGE_NAME libuserver-examples)
+if(USERVER_FEATURE_EASY)
+    add_subdirectory(easy)
+    add_dependencies(${PROJECT_NAME} userver-easy-samples)
+endif()
 
 # Clean up fake userver installation above to avoid messing with find_package(userver) in the parent project.
 file(REMOVE "${CMAKE_BINARY_DIR}/package_stubs/userverConfig.cmake")