Merge pull request #256 from vtexdocs/feat/tests

Feat/Tests

.github/workflows/cypress.yml

@@ -6,31 +6,19 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v1
-      - name: Use Node.js 14.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-      - name: Install
-        run: |
-          yarn install --immutable --immutable-cache --check-cache
-      - name: Build
-        run: |
-          yarn build
-        env:
-          GITHUB_PRIVATEKEY: ${{ secrets.PRIVATEKEY }}
-          GITHUB_APPID: ${{ secrets.APPID }}
-          GITHUB_INSTALLATIONID: ${{ secrets.INSTALLATIONID }}
       - name: Waiting for 200 from the Netlify Preview
-        uses: kamranayub/wait-for-netlify-action@2.0.0
+        uses: jakepartusch/wait-for-netlify-action@v1.4
         id: wait-for-netflify-preview
         with:
           site_name: 'elated-hoover-5c29bf'
+          max_timeout: 1800
         env:
-          NETLIFY_TOKEN: ${{secrets.NETLIFY_TOKEN}}
+          NETLIFY_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
+      - name: Fetch navigation.json
+        uses: wei/curl@v1
+        with:
+          args: -o src/tests/cypress/fixtures/navigation.json https://developers.vtex.com/navigation.json
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v5
         env:
           CYPRESS_baseUrl: ${{ steps.wait-for-netflify-preview.outputs.url }}
-        with:
-          wait-on: ${{ steps.wait-for-netflify-preview.outputs.url }}
-          wait-on-timeout: 90

cypress.config.mjs

@@ -0,0 +1,13 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+  fixturesFolder: 'src/tests/cypress/fixtures',
+  screenshotsFolder: 'src/tests/cypress/screenshots',
+  videosFolder: 'src/tests/cypress/videos',
+  downloadsFolder: 'src/tests/cypress/downloads',
+  e2e: {
+    specPattern: 'src/tests/cypress/integration/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'src/tests/cypress/support/index.js',
+    baseUrl: 'http://localhost:3000',
+  },
+})

package.json

@@ -18,7 +18,8 @@
     "postinstall": "husky install",
     "cz-commit": "cz",
     "release": "standard-version",
-    "index": "chmod +x ./algolia/scripts/scraper.sh && ./algolia/scripts/scraper.sh"
+    "index": "chmod +x ./algolia/scripts/scraper.sh && ./algolia/scripts/scraper.sh",
+    "cypress": "cypress open"
   },
   "dependencies": {
     "@openreplay/tracker": "^4.1.9",
@@ -58,6 +59,7 @@
     "search-insights": "^2.3.0",
     "sharp": "^0.31.2",
     "swr": "^1.3.0",
+    "unist-builder": "^3.0.1",
     "unist-util-visit": "^4.1.1",
     "use-yarn": "^2.4.0",
     "uuid": "^9.0.0"
@@ -73,7 +75,7 @@
     "@typescript-eslint/parser": "^5.14.0",
     "@vtex/prettier-config": "^1.0.0",
     "@vtex/tsconfig": "^0.6.0",
-    "cypress": "^9.5.2",
+    "cypress": "12.5.1",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^7.32.0",
     "eslint-config-next": "13.0.6",

src/tests/cypress/integration/documentation-pages-status.cy.js

@@ -0,0 +1,21 @@
+/// <reference types="cypress" />
+
+import navigation from '../fixtures/navigation.json'
+
+describe('Status of documentation pages', () => {
+  const visitDocumentationPages = (slugPrefix) => {
+    const visitPages = ({ slug, type, children }) => {
+      const page = `${slugPrefix}/${slug}`
+      if (type === 'markdown' || type === 'openapi')
+        it(`Checks page ${page}`, () => cy.visit(page))
+
+      children.forEach(visitPages)
+    }
+
+    return visitPages
+  }
+
+  navigation.navbar.forEach(({ slugPrefix, categories }) => {
+    categories.forEach(visitDocumentationPages(slugPrefix))
+  })
+})

src/utils/getHeadings.ts

@@ -1,6 +1,8 @@
 import { toString } from 'mdast-util-to-string'
 import { slugify } from 'utils/string-utils'
-import { visit, Node } from 'unist-util-visit'
+import { visit } from 'unist-util-visit'
+
+import type { Node } from 'unist'
 import type { Item } from 'components/table-of-contents'
 
 interface Heading {