xref: /openbmc/openbmc-test-automation/data/variables.py (revision 28e403b8c632ff68954aa1e3b7fd9ca10ee1b332)
1import os
2
3OPENBMC_BASE_URI = '/xyz/openbmc_project/'
4OPENBMC_BASE_DBUS = 'xyz.openbmc_project.'
5
6# org open power base URI.
7OPENPOWER_BASE_URI = '/org/open_power/'
8OPENPOWER_CONTROL = OPENPOWER_BASE_URI + 'control/'
9
10# REST URI base endpoint paths.
11CONTROL_URI = OPENBMC_BASE_URI + 'control/'
12# old vs new code dependencies in many places.
13# TODO: remove when ready.
14SETTINGS_URI = '/org/openbmc/settings/'
15WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
16TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
17XYZ_NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
18
19# Sensors base variables.
20SENSORS_URI =  OPENBMC_BASE_URI + 'sensors/'
21
22# State Manager base variables
23BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
24
25HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
26HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
27HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
28HOST_POWEROFF_STATE = 'xyz.openbmc_project.State.Host.HostState.Off'
29HOST_POWERON_STATE = 'xyz.openbmc_project.State.Host.HostState.Running'
30
31CHASSIS_POWEROFF_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.Off'
32CHASSIS_POWERON_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.On'
33CHASSIS_POWEROFF_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.Off'
34CHASSIS_POWERON_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.On'
35
36# State Manager URI variables.
37SYSTEM_STATE_URI = OPENBMC_BASE_URI + 'state/'
38BMC_STATE_URI = OPENBMC_BASE_URI + 'state/bmc0/'
39HOST_STATE_URI = OPENBMC_BASE_URI + 'state/host0/'
40CHASSIS_STATE_URI = OPENBMC_BASE_URI + 'state/chassis0/'
41HOST_WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/host0/'
42
43# Logging URI variables
44BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
45BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
46
47# Software manager version
48SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
49ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
50READY = 'xyz.openbmc_project.Software.Activation.Activations.Ready'
51INVALID = 'xyz.openbmc_project.Software.Activation.Activations.Invalid'
52ACTIVATING = 'xyz.openbmc_project.Software.Activation.Activations.Activating'
53NOTREADY = 'xyz.openbmc_project.Software.Activation.Activations.NotReady'
54FAILED = 'xyz.openbmc_project.Software.Activation.Activations.Failed'
55
56SOFTWARE_ACTIVATION = 'xyz.openbmc_project.Software.Activation'
57REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
58REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
59REQUESTED_NONE = REQUESTED_ACTIVATION + '.None'
60
61SOFTWARE_PURPOSE = 'xyz.openbmc_project.Software.Version.VersionPurpose'
62VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + '.Host'
63VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + '.BMC'
64VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + '.System'
65
66# Image Upload Directory Path
67IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
68
69# Inventory URI
70HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
71
72# Led URI variable
73LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
74LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
75
76# Host control URI variables.
77CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
78
79# Power restore variables.
80POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
81CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
82
83RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
84ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
85ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
86
87# Dump URI variable
88DUMP_URI = OPENBMC_BASE_URI +'/dump/'
89DUMP_ENTRY_URI = DUMP_URI + 'entry/'
90# The path on the BMC where dumps are stored.
91DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
92
93# Boot progress variables.
94STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
95OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
96OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
97OS_BOOT_COMPLETE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.BootComplete'
98
99# Boot variables.
100BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
101BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
102BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
103BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
104BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
105BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
106BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
107
108'''
109  QEMU HTTPS variable:
110
111  By default lib/resource.txt AUTH URI construct is as
112  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
113  ${AUTH_SUFFIX} is populated here by default EMPTY else
114  the port from the OS environment
115'''
116
117
118def get_port_https():
119    # defaulted to empty string
120    l_suffix = ''
121    try:
122        l_https_port = os.getenv('HTTPS_PORT')
123        if l_https_port:
124            l_suffix = ':' + l_https_port
125    except:
126        print "Environment variable HTTPS_PORT not set,\
127              using default HTTPS port"
128    return l_suffix
129
130AUTH_SUFFIX = {
131    "https_port": [get_port_https()],
132}
133
134# Update the ':Port number' to this variable
135AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
136
137# Here contains a list of valid Properties bases on fru_type after a boot.
138INVENTORY_ITEMS = {
139    "CPU": [
140        "Custom Field 1",
141        "Custom Field 2",
142        "Custom Field 3",
143        "Custom Field 4",
144        "Custom Field 5",
145        "Custom Field 6",
146        "Custom Field 7",
147        "Custom Field 8",
148        "FRU File ID",
149        "Manufacturer",
150        "Name",
151        "Part Number",
152        "Serial Number",
153        "fault",
154        "fru_type",
155        "is_fru",
156        "present",
157        "version",
158        ],
159
160    "DIMM": [
161        "Asset Tag",
162        "Custom Field 1",
163        "Custom Field 2",
164        "Custom Field 3",
165        "Custom Field 4",
166        "Custom Field 5",
167        "Custom Field 6",
168        "Custom Field 7",
169        "Custom Field 8",
170        "FRU File ID",
171        "Manufacturer",
172        "Model Number",
173        "Name",
174        "Serial Number",
175        "Version",
176        "fault",
177        "fru_type",
178        "is_fru",
179        "present",
180        "version",
181        ],
182    "MEMORY_BUFFER": [
183        "Custom Field 1",
184        "Custom Field 2",
185        "Custom Field 3",
186        "Custom Field 4",
187        "Custom Field 5",
188        "Custom Field 6",
189        "Custom Field 7",
190        "Custom Field 8",
191        "FRU File ID",
192        "Manufacturer",
193        "Name",
194        "Part Number",
195        "Serial Number",
196        "fault",
197        "fru_type",
198        "is_fru",
199        "present",
200        "version",
201        ],
202    "FAN": [
203        "fault",
204        "fru_type",
205        "is_fru",
206        "present",
207        "version",
208        ],
209    "DAUGHTER_CARD": [
210        "Custom Field 1",
211        "Custom Field 2",
212        "Custom Field 3",
213        "Custom Field 4",
214        "Custom Field 5",
215        "Custom Field 6",
216        "Custom Field 7",
217        "Custom Field 8",
218        "FRU File ID",
219        "Manufacturer",
220        "Name",
221        "Part Number",
222        "Serial Number",
223        "fault",
224        "fru_type",
225        "is_fru",
226        "present",
227        "version",
228        ],
229    "BMC": [
230        "fault",
231        "fru_type",
232        "is_fru",
233        "manufacturer",
234        "present",
235        "version",
236        ],
237    "MAIN_PLANAR": [
238        "Custom Field 1",
239        "Custom Field 2",
240        "Custom Field 3",
241        "Custom Field 4",
242        "Custom Field 5",
243        "Custom Field 6",
244        "Custom Field 7",
245        "Custom Field 8",
246        "Part Number",
247        "Serial Number",
248        "Type",
249        "fault",
250        "fru_type",
251        "is_fru",
252        "present",
253        "version",
254        ],
255    "SYSTEM": [
256        "Custom Field 1",
257        "Custom Field 2",
258        "Custom Field 3",
259        "Custom Field 4",
260        "Custom Field 5",
261        "Custom Field 6",
262        "Custom Field 7",
263        "Custom Field 8",
264        "FRU File ID",
265        "Manufacturer",
266        "Model Number",
267        "Name",
268        "Serial Number",
269        "Version",
270        "fault",
271        "fru_type",
272        "is_fru",
273        "present",
274        "version",
275        ],
276    "CORE": [
277        "fault",
278        "fru_type",
279        "is_fru",
280        "present",
281        "version",
282        ],
283}
284