Merge pull request #23 from mtrezza/increase-test-coverage

Increase test coverage

Author: mtrezza

spec/ApiMailAdapter.spec.js

@@ -123,7 +123,7 @@ describe('ApiMailAdapter', () => {
       }
     });
 
-    it('fails with invalid placeholder callback configuration', async () => {
+    it('fails with invalid placeholder callback', async () => {
       const configs = [
         { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds, placeholderCallback: {} } } },
         { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds, placeholderCallback: ds } } }
@@ -133,6 +133,29 @@ describe('ApiMailAdapter', () => {
       }
     });
 
+    it('fails with missing or invalid API callback', async () => {
+      const configs = [
+        { sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds } } },
+        { apiCallback: null, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds } } },
+        { apiCallback: true, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds } } },
+        { apiCallback: ds, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds } } },
+      ];
+      for (const config of configs) {
+        expect(adapter(config)).toThrow(Errors.Error.apiCallbackNoFunction);
+      }
+    });
+
+    it('fails with invalid locale callback', async () => {
+      const configs = [
+        { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds, localeCallback: ds } } },
+        { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds, localeCallback: true } } },
+        { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds, localeCallback: [] } } },
+      ];
+      for (const config of configs) {
+        expect(adapter(config)).toThrow(Errors.Error.localeCallbackNoFunction);
+      }
+    });
+
     it('succeeds with valid configuration', async () => {
       const configs = [
         { apiCallback: df, sender: ds, templates: { customEmail: { subjectPath: ds, textPath: ds } } },
@@ -607,7 +630,7 @@ describe('ApiMailAdapter', () => {
       expect(htmlSpyData.toString('utf8')).toEqual(htmlFileData.toString('utf8'));
     });
 
-    it('falls back to default file if there is no language or locale match', async function () {
+    it('falls back to default file if there is no language or locale match', async () => {
       // Pretend that there are no files in folders `de-AT` and `de`
       spyOn(adapter, '_fileExists').and.callFake(async (path) => {
         return !/\/templates\/de(-AT)?\//.test(path);
@@ -627,6 +650,16 @@ describe('ApiMailAdapter', () => {
       expect(htmlSpyData.toString('utf8')).toEqual(htmlFileData.toString('utf8'));
     });
 
+    it('falls back to default file if file access throws', async () => {
+      const getLocalizedFilePathSpy = spyOn(adapter, '_getLocalizedFilePath').and.callThrough();
+      spyOn(fs, 'access').and.callFake(async () => {
+        throw 'Test file access error';
+      });
+      await adapter._createApiData(options);
+      const file = await getLocalizedFilePathSpy.calls.all()[0].returnValue;
+      expect(file).toMatch(options.template.subjectPath);
+    });
+
     it('makes user locale available in API callback', async () => {
       const locale = await options.template.localeCallback();
       const email = {

spec/Errors.spec.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const Errors = require('../src/Errors');
+
+describe('Errors', () => {
+  it('should create a custom error', () => {
+    const message = "Example Error";
+    const error = Errors.customError(message);
+    expect(error.message).toBe(message);
+    expect(error instanceof Error).toBeTrue();
+  });
+});

src/ApiMailAdapter.js

@@ -30,7 +30,7 @@ class ApiMailAdapter extends MailAdapter {
 
     // Ensure API callback is set
     if (typeof apiCallback !== 'function') {
-      throw Errors.Error.apiClientCallbackNoFuncion;
+      throw Errors.Error.apiCallbackNoFunction;
     }
 
     // Initialize
@@ -311,7 +311,7 @@ class ApiMailAdapter extends MailAdapter {
    * @description Loads a file's content.
    * @param {String} path The file path.
    * @param {String} locale The locale if a localized version of the file should be
-   * loaded if available, or `undefined` if no localiziation should occur.
+   * loaded if available, or `undefined` if no localization should occur.
    * @returns {Promise<Buffer>} The file content.
    */
   async _loadFile(path, locale) {
@@ -393,7 +393,7 @@ class ApiMailAdapter extends MailAdapter {
    * @function getLocalizedFilePath
    * @description Returns a localized file path matching a given locale.
    *
-   * Localized files are placed in subfolders of the given path, for example:
+   * Localized files are placed in sub-folders of the given path, for example:
    *
    * root/
    * ├── base/                    // base path to files
@@ -414,37 +414,29 @@ class ApiMailAdapter extends MailAdapter {
    * if a localized file could not be determined.
    */
   async _getLocalizedFilePath(filePath, locale) {
-    try {
-      // Get file name and base path
-      const file = path.basename(filePath);
-      const basePath = path.dirname(filePath);
-
-      // If locale is not set return default file
-      if (!locale) { return filePath; }
+    // Get file name and base path
+    const file = path.basename(filePath);
+    const basePath = path.dirname(filePath);
 
-      // Check file for locale exists
-      const localePath = path.join(basePath, locale, file);
-      const localeFileExists = await this._fileExists(localePath);
+    // If locale is not set return default file
+    if (!locale) { return filePath; }
 
-      // If file for locale exists return file
-      if (localeFileExists) { return localePath; }
+    // Check file for locale exists
+    const localePath = path.join(basePath, locale, file);
+    const localeFileExists = await this._fileExists(localePath);
 
-      // Check file for language exists
-      const languagePath = path.join(basePath, locale.split("-")[0], file);
-      const languageFileExists = await this._fileExists(languagePath);
+    // If file for locale exists return file
+    if (localeFileExists) { return localePath; }
 
-      // If file for language exists return file
-      if (languageFileExists) { return languagePath; }
+    // Check file for language exists
+    const languagePath = path.join(basePath, locale.split("-")[0], file);
+    const languageFileExists = await this._fileExists(languagePath);
 
-      // Return default file path
-      return filePath;
+    // If file for language exists return file
+    if (languageFileExists) { return languagePath; }
 
-    } catch (e) {
-      console.log("error in getLocalizedFilePath: " + e);
-
-      // Return default file path
-      return filePath;
-    }
+    // Return default file path
+    return filePath;
   }
 
   /**

src/Errors.js

@@ -16,7 +16,7 @@ class Errors extends Error {
       configurationInvalid: new Error('ApiMailAdapter: configuration is missing or invalid.'),
       templatesInvalid: new Error('ApiMailAdapter: templates are missing or invalid.'),
       templateContentPathInvalid: new Error('ApiMailAdapter: template content path is invalid.'),
-      apiCallbackNoFuncion: new Error('ApiMailAdapter: API callback is not a function.'),
+      apiCallbackNoFunction: new Error('ApiMailAdapter: API callback is not a function.'),
       templateCallbackNoFunction: new Error('ApiMailAdapter: placeholder callback is not a function.'),
       localeCallbackNoFunction: new Error('ApiMailAdapter: locale callback is not a function.'),
       templateConfigurationNoName: new Error('ApiMailAdapter: template name is missing.'),