Spec environment fixtures duplicate skeleton data that no spec reads

Ouverte Adaptée aux débutants
#238 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
79/100
Type d'issue
Refactorisation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
ruby, yaml
Domaine
testing

Piste de recherche

Commencez par les fixtures sous spec/lib/simp/cli/commands/files/environments/ et les trois specs nommés : simp_puppet_env_helper_spec.rb, set_site_scenario_action_spec.rb et cli_simp_scenario_spec.rb. Vérifiez de quelle disposition, de quels fichiers hiera.yaml, manifests/site.pp et des noms de fichiers de scénario ils dépendent ; réduisez les valeurs YAML inutilisées à des espaces réservés ou aux clés vérifiées. Le travail est terminé lorsque les specs passent toujours et que les fixtures ne dupliquent plus de données de squelette inutilisées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

The environment fixtures under spec/lib/simp/cli/commands/files/environments/ (simp/ and simp_hiera3/) are hand-copied from simp/simp-environment-skeleton. The specs that use them (simp_puppet_env_helper_spec.rb, set_site_scenario_action_spec.rb, cli_simp_scenario_spec.rb) copy the directories into a temp environment. They depend on the layout (data/ vs. hieradata/, hiera.yaml), on manifests/site.pp, and on which scenario files exist. No spec reads the Hiera values in the scenario or host files.

So every data change in the skeleton needs a matching manual edit here, even though no test can tell whether it was made. #237 changed six fixture files only to follow simp/simp-environment-skeleton#76 (haveged → rngd), and the copies have drifted anyway (#236).

Options:

  • Cut the fixtures down to what the specs need. Keep the directory layout, hiera.yaml, site.pp and the scenario file names, and replace the YAML contents with a minimal placeholder (or only the keys a spec actually asserts). Skeleton data changes then never touch this repo. This also makes #236 unnecessary.
  • Build the fixtures from the skeleton at test time, e.g. from the simp-environment-skeleton RPM or a pinned checkout. That keeps them accurate, but it adds a network or package dependency to unit tests, so it's probably not worth it.

The first option looks like the better fit. The simp_hiera3/ copy has no current skeleton to follow anyway, so it can be trimmed the same way.

Langage dominant
Ruby
Étoiles
2
Forks
12
Merge moyen
1 j 13 h
PR mergées (30 j)
4

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de simp/rubygem-simp-cli

Toutes les issues de simp/rubygem-simp-cli

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.