matrix-org / matrix-org/complement

Simplify internals

Aperta
#655 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Go
Stelle
99
Fork
72
Merge medio
4g 1h
PR unite (30g)
8

Descrizione

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).

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia tracciando l’attuale configurazione dei container Docker di Complement utilizzata dai suoi test Go, quindi confronta la sua API interna con testcontainers-go. Verifica se l’API rivolta ai test può rimanere invariata ed esegui i test Go esistenti; il lavoro è completo quando gli interni utilizzano la dipendenza, i test dei container continuano a passare e il codice di manutenzione è più semplice.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
docker, go
Ambito
infrastructure, testing
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.