platformio/platformio-core

Silent failure when dependency path is incorrect in library.json

Open

#4901 aperta il 19 apr 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (791 fork)batch import
help wantedpackage management

Metriche repository

Star
 (7329 star)
Metriche merge PR
 (Merge medio 109g 16h) (5 PR mergiate in 30 g)

Descrizione

Configuration

Operating system: Windows

PlatformIO Version: 6.1.14

Description of problem

If you put this in a library.json file:

{
  "dependencies": {
    "nonexistent_lib_1": "symlink:../hfzehfzeiohize",
    "nonexistent_lib_2": "file:../hrfiohgeuibz"
  }
}

PlatformIO will happily tell you:

Library Manager: Installing symlink:../hfzehfzeiohize
Library Manager: Installing file:../hrfiohgeuibz

even though none of those paths exist. This makes tracking path issues painful.

Expected Results

I would expect:

Library Manager: Installing symlink:../hfzehfzeiohize
PackageException: Can not create a symbolic link for `../hfzehfzeiohize`, not a directory

or:

Library Manager: Installing symlink:../hfzehfzeiohize
VCSBaseException: VCS: Unknown repository type symlink:../hfzehfzeiohize

Guida contributor

Direzione di ricerca
Esamina il codice di installazione delle dipendenze del gestore di librerie (probabilmente in platformio/package/manager/library.py o simile) per individuare dove vengono installate le dipendenze di tipo symlink e file. Aggiungi una validazione per verificare se il percorso specificato esiste prima di tentare l'installazione e solleva un'eccezione appropriata con un messaggio di errore chiaro.
Tech stack
python
Dominio
cli
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75