- Avoir installé un IDE :
- IntelliJ Ultimate, avec votre adresse IPI sur Jetbrains Student à https://www.jetbrains.com/student/
- ou Eclipse, à https://www.eclipse.org/downloads/packages/release/2022-09/r/eclipse-ide-java-developers
- Savoir utiliser Git et les branches. Quelques liens :
- Avoir un compte Github. Voici comment y configurer l'authentification de git par clé SSH :
- forkez ce repository sur votre compte Github.
- Puis après chaque question, committez et pushez vos réponses sur votre repository.
- sur ce repository, configurez un build automatisé Maven.
- indice : Github Actions > Java with Maven > Configure > Start commit
- vérifiez d'abord la configuration proposée
- vérifiez que le workflow correspondant a été committé, et qu'un job de build a été lancé
- suivre les bonnes pratiques : à chaque commit, si son build casse, ne pas le laisser dans cet état !
- Connectez-vous à https://sonarcloud.io/ en vous identifiant à l'aide de votre compte Github
- Créez un projet Sonar Cloud pour votre repository forké :
- New Project > sélectionnez votre repoisitory forké
- Analyse new project > Create a project manually > Créer un token comme indiqué et copiez-le dans un fichier temporaire
- Paramétrez l'analyse avec les actions Github comme indiqué
- ajoutez dans le workflow Github la configuration de l'analyse Sonar Cloud du code
- Rédigez ci-dessous une courte analyse du premier rapport produit par Sonar (métriques, état général...) :
Le premier rapport Sonar indique...
Dans tous les cas :
- créez la classe de test si nécessaire, et une ou plusieurs méthodes de test
- les tests doivent couvrir autant de cas que possible
- vous pouvez corriger le code de la méthode testée si nécessaire
Questions :
- Tests unitaires simples : Testez unitairement la méthode
SalarieAideADomicile.aDroitADesCongesPayes()(pensez aux cas aux limites). - Tests paramétrés : Testez par une méthode de test paramétrée la méthode
SalarieAideADomicile.calculeJoursDeCongeDecomptesPourPlage(). - Tests avec mocks : Testez de manière mockée (sans dépendance à la base de données) la méthode
SalarieAideADomicileService.clotureMois().
- Tests de repository : Testez la méthode
SalarieAideADomicileRepository.findByNom(). - Tests d'intégration de service : Créez un test d'intégration d'un exemple d'usage typique de la méthode
SalarieAideADomicileService.clotureMois().
Cucumber est installé dans le projet : maven exécute dans les tests également les Features cucumber définies dans src/test/resources, en prenant comme définition de leurs Steps celles trouvées dans des méthodes annotées (suprise !) @Given, @When, @Then. Tout cela grâce aux bonnes dépendances Maven dans le pom.xml, et la bonne extension Junit configurée dans la classe RunCucumberTest, fournies par l'exécution de l'archetype Maven comme indiqué dans le tutorial officiel à https://cucumber.io/docs/guides/10-minute-tutorial/ .
Regarder l'exemple qui fonctionne dans la classe StepDefinitions et le fichier de Feature is_it_friday.feature, repris du même tutorial.
S'en inspirer pour écrire la Feature puis développer les Step nécessaires dans StepDefinitions pour écrirer un test d'acceptation validant la fonctionnalité de clôture de mois d'un salarié aide à domicile.
- conventions de codage : faites les respecter, améliorez la lisibilité du code
- journalisation : rajoutez du logging aux endroits les plus pertinents. Changez la configuration pour que les messages de log aillent en plus dans un nouveau fichier
error.log - documentation : améliorez la documentation du code où c'est nécessaire. Générez localement la JavaDoc en utilisant Maven.
- Rajoutez en entrée de ce README les badges Sonar des métriques importantes de votre projet, en utilisant l'API web de Sonar : https://sonarcloud.io/web_api/api/project_badges
Une fois le TD fini, réalisez les travaux de l'évaluation dans une branche "evaluation" créée à partir de la branche "master" de votre repository forké.
Dans tous les cas :
- assurez-vous que le build passe (compilation, tests) et qu'il n'y a aucune alerte Sonar bloquante, critique ou majeur (Code Smells, anomalies, bugs). Vous pouvez corriger le code originel si nécessaire.
- efforcez-vous d'avoir une couverture de code à 100% sur les méthodes testées plus bas. BONUS : même chose mais avec la couverture de code avec mutation.
- Si cela vous est permis, vous êtes invités à réaliser travaux de l'évaluation en Pair Programming, en vous associant avec un autre étudiant. Dans ce cas, partez du repository forké jugé le plus complet ou mieux noté par Sonar des deux, passez-vous le clavier au moins entre 2 questions, et indiquez qui le tenait par l'utilisateur de votre commit.
- Sinon, une fois le TP d'évaluation fini, créez sur Github une Pull Request de votre branche "evaluation" vers la branche "master" et demandez à un autre étudiant de faire la revue de votre code. Les cas échéant, faites les corrections demandées.
- Faites du TDD pour tester unitairement la méthode
Entreprise.estDansPlage(): écrire d'abord les tests entièrement (pensez aux cas limites) et seulement ensuite écrivez le code de la méthode. Indiquez dans un commentaire une chose ou deux que vous auriez peut-être fait différemment sans faire de TDD.
- Tester unitairement (de manière paramétrée) la méthode
Entreprise.estJourFerie()OU BIENEntreprise.proportionPondereeDuMois()etEntreprise.getPremierJourAnneeDeConges(). Attention, elles contiennent des erreurs, bon débogage ! Améliorez l'ensemble de la qualité de cette méthode, avec l'aide de Sonar. - Testez sans dépendance à la base de données la méthode
SalarieAideADomicileService.calculeLimiteEntrepriseCongesPermis()
- Tests de repository : Testez la méthode
SalarieAideADomicileRepository.partCongesPrisTotauxAnneeNMoins1() - Tests d'intégration de service : Créez un test d'intégration d'un exemple d'usage typique de la méthode
SalarieAideADomicileService.calculeLimiteEntrepriseCongesPermis() - TODO RM BONUS Ecrire un test d'acceptation Cucumber pour au moins la partie "ancienneté" la fonctionnalité de calcul de limite de congés permis par l'entreprise.
- conventions de codage : pareil, faites les respecter, améliorez la lisibilité du code
- journalisation : Changez la configuration pour réaliser la rotation des fichiers de logs tous les jours et que chaque fichier ne dépasse pas 1 MO.
- BONUS : Créez une petite documentation statique en utilisant MkDocs.
- Rédigez ci-dessous une courte analyse du rapport produit par Sonar (métriques, évolution, état général...) :
Le rapport Sonar final indique...