feat(e2e-test-server): Rename package and move to separate branch

Also update `README.md` to reflect the change.
Remove `cypress` peer dependency to ease use in playwright.

Signed-off-by: Max <max@nextcloud.com>

Author: max-nextcloud

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,47 +16,22 @@ 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) 
+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 { addCommands } from '@nextcloud/cypress'
+## Starting Nextcloud Docker container
 
-addCommands()
-```
+### Playwright
 
-```js
-// cypress/support/commands.js
-import { getNc } from '@nextcloud/cypress/commands'
+This repository does not include playwritght configurations or examples yet.
 
-Cypress.Commands.add('getNc', getNc)
-```
+Please take a look at the [forms app](https://github.com/nextcloud/forms) for an example of using `@nextlcloud/e2e-test-server` with playwright.
 
-## Selectors
+### Cypress
 
-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')
-	})
-})
-```
-
-## Starting Nextcloud Docker container
-
-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'
@@ -89,3 +64,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/cypress'
+
+addCommands()
+```
+
+```js
+// cypress/support/commands.js
+import { getNc } from '@nextcloud/cypress/commands'
+
+Cypress.Commands.add('getNc', getNc)
+```
+
+## 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'

lib/commands/docker.ts

@@ -11,7 +11,7 @@ function basename(path: string): string {
 function getContainerName(): Cypress.Chainable<string> {
 	return cy.exec('pwd').then(({ stdout }) => {
 		const name = basename(stdout).replace(' ', '')
-		return cy.wrap(`nextcloud-cypress-tests_${name}`)
+		return cy.wrap(`nextcloud-e2e-test-server_${name}`)
 	})
 }
 

lib/docker.ts

@@ -36,7 +36,7 @@ let _serverBranch = 'master'
 export const getContainerName = function(): string {
 	if (_containerName === null) {
 		const app = basename(process.cwd()).replace(' ', '')
-		_containerName = `nextcloud-cypress-tests_${app}`
+		_containerName = `nextcloud-e2e-test-server_${app}`
 	}
 	return _containerName
 }

lib/index.ts

@@ -117,8 +117,8 @@ declare global {
  * Register all existing commands provided by this library
  *
  * You can also manually register those commands by importing them
- * @example import { getNc } from '@nextcloud/cypress/commands'
- *          Cypress.Commands.add('getNc', getNc)
+ * @example import { login } from '@nextcloud/e2e-test-server/commands'
+ *          Cypress.Commands.add('login', login)
  */
 export const addCommands = function() {
 	Cypress.Commands.add('getNc', getNc)

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "@nextcloud/cypress",
-  "version": "1.0.0-beta.15",
-  "description": "Nextcloud cypress commands, utils and selectors library",
+  "name": "@nextcloud/e2e-test-server",
+  "version": "0.1.0",
+  "description": "Nextcloud e2e test server and utils for cypress and playwright",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,7 +35,11 @@
   "license": "AGPL-3.0-or-later",
   "keywords": [
     "nextcloud",
+    "docker",
+    "e2e",
+    "testing",
     "cypress",
+    "playwright",
     "selector",
     "plugins",
     "library"
@@ -66,9 +70,6 @@
     "npm": "^10.0.0"
   },
   "homepage": "https://github.com/nextcloud/nextcloud-cypress",
-  "peerDependencies": {
-    "cypress": "^13.9.0"
-  },
   "dependencies": {
     "dockerode": "^4.0.2",
     "fast-xml-parser": "^5.2.2",