Repository navigation
Relocate schema into includes/database.php - #112
Merged
Merged
Conversation
- Move mikrotik_setup_table() verbatim into includes/database.php and load it once via a top-level require_once in setup.php. - Allowlist the install/upgrade-only includes/database.php in the patch-coverage gate. Keeps the raw CREATE TABLE definitions as-is (lighter relocation); the vendored RouterOS/ library is left untouched.
TheWitness
requested review from
bmfmancini,
browniebraun,
cigamit and
xmacan
and
a balanced review from Copilot
September 30, 2026 12:46
xmacan
previously approved these changes
Sep 30, 2026
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The schema implementation violates repository provisioning conventions and the broad coverage exemption hides future schema changes.
Review effort: Balanced
Findings: 1
Open (3)
What changed in this PR
Relocates MikroTik schema provisioning into a dedicated include while preserving install and upgrade wiring.
Changes:
- Moves schema creation into
includes/database.php. - Loads the schema module from
setup.php. - Allowlists the schema file in patch coverage.
| File | Description |
|---|---|
includes/database.php |
Contains relocated schema provisioning. |
setup.php |
Loads the new schema module. |
tests/bin/patch-coverage.php |
Exempts the schema module from coverage. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…r; fix PHPDoc - Convert all 14 table definitions from raw CREATE TABLE to api_plugin_db_table_create() so tables register in plugin_db_changes (verified SQL-equivalent to the originals for every table). - ON UPDATE CURRENT_TIMESTAMP columns restored via idempotent ALTER, since api_plugin_db_table_create() cannot express ON UPDATE. - Add the complete standard GPL header (warranty + Cacti Group attribution). - Reshape the function PHPDoc: one-line summary, @return last.
phpunit.xml ships in the repo for CI but is a dev-only test artifact, so it is removed from manifest.json 'expected', pruned from installs on upgrade (like tests/), and excluded from the manifest drift check. The retired markdown-lint configs (.mdlrc, .md_style.rb) are deleted, and .md* is now ignored like .git*: protected from pruning and excluded from drift if it reappears.
The upgrade-time prune now rejects any tombstone containing '.'/'..' segments (which could escape the plugin directory or resolve to its root) and treats ancestors of whitelist entries as protected, so a tombstone on a parent directory can no longer delete a whitelisted file beneath it.
The trailing '# ...' comments in the Project Structure block drifted further right down the tree; align them all to a single column.
- Use the full license header (from the plugin's own setup.php) in tests/Unit/PruneFilesTest.php instead of the abbreviated copyright banner. - Document that the manifest drift check and the upgrade-time prune also handle phpunit.xml and .md* files, matching the implemented behavior.
The repository naming contract reserves the plugin_<name>_ prefix for plugin lifecycle / hook-registration functions; all other functions use the plain <name>_ prefix. Rename the internal upgrade helpers accordingly: plugin_<name>_prune_files() -> <name>_prune_files() plugin_<name>_rmtree() -> <name>_rmtree() The call site, unit tests, and the copilot-instructions.md references are updated to match. No behavioral change.
Align the compat metadata (and the contributor-guide references) with the team decision to standardize the minimum supported Cacti version at 1.2.29; the previously proposed 1.2.32 floor was not adopted.
cigamit
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Relocate schema into includes/database.php and add the fleet file manifest
Aligns
plugin_mikrotikwith the fleet schema/includes convention and adds the fleet-widemanifest.json+ upgrade-time file-pruning mechanism.mikrotik_setup_table()moved intoincludes/database.php, loaded via a top-levelrequire_onceinsetup.php(behavior unchanged).manifest.jsonwithtombstones(empty — this relocation moved a function, not files),expected(top-level files/directories shipping today, directories with a trailing/), andwhitelist(empty).mikrotik_prune_files()(insetup.php, called from the version-change block ofmikrotik_check_upgrade()) removes the dev-onlytests/tree on upgrade, refuses any path that resolves outside the plugin directory (a tamperedmanifest.json), warns on any file/directory it cannot remove, leaveswhitelist/.git*alone, and logs — without removing — any top-level entry the manifest does not account for.tests/bin/validate-manifest.php(wired intoplugin-ci-workflow.yml) fails on drift betweenexpectedand the real top-level tree.PruneFilesTest(tombstone/file/dir removal, path-escape refusal, permission warnings, whitelist/.gitprotection, missing/malformed no-ops) and a focusedMikrotikUpgradeTestthat drivesmikrotik_check_upgrade()'s version-drift path (sandboxingbase_pathso the prune runs against a temp tree); made the test bootstrap'sget_current_page()stub overridable to enable it.Validation
Full Pest suite green (80 passed) and patch-coverage passes at 100% (66/66 changed lines); manifest drift-check passes and the translation template is up to date.
Revision: hardening & fleet cleanup
Since the initial description, this PR also:
phpunit.xmlon upgrade (alongside the dev-onlytests/tree) and leaves.md*lint configs in place — the drift check now ignorestests/,phpunit.xml,.git*,.md*, and whitelisted paths../..traversal segment or resolves outside the plugin directory (including via a symlinked directory), and protects a directory when a whitelisted entry lives beneath it — each with added unit coverage.mikrotik_prune_files()/mikrotik_rmtree()(theplugin_mikrotik_prefix is reserved for lifecycle/hook-registration functions).tests/Unit/PruneFilesTest.phpthe full standard GPL v2 header and aligns the Project Structure block in.github/copilot-instructions.md.