data-quality: Add rule to ensure timezone matches IANA list

scheduleTimezone rule: update message with link to IANA

Author: Jared Parnell

src/rules/data-quality/timezone-in-partial-schedule-spec.js renamed to src/rules/data-quality/scheduletimezone-in-partialschedule-rule-spec.js

@@ -1,4 +1,4 @@
-const TimezoneInPartialSchedule = require('./timezone-in-partial-schedule');
+const TimezoneInPartialSchedule = require('./scheduletimezone-in-partial-schedule-rule');
 const Model = require('../../classes/model');
 const ModelNode = require('../../classes/model-node');
 const ValidationErrorType = require('../../errors/validation-error-type');

src/rules/data-quality/timezone-in-partial-schedule.js renamed to src/rules/data-quality/scheduletimezone-in-partialschedule-rule.js

@@ -1,4 +1,4 @@
-const RepeatCountIsPositiveInteger = require('./repeatcount-is-positive-integer');
+const RepeatCountIsPositiveInteger = require('./repeatcount-format-rule');
 const Model = require('../../classes/model');
 const ModelNode = require('../../classes/model-node');
 const ValidationErrorType = require('../../errors/validation-error-type');

src/rules/data-quality/repeatcount-is-positive-integer-spec.js renamed to src/rules/format/repeatcount-format-rule-spec.js

@@ -0,0 +1,63 @@
+const ScheduleTimezoneMatchesIANAList = require('./scheduletimezone-format-rule');
+const Model = require('../../classes/model');
+const ModelNode = require('../../classes/model-node');
+const ValidationErrorType = require('../../errors/validation-error-type');
+const ValidationErrorSeverity = require('../../errors/validation-error-severity');
+
+describe('ScheduleTimezoneMatchesIANAList', () => {
+  const rule = new ScheduleTimezoneMatchesIANAList();
+  const model = new Model({
+    type: 'PartialSchedule',
+    fields: {
+      scheduleTimezone: {
+        fieldName: 'scheduleTimezone',
+        requiredType: 'https://schema.org/Text',
+      },
+    },
+  }, 'latest');
+
+  it('should target PartialSchedule models', () => {
+    const isTargeted = rule.isModelTargeted(model);
+    expect(isTargeted).toBe(true);
+  });
+
+  it('should not return errors when scheduleTimezone is in the IANA database list', async () => {
+    const data = {
+      '@type': 'PartialSchedule',
+      scheduleTimezone: 'Europe/London',
+    };
+
+    const nodeToTest = new ModelNode(
+      '$',
+      data,
+      null,
+      model,
+    );
+
+    const errors = await rule.validate(nodeToTest);
+
+    expect(errors.length).toBe(0);
+  });
+
+  it('should return errors when scheduleTimezone is not in the IANA database list', async () => {
+    const data = {
+      '@type': 'PartialSchedule',
+      scheduleTimezone: 'Europe/Slough',
+    };
+
+    const nodeToTest = new ModelNode(
+      '$',
+      data,
+      null,
+      model,
+    );
+
+    const errors = await rule.validate(nodeToTest);
+
+    expect(errors.length).toBe(1);
+    for (const error of errors) {
+      expect(error.type).toBe(ValidationErrorType.MISSING_REQUIRED_FIELD);
+      expect(error.severity).toBe(ValidationErrorSeverity.FAILURE);
+    }
+  });
+});

src/rules/data-quality/repeatcount-is-positive-integer.js renamed to src/rules/format/repeatcount-format-rule.js

@@ -0,0 +1,52 @@
+const momentTZ = require('moment-timezone');
+const Rule = require('../rule');
+const ValidationErrorType = require('../../errors/validation-error-type');
+const ValidationErrorCategory = require('../../errors/validation-error-category');
+const ValidationErrorSeverity = require('../../errors/validation-error-severity');
+
+module.exports = class ScheduleTimezoneMatchesIANAList extends Rule {
+  constructor(options) {
+    super(options);
+    this.targetModels = ['Schedule', 'PartialSchedule'];
+    this.meta = {
+      name: 'ScheduleTimezoneMatchesIANAList',
+      description: 'Validates that scheduleTimezone matches an IANA Timezone.',
+      tests: {
+        default: {
+          message: 'scheduleTimezone must be one of the timezones contained in the [IANA Timezone database](https://www.iana.org/time-zones)',
+          sampleValues: {
+            field: 'scheduleTimezone',
+            allowedValues: 'Europe/London',
+          },
+          category: ValidationErrorCategory.CONFORMANCE,
+          severity: ValidationErrorSeverity.FAILURE,
+          type: ValidationErrorType.MISSING_REQUIRED_FIELD,
+        },
+      },
+    };
+  }
+
+  validateModel(node) {
+    const timezoneList = momentTZ.tz.names();
+    const scheduleTimezone = node.getValue('scheduleTimezone');
+
+    if (typeof scheduleTimezone === 'undefined') {
+      return [];
+    }
+    const errors = [];
+
+    if (!timezoneList.includes(scheduleTimezone)) {
+      errors.push(
+        this.createError(
+          'default',
+          {
+            scheduleTimezone,
+            path: node.getPath('scheduleTimezone'),
+          },
+        ),
+      );
+    }
+
+    return errors;
+  }
+};