Move definitions in to resources/definitions (librenms#17341)

* Move definitions in to resources/definitions
OS detection : resources/definitions/os_detection
OS discovery : resources/definitions/os_discovery
More consistent location that should be future-proof.
Better folder names (feedback on names welcomed)
Move schema definitions into resources/definitions/schema
this will break users with local os definitions we could help them out and add some code to move those files to the new location in daily update.  Thoughts?

* Fix more broken paths

* move local os definitions

* Move misc definitions

* style fixes

* Migration handle missing directories

* Move os yaml files

* I guess I'm moving db_schema.yaml too :)

* Apply fixes from StyleCI

* Exclude os_defs from resources

* Schema files were supposed to be in resources/definitions/schema

---------

Co-authored-by: StyleCI Bot <[email protected]>

Author: murrant

LibreNMS/DB/Schema.php

@@ -106,7 +106,7 @@ public function getPrimaryKey($table)
     public function getSchema()
     {
         if (! isset($this->schema)) {
-            $file = Config::get('install_dir') . '/misc/db_schema.yaml';
+            $file = resource_path('definitions/schema/db_schema.yaml');
             $this->schema = Yaml::parse(file_get_contents($file));
         }
 

LibreNMS/OS.php

@@ -374,7 +374,7 @@ public function discoverStorage(): Collection
     public function getDiscovery($module = null)
     {
         if (! array_key_exists('dynamic_discovery', $this->device)) {
-            $file = base_path('/includes/definitions/discovery/' . $this->getName() . '.yaml');
+            $file = resource_path('definitions/os_discovery/' . $this->getName() . '.yaml');
             if (file_exists($file)) {
                 $this->device['dynamic_discovery'] = \Symfony\Component\Yaml\Yaml::parse(file_get_contents($file));
             }

LibreNMS/Util/FileCategorizer.php

@@ -65,7 +65,7 @@ public function __construct($items = [])
             return Str::endsWith($item, '.svg') ? $item : false;
         });
         $this->addCategory('resources', function ($item) {
-            return Str::startsWith($item, 'resources/') ? $item : false;
+            return (str_starts_with($item, 'resources/') && ! str_starts_with($item, 'resources/definitions/os_')) ? $item : false;
         });
         $this->addCategory('full-checks', function ($item) {
             return in_array($item, ['composer.lock', '.github/workflows/test.yml']) ? $item : false;
@@ -100,7 +100,7 @@ public function categorize()
 
     private function validateOs($os)
     {
-        return file_exists("includes/definitions/$os.yaml") ? $os : null;
+        return file_exists("resources/definitions/os_detection/$os.yaml") ? $os : null;
     }
 
     private function osFromMibs(): void
@@ -125,7 +125,7 @@ private function osFromMibs(): void
                 '--files-with-matches',
                 '--file=-',
                 '--',
-                'includes/definitions/',
+                'resources/definitions/os_',
                 'includes/discovery/',
                 'includes/polling/',
                 'LibreNMS/OS/',
@@ -146,7 +146,7 @@ private function osFromMibs(): void
 
     private function osFromFile($file)
     {
-        if (Str::startsWith($file, 'includes/definitions/')) {
+        if (Str::startsWith($file, 'resources/definitions/os_')) {
             return basename($file, '.yaml');
         } elseif (Str::startsWith($file, ['includes/polling', 'includes/discovery'])) {
             return $this->validateOs(basename($file, '.inc.php'));

LibreNMS/Util/ModuleTestHelper.php

@@ -298,7 +298,7 @@ public static function extractVariant($os_file)
 
         if (! Str::contains($full_name, '_')) {
             return [$full_name, ''];
-        } elseif (is_file(Config::get('install_dir') . "/includes/definitions/$full_name.yaml")) {
+        } elseif (is_file(resource_path("definitions/os_detection/$full_name.yaml"))) {
             return [$full_name, ''];
         } else {
             [$rvar, $ros] = explode('_', strrev($full_name), 2);

LibreNMS/Validations/Database/CheckSchemaStructure.php

@@ -28,7 +28,6 @@
 
 use Illuminate\Database\QueryException;
 use Illuminate\Support\Facades\DB;
-use LibreNMS\Config;
 use LibreNMS\DB\Eloquent;
 use LibreNMS\DB\Schema;
 use LibreNMS\Interfaces\Validation;
@@ -47,7 +46,7 @@ class CheckSchemaStructure implements Validation, ValidationFixer
 
     public function __construct()
     {
-        $this->schema_file = Config::get('install_dir') . '/misc/db_schema.yaml';
+        $this->schema_file = resource_path('definitions/schema/db_schema.yaml');
     }
 
     /**

app/ConfigRepository.php

@@ -75,7 +75,7 @@ public function __construct()
      */
     public function getDefinitions(): array
     {
-        return json_decode(file_get_contents($this->get('install_dir') . '/misc/config_definitions.json'), true)['config'];
+        return json_decode(file_get_contents($this->get('install_dir') . '/resources/definitions/config_definitions.json'), true)['config'];
     }
 
     /**
@@ -382,7 +382,7 @@ private function loadPreUserConfigDefaults(): void
         }
 
         // load macros from json
-        $macros = json_decode(file_get_contents($this->get('install_dir') . '/misc/macros.json'), true);
+        $macros = json_decode(file_get_contents($this->get('install_dir') . '/resources/definitions/macros.json'), true);
         Arr::set($this->config, 'alert.macros.rule', $macros);
 
         Arr::set($this->config, 'log_dir', $this->get('install_dir') . '/logs');
@@ -583,7 +583,7 @@ public function populateLegacyDbCredentials(): void
      */
     private function loadAllOsDefinitions(): void
     {
-        $os_list = glob($this->get('install_dir') . '/includes/definitions/*.yaml');
+        $os_list = glob($this->get('install_dir') . '/resources/definitions/os_detection/*.yaml');
 
         foreach ($os_list as $yaml_file) {
             $os = basename($yaml_file, '.yaml');

app/Console/Commands/SchemaDumpCommand.php

@@ -57,7 +57,7 @@ public function handle(ConnectionResolverInterface $connections, Dispatcher $dis
 
         \Artisan::call('migrate', $parameters, $stdout);
 
-        $file = $this->option('path') ?: base_path('/misc/db_schema.yaml');
+        $file = $this->option('path') ?: resource_path('definitions/schema/db_schema.yaml');
         $yaml = Yaml::dump(Schema::dump($database), 3, 2);
 
         if (file_put_contents($file, $yaml)) {

app/Console/Commands/SetConfigCommand.php

@@ -229,7 +229,7 @@ private function validateOsSetting(string $os, string $setting, $value)
         $validator = new Validator;
         $validator->validate(
             $os_data,
-            (object) ['$ref' => 'file://' . base_path('/misc/os_schema.json')],
+            (object) ['$ref' => 'file://' . resource_path('definitions/schema/os_schema.json')],
             Constraint::CHECK_MODE_TYPE_CAST
         );
 

composer.lock

@@ -1,6 +1,6 @@
 <?php
 
-## Have a look in misc/config_definitions.json for examples of settings you can set here. DO NOT EDIT misc/config_definitions.json!
+## Have a look in resources/definitions/config_definitions.json for examples of settings you can set here. DO NOT EDIT config_definitions.json!
 
 // This is the user LibreNMS will run as
 //Please ensure this user is created and has the correct permissions to your install