1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
#
# Author:: Steven Murawski (<smurawski@chef.io>)
# Copyright:: Copyright (c) Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
class Chef
class Application
# These are the exit codes defined in the exit codes design document
# https://github.com/chef/chef/blob/main/docs/dev/design_documents/client_exit_codes.md
class ExitCode
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
# -1 is defined as DEPRECATED_FAILURE in RFC 062, so it is
# not enumerated in an active constant.
#
VALID_RFC_062_EXIT_CODES = {
SUCCESS: 0,
GENERIC_FAILURE: 1,
SIGINT_RECEIVED: 2,
SIGTERM_RECEIVED: 3,
REBOOT_SCHEDULED: 35,
REBOOT_NEEDED: 37,
REBOOT_FAILED: 41,
# 42 was used by audit mode and should not be reused
CONFIG_FAILURE: 43,
CLIENT_UPGRADED: 213,
}.freeze
DEPRECATED_RFC_062_EXIT_CODES = {
DEPRECATED_FAILURE: -1,
}.freeze
class << self
def normalize_exit_code(exit_code = nil)
normalized_exit_code = normalize_legacy_exit_code(exit_code)
if valid_exit_codes.include? normalized_exit_code
normalized_exit_code
else
Chef::Log.warn(non_standard_exit_code_warning(normalized_exit_code))
VALID_RFC_062_EXIT_CODES[:GENERIC_FAILURE]
end
end
private
def normalize_legacy_exit_code(exit_code)
case exit_code
when Integer
exit_code
when Exception
lookup_exit_code_by_exception(exit_code)
else
VALID_RFC_062_EXIT_CODES[:GENERIC_FAILURE]
end
end
def lookup_exit_code_by_exception(exception)
if sigint_received?(exception)
VALID_RFC_062_EXIT_CODES[:SIGINT_RECEIVED]
elsif sigterm_received?(exception)
VALID_RFC_062_EXIT_CODES[:SIGTERM_RECEIVED]
elsif reboot_scheduled?(exception)
VALID_RFC_062_EXIT_CODES[:REBOOT_SCHEDULED]
elsif reboot_needed?(exception)
VALID_RFC_062_EXIT_CODES[:REBOOT_NEEDED]
elsif reboot_failed?(exception)
VALID_RFC_062_EXIT_CODES[:REBOOT_FAILED]
elsif configuration_failure?(exception)
VALID_RFC_062_EXIT_CODES[:CONFIG_FAILURE]
elsif client_upgraded?(exception)
VALID_RFC_062_EXIT_CODES[:CLIENT_UPGRADED]
else
VALID_RFC_062_EXIT_CODES[:GENERIC_FAILURE]
end
end
def reboot_scheduled?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::Reboot)
end
def reboot_needed?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::RebootPending)
end
def reboot_failed?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::RebootFailed)
end
def configuration_failure?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::ConfigurationError)
end
def client_upgraded?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::ClientUpgraded)
end
def sigint_received?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::SigInt)
end
def sigterm_received?(exception)
resolve_exception_array(exception).any?(Chef::Exceptions::SigTerm)
end
def resolve_exception_array(exception)
exception_array = [exception]
if exception.respond_to?(:wrapped_errors)
exception.wrapped_errors.each do |e|
exception_array.push e
end
end
exception_array
end
def valid_exit_codes
VALID_RFC_062_EXIT_CODES.values
end
def notify_on_deprecation(message)
Chef.deprecated(:exit_code, message)
rescue Chef::Exceptions::DeprecatedFeatureError
# Have to rescue this, otherwise this unhandled error preempts
# the current exit code assignment.
end
def non_standard_exit_code_warning(exit_code)
"#{ChefUtils::Dist::Infra::CLIENT} attempted to exit with a non-standard exit code of #{exit_code}." \
" The #{ChefUtils::Dist::Infra::PRODUCT} Exit Codes design document (https://github.com/chef/chef/blob/main/docs/dev/design_documents/client_exit_codes.md)" \
" defines the exit codes that should be used with #{ChefUtils::Dist::Infra::CLIENT}. Chef::Application::ExitCode defines" \
" valid exit codes Non-standard exit codes are redefined as GENERIC_FAILURE."
end
end
end
end
end
|
