github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
649c03e2908c797664ded06ef93234312e694cb7
firezone/rust/gui-client/docs/intended_behavior.md
Jamil feb1ec5e17 chore: Update client URLs & redirects for consistency (#8056) 
Whenever changing a URL we care about, we add an entry in
`website/redirects.js` to avoid breaking links to the old page. Most
search engines reindex these after 1 year, but other websites and places
won't, so we should generally keep them indefinitely since they don't
cost us much to keep around.
2025-02-11 03:30:41 +00:00

3.9 KiB
Raw Blame History

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. Sign in
  13. Expect Firefox to show "Allow this site to open the link with Firezone?" modal
  14. Check "Always..." and click "Open link"
  15. Expect a keyring dialog to pop up
  16. Enter 'password' for testing purposes
  17. Expect "Firezone connected" notification
  18. Browse to https://ifconfig.net
  19. Expect to see the gateway's IP and location
  20. Quit Firezone
  21. Refresh the page
  22. Expect to see your own IP and location
  23. Reboot
  24. Run the Firezone GUI
  25. Expect a keyring dialog to pop up
  26. Enter 'password' to unlock the stored token
  27. Expect "Firezone connected" notification
  28. Check the IP again, expect the gateway's IP
  29. Sign out of Firezone without quitting
  30. Check the IP again, expect your own IP (Checks for regressions in https://github.com/firezone/firezone/pull/5828)
  31. Export the logs
  32. Expect the zip file to start with firezone_logs_
  33. Expect zipinfo to show a single directory in the root of the zip, to prevent zip bombing
  34. 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-gui-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 https://github.com/firezone/firezone/pull/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:

Reference in New Issue View Git Blame Copy Permalink