microcks / microcks/microcks-cli

TestDeleteContext fails when cmd/testdata directory is missing

Aperta Adatta ai principianti
#321 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Go
Stelle
52
Fork
68
Merge medio
6h 54m
PR unite (30g)
10

Descrizione

### Describe the bug

While running the test suite with `go test ./...`, the `TestDeleteContext` test fails because it tries to write/read a config file at `./testdata/local.config`. However, the `cmd/testdata` directory does not exist in a fresh clone, causing the test to fail with:

```
open ./testdata/local.config: no such file or directory
```

This makes the test dependent on a manually existing local directory instead of being fully self-contained.

Image

### Expected behavior

`go test ./...` should pass on a fresh clone without requiring the `cmd/testdata` directory to already exist. The test should create any temporary files or directories it needs during execution.

### Actual behavior

The test suite fails in `TestDeleteContext`:

```
--- FAIL: TestDeleteContext (0.00s)
context_test.go:44:
Error: Received unexpected error:
open ./testdata/local.config: no such file or directory
```

### How to Reproduce?

1. Clone the repository fresh: `git clone https://github.com/microcks/microcks-cli.git`
2. Change into the directory: `cd microcks-cli`
3. Run the test suite: `go test ./...`
4. Observe the failure in `cmd/context_test.go` at `TestDeleteContext`.

### Microcks version or git rev

_No response_

### Install method (`docker-compose`, `helm chart`, `operator`, `docker-desktop extension`,...)

_No response_

### Additional information

**Root cause.** `cmd/context_test.go` declares a hardcoded path:

```go
const testConfigFilePath = "./testdata/local.config"
```

and then calls `os.WriteFile(testConfigFilePath, ...)`. `os.WriteFile` does not create parent directories, and `.gitignore` excludes `**/testdata/**`, so the `cmd/testdata/` directory does not exist on a clean clone.

**Proposed fix.** Use Go's `t.TempDir()` so the test creates an isolated, auto-cleaned temporary directory on every run:

```go
testConfigFilePath := filepath.Join(t.TempDir(), "local.config")
```

This makes the test self-contained, removes the dependency on repository-local folders, and prevents state leakage between consecutive runs.

I would like to work on this issue if the maintainers agree with the proposed approach. I can send a small PR that updates the test to use `t.TempDir()`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia in cmd/context_test.go, da TestDeleteContext, e verifica come viene usato testConfigFilePath. Esegui go test ./... per riprodurre il fallimento dovuto all'assenza di cmd/testdata, quindi verifica che il test utilizzi una posizione temporanea isolata e passi in un checkout nuovo senza directory locali del repository.

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

Valutazione

Stack tecnologico
go
Ambito
cli, testing
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
84/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.