xref: /openbmc/openbmc-test-automation/docs/gui_setup_reference.md (revision 069b266e40a93fda3992c888062745b1ac920473)
1## OpenBMC GUI Test Setup Guide
2
3The base needed packages for Linux distro.
4
5- Python 3.x or latter
6- Robot Framework ( base framework package )
7
8Browser specific packages:
9
10- Mozilla Firefox
11- Robot Framework Selenium Library
12- geckodriver
13- Robotframework xvfb
14- xvfbwrapper
15- Robot Framework AngularJS Library
16
17## Tested On Linux
18
19- RHEL
20- Ubuntu
21
22Last tested packages versions:
23
24```
25    Python                          3.12
26    Selenium                        4.8.2
27    Mozilla Firefox                 112.0.2
28    Robot Framework                 7.2.2
29    robotframework-seleniumlibrary  6.0.0
30    geckodriver                     0.32.2
31    robotframework-xvfb             1.2.2
32    xvfbwrapper                     0.2.9
33    webdriver-manager               4.0.2
34```
35
36## Installation Setup Guide
37
38- Python Installation: Please follow the documented procedure available.
39
40- Firefox Installation: Please follow the documented procedure available.
41
42- geckodriver installation: Please follow the documented procedure available.
43  [Firefox Geckodriver](https://github.com/mozilla/geckodriver/releases)
44
45The recommended installation method is using pip:
46
47```
48    pip install --upgrade robotframework
49    pip install --upgrade robotframework-seleniumlibrary
50    pip install --upgrade xvfbwrapper
51    pip install --upgrade robotframework-xvfb
52    pip install --upgrade robotframework-angularjs
53```
54
55## Geckodriver Supported Platforms
56
57Mapping between geckodriver releases, and required versions of Selenium and
58Firefox:
59[Geckodriver Supported platforms](https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html#supported-platforms)
60