Skip to main content

Useful commands

Whether you are running tests locally or in QIT's cloud, certain CLI commands streamline test execution and reporting. These commands help you list extensions, view test runs and their results, and validate local zip files before testing.

Listing extensions​

If you need to confirm which extensions you have access to, use:

qit extensions

This command shows a table of extensions including their ID and slug. For example:

+----------------+--------------+
| ID             | Slug         |
+----------------+--------------+
| 123            | my-extension |
+----------------+--------------+

This quick reference helps you ensure you have the correct slug when running tests.

Listing test runs​

To see a history of tests you've run and their outcomes:

qit list-tests

This displays a table with run IDs, test types, the WordPress and WooCommerce versions, status, and links to reports. For instance:

+--------+------------+-------+------------+---------+-----------+----------------------+
| Run Id | Test       | WP    | WC         | Status  | Report    | Name/Version         |
+--------+------------+-------+------------+---------+-----------+----------------------+
| 344745 | security   | 6.1.1 | 7.2.2      | warning |           | My Extension (Zip)   |
| 344759 | woo-e2e    | 6.1.1 | 7.2.0-rc.2 | failed  | Available | My Extension (1.0.0) |
+--------+------------+-------+------------+---------+-----------+----------------------+

This helps you quickly find runs that failed or produced warnings and review their details.

Viewing a single test run​

To get detailed information about a specific test run, use:

qit get <run ID>

Replace <run ID> with the numeric ID from qit list-tests. For example:

qit get 344745

Displays info such as:

Run Id              344745
Test Type           security
WordPress Version   6.1.1
WooCommerce Version 7.2.2
Status              warning
Is Development      Yes
Woo Extension       My Extension

If a report is available, it will also show a 'Result Url' linking to more detailed logs and screenshots.

Opening a test report​

For tests that have a detailed report available, you can open it in your browser:

qit open <run ID>

This launches the test's report page, making it easier to review results, download logs, and examine screenshots.

Validating ZIP files​

Before running tests on a local zip, ensure it meets QIT's criteria:

qit woo:validate-zip <path-to-zip-file>

This checks for invalid files (like Thumbs.db, .DS_Store) and ensures the zip is structured correctly. If it passes validation, you can confidently run tests against it:

qit run:e2e my-extension --zip=my-extension.zip

Tips​

  • Combine commands for efficient workflows. For example, after running qit run:woo-e2e my-extension, use qit list-tests to find the run ID, then qit get <run ID> for details.
  • Use qit extensions before running tests if you're unsure of the correct extension slug.
  • Validate zips before testing to avoid issues related to malformed packages.