add deprecated to all support files

uktrade · Oct 9, 2023 · 49c936f · 49c936f
1 parent 8faae28
commit 49c936f
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 8 deletions.
diff --git a/test/functional/cypress/support/actions.js b/test/functional/cypress/support/actions.js
@@ -1,4 +1,10 @@
 import { fill } from './form-fillers'
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
 
 const adviserResult = require('../../../sandbox/fixtures/autocomplete-adviser-list.json')
 

diff --git a/test/functional/cypress/support/assertions.js b/test/functional/cypress/support/assertions.js
@@ -1,3 +1,10 @@
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 const { keys, forEach, isObject } = require('lodash')
 const qs = require('qs')
 

diff --git a/test/functional/cypress/support/collection-list-assertions.js b/test/functional/cypress/support/collection-list-assertions.js
@@ -1,5 +1,8 @@
 /**
- * Assertions for the various CollectionList tests
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
  */
 
 const { assertBreadcrumbs } = require('./assertions')

diff --git a/test/functional/cypress/support/company-local-header-assertions.js b/test/functional/cypress/support/company-local-header-assertions.js
@@ -1,4 +1,9 @@
-// Assertions for the CompanyLocalHeader tests
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
 
 const selectors = require('../../../selectors')
 const { testBreadcrumbs } = require('./assertions')

diff --git a/test/functional/cypress/support/event-assertions.js b/test/functional/cypress/support/event-assertions.js
@@ -8,6 +8,13 @@ import {
   assertTextVisible,
 } from './assertions'
 
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 const YES = 'Yes'
 const UK = 'United Kingdom'
 

diff --git a/test/functional/cypress/support/eventform-fillers.js b/test/functional/cypress/support/eventform-fillers.js
@@ -11,6 +11,13 @@ import {
   fillMultiOptionTypeaheadWithLegend,
 } from './form-fillers'
 
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 const selectors = require('../../../selectors/event/createOrEdit')
 
 const UK = 'United Kingdom'

diff --git a/test/functional/cypress/support/form-fillers.js b/test/functional/cypress/support/form-fillers.js
@@ -1,3 +1,10 @@
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 /**
  * @deprecated
  */

diff --git a/test/functional/cypress/support/tests.js b/test/functional/cypress/support/tests.js
@@ -1,16 +1,17 @@
-/**
- * Resuable test functions - these combine an action with an assertion.
- *
- * These are distinct from assertions because unlike an assertion, these have
- * side effects as a result of the action taken.
- */
 import { selectFirstTypeaheadOption } from './actions'
 import {
   assertTypeaheadHints,
   assertTypeaheadOptionSelected,
   assertCheckboxGroupOption,
 } from './assertions'
 
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 /**
  * @deprecated
  * Tests that a typeahead functions correctly by inputing a value and selecting

diff --git a/test/functional/cypress/support/utils.js b/test/functional/cypress/support/utils.js
@@ -1,3 +1,10 @@
+/**
+ * @deprecated
+ * THE LOGIC IN THIS FILE HAS BEEN MOVED TO THE /test/support FOLDER AS THE LOGIC IS SHARED BETWEEN
+ *  THE COMPONENT AND FUNCTIONAL TESTS. THIS FILE IS ONLY HERE TO AVOID BREAKING ANY TESTS, NO
+ * ADDITIONAL LOGIC SHOULD BE ADDED
+ */
+
 module.exports = {
   /**
    * @deprecated