add new fields and allowlist to course.yaml validation

UofGAnalytics · Apr 21, 2022 · 1583198 · 1583198
1 parent c93e5a4
commit 1583198
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/compiler/src/course/load-course.ts b/compiler/src/course/load-course.ts
@@ -6,14 +6,30 @@ import * as yup from 'yup';
 import { readFile } from '../utils/utils';
 import { CourseYaml } from './types';
 
+export const validCatalogValues = [
+  'STATS5077',
+  'STATS5078',
+  'STATS5075',
+  'STATS5084',
+  'STATS5074',
+  'STATS5081',
+  'STATS5080',
+  'STATS5073',
+  'STATS5076',
+  'STATS5079',
+  'STATS5082',
+  'STATS5094',
+  'STATS5083',
+];
+
 const courseSchema = yup.object().shape({
   title: yup.string().required(),
   units: yup.array().of(
     yup.object().shape({
       src: yup.string().required(),
     })
   ),
-  catalog: yup.string().required(),
+  catalog: yup.string().oneOf(validCatalogValues).required(),
   authors: yup.string().required(),
   academic_year: yup.string().required(),
 });

diff --git a/compiler/src/course/types.ts b/compiler/src/course/types.ts
@@ -2,6 +2,9 @@ import { VFile } from 'vfile';
 
 export type CourseYaml = {
   title: string;
+  catalog: string;
+  authors: string;
+  academic_year: string;
   units: FileRef[];
 };
 
@@ -22,6 +25,9 @@ export type Unit = {
 
 export type Course = {
   title: string;
+  catalog: string;
+  authors: string;
+  academic_year: string;
   coursePath: string;
   units: Unit[];
 };

diff --git a/compiler/src/test-utils/test-processor.ts b/compiler/src/test-utils/test-processor.ts
@@ -56,6 +56,9 @@ async function createTestContext(md: string, options: Options = {}) {
 
   const course = {
     title: 'Test Course',
+    catalog: 'STATS5078',
+    authors: 'David McArthur',
+    academic_year: '2021-22',
     coursePath: cacheDir,
     units: [{ src: unitPath }],
   };