Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ajoute un guide sur les tests backend #6166

Merged
merged 7 commits into from
Sep 23, 2021

Conversation

Arnaud-D
Copy link
Contributor

@Arnaud-D Arnaud-D commented Sep 12, 2021

Ajoute un guide sur les tests backend. Le guide ne traite volontairement que de l'utilisation basique des tests existants. Cela permet de couvrir les cas d'utilisation basiques, comme par exemple vérifier en local qu'une petite modification ne casse pas tout.

Je pense que des conseils plus orientés sur l'écriture de tests pour ZdS auront plus leur place dans un autre guide.

Contrôle qualité

  • Générer la doc
  • Vérifier que le rendu et les liens sont corrects
  • Jeter un œil à l'orthographe.

@Arnaud-D Arnaud-D added the C-Docs Concerne la documentation label Sep 12, 2021
@coveralls
Copy link

coveralls commented Sep 12, 2021

Coverage Status

Coverage remained the same at 86.621% when pulling bebdec9 on Arnaud-D:guide_backend_tests into ecd07ca on zestedesavoir:dev.

Copy link
Member

@Situphen Situphen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je pense que tu as oublié quelques petites choses dans les commandes à lancer. Voici ce qu'il y a dans le Makefile actuellement :

test-back: clean-back zmd-start ## Run backend unit tests
	python manage.py test --settings zds.settings.test --exclude-tag=front
	make zmd-stop

test-back-selenium: ## Run backend Selenium tests
	xvfb-run --server-args="-screen 0 1280x720x8" python manage.py test --settings zds.settings.test --tag=front

Il faut donc préciser la nécessité de lancer zmarkdown avant de lancer les tests. Il manque le --settings zds.settings.test pour que certains tests fonctionnent correctement. Je ne sais pas si on doit parler de --exclude-tag=front.

doc/source/guides/backend-tests.rst Outdated Show resolved Hide resolved
@Arnaud-D
Copy link
Contributor Author

Merci pour ton retour.

J'ai :

  • ajouté une instruction pour lancer zmd,
  • ajouté l'argument pour les settings,
  • décidé de ne pas mentionner le exclude-tags.

Pour le exlude-tags, je préfère me passer de cette subtilité dans un guide qui vise essentiellement à apprendre en deux minutes comment se dépatouiller avec les tests en local. D'ailleurs, on s'en sert très peu dans le code (deux fois si j'ai bien compté).

Copy link
Member

@philippemilink philippemilink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quelques suggestion d'améliorations. Je rajouterais en plus:

  • suggérer le TDD ?
  • dire qu'une PR qui touche au code Python nécessite un test back (ça peut aussi permettre d'éclaircir le terme backend)

Ces points auraient sans doute leur place dans l'introduction du guide.

doc/source/guides/backend-tests.rst Outdated Show resolved Hide resolved
doc/source/guides/backend-tests.rst Show resolved Hide resolved
doc/source/guides/backend-tests.rst Show resolved Hide resolved
doc/source/guides/backend-tests.rst Outdated Show resolved Hide resolved
doc/source/guides/backend-tests.rst Outdated Show resolved Hide resolved
Arnaud-D and others added 3 commits September 23, 2021 20:55
Co-authored-by: Ph. SW. <[email protected]>
Co-authored-by: Ph. SW. <[email protected]>
@Arnaud-D
Copy link
Contributor Author

suggérer le TDD ?

Non, car l'objet de ce guide est simplement d'apprendre à lancer les tests quand on dév, pas d'en rajouter ou de les modifier, ça c'est l'autre guide. On s'adresse à des gens qui savent à peine se débrouiller avec Django ou la doc d'outils en général, tout ce que je dis là est en vérité dans la doc officielle !

dire qu'une PR qui touche au code Python nécessite un test back (ça peut aussi permettre d'éclaircir le terme backend)

Idem, c'est plus pour l'autre guide et le modèle de PR le rappelle aussi.

@philippemilink philippemilink enabled auto-merge (squash) September 23, 2021 19:36
@philippemilink philippemilink merged commit 9cbde43 into zestedesavoir:dev Sep 23, 2021
@Arnaud-D Arnaud-D deleted the guide_backend_tests branch September 23, 2021 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs Concerne la documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants