-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: Export docker functions from main entry
Signed-off-by: Max <max@nextcloud.com>
- Loading branch information
1 parent
ffe8fe0
commit 2bd6693
Showing
9 changed files
with
186 additions
and
155 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /** | ||
| * 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 | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /** | ||
| * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
| import { User } from "./User" | ||
| import { getNc, restoreState, runCommand, runOccCommand, saveState } from "./commands" | ||
| import { login, logout } from "./commands/sessions" | ||
| import { createRandomUser, createUser, deleteUser, modifyUser, listUsers, getUserData, enableUser } from "./commands/users" | ||
| import type { Selector } from "./selectors" | ||
|
|
||
| declare global { | ||
| namespace Cypress { | ||
| interface Chainable { | ||
| /** | ||
| * Get an element from the Nextcloud selector set. | ||
| * @example cy.getNc(FileList) | ||
| * cy.getNc(FileRow, { id: fileInfo.id }) | ||
| */ | ||
| getNc(selector: Selector, args?: Object): Cypress.Chainable<JQuery<HTMLElement>> | ||
|
|
||
| /** | ||
| * Login on a Nextcloud instance | ||
| */ | ||
| login(user: User): void | ||
|
|
||
| /** | ||
| * Logout from a Nextcloud instance | ||
| */ | ||
| logout(): void | ||
|
|
||
| /** | ||
| * Create a random user on the Nextcloud instance | ||
| * | ||
| * **Warning**: Using this function will reset the previous session | ||
| */ | ||
| createRandomUser(): Cypress.Chainable<User> | ||
|
|
||
| /** | ||
| * Create a user on the Nextcloud instance | ||
| * | ||
| * **Warning**: Using this function will reset the previous session | ||
| */ | ||
| createUser(user: User): Cypress.Chainable<Cypress.Response<any>> | ||
|
|
||
| /** | ||
| * Delete a user on the Nextcloud instance | ||
| * | ||
| * **Warning**: Using this function will reset the previous session | ||
| */ | ||
| deleteUser(user: User): Cypress.Chainable<Cypress.Response<any>> | ||
|
|
||
| /** | ||
| * Query list of users on the Nextcloud instance | ||
| * | ||
| * **Warning**: Using this function will reset the previous session | ||
| * | ||
| * @param details Set to true to fetch users with detailed information (default false) | ||
| * @return List of user IDs or list of Users (if details was set to true) | ||
| */ | ||
| listUsers<b extends boolean>(details?: b): Cypress.Chainable<b extends true ? Record<string, string>[] : string[]> | ||
| listUsers(details?: boolean): Cypress.Chainable<Record<string,string>[] | string[]> | ||
|
|
||
| /** | ||
| * Modify an attribute of a given user on the Nextcloud instance | ||
| * | ||
| * @param user User who modifies their metadata | ||
| * @param key Attribute name | ||
| * @param value New attribute value | ||
| */ | ||
| modifyUser(user: User, key: string, value: any): Cypress.Chainable<Cypress.Response<any>> | ||
|
|
||
| /** | ||
| * Enable or disable a given user | ||
| * | ||
| * @param user user whom to enable or disable | ||
| * @param enable True to enable, false to disable (default is enable) | ||
| */ | ||
| enableUser(user: User, enable?: boolean): Cypress.Chainable<Cypress.Response<any>> | ||
|
|
||
| /** | ||
| * | ||
| * Query metadata for, and in behalf, of a given user | ||
| * | ||
| * @param user User whom metadata to query | ||
| */ | ||
| getUserData(user: User): Cypress.Chainable<Cypress.Response<any>> | ||
|
|
||
| /** | ||
| * Create a snapshot of the current DB and data folder state. | ||
| * | ||
| * @return string the ID of the snapshot | ||
| */ | ||
| saveState(): Cypress.Chainable<string> | ||
|
|
||
| /** | ||
| * Restore a snapshot of the database | ||
| * Default is the post-setup state | ||
| * | ||
| * @param snapshot string the ID of the snapshot | ||
| */ | ||
| restoreState(snapshot?: string): Cypress.Chainable<void> | ||
|
|
||
| /** | ||
| * Run a command in the docker container | ||
| * | ||
| */ | ||
| runCommand(command: string, options?: Partial<Cypress.ExecOptions>): Cypress.Chainable<Cypress.Exec> | ||
|
|
||
| /** | ||
| * Run an occ command | ||
| */ | ||
| runOccCommand(command: string, options?: Partial<Cypress.ExecOptions>): Cypress.Chainable<Cypress.Exec> | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Register all existing commands provided by this library | ||
| * | ||
| * You can also manually register those commands by importing them | ||
| * @example import { login } from '@nextcloud/e2e-test-server/commands' | ||
| * Cypress.Commands.add('login', login) | ||
| */ | ||
| export const addCommands = function() { | ||
| Cypress.Commands.add('getNc', getNc) | ||
| Cypress.Commands.add('login', login) | ||
| Cypress.Commands.add('logout', logout) | ||
| Cypress.Commands.add('createRandomUser', createRandomUser) | ||
| Cypress.Commands.add('createUser', createUser) | ||
| Cypress.Commands.add('deleteUser', deleteUser) | ||
| Cypress.Commands.add('listUsers', listUsers) | ||
| Cypress.Commands.add('modifyUser', modifyUser) | ||
| Cypress.Commands.add('enableUser', enableUser) | ||
| Cypress.Commands.add('getUserData', getUserData) | ||
| Cypress.Commands.add('saveState', saveState) | ||
| Cypress.Commands.add('restoreState', restoreState) | ||
| Cypress.Commands.add('runCommand', runCommand) | ||
| Cypress.Commands.add('runOccCommand', runOccCommand) | ||
| } | ||
|
|
||
| export { User } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.