adding test for building redirects

Author: colbyfayock

src/index.js

@@ -42,6 +42,10 @@ module.exports = {
     const functionTemplatesPath = path.join(__dirname, 'templates/functions');
     const functionTemplates = await fs.readdir(functionTemplatesPath);
 
+    if ( !Array.isArray(functionTemplates) || functionTemplates.length == 0 ) {
+      throw new Error(`Failed to generate templates: can not find function templates in ${functionTemplatesPath}`);
+    }
+
     try {
       await Promise.all(functionTemplates.map(async templateFileName => {
         const bundle = await ncc(path.join(functionTemplatesPath, templateFileName));
@@ -53,8 +57,7 @@ module.exports = {
         await fs.writeFile(filePath, bundle.code, 'utf8');
       }));
     } catch(e) {
-      console.log('Failed to generate templates:', e);
-      throw e;
+      throw new Error(`Failed to generate templates: ${e}`);
     }
 
     // Configure reference parameters for Cloudinary delivery to attach to redirect

tests/lib/util.test.js

@@ -1,14 +1,14 @@
-const { isRemoteUrl, determineRemoteUrl } = require('../../src/lib/util');
+const { isRemoteUrl, determineRemoteUrl, getQueryParams } = require('../../src/lib/util');
 
 describe('lib/util', () => {
 
   describe('isRemoteUrl', () => {
-    
+
     test('should be a remote URL', () => {
       expect(isRemoteUrl('https://cloudinary.com')).toEqual(true);
       expect(isRemoteUrl('http://cloudinary.com')).toEqual(true);
     });
-    
+
     test('should not be a remote URL', () => {
       expect(isRemoteUrl('/images/cloud.jpg')).toEqual(false);
       expect(isRemoteUrl('images/cloud.jpg')).toEqual(false);
@@ -17,15 +17,15 @@ describe('lib/util', () => {
   });
 
   describe('determineRemoteUrl', () => {
-    
+
     test('should return original value when remote URL', () => {
       const secure = determineRemoteUrl('https://cloudinary.com', 'https://cloudinary.netlify.app');
       expect(secure).toEqual('https://cloudinary.com');
 
       const notSecure = determineRemoteUrl('http://cloudinary.com', 'https://cloudinary.netlify.app');
       expect(notSecure).toEqual('http://cloudinary.com');
     });
-    
+
     test('should prepend DEPLOY_PRIME_URL when local path', () => {
       const withStartingSlash = determineRemoteUrl('/images/cloud.jpg', 'https://cloudinary.netlify.app');
       expect(withStartingSlash).toEqual('https://cloudinary.netlify.app/images/cloud.jpg');
@@ -36,4 +36,19 @@ describe('lib/util', () => {
 
   });
 
+  describe('getQueryParams', () => {
+
+    test('should get query parameters by URL with a single param', () => {
+      const { myparam } = getQueryParams('https://cloudinary.com?myparam=myvalue')
+      expect(myparam).toEqual('myvalue');
+    });
+
+    test('should get query parameters by URL with a multiple params', () => {
+      const { myparam, otherparam } = getQueryParams('https://cloudinary.com?myparam=myvalue&otherparam=othervalue')
+      expect(myparam).toEqual('myvalue');
+      expect(otherparam).toEqual('othervalue');
+    });
+
+  });
+
 });

tests/on-build.test.js

@@ -0,0 +1,127 @@
+const fs = require('fs-extra');
+const ncc = require('@vercel/ncc');
+const { onBuild } = require('../src/');
+
+jest.mock('fs-extra', () => ({
+  readdir: jest.fn(),
+  ensureDir: jest.fn(),
+  writeFile: jest.fn(),
+}));
+
+jest.mock('@vercel/ncc', () => jest.fn());
+
+describe('onBuild', () => {
+
+  describe('Redirects', () => {
+
+    test('should create redirects with defaut fetch-based configuration', async () => {
+      const imagesFunctionName = 'cld_images';
+
+      fs.readdir.mockResolvedValue([imagesFunctionName]);
+      ncc.mockResolvedValue('exports.handler = async function (event, context) {}');
+
+      process.env.SITE_NAME = 'cool-site';
+      process.env.CLOUDINARY_CLOUD_NAME = 'testcloud';
+
+      const deliveryType = 'fetch';
+
+      const defaultRedirect = {
+        from: '/path',
+        to: '/other-path',
+        status: 200
+      }
+
+      const redirects = [defaultRedirect];
+
+      const netlifyConfig = {
+        redirects
+      };
+
+      await onBuild({
+        netlifyConfig,
+        constants: {
+          INTERNAL_FUNCTIONS_SRC: '.netlify/functions-internal'
+        },
+        inputs: {
+          deliveryType
+        }
+      });
+
+      expect(redirects[0]).toEqual({
+        from: '/images/*',
+        to: `/.netlify/functions/${imagesFunctionName}?path=/images/:splat&deliveryType=${deliveryType}&cloudName=${process.env.CLOUDINARY_CLOUD_NAME}&folder=${process.env.SITE_NAME}`,
+        status: 302,
+        force: true
+      });
+
+      expect(redirects[1]).toEqual({
+        from: 'cld-assets/images/*',
+        to: '/images/:splat',
+        status: 200,
+        force: true
+      });
+
+      expect(redirects[2]).toEqual(defaultRedirect);
+    });
+
+
+    test('should create redirects with upload delivery type and custom inputs', async () => {
+      const imagesFunctionName = 'cld_images';
+
+      fs.readdir.mockResolvedValue([imagesFunctionName]);
+      ncc.mockResolvedValue('exports.handler = async function (event, context) {}');
+
+      process.env.SITE_NAME = 'cool-site';
+
+      const cloudName = 'othercloud';
+      const deliveryType = 'upload';
+      const imagesPath = '/awesome';
+      const folder = 'test-folder';
+      const uploadPreset = 'my-upload-preset';
+
+      const defaultRedirect = {
+        from: '/path',
+        to: '/other-path',
+        status: 200
+      }
+
+      const redirects = [defaultRedirect];
+
+      const netlifyConfig = {
+        redirects
+      };
+
+      await onBuild({
+        netlifyConfig,
+        constants: {
+          INTERNAL_FUNCTIONS_SRC: '.netlify/functions-internal'
+        },
+        inputs: {
+          cloudName,
+          deliveryType,
+          imagesPath,
+          folder,
+          uploadPreset
+        }
+      });
+
+      expect(redirects[0]).toEqual({
+        from: `${imagesPath}/*`,
+        to: `/.netlify/functions/${imagesFunctionName}?path=${imagesPath}/:splat&uploadPreset=${uploadPreset}&deliveryType=${deliveryType}&cloudName=${process.env.CLOUDINARY_CLOUD_NAME}&folder=${folder}`,
+        status: 302,
+        force: true
+      });
+
+      expect(redirects[1]).toEqual({
+        from: `cld-assets${imagesPath}/*`,
+        to: `${imagesPath}/:splat`,
+        status: 200,
+        force: true
+      });
+
+      expect(redirects[2]).toEqual(defaultRedirect);
+    });
+
+  });
+
+});