Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Smoke testing core features

Aberta
  • Algo errado?
#660 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
go
Domínio
testing

Direção de pesquisa

Comece pela interface auxiliar de cliente existente, incluindo client.CreateRoom, e pelos testes do Complement que a utilizam. Compare as interfaces propostas de usuário autenticado/token, atualizações em tempo real e salas com os cenários do matrix-authentication-service, sliding-sync e MSC4014; considera-se concluído quando houver uma abordagem definida de smoke testing, com seus modos de falha e escopo acordados.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement

Matrix has many moving parts. Tests typically only care about one single moving part at a time e.g send a message, create a room, upload OTKs. The setup code that happens to get to the point where we can test that moving part is for the most part, boilerplate. Complement has to date provided helper functions in client to do this sort of thing, failing the test if the boilerplate fails e.g client.CreateRoom. However, this then fixes the test into a certain way to setup the test. This is "okay" in that it is clear what is happening, but it limits the ability to do smoke tests:

smoke testing is preliminary testing or sanity testing to reveal simple failures severe enough to, for example, reject a prospective software release. Smoke tests are a subset of test cases that cover the most important functionality of a component or system, used to aid assessment of whether main functions of the software appear to work correctly.

There are several projects which would benefit from smoke testing:

  • matrix-authentication-service - all tests could start by logging into MAS and getting MAS tokens before checking basic functionality (the tests) work.
  • sliding-sync - all tests could use sliding sync APIs to consume live data rather than mandating sync v2.
  • MSC4014 pseudo IDs - all tests could be made as pseudo ID rooms which would otherwise then function the same as a normal room.

These could "reasonably" be split into 3 interfaces:

  • give me a logged in user and access token.
  • give me live updates.
  • give me a room.

There may be more. Smoke testing in this way is error-prone. Some tests will fail due to this setup in flakey ways, e.g:

  • The MAS token expires.
  • The sliding sync proxy didn't get the event, or the API doesn't expose the data you want to see in the test.
  • The room version behaves in a subtley different way.

However, there is real value in being able to run a sanity check like this, even if it isn't fully reliable (read: likely not in CI).

Linguagem predominante
Go
Estrelas
99
Forks
72
Merge médio
3d 5h
PRs com merge (30d)
9

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de matrix-org/complement

Todas as issues de matrix-org/complement

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.