saltstack / saltstack/salt

[TECH DEBT] saltenv="base" audit

Open
#61,615 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

severity-medium tech-debt
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description of the tech debt to be addressed, include links and screenshots

while working on cmdmod not taking into consideration saltenv setup in config. i ran a quick command to see just how many modules might have this same problem.

here are the results of that command

grep -r 'saltenv="base"' * | awk -F \: '{print $1}' | sort | uniq -c                                                                
      3 aptly.py
      3 aptpkg.py
      2 archive.py
      1 arista_pyeapi.py
      1 chroot.py
      8 ciscoconfparse_mod.py
      2 debconfmod.py
      4 debuild_pkgbuild.py
      5 dockermod.py
      1 dpkg_lowpkg.py
      2 file.py
      8 git.py
      8 heat.py
      7 iosconfig.py
      2 jenkinsmod.py
      1 jira_mod.py
      2 k8s.py
      4 kubernetesmod.py
      2 lxd.py
      6 napalm_mod.py
      3 napalm_network.py
      1 netmiko_mod.py
      1 nxos.py
      1 nxos_api.py
      2 pip.py
      1 pkg_resource.py
      1 rpm_lowpkg.py
      5 rpmbuild_pkgbuild.py
      1 rsync.py
      3 saltcheck.py
      1 saltutil.py
      1 scp_mod.py
      4 slsutil.py
      2 solarispkg.py
      3 ssh.py
      1 state.py
      2 textfsm_mod.py
      1 tomcat.py
      1 transactional_update.py
      3 virt.py
      2 virtualenv_mod.py
      3 win_certutil.py
      4 win_pkg.py
      1 win_pki.py
      2 winrepo.py
      1 yumpkg.py

Now it is entirely possible given the search simplicity that these are not an issue. however this is something that needs to be looked into to make sure we are not making the same mistake everywhere and that saltenv is not ignored when it is set in the config file.

Versions Report

This was run against the master branch of the gitrepo.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the saltenv="base" occurrences listed in the issue, beginning with cmdmod and the named module files. Check each use against saltenv configuration behavior and identify tests for affected modules; done means relevant modules no longer ignore configured saltenv, with coverage for confirmed cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops, infrastructure
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.