fleet/.github/ISSUE_TEMPLATE/smoke-tests.md
Luke Heath c5877e47d3
Update release QA to include packs and log destinations (#15814)
...

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2024-01-03 23:38:59 -06:00

5.8 KiB

name about title labels assignees
Release QA Checklist of required tests prior to release

Goal: easy-to-follow test steps for checking a release manually

Fleet version (Head to the "My account" page in the Fleet UI or run fleetctl version):

Web browser (e.g. Chrome 88.0.4324):

Important reference data

  1. fleetctl preview setup
  2. permissions documentation
  3. premium tests require license key (needs renewal) fleetctl preview --license-key=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJGbGVldCBEZXZpY2UgTWFuYWdlbWVudCBJbmMuIiwiZXhwIjoxNjQwOTk1MjAwLCJzdWIiOiJkZXZlbG9wbWVudCIsImRldmljZXMiOjEwMCwibm90ZSI6ImZvciBkZXZlbG9wbWVudCBvbmx5IiwidGllciI6ImJhc2ljIiwiaWF0IjoxNjIyNDI2NTg2fQ.WmZ0kG4seW3IrNvULCHUPBSfFdqj38A_eiXdV_DFunMHechjHbkwtfkf1J6JQJoDyqn8raXpgbdhafDwv3rmDw
  4. premium tests require license key (active - Expires Sunday, January 1, 2023 12:00:00 AM) fleetctl preview --license-key=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJGbGVldCBEZXZpY2UgTWFuYWdlbWVudCBJbmMuIiwiZXhwIjoxNjcyNTMxMjAwLCJzdWIiOiJGbGVldCBEZXZpY2UgTWFuYWdlbWVudCIsImRldmljZXMiOjEwMCwibm90ZSI6ImZvciBkZXZlbG9wbWVudCBvbmx5IiwidGllciI6InByZW1pdW0iLCJpYXQiOjE2NDI1MjIxODF9.EGHQjIzM73YyMbnCruswzg360DEYCsDi9uz48YcDwQHq90BabGT5PIXRiculw79emGj5sk2aKgccTd2hU5J7Jw

Smoke Tests

Smoke tests are limited to core functionality and serve as a pre-release final review. If smoke tests are failing, a release cannot proceed.

Prerequisites

  1. fleetctl preview is set up and running the desired test version using --tag parameters.
  2. Unless you are explicitly testing older browser versions, browser is up to date.
  3. Certificate & flagfile are in place to create new host.
  4. In your browser, clear local storage using devtools.

Instructions

Test nameStep instructionsExpected resultpass/fail
$Name{what a tester should do}{what a tester should see when they do that}pass/fail
Update flow
  1. remove all fleet processes/agents/etc using fleetctl preview reset for a clean slate
  2. run fleetctl preview with no tag for latest stable
  3. create a host/query to later confirm upgrade with
  4. STOP fleet-preview-server instances in containers/apps on Docker
  5. run fleetctl preview with appropriate testing tag
All previously created hosts/queries are verified to still existpass/fail
Login flow
  1. navigate to the login page and attempt to login with both valid and invalid credentials to verify some combination of expected results.
  2. navigate to the login page and attempt to login with both valid and invalid sso credentials to verify expected results.
  1. text fields prompt when blank
  2. correct error message is "authentication failed"
  3. forget password link prompts for email
  4. valid credentials result in a successful login.
  5. valid sso credentials result in a successful login
pass/fail
Query flowCreate, edit, run, and delete queries.
  1. permissions regarding creating/editing/deleting queries are up to date with documentation
  2. syntax errors result in error messaging
  3. queries can be run manually
pass/fail
Host FlowVerify a new host can be added and removed following modal instructions using your own device.
  1. Host is added via command line
  2. Host serial number and date added are accurate
  3. Host is not visible after it is deleted
  4. Warning and informational modals show when expected and make sense
pass/fail
Packs flowVerify management, operation, and logging of ["2017 packs"](https://fleetdm.com/handbook/company/why-this-way#why-does-fleet-support-query-packs).
  1. Packs successfully run on host machines after migrations
  2. New Packs can be created
  3. Packs can be edited and deleted
  4. Packs results information is logged
pass/fail
Log destination flowVerify log destination for software, query, policy, and packs.
  1. Software, query, policy, and packs logs are successfully sent to external log destinations
  2. Software, query, policy, and packs logs are successfully sent to Filesystem log destinations
pass/fail
MDM Smoke TestsVerify MDM enrollments, run commands, and script execution
  1. Erase an ADE-eligible macOS host and verify able to complete auomated enrollment flow.
  2. With Windows MDM turned On, enroll a Windows host and verify MDM is turned On for the host.
  3. Verify able to run a script on all host types from CLI.
  4. Verify scripts library upload/download/delete, run from Host details.
  5. Verify able to run MDM commands on both macOS and Windows hosts from the CLI.
pass/fail
Migration TestVerify Fleet can migrate to the next version with no issues.

Using the migration scripts located in fleet/test/upgrade/

  1. Run the upgrade_test.go script using the most recent stable version of Fleet and main.
  2. Upgrade test returns an 'OK' response.
pass/fail
Release blockersVerify there are no outstanding release blocking tickets.
  1. Check this filter to view all open ~release blocker tickets.
  2. If any are found raise an alarm in the #help-engineering and #help-product-design channels.
pass/fail

Notes

Issues found new to this version:

Issues found that reproduce in last stable version:

What has not been tested:

Include any notes on whether issues should block release or not as needed