]> source.dussan.org Git - nextcloud-server.git/commitdiff
chore(cypress): Migrate header contacts menu tests from Behat to Cypress 41190/head
authorFerdinand Thiessen <opensource@fthiessen.de>
Sun, 29 Oct 2023 23:46:32 +0000 (00:46 +0100)
committerFerdinand Thiessen <opensource@fthiessen.de>
Sun, 5 Nov 2023 19:17:00 +0000 (20:17 +0100)
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
.drone.yml
cypress/e2e/core/header_contacts-menu.cy.ts [new file with mode: 0644]
cypress/support/commands.ts
tests/acceptance/config/behat.yml
tests/acceptance/features/bootstrap/ThemingAppContext.php [deleted file]
tests/acceptance/features/header.feature [deleted file]

index 70e0318aca5bc497d2958bff49401b328907e8a3..3a7574a509ca11338e86ca2c4aaaddfb6ad6c625 100644 (file)
@@ -1561,36 +1561,6 @@ trigger:
     - pull_request
     - push
 
----
-kind: pipeline
-name: acceptance-header
-
-steps:
-- name: submodules
-  image: ghcr.io/nextcloud/continuous-integration-alpine-git:latest
-  commands:
-    - git submodule update --init
-- name: acceptance-header
-  image: ghcr.io/nextcloud/continuous-integration-acceptance-php8.0:latest
-  commands:
-    - tests/acceptance/run-local.sh --timeout-multiplier 10 --nextcloud-server-domain acceptance-header --selenium-server selenium:4444 allow-git-repository-modifications features/header.feature
-
-services:
-- name: selenium
-  image: ghcr.io/nextcloud/continuous-integration-selenium:3.141.59
-  environment:
-    # Reduce default log level for Selenium server (INFO) as it is too
-    # verbose.
-    JAVA_OPTS: -Dselenium.LOGGER.level=WARNING
-
-trigger:
-  branch:
-    - master
-    - stable*
-  event:
-    - pull_request
-    - push
-
 ---
 kind: pipeline
 name: acceptance-apps
diff --git a/cypress/e2e/core/header_contacts-menu.cy.ts b/cypress/e2e/core/header_contacts-menu.cy.ts
new file mode 100644 (file)
index 0000000..d4c8ffe
--- /dev/null
@@ -0,0 +1,154 @@
+/**
+ * @copyright Copyright (c) 2023 Ferdinand Thiessen <opensource@fthiessen.de>
+ *
+ * @author Ferdinand Thiessen <opensource@fthiessen.de>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+import { User } from '@nextcloud/cypress'
+import { clearState, getNextcloudHeader } from '../../support/commonUtils'
+
+// eslint-disable-next-line n/no-extraneous-import
+import randomString from 'crypto-random-string'
+
+const admin = new User('admin', 'admin')
+
+const getContactsMenu = () => getNextcloudHeader().find('#header-menu-contactsmenu')
+const getContactsMenuToggle = () => getNextcloudHeader().find('#contactsmenu .header-menu__trigger')
+const getContactsSearch = () => getContactsMenu().find('#contactsmenu__menu__search')
+
+describe('Header: Contacts menu', { testIsolation: true }, () => {
+       let user: User
+
+       beforeEach(() => {
+               // clear user and group state
+               clearState()
+               // ensure the contacts menu is not restricted
+               cy.runOccCommand('config:app:set --value no core shareapi_restrict_user_enumeration_to_group')
+               // create a new user for testing the contacts
+               cy.createRandomUser().then(($user) => {
+                       user = $user
+               })
+
+               // Given I am logged in as the admin
+               cy.login(admin)
+               cy.visit('/')
+       })
+
+       it('Other users are seen in the contacts menu', () => {
+               // When I open the Contacts menu
+               getContactsMenuToggle().click()
+               // I see that the Contacts menu is shown
+               getContactsMenu().should('exist')
+               // I see that the contact user in the Contacts menu is shown
+               getContactsMenu().contains('li.contact', user.userId).should('be.visible')
+               // I see that the contact "admin" in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+       })
+
+       it('Just added users are seen in the contacts menu', () => {
+               // I create a new user
+               const newUserName = randomString(7)
+               // we can not use createRandomUser as it will invalidate the session
+               cy.runOccCommand(`user:add --password-from-env '${newUserName}'`, { env: { OC_PASS: '1234567' } })
+               // I open the Contacts menu
+               getContactsMenuToggle().click()
+               // I see that the Contacts menu is shown
+               getContactsMenu().should('exist')
+               // I see that the contact user in the Contacts menu is shown
+               getContactsMenu().contains('li.contact', user.userId).should('be.visible')
+               // I see that the contact of the new user in the Contacts menu is shown
+               getContactsMenu().contains('li.contact', newUserName).should('be.visible')
+               // I see that the contact "admin" in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+       })
+
+       it('Search for other users in the contacts menu', () => {
+               cy.createRandomUser().then((otherUser) => {
+                       // Given I am logged in as the admin
+                       cy.login(admin)
+                       cy.visit('/')
+
+                       // I open the Contacts menu
+                       getContactsMenuToggle().click()
+                       // I see that the Contacts menu is shown
+                       getContactsMenu().should('exist')
+                       // I see that the contact user in the Contacts menu is shown
+                       getContactsMenu().contains('li.contact', user.userId).should('be.visible')
+                       // I see that the contact of the new user in the Contacts menu is shown
+                       getContactsMenu().contains('li.contact', otherUser.userId).should('be.visible')
+
+                       // I see that the Contacts menu search input is shown
+                       getContactsSearch().should('exist')
+                       // I search for the otherUser
+                       getContactsSearch().type(otherUser.userId)
+                       // I see that the contact otherUser in the Contacts menu is shown
+                       getContactsMenu().contains('li.contact', otherUser.userId).should('be.visible')
+                       // I see that the contact user in the Contacts menu is not shown
+                       getContactsMenu().contains('li.contact', user.userId).should('not.exist')
+                       // I see that the contact "admin" in the Contacts menu is not shown
+                       getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+               })
+       })
+
+       it('Search for unknown users in the contacts menu', () => {
+               // I open the Contacts menu
+               getContactsMenuToggle().click()
+               // I see that the Contacts menu is shown
+               getContactsMenu().should('exist')
+               // I see that the contact user in the Contacts menu is shown
+               getContactsMenu().contains('li.contact', user.userId).should('be.visible')
+
+               // I see that the Contacts menu search input is shown
+               getContactsSearch().should('exist')
+               // I search for an unknown user
+               getContactsSearch().type('surely-unknown-user')
+               // I see that the no results message in the Contacts menu is shown
+               getContactsMenu().find('ul li').should('have.length', 0)
+               // I see that the contact user in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', user.userId).should('not.exist')
+               // I see that the contact "admin" in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+       })
+
+       it('Users from other groups are not seen in the contacts menu when autocompletion is restricted within the same group', () => {
+               // I enable restricting username autocompletion to groups
+               cy.runOccCommand('config:app:set --value yes core shareapi_restrict_user_enumeration_to_group')
+               // I open the Contacts menu
+               getContactsMenuToggle().click()
+               // I see that the Contacts menu is shown
+               getContactsMenu().should('exist')
+               // I see that the contact user in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', user.userId).should('not.exist')
+               // I see that the contact "admin" in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+
+               // I close the Contacts menu
+               getContactsMenuToggle().click()
+               // I disable restricting username autocompletion to groups
+               cy.runOccCommand('config:app:set --value no core shareapi_restrict_user_enumeration_to_group')
+               // I open the Contacts menu
+               getContactsMenuToggle().click()
+               // I see that the Contacts menu is shown
+               getContactsMenu().should('exist')
+               // I see that the contact user in the Contacts menu is shown
+               getContactsMenu().contains('li.contact', user.userId).should('be.visible')
+               // I see that the contact "admin" in the Contacts menu is not shown
+               getContactsMenu().contains('li.contact', admin.userId).should('not.exist')
+       })
+})
index 1596bfe81fc9cd986d5d810e7d893822bfb06ef8..b2ec7f1e74529db19a1b3b23169cd6bb021c3b2f 100644 (file)
@@ -218,5 +218,6 @@ Cypress.Commands.add('resetUserTheming', (user?: User) => {
 })
 
 Cypress.Commands.add('runOccCommand', (command: string, options?: Partial<Cypress.ExecOptions>) => {
-       return cy.exec(`docker exec --user www-data nextcloud-cypress-tests-server php ./occ ${command}`, options)
+       const env = Object.entries(options?.env ?? {}).map(([name, value]) => `-e '${name}=${value}'`).join(' ')
+       return cy.exec(`docker exec --user www-data ${env} nextcloud-cypress-tests-server php ./occ ${command}`, options)
 })
index 80413c82532d21b82c5d532036eead1cf2e1bd79..3ff26c8901b23c8fa7cc2c51cf48d3db01c6d015 100644 (file)
@@ -22,7 +22,6 @@ default:
         - SearchContext
         - SettingsContext
         - SettingsMenuContext
-        - ThemingAppContext
         - ToastContext
       filters:
         tags: "~@apache"
@@ -49,7 +48,6 @@ default:
         - SearchContext
         - SettingsContext
         - SettingsMenuContext
-        - ThemingAppContext
         - ToastContext
       filters:
         tags: "@apache"
diff --git a/tests/acceptance/features/bootstrap/ThemingAppContext.php b/tests/acceptance/features/bootstrap/ThemingAppContext.php
deleted file mode 100644 (file)
index e680a3c..0000000
+++ /dev/null
@@ -1,186 +0,0 @@
-<?php
-
-/**
- *
- * @copyright Copyright (c) 2017, Daniel Calviño Sánchez (danxuliu@gmail.com)
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-use Behat\Behat\Context\Context;
-use PHPUnit\Framework\Assert;
-
-class ThemingAppContext implements Context, ActorAwareInterface {
-       use ActorAware;
-
-       /**
-        * @return Locator
-        */
-       public static function inputFieldFor($parameterName) {
-               return Locator::forThe()->css("input")->
-                               descendantOf(self::parameterDivFor($parameterName))->
-                               describedAs("Input field for $parameterName parameter in Theming app");
-       }
-
-       /**
-        * @return Locator
-        */
-       public static function resetButtonFor($parameterName) {
-               return Locator::forThe()->css(".theme-undo")->
-                               descendantOf(self::parameterDivFor($parameterName))->
-                               describedAs("Reset button for $parameterName parameter in Theming app");
-       }
-
-       /**
-        * @return Locator
-        */
-       private static function parameterDivFor($parameterName) {
-               return Locator::forThe()->xpath("//*[@id='theming']//label//*[normalize-space() = '$parameterName']/ancestor::div[1]")->
-                               describedAs("Div for $parameterName parameter in Theming app");
-       }
-
-       /**
-        * @return Locator
-        */
-       public static function statusMessage() {
-               return Locator::forThe()->id("theming_settings_msg")->
-                               describedAs("Status message in Theming app");
-       }
-
-       /**
-        * @When I set the :parameterName parameter in the Theming app to :parameterValue
-        */
-       public function iSetTheParameterInTheThemingAppTo($parameterName, $parameterValue) {
-               $this->actor->find(self::inputFieldFor($parameterName), 10)->setValue($parameterValue);
-       }
-
-       /**
-        * @When I reset the :parameterName parameter in the Theming app to its default value
-        */
-       public function iSetTheParameterInTheThemingAppToItsDefaultValue($parameterName) {
-               // The reset button is not shown when the cursor is outside the input
-               // field, so ensure that the cursor is on the input field by clicking on
-               // it.
-               $this->actor->find(self::inputFieldFor($parameterName), 10)->click();
-
-               $this->actor->find(self::resetButtonFor($parameterName), 10)->click();
-       }
-
-       /**
-        * @Then I see that the color selector in the Theming app has loaded
-        */
-       public function iSeeThatTheColorSelectorInTheThemingAppHasLoaded() {
-               // Checking if the color selector has loaded by getting the background color
-               // of the input element. If the value present in the element matches the
-               // background of the input element, it means the color element has been
-               // initialized.
-
-               Assert::assertTrue($this->actor->find(self::inputFieldFor("Color"), 10)->isVisible());
-
-               $actor = $this->actor;
-
-               $colorSelectorLoadedCallback = function () use ($actor) {
-                       $colorSelectorValue = $this->getRGBArray($actor->getSession()->evaluateScript("return $('#admin-theming-color').text().trim();"));
-                       $inputBgColorRgb = $this->getRGBArray($actor->getSession()->evaluateScript("return $('#admin-theming-color').css('background-color');"));
-
-                       $matches = [];
-                       preg_match_all('/\d+/', $inputBgColorRgb, $matches);
-                       $inputBgColorHex = sprintf("#%02x%02x%02x", $matches[0][0], $matches[0][1], $matches[0][2]);
-
-                       if ($colorSelectorValue == $inputBgColorHex) {
-                               return true;
-                       }
-
-                       return false;
-               };
-
-               if (!Utils::waitFor($colorSelectorLoadedCallback, $timeout = 10 * $this->actor->getFindTimeoutMultiplier(), $timeoutStep = 1)) {
-                       Assert::fail("The color selector in Theming app has not been loaded after $timeout seconds");
-               }
-       }
-
-       private function getRGBArray($color) {
-               if (preg_match("/rgb\(\s*(\d+),\s*(\d+),\s*(\d+)\)/", $color, $matches)) {
-                       // Already an RGB (R, G, B) color
-                       // Convert from "rgb(R, G, B)" string to RGB array
-                       $tmpColor = array_splice($matches, 1);
-               } elseif ($color[0] === '#') {
-                       $color = substr($color, 1);
-                       // HEX Color, convert to RGB array.
-                       $tmpColor = sscanf($color, "%02X%02X%02X");
-               } else {
-                       Assert::fail("The acceptance test does not know how to handle the color string : '$color'. "
-                       . "Please provide # before HEX colors in your features.");
-               }
-               return $tmpColor;
-       }
-
-       /**
-        * @Then I see that the primary color is eventually :color
-        */
-       public function iSeeThatThePrimaryColorIsEventually($color) {
-               $primaryColorMatchesCallback = function () use ($color) {
-                       $primaryColor = $this->actor->getSession()->evaluateScript("return getComputedStyle(document.documentElement).getPropertyValue('--color-primary').trim();");
-                       $primaryColor = $this->getRGBArray($primaryColor);
-                       $color = $this->getRGBArray($color);
-
-                       return $primaryColor == $color;
-               };
-
-               if (!Utils::waitFor($primaryColorMatchesCallback, $timeout = 10 * $this->actor->getFindTimeoutMultiplier(), $timeoutStep = 1)) {
-                       Assert::fail("The primary color is not $color yet after $timeout seconds");
-               }
-       }
-
-       /**
-        * @Then I see that the non-plain background color variable is eventually :color
-        */
-       public function iSeeThatTheNonPlainBackgroundColorVariableIsEventually($color) {
-               $colorVariableMatchesCallback = function () use ($color) {
-                       $colorVariable = $this->actor->getSession()->evaluateScript("return getComputedStyle(document.documentElement).getPropertyValue('--color-primary-default').trim();");
-                       $colorVariable = $this->getRGBArray($colorVariable);
-                       $color = $this->getRGBArray($color);
-
-                       return $colorVariable == $color;
-               };
-
-               if (!Utils::waitFor($colorVariableMatchesCallback, $timeout = 10 * $this->actor->getFindTimeoutMultiplier(), $timeoutStep = 1)) {
-                       Assert::fail("The non-plain background color variable is not $color yet after $timeout seconds");
-               }
-       }
-
-       /**
-        * @Then I see that the parameters in the Theming app are eventually saved
-        */
-       public function iSeeThatTheParametersInTheThemingAppAreEventuallySaved() {
-               Assert::assertTrue($this->actor->find(self::statusMessage(), 10)->isVisible());
-
-               $actor = $this->actor;
-
-               $savedStatusMessageShownCallback = function () use ($actor) {
-                       if ($actor->find(self::statusMessage())->getText() !== "Saved") {
-                               return false;
-                       }
-
-                       return true;
-               };
-
-               if (!Utils::waitFor($savedStatusMessageShownCallback, $timeout = 10 * $this->actor->getFindTimeoutMultiplier(), $timeoutStep = 1)) {
-                       Assert::fail("The 'Saved' status messages in Theming app has not been shown after $timeout seconds");
-               }
-       }
-}
diff --git a/tests/acceptance/features/header.feature b/tests/acceptance/features/header.feature
deleted file mode 100644 (file)
index 2d9e2d5..0000000
+++ /dev/null
@@ -1,61 +0,0 @@
-@apache
-Feature: header
-
-  Scenario: other users are seen in the contacts menu
-    Given I am logged in as the admin
-    When I open the Contacts menu
-    Then I see that the Contacts menu is shown
-    And I see that the contact "user0" in the Contacts menu is shown
-    And I see that the contact "admin" in the Contacts menu is not shown
-
-#  Scenario: users from other groups are not seen in the contacts menu when autocompletion is restricted within the same group
-#    Given I am logged in as the admin
-#    And I visit the admin settings page
-#    And I open the "Sharing" section of the "Administration" group
-#    And I enable restricting username autocompletion to groups
-#    And I see that username autocompletion is restricted to groups
-#    When I open the Contacts menu
-#    Then I see that the Contacts menu is shown
-#    And I see that the contact "user0" in the Contacts menu is not shown
-#    And I see that the contact "admin" in the Contacts menu is not shown
-
-  Scenario: just added users are seen in the contacts menu
-    Given I am logged in as the admin
-    And I open the User settings
-    And I click the New user button
-    And I see that the new user form is shown
-    And I create user user2 with password 123456acb
-    # And I see that the list of users contains the user user2
-    When I open the Contacts menu
-    Then I see that the Contacts menu is shown
-    And I see that the contact "user0" in the Contacts menu is shown
-    And I see that the contact "user1" in the Contacts menu is shown
-    And I see that the contact "user2" in the Contacts menu is shown
-    And I see that the contact "admin" in the Contacts menu is not shown
-
-  Scenario: search for other users in the contacts menu
-    Given I am logged in as the admin
-    And I open the Contacts menu
-    And I see that the Contacts menu is shown
-    And I see that the contact "user0" in the Contacts menu is shown
-    And I see that the contact "user1" in the Contacts menu is shown
-    And I see that the Contacts menu search input is shown
-    When I search for the user "user0"
-    # First check that "user1" is no longer shown to ensure that the search was
-    # made; checking that "user0" is shown or that "admin" is not shown does not
-    # guarantee that (as they were already being shown and not being shown,
-    # respectively, before the search started).
-    Then I see that the contact "user1" in the Contacts menu is eventually not shown
-    And I see that the contact "user0" in the Contacts menu is shown
-    And I see that the contact "admin" in the Contacts menu is not shown
-
-  Scenario: search for unknown users in the contacts menu
-    Given I am logged in as the admin
-    And I open the Contacts menu
-    And I see that the Contacts menu is shown
-    And I see that the contact "user0" in the Contacts menu is shown
-    And I see that the Contacts menu search input is shown
-    When I search for the user "unknownuser"
-    Then I see that the no results message in the Contacts menu is shown
-    And I see that the contact "user0" in the Contacts menu is not shown
-    And I see that the contact "admin" in the Contacts menu is not shown