platformio/platformio-core

Silent failure when dependency path is incorrect in library.json

Open

#4 901 ouverte le 19 avr. 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (791 forks)batch import
help wantedpackage management

Métriques du dépôt

Stars
 (7 329 stars)
Métriques de merge PR
 (Merge moyen 109j 16h) (5 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez le code d'installation des dépendances du gestionnaire de bibliothèques (probablement dans platformio/package/manager/library.py ou similaire) pour trouver où les dépendances de type lien symbolique et fichier sont installées. Ajoutez une validation pour vérifier si le chemin spécifié existe avant de tenter l'installation, et levez une exception appropriée avec un message d'erreur clair.
Stack technique
python
Domaine
cli
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75