{"id":18368646,"url":"https://github.com/openbmc/openbmc-test-automation","last_synced_at":"2025-04-10T19:38:30.407Z","repository":{"id":40680484,"uuid":"48249308","full_name":"openbmc/openbmc-test-automation","owner":"openbmc","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-01T18:38:56.000Z","size":38939,"stargazers_count":114,"open_issues_count":15,"forks_count":96,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-04-01T19:42:15.403Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"RobotFramework","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openbmc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security/test_bmc_connections.robot","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-18T18:07:38.000Z","updated_at":"2025-04-01T18:39:00.000Z","dependencies_parsed_at":"2023-02-18T05:30:45.297Z","dependency_job_id":"91d12c4c-c722-43f4-84e0-d96c22b2cd11","html_url":"https://github.com/openbmc/openbmc-test-automation","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fopenbmc-test-automation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fopenbmc-test-automation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fopenbmc-test-automation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbmc%2Fopenbmc-test-automation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openbmc","download_url":"https://codeload.github.com/openbmc/openbmc-test-automation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248281427,"owners_count":21077423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T23:26:50.853Z","updated_at":"2025-04-10T19:38:30.398Z","avatar_url":"https://github.com/openbmc.png","language":"RobotFramework","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Features of OpenBMC Test Automation\n\n**Interface Feature List**\n\n- DMTF Redfish\n- Out-of-band IPMI\n- SSH to BMC and Host OS\n- [Legacy REST](https://github.com/openbmc/openbmc-test-automation/releases/tag/v4.0-stable)\n\n**Key Feature List**\n\n- Power on/off\n- Reboot Host\n- Reset BMC\n- Code update BMC and host\n- Power management\n- Fan controller\n- HTX bootme\n- XCAT execution\n- Network\n- IPMI support (generic and DCMI compliant)\n- Factory reset\n- RAS (Reliability, availability and serviceability)\n- Web UI testing\n- Secure boot\n- SNMP (Simple Network Management Protocol)\n- Remote Logging via Rsyslog\n- LDAP (Lightweight Directory Access Protocol)\n- Certificate\n- Local User Management(Redfish/IPMI)\n- DateTime\n- Event Logging\n- PLDM (Platform Level Data Model) via pldmtool\n\n**Debugging Supported List**\n\n- SOL collection\n- FFDC collection\n- Error injection from host\n\n## Installation Setup Guide\n\n- [Robot Framework Install Instruction](https://github.com/robotframework/robotframework/blob/master/INSTALL.rst)\n\n- Miscellaneous Packages required to be installed for OpenBmc Automation.\n  Install the packages and it's dependencies via `pip`\n\nIf using Python 3.x, use the corresponding `pip3` to install packages. Note:\nOlder Python 2.x is not actively supported.\n\nInstalling requirement dependencies:\n\n```\n    $ pip install -r requirements.txt\n```\n\nOptional packages but required for `redfish/dmtf_tools/`\n\n```\n    $ pip install -r requirements_optional.txt\n```\n\nyou'll find this file once your clone openbmc-test-automation repository.\n\nFor Web UI ( GUI ) Testing setup, please the follow instructions mentioned in\nthe OpenBMC GUI Test Setup Guide. Note: GUI test cases under `gui/` will not\nwork without the above setup completed in your environment.\n[OpenBMC GUI Test Setup Guide](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/gui_setup_reference.md)\n\nInstalling tox:\n\n```\n    $ pip install -U tox\n```\n\nInstalling expect (Ubuntu example):\n\n```\n    $ sudo apt-get install expect\n```\n\n## OpenBMC Test Development\n\nThese documents contain details on developing OpenBMC test code and debugging.\n\n- [MAINTAINERS](OWNERS): OpenBMC test code maintainers information.\n- [CONTRIBUTING.md](CONTRIBUTING.md): Coding guidelines.\n- [Code Check Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_standards_check.md):\n  To check common code misspellings, syntax and standard checks.\n- [Redfish Coding Guidelines](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_coding_guidelines.md):\n  Refer for Redfish coding guidelines.\n- [REST-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md):\n  Quick reference for some common curl commands required for legacy REST\n  testing.\n- [REDFISH-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md):\n  Quick reference for some common curl commands required for redfish testing.\n- [README.md](https://github.com/openbmc/webui-vue/blob/master/README.md): Web\n  UI setup reference.\n- [Redfish Request Via mTLS](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/redfish_request_via_mTLS.md):\n  Reference for Redfish Request Via mTLS .\n- [Corporate CLA and Individual CLA](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server):\n  Submitting changes via Gerrit server\n\n## OpenBMC Test Documentation\n\n- [OpenBMC Test Architecture](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_architecture.md):\n  Reference for OpenBMC Test Architecture.\n- [Tools](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_tools.md):\n  Reference information for helper tools.\n- [Code Update](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/code_update.md):\n  Currently supported BMC and PNOR update.\n- [Certificate Generate](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/certificate_generate.md):\n  Steps to create and install CA signed certificate.\n- [Boot Test](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/boot_test.md):\n  Boot test for OpenBMC.\n\n## Supported Systems Architecture\n\nOpenBMC test infrastructure is proven capable of running on:\n\n- POWER\n- x86 systems running OpenBMC firmware stack.\n\n## Testing Setup Steps\n\nTo verify the installation setup is completed and ready to execute.\n\n- Download the openbmc-test-automation repository:\n\n  ```\n  $ git clone https://github.com/openbmc/openbmc-test-automation\n  $ cd openbmc-test-automation\n  ```\n\n- Execute basic setup test run:\n\n  ```\n  $ robot -v OPENBMC_HOST:xx.xx.xx.xx templates/test_openbmc_setup.robot\n  ```\n\n  where xx.xx.xx.xx is the BMC hostname or IP.\n\n## Test Layout\n\nThere are several sub-directories within the openbmc-test-automation base which\ncontain test suites, tools, templates, etc. These sub-directories are classified\nas follows:\n\n`docs/`: Contains the documentation related to OpenBMC.\n\n`redfish/`: Contains the general test cases for OpenBMC stack functional\nverification.\n\n`systest/`: Contains test cases for HTX bootme testing.\n\n`xcat/`: Contains test cases for XCAT automation.\n\n`gui/test/`: Contains test cases for testing web-based interface built on\nAngularJS.\n\n`gui/gui_test/`: Contains test cases for testing web-based user interface built\non Vue.js.\n\n`pldm/`: Contains test cases for platform management subsystem (base, bios, fru,\nplatform, OEM).\n\n`snmp/`: Contains test cases for SNMP (Simple Network Management Protocol)\nconfiguration testing.\n\n`openpower/`: Contains test cases for an OpenPOWER based system.\n\n`tools/`: Contains various tools.\n\n`templates/`: Contains sample code examples and setup testing.\n\n`test_list/`: Contains the argument files used for skipping test cases (e.g\n\"skip_test\", \"skip_test_extended\", etc.) or grouping them (e.g \"HW_CI\",\n\"CT_basic_run\", etc.).\n\n## Redfish Test Layout\n\nOpenBMC is moving steadily towards DTMF Redfish, which is an open industry\nstandard specification and schema that meets the expectations of end users for\nsimple, modern and secure management of scalable platform hardware.\n\n`redfish/`: Contains test cases for DMTF Redfish-related feature supported on\nOpenBMC.\n\n`redfish/extended/`: Contains test cases for combined DMTF Redfish-related\nfeature supported on OpenBMC. Some of the test will be deprecated.\n\nNote: Work in progress test development parameter\n`-v REDFISH_SUPPORT_TRANS_STATE:1` to force the test suites to execute in\nredfish mode only.\n\n## Quickstart\n\nTo run openbmc-automation first you need to install the prerequisite Python\npackages which will help to invoke tests through tox (Note that tox version\n2.3.1 or greater is required) or via Robot CLI command.\n\n**Robot Command Line**\n\n- Execute all test suites for `tests/`:\n\n  ```\n  $ robot -v OPENBMC_HOST:xx.xx.xx.xx  tests\n  ```\n\n- Execute a test suite:\n\n  ```\n  $ robot -v OPENBMC_HOST:xx.xx.xx.xx redfish/extended/test_basic_ci.robot\n  ```\n\n- Initialize the following test variables which will be used during test\n  execution:\n\n  User can forward declare as environment variables:\n\n  ```\n  $ export OPENBMC_HOST=\u003copenbmc machine IP address/hostname\u003e\n  $ export OPENBMC_USERNAME=\u003copenbmc username\u003e\n  $ export OPENBMC_PASSWORD=\u003copenbmc password\u003e\n  $ export IPMI_COMMAND=\u003cDbus/External\u003e\n  $ export REST_USERNAME=\u003cREST interface username\u003e\n  $ export REST_PASSWORD=\u003cREST interface password\u003e\n  ```\n\n  or\n\n  User can input as robot variables as part of the CLI command:\n\n  ```\n  -v OPENBMC_HOST:\u003copenbmc machine IP address/hostname\u003e\n  -v OPENBMC_USERNAME:\u003copenbmc username\u003e\n  -v OPENBMC_PASSWORD:\u003copenbmc password\u003e\n  ```\n\n- Testing in qemu:\n\n  Set extra environment variables:\n\n  ```\n  $ export SSH_PORT=\u003cssh port number\u003e\n  $ export HTTPS_PORT=\u003chttps port number\u003e\n  ```\n\n  Run the QEMU CI test suite (not all tests will pass in qemu):\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x SSH_PORT=\u003cport number\u003e HTTPS_PORT=\u003cport number\u003e robot -A test_lists/QEMU_CI tests/\n  ```\n\n- Run tests:\n\n  ```\n  $ tox tests\n  ```\n\n- How to run an individual test:\n\n  ```\n  $ tox -e default -- --include Power_On_Test  tests/test_basic_poweron.robot\n  ```\n\n- No preset environment variables, default configuration for all supported\n  systems:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- tests\n  ```\n\n- No preset environment variables, one test case from a test suite:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot\n  ```\n\n- No preset environment variables, the entire test suite:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- tests\n  ```\n\n- No preset environment variables, the entire test suite excluding test cases\n  using argument file:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/skip_test tests\n  ```\n\n- Exclude test list for supported systems:\n\n  ```\n  Palmetto:  test_lists/skip_test_palmetto\n  Witherspoon:  test_lists/skip_test_witherspoon\n  ```\n\n  Using the exclude lists (example for Witherspoon)\n\n  ```\n  $ robot -v OPENBMC_HOST:xx.xx.xx.xx -A test_lists/skip_test_witherspoon tests/\n  ```\n\n- Run IPMI tests:\n\n  Running only out-of-band IPMI tests:\n\n  ```\n  $ robot -v IPMI_COMMAND:External -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/witherspoon/skip_inband_ipmi tests/ipmi/\n  ```\n\n  Running only inband IPMI tests:\n\n  ```\n  $ robot -v IPMI_COMMAND:Inband -v OPENBMC_HOST:x.x.x.x -v OS_HOST:x.x.x.x -v OS_USERNAME:xxxx -v OS_PASSWORD:xxxx --argumentfile test_lists/witherspoon/skip_oob_ipmi tests/ipmi/\n  ```\n\n- Run GUI tests:\n\n  By default, GUI runs with Firefox browser and headless mode. Example with\n  Chrome browser and header mode:\n\n  ```\n  $ robot -v OPENBMC_HOST:x.x.x.x -v GUI_BROWSER:gc -v GUI_MODE:header gui/test/\n  ```\n\n  Run GUI default CI test bucket:\n\n  ```\n  $ robot -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/BMC_WEB_CI gui/test/\n  ```\n\n- Run LDAP tests:\n\n  Before using LDAP test functions, be sure appropriate LDAP user(s) and\n  group(s) have been created on your LDAP server. Note: There are multiple ways\n  to create LDAP users / groups and all depend on your LDAP server. One common\n  way for openldap is ldapadd / ldapmodify refer\n  https://linux.die.net/man/1/ldapadd For ldapsearch, refer to\n  \"https://linux.die.net/man/1/ldapsearch\". Microsoft ADS: refer to\n  https://searchwindowsserver.techtarget.com/definition/Microsoft-Active-Directory-Domain-Services-AD-DS\n\n  Note: Currently, LDAP test automation for Redfish API is in progress. The\n  format to invoke LDAP test is as follows:\n\n  ```\n  $ cd redfish/account_service/\n  $ robot -v OPENBMC_HOST:x.x.x.x -v LDAP_SERVER_URI:\u003cldap(s)//LDAP Hostname / IP\u003e -v LDAP_BIND_DN:\u003cLDAP Bind DN\u003e -v LDAP_BASE_DN:\u003cLDAP Base DN\u003e -v LDAP_BIND_DN_PASSWORD:\u003cLDAP Bind password\u003e -v LDAP_SEARCH_SCOPE:\u003cLDAP search scope\u003e -v LDAP_SERVER_TYPE:\u003cLDAP server type\u003e -v LDAP_USER:\u003cLDAP user-id\u003e -v LDAP_USER_PASSWORD:\u003cLDAP PASSWORD\u003e -v GROUP_NAME:\u003cGroup Name\u003e -v GROUP_PRIVILEGE:\u003cPrivilege\u003e  ./test_ldap_configuration.robot\n  ```\n\n- How to run CI and CT bucket test:\n\n  Default CI test bucket list:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests\n  ```\n\n  Default CI smoke test bucket list:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/CT_basic_run tests\n  ```\n\n- Run extended tests:\n\n  For-loop test (default iteration is 10):\n\n  ```\n  $ robot -v OPENBMC_HOST:x.x.x.x -v OPENBMC_SYSTEMMODEL:xxxxxx -v ITERATION:n -v LOOP_TEST_COMMAND:xxxxxx extended/full_suite_regression.robot\n  ```\n\n  Example using tox testing a test suite for 5 iterations \"witherspoon\":\n\n  ```\n  OPENBMC_HOST=x.x.x.x  LOOP_TEST_COMMAND=\"tests/test_fw_version.robot\" ITERATION=5 OPENBMC_SYSTEMMODEL=witherspoon tox -e witherspoon -- ./extended/full_suite_regression.robot\n  ```\n\n- Host CPU architecture\n\n  By default openbmc-test-automation framework assumes that host CPU is based on\n  the POWER architecture. If your host CPU is x86 add\n  `-v PLATFORM_ARCH_TYPE:x86` variable setting to your CLI commands or set an\n  environment variable:\n\n  ```\n  $ export PLATFORM_ARCH_TYPE=x86\n  ```\n\n**Jenkins jobs tox commands**\n\n- HW CI tox command:\n\n  ```\n  $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbmc%2Fopenbmc-test-automation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbmc%2Fopenbmc-test-automation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbmc%2Fopenbmc-test-automation/lists"}