Test Bundle Laravel Package

Getting Started

Minimal Setup

1. Add to composer.json (for learning/testing only):

   composer require avinsol/test-bundle --dev
   

   Note: Exclude from production via composer.json config.exclude-dev or .gitignore.

2. Enable in config/bundles.php (temporarily):

   return [
       // ...
       Avinsol\TestBundle\AvinsolTestBundle::class => ['dev' => true],
   ];
   

3. First Use Case:

   • Debugging Twig templates: The bundle likely extends Symfony’s Twig integration. Test with:

     {{ dump(_context) }}  {# Dump full template context #}
     

   • Route inspection: Use the symfony/stopwatch integration (from require-dev) to profile routes:

     php bin/console debug:router | grep "test"
     

Implementation Patterns

Common Workflows

1. Twig Debugging:

   • Override twig.configurator in config/packages/twig.yaml to enable strict checks:

     twig:
         debug: true
         strict_variables: true
     

   • Use the bundle’s custom Twig extensions (if any) for learning:

     {{ avinsol_test_extension.some_method() }}
     

2. Dependency Injection Learning:

   • Inspect the bundle’s services via:

     php bin/console debug:container avinsol
     

   • Recreate similar services in your project:

     # config/services.yaml
     services:
         App\Service\TestService:
             arguments:
                 $someParam: '%env(TEST_VAR)%'
     

3. Routing Experiments:

   • Test dynamic routes with the bundle’s TestRouter (if implemented):

     // src/Controller/TestController.php
     use Avinsol\TestBundle\DependencyInjection\TestRouter;
     
     public function testRoute(TestRouter $router) {
         $routes = $router->getRoutes();
         // Log/inspect routes for learning
     }
     

4. Integration with Symfony’s Dev Tools:

   • Leverage the symfony/stopwatch dev dependency to mimic the bundle’s profiling:

     use Symfony\Component\Stopwatch\Stopwatch;
     
     $stopwatch = new Stopwatch();
     $stopwatch->start('test_event');
     // ... code ...
     $event = $stopwatch->stop('test_event');
     

Gotchas and Tips

Pitfalls

1. Security Risks:

   • The bundle is not production-ready. Avoid enabling it in app.php or prod environments.
   • Workaround: Use env('APP_ENV') === 'dev' guards in custom code.

2. Missing Documentation:

   • No public API docs exist. Reverse-engineer usage via:
     • src/Resources/config/services.yaml (service definitions).
     • src/DependencyInjection/ (compiler passes, extensions).
     • src/Twig/ (custom Twig extensions).

3. Dependency Conflicts:

   • The bundle requires Symfony 4.4–5.0. Test in a fresh project first:

     symfony new test-project "5.4.*"
     composer require avinsol/test-bundle --dev
     

4. Twig Auto-Reloading:

   • If Twig templates don’t update, clear cache:

     php bin/console cache:clear
     

Debugging Tips

• Inspect Bundle Structure:

  find vendor/avinsol/test-bundle -type f -name "*.php" | xargs grep -l "class\|function"
  

• Override Bundle Behavior:
  • Create a custom compiler pass to extend the bundle’s logic:

    // src/DependencyInjection/Compiler/TestPass.php
    use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
    use Symfony\Component\DependencyInjection\ContainerBuilder;
    
    class TestPass implements CompilerPassInterface {
        public function process(ContainerBuilder $container) {
            // Modify services added by the bundle
        }
    }
    

  • Register it in src/Kernel.php:

    protected function build(ContainerBuilder $container) {
        $container->addCompilerPass(new TestPass());
    }
    

Extension Points

1. Custom Twig Extensions:

   • If the bundle provides Twig extensions, extend them:

     {% extends 'base.html.twig' %}
     {% block custom_test %}
         {{ parent() }}
         {{ include('avinsol_test/_custom_extension.html.twig') }}
     {% endblock %}
     

2. Event Listeners:

   • Hook into Symfony events the bundle uses (e.g., kernel.request):

     // src/EventListener/TestListener.php
     use Symfony\Component\HttpKernel\Event\RequestEvent;
     use Symfony\Component\HttpKernel\KernelEvents;
     
     class TestListener {
         public function onKernelRequest(RequestEvent $event) {
             if ($event->isMainRequest()) {
                 // Log/inspect request for learning
             }
         }
     }
     

     Register in config/services.yaml:

     services:
         App\EventListener\TestListener:
             tags:
                 - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }
     

3. Configuration Overrides:

   • Override bundle configs in config/packages/avinsol_test.yaml:

     avinsol_test:
         some_setting: "custom_value"