Fix a confusion between 'cleanup' and 'skip_cleanup_if_failed' configuration params

Offen

#67 erstellt am 09.5.2024 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: php
Bereich: database, documentation

Rechercherichtung

Das Issue nennt die Konfigurationsparameter cleanup und skip_cleanup_if_failed, identifiziert aber keine Dateien oder Tests. Beginne damit, ihre Definitionen und Dokumentation zu finden, und ermittle dann, wie beide Verhaltensweisen beschrieben werden und wo sich eine zukünftige Umbenennung auf Benutzer auswirken würde. Als abgeschlossen gilt die Arbeit, wenn die beiden Cleanup-Verantwortlichkeiten klar unterschieden sind und die vorgeschlagene Namensänderung für eine Major-Version geklärt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Problem

Currently we have configuration params cleanup and skip_cleanup_if_failed.
Despite their names sound similar, they are responsible for completely different things: cleanup controls the database re-creation before each test, and skip_cleanup_if_failed controls whether records, added by haveInDatabase() should be erased after the test.

Suggested fix

It would be good to distinguish these two 'cleanups' in documentation and in the names of config params in next major versions.
For example, to rename cleanup to repopulate (since we have populate responsible for initial database creation).

Vorherrschende Sprache: PHP
Sterne: 23
Forks: 31
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Codeception/module-db

haveInDatabase() is not usable inside a transaction on PostgreSQL Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 42/100

Codeception/module-db#87 · Erstellt am 09.6.2025
Using DB module in testing with transactions Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100

Codeception/module-db#85 · Erstellt am 25.2.2025
Make optional the auto-erase of the records, added by `haveInDatabase()` Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

Codeception/module-db#68 · 1 Kommentar · Erstellt am 10.5.2024
inserting null on an autoincrement primary key prevents cleanup Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

Codeception/module-db#58 · Erstellt am 14.6.2023
[DB error] PostgreSQL, for tables without sequences get "Undefined table: ERROR: relation '%_seq' does not exist" Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

Codeception/module-db#54 · Erstellt am 31.3.2023

Alle Issues in Codeception/module-db