Migrate tests/ files to src/ (#45840)

.github/workflows/test.yml

@@ -38,25 +38,23 @@ jobs:
         # Note that *if you add* to this, remember to also add that
         # to the **required checks** in the branch protection rules.
         name:
-          # tests/ directory
-          - content
-          - rendering
-          - rendering-fixtures
-          - routing
-          - unit
-
           # src/ directory
           - archives
           - assets
           - audit-logs
           - automated-pipelines
+          # - bookmarklets
+          - changelogs
           # - codeql-cli
           - color-schemes
           - content-linter
           - content-render
+          - data-directory
+          # - dev-toc
           - early-access
           - events
-          # - frame
+          - fixtures
+          - frame
           - ghes-releases
           - github-apps
           - graphql
@@ -68,12 +66,14 @@ jobs:
           # - open-source
           - pageinfo
           # - pages
+          - products
           - redirects
           - release-notes
           - rest
           - search
           - secret-scanning
           - shielding
+          # - tests
           # - tools
           - versions
           - webhooks
@@ -103,23 +103,23 @@ jobs:
           token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }}
 
       - name: Check the test fixture data (if applicable)
-        if: ${{ matrix.name == 'rendering-fixtures' }}
+        if: ${{ matrix.name == 'fixtures' }}
         run: ./src/tests/scripts/copy-fixture-data.js --check
 
       # This keeps our fixture content/data in check
       - name: Check the test fixture content (if applicable)
-        if: ${{ matrix.name == 'rendering-fixtures' }}
+        if: ${{ matrix.name == 'fixtures' }}
         env:
-          ROOT: tests/fixtures
+          ROOT: src/fixtures/fixtures
         run: |
           # If either of these fail, it means our fixture content's internal
           # links can and should be updated.
           ./src/links/scripts/update-internal-links.js --dry-run --check --strict \
-            tests/fixtures/content \
+            src/fixtures/fixtures/content \
-            --exclude tests/fixtures/content/get-started/foo/typo-autotitling.md \
+            --exclude src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md \
-            --exclude tests/fixtures/content/get-started/foo/anchor-autotitling.md
+            --exclude src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md
           ./src/links/scripts/update-internal-links.js --dry-run --check --strict \
-            tests/fixtures/data
+            src/fixtures/fixtures/data
 
       - name: Clone all translations
         if: ${{ matrix.name == 'languages' }}
@@ -169,7 +169,7 @@ jobs:
       - uses: ./.github/actions/warmup-remotejson-cache
         # Only the 'routing' tests include end-to-end tests about
         # archived enterprise server URLs.
-        if: ${{ matrix.name == 'routing' }}
+        if: ${{ matrix.name == 'redirects' }}
 
       - name: Index fixtures into the local Elasticsearch
         # For the sake of saving time, only run this step if the group
@@ -180,17 +180,11 @@ jobs:
       - name: Run tests
         env:
           DIFF_FILE: get_diff_files.txt
-          CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
+          CHANGELOG_CACHE_FILE_PATH: src/fixtures/fixtures/changelog-feed.json
           # By default, when `process.env.NODE_ENV === 'test'` it forces the
           # tests run only in English. The exception is the
           # `languages` suite which needs all languages to be set up.
           ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }}
-          ROOT: ${{ (matrix.name == 'rendering-fixtures' || matrix.name == 'pageinfo' || matrix.name == 'landings' ) && 'tests/fixtures' || '' }}
+          ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }}
-          TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'rendering-fixtures' || matrix.name == 'pageinfo') && 'tests/fixtures/translations' || '' }}
+          TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo') && 'src/fixtures/fixtures/translations' || '' }}
-        run: |
+        run: npm test -- src/${{ matrix.name }}/tests/
-          if [ -d "tests/${{ matrix.name }}/" ]
-          then
-            npm test -- tests/${{ matrix.name }}/
-          else
-            npm test -- src/${{ matrix.name }}/tests/
-          fi

content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md

@@ -212,7 +212,7 @@ jobs:
       - name: Run tests
         env:
           DIFF_FILE: get_diff_files.txt
-          CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
+          CHANGELOG_CACHE_FILE_PATH: src/fixtures/fixtures/changelog-feed.json
         run: npm test -- {% raw %}tests/${{ matrix.test-group }}/{% endraw %}
 ```
 

package.json

@@ -19,8 +19,8 @@
     "build": "next build",
     "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.js",
     "dev": "cross-env npm start",
-    "fixture-dev": "cross-env ROOT=tests/fixtures npm start",
+    "fixture-dev": "cross-env ROOT=src/fixtures/fixtures npm start",
-    "fixture-test": "cross-env ROOT=tests/fixtures npm test -- tests/rendering-fixtures",
+    "fixture-test": "cross-env ROOT=src/fixtures/fixtures npm test -- src/fixtures/tests",
     "index-test-fixtures": "node src/search/scripts/index-elasticsearch.js -l en -l ja -V ghae -V dotcom --index-prefix tests -- src/search/tests/fixtures/search-indexes",
     "lint": "eslint '**/*.{js,mjs,ts,tsx}'",
     "lint-content": "node src/content-linter/scripts/lint-content.js",
@@ -37,7 +37,7 @@
     "prestart": "node src/workflows/cmp-files.js package-lock.json .installed.package-lock.json || npm install && cp package-lock.json .installed.package-lock.json",
     "start": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon src/frame/server.js",
     "start-all-languages": "cross-env NODE_ENV=development nodemon src/frame/server.js",
-    "start-for-playwright": "cross-env ROOT=tests/fixtures TRANSLATIONS_FIXTURE_ROOT=tests/fixtures/translations ENABLED_LANGUAGES=en,ja NODE_ENV=test node src/frame/server.js",
+    "start-for-playwright": "cross-env ROOT=src/fixtures/fixtures TRANSLATIONS_FIXTURE_ROOT=src/fixtures/fixtures/translations ENABLED_LANGUAGES=en,ja NODE_ENV=test node src/frame/server.js",
     "sync-rest": "node src/rest/scripts/update-files.js",
     "sync-search": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test sync-search-server 4002 sync-search-indices",
     "sync-search-ghes-release": "cross-env GHES_RELEASE=1 start-server-and-test sync-search-server 4002 sync-search-indices",
@@ -200,8 +200,8 @@
     "testPathIgnorePatterns": [
       "node_modules/",
       "vendor/",
-      "tests/fixtures/",
+      "src/fixtures/fixtures/",
-      "tests/helpers/"
+      "src/tests/helpers/"
     ]
   },
   "dependencies": {

playwright.config.ts

@@ -10,7 +10,7 @@ import { defineConfig, devices } from '@playwright/test'
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig({
-  testDir: './tests',
+  testDir: './src/fixtures/tests',
   /* Maximum time one test can run for. */
   timeout: 30 * 1000,
   expect: {

src/archives/tests/deprecated-enterprise-versions.js

@@ -1,7 +1,7 @@
 import { describe, jest, test } from '@jest/globals'
 
 import enterpriseServerReleases from '#src/versions/lib/enterprise-server-releases.js'
-import { get, getDOM } from '../../../tests/helpers/e2etest.js'
+import { get, getDOM } from '#src/tests/helpers/e2etest.js'
 import { SURROGATE_ENUMS } from '#src/frame/middleware/set-fastly-surrogate-key.js'
 
 jest.useFakeTimers({ legacyFakeTimers: true })

src/assets/scripts/find-orphaned-assets.js

@@ -95,7 +95,7 @@ async function main(opts) {
     }
   }
 
-  const roots = ['tests', 'contributing', 'src', 'assets']
+  const roots = ['contributing', 'src', 'assets']
 
   for (const root of roots) {
     sourceFiles.push(

src/assets/tests/dynamic-assets.js

@@ -3,7 +3,7 @@ import sharp from 'sharp'
 import { fileTypeFromBuffer } from 'file-type'
 
 import { SURROGATE_ENUMS } from '#src/frame/middleware/set-fastly-surrogate-key.js'
-import { get, head } from '../../../tests/helpers/e2etest.js'
+import { get, head } from '#src/tests/helpers/e2etest.js'
 
 describe('dynamic assets', () => {
   jest.setTimeout(3 * 60 * 1000)

src/assets/tests/static-assets-1.js

@@ -1,7 +1,7 @@
 import nock from 'nock'
 import { expect, jest } from '@jest/globals'
 
-import { checkCachingHeaders } from '../../../tests/helpers/caching-headers.js'
+import { checkCachingHeaders } from '#src/tests/helpers/caching-headers.js'
 import { setDefaultFastlySurrogateKey } from '#src/frame/middleware/set-fastly-surrogate-key.js'
 import archivedEnterpriseVersionsAssets from '#src/archives/middleware/archived-enterprise-versions-assets.js'
 

src/assets/tests/static-assets.js

@@ -3,8 +3,8 @@ import path from 'path'
 
 import { jest, expect } from '@jest/globals'
 
-import { get } from '../../../tests/helpers/e2etest.js'
+import { get } from '#src/tests/helpers/e2etest.js'
-import { checkCachingHeaders } from '../../../tests/helpers/caching-headers.js'
+import { checkCachingHeaders } from '#src/tests/helpers/caching-headers.js'
 
 function getNextStaticAsset(directory) {
   const root = path.join('.next', 'static', directory)

src/audit-logs/tests/rendering.js

@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals'
 
-import { getDOM } from '../../../tests/helpers/e2etest.js'
+import { getDOM } from '#src/tests/helpers/e2etest.js'
 import { allVersions } from '#src/versions/lib/all-versions.js'
 import { getAuditLogEvents } from '../lib/index.js'
 

src/automated-pipelines/tests/rendering.js

@@ -4,7 +4,7 @@ import cheerio from 'cheerio'
 import { jest, test } from '@jest/globals'
 
 import { loadPages } from '#src/frame/lib/page-data.js'
-import { get } from '../../../tests/helpers/e2etest.js'
+import { get } from '#src/tests/helpers/e2etest.js'
 
 // Get a list of the autogenerated pages
 const pageList = await loadPages(undefined, ['en'])

src/changelogs/tests/get-rss-feeds.js

@@ -10,7 +10,7 @@ describe('getChangelogItems module', () => {
 
   beforeAll(async () => {
     const rssFeedContent = await fs.readFile(
-      path.join(process.cwd(), 'tests/fixtures/rss-feed.xml'),
+      path.join(process.cwd(), 'src/fixtures/fixtures/rss-feed.xml'),
       'utf8',
     )
 

src/content-linter/tests/lint-frontmatter.js

@@ -1,6 +1,6 @@
 import { loadPages, loadPageMap } from '#src/frame/lib/page-data.js'
 import loadRedirects from '#src/redirects/lib/precompile.js'
-import { checkURL } from '../../../tests/helpers/check-url.js'
+import { checkURL } from '#src/tests/helpers/check-url.js'
 
 const pageList = await loadPages(undefined, ['en'])
 const pages = await loadPageMap(pageList)

src/content-linter/tests/lint-versioning.js

@@ -5,7 +5,7 @@ import semver from 'semver'
 
 import featureVersionsSchema from '../lib/feature-versions-schema.js'
 import { getDeepDataByLanguage } from '#src/data-directory/lib/get-data.js'
-import { formatAjvErrors } from '../../../tests/helpers/schemas.js'
+import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
 
 /*
   NOTE: This test suite does NOT validate the `versions` frontmatter in content files.

src/content-linter/tests/unit/frontmatter-hidden-docs.js

@@ -4,7 +4,7 @@ import { runRule } from '../../lib/init-test.js'
 import { frontmatterHiddenDocs } from '../../lib/linting-rules/frontmatter-hidden-docs.js'
 
 const ACTIONS_FIXTURE = 'src/content-linter/tests/fixtures/actions/hidden.md'
-const EARLY_ACCESS_FIXTURE = 'tests/fixtures/content/early-access/secrets/early-days.md'
+const EARLY_ACCESS_FIXTURE = 'src/fixtures/fixtures/content/early-access/secrets/early-days.md'
 const EXPERIMENTAL_FIXTURE = 'src/content-linter/tests/fixtures/actions/experimental.md'
 const fmOptions = { markdownlintOptions: { frontMatter: null } }
 

src/content-linter/tests/unit/liquid-data-tags.js

@@ -10,7 +10,7 @@ describe(liquidDataReferencesDefined.names.join(' - '), () => {
   const envVarValueBefore = process.env.ROOT
 
   beforeAll(() => {
-    process.env.ROOT = path.join('tests', 'fixtures')
+    process.env.ROOT = path.join('src', 'fixtures', 'fixtures')
   })
 
   afterAll(() => {

src/content-linter/tests/unit/liquid-versioning.js

@@ -8,7 +8,7 @@ describe(liquidIfTags.names.join(' - '), () => {
   const envVarValueBefore = process.env.ROOT
 
   beforeAll(() => {
-    process.env.ROOT = path.join('tests', 'fixtures')
+    process.env.ROOT = path.join('src', 'fixtures', 'fixtures')
   })
 
   afterAll(() => {
@@ -39,7 +39,7 @@ describe(liquidIfVersionTags.names.join(' - '), () => {
   const envVarValueBefore = process.env.ROOT
 
   beforeAll(() => {
-    process.env.ROOT = path.join('tests', 'fixtures')
+    process.env.ROOT = path.join('src', 'fixtures', 'fixtures')
   })
 
   afterAll(() => {

src/content-render/tests/data.js

@@ -3,7 +3,7 @@ import { afterAll, beforeAll, expect, describe, it } from '@jest/globals'
 import Page from '#src/frame/lib/page.js'
 import languages from '#src/languages/lib/languages.js'
 import nonEnterpriseDefaultVersion from '#src/versions/lib/non-enterprise-default-version.js'
-import { DataDirectory } from '../../../tests/helpers/data-directory.js'
+import { DataDirectory } from '#src/tests/helpers/data-directory.js'
 
 describe('data tag', () => {
   let dd
@@ -30,7 +30,7 @@ describe('data tag', () => {
   it('should render fine if data is found', async () => {
     const page = await Page.init({
       relativePath: 'liquid-tags/good-data-variable.md',
-      basePath: './tests/fixtures',
+      basePath: './src/fixtures/fixtures',
       languageCode: 'en',
     })
     const context = {
@@ -47,7 +47,7 @@ describe('data tag', () => {
   it('should throw if the data tag is used with something unrecognized', async () => {
     const page = await Page.init({
       relativePath: 'liquid-tags/bad-data-variable.md',
-      basePath: './tests/fixtures',
+      basePath: './src/fixtures/fixtures',
       languageCode: 'en',
     })
     const context = {

src/content-render/tests/liquid-helpers.js

@@ -1,7 +1,7 @@
 import { afterAll, jest, beforeAll, expect } from '@jest/globals'
 import { liquid } from '#src/content-render/index.js'
 import languages from '#src/languages/lib/languages.js'
-import { DataDirectory } from '../../../tests/helpers/data-directory.js'
+import { DataDirectory } from '#src/tests/helpers/data-directory.js'
 
 describe('liquid helper tags', () => {
   jest.setTimeout(60 * 1000)

src/content-render/tests/render-changed-and-deleted-files.js

@@ -33,7 +33,7 @@ import path from 'path'
 
 import { jest } from '@jest/globals'
 
-import { head, get } from '../../../tests/helpers/e2etest.js'
+import { head, get } from '#src/tests/helpers/e2etest.js'
 import { loadPages } from '#src/frame/lib/page-data.js'
 
 const EMPTY = Symbol('EMPTY')

src/data-directory/tests/get-data.js

@@ -9,7 +9,7 @@ import {
   getDeepDataByLanguage,
   getUIDataMerged,
 } from '#src/data-directory/lib/get-data.js'
-import { DataDirectory } from '../helpers/data-directory.js'
+import { DataDirectory } from '#src/tests/helpers/data-directory.js'
 
 describe('get-data', () => {
   let dd

src/early-access/tests/early-access-rendering.js

@@ -3,8 +3,8 @@ import path from 'path'
 
 import { expect } from '@jest/globals'
 
-import { testViaActionsOnly } from '../../../tests/helpers/conditional-runs.js'
+import { testViaActionsOnly } from '#src/tests/helpers/conditional-runs.js'
-import { get, getDOM } from '../../../tests/helpers/e2etest.js'
+import { get, getDOM } from '#src/tests/helpers/e2etest.js'
 
 describe('cloning early-access', () => {
   testViaActionsOnly('the content directory exists', async () => {

src/early-access/tests/early-access-unit.js

@@ -1,7 +1,7 @@
 import { expect, jest, test } from '@jest/globals'
-import { get, getDOM } from '../../../tests/helpers/e2etest.js'
+import { get, getDOM } from '#src/tests/helpers/e2etest.js'
 
-import { describeIfDocsEarlyAccess } from '../../../tests/helpers/conditional-runs.js'
+import { describeIfDocsEarlyAccess } from '#src/tests/helpers/conditional-runs.js'
 import languages from '#src/languages/lib/languages.js'
 
 const VALID_EARLY_ACCESS_URI = '/early-access/github/save-time-with-slash-commands'

src/events/tests/middleware.js

@@ -1,5 +1,5 @@
 import { expect, jest } from '@jest/globals'
-import { post } from '../../../tests/helpers/e2etest.js'
+import { post } from '#src/tests/helpers/e2etest.js'
 
 describe('POST /events', () => {
   jest.setTimeout(60 * 1000)

src/fixtures/fixtures/README.md

@@ -17,7 +17,7 @@ have to worry about breaking tests of functionality.
 
 ## How to write fixtured based rendering tests
 
-The content is in `tests/fixtures/content/` (and `tests/fixtures/data/`)
+The content is in `src/fixtures/fixtures/content/` (and `src/fixtures/fixtures/data/`)
 is a cut down version of the real `content/` (and `data/`) at the root.
 It doesn't have nearly as many pages and if you look closely you'll see
 references and mentions to unrealistic things like "foo" or "HubGit"
@@ -26,7 +26,7 @@ with any silly name, the code is modular and good.
 
 ### Quickstart
 
-Navigate around in `tests/fixtures/content/` and familiarize yourself
+Navigate around in `src/fixtures/fixtures/content/` and familiarize yourself
 with the directory structure. The only things that are "identical" to the
 real content is the top-level product names which match the real content.
 Deeper than the product level, the names and directories can be whatever
@@ -47,13 +47,13 @@ action.
 Feel free to create sub-directories or new files. For example, if it's
 about end-to-end testing a new custom Liquid tag called
 `lib/liquid-tags/snacks.js` you create a new test called
-`tests/rendering-fixtures/snack.js`. (And equally, you might want to create
+`src/fixtures/tests/snack.js`. (And equally, you might want to create
-`tests/fixtures/content/get-started/foo/snacking.md`)
+`src/fixtures/fixtures/content/get-started/foo/snacking.md`)
 
 To run the tests use:
 
 ```shell
-ROOT=tests/fixtures jest tests/rendering-fixtures/
+ROOT=src/fixtures/fixtures jest src/fixtures/tests
 ```
 
 ### Exceptions