Probleme beim Rendern einer Zweigvorlage bei einem Phpunit-Test

Nov 04 2020

Ich arbeite derzeit an einem Projekt, das zum ersten Mal "Zweig" verwendet. Ich entschuldige mich, wenn dies nicht sehr klar ist.

Ich habe eine benutzerdefinierte Funktion entwickelt, die SVG-Symbole in die Zweigvorlagen einbettet, aber für dieses spezielle Projekt werde ich mehr für die Abdeckung und das Testen von Einheiten als für alles andere bewertet. Aus diesem Grund versuche ich, mit phpunit zu testen, ob meine Funktion wie beabsichtigt funktioniert.

Dazu muss ich meiner Meinung nach eine Instanz der benutzerdefinierten Funktion in der Testdatei rendern und sie dann mit der SVG-Rohdatei in meinem Verzeichnis vergleichen. Ich habe jedoch Probleme mit der Rendermethode. Ich glaube, weil ich im Test keine Zweigumgebung zur Verfügung habe.

Ich habe hier nach etwas Ähnlichem gesucht und diese vorherige Frage gefunden: "https://stackoverflow.com/questions/17026405/twig-template-unit-testing?rq=1". In der Antwort auf diese Frage wird Folgendes empfohlen:

$twig = self::$kernel->getContainer()->get('twig');
    $html = $twig->render('AppBundle::app/something.html.twig', ['content' => 'I am some variable value']);
    self::assertEquals($html, $response->getContent());

aber wenn ich das starte bekomme ich folgenden Fehler:

Error: Access to undeclared static property: App\Tests\Templates\Icons\IconsExtensionTest::$kernel

Wie kann ich auf den Kernel zugreifen?

Hier ist meine derzeit nicht funktionierende Testdatei:

<?php

// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This file test the Macro that Embeds SVG icons.
 *
 * @package   Tests
 *
 * @author    Ângelo D. Moura <[email protected]>
 * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

namespace App\Tests\Templates\Icons;

use App\Twig\IconsExtension;
use App\Kernel;
use DirectoryIterator;
use PHPUnit\Framework\TestCase;

class IconsExtensionTest extends TestCase
{
    public function testIconsExtension()
    {

        //Get all Icon files names from "public/assets/icons"
        $icon_file_names = [];
        foreach (new DirectoryIterator('public/assets/icons/') as $file) { if ($file->isDot()) {
                continue;
            }
            $icon_file_names[] = $file->getFilename();
        }

        //Check if every icon file as a ".svg.twig" extension
        foreach ($icon_file_names as $icon_file_name) {
            static::assertRegExp('#([a-zA-Z0-9\s_\\.\-\(\):])+(.svg.twig)$#', $icon_file_name);
        }



        //Check if the function gives a valid HTML with a class attribute equal to the one passed
        $twig = self::$kernel->getContainer()->get('twig');

        /*
        $icon_template_render = $twig->render('public/icons/logo.svg', ['iconClass' => 'icon icon-logo']);

        $iconsExtension= new IconsExtension(); $iconsExtension_render = $iconsExtension->embedSvgIcon($twig, 'logo', 'logo');

        self::assertEquals($icon_template_render, $iconsExtension_render);

        // Next I need to verify that the $iconsExtension_render is a valid html code (maybe through regex)

        */
    }
}

Hier ist meine benutzerdefinierte Funktion (falls erforderlich):

<?php

// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
// }}}

/**
 * GNU social Twig extensions
 *
 * @package   GNUsocial
 * @category  Twig
 *
 * @author    Ângelo D. Moura <[email protected]>
 * @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

namespace App\Twig;

use Twig\Environment;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

class IconsExtension extends AbstractExtension
{
    public function getFunctions()
    {
        return [
            new TwigFunction('icon',
                [$this, 'embedSvgIcon'],
                ['needs_environment' => true]
            ),
        ];
    }

    /**
     * Renders the Svg Icon template and returns it.
     *
     * @param Environment $twig * @param string $icon_name
     * @param string      $icon_css_class * * @return string * * @author Ângelo D. Moura <[email protected]> */ public function embedSvgIcon(Environment $twig, string $icon_name = '', string $icon_css_class = '')
    {
        try {
            return $twig->render('@public_path/assets/icons/' . $icon_name . '.svg.twig', ['iconClass' => $icon_css_class]); } catch (LoaderError $e) {
            //return an empty string (a missing icon is not that important of an error)
            return '';
        } catch (RuntimeError $e) { //return an empty string (a missing icon is not that important of an error) return ''; } catch (SyntaxError $e) {
            //return an empty string (a missing icon is not that important of an error)
            return '';
        }
    }
}

Antworten

Jakumi Nov 04 2020 at 14:17

TestCase(phpunit Klasse, die Ihr Test erweitert) ist unzureichend. Möglicherweise haben Sie übersehen, dass symfony eine Erweiterung namens KernelTestCasebietet, die einen Kernel bereitstellt, von dem Sie die Zweigumgebung abrufen können (oder WebTestCaseder auch einen Client bereitstellt, mit dem Sie auf Ihrer Website navigieren können).

Also statt

use PHPUnit\Framework\TestCase;

class IconsExtensionTest extends TestCase

du kannst tun

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;

class IconsExtensionTest extends KernelTestCase

Möglicherweise müssen Sie static::bootKernel();Ihre setUp-Methode oder den Test selbst aufrufen, um den Kernel und den Container zu initialisieren.

dann sollte alles wie vorgesehen funktionieren