Brolendar

Its gonna be great

Deployed Instances

• unstable - current development branch
• stable

Tests

Implement Tests

General

• Tests are implemented with playwright
• Tests are stored in tests/<name>.spec.ts
• Configs for playwright are stored in playwright.config.ts (you probably don't need to touch this)

Writing A New Test

• Create a new file in tests/ called <name>.spec.ts

• Take inspiration by one of the existing tests, for example calendar.spec.ts:

  • You can mostly copy the imports from the top
  • Below that are environment variable imports that define, for example, backend and frontend urls
  • If you want to run some logic before each test, define a test.beforeEach( async ({ page }) => {})
  • In test.describe you can define a number of tests like test("description", async ({ page }) => {})

• Find more information at playwright!

Test Structure

The structure of how tests are grouped is not yet final and might change in the future.

Framework

Fixtures

A fixtures is a page in a specific state. For example, the brolendarPage fixture is logged in with Brolendar and DAV credentials with all events cleared. It uses the Brolendar class for moving between pages and clicking on common buttons.

New fixtures can be added in tests/fixtures/fixtures.ts.

Brolendar Class

The BrolendarClass is defined in /tests/fixtures/brolendar.ts and implements common actions in Brolendar. This includes common selectors and workflows. For example, the login functions loads the /welcome page, enters credentials loaded from .env and loads /calendar.

Any common action a user could do in Brolendar should be implemented here.

Network Calls to Backend

The brolendarPage fixture intercepts all network calls and blocks them by default. Therefore, any calls have to be specified in the test with the intendet status code and body.

Add the following code before the corresponding backend calls to enable the /caldav/sync, /caldav/calendars, and /caldav/events endpoints.

brolendarPage.page.route('**/caldav/sync', route => route.fulfill(
  {
    status: 200,
    body: JSON.stringify({ success: true })
  }
))
brolendarPage.page.route('**/caldav/calendars', route => route.fulfill(
  {
    status: 200,
    headers: headers,
    body: JSON.stringify({
      success: true,
      data: [
        {
          id: "personal",
          writable: true,
          name: "Personal",
          color:"#2F2F2F"
        }
      ]
    })
  }
))

brolendarPage.page.route('**/caldav/events?*', route => route.fulfill(
  {
    status: 200,
    headers: headers,
    body: []
  }
))

The above can also be enabled using brolendarPage.enableDefaultCaldavResponse()

More info can be found here.

Run Tests

With GUI During Implementation

• Run yarn playwright test --ui
• At the top left, click on Projects and activate setup plus at least of of chromium and firefox
• The setup function is cached, meaning you can disable the setup project after the first run. The page state after the login is then restored for each test run

Headless

• Run yarn playwright test --reporter=list
• The reporter is the output format