Skip to content

Latest commit

 

History

History
112 lines (91 loc) · 4.08 KB

intended_behavior.md

File metadata and controls

112 lines (91 loc) · 4.08 KB

Intended Behavior

A less exhaustive version of Manual Testing

Smoke test checklist (Ubuntu)

Keep this synchronized with the Linux GUI docs in /website/src/app/kb/client-apps/linux-gui-client

Best performed on a clean VM

  1. Run scripts/firezone-client-gui-install.sh
  2. Expect "Reboot to finish..." message
  3. Run the Firezone GUI
  4. Expect an error saying that you are not a member of the group firezone-client
  5. Reboot
  6. Expect groups to include "firezone-client"
  7. Run the Firezone GUI
  8. Expect the "Welcome to Firezone." screen
  9. Open the Settings window and change to staging if needed
  10. Click "Sign in"
  11. Expect a browser to open
  12. Disable DoH in Firefox if needed (20.04 and 22.04 both have it, in different places) https://www.firezone.dev/kb/administer/troubleshooting#some-browsers-break-dns-routing
  13. Sign in
  14. Expect Firefox to show "Allow this site to open the link with Firezone?" modal
  15. Check "Always..." and click "Open link"
  16. Expect a keyring dialog to pop up
  17. Enter 'password' for testing purposes
  18. Expect "Firezone connected" notification
  19. Browse to https://ifconfig.net
  20. Expect to see the gateway's IP and location
  21. Quit Firezone
  22. Refresh the page
  23. Expect to see your own IP and location
  24. Reboot
  25. Run the Firezone GUI
  26. Expect a keyring dialog to pop up
  27. Enter 'password' to unlock the stored token
  28. Expect "Firezone connected" notification
  29. Check the IP again, expect the gateway's IP
  30. Sign out of Firezone without quitting
  31. Check the IP again, expect your own IP (Checks for regressions in #5828)
  32. Export the logs
  33. Expect the zip file to start with firezone_logs_
  34. Expect zipinfo to show a single directory in the root of the zip, to prevent zip bombing
  35. Expect two subdirectories in the zip, "connlib", and "app", with 3 and 2 files respectively, totalling 5 files

Smoke test checklist (Windows)

Keep this synchronized with the Windows GUI docs in /website/src/app/kb/client-apps/windows-client

x86_64 only, see issue #2992. Best performed on a clean VM.

  1. Run the MSI installer and ensure "Launch Firezone" is checked at the end
  2. Expect the "Welcome to Firezone." screen
  3. Right-click on the Windows taskbar and configure it to show the Firezone icon
  4. Open the Settings window and change to staging if needed
  5. Click "Sign in"
  6. Expect a browser to open
  7. Sign in
  8. Expect the browser to show "This site is trying to open Firezone." modal
  9. Check "Always allow..." and click "Open"
  10. Expect "Firezone connected" notification
  11. Browse to https://ifconfig.net
  12. Expect to see the gateway's IP and location
  13. Quit Firezone
  14. Refresh the page
  15. Expect to see your own IP and location
  16. Reboot
  17. Browse to https://ifconfig.net (For issue #4899)
  18. Expect to see your own IP and location
  19. Run the Firezone GUI
  20. Expect "Firezone connected" notification
  21. Check the IP again, expect the gateway's IP
  22. Sign out of Firezone without quitting
  23. Check the IP again, expect your own IP (Checks for regressions in #5828)
  24. Export the logs
  25. Expect the zip file to start with firezone_logs_
  26. Expect the zip to contain a single directory in the root of the zip, to prevent zip bombing
  27. Expect two subdirectories in the zip, "connlib", and "app", with 2 files each, totalling 4 files

Upgrade checklist (Linux)

  1. Close the Firezone GUI
  2. Run scripts/firezone-client-gui-install.sh $NEW_DEB
  3. Run the Firezone GUI

Upgrade checklist (Windows)

  1. Close the Firezone GUI
  2. Run the new MSI
  3. Run the Firezone GUI

Un-install checklist (Linux)

  1. Close the Firezone GUI
  2. Run sudo apt-get remove firezone-client-gui

Un-install checklist (Windows)

  1. Quit the Firezone GUI
  2. Go to "Add or Remove Programs"
  3. Search for Firezone and click "Uninstall"

Settings tab

  • Pressing Enter on a text field immediately saves and applies the settings
  • Log level changes take effect on the next app start
  • Auth base URL and API URL changes take effect on the next sign-in

Refs: