Skip to main content

E2E Tests

The Tableau MCP project uses Vitest for end-to-end (E2E) testing. E2E tests are located in the tests/e2e directory and are named *.test.ts.

Running​

The E2E tests can only be run:

  1. As part of the CI pipeline.
  2. Locally if you have access to a site the tests understand. Currently, that's only https://10ax.online.tableau.com/#/site/mcp-test/.

To run them locally:

  1. Ensure you do not have a .env file in the root of the project.
  2. Create a tests/.env file with contents:
SERVER=https://10ax.online.tableau.com
SITE_NAME=mcp-test
AUTH=direct-trust
JWT_SUB_CLAIM=<your email address>
CONNECTED_APP_CLIENT_ID=<redacted>
CONNECTED_APP_SECRET_ID=<redacted>
CONNECTED_APP_SECRET_VALUE=<redacted>
  1. Create a tests/.env.reset file with the same contents except all the env var values are empty. (Environment variables get set at the beginning of each test and cleared at the end of each test.)
  2. Run npm run test:e2e or select the vitest.config.e2e.ts config in the Vitest extension and run them from your IDE.

Running the E2E tests against a different site​

To run the E2E tests locally against a different site, you need to:

  1. Have a site that has the Superstore sample datasource and workbook (which exist with every new site). The tests query this datasource and workbook.
  2. Create and enable a Direct Trust Connected App in the site.
  3. Create a Pulse Metric Definition named Tableau MCP. Its details don't matter.
  4. Update the environmentData object in tests/constants.ts with the new site details.
  5. Follow the steps in the Running section, providing these new site details in the tests/.env file.

Debugging​

If you are using VS Code or a fork, you can use the Vitest extension to run and debug the E2E tests.