test: ensure build is failed when netlify forms detected

orinokai · orinokai · commit 39511ed952d7 · 2024-06-26T13:03:54.000+01:00
diff --git a/tests/fixtures/netlify-forms/app/layout.js b/tests/fixtures/netlify-forms/app/layout.js
@@ -0,0 +1,12 @@
+export const metadata = {
+  title: 'Netlify Forms',
+  description: 'Test for verifying Netlify Forms',
+}
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/tests/fixtures/netlify-forms/app/page.js b/tests/fixtures/netlify-forms/app/page.js
@@ -0,0 +1,7 @@
+export default function Page() {
+  return (
+    <form data-netlify="true">
+      <button type="submit">Send</button>
+    </form>
+  )
+}
diff --git a/tests/fixtures/netlify-forms/next-env.d.ts b/tests/fixtures/netlify-forms/next-env.d.ts
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.
diff --git a/tests/fixtures/netlify-forms/next.config.js b/tests/fixtures/netlify-forms/next.config.js
@@ -0,0 +1,10 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  output: 'standalone',
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+  generateBuildId: () => 'build-id',
+}
+
+module.exports = nextConfig
diff --git a/tests/fixtures/netlify-forms/package.json b/tests/fixtures/netlify-forms/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "netlify-forms",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "postinstall": "next build",
+    "dev": "next dev",
+    "build": "next build"
+  },
+  "dependencies": {
+    "@netlify/functions": "^2.7.0",
+    "next": "latest",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "18.2.75"
+  }
+}
diff --git a/tests/fixtures/netlify-forms/tsconfig.json b/tests/fixtures/netlify-forms/tsconfig.json
@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "noEmit": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}
diff --git a/tests/integration/advanced-api-routes.test.ts b/tests/integration/advanced-api-routes.test.ts
@@ -1,7 +1,8 @@
 import { getLogger } from 'lambda-local'
 import { v4 } from 'uuid'
-import { beforeEach, vi, it, expect } from 'vitest'
-import { createFixture, runPlugin, type FixtureTestContext } from '../utils/fixture.js'
+import { beforeEach, expect, it, vi } from 'vitest'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, runPlugin } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 
 getLogger().level = 'alert'
diff --git a/tests/integration/netlify-forms.test.ts b/tests/integration/netlify-forms.test.ts
@@ -0,0 +1,31 @@
+import { getLogger } from 'lambda-local'
+import { v4 } from 'uuid'
+import { beforeEach, expect, it, vi } from 'vitest'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, runPlugin } from '../utils/fixture.js'
+import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
+
+getLogger().level = 'alert'
+
+beforeEach<FixtureTestContext>(async (ctx) => {
+  // set for each test a new deployID and siteID
+  ctx.deployID = generateRandomObjectID()
+  ctx.siteID = v4()
+  vi.stubEnv('SITE_ID', ctx.siteID)
+  vi.stubEnv('DEPLOY_ID', ctx.deployID)
+  vi.stubEnv('NETLIFY_PURGE_API_TOKEN', 'fake-token')
+  // hide debug logs in tests
+  // vi.spyOn(console, 'debug').mockImplementation(() => {})
+
+  await startMockBlobStore(ctx)
+})
+
+it<FixtureTestContext>('test', async (ctx) => {
+  await createFixture('netlify-forms', ctx)
+
+  const runPluginPromise = runPlugin(ctx)
+
+  await expect(runPluginPromise).rejects.toThrow(
+    '@netlify/plugin-next@5 does not support Netlify Forms',
+  )
+})
