xref: /openbmc/openbmc-test-automation/docs/gui_setup_reference.md (revision a68c5ae4f846262b438d77e44b64a3faefa84a91)
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.11.9
26    Mozilla Firefox                 112.0.2
27    Robot Framework                 7.1.1
28    robotframework-seleniumlibrary  6.0.0
29    geckodriver                     0.32.2
30    robotframework-xvfb             1.2.2
31    xvfbwrapper                     0.2.9
32```
33
34## Installation Setup Guide
35
36- Python Installation: Please follow the documented procedure available.
37
38- Firefox Installation: Please follow the documented procedure available.
39
40- geckodriver installation: Please follow the documented procedure available.
41  [Firefox Geckodriver](https://github.com/mozilla/geckodriver/releases)
42
43The recommended installation method is using pip:
44
45```
46    pip install --upgrade robotframework
47    pip install --upgrade robotframework-seleniumlibrary
48    pip install --upgrade xvfbwrapper
49    pip install --upgrade robotframework-xvfb
50    pip install --upgrade robotframework-angularjs
51```
52
53## Geckodriver Supported Platforms
54
55Mapping between geckodriver releases, and required versions of Selenium and
56Firefox:
57[Geckodriver Supported platforms](https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html#supported-platforms)
58