Skip to content

Add TestDriver sample tests for the easydocs docs site - #22

Open
testdriverai[bot] wants to merge 1 commit into
mainfrom
testdriver/add-testdriver-sample-tests-for-the-easydocs-doc
Open

Add TestDriver sample tests for the easydocs docs site#22
testdriverai[bot] wants to merge 1 commit into
mainfrom
testdriver/add-testdriver-sample-tests-for-the-easydocs-doc

Conversation

@testdriverai

@testdriverai testdriverai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Closes #20.

Sets up TestDriver in this repo with three short, passing sample tests. All 3 pass against the live target.

Target: the published documentation site

easydocs is a self-hostable app — you install it with docker compose up, so there is no public/hosted "production" instance of the app itself to drive, and no example credentials exist for one. The one publicly deployed production surface for this project is the documentation site published from this repo via GitHub Pages:

https://robertzu43.github.io/easydocs/

So these samples target that live site. They're intentionally short and stable — good starting points to copy from. (When you have a hosted app instance, or want tests to run the full stack, these can be repointed at it and extended to cover register/login/upload/branch/merge.)

What the tests cover

Test What it checks
tests/testdriver/docs-home.test.mjs The production docs home page loads with the easydocs heading and the ".docx history" tagline
tests/testdriver/docs-navigation.test.mjs The left-nav "Getting started" link navigates to the setup guide
tests/testdriver/docs-search.test.mjs The header search returns matching documents for a query

Test recordings (all ✅)

Home page loads with heading + tagline
Recording
📊 Report

Navigate to "Getting started"
Recording
📊 Report

Docs search returns results
Recording
📊 Report

Full run: https://console-test.testdriver.ai/runs/6a6ef1c89d180790099e49a23/3 passed.

Setup notes

  • npx testdriverai init scaffolded vitest.config.mjs, package.json, and .github/workflows/testdriver.yml.
  • vitest.config.mjs sets include: ['tests/testdriver/**/*.test.mjs'] so vitest runs only these TestDriver tests and stays out of the existing tests/EasyDocs.Api.Tests/ .NET project.
  • Run locally: npx vitest run.

Running in CI (recommended: OIDC, no stored secret)

The included workflow uses testdriverai/action. The recommended way to authenticate is GitHub OIDC — authorize the TestDriver GitHub App for the org once (https://console.testdriver.ai) and the action mints/exchanges a token at run time, so there's no TD_API_KEY secret to add or rotate. A stored TD_API_KEY repo secret is only needed as a fallback on runners without OIDC.

@testdriverai testdriverai Bot mentioned this pull request Aug 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Set up TestDriver

0 participants