salt.hightstate no top file error but exit status is zero

[mitchellh]

I ran salt.highstate and it gave me an error about no top file and yet the exit status was still zero. This is breaking error detection in tools like Vagrant and Packer because they can't detect if it failed.

See here: https://gist.github.com/armon/843f44777db3cf6e20f9

[basepi]

Yes, this is something we've been meaning to fix. Thanks for the report.

[terminalmage]

So, I did some digging, and within the state module __context__['retcode'] was set to nonzero, the salt CLI just isn't returning it.

[s0undt3ch]

Please try again by passing --retcode-passthrough to salt

[terminalmage]

Actually, the retcode wasn't being set right, I had modified salt/utils/init.py.

Here's an example of the ret data in a highstate, which ends up getting passed to salt.utils.check_state_result()

{'no_|-states_|-states_|-None': {
    'comment': 'No Top file or external nodes data matches found',
    '__run_num__': 0,
    'changes': {},
    'result': False,
    'name': 'No States'
    }
}

There seems to be a bug here, so I changed this line to:

if '_|-' in host:

[s0undt3ch]

Hmm, that's a fix @thatch45 did a while back because I was having some issues... Can't remember what the issue was...

[terminalmage]

@s0undt3ch

(saltdev)[root@virtucentos saltdev]# salt -c etc/salt --retcode-passthrough virtucentos state.highstate
Usage: salt [options] '<target>' <function> [arguments]

salt: error: no such option: --retcode-passthrough

[s0undt3ch]

Your fix might work because the will never be a key like _|-, hopefully...

[s0undt3ch]

@terminalmage, salt-call

[s0undt3ch]

I wonder if we can also add it to the salt binary...

[s0undt3ch]

Hmm, no, if returning info from several minions and only one failed? Or two failed with different exit codes...

[s0undt3ch]

Sorry for the misleading in my initial comment about --retcode-passthrough. It's available for salt-call not salt.

[dlanderson]

Added a test to make sure 'salt-call --retcode-passthrough' works as intended in #7224

[techdragon]

more bad return code issues - linking to issue #7013

[cachedout]

This does not seem to be an error in the current version of Salt.

mp@silver:~$ sudo salt silver state.highstate
silver:
----------
          ID: states
    Function: no.None
      Result: False
     Comment: No Top file or external nodes data matches found
     Started: 
     Duration:  ms
     Changes:   

Summary
------------
Succeeded: 0
Failed:    1
------------
Total states run:     1
mp@silver:~$ echo $?
11

And with salt-call

mp@silver:~$ sudo salt-call --local  --retcode-passthrough state.highstate
[INFO    ] Loading fresh modules for state activity
local:
----------
          ID: states
    Function: no.None
      Result: False
     Comment: No Top file or external nodes data matches found
     Started: 
     Duration:  ms
     Changes:   

Summary
------------
Succeeded: 0
Failed:    1
------------
Total states run:     1
mp@silver:~$ echo $?
2

@techdragon and @mitchellh is this the behaviour you would expect?

[techdragon]

@cachedout That looks good to me.

@mitchellh can you confirm?

[cachedout]

Thanks for the reply @techdragon. I think this is fixed but we'll wait a bit for @mitchellh to respond, as you recommend.

[mitchellh]

I don't have the repro case anymore to confirm, sorry. You can probably just safetly close this if you're confident it is fixed.