https://github.com/nextcloud-libraries/nextcloud-e2e-test-server
Nextcloud cypress commands, utils and selectors library https://npmjs.org/@nextcloud/cypress
https://github.com/nextcloud-libraries/nextcloud-e2e-test-server
javascript-library
Last synced: 3 months ago
JSON representation
Nextcloud cypress commands, utils and selectors library https://npmjs.org/@nextcloud/cypress
- Host: GitHub
- URL: https://github.com/nextcloud-libraries/nextcloud-e2e-test-server
- Owner: nextcloud-libraries
- License: agpl-3.0
- Created: 2022-06-23T15:30:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-21T12:53:54.000Z (6 months ago)
- Last Synced: 2025-10-23T09:35:02.513Z (6 months ago)
- Topics: javascript-library
- Language: TypeScript
- Homepage: https://nextcloud-libraries.github.io/nextcloud-cypress/
- Size: 13.3 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# \@nextcloud/e2e-test-server
[](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-e2e-test-server) [](https://www.npmjs.com/package/@nextcloud/e2e-test-server) 
Nextcloud e2e test server and utils for cypress and playwright.
## 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'
```
3. Add the `start:nextcloud` script to your package.json
```json
{
"start:nextcloud": "node playwright/start-nextcloud-server.mjs",
}
```
4. Install chromium for playwright:
```
npx playwright install chromium --only-shell
```
5. Run playwright tests:
```
npx playwright test
```
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`):
```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
})
},
},
})
```
## Cypress commands
You can import individual commands or all at once
You can find [the list of all available commands here](https://nextcloud.github.io/nextcloud-e2e-test-server/modules/commands.html)
```js
// cypress/support/commands.js
import { addCommands } from '@nextcloud/e2e-test-server/cypress'
addCommands()
```
```js
// cypress/support/commands.js
import { login } from '@nextcloud/e2e-test-server/commands'
Cypress.Commands.add('login', login)
```
## Selectors (:warn: deprecated)
You can find [the list of all available selectors here](https://nextcloud.github.io/nextcloud-e2e-test-server/modules/selectors.html)
```js
import { UploadPicker as UploadPickerComponent} from '../../dist/index.js'
import { UploadPicker, UploadPickerInput } from '@nextcloud/e2e-test-server/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')
})
})
```