Move testing-library cypress commands import to inner commands so it …

…can be imported (#5906)

Co-authored-by: Steve Piercy <[email protected]>

docs/source/upgrade-guide/index.md

@@ -170,6 +170,22 @@ In your add-ons and projects, we advise you to always use the public components
 
 This change improves UX of the Babel view (translation form) since a disabled field cannot be selected to be copied over.
 
+### `volto-slate` Cypress helpers moved to its own module
+
+There were some Cypress helpers for `volto-slate` along with the other definitions of Cypress commands.
+The Cypress command definitions are intended to be loaded only once, whereas the helpers can be imported any number of times.
+Therefore, we moved the helpers to its own module:
+
+```js
+import { slateBeforeEach } from '@plone/volto/cypress/support/commands';
+```
+
+becomes:
+
+```js
+import { slateBeforeEach } from '@plone/volto/cypress/support/helpers';
+```
+
 (volto-upgrade-guide-17.x.x)=
 
 ## Upgrading to Volto 17.x.x

packages/volto/cypress/support/commands.js

@@ -1,4 +1,5 @@
 /* eslint-disable no-console */
+import '@testing-library/cypress/add-commands';
 import { getIfExists } from '../helpers';
 import { ploneAuth } from './constants';
 
@@ -21,8 +22,6 @@ const ploneAuthObj = {
   pass: ploneAuth[1],
 };
 
-export * from './volto-slate';
-
 // --- isInViewport ----------------------------------------------------------
 Cypress.Commands.add('isInViewport', (element) => {
   cy.get(element).then(($el) => {

packages/volto/cypress/support/helpers.js

@@ -0,0 +1 @@
+export * from './volto-slate';

packages/volto/cypress/tests/core/volto-slate/01-block-slate-title-description.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/02-block-slate.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/03-block-slate.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach, getSlateBlockValue } from '../../../support/commands';
+import { slateBeforeEach, getSlateBlockValue } from '../../../support/helpers';
 
 describe('Block Tests', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/04-block-focus.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/05-block-slate-format-basics.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: Basic text format', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/06-block-slate-format-link.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: Links', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/07-block-slate-format-ulist.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: Bulleted lists', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/08-block-slate-format-olist.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: Numbered lists', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/09-block-slate-slashmenu.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('SlashMenu Test: Shortcuts', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/24-block-slate-format-boldlists.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: Bold Bulleted lists', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/25-block-slate-paste-images.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: paste external images', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/27-block-slate-paste-html.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: external text containing html contents/tags ', () => {
   beforeEach(slateBeforeEach);

packages/volto/cypress/tests/core/volto-slate/28-table-block-slate-paste.js

@@ -1,4 +1,4 @@
-import { slateBeforeEach } from '../../../support/commands';
+import { slateBeforeEach } from '../../../support/helpers';
 
 describe('Block Tests: pasting content in table block', () => {
   beforeEach(slateBeforeEach);

packages/volto/news/5906.internal

@@ -0,0 +1 @@
+Move `testing-library` Cypress commands import to inner commands, so it can be imported from the outside. @sneridagh