xref: /openbmc/u-boot/test/py/tests/test_gpt.py (revision 32f11829) 
1# Copyright (c) 2017 Alison Chaiken
2# Copyright (c) 2017, NVIDIA CORPORATION. All rights reserved.
3#
4# SPDX-License-Identifier: GPL-2.0
5
6# Test GPT manipulation commands.
7
8import os
9import pytest
10import u_boot_utils
11
12"""
13These tests rely on a 4 MB disk image, which is automatically created by
14the test.
15"""
16
17class GptTestDiskImage(object):
18    """Disk Image used by the GPT tests."""
19
20    def __init__(self, u_boot_console):
21        """Initialize a new GptTestDiskImage object.
22
23        Args:
24            u_boot_console: A U-Boot console.
25
26        Returns:
27            Nothing.
28        """
29
30        filename = 'test_gpt_disk_image.bin'
31        self.path = u_boot_console.config.persistent_data_dir + '/' + filename
32
33        if os.path.exists(self.path):
34            u_boot_console.log.action('Disk image file ' + self.path +
35                ' already exists')
36        else:
37            u_boot_console.log.action('Generating ' + self.path)
38            fd = os.open(self.path, os.O_RDWR | os.O_CREAT)
39            os.ftruncate(fd, 4194304)
40            os.close(fd)
41            cmd = ('sgdisk', '-U', '375a56f7-d6c9-4e81-b5f0-09d41ca89efe',
42                self.path)
43            u_boot_utils.run_and_log(u_boot_console, cmd)
44            cmd = ('sgdisk', '--new=1:2048:2560', self.path)
45            u_boot_utils.run_and_log(u_boot_console, cmd)
46            cmd = ('sgdisk', '--new=2:4096:4608', self.path)
47            u_boot_utils.run_and_log(u_boot_console, cmd)
48            cmd = ('sgdisk', '-l', self.path)
49            u_boot_utils.run_and_log(u_boot_console, cmd)
50
51gtdi = None
52@pytest.fixture(scope='function')
53def state_disk_image(u_boot_console):
54    """pytest fixture to provide a GptTestDiskImage object to tests.
55    This is function-scoped because it uses u_boot_console, which is also
56    function-scoped. However, we don't need to actually do any function-scope
57    work, so this simply returns the same object over and over each time."""
58
59    global gtdi
60    if not gtdi:
61        gtdi = GptTestDiskImage(u_boot_console)
62    return gtdi
63
64@pytest.mark.boardspec('sandbox')
65@pytest.mark.buildconfigspec('cmd_gpt')
66@pytest.mark.requiredtool('sgdisk')
67def test_gpt_guid(state_disk_image, u_boot_console):
68    """Test the gpt guid command."""
69
70    u_boot_console.run_command('host bind 0 ' + state_disk_image.path)
71    output = u_boot_console.run_command('gpt guid host 0')
72    assert '375a56f7-d6c9-4e81-b5f0-09d41ca89efe' in output
73
74@pytest.mark.boardspec('sandbox')
75@pytest.mark.buildconfigspec('cmd_gpt')
76@pytest.mark.requiredtool('sgdisk')
77def test_gpt_save_guid(state_disk_image, u_boot_console):
78    """Test the gpt guid command to save GUID into a string."""
79
80    if u_boot_console.config.buildconfig.get('config_cmd_gpt', 'n') != 'y':
81        pytest.skip('gpt command not supported')
82    u_boot_console.run_command('host bind 0 ' + state_disk_image.path)
83    output = u_boot_console.run_command('gpt guid host 0 newguid')
84    output = u_boot_console.run_command('printenv newguid')
85    assert '375a56f7-d6c9-4e81-b5f0-09d41ca89efe' in output
86
87@pytest.mark.boardspec('sandbox')
88@pytest.mark.buildconfigspec('cmd_gpt')
89@pytest.mark.buildconfigspec('cmd_gpt_rename')
90@pytest.mark.requiredtool('sgdisk')
91def test_gpt_rename_partition(state_disk_image, u_boot_console):
92    """Test the gpt rename command to write partition names."""
93
94    u_boot_console.run_command('host bind 0 ' + state_disk_image.path)
95    u_boot_console.run_command('gpt rename host 0 1 first')
96    output = u_boot_console.run_command('gpt read host 0')
97    assert 'name first' in output
98    u_boot_console.run_command('gpt rename host 0 2 second')
99    output = u_boot_console.run_command('gpt read host 0')
100    assert 'name second' in output
101
102@pytest.mark.boardspec('sandbox')
103@pytest.mark.buildconfigspec('cmd_gpt')
104@pytest.mark.buildconfigspec('cmd_gpt_rename')
105@pytest.mark.buildconfigspec('cmd_part')
106@pytest.mark.requiredtool('sgdisk')
107def test_gpt_swap_partitions(state_disk_image, u_boot_console):
108    """Test the gpt swap command to exchange two partition names."""
109
110    u_boot_console.run_command('host bind 0 ' + state_disk_image.path)
111    output = u_boot_console.run_command('part list host 0')
112    assert '0x000007ff	"first"' in output
113    assert '0x000017ff	"second"' in output
114    u_boot_console.run_command('gpt swap host 0 first second')
115    output = u_boot_console.run_command('part list host 0')
116    assert '0x000007ff	"second"' in output
117    assert '0x000017ff	"first"' in output
118