Merge pull request #758 from nextcloud-libraries/e2e-test-server

E2e test server

Author: max-nextcloud

.gitignore

@@ -65,3 +65,7 @@ typings/
 /dist
 cypress/screenshots
 cypress/videos
+
+# playwright artifacts
+test-results/
+playwright-report/

README.md

@@ -2,11 +2,11 @@
   - SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
-# \@nextcloud/cypress
+# \@nextcloud/e2e-test-server
 
-[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-cypress)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-cypress) [![npm last version](https://img.shields.io/npm/v/@nextcloud/cypress.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/cypress) ![Codecov](https://img.shields.io/codecov/c/github/nextcloud/nextcloud-cypress?style=flat-square)
+[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-cypress)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-cypress) [![npm last version](https://img.shields.io/npm/v/@nextcloud/e2e-test-server.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/e2e-test-server) ![Codecov](https://img.shields.io/codecov/c/github/nextcloud/nextcloud-cypress?style=flat-square)
 
-Nextcloud cypress helpers for Nextcloud apps and libraries
+Nextcloud e2e test server and utils for cypress and playwright.
 
 ## New package available
 
@@ -16,50 +16,45 @@ that will work nicely with both cypress and playwright.
 It will eventually superseed `@nextcloud/cypress`.
 When starting a new project we recommend using `@nextcloud/e2e-test-server`.
 
-## Commands
+## Status
 
-You can import individual commands or all at once
-You can find [the list of all available commands here](https://nextcloud.github.io/nextcloud-cypress/modules/commands.html) 
-
-```js
-// cypress/support/commands.js
-import { addCommands } from '@nextcloud/cypress'
-
-addCommands()
-```
+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.
 
-```js
-// cypress/support/commands.js
-import { getNc } from '@nextcloud/cypress/commands'
-
-Cypress.Commands.add('getNc', getNc)
-```
+## Starting Nextcloud Docker container
 
-## Selectors
+### Playwright
 
-You can find [the list of all available selectors here](https://nextcloud.github.io/nextcloud-cypress/modules/selectors.html) 
+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!
 
-```js
-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')
-	})
-})
-```
 
-## Starting Nextcloud Docker container
+### Cypress
 
-It is possible to automatically start a docker container providing a Nextcloud instance for testing.
-Therefor adjust your `cypress.config.ts` (or `.js`):
+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/cypress/docker'
+import { configureNextcloud,  startNextcloud,  stopNextcloud, waitOnNextcloud } from '@nextcloud/e2e-test-server'
 
 export default defineConfig({
 // ...
@@ -89,3 +84,40 @@ export default defineConfig({
 	},
 })
 ```
+
+## 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-cypress/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-cypress/modules/selectors.html) 
+
+```js
+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')
+	})
+})
+```

REUSE.toml

@@ -1,9 +1,9 @@
 # SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 # SPDX-License-Identifier: AGPL-3.0-or-later
 version = 1
-SPDX-PackageName = "nextcloud-cypress"
+SPDX-PackageName = "nextcloud-e2e-test-server"
 SPDX-PackageSupplier = "Nextcloud <info@nextcloud.com>"
-SPDX-PackageDownloadLocation = "https://github.com/nextcloud-libraries/nextcloud-cypressg"
+SPDX-PackageDownloadLocation = "https://github.com/nextcloud-libraries/nextcloud-cypress"
 
 [[annotations]]
 path = ["package-lock.json", "package.json", "tsconfig.json", "__tests__/tsconfig.json", "cypress/tsconfig.json"]

cypress.config.ts

@@ -4,7 +4,7 @@
  */
 // Making sure we're forcing the development mode
 process.env.NODE_ENV = 'development'
-process.env.npm_package_name = 'nextcloud-cypress'
+process.env.npm_package_name = 'nextcloud-e2e-test-server'
 
 /* eslint-disable import/first */
 import { configureNextcloud, createSnapshot, setupUsers, startNextcloud, stopNextcloud, waitOnNextcloud } from './lib/docker'

cypress/e2e/sessions.cy.ts

@@ -2,7 +2,7 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import { User } from '../../dist'
+import { User } from '../../dist/cypress'
 
 describe('Login and logout', function() {
 	it('Login and see the default files list', function() {

cypress/e2e/snapshots.cy.ts

@@ -2,7 +2,7 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import { User } from '../../dist'
+import { User } from '../../dist/cypress'
 import { randHash } from '../utils'
 
 describe('Create a snapshot and a user', function() {

cypress/e2e/users.cy.ts

@@ -2,7 +2,7 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import { User } from '../../dist'
+import { User } from '../../dist/cypress'
 import { randHash } from '../utils'
 
 describe('Create user and login', function() {

cypress/support/commands.ts

@@ -14,5 +14,5 @@
 // ***********************************************
 //
 
-import { addCommands } from '../../dist/'
+import { addCommands } from '../../dist/cypress'
 addCommands()

jest.config.js

@@ -0,0 +1,22 @@
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+export class User {
+	userId: string
+	password: string
+	language: string
+
+	constructor(user: string, password: string = user, language = 'en') {
+		this.userId = user
+		this.password = password
+		this.language = language
+	}
+
+	static createRandom() {
+		const uid = (Math.random() + 1).toString(36).substring(7)
+		return new User(uid)
+	}
+}
+