Entités d'accès aux données et tests

Modifiez le modèle des entêtes des fichiers PHP pour y insérer automatiquement le typage strict

1. Sélectionnez le répertoire « src » par un clic gauche
2. Ouvrez la boîte de dialogue de création d'une nouvelle classe en utilisant le menu contextuel accessible par un clic droit sur le répertoire « src »
3. Complétez les champs de saisie « Name » et « Namespace » sans valider :
4. Constatez que le répertoire (champ de saisie « Directory ») est complété automatiquement, de façon cohérente selon l'espace de noms choisi
   Information

   Si le nom du répertoire et de l'espace de nommage ne sont pas automatiquement en accord dans la boîte de dialogue, réinitialisez le cache de PhpStorm par le menu « File » puis « Invalidate Caches…. ». Cochez la première case et validez :

5. Remarquez que la boîte de dialogue comporte des champs de saisie pour choisir classe, interface ou trait, mais aussi la classe parente et les interfaces implémentées
6. Validez votre saisie et ajoutez ce fichier à l'index Git et répondant favorablement à la suggestion de PhpStorm
7. Ajoutez les propriétés privées « id » et « name » avec leur type à la classe « Artist »
8. Utilisez le menu « Code - Generate… » puis choisissez « Getters… »
   Information

   « Generate… » est également accessible dans le menu contextuel au clic droit sur un code source PHP.

   Le raccourci clavier « ALT+Ins. » est utilisé par le gestionnaire de fenêtres XFCE pour créer un nouvel espace de travail. Il ne fonctionne donc pas dans PhpStorm, à moins de supprimer ou redéfinir le raccourci de XFCE.

   Le code généré sera inséré à l'endroit où se situe le curseur texte.

9. Sélectionnez les deux propriétés « id » et « name » en utilisant « CTRL » ou « SHIFT » puis validez

1. Créez une classe « Entity\Collection\ArtistCollection »
2. Écrivez la méthode « findAll() » qui retourne un tableau contenant tous les artistes triés par ordre alphabétique en vous inspirant très fortement du code que vous aviez écrit dans « index.php », en intégrant les modifications suivantes :
   • la récupération des lignes utilisera « fetchAll() de PDOStatement »
   • le mode de récupération des lignes sera « PDO::FETCH_CLASS »
   Remarque importante

   Toutes vos requêtes doivent être préparées pour des raisons de performance, et si nécessaire paramétrées pour des raisons de sécurité. Toute substitution de variable dans une requête est une faille de sécurité potentielle !

1. Ajoutez un bloc de documentation automatique au-dessus de la méthode « ArtistCollection::findAll() » en saisissant « /** » suivi de la touche « ENTER »
2. Changez le type « array » de l'annotation « @return » en « Artist[] »
   Information

   Les pseudo-types « type[] » peuvent aussi être formulés comme « array<type> », ou encore « array<int, type> » qui précise que les clés du tableau sont numériques.

3. Survolez la méthode « ArtistCollection::findAll() » et constatez les informations fournies dans la documentation
4. Profitez-en pour documenter la méthode en précisant ce qu'elle fait

1. Recherchez « codeception » dans les paquets Composer :
   Remarque importante

   Codeception est décomposé en un cœur accompagné de modules. Pour des raisons pratiques, vous allez installer des modules qui ne vous seront pas immédiatement utiles et dans des versions fixées au moment de la rédaction de ce sujet.

2. Demandez la dépendance de développement suivante :

   composer require --dev --with-all-dependencies codeception/codeception:^4.1 codeception/module-phpbrowser:^1 codeception/module-asserts:^1 codeception/module-db:^1

3. Testez le bon fonctionnement de Codeception avec la commande suivante :

   php vendor/bin/codecept --version
   Codeception 4.2.2
   

1. Lancez la commande d'initialisation du fichier de configuration :

   php vendor/bin/codecept bootstrap --namespace=Tests --empty

2. Observez l'apparition du fichier « codeception.yml » à la racine de votre projet
3. Observez l'apparition du répertoire « tests » et de sa sous-arborescence à la racine de votre projet
   Information

   Les fichiers « .gitkeep » sont utilisés pour préserver une arborescence vide car Git est prévu pour suivre les modifications des fichiers et non des répertoires.

4. Ajoutez l'ensemble des fichiers générés par Codeception à l'index Git

1. Ouvrez le fichier « composer.json »
2. Localiser la propriété « autoload »
3. Placez votre curseur à la fin de la valeur associée à la propriété « autoload »
4. Commencez à saisir « auto » et acceptez la suggestion « autoload-dev » de PhpStorm
5. Commencez à saisir « ps » et acceptez la suggestion « psr-4 » de PhpStorm
6. Associez l'espace de noms « Tests\ » au répertoire « tests »
7. Mettez à jour l'auto-chargement de Composer en lançant la commande suivante :

   composer dump-autoload

1. Lancez la commande de création d'une nouvelle suite de tests « Crud » :

   php vendor/bin/codecept generate:suite Crud

2. Observez l'apparition du fichier « Crud.suite.yml » dans le répertoire « tests »
3. Observez l'apparition du fichier « Crud.php » dans le répertoire « tests/_support/Helper »
   Information

   Une partie de la modularité de Codeception réside dans les modules et assistants. Les modules (« Modules ») apportent des fonctionnalités à l'objet effectuant les tests. Ils sont proposés de façon standard avec Codeception. Des modules personnalisés ou assistants (« Helpers ») complètent le dispositif et permettent au développeur de proposer ses propres fonctionnalités.

4. Éditez le fichier « Crud.suite.yml » pour activer les modules « Asserts » et « Db » :

   modules:
       enabled:
           - \Tests\Helper\Crud
           - Asserts
           - Db: # configuration from codeception.yml injected into MyPdo in _support/Helper/Crud.php

   Information

   Le module « Db » sera configuré dans le fichier « codeception.yml » et cette configuration sera injectée dans le singleton « MyPdo » dans le code de « _support/Helper/Crud.php ».

1. Placez le « dump » de la base de données dans le répertoire « tests/_data »
   Information

   Le « dump » musiclite.sql est une version réduite de la base de données avec seulement 8 artistes. Il n'est pas utile d'avoir l'intégralité de la base de données pour effectuer les tests est cela permet d'augmenter leur rapidité, en particulier la génération des données lors de chaque test.

2. Ajoutez la configuration du module « DB » dans le fichier « codeception.yml » :

   modules:
       config:
           Db: # configuration injected into MyPdo in _support/Helper/*.php, if necessary
               dsn: "sqlite:tests/musiclite.sqlite"
               user: ""
               password: ""
               dump: "tests/_data/musiclite.sql"
               populate: true
               cleanup: true
   

3. Excluez le fichier binaire de la base de données SQLite « tests/musiclite.sqlite » ainsi que « tests/musiclite.sqlite_snapshot » de l'index de votre dépôt Git en les ajoutant dans le fichier « .gitignore »
   Remarque importante

   Les fichiers « tests/musiclite.sqlite » et « tests/musiclite.sqlite_snapshot » sont créés par Codeception à partir du « dump » « musiclite.sql ». Il est parfaitement inutile, et surtout contreproductif, de les intégrer au dépôt Git.

4. Ajoutez la méthode « _initialize() » à la classe d'assistant « Tests\Helper\Crud » pour configurer « MyPdo » lors de l'initialisation de la suite de tests :

   public function _initialize($settings = [])
   {
       try {
           MyPdo::setConfiguration($this->getModule('Db')->_getConfig('dsn'));
       } catch (ModuleException $moduleException) {
           $this->fail('Codeception DB module not found');
       }
   }

5. Corrigez les erreurs en ajoutant les imports nécessaires grâce à PhpStorm

1. Lancez la commande de création d'un nouveau « Cest » :

   php vendor/bin/codecept generate:cest Crud Collection\\ArtistCollection

2. Observez l'apparition du fichier « tests/Crud/Collection/ArtistCollectionCest.php »
3. Corrigez l'espace de noms du fichier « tests/Crud/Collection/ArtistCollectionCest.php » pour le rendre conforme à la recommandation PSR-4
4. Supprimez toutes les méthodes de la classe « ArtistCollectionCest » générées automatiquement et remplacez-les par :

   public function findAll(CrudTester $I)
   {
       $expectedArtists = [
           ['id' => 40, 'name' => 'Joe Cocker'],
           ['id' => 89, 'name' => 'Justin Bieber'],
           ['id' => 59, 'name' => 'Lance & Donna'],
           ['id' => 17, 'name' => 'Metallica'],
           ['id' => 13, 'name' => 'Pantera'],
           ['id' => 4, 'name' => 'Slipknot'],
           ['id' => 26, 'name' => 'System Of A Down'],
           ['id' => 6, 'name' => 'ZZ Top'],
       ];
   
       $artists = ArtistCollection::findAll();
       $I->assertCount(count($expectedArtists), $artists);
       $I->assertContainsOnlyInstancesOf(Artist::class, $artists);
       foreach ($artists as $index => $artist) {
           $expectedArtist = $expectedArtists[$index];
           $I->assertEquals($expectedArtist['id'], $artist->getId());
           $I->assertEquals($expectedArtist['name'], $artist->getName());
       }
   }

5. Lancez la command de génération des fichiers nécessaires au fonctionnement du « Cest » :

   php vendor/bin/codecept build

6. Corrigez les erreurs en ajoutant les imports nécessaires grâce à PhpStorm

1. Lancez la commande d'exécution des tests' :

   php vendor/bin/codecept run

2. Vérifiez que le test « passe » :

   Codeception PHP Testing Framework v4.1.31
   Powered by PHPUnit 9.5.20
   
   Tests.Crud Tests (1) -----------------------------------------------------------------------------------------------------------
   ✔ ArtistCollectionCest: Get all (0.00s)
   --------------------------------------------------------------------------------------------------------------------------------
   
   
   Time: 00:00.041, Memory: 12.00 MB
   
   OK (1 test, 18 assertions)
   

1. Ouvrez le fichier « composer.json »
2. Ajoutez un script « test:crud » :

   php vendor/bin/codecept run Crud

3. Ajoutez un script « test:codecept » qui lance l'ensemble des tests de Codeception
4. Ajoutez un script « test » qui référence les scripts « test:cs » et « test:codecept »
5. Vérifiez que les tests passent
6. Documentez votre projet dans « README.md » en expliquant l'utilisation et l'objectif de chaque script de test dans une partie « Tests »

Créez la classe « Album » en suivant la même démarche que pour la classe « Artist »

Créez la classe « AlbumCollection » en suivant la même démarche que pour la classe « ArtistCollection »

1. Lancez la commande de création d'un nouveau « Cest » :

   php vendor/bin/codecept generate:cest Crud Collection\\AlbumCollection

2. Observez l'apparition du fichier « tests/Crud/Collection/AlbumCollectionCest.php »
3. Corrigez l'espace de noms du fichier « tests/Crud/Collection/AlbumCollectionCest.php » pour le rendre conforme à la recommandation PSR-4
4. Supprimez toutes les méthodes de la classe « AlbumCollectionCest » générées automatiquement et remplacez-les par :

   public function findByArtistId(CrudTester $I)
   {
       $expectedAlbums = [
           ['id' => 419, 'name' => 'The Big 4: Live From Sofia, Bulgaria', 'year' => 2010, 'genreId' => 4, 'artistId' => 17, 'coverId' => 251],
           ['id' => 330, 'name' => 'Death Magnetic', 'year' => 2008, 'genreId' => 4, 'artistId' => 17, 'coverId' => 326],
           ['id' => 44, 'name' => '2004/10/15 Quebec City, QC', 'year' => 2004, 'genreId' => 4, 'artistId' => 17, 'coverId' => 132],
           ['id' => 131, 'name' => 'St. Anger', 'year' => 2003, 'genreId' => 4, 'artistId' => 17, 'coverId' => 373],
           ['id' => 132, 'name' => 'St. Anger DVD', 'year' => 2003, 'genreId' => 4, 'artistId' => 17, 'coverId' => 302],
           ['id' => 416, 'name' => 'S&M', 'year' => 1999, 'genreId' => 4, 'artistId' => 17, 'coverId' => 320],
           ['id' => 405, 'name' => 'Garage Inc.', 'year' => 1998, 'genreId' => 4, 'artistId' => 17, 'coverId' => 348],
           ['id' => 178, 'name' => 'Live in Detroit', 'year' => 1998, 'genreId' => 4, 'artistId' => 17, 'coverId' => 307],
           ['id' => 135, 'name' => 'Reload', 'year' => 1997, 'genreId' => 4, 'artistId' => 17, 'coverId' => 344],
           ['id' => 20, 'name' => 'Load', 'year' => 1996, 'genreId' => 4, 'artistId' => 17, 'coverId' => 98],
           ['id' => 404, 'name' => 'Live Shit: Binge & Purge in Mexico City', 'year' => 1993, 'genreId' => 4, 'artistId' => 17, 'coverId' => 361],
           ['id' => 108, 'name' => 'Black Album', 'year' => 1991, 'genreId' => 4, 'artistId' => 17, 'coverId' => 363],
           ['id' => 38, 'name' => 'Prowling Osaka', 'year' => 1989, 'genreId' => 4, 'artistId' => 17, 'coverId' => 202],
           ['id' => 43, 'name' => '...And Justice For All', 'year' => 1988, 'genreId' => 4, 'artistId' => 17, 'coverId' => 48],
           ['id' => 39, 'name' => 'Master of Puppets', 'year' => 1986, 'genreId' => 4, 'artistId' => 17, 'coverId' => 65],
           ['id' => 121, 'name' => 'Ride The Lightning', 'year' => 1984, 'genreId' => 4, 'artistId' => 17, 'coverId' => 195],
           ['id' => 155, 'name' => 'Kill \'Em All', 'year' => 1983, 'genreId' => 4, 'artistId' => 17, 'coverId' => 260],
           ['id' => 310, 'name' => 'Sucking My Love', 'year' => 1982, 'genreId' => 4, 'artistId' => 17, 'coverId' => 222],
       ];
       $albums = AlbumCollection::findByArtistId(17);
       $I->assertCount(count($expectedAlbums), $albums);
       $I->assertContainsOnlyInstancesOf(Album::class, $albums);
       foreach ($albums as $index => $album) {
           $expectedAlbum = $expectedAlbums[$index];
           $I->assertEquals($expectedAlbum['id'], $album->getId());
           $I->assertEquals($expectedAlbum['name'], $album->getName());
           $I->assertEquals($expectedAlbum['year'], $album->getYear());
           $I->assertEquals($expectedAlbum['genreId'], $album->getGenreId());
           $I->assertEquals($expectedAlbum['artistId'], $album->getArtistId());
           $I->assertEquals($expectedAlbum['coverId'], $album->getCoverId());
       }
   }

5. Corrigez les erreurs en ajoutant les imports nécessaires grâce à PhpStorm
6. Vérifiez que les tests passent et corrigez votre code si besoin

1. Créez la classe « Entity\Exception\EntityNotFoundException » héritant de « OutOfBoundsException »
2. Ajoutez la méthode « findById() » à la classe « Artist »
   Remarque importante

   Toutes vos requêtes doivent être préparées pour des raisons de performance, et si nécessaire paramétrées pour des raisons de sécurité. Toute substitution de variable dans une requête est une faille de sécurité potentielle !

3. Ajoutez la méthode « getAlbums() » à la classe « Artist »

1. Lancez la commande de création d'un nouveau « Cest » :

   php vendor/bin/codecept generate:cest Crud Artist

2. Observez l'apparition du fichier « tests/Crud/ArtistCest.php »
3. Corrigez l'espace de noms du fichier « tests/Crud/ArtistCest.php » pour le rendre conforme à la recommandation PSR-4
4. Supprimez toutes les méthodes de la classe « ArtistCest » générées automatiquement et remplacez-les par :

   public function findById(CrudTester $I)
   {
       $artist = Artist::findById(4);
       $I->assertSame(4, $artist->getId());
       $I->assertSame('Slipknot', $artist->getName());
   }
   
   public function findByIdThrowsExceptionIfArtistDoesNotExist(CrudTester $I)
   {
       $I->expectThrowable(EntityNotFoundException::class, function () {
           Artist::findById(PHP_INT_MAX);
       });
   }

5. Corrigez les erreurs en ajoutant les imports nécessaires grâce à PhpStorm
6. Vérifiez que les tests passent et corrigez votre code si besoin