Feat/add integration tests (#28)

* feat: add integration tests

* chore: test

* chore: update

* chore:  update

* chore: update

* chore: fix the headers test

* chore: cleanup

* chore: cleanup

Author: lukasholzer

.eslintignore

@@ -1,2 +1,3 @@
 dist/
 demo/
+tests/

.eslintrc.cjs

@@ -15,6 +15,7 @@ module.exports = {
     'unicorn/filename-case': ['error', { case: 'kebabCase' }],
     'import/no-namespace': 'off',
     'import/extensions': 'off',
+    'max-depth': 'off',
   },
   overrides: [
     ...overrides,

.github/workflows/run-tests.yml

@@ -7,12 +7,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: 'Install Node'
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18.x'
-    - name: 'Install dependencies'
-      run: npm ci
-    - name: 'Test'
-      run: npm run test:ci
+      - uses: actions/checkout@v4
+      - name: 'Install Node'
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: 'Install dependencies'
+        run: npm ci
+      - name: 'build'
+        run: npm run build
+      - name: 'Test'
+        run: npm run test:ci

.gitignore

@@ -1,5 +1,6 @@
 node_modules/
 dist/
+.next
 
 # Local Netlify folder
 .netlify

README.md

@@ -1,4 +1,20 @@
 # Next.js Runtime
 
-Next.js is supported natively on Netlify, and in most cases you will not need to install or configure anything. This
-repo includes the packages used to support Next.js on Netlify.
+Next.js is supported natively on Netlify, and in most cases you will not need to install or
+configure anything. This repo includes the packages used to support Next.js on Netlify.
+
+## Testing
+
+### Integration testing
+
+How to add new integration test scenarios to the application:
+
+1. Create a new folder under `tests/fixtures/<your-name>`
+2. Adapt the `next.config.js` to be a standalone application
+3. Create a `postinstall` script that runs the `next build`. It's important to notice that the
+   integration tests rely on a already built next.js application in this folder. They rely on the
+   `.next` folder.
+4. Add your test
+
+> Currently the tests require a built version of the `dist/handlers/cache.cjs` so you need to run
+> `npm run build` before executing the integration tests.