1
diff --git a/src/actions.yaml b/src/actions.yaml
2
index 1dcaedb..93282ae 100644
3
--- a/src/actions.yaml
4
+++ b/src/actions.yaml
5
@@ -6,7 +6,7 @@ clear-notification:
6
6
    By doing so, unit will change the description to 'ready'
6
    By doing so, unit will change the description to 'ready'
7
7
update-grub:
7
update-grub:
8
8
  description: |
8
  description: |
10
9
    This action will run 'update-grub' to the generate a GRUB configuration file.
9
    This action will run 'update-grub' to generate a GRUB configuration file.
11
10
check-update-grub:
10
check-update-grub:
12
11
  description: |
11
  description: |
13
12
    This action will test if there is any GRUB configuration changes available.
12
    This action will test if there is any GRUB configuration changes available.
14
diff --git a/src/config.yaml b/src/config.yaml
15
index ba4a0a6..f7455e4 100644
16
--- a/src/config.yaml
17
+++ b/src/config.yaml
18
@@ -121,6 +121,9 @@ options:
19
121
        to avoid them being overwritten, for example
121
        to avoid them being overwritten, for example
20
122
        grub-config-flags='GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT
122
        grub-config-flags='GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT
21
123
        nvme_core.multipath=0'
123
        nvme_core.multipath=0'
22
124
        Also supports adding values with special characters in them(`$`, `=`, `,` etc.)
23
125
        but they need to be enclosed in double quotes. For example, grub-config-flags='GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT
24
126
        console=ttyS0,115200 console=tty0",GRUB_TIMEOUT=0'
25
124
  isolcpus:
127
  isolcpus:
26
125
    default: ""
128
    default: ""
27
126
    type: string
129
    type: string
28
diff --git a/src/lib/lib_sysconfig.py b/src/lib/lib_sysconfig.py
29
index 1a9875a..caf4c00 100644
30
--- a/src/lib/lib_sysconfig.py
31
+++ b/src/lib/lib_sysconfig.py
32
@@ -5,6 +5,7 @@ Manage grub, systemd, coufrequtils and kernel version configuration.
33
5
import filecmp
5
import filecmp
34
6
import hashlib
6
import hashlib
35
7
import os
7
import os
36
8
import re
37
8
import subprocess
9
import subprocess
38
9
from datetime import datetime, timedelta, timezone
10
from datetime import datetime, timedelta, timezone
39
10
11
40
@@ -35,10 +36,34 @@ IRQBALANCE_CONF = "/etc/default/irqbalance"
41
35
def parse_config_flags(config_flags):
36
def parse_config_flags(config_flags):
42
36
    """Parse config flags into a dict.
37
    """Parse config flags into a dict.
43
37
38
44
39
    This parsing function supports a few different formats
45
40
    depending on the config flags being provided.
46
41
47
42
    1. Simple string with key=value pairs. For example,
48
43
    a string in the format of 'key1=val1, key2=val2' will return a dict of:
49
44
    {'key1': 'val1', 'key2': 'val2'}.
50
45
51
46
    2. A string in the above format, but supporting a comma-delimited
52
47
    list of values for the same key. For example, a string in the format of
53
48
    'key1=val1, key2=val2,val3,val4' will return a dict of:
54
49
    {'key1': 'val1', 'key2': 'val2,val3,val4'}
55
50
56
51
    3. A string with special characters (`=`, `,`) in the value.
57
52
    Note: This case requires double quotes to properly separate the key and value pairs
58
53
    since there are special characters that need to be protected. Adding the double
59
54
    quotes explicitly ensures that the quotes are present in the dict output as well.
60
55
    For example, a string in the format of 'key1="subkey1=val1,val2 subkey2=val3"'
61
56
    will return a dict of: {'key1': '"subkey1=val1,val2 subkey2=val3"'}
62
57
63
38
    :param config_flags: key pairs list. Format: key1=value1,key2=value2
58
    :param config_flags: key pairs list. Format: key1=value1,key2=value2
64
39
    :return dict: format {'key1': 'value1', 'key2': 'value2'}
59
    :return dict: format {'key1': 'value1', 'key2': 'value2'}
65
40
    """
60
    """
67
41
    key_value_pairs = config_flags.split(",")
61
    # This regular expression is used to split the config flags
68
62
    # into a list while preserving the content within the
69
63
    # double quotes even if it contains commas
70
64
    # For example, it splits 'val1, val2, "val3,val4", val5'
71
65
    # as ['val1', 'val2', '"val3, val4"', 'val5]
72
66
    key_value_pairs = re.split(r',(?=(?:[^"]*"[^"]*")*[^"]*$)', config_flags)
73
42
    parsed_config_flags = {}
67
    parsed_config_flags = {}
74
43
    for index, pair in enumerate(key_value_pairs):
68
    for index, pair in enumerate(key_value_pairs):
75
44
        if "=" in pair:
69
        if "=" in pair:
76
diff --git a/src/templates/grub.j2 b/src/templates/grub.j2
77
index a76ca57..5d7cf79 100644
78
--- a/src/templates/grub.j2
79
+++ b/src/templates/grub.j2
80
@@ -5,18 +5,13 @@
81
5
# For full documentation of the options in this file, see:
5
# For full documentation of the options in this file, see:
82
6
#   info -f grub -n 'Simple configuration'
6
#   info -f grub -n 'Simple configuration'
83
7
7
84
8
# Evaluate grub-config-flags first, in case it uses $GRUB_CMDLINE_LINUX_DEFAULT.
85
9
# However, if grub-config-flags is not specified, ignore that (current behavior.)
86
10
{% if grub_config_flags is defined and grub_config_flags -%}
8
{% if grub_config_flags is defined and grub_config_flags -%}
87
11
# config-flags
9
# config-flags
88
12
{% for key, value in grub_config_flags.items() -%}
10
{% for key, value in grub_config_flags.items() -%}
89
13
{{ key }}={{ value }}
11
{{ key }}={{ value }}
90
14
{% endfor -%}
12
{% endfor -%}
91
15
{% else -%}
92
16
GRUB_CMDLINE_LINUX_DEFAULT=""
93
17
{% endif -%}
13
{% endif -%}
94
18
14
95
19
GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT console=ttyS0,115200 console=tty0"
96
20
{% if isolcpus is defined and isolcpus -%}
15
{% if isolcpus is defined and isolcpus -%}
97
21
GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT isolcpus={{ isolcpus }}"
16
GRUB_CMDLINE_LINUX_DEFAULT="$GRUB_CMDLINE_LINUX_DEFAULT isolcpus={{ isolcpus }}"
98
22
{% endif -%}
17
{% endif -%}
99
diff --git a/src/tests/unit/test_lib.py b/src/tests/unit/test_lib.py
100
index 9721313..b2b5354 100644
101
--- a/src/tests/unit/test_lib.py
102
+++ b/src/tests/unit/test_lib.py
103
@@ -45,6 +45,47 @@ def test_check_update_grub_unavailable(check_output, cmp_file):
104
45
    assert "No available grub updates found." in message
45
    assert "No available grub updates found." in message
105
46
46
106
47
47
107
48
@pytest.mark.parametrize(
108
49
    "config_flags, expected",
109
50
    [
110
51
        ("key1=val1,key2=val2", {"key1": "val1", "key2": "val2"}),
111
52
        # whitespace between key value pairs after comma
112
53
        ("key1=val1,  key2=val2", {"key1": "val1", "key2": "val2"}),
113
54
        # multiple values assigned to key
114
55
        ("key1=val1,val2,key2=val3", {"key1": "val1,val2", "key2": "val3"}),
115
56
        ("key1=val1 val2 val3", {"key1": "val1 val2 val3"}),
116
57
        # Subkey assigned to key has a single value (val) assigned with "="
117
58
        ('key="$key subkey=val"', {"key": '"$key subkey=val"'}),
118
59
        (
119
60
            'key1="subkey1=val1 val2",key2="$key2 val3"',
120
61
            {"key1": '"subkey1=val1 val2"', "key2": '"$key2 val3"'},
121
62
        ),
122
63
        # Subkey has multiple values (val1, val2) assigned each separated by comma
123
64
        (
124
65
            'key1="subkey1=val1,val2 subkey2=val3",key2=val4',
125
66
            {"key1": '"subkey1=val1,val2 subkey2=val3"', "key2": "val4"},
126
67
        ),
127
68
        (
128
69
            'key1="$key1 subkey1=val1,val2 subkey2=val3", key2=val4',
129
70
            {"key1": '"$key1 subkey1=val1,val2 subkey2=val3"', "key2": "val4"},
130
71
        ),
131
72
        (
132
73
            (
133
74
                'key1="$key1 subkey1=val1,val2 subkey2=val3", key2="$key2 '
134
75
                'subkey1=val1 subkey2=val2"'
135
76
            ),
136
77
            {
137
78
                "key1": '"$key1 subkey1=val1,val2 subkey2=val3"',
138
79
                "key2": '"$key2 subkey1=val1 subkey2=val2"',
139
80
            },
140
81
        ),
141
82
    ],
142
83
)
143
84
def test_parse_config_flags(config_flags, expected):
144
85
    """Test parsing function for config flags."""
145
86
    assert lib_sysconfig.parse_config_flags(config_flags) == expected
146
87
147
88
148
48
class TestBootResourceState:
89
class TestBootResourceState:
149
49
    """Test BootResourceState class."""
90
    """Test BootResourceState class."""
150
50
91
Reviewer	Review Type	Date Requested	Status
JamesLin			Approve on 2023-05-09
🤖 prod-jenkaas-bootstack (community)	continuous-integration		Approve on 2023-05-08
Eric Chen		2023-04-18	Approve on 2023-05-08
Erhan Sunar (community)		2023-04-18	Needs Fixing on 2023-04-18
BootStack Reviewers		2023-05-05	Pending
Review via email: mp+441304@code.launchpad.net