@nextcloud/e2e-test-server

Nextcloud e2e test server and utils for cypress and playwright.

Automatically start a docker container providing a Nextcloud instance for testing.

Status

This package is currently work in progress and will change significantly until version 1.0. In particular cypress specific utils such as selectors will be dropped unless they are widely used.

Starting Nextcloud Docker container

Playwright

1. Copy playwright.config.mjs and playwright folder from this repository!
2. Add the @playwright/test dependency:

  npm install --save-dev '@playwright/test'
Copy

3. Add the start:nextcloud script to your package.json

  {
    "start:nextcloud": "node playwright/start-nextcloud-server.mjs",
  }
Copy

4. Install chromium for playwright:

  npx playwright install chromium --only-shell
Copy

5. Run playwright tests:

  npx playwright test
Copy

6. Add .github/workflows/playwright.yml to your repository!
7. Write your own tests!

Cypress

You can use the cypress folder and the cypress.config.ts in this repository as starting points or adjust your cypress.config.ts (or .js):

import { configureNextcloud,  startNextcloud,  stopNextcloud, waitOnNextcloud } from '@nextcloud/e2e-test-server'

export default defineConfig({
// ...
	e2e: {
		// other configuration

		setupNodeEvents(on, config) {
			// Remove container after run
			on('after:run', () => {
				stopNextcloud()
			})

			// starting Nextcloud testing container with specified server branch
			return startNextcloud(process.env.BRANCH)
				.then((ip) => {
					// Setting container's IP as base Url
					config.baseUrl = `http://${ip}/index.php`
					return ip
				})
				.then(waitOnNextcloud)
				// configure Nextcloud, also install and enable the `viewer` app
				.then(() => configureNextcloud(['viewer']))
				.then(() => {
					return config
				})
		},
	},
})
Copy

Cypress commands

You can import individual commands or all at once You can find the list of all available commands here

// cypress/support/commands.js
import { addCommands } from '@nextcloud/e2e-test-server/cypress'

addCommands()
Copy

// cypress/support/commands.js
import { login } from '@nextcloud/e2e-test-server/commands'

Cypress.Commands.add('login', login)
Copy

Selectors (:warn: deprecated)

You can find the list of all available selectors here

import { UploadPicker as UploadPickerComponent} from '../../dist/index.js'
import { UploadPicker, UploadPickerInput } from '@nextcloud/cypress/selectors'

describe('UploadPicker rendering', () => {
	it('Renders default UploadPicker', () => {
		cy.mount(UploadPickerComponent)
		cy.getNc(UploadPicker).should('exist')
			.should('have.class', 'upload-picker')
		cy.getNc(UploadPickerInput).should('exist')
	})
})
Copy