167 - Upload of branding and upload of partners

.eslintrc

@@ -5,7 +5,7 @@
   },
   "extends": "eslint:recommended",
   "parserOptions": {
-    "ecmaVersion": 8
+    "ecmaVersion": 9
   },
   "rules": {
     "eqeqeq": "error",

README.md

@@ -112,6 +112,8 @@ In order to avoid overwriting someone elses configuration medic-conf records the
 * upload app settings to server
 * upload resources to server
 * upload custom translations to the server
+* upload branding to server
+* upload partners to server
 
 ## Forms
 

src/fn/upload-branding.js

@@ -0,0 +1,12 @@
+const environment = require('../lib/environment');
+const uploadConfigurationDocs = require('../lib/upload-configuration-docs');
+
+module.exports = {
+  requiresInstance: true,
+  execute: () => {
+    const configurationPath = `${environment.pathToProject}/branding.json`;
+    const directoryPath = `${environment.pathToProject}/branding`;
+
+    return uploadConfigurationDocs(configurationPath, directoryPath, 'branding');
+  }
+};

src/fn/upload-partners.js

@@ -0,0 +1,12 @@
+const environment = require('../lib/environment');
+const uploadConfigurationDocs = require('../lib/upload-configuration-docs');
+
+module.exports = {
+  requiresInstance: true,
+  execute: () => {
+    const configurationPath = `${environment.pathToProject}/partners.json`;
+    const directoryPath = `${environment.pathToProject}/partners`;
+
+    return uploadConfigurationDocs(configurationPath, directoryPath, 'partners');
+  }
+};

src/fn/upload-resources.js

@@ -1,39 +1,12 @@
-const attachmentsFromDir = require('../lib/attachments-from-dir');
 const environment = require('../lib/environment');
-const fs = require('../lib/sync-fs');
-const pouch = require('../lib/db');
-const { info, warn } = require('../lib/log');
-const insertOrReplace = require('../lib/insert-or-replace');
-const warnUploadOverwrite = require('../lib/warn-upload-overwrite');
+const uploadConfigurationDocs = require('../lib/upload-configuration-docs');
 
 module.exports = {
   requiresInstance: true,
-  execute: async () => {
-    const resourcesPath = fs.path.resolve(`${environment.pathToProject}/resources.json`);
+  execute: () => {
+    const configurationPath = `${environment.pathToProject}/resources.json`;
+    const directoryPath = `${environment.pathToProject}/resources`;
 
-    if(!fs.exists(resourcesPath)) {
-      warn(`No resources file found at path: ${resourcesPath}`);
-      return Promise.resolve();
-    }
-
-    const doc = {
-      _id: 'resources',
-      resources: fs.readJson(resourcesPath),
-      _attachments: attachmentsFromDir(`${environment.pathToProject}/resources`),
-    };
-
-    const db = pouch();
-
-    const changes = await warnUploadOverwrite.preUploadDoc(db, doc);
-    if (changes) {
-      await insertOrReplace(db, doc);
-      info('Resources file uploaded');
-    } else {
-      info('Resources file not uploaded as no changes found');
-    }
-
-    warnUploadOverwrite.postUploadDoc(doc);
-
-    return Promise.resolve();
+    return uploadConfigurationDocs(configurationPath, directoryPath, 'resources');
   }
 };

src/lib/main.js

@@ -25,6 +25,8 @@ const defaultActions = [
   'upload-collect-forms',
   'upload-contact-forms',
   'upload-resources',
+  'upload-branding',
+  'upload-partners',
   'upload-custom-translations',
 ];
 const defaultArchiveActions = [
@@ -37,6 +39,8 @@ const defaultArchiveActions = [
   'upload-collect-forms',
   'upload-contact-forms',
   'upload-resources',
+  'upload-branding',
+  'upload-partners',
   'upload-custom-translations',
 ];
 

src/lib/upload-configuration-docs.js

@@ -0,0 +1,43 @@
+const attachmentsFromDir = require('../lib/attachments-from-dir');
+const fs = require('../lib/sync-fs');
+const pouch = require('../lib/db');
+const insertOrReplace = require('../lib/insert-or-replace');
+const warnUploadOverwrite = require('../lib/warn-upload-overwrite');
+const { info, warn } = require('../lib/log');
+
+module.exports = async (configPath, directoryPath, dbDocName) => {
+  if (!configPath && !directoryPath && !dbDocName) {
+    warn('Information missing: Make sure to provide the configuration file path and the directory path.');
+    return Promise.resolve();
+  }
+
+  const jsonPath = fs.path.resolve(configPath);
+
+  if (!fs.exists(jsonPath)) {
+    warn(`No configuration file found at path: ${jsonPath}`);
+    return Promise.resolve();
+  }
+
+  const settings = fs.readJson(jsonPath);
+
+  const doc = {
+    ...settings,
+    _id: dbDocName,
+    _attachments: attachmentsFromDir(directoryPath),
+  };
+
+  const db = pouch();
+
+  const changes = await warnUploadOverwrite.preUploadDoc(db, doc);
+
+  if (changes) {
+    await insertOrReplace(db, doc);
+    info('Configuration upload complete!');
+  } else {
+    info('Configuration not uploaded as no changes found');
+  }
+
+  warnUploadOverwrite.postUploadDoc(doc);
+
+  return Promise.resolve();
+};

test/fn/upload-branding.spec.js

@@ -0,0 +1,26 @@
+const { expect } = require('chai');
+const sinon = require('sinon');
+const rewire = require('rewire');
+const environment = require('../../src/lib/environment');
+const uploadBranding = rewire('../../src/fn/upload-branding');
+
+describe('Upload Branding', () => {
+  afterEach(() => {
+    sinon.reset();
+  });
+
+  it('should call uploadConfigurationDocs with expected parameters', async () => {
+    const configurationPath = `${environment.pathToProject}/branding.json`;
+    const directoryPath = `${environment.pathToProject}/branding`;
+    const dbDocName = 'branding';
+    const uploadConfigurationDocs = sinon.stub().returns(Promise.resolve());
+
+    return uploadBranding.__with__({ uploadConfigurationDocs })(async () => {
+      await uploadBranding.execute();
+
+      expect(uploadConfigurationDocs.args[0][0]).to.equal(configurationPath);
+      expect(uploadConfigurationDocs.args[0][1]).to.equal(directoryPath);
+      expect(uploadConfigurationDocs.args[0][2]).to.equal(dbDocName);
+    });
+  });
+});

test/fn/upload-partners.spec.js

@@ -0,0 +1,26 @@
+const { expect } = require('chai');
+const sinon = require('sinon');
+const rewire = require('rewire');
+const environment = require('../../src/lib/environment');
+const uploadPartners = rewire('../../src/fn/upload-partners');
+
+describe('Upload Partners', () => {
+  afterEach(() => {
+    sinon.reset();
+  });
+
+  it('should call uploadConfigurationDocs with expected parameters', async () => {
+    const configurationPath = `${environment.pathToProject}/partners.json`;
+    const directoryPath = `${environment.pathToProject}/partners`;
+    const dbDocName = 'partners';
+    const uploadConfigurationDocs = sinon.stub().returns(Promise.resolve());
+
+    return uploadPartners.__with__({ uploadConfigurationDocs })(async () => {
+      await uploadPartners.execute();
+
+      expect(uploadConfigurationDocs.args[0][0]).to.equal(configurationPath);
+      expect(uploadConfigurationDocs.args[0][1]).to.equal(directoryPath);
+      expect(uploadConfigurationDocs.args[0][2]).to.equal(dbDocName);
+    });
+  });
+});

test/fn/upload-resources.spec.js

@@ -0,0 +1,26 @@
+const { expect } = require('chai');
+const sinon = require('sinon');
+const rewire = require('rewire');
+const environment = require('../../src/lib/environment');
+const uploadResources = rewire('../../src/fn/upload-resources');
+
+describe('Upload Resources', () => {
+  afterEach(() => {
+    sinon.reset();
+  });
+
+  it('should call uploadConfigurationDocs with expected parameters', async () => {
+    const configurationPath = `${environment.pathToProject}/resources.json`;
+    const directoryPath = `${environment.pathToProject}/resources`;
+    const dbDocName = 'resources';
+    const uploadConfigurationDocs = sinon.stub().returns(Promise.resolve());
+
+    return uploadResources.__with__({ uploadConfigurationDocs })(async () => {
+      await uploadResources.execute();
+
+      expect(uploadConfigurationDocs.args[0][0]).to.equal(configurationPath);
+      expect(uploadConfigurationDocs.args[0][1]).to.equal(directoryPath);
+      expect(uploadConfigurationDocs.args[0][2]).to.equal(dbDocName);
+    });
+  });
+});

test/lib/upload-configuration-docs.spec.js

@@ -0,0 +1,148 @@
+const { expect } = require('chai');
+const sinon = require('sinon');
+const api = require('../api-stub');
+const rewire = require('rewire');
+const uploadConfigurationDocs = rewire('../../src/lib/upload-configuration-docs');
+
+describe('Upload Configuration Docs', () => {
+  let fs;
+  let warn;
+  let pouch;
+  let warnUploadOverwrite;
+  let insertOrReplace;
+  let attachmentsFromDir;
+  let configuration = {
+    title: 'ABC Company',
+    resources: {
+      greatCompany: 'greatCompany.png',
+      aliasCompany: 'aliasCompany.png'
+    }
+  };
+
+  beforeEach(() => {
+    api.start();
+    fs = {
+      exists: () => true,
+      readJson: () => configuration,
+      path: {
+        resolve: () => 'path/configuration.json'
+      }
+    };
+    warnUploadOverwrite = {
+      preUploadDoc: sinon.stub(),
+      postUploadDoc: sinon.stub()
+    };
+    warn = sinon.stub();
+    pouch = sinon.stub();
+    insertOrReplace = sinon.stub();
+    attachmentsFromDir = sinon.stub();
+  });
+
+  afterEach(() => {
+    api.stop();
+    sinon.reset();
+  });
+
+  it('should upload configuration', async () => {
+    warnUploadOverwrite.preUploadDoc.returns(true);
+    insertOrReplace.returns(Promise.resolve());
+    attachmentsFromDir.returns({ image: {} });
+
+    const configurationDoc = {
+      _id: 'configurationDoc',
+      title: 'ABC Company',
+      resources: {
+        greatCompany: 'greatCompany.png',
+        aliasCompany: 'aliasCompany.png'
+      },
+      _attachments: { image: {} }
+    };
+    const rewireWith = {
+      fs,
+      pouch,
+      attachmentsFromDir,
+      warnUploadOverwrite,
+      insertOrReplace
+    };
+
+    return uploadConfigurationDocs.__with__(rewireWith)(async () => {
+      await uploadConfigurationDocs('path/configuration.json', 'path/configuration', 'configurationDoc');
+
+      expect(attachmentsFromDir.called).to.be.true;
+      expect(pouch.called).to.be.true;
+      expect(warnUploadOverwrite.preUploadDoc.args[0][1]).to.deep.include(configurationDoc);
+      expect(warnUploadOverwrite.postUploadDoc.args[0][0]).to.deep.include(configurationDoc);
+      expect(insertOrReplace.args[0][1]).to.deep.include(configurationDoc);
+    });
+  });
+
+  it('should warn when paths no provided', async () => {
+    fs.exists = () => false;
+    const rewireWith = {
+      fs,
+      warn,
+      pouch,
+      attachmentsFromDir,
+      warnUploadOverwrite,
+      insertOrReplace
+    };
+
+    return uploadConfigurationDocs.__with__(rewireWith)(async () => {
+      await uploadConfigurationDocs('configuration.js', 'configuration', 'configuration');
+
+      expect(warn.called).to.be.true;
+      expect(attachmentsFromDir.called).to.be.false;
+      expect(pouch.called).to.be.false;
+      expect(warnUploadOverwrite.preUploadDoc.called).to.be.false;
+      expect(insertOrReplace.called).to.be.false;
+    });
+  });
+
+  it('should warn when config file doesnt exists', async () => {
+    fs.exists = () => false;
+    const rewireWith = {
+      fs,
+      warn,
+      pouch,
+      attachmentsFromDir,
+      warnUploadOverwrite,
+      insertOrReplace
+    };
+
+    return uploadConfigurationDocs.__with__(rewireWith)(async () => {
+      await uploadConfigurationDocs('configuration.js', 'configuration', 'configuration');
+
+      expect(warn.called).to.be.true;
+      expect(attachmentsFromDir.called).to.be.false;
+      expect(pouch.called).to.be.false;
+      expect(warnUploadOverwrite.preUploadDoc.called).to.be.false;
+      expect(insertOrReplace.called).to.be.false;
+    });
+  });
+
+  it('should inform when no changes detected', async () => {
+    warnUploadOverwrite.preUploadDoc.returns(false);
+    insertOrReplace.returns(Promise.resolve());
+    attachmentsFromDir.returns({ image: {} });
+    const info = sinon.stub();
+    const rewireWith = {
+      fs,
+      info,
+      pouch,
+      attachmentsFromDir,
+      warnUploadOverwrite,
+      insertOrReplace
+    };
+
+    return uploadConfigurationDocs.__with__(rewireWith)(async () => {
+      await uploadConfigurationDocs('configuration.js', 'configuration', 'configuration');
+
+      expect(info.called).to.be.true;
+      expect(attachmentsFromDir.called).to.be.true;
+      expect(pouch.called).to.be.true;
+      expect(warnUploadOverwrite.preUploadDoc.called).to.be.true;
+      expect(warnUploadOverwrite.postUploadDoc.called).to.be.true;
+      expect(insertOrReplace.called).to.be.false;
+    });
+  });
+});