Skip to content

Commit

Permalink
stage/test: kickstart test split
Browse files Browse the repository at this point in the history 
Split out the kickstart tests between checking contents and validating,
this allows to skip the validation tests if ksvalidator isn't available.
  • Loading branch information
@supakeen
supakeen committed Nov 10, 2023
1 parent 1f51938 commit 910a4b5
Showing 1 changed file with 126 additions and 99 deletions.
225 changes: 126 additions & 99 deletions stages/test/test_kickstart.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,96 +6,106 @@
import pytest

import osbuild.meta
from osbuild.testutil import has_executable
from osbuild.testutil.imports import import_module_from_path


@pytest.mark.parametrize("test_input,expected", [
TEST_INPUT = [
({"lang": "en_US.UTF-8"}, "lang en_US.UTF-8"),
({"keyboard": "us"}, "keyboard us"),
({"timezone": "UTC"}, "timezone UTC"),
({"lang": "en_US.UTF-8",
"keyboard": "us",
"timezone": "UTC",
},
"lang en_US.UTF-8\nkeyboard us\ntimezone UTC"),
({"ostree":
{
"osname": "some-osname",
"url": "http://some-ostree-url.com/foo",
"ref": "some-ref",
"remote": "some-remote",
"gpg": True,
},
"liveimg": {
"url": "some-liveimg-url",
},
"groups": {
"somegrp": {
"gid": 2337,
},
},
"users": {
"someusr": {
"uid": 1337,
"gid": 1337,
"groups": [
"grp1",
"grp2",
],
"home": "/other/home/someusr",
"shell": "/bin/ksh",
"password": "$1$notreally",
"key": "ssh-rsa not-really-a-real-key",
},
},
},
"ostreesetup --osname=some-osname --url=http://some-ostree-url.com/foo --ref=some-ref --remote=some-remote\n" +
"liveimg --url some-liveimg-url\ngroup --name somegrp --gid 2337\n" +
"user --name someusr --password $1$notreally --iscrypted --shell /bin/ksh --uid 1337 --gid 1337 --groups grp1,grp2 --homedir /other/home/someusr\n" +
'sshkey --username someusr "ssh-rsa not-really-a-real-key"'
),
(
{
"lang": "en_US.UTF-8",
"keyboard": "us",
"timezone": "UTC",
},
"lang en_US.UTF-8\nkeyboard us\ntimezone UTC",
),
(
{
"ostree": {
"osname": "some-osname",
"url": "http://some-ostree-url.com/foo",
"ref": "some-ref",
"remote": "some-remote",
"gpg": True,
},
"liveimg": {
"url": "some-liveimg-url",
},
"groups": {
"somegrp": {
"gid": 2337,
},
},
"users": {
"someusr": {
"uid": 1337,
"gid": 1337,
"groups": [
"grp1",
"grp2",
],
"home": "/other/home/someusr",
"shell": "/bin/ksh",
"password": "$1$notreally",
"key": "ssh-rsa not-really-a-real-key",
},
},
},
"ostreesetup --osname=some-osname --url=http://some-ostree-url.com/foo --ref=some-ref --remote=some-remote\n"
+ "liveimg --url some-liveimg-url\ngroup --name somegrp --gid 2337\n"
+ "user --name someusr --password $1$notreally --iscrypted --shell /bin/ksh --uid 1337 --gid 1337 --groups grp1,grp2 --homedir /other/home/someusr\n"
+ 'sshkey --username someusr "ssh-rsa not-really-a-real-key"',
),
({"zerombr": "true"}, "zerombr"),
({"clearpart": {"all": True}}, "clearpart --all"),
({"clearpart": {"drives": ["hda", "hdb"]}}, "clearpart --drives=hda,hdb",),
(
{"clearpart": {"drives": ["hda", "hdb"]}},
"clearpart --drives=hda,hdb",
),
({"clearpart": {"drives": ["hda"]}}, "clearpart --drives=hda"),
({"clearpart": {"list": ["sda2", "sda3"]}}, "clearpart --list=sda2,sda3"),
({"clearpart": {"list": ["sda2"]}}, "clearpart --list=sda2"),
({"clearpart": {"disklabel": "some-label"}},
"clearpart --disklabel=some-label",
),
(
{"clearpart": {"disklabel": "some-label"}},
"clearpart --disklabel=some-label",
),
({"clearpart": {"linux": True}}, "clearpart --linux"),
({"clearpart": {
"all": True,
"drives": ["hda", "hdb"],
"list": ["sda2", "sda3"],
"disklabel": "some-label",
"linux": True,
},
},
"clearpart --all --drives=hda,hdb --list=sda2,sda3 --disklabel=some-label --linux"),
({"lang": "en_US.UTF-8",
"keyboard": "us",
"timezone": "UTC",
"zerombr": True,
"clearpart": {
"all": True,
"drives": [
"sd*|hd*|vda",
"/dev/vdc"
]
}
},
(
{
"clearpart": {
"all": True,
"drives": ["hda", "hdb"],
"list": ["sda2", "sda3"],
"disklabel": "some-label",
"linux": True,
},
},
"clearpart --all --drives=hda,hdb --list=sda2,sda3 --disklabel=some-label --linux",
),
(
{
"lang": "en_US.UTF-8",
"keyboard": "us",
"timezone": "UTC",
"zerombr": True,
"clearpart": {"all": True, "drives": ["sd*|hd*|vda", "/dev/vdc"]},
},
"lang en_US.UTF-8\nkeyboard us\ntimezone UTC\nzerombr\nclearpart --all --drives=sd*|hd*|vda,/dev/vdc",
),
),
# no reboot for an empty dict
({"reboot": True}, "reboot"),
({"reboot": {"eject": False}}, "reboot"),
({"reboot": {"eject": True}}, "reboot --eject"),
({"reboot": {"kexec": False}}, "reboot"),
({"reboot": {"kexec": True}}, "reboot --kexec"),
({"reboot": {"eject": True, "kexec": True}}, "reboot --eject --kexec"),
])
def test_kickstart(tmp_path, test_input, expected):
]


@pytest.mark.parametrize("test_input,expected", TEST_INPUT)
def test_kickstart_write(tmp_path, test_input, expected):
ks_stage_path = os.path.join(os.path.dirname(__file__), "../org.osbuild.kickstart")
ks_stage = import_module_from_path("ks_stage", ks_stage_path)

Expand All @@ -110,33 +120,50 @@ def test_kickstart(tmp_path, test_input, expected):
ks_content = fp.read()
assert ks_content == expected + "\n"

# double check with pykickstart if the file looks valid
if expected:
subprocess.check_call(["ksvalidator", ks_path])


@pytest.mark.parametrize("test_data,expected_err", [
# BAD pattern, ensure some obvious ways to write arbitrary
# kickstart files will not work
({"clearpart": {}}, "{} is not valid "),
({"clearpart": {"disklabel": r"\n%pre\necho p0wnd"}}, r"p0wnd' does not match"),
({"clearpart": {"drives": [" --spaces-dashes-not-allowed"]}}, "' --spaces-dashes-not-allowed' does not match"),
({"clearpart": {"drives": ["\n%pre not allowed"]}}, "not allowed' does not match"),
({"clearpart": {"drives": ["no,comma"]}}, "no,comma' does not match"),
({"clearpart": {"list": ["\n%pre not allowed"]}}, "not allowed' does not match"),
({"clearpart": {"list": ["no,comma"]}}, "no,comma' does not match"),
({"clearpart": {"disklabel": "\n%pre not allowed"}}, "not allowed' does not match"),
# schema ensures reboot has at least one option set
({"reboot": {}}, "{} is not valid under any of the given schemas"),
({"reboot": "random-string"}, "'random-string' is not valid "),
({"reboot": {"random": "option"}}, "{'random': 'option'} is not valid "),
# GOOD pattern we want to keep working
({"clearpart": {"drives": ["sd*|hd*|vda", "/dev/vdc"]}}, ""),
({"clearpart": {"drives": ["disk/by-id/scsi-58095BEC5510947BE8C0360F604351918"]}}, ""),
({"clearpart": {"list": ["sda2", "sda3", "sdb1"]}}, ""),
({"reboot": True}, ""),
({"reboot": {"kexec": False}}, ""),
])

@pytest.mark.skipif(not has_executable("ksvalidator"), reason="`ksvalidator` is required")
@pytest.mark.parametrize("test_input,expected", TEST_INPUT)
def test_kickstart_valid(tmp_path, test_input, expected): # pylint: disable=unused-argument
ks_stage_path = os.path.join(os.path.dirname(__file__), "../org.osbuild.kickstart")
ks_stage = import_module_from_path("ks_stage", ks_stage_path)

ks_path = "kickstart/kfs.cfg"
options = {"path": ks_path}
options.update(test_input)

ks_stage.main(tmp_path, options)

ks_path = os.path.join(tmp_path, ks_path)

# check with pykickstart if the file looks valid
subprocess.check_call(["ksvalidator", ks_path])


@pytest.mark.parametrize(
"test_data,expected_err",
[
# BAD pattern, ensure some obvious ways to write arbitrary
# kickstart files will not work
({"clearpart": {}}, "{} is not valid "),
({"clearpart": {"disklabel": r"\n%pre\necho p0wnd"}}, r"p0wnd' does not match"),
({"clearpart": {"drives": [" --spaces-dashes-not-allowed"]}}, "' --spaces-dashes-not-allowed' does not match"),
({"clearpart": {"drives": ["\n%pre not allowed"]}}, "not allowed' does not match"),
({"clearpart": {"drives": ["no,comma"]}}, "no,comma' does not match"),
({"clearpart": {"list": ["\n%pre not allowed"]}}, "not allowed' does not match"),
({"clearpart": {"list": ["no,comma"]}}, "no,comma' does not match"),
({"clearpart": {"disklabel": "\n%pre not allowed"}}, "not allowed' does not match"),
# schema ensures reboot has at least one option set
({"reboot": {}}, "{} is not valid under any of the given schemas"),
({"reboot": "random-string"}, "'random-string' is not valid "),
({"reboot": {"random": "option"}}, "{'random': 'option'} is not valid "),
# GOOD pattern we want to keep working
({"clearpart": {"drives": ["sd*|hd*|vda", "/dev/vdc"]}}, ""),
({"clearpart": {"drives": ["disk/by-id/scsi-58095BEC5510947BE8C0360F604351918"]}}, ""),
({"clearpart": {"list": ["sda2", "sda3", "sdb1"]}}, ""),
({"reboot": True}, ""),
({"reboot": {"kexec": False}}, ""),
],
)
def test_schema_validation_smoke(test_data, expected_err):
name = "org.osbuild.kickstart"
root = os.path.join(os.path.dirname(__file__), "../..")
Expand All @@ -147,7 +174,7 @@ def test_schema_validation_smoke(test_data, expected_err):
"name": "org.osbuild.kickstart",
"options": {
"path": "some-path",
}
},
}
test_input["options"].update(test_data)
res = schema.validate(test_input)
Expand Down

0 comments on commit 910a4b5

Please sign in to comment.