diff --git a/deadlock-plugins/deadlock-extension/docs/README.md b/deadlock-plugins/deadlock-extension/docs/README.md index e5885f73fea2824a160520f17b3dda63947a86ac..0c300bc5b2c3d055e1b583ebc83d5ca8eb7a6f0d 100644 --- a/deadlock-plugins/deadlock-extension/docs/README.md +++ b/deadlock-plugins/deadlock-extension/docs/README.md @@ -46,3 +46,31 @@ The pipeline needs a token from the marketplace in order to publish the extensio - Then the token must be inserted as the value of the CI/CD variables `VSCODE_EXTENSION_MARKET_PLACE_ACCESS_TOKEN` **This token has a maximum lifetime of 1 year** + +--- + +## Details on the use case to be tested + +The use case to be tested to validate a US Deadlock Desktop corresponds to a use scenario. De facto, this scenario should be updated after each release of features. + +Initial configuration: + +- OS: Ubuntu 20.04.4 LTS +- Browser: Mozilla Firefox (v99.0+), Google Chrome (v101.0+) +- Docker version 20.10.14, build a224086 +- Visual Studio Code (v1.66.2+) + +Steps: + +1. Go to https://www.dev.deadlock.io/. The Keycloak authentication home page should appear. +2. Log in via the Google Identity Provider. The user should be authenticated and redirected to the home page. +3. Select and launch a desktop mission. Instructions specific to this type should be displayed on the mission overview page. +4. All links on the mission page should work: dependencies installation, extension page on the Store, and xdg-open link opening VS Code. +5. Once VS Code is open, a popup window should appear, suggesting the installation of the extension. Accept the installation. The installation should be successful, and the welcome to Deadlock notification should appear. +6. Uninstall the extension, restart the IDE, and search for `deadlock` in the `marketplace` search bar. The extension should immediately appear in the first 3 results. Reinstall the extension. +7. Re-click on the xdg-open link. A popup asking for the parent working folder should open. +8. Select a directory that does not pose any access rights problems for the current user. A page on the default browser should open, allowing access to an OAuth Device Flow 2.0 authentication page. +9. Validate the authentication using the Google provider and return to the extension. A login confirmation notification should be visible. +10. Open the extension's home page from the Deadlock panel. The view should be representative of the status (success or failure) of the previously performed tasks. +11. Once authenticated, VS Code should automatically re-open inside a `devcontainer`. The file explorer tree should be mounted to mission root dir +12. Open the embedded terminal. It should have `deadlock` as user and every libs+executables required for the mission should be present (e.g. docker, java, node, ...).