rock: override built-in metrics

The ability to override built-in modules was introduced with [1].
After [2], metrics will be embedded to core Tarantool. The ability to
override them with installed rock will make it possible to use old
Tarantool with new metrics. cartridge role, which was embedded to
tarantool/cartridge in [3], is also would be override.

1. tarantool/tarantool#7774
2. tarantool/tarantool#7725
3. tarantool/cartridge#2047

Closes tarantool/tarantool#7727

Author: DifferentialOrange

.github/workflows/packaging.yml

@@ -21,9 +21,7 @@ jobs:
         with:
           module-name: 'metrics'
           version-pre-extraction-hook: |
-            local rock_utils = require('test.rock_utils')
-            rock_utils.remove_builtin('metrics')
-            rock_utils.assert_nonbuiltin('metrics')
+            require('test.rock_utils').assert_nonbuiltin('metrics')
 
   package:
     # Skip pull request jobs when the source branch is in the same

.github/workflows/push_rockspec.yml

@@ -24,9 +24,7 @@ jobs:
         with:
           module-name: 'metrics'
           version-pre-extraction-hook: |
-            local rock_utils = require('test.rock_utils')
-            rock_utils.remove_builtin('metrics')
-            rock_utils.assert_nonbuiltin('metrics')
+            require('test.rock_utils').assert_nonbuiltin('metrics')
 
   push-scm-rockspec:
     runs-on: [ ubuntu-20.04 ]

.gitignore

@@ -17,3 +17,4 @@ doc/locale/en/
 *.lua.c
 
 build.luarocks
+packpack

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - simultaneous `include` and `exclude` arguments
     (`exclude` has higher priority)
 - Build rock with cmake
+- Override built-in metrics, if installed
 
 ### Deprecated
 - Passing nonexistent metrics to `enable_default_metrics()`

CMakeLists.txt

@@ -18,3 +18,13 @@ install(
   DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/cartridge
   DESTINATION ${TARANTOOL_INSTALL_LUADIR}
 )
+
+install(
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_NAME}
+  DESTINATION ${TARANTOOL_INSTALL_LUADIR}/override
+)
+
+install(
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/cartridge
+  DESTINATION ${TARANTOOL_INSTALL_LUADIR}/override
+)

rpm/tarantool-metrics.spec

@@ -23,10 +23,14 @@ Easy collecting, storing and manipulating metrics timeseriess.
 mkdir -p %{br_luapkgdir}
 cp -rv metrics %{br_luapkgdir}
 cp -rv cartridge %{br_luapkgdir}
+mkdir %{br_luapkgdir}/override
+cp -rv metrics %{br_luapkgdir}/override
+cp -rv cartridge %{br_luapkgdir}/override
 
 %files
      %{luapkgdir}/metrics
      %{luapkgdir}/cartridge
+     %{luapkgdir}/override
 
 %doc README.md
 %doc doc/monitoring/getting_started.rst

test/helper.lua

@@ -1,9 +1,7 @@
 require('strict').on()
 
--- Clean up built-in metrics to run tests with repository module.
-local rock_utils = require('test.rock_utils')
-rock_utils.remove_builtin('metrics')
-rock_utils.assert_nonbuiltin('metrics')
+-- Override should be preferred over built-in.
+require('test.rock_utils').assert_nonbuiltin('metrics')
 
 
 local fio = require('fio')