GitHub Continuous Integration und CodeCoverage mit Travis CI

Für mein öffentliches GitHub Projekt Entity to Rest Bundle für Symfony, habe ich Travis CI, ein Service einer Frima aus Berlin/Friedrichshain, für Continuous Integration benutzt und bin vollbegeistert. Ich musste nur eine .travis.yml erstellen und mich mit meinem Github Account kostenlos anmelden und mit wenigen Handgriffen kann ich jetzt mittels Travis CI:

  • Testen von unterschiedlichen PHP-Versionen
  • Testen von unterschiedlichen Symfony Versionen
  • Markup auf GitHub über den Stand der Tests: Build:success/failed
  • automatische E-Mail Benachrichtigung über das Ergebnis nach jedem Pull-Request

Jetzt erscheint eine schicke Grafik und informiert über den aktuellen Build Status:

travis_github_ci

Das Ergebnis des Builds kann man sich anschauen auf der travis ci Webseite.

Hinweis: Für öffentliche GitHub Repositories ist der Service kostenlos, für private Repositories muss man bezahlen.

Um die CodeCoverage auch anzeigen und berechnen zu können, kann man sich kostenlos bei einem der beiden Anbieter anmelden und muss nur die CodeCoverage Generierung in seiner .travis.yml triggern.

https://codecov.io  Beispiel Projekt

https://coveralls.io Beispiel Projekt

Symfony Entity to REST API Bundle released

Bei meinem jetztigen Projekt programmiere ich gerade mit Symfony 3 eine REST API und habe aus verschiedenen Bundlen eine REST Suite erstellt für Symfony 3 erstellt, welche folgende  Komponenten enthält:

  • Api Dokumentation inkl Sandbox Tests – auch ohne Programmierkenntnisse kann der Code abgenommen werden und ausprobiert werden
  • die Dokumentation wird automatisch generiert aus den Eigenschaften der Entitäten, es ist kein zusätzlicher Aufwand notwendig
  • die Validierung der Parameter wird automatisch anhand der Entitäten durchgeführt, es ist kein zusätzlicher Aufwand notwendig
  • eine Suche ist automatisch enthalten, die Relationen von Entitäten sind auch durchsuchbar
  • CRUD Funktionalität: GET, CREATE, UPDATE, DELETE einer Entität ist schon implementiert und kann erweitert werden
  • einfaches Testing: Integration Tests sind schnell erstellbar / Vorlagen liegen bereit
  • ein Demo REST Service Projekt mit Demo Code ist bereit
  • ausführliche Dokumentation
  • einfache Installation über composer: composer require sebvie/rest-suite-bundle

Bei Interesse kann ich gern das Bundle in ihrem Projekt integrieren oder einarbeiten: Kontakt.

 

 

Symfony static laden von Fixtures beim Laden eines Integration Tests in PHPUnit

Mit der statischen Funktion setUpBeforeClass() von PHPunit kann man einmalig vor dem durchführen der Tests  in einer Klasse Fixtures laden und die Datenbank zurücksetzen:

class MyTestCase extends WebTestCase
{
    use FixtureLoadTrait;
 /**
 * @return void
 */
 public static function setUpBeforeClass()
 {

     $fixtures = [
         new TriggerConditionFixture()
     ];
     self::rebuildDataBase($fixtures);
 }

Die Fixtures lassen sich bequem mit dem Trait laden und die Datenbank wird geleert:

<?php

namespace Tests\Integration;

use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
use Doctrine\Common\DataFixtures\Purger\ORMPurger;
use Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader;
use Tests\Fixture\BackendBundle\DataFixtures\ORM\LoginFixture;

trait FixtureLoadTrait
{

    /**
     * @param array $fixtures
     *
     * @return void
     */
    protected static function rebuildDataBase(array $fixtures)
    {
        self::bootKernel();
        $fixtureLoader = new ContainerAwareLoader(
            self::$kernel->getContainer()
        );
        foreach($fixtures as $fixture){
            $fixtureLoader->addFixture($fixture);
        }
        $fixtureLoader->addFixture(new LoginFixture());
        self::getFixtureExecutor()->execute($fixtureLoader->getFixtures());
    }

    /**
     * @return ORMExecutor
     */
    protected static function getFixtureExecutor()
    {
        /** @var \Doctrine\ORM\EntityManager $entityManager */
        $entityManager = self::$kernel->getContainer()
            ->get('doctrine')
            ->getManager();

        return new ORMExecutor(
            $entityManager,
            new ORMPurger($entityManager, ['user'])
        );
    }

    /**
     * @return ContainerAwareLoader
     */
    protected static function getFixtureLoader()
    {
        return new ContainerAwareLoader(
            self::$kernel->getContainer()
        );
    }
}

Symfony 3 Test-Datenbank einrichten für Integration Tests

In Symofny wird automatisch beim Ausführen von Tests die  app/config/parameters_test.yml geladen.
Dort sollte dann eine andere Datenbank angegeben werden, der Einfachheit halber mit demselben Datenbank User:

database_host: same_as_dev
database_port: same_as_dev
database_name: test_db
database_user: same_as_dev
database_password: same_as_dev

Dann müssen auf der Konsole folgende Befehle ausgeführt werden:
Cache leeren:
php bin/console cache:clear –env=test

Datenbank erstellen
php bin/console doctrine:database:create –env=test

Tabellen erstellen
hp bin/console doctrine:schema:update –env=test –force

Dann könnne Fixtures geladen werden und Integration Tests geschrieben werden.

 

Bundle Konfiguration innerhalb des Bundles laden

Damit die Bundle unabhängig voneinander funktioneiren und man Abhängigkeiten vermeidet, sollte ein Bundle sein eigenen Konfigurationen beinhalten

z.B. : src/MyBundle/Resources/config/config.yml

aber auch selber laden.

Das Laden der Konfiguration ist über den DependencyInjection Container möglich.

Beispiel:

Die folgende config soll geladen werden. Sie enthält eigene Bundle-Parametern und benutzen Extension Parametern:

my_bundle:   #Naming Convention!
  modules:

extension_x:
  param: "foo.html.twig"

Es müssen 2 Dateien angelegt werden:

src/MyBundle/DependencyInjection/MyExtension.php: weiterlesen…

Syfmony 3.3. – Wie man ein Repository als Service injeziert mittels Dependency Injection

In Symfony 3 wird standardmäßig immer der EntityManager injected, um dann darüber das entsprechende Repository zur Verfügung zu bekommen.

Meistens wird aber nur genau ein Repository benötigt und der Code und die Tests werden aufgebläht.

Es gibt eine einfach Möglichkeit in der Configuration einen Service von einem Respository zu erstellen:

service.repository.name:
 class: 'AppBundle\Repository\MyEntity'
 factory: 'Doctrine\ORM\EntityManagerInterface:getRepository'
 arguments: ['AppBundle\Entity\MyEntity']

Testable PHP CSV Streamreader Class inklusive Shunks

class CsvReader implements ReaderInterface
{

    /**
     * shunk size for file import
     */
    private $shunkSize;

    /**
     * @param int $shunkSize
     */
    public function __construct(int $shunkSize)
    {
        $this->shunkSize = $shunkSize;
    }

    /**
     * @param string $file
     * @param callable $callback
     *
     * @return array
     * @throws StorageException
     */
    public function shunkCsvFile(string $file, callable $callback): array
    {
        $file = $this->getFileObject($file);
        $file->setFlags(
            SplFileObject::READ_CSV |
            SplFileObject::SKIP_EMPTY |
            SplFileObject::READ_AHEAD
        );

        $row = 0;
        $data = [];
        if ($file->isFile()) {
            while (!$file->eof()) {
                $line = $file->fgetcsv(';');
                $row++;
                if ($row === 1) {
                    //skip header
                    continue;
                }

                $data[] = $line;

                if (($row % $this->shunkSize) == 0) {
                    $callback($data);
                    $data = [];
                }
            }
        }

        $callback($data);
            
    }

    /**
     * @param string $file
     *
     * @return SplFileObject
     *
     * @codeCoverageIgnore
     */
    protected function getFileObject(string $file): SplFileObject
    {
        return new SplFileObject($file);
    }

Symfony 3 Entity Pfad innerhalb des Bundles ändern

Wenn man den Pfad für die Entitäten in Symfony 2 und 3 ändern will, der standardmäßig in @Bundle/Entity liegt, muss man nur das Mapping in der Konfiguration  anpassen.

Beispiel, das neue Mapping befindet sich im Ordner: @Bundle/Folder/Entity

doctrine:
   orm:
      mappings:
         Bundle: 
            type: annotation 
            is_bundle: true 
            dir: 'Folder/Entity' 
            prefix: Bundle\Folder\Entity

Projekt: baby-taschenrechner.de

Das gerade fertiggestellt Projekt baby-taschenrechner.de beschäftigt sich mit den Fragestellungen rund um die Entwicklung des eigenen Kindes:

  • Wie groß wird mein Kind werden in x-Jahren
  • Wie schwer wird mein Kind in x-Jahren
  • Ist mein Kind zu schwer/zu dünn
  • Welche Kleidergröße wird es wann tragen?

Die Webseite soll Eltern dabei helfen herauszufinden, wann sie welche Kleidergröße kaufen müssen, um im nahenden Winter/Sommer das passende zu Hause zu haben.

Eltern können so einschätzne, ob das Kind zu dünn oder zu dick ist  für ihr Alter/Größe/Gewicht-Verhältnis.

Für die Realiserung wurden folgende Technologien verwendet:

Symfony 3, Docker, MySQL, PHP, GIT, Google Material Design, Amazon AWS

Amazon automatische Preisanpassung Tool

Für einen Kunden habe ich gerade ein Tool entwickelt, mit dem man die Preise der eigenen Waren bei Amazon automatisch anpassen kann.Dabei werden die Angote der Konkurrenz analysiert nach Zustand der Ware und nach Seller Seriösität und dadurch ein fairer Preis bestimmt für die Ware. Es werden alle Daten, die über die API verfügbar sind für die Preisbestimmung mit herangezogen, wie z.B. Seller Feedback (Bewertungen des Händlers), ob Amazon selber verschickt, Versanddauer und vieles mehr.

Das Tool vergleicht optional die Preise zwischen den verschiedenen Amazon Plattformen in Europa (DE, UK, IT, ES, FR) aber auch Plattformen außerhalb Europas, wie Japan oder Amerika und händelt die unterschiedlichen Währungen.

Das Ergebnis kann direkt zu Amazon mittels der API geschickt werden und die Preise werden sofort geupdatet.

Amazon Preisanpassung

Screenshot Preisanpassungs Tool

 

Die Anwendung ist in PHP mit Symfony 3 geschrieben und hat ein Frontend mit Twitter Bootstrap 3 und eine MySQL Datenbank. Außerdem gibt es eine Vagrant Umgebung für die Entwicklung mit PHP7.1 und nginx. Ausgeführt werden kann das ganze mit einer einfachen Xampp Umgebung oder Vagrant Virtual Box beim Kunden lokal auf einem PC.

Falls sie auch Interesse an einem solchen Tool haben, könnne sie gern Kontakt aufnehmen.