matrix-org / matrix-org/complement

Simplify internals

Offen
#655 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Go
Sterne
99
Forks
72
Ø Merge
4 T. 1 Std.
Gemergte PRs (30 T.)
8

Beschreibung

The idea of running docker containers in Go tests isn't new. It was reasonably new back when Complement started, but now there are libraries we could use instead, notably https://github.com/testcontainers/testcontainers-go

We should consider using this internally. This would be transparent to tests as they have a separate API shape, and greatly simplify the burden of maintaining Complement internals, as the cost of an extra dependency. This dependency though is backed by a number of companies and does test containers for other languages as well, [not just Go](https://github.com/testcontainers).

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die aktuelle Docker-Container-Einrichtung von Complement nachzuverfolgen, die von seinen Go-Tests verwendet wird, und vergleiche dann seine interne API mit testcontainers-go. Bestätige, ob die testseitige API unverändert bleiben kann, und führe die bestehenden Go-Tests aus; als erledigt gilt die Aufgabe, wenn die Interna die Abhängigkeit verwenden, die Container-Tests weiterhin bestehen und der Wartungscode einfacher ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
docker, go
Bereich
infrastructure, testing
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.