Fix minion crash when grains config option is empty - #69891
Open
BrianHa94 wants to merge 2 commits into
Open
Conversation
An empty 'grains:' config option parses to None instead of a dict,
which crashed the minion during startup with "TypeError: 'NoneType'
object is not iterable" when the loader tried to build the
__grains__ NamespacedDictWrapper.
Default the option to an empty dict in both places that read it:
apply_minion_config, and salt.loader.grains(), which independently
re-reads the raw config file off disk. Log a warning in each case
pointing out that 'grains: {}' should be used instead.
Fixes saltstack#61321
BrianHa94
force-pushed
the
fix-61321-minion-crash-on-invalid-empty-grains
branch
from
July 28, 2026 05:43
378f500 to
3bb5529
Compare
twangboy
requested changes
Jul 28, 2026
Only warn/default the 'grains' config option when it is explicitly
present and None, not merely absent from opts. The looser
opts.get("grains") is None check could not distinguish "grains: set
to empty" from "grains key never set at all" (e.g. a sparse defaults
dict passed into apply_minion_config without a 'grains' key), causing
a false-positive warning in that case. This matches the equivalent
check already used in salt.loader.grains().
Also move log_file = factory.config["log_file"] in the new
integration test out of the try block, since it doesn't depend on the
test.ping call succeeding and reads more clearly next to the log file
assertions it's used for.
twangboy
approved these changes
Jul 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Fixes a minion crash on startup caused by an empty
grains:config option. YAML parsesgrains:with no value asNoneinstead of a dict, which two separate code paths (apply_minion_configandsalt.loader.grains(), which independently re-reads the raw config file off disk) assumed was always a dict. That crashed the minion withTypeError: 'NoneType' object is not iterablewhen building the__grains__context wrapper.Both locations now default the option to an empty dict (
{}) when it resolves toNone, and log a warning pointing out thatgrains: {}should be used instead of an emptygrains:key.What issues does this PR fix or reference?
Fixes #61321
Previous Behavior
A minion configured with an empty
grains:config option (e.g.grains:with no value) would crash on startup with:raised from
salt.utils.context.NamespacedDictWrapper.__init__via the loader's__prep_mod_opts.New Behavior
The minion starts normally. The empty
grainsoption is treated as{}, and a warning is logged:Merge requirements satisfied?
Add unit tests in
tests/unit/test_config.pyandtests/pytests/unit/loader/test_loader.py, plus an integration test intests/pytests/integration/cli/test_salt_minion.py.Commits signed with GPG?
No