installer-test-matrix.md

Installer Test Matrix Workflows

General Docs

• O3DE Welcome Guide
• O3DE Requirements
• Setup O3DE

Common Issues to Look out For

• Invalid install location (Directory isn't empty)
• Install already exists (side-by-side install not currently supported)

Installer FTUE

First Time User Experience(FTUE):

• Launch O3DE.exe.
• Create and build a new project.
• Launch the O3DE Editor.
• Create a quick sample level.
• Enter Game Mode.

Workflows

Area: Installer Requirements

This area is used to test the Installer Requirements for the Windows Installer & Linux Installer (deb).

Platform Requirements

25/1/2022 - This file contains numerous setup configurations that are recommended to run against each O3DE releases installers.

Windows Requirements

• Microsoft Visual Studio 2019 version 16.9.2 through version 16.11.x are supported with O3DE.
  • This includes manually adding desktop/game development with C++ workloads
• Visual C++ Redistributable for Visual Studio 2019
• CMake 3.20.5 or later

Windows Requirement Alternatives

• Visual Studio 2022

Linux Requirements

• CMake 3.20.5 or later
• Clang 12
• Vulkan Drivers (hardware specific)
• libffi (an older version for Ubuntu, which doesn't currently support the most recent)
• libglu1-mesa-dev
• libxcb-xinerama0
• libxcb-xinput0
• libxcb-xinput-dev
• libxcb-xfixes0-dev
• libxcb-xkb-dev
• libxkbcommon-dev
• libxkbcommon-x11-dev
• libfontconfig1-dev
• libcurl4-openssl-dev
• libsdl2-dev
• zlib1g-dev
• mesa-common-dev

Linux Requirement Alternatives

• Clang 13

Platform Configurations

Test Matrix Generation Data

Note: In all cases where a requirement is intentionally left out or incorrect, the goal is to test for clear error messaging related to the issue (in some cases these errors will happen at the OS level and it may not be in our power to update the error messaging, but these should be recorded for reference/possible Troubleshooting page)

Windows

• Prerequisites are met exactly as written
• No CMake
• No Visual Studio
• No VS 2019 redistributable
• No prerequisites met
• Previous Installer already installed
• Visual Studio 2022 used in place of 2019
• Earlier version of CMake installed (earlier than 3.20.5)
• Visual studio version other than 16.9.2 through version 16.11.x is used (while using 2019, 2022 will inherently be this)

Linux

• Prerequisites are met exactly as written
• No CMake
• No Clang
• Most recent libffi version
• None of the additional libs (these are generally installed all at once)
• No prerequisites met
• Clang 13 used in place of 12
• Earlier version of CMake installed(earlier than 3.20.5)

Installer Requirements Workflows

Scenario	OS	Workflow	Things to Watch For
Prerequisites are fully met	Windows & Linux	If O3DE is not already installed, install all the prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. User is able to complete the FTUE.
CMake isn't installed	Windows & Linux	If CMake is already installed, uninstall CMake. Install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE	O3DE successfully installs in the default location. On Windows User is able to complete the FTUE as CMake is installed under: \cmake\runtime\bin On Linux, while installing O3DE User gets an error message and the installed engine is not functional. Compatible Cmake version is required to perform FTUE.
None of the prerequisites are met	Windows & Linux	If they are already installed, uninstall all the prerequisites found at: O3DE Requirements. To uninstall: See above for the individual items. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. On Windows, User is able to run Project Manager and create a project. On Windows, building the created project results with information about missing supported Visual Studio version. On Linux, while installing O3DE User gets an error message and the installed engine is not functional. Compatible Cmake version is required to perform FTUE.
Previous Installer already installed	Windows & Linux	If previous installer is not already installed, install it. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location (each version has different default location). User is able to complete the FTUE. User is able to run each version of O3DE
CMake version earlier than 3.20.5 is used	Windows & Linux	If cmake version installed is greater than the scenario version, uninstall CMake. Install a version earlier than 3.20.5 if not already installed from CMake Releases. If not already installed, install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. On Windows User is able to complete the FTUE as supported CMake is installed under: \cmake\runtime\bin On Linux, while installing O3DE User gets an error message and the installed engine is not functional. Compatible Cmake version is required to perform FTUE.
Visual Studio isn't installed	Windows	If it is already installed, uninstall Visual Studio. If not already installed, install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. On Windows, User is able to run Project Manager and create a project. On Windows, building the created project results with information about missing supported Visual Studio version.
VS 2019 redistributable isn't installed	Windows	If it is already installed, uninstall VS2019 redistributable. If not already installed, install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. On Windows, User is able to run Project Manager and create a project. On Windows, building the created project results with information about missing supported Visual Studio version.
Visual Studio 2022 used instead of 2019	Windows	If it is already installed, uninstall Visual Studio 2019. Install Visual Studio 2022. If not already installed, install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. User is able to complete the FTUE.
Unsupported Visual Studio version is used (something other than 16.9.2 - 16.11.x)	Windows	If it is already installed, uninstall Visual Studio. Install a version of Visual Studio that falls outside the supported version range. If not already installed, install the remaining prerequisites found at: O3DE Requirements. Install most recent release installer. Run through the Installer FTUE.	O3DE successfully installs in the default location. On Windows, User is able to run Project Manager and create a project. On Windows, building the created project results with information about missing supported Visual Studio version.

---

Area: General Installer

This area will test General Installer Workflows for the Windows Installer, Linux Installer (deb), and Linux Snap Installer.

Project Requirements

• The Windows Installer, Linux Installer (deb), or Linux Snap Installer is present on your machine.
• O3DE Requirements are satisfied on your machine.
• Linux Snapd is installed on your Linux machine.
• Linux Snap Package under test is available on the Snapcraft store.

Product: O3DE is installed and a new project with a sample level has been created.

Suggested Time Box: 2 hours per platform.

General Installer Workflows

Scenario	OS	Workflow	Things to Watch For
Install O3DE in Default Location	Windows Installer & Linux Installer	Download latest Release or Development Installer. Run the Installer. Select Install. Run through the Installer FTUE.	O3DE successfully installs in the default location. User is able to complete the FTUE.
Install O3DE in Custom Location	Windows Installer & Linux Installer	Download latest Release or Development Installer. Run the Installer. Select "Options" and select your non-default install location. Finish Installation. Run through the Installer FTUE.	O3DE successfully installs in the user defined location. User is able to complete the FTUE.
Install O3DE Linux Snap from local file system	Linux Snap Installer	Run the snap installer on the locaL O3DE snap package. sudo snap install /path/to/o3de_<version>_amd64.snap --classic --dangerous The classic flag is required as O3DE is a classic confinement snap, the dangerous is required to install from a file locally. Run through the Installer FTUE.	O3DE successfully installs in the snap installed packages location. User is able to complete the FTUE.
Install O3DE Linux Snap from the Snapcraft Store	Linux Snap Installer	Run the snap installer on the Snapcraft Store O3DE package. sudo snap install o3de Run through the Installer FTUE.	O3DE successfully installs in the snap installed packages location. User is able to complete the FTUE.
Repair O3DE Install	Windows Installer & Linux Installer	O3DE has already been installed on your machine. Corrupt the installation by removing required files. Run the Installer. Use the Installer's Repair functionality. Run through the Installer FTUE.	O3DE successfully repairs the O3DE installation. User is able to complete the FTUE.
Uninstall O3DE	Windows Installer & Linux Installer	With O3DE already installed, launch the installer. Select "Uninstall".	The installer successfully uninstalls O3DE from the previously defined location on disk.

---