Custom Script Validation feature

[jo-bzh]

Feature Request: Script Validation Command

Problem Statement

When developing custom scripts in NetBox, there are two common issues that are only discovered at runtime:

1. BaseScript Property Override Issues

   • Scripts incorrectly define properties directly on the class instead of in Meta
   • This causes the properties to not work as expected
   • Currently no way to detect this before runtime

2. Script Loading Failures

   • Scripts fail to load due to syntax errors or missing dependencies
   • No clear error messages about why loading failed
   • Issues only discovered when trying to use the script

Current Detection Method

Currently, users need to run code in nbshell to detect these issues:

# Check for property overrides
from extras.models import ScriptModule

for module in ScriptModule.objects.all():
    print(f"\nModule: {module.name}")
    for script in module.ordered_scripts:
        if isinstance(script, tuple):
            print(f"  Problem: {script[0]} returned as tuple instead of Script object")
            print("  This usually means properties are defined outside Meta class")
        else:
            print(f"  OK: {script.name}")

# Check script loading
for module in ScriptModule.objects.all():
    print(f"\nModule: {module.name}")
    try:
        module_obj = module.get_module()
        scripts = module.module_scripts
        if scripts:
            print("Scripts found:")
            for name in scripts:
                print(f"  - {name}")
        else:
            print("No scripts found in module")
    except ImportError as e:
        print(f"Import error: {str(e)}")
        print("Check if all dependencies are installed")
    except SyntaxError as e:
        print(f"Syntax error: {str(e)}")
        print("Check the module file for Python syntax errors")
    except Exception as e:
        print(f"Error: {type(e).__name__}: {str(e)}")

Proposed Solution

Add a validate_scripts management command focused on these two issues:

class Command(BaseCommand):
    help = 'Validate script property overrides and loading'

    def handle(self, *args, **options):
        modules = ScriptModule.objects.all()
        has_errors = False

        for module in modules:
            self.stdout.write(f"\nValidating {module.name}")
            
            # Check script loading
            try:
                module_obj = module.get_module()
                scripts = module.module_scripts
                
                # Check each script for property overrides
                for name, script_class in scripts.items():
                    overridden = []
                    for prop in ['name', 'description']:
                        if prop in script_class.__dict__:
                            overridden.append(prop)
                    
                    if overridden:
                        has_errors = True
                        self.stdout.write(
                            self.style.ERROR(
                                f"  {name}: Properties {overridden} defined outside Meta"
                            )
                        )
                    else:
                        self.stdout.write(
                            self.style.SUCCESS(f"  {name}: Valid")
                        )
                        
            except ImportError as e:
                has_errors = True
                self.stdout.write(
                    self.style.ERROR(f"  Failed to import: {str(e)}")
                )
            except SyntaxError as e:
                has_errors = True
                self.stdout.write(
                    self.style.ERROR(f"  Syntax error: {str(e)}")
                )
            except Exception as e:
                has_errors = True
                self.stdout.write(
                    self.style.ERROR(f"  Error: {type(e).__name__}: {str(e)}")
                )

        if has_errors:
            self.stdout.write(self.style.ERROR("\nValidation failed"))
            exit(1)
        else:
            self.stdout.write(self.style.SUCCESS("\nAll scripts valid"))

This would provide:

• Early detection of common script issues
• Clear error messages
• Can be run before deployment
• Useful for CI/CD pipelines

Example output:

$ python manage.py validate_scripts

Validating backup_scripts
  BackupDevice: Valid
  RestoreConfig: Valid

Validating custom_scripts
  UpdateDevice: Properties ['name', 'description'] defined outside Meta
  CreateVLAN: Valid

Validation failed

Would this be helpful to add to NetBox core?

[jo-bzh]

Example of current analysis return for Script validation

>>> for module in ScriptModule.objects.all():
...     print(f'\nModule: {module.name} (File: {module.file_path})')
...     try:
...         # First try to load the actual module
...         module_obj = module.get_module()
...         print('✅ Module loaded successfully')
...         
...         # Then try to load the scripts
...         scripts = module.module_scripts
...         if scripts:
...             print('Scripts found:')
...             for name, script_class in scripts.items():
...                 print(f'  - {name}')
...         else:
...             print('⚠️  No scripts found in module')
...             
...     except ImportError as e:
...         print(f'❌ Module import error: {str(e)}')
...         print('   This usually means the module file is missing or has incorrect imports')
...     except SyntaxError as e:
...         print(f'❌ Syntax error in module: {str(e)}')
...         print('   Check the module file for Python syntax errors')
...     except AttributeError as e:
...         print(f'❌ Attribute error: {str(e)}')
...         print('   This might mean a script class is missing required attributes')
...     except Exception as e:
...         print(f'❌ Error loading module: {type(e).__name__}: {str(e)}')
... 

Module: esn_ip_reservation.py (File: esn_ip_reservation.py)
✅ Module loaded successfully
Scripts found:
  - AllocateSubnet

Module: esn_ip_reservation2.py (File: esn_ip_reservation2.py)
❌ Error loading module: FileNotFoundError: [Errno 2] No such file or directory: '/opt/netbox/netbox/scripts/esn_ip_reservation2.py'

Module: esn_subnet_reservation.py (File: esn_subnet_reservation.py)
✅ Module loaded successfully
Scripts found:
  - AllocateSubnet

Module: plugin-netbox-contract.py (File: plugin-netbox-contract.py)
❌ Module import error: cannot import name 'AccountingDimension' from 'netbox_contract.models' (/opt/netbox/netbox/netbox-contract/netbox_contract/models.py)
   This usually means the module file is missing or has incorrect imports

Module: remove_disabled_tunnel.py (File: remove_disabled_tunnel.py)
❌ Error loading module: FileNotFoundError: [Errno 2] No such file or directory: '/opt/netbox/netbox/scripts/remove_disabled_tunnel.py'
```

[chris240189]

I want that. I have wasted so much time with trial and error.

[linuxrrze]

I'd also like to see that implemented.
Just spent quite some time to get a plugin script running (and it still only works on CLI not GUI), and it really is a mess.
Just in case you're interested:
peteeckel/netbox-plugin-dns#639