New: Migration Scripts (fixes #208)

migrations/v2.js

@@ -0,0 +1,225 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin } from 'adapt-migrations';
+
+describe('adapt-contrib-assessment - v2.0.0 > v2.0.3', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v2.0.0', { name: 'adapt-contrib-assessment', version: '<2.0.3' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _type, _assessment }) => _type === 'article' && _assessment !== undefined);
+    return assessments.length;
+  });
+
+  /**
+   * * Add field to each item in a JSON array and set blank.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._questions._canShowModelAnswer attribute', async () => {
+    assessments.forEach(assessment => {
+      assessment._questions.forEach(item => {
+        item._canShowModelAnswer = true;
+      });
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._questions._canShowModelAnswer attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._questions.every(item =>
+        item._canShowModelAnswer !== false
+      )
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _canShowModelAnswer not added to every instance of assessment._questions');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v2.0.3', { name: 'adapt-contrib-assessment', version: '2.0.3', framework: '>=2.0.0' });
+});
+
+describe('adapt-contrib-assessment - v2.0.3 > v2.1.0', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v2.0.3', { name: 'adapt-contrib-assessment', version: '<2.1.0' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _type, _assessment }) => _type === 'article' && _assessment !== undefined);
+    return assessments.length;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._suppressMarking', async () => {
+    assessments.forEach(assessment => {
+      assessment._suppressMarking = true;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._suppressMarking attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._suppressMarking === true
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _suppressMarking not added to every instance of assessment as true.');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v2.1.0', { name: 'adapt-contrib-assessment', version: '2.1.0', framework: '>=2.0.18' });
+});
+
+describe('adapt-contrib-assessment - v2.1.0 > v2.1.1', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v2.1.0', { name: 'adapt-contrib-assessment', version: '<2.1.1' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _type, _assessment }) => _type === 'article' && _assessment !== undefined);
+    if (assessments) return true;
+  });
+
+  /**
+   * * Modify existing attribute to new value.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._isPercentageBased', async () => {
+    assessments.forEach(assessment => {
+      if (assessment._isPercentageBased !== true) assessment._isPercentageBased = true;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._isPercentageBased attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._isPercentageBased === true
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _isPercentageBased has been modified to true');
+    return true;
+  });
+
+  /**
+   * * Modify existing attribute to new value.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._canShowFeedback', async () => {
+    assessments.forEach(assessment => {
+      if (assessment._canShowFeedback !== false) assessment._canShowFeedback = false;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._canShowFeedback attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._canShowFeedback === false
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _canShowFeedback has been modified to false');
+    return true;
+  });
+
+  /**
+   * * Modify existing attribute to new value.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._canShowMarking', async () => {
+    assessments.forEach(assessment => {
+      if (assessment._canShowMarking !== false) assessment._canShowMarking = false;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._canShowMarking attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._canShowMarking === false
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _canShowMarking has been modified to false');
+    return true;
+  });
+
+  /**
+   * * Modify existing attribute to new value.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._canShowModelAnswer', async () => {
+    assessments.forEach(assessment => {
+      if (assessment._canShowModelAnswer !== false) assessment._canShowModelAnswer = false;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._canShowModelAnswer attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._canShowModelAnswer === false
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _canShowModelAnswer has been modified to false');
+    return true;
+  });
+
+  /**
+   * * Remove existing attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._requireAssessmentPassed', async () => {
+    assessments.forEach(assessment => {
+      delete assessment._requireAssessmentPassed;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._requireAssessmentPassed attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._requireAssessmentPassed === undefined
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _requireAssessmentPassed has been removed');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v2.1.1', { name: 'adapt-contrib-assessment', version: '2.1.1', framework: '>=2.0.18' });
+});
+
+describe('adapt-contrib-assessment - v2.1.1 > v2.2.0', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v2.1.1', { name: 'adapt-contrib-assessment', version: '<2.2.0' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _type, _assessment }) => _type === 'article' && _assessment !== undefined);
+    if (assessments) return true;
+  });
+
+  /**
+   * * Modify Attribute
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._includeInTotalScore attribute', async () => {
+    assessments.forEach(assessment => {
+      assessment._includeInTotalScore = true;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._includeInTotalScore attribute', async () => {
+    const isValid = assessments.every(({ _includeInTotalScore }) => _includeInTotalScore === true);
+    if (!isValid) throw new Error('adapt-contrib-assessment - _includeInTotalScore not modified to true in every assessment instance.');
+    return true;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._allowResetIfPassed', async () => {
+    assessments.forEach(assessment => {
+      assessment._questions.forEach(item => {
+        item._allowResetIfPassed = false;
+      });
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._allowResetIfPassed attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._questions.every(item =>
+        item._allowResetIfPassed === false
+      )
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _allowResetIfPassed not added to every instance of assessment._questions');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v2.2.0', { name: 'adapt-contrib-assessment', version: 'v2.2.0', framework: '>=2.2.0' });
+});

migrations/v3.js

@@ -0,0 +1,29 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin } from 'adapt-migrations';
+
+describe('adapt-contrib-assessment - v2.2.0 > v3.0.0', async () => {
+  let course, assessmentConfig;
+
+  whereFromPlugin('adapt-contrib-assessment - from v2.2.0', { name: 'adapt-contrib-assessment', version: '<3.0.0' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    course = content.filter(({ _type }) => _type === 'course');
+    assessmentConfig = course.find(({ _assessment }) => _assessment);
+    if (assessmentConfig) return true;
+  });
+
+  /**
+   * * Remove JSON attribute from Course file.
+   */
+  mutateContent('adapt-contrib-assessment - remove course._postTotalScoreToLms attribute', async () => {
+    delete assessmentConfig._postTotalScoreToLms;
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check course._postTotalScoreToLms attribute', async () => {
+    const isValid = !assessmentConfig._postTotalScoreToLms;
+    if (!isValid) throw new Error('adapt-contrib-assessment - _postTotalScoreToLms removed from course file.');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v3.0.0', { name: 'adapt-contrib-assessment', version: '3.0.0', framework: '>=3.2.0' });
+});

migrations/v4.js

@@ -0,0 +1,123 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin } from 'adapt-migrations';
+
+describe('adapt-contrib-assessment - v3.0.0 > v4.3.0', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v3.0.0', { name: 'adapt-contrib-assessment', version: '<4.3.0' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _assessment }) => _assessment !== undefined);
+    return assessments.length;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._scrollToOnReset', async () => {
+    assessments.forEach(assessment => {
+      assessment._scrollToOnReset = false;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._scrollToOnReset attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._scrollToOnReset === false
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _scrollToOnReset not added to every instance of assessment');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v4.3.0', { name: 'adapt-contrib-assessment', version: '4.3.0', framework: '>=5.4.0' });
+});
+
+describe('adapt-contrib-assessment - v4.3.0 > v4.4.0', async () => {
+  let course, assessmentConfig, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v4.3.0', { name: 'adapt-contrib-assessment', version: '<4.4.0' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    course = content.filter(({ _type }) => _type === 'course');
+    assessmentConfig = course.find(({ _assessment }) => _assessment);
+    if (assessmentConfig) return true;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._scoreToPass', async () => {
+    assessments.forEach(assessment => {
+      assessment._scoreToPass = 60;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._scoreToPass attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._scoreToPass === 60
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _scoreToPass not added to every instance of assessment and set as 60.');
+    return true;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - add assessment._correctToPass', async () => {
+    assessments.forEach(assessment => {
+      assessment._correctToPass = 60;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._correctToPass attribute', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._correctToPass === 60
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _correctToPass not added to every instance of assessment and set as 60.');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v4.4.0', { name: 'adapt-contrib-assessment', version: '4.4.0', framework: '>=5.4.0' });
+});
+
+describe('adapt-contrib-assessment - v4.4.0 > v4.6.1', async () => {
+  let articles, assessments;
+
+  whereFromPlugin('adapt-contrib-assessment - from v4.4.0', { name: 'adapt-contrib-assessment', version: '<4.6.1' });
+
+  whereContent('adapt-contrib-assessment - where assessment', async content => {
+    articles = content.filter(({ _type }) => _type === 'article');
+    assessments = articles.filter(({ _type, _assessment }) => _type === 'article' && _assessment !== undefined);
+    return assessments.length;
+  });
+
+  /**
+   * * Add JSON field and set attribute.
+   */
+  mutateContent('adapt-contrib-assessment - modify assessment._questions._resetType value', async () => {
+    /**
+     * ? Changing _resetType globally to 'hard' might have unintended consequences.
+     * ? This change assumes that a hard reset is preferred in all cases, which may not be true for all users.
+     */
+    assessments.forEach(assessment => {
+      assessment._questions.forEach(item => {
+        item._resetType = 'hard';
+      });
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-assessment - check assessment._questions._resetType value', async () => {
+    const isValid = assessments.every(assessment =>
+      assessment._questions.every(item =>
+        item._resetType === 'hard'
+      )
+    );
+    if (!isValid) throw new Error('adapt-contrib-assessment - _resetType not set to "hard" for every instance of assessment._questions');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-assessment - update to v4.6.1', { name: 'adapt-contrib-assessment', version: 'v4.6.1', framework: '>=5.11.0' });
+});