Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Proposal] Adding supporting docs for E2E test development under development guide

Aperta
  • Qualcosa non va?
#1,313 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
docker, go
Ambito
cli, documentation, testing

Direzione di ricerca

Inizia da cli/development.md e deployment.md, quindi esamina tests/e2e/standalone/uninstall_test.go e i commenti esistenti sulla configurazione E2E. Verifica il prerequisito make build, il comando go test --tags=e2e, il percorso richiesto del binario e le variabili DAPR_DASHBOARD_PINNED_VERSION e DAPR_RUNTIME_PINNED_VERSION. Il lavoro è completato quando la guida allo sviluppo spiega come compilare ed eseguire un singolo test E2E e perché sono necessarie queste variabili.

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

Descrizione

good first issue kind/documentation size/XS triaged/resolved

Describe the proposal

  1. Right now under the cli/development.md we do not have a supporting guide to run the E2E test. This includes maybe the command used to run the individual test because to run E2E tests one needs to add --tags=e2e while running the command and it looks something like go test --tags=e2e ./test/e2e/... -run NameOfTest which is different from how one runs unit tests. Additionally one has to build the project using make build command before running the E2E test as it requires the binary to be in dist/darwin_arch/release folder. Now this might be non-intuitive to a new contributor.
  2. Also while contributing or making changes to the E2E test, I had to add some environment variables for example in my case I was working on tests/e2e/standalone/uninstall_test.go which requires the addition of two environment variables DAPR_DASHBOARD_PINNED_VERSION and DAPR_RUNTIME_PINNED_VERSION. Now this was discovered while dry-running the code to navigate to a function where on the comment it is written that we need to add these variables as environment variables, otherwise, the test run fails. Although I do understand that the error message while tests failed was accurate in describing where the issue is and it clearly mentioned that DAPR_RUNTIME_PINNED_VERSION variable was not set. However, for someone new to the code base it would not make sense as to what the value should be of the given variable DAPR_RUNTIME_PINNED_VERSION or why it needs to be added.

The proposal is to add some supporting docs at least with basic details under deployment.md or at some other appropriate location.

My Setup

I was having docker installed on Mac machine. I built the code using make build and used the binary in the dist/darwin_arch/release folder to run dapr init. This did not automatically set the environment variables DAPR_DASHBOARD_PINNED_VERSION and DAPR_RUNTIME_PINNED_VERSION required to run the E2E test.

Lingua principale
Go
Stelle
353
Fork
220
Merge medio
6g 16h
PR unite (30g)
1

Preparare l'ambiente

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.

Altre issue di dapr/cli

Tutte le issue di dapr/cli

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.