Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openbmc-test-automation / 3efab4ce971c03d09c4b8ebb171fcd0e07937b00 / . / lib / os_utilities.py
blob: a1b4223bb5b41f5a2076c0d2a6f6fa0a1796efd0 [file] [log] [blame]
George Keishinge7e91712021-09-03 11:28:44 -0500[diff] [blame]1#!/usr/bin/env python3
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]2
3r"""
4This file contains utilities associated with the host OS.
5"""
6
George Keishinge635ddc2022-12-08 07:38:02 -0600[diff] [blame]7import os
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]8import sys
George Keishinge635ddc2022-12-08 07:38:02 -0600[diff] [blame]9
George Keishingb1cfbde2018-05-30 11:50:07 -0500[diff] [blame]10sys.path.append(os.path.join(os.path.dirname(__file__), "../lib"))
11
George Keishing09679892022-12-08 08:21:52 -0600[diff] [blame]12import bmc_ssh_utils # NOQA
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]13import var_funcs # NOQA
George Keishing37c58c82022-12-08 07:42:54 -0600[diff] [blame]14
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500[diff] [blame]15
George Keishing1ad128c2021-10-28 09:38:37 -0500[diff] [blame]16def get_os_release_info(default_cmd="cat /etc/os-release"):
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]17 r"""
18
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]19 Get os-release info and return it as a dictionary.
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]20
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]21 An example of the contents of /etc/os-release:
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]22
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]23 NAME="Red Hat Enterprise Linux Server"
24 VERSION="7.5 (Maipo)"
25 ID="rhel"
26 ID_LIKE="fedora"
27 VARIANT="Server"
28 VARIANT_ID="server"
29 VERSION_ID="7.5"
30 PRETTY_NAME="Red Hat Enterprise Linux Server 7.5 Beta (Maipo)"
31 ANSI_COLOR="0;31"
32 CPE_NAME="cpe:/o:redhat:enterprise_linux:7.5:beta:server"
33 HOME_URL="https://www.redhat.com/"
34 BUG_REPORT_URL="https://bugzilla.redhat.com/"
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]35
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]36 REDHAT_BUGZILLA_PRODUCT="Red Hat Enterprise Linux 7"
37 REDHAT_BUGZILLA_PRODUCT_VERSION=7.5
38 REDHAT_SUPPORT_PRODUCT="Red Hat Enterprise Linux"
39 REDHAT_SUPPORT_PRODUCT_VERSION="7.5 Beta"
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]40
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]41 For the data shown above, this function will return the following
42 dictionary:
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]43
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]44 result:
45 [name]: Red Hat Enterprise Linux Server
46 [version]: 7.5 (Maipo)
47 [id]: rhel
48 [id_like]: fedora
49 [variant]: Server
50 [variant_id]: server
51 [version_id]: 7.5
52 [pretty_name]: Red Hat Enterprise Linux Server 7.5 Beta (Maipo)
53 [ansi_color]: 0;31
54 [cpe_name]: cpe:/o:redhat:enterprise_linux:7.5:beta:server
55 [home_url]: https://www.redhat.com/
56 [bug_report_url]: https://bugzilla.redhat.com/
57 [redhat_bugzilla_product]: Red Hat Enterprise Linux 7
58 [redhat_bugzilla_product_version]: 7.5
59 [redhat_support_product]: Red Hat Enterprise Linux
60 [redhat_support_product_version]: 7.5 Beta
George Keishing1ad128c2021-10-28 09:38:37 -0500[diff] [blame]61
62
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]63 . Description of argument(s):
64 default_cmd A string command to be executed (e.g cat /etc/os-release).
George Keishing1ad128c2021-10-28 09:38:37 -0500[diff] [blame]65
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]66 """
67
Patrick Williams20f38712022-12-08 06:18:26 -0600[diff] [blame]68 stdout, stderr, rc = bmc_ssh_utils.os_execute_command(default_cmd)
Michael Walsh6dbdfef2018-05-30 10:35:26 -0500[diff] [blame]69
70 return var_funcs.key_value_outbuf_to_dict(stdout, delim="=", strip='"')