Added identifiers and update identifier test

microbit-foundation · Aug 13, 2023 · 1581752 · 1581752
1 parent 539a304
commit 1581752
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 5 deletions.
diff --git a/microbit/v1/source/main.cpp b/microbit/v1/source/main.cpp
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #include "MicroBit.h"
 #include "MicroBitUARTService.h"
 #include "MicroBitAccelerometerService.h"

diff --git a/microbit/v2/source/codebook.h b/microbit/v2/source/codebook.h
@@ -1,3 +1,9 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
 #include "MicroBit.h"
 #ifndef CODEBOOK_H_INCLUDED
 #define CODEBOOK_H_INCLUDED

diff --git a/microbit/v2/source/helpers.cpp b/microbit/v2/source/helpers.cpp
@@ -1,3 +1,9 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
 #include "MicroBit.h" 
 #include "codebook.h"
 #include "utilities.h"

diff --git a/microbit/v2/source/main.cpp b/microbit/v2/source/main.cpp
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #include "MicroBit.h"
 #include "MicroBitUARTService.h"
 #include "MicroBitAccelerometerService.h"

diff --git a/microbit/v2/source/smileys.h b/microbit/v2/source/smileys.h
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #include "utilities.h"
 #ifndef SMILEYS_H_INCLUDED
 #define SMILEYS_H_INCLUDED

diff --git a/microbit/v2/source/sound.cpp b/microbit/v2/source/sound.cpp
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #include "MicroBit.h"
 #include "utilities.h"
 #include "sounds.h"

diff --git a/microbit/v2/source/sounds.h b/microbit/v2/source/sounds.h
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #include "utilities.h"
 #ifndef SOUNDS_H_INCLUDED
 #define SOUNDS_H_INCLUDED

diff --git a/microbit/v2/source/utilities.h b/microbit/v2/source/utilities.h
@@ -1,3 +1,8 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 #ifndef UTILITIES_H_INCLUDED
 #define UTILITIES_H_INCLUDED
 

diff --git a/src/__tests__/license-identifiers.test.ts b/src/__tests__/license-identifiers.test.ts
@@ -1,13 +1,19 @@
 /**
  * @jest-environment jsdom
  */
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
 
 import fs from 'fs';
 import 'jest-expect-message';
 import * as path from 'path';
 
 // Place files you wish to ignore by name in here
 const ignoredFiles: string[] = [];
+const directoriesToScan = ['./src/', './microbit/v2/source/', './microbit/v1/source/']
 
 const licenseIdentifierStringContributors =
   'Center for Computational Thinking and Design at Aarhus University and contributors';
@@ -61,7 +67,7 @@ const filesMissingIdentifier = (files: string[], expects: string[]): string[] =>
     for (const expect of expects) {
       if (!readFile('./' + files[i], expect)) {
         if (!filesWithMissingIdentifier.includes(files[i])) {
-            filesWithMissingIdentifier.push(files[i]);
+          filesWithMissingIdentifier.push(files[i]);
         }
       }
     }
@@ -73,17 +79,23 @@ describe('License identifier tests', () => {
   test(
     'All files should contain license identifier',
     () => {
-      const flatten = flattenDirectory('./src/');
+
+      const flatten = directoriesToScan.reduce(
+        (acc: any, current) => {
+          return acc.concat(flattenDirectory(current))
+        }, []
+      );
+
       const faultyFiles = filesMissingIdentifier(flatten, [
         licenseIdentifierStringContributors,
         licenseIdentifierStringSPDX,
       ]);
       expect(
         faultyFiles.length,
         'Some files do not contain identifier! ' +
-          faultyFiles
-            .map(val => `\n \u001b[35m${val} \u001b[0mis missing license identifier`)
-            .join(),
+        faultyFiles
+          .map(val => `\n \u001b[35m${val} \u001b[0mis missing license identifier`)
+          .join(),
       ).toEqual(0);
     },
     60000 * 10,