Merge branch 'MAS-121-SendEmailWithPreferences-2' of https://github.com/nhsevidence/MAS into MAS-121-SendEmailWithPreferences-2

Author: dylan

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto
+/cms/** eol=lf

cms/.eslintignore

@@ -0,0 +1 @@
+!.eslintrc.js

cms/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+	parser: "babel-eslint",
+	extends: [
+		"@nice-digital/eslint-config/es6",
+		"plugin:prettier/recommended",
+		"prettier/standard"
+	],
+	parserOptions: {
+		ecmaFeatures: {
+			jsx: true,
+			modules: true
+		}
+	},
+	env: {
+		es6: true,
+		jest: true
+	}
+};

cms/.prettierignore

@@ -0,0 +1 @@
+package.json

cms/.prettierrc

@@ -0,0 +1,18 @@
+{
+	"semi": true,
+	"singleQuote": false,
+	"trailingComma": "none",
+	"useTabs": true,
+	"printWidth": 80,
+	"endOfLine": "lf",
+	"overrides": [
+		{
+			"files": ["**/*.scss"],
+			"options": {
+				"useTabs": false,
+				"tabWidth": 2,
+				"singleQuote": true
+			}
+		}
+	]
+}

cms/.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+	"recommendations": [
+		"EditorConfig.EditorConfig",
+		"dbaeumer.vscode-eslint",
+		"andys8.jest-snippets",
+		"eg2.vscode-npm-script",
+		"christian-kohler.npm-intellisense",
+		"christian-kohler.path-intellisense",
+		"esbenp.prettier-vscode",
+		"hex-ci.stylelint-plus"
+	]
+}

cms/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+	"editor.formatOnSave": true,
+	"editor.rulers": [80],
+	"files.eol": "\n"
+}

cms/MAS.CMS.nuspec

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
+	<metadata>
+		<id>MAS.CMS</id>
+		<version>1.0.0</version>
+		<title>MAS CMS</title>
+		<authors>NICE Digital Services,Ian Routledge</authors>
+		<owners>nice-digital</owners>
+		<projectUrl>https://github.com/nice-digital/MAS</projectUrl>
+		<iconUrl>https://cdn.nice.org.uk/V3/Content/nice/favicon-120.png</iconUrl>
+		<requireLicenseAcceptance>false</requireLicenseAcceptance>
+		<description>Keystone CMS for Medicines Awareness Service</description>
+		<tags>keystonejs cms</tags>
+		<dependencies></dependencies>
+	</metadata>
+	<files>
+		<file src="models\**\*" target="models" />
+		<file src="public\**\*" target="public" />
+		<file src="routes\**\*" target="routes" />
+		<file src="updates\**\*" target="updates" />
+		<file src="dotenv.config" />
+		<file src="keystone.js" />
+		<file src="package-lock.json" />
+		<file src="package.json" />
+	</files>
+</package>

cms/README.md

@@ -12,6 +12,36 @@ Configure the CMS through environment variables.
 
 Running the CMS as part of the Docker stack from the root of this repo will automatically set these for you.
 
-- `MONGO_URL` - The URL for connecting to Mongo. Defaults to *mongodb://localhost:27017*
-- `PORT` - The port to run under. Defaults to *3010*.
-- `COOKIE_SECRET` 
+- `MONGO_URL` - The URL for connecting to Mongo. Defaults to _mongodb://localhost:27017_
+- `PORT` - The port to run under. Defaults to _3010_.
+- `COOKIE_SECRET`
+
+# Tests
+
+There are unit tests for custom logic and validation within the CMS. These use Jest under the hood.
+
+Run the tests (and linting) on the command line with:
+
+```
+npm test
+```
+
+Alternatively, run `npm run test:unit` to just run the unit tests without linting.
+
+## Watch mode
+
+Run the tests in watch mode when developing to automatically re-run changed tests:
+
+```
+npm run test:unit:watch
+```
+
+## Coverage
+
+Collect coverage by running the following command:
+
+```
+npm run test:unit:coverage
+```
+
+This reports coverage on the command line, and as HTML within the _coverage_ folder. It also reports coverage to TeamCity automatically when run on a build agent (or when the `TEAMCITY_VERSION` environment variable is set).

cms/__tests__/models/Weekly.test.js

@@ -0,0 +1,73 @@
+jest.mock("keystone", () => {
+	const list = {
+		add: jest.fn(),
+		schema: {
+			pre: jest.fn()
+		},
+		relationship: jest.fn(),
+		register: jest.fn()
+	};
+
+	return {
+		// Use a normal func and not an arrow so it can be used as a constructor
+		List: function() {
+			return list;
+		},
+		Field: {
+			Types: {}
+		}
+	};
+});
+
+describe("Weekly", () => {
+	let keystone, pre;
+
+	beforeEach(() => {
+		jest.resetModules();
+		require("../../models/Weekly");
+		keystone = require("keystone");
+
+		pre = keystone.List("Weekly").schema.pre;
+	});
+
+	it("should set up a pre-validate function", () => {
+		expect(pre).toHaveBeenCalledWith("validate", expect.any(Function));
+	});
+
+	it("should call next with no errors when validation succeeds", () => {
+		const validatorFn = pre.mock.calls[0][1];
+
+		const next = jest.fn();
+		validatorFn.call({}, next);
+
+		expect(next).toHaveBeenCalledWith();
+	});
+
+	it.each`
+		field                  | filledIn     | emptyFields
+		${"commentaryTitle"}   | ${"title"}   | ${"summary and body"}
+		${"commentarySummary"} | ${"summary"} | ${"title and body"}
+		${"commentaryBody"}    | ${"body"}    | ${"title and summary"}
+	`(
+		"should validate commentary $emptyFields when $filledIn is set",
+		({ field, filledIn, emptyFields }) => {
+			const pre = keystone.List("Weekly").schema.pre;
+
+			expect(pre).toHaveBeenCalledWith("validate", expect.any(Function));
+
+			const validatorFn = pre.mock.calls[0][1];
+
+			const next = jest.fn();
+			validatorFn.call(
+				{
+					[field]: "Test content"
+				},
+				next
+			);
+
+			const errorMessage = `Commentary ${emptyFields} are both required if commentary ${filledIn} is set`;
+
+			expect(next).toHaveBeenCalledWith(Error(errorMessage));
+		}
+	);
+});