Merge pull request #593 from rage/2-1-0

Release 2.1.0

Author: sebazai

.eslintignore

@@ -3,6 +3,7 @@
 dist
 **/node_modules
 out
+test-artifacts/
 test-resources/
 submodules/
 .vscode-test/

.github/workflows/nodejs.yml

@@ -34,7 +34,11 @@ jobs:
                   npm run setup
                   chmod -R +x cli
                   cd ..
-            - name: Run tests
+            - name: Unit tests
               uses: GabrielBB/[email protected]
               with:
                   run: npm test
+            - name: Integration tests
+              uses: GabrielBB/[email protected]
+              with:
+                  run: npm run test-integration-only integration

.gitignore

@@ -1,6 +1,7 @@
 # Project files
 .vscode-test/
 node_modules/
+test-artifacts/
 test-resources/
 .eslintcache
 vscode.proposed.d.ts

.vscode/launch.json

@@ -24,7 +24,19 @@
                 "--extensionDevelopmentPath=${workspaceFolder}",
                 "--extensionTestsPath=${workspaceFolder}/bin/testLoader"
             ],
-            "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+            "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+            "preLaunchTask": "webpackBuild"
+        },
+        {
+            "name": "Integration tests",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionTestsPath=${workspaceFolder}/bin/integrationLoader"
+            ],
+            "outFiles": ["${workspaceFolder}/dist/**/*.js"],
             "preLaunchTask": "webpackBuild"
         }
     ]

.vscode/settings.json

@@ -10,6 +10,7 @@
     "search.exclude": {
         "**/out": true
     },
+    "files.eol": "\n",
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
     "typescript.tsc.autoDetect": "off",
     "html.validate.scripts": false,

.vscodeignore

@@ -18,7 +18,8 @@ types/**
 **/.gitmodules
 **/.eslintignore
 **/.eslintrc.json
-**/dist/testBundle*
+**dist/integration*
+**/dist/test*
 **/tsconfig.json
 **/tsconfig.production.json
 **/tslint.json

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [2.1.0] - 2021-07-05
+
+#### Added
+
+- Exercise decorations: Show completed, expired, partially completed and missing in course workspace file tree.
+- Automatically download old submission (disabled since version 2.0.0).
+
+#### Changed
+- Bumped TMC-langs to version 0.21.0-beta-4.
+- Moved Extension Settings behind VSCode Settings API. [Read more...](https://code.visualstudio.com/docs/getstarted/settings)
+- Moved TMC folder selection to My Courses page.
+
+#### Removed
+- Custom Settings webview.
+
+#### Security
+- Updated dependencies.
 ## [2.0.3] - 2021-06-28
 
 #### Fixed

README.md

@@ -12,7 +12,7 @@ Students of its various organizations can download, complete and return course e
 
 ## Prerequisites
 
-* Visual Studio Code version 1.40.xx or above
+* Visual Studio Code version 1.52.xx or above
 * [TestMyCode](https://tmc.mooc.fi/) account
 * Course-specific system environment   
 

backend/index.ts

@@ -27,6 +27,15 @@ import {
 
 const PORT = 4001;
 
+interface DetailsForLangs {
+    exercises: Array<{
+        id: number;
+        checksum: string;
+        course_name: string;
+        exercise_name: string;
+    }>;
+}
+
 const testOrganization = createOrganization({
     information: "This is a test organization from a local development server.",
     name: "Test Organization",
@@ -53,6 +62,7 @@ const submissions = [
         exerciseName: passingExercise.name,
         id: 0,
         passed: true,
+        timestamp: new Date(2000, 1, 1),
         userId: 0,
     }),
 ];
@@ -111,6 +121,21 @@ app.get(`/api/v8/core/courses/${pythonCourse.id}`, (req, res: Response<CourseDet
     }),
 );
 
+// downloadExercises()
+app.get("/api/v8/core/exercises/details", (req, res: Response<DetailsForLangs>) => {
+    const rawIds = req.query.ids;
+    const ids = Array.isArray(rawIds) ? rawIds : [rawIds];
+    const filtered = [passingExercise].filter((x) => ids.includes(x.id.toString()));
+    return res.json({
+        exercises: filtered.map((x) => ({
+            id: x.id,
+            checksum: x.checksum,
+            course_name: "python-course",
+            exercise_name: x.exercise_name,
+        })),
+    });
+});
+
 // getExerciseDetails(1)
 app.get(`/api/v8/core/exercises/${passingExercise.id}`, (req, res: Response<ExerciseDetails>) =>
     res.json({ ...passingExercise, course_id: pythonCourse.id, course_name: pythonCourse.name }),
@@ -134,6 +159,7 @@ app.post(
                 exerciseName: passingExercise.name,
                 id: passingExercise.id,
                 passed: true,
+                timestamp: new Date(),
                 userId: 0,
             }),
         );

backend/setup.ts

@@ -23,7 +23,7 @@ const copyTMCPythonModules = async (): Promise<void> => {
         ncp(module, target, () => {});
     });
     console.log("Modules copied!");
-
+    await new Promise((res) => setTimeout(res, 1000));
     await Promise.all(
         pythonExercises.map(async (exercise) => {
             console.log(`Creating download archive for ${exercise}`);

backend/utils.ts

@@ -155,35 +155,39 @@ interface CreateOldSubmissionParams {
     exerciseName: string;
     id: number;
     passed: boolean;
+    timestamp: Date;
     userId: number;
 }
 
-const createOldSubmission = (params: CreateOldSubmissionParams): OldSubmission => ({
-    all_tests_passed: params.passed,
-    course_id: params.courseId,
-    created_at: "",
-    exercise_name: params.exerciseName,
-    id: params.id,
-    message_for_paste: "",
-    message_for_reviewer: "",
-    newer_submission_reviewed: false,
-    params_json: "",
-    paste_available: false,
-    paste_key: "",
-    points: "",
-    pretest_error: "",
-    processed: true,
-    processing_attempts_started_at: "",
-    processing_began_at: "",
-    processing_completed_at: "",
-    processing_tried_at: "",
-    requests_review: false,
-    requires_review: false,
-    review_dismissed: false,
-    reviewed: false,
-    times_sent_to_sandbox: 1,
-    user_id: 0,
-});
+const createOldSubmission = (params: CreateOldSubmissionParams): OldSubmission => {
+    const timestamp = params.timestamp.toISOString();
+    return {
+        all_tests_passed: params.passed,
+        course_id: params.courseId,
+        created_at: timestamp,
+        exercise_name: params.exerciseName,
+        id: params.id,
+        message_for_paste: "",
+        message_for_reviewer: "",
+        newer_submission_reviewed: false,
+        params_json: "",
+        paste_available: false,
+        paste_key: "",
+        points: "",
+        pretest_error: "",
+        processed: true,
+        processing_attempts_started_at: timestamp,
+        processing_began_at: timestamp,
+        processing_completed_at: timestamp,
+        processing_tried_at: timestamp,
+        requests_review: false,
+        requires_review: false,
+        review_dismissed: false,
+        reviewed: false,
+        times_sent_to_sandbox: 1,
+        user_id: 0,
+    };
+};
 
 const respondWithFile = (res: Response, file: string): void =>
     res.sendFile(file, (error) => {

bin/integrationLoader.js

@@ -0,0 +1,31 @@
+//@ts-check
+
+const Mocha = require("mocha");
+const path = require("path");
+
+function run() {
+    // Create the mocha test
+    const mocha = new Mocha({
+        ui: "tdd",
+        color: true,
+    });
+
+    return new Promise((c, e) => {
+        mocha.addFile(path.resolve(__dirname, "..", "dist", "integration.spec.js"));
+
+        try {
+            // Run the mocha test
+            mocha.run((failures) => {
+                if (failures > 0) {
+                    e(new Error(`${failures} tests failed.`));
+                } else {
+                    c();
+                }
+            });
+        } catch (err) {
+            e(err);
+        }
+    });
+}
+
+exports.run = run;

bin/runIntegration.js

@@ -0,0 +1,33 @@
+//@ts-check
+
+const path = require("path");
+const runTests = require("vscode-test").runTests;
+
+async function main() {
+    let exitCode = 0;
+    /**@type {import("child_process").ChildProcess} */
+    try {
+        const platform =
+            process.platform === "win32" && process.arch === "x64"
+                ? "win32-x64-archive"
+                : undefined;
+
+        // The folder containing the Extension Manifest package.json
+        // Passed to `--extensionDevelopmentPath`
+        const extensionDevelopmentPath = path.resolve(__dirname, "..");
+
+        // The path to test runner
+        // Passed to --extensionTestsPath
+        const extensionTestsPath = path.resolve(__dirname, "integrationLoader");
+
+        // Download VS Code, unzip it and run the integration test
+        await runTests({ extensionDevelopmentPath, extensionTestsPath, platform });
+    } catch (err) {
+        console.error("Failed to run tests");
+        exitCode = 1;
+    }
+
+    process.exit(exitCode);
+}
+
+main();

bin/runTests.js

@@ -1,42 +1,12 @@
 //@ts-check
 
-const cp = require("child_process");
 const path = require("path");
-const kill = require("tree-kill");
 const runTests = require("vscode-test").runTests;
 
-/**@returns {Promise<import("child_process").ChildProcess>} */
-async function startServer() {
-    let ready = false;
-    console.log(path.join(__dirname, "..", "backend"));
-    const server = cp.spawn("npm", ["start"], {
-        cwd: path.join(__dirname, "..", "backend"),
-        shell: "bash",
-    });
-    server.stdout.on("data", (chunk) => {
-        if (chunk.toString().startsWith("Server listening to")) {
-            ready = true;
-        }
-    });
-
-    const timeout = setTimeout(() => {
-        throw new Error("Failed to start server");
-    }, 10000);
-
-    while (!ready) {
-        await new Promise((resolve) => setTimeout(resolve, 1000));
-    }
-
-    clearTimeout(timeout);
-    return server;
-}
-
 async function main() {
     let exitCode = 0;
     /**@type {import("child_process").ChildProcess} */
-    let backend;
     try {
-        backend = await startServer();
         const platform =
             process.platform === "win32" && process.arch === "x64"
                 ? "win32-x64-archive"
@@ -55,10 +25,9 @@ async function main() {
     } catch (err) {
         console.error("Failed to run tests");
         exitCode = 1;
-    } finally {
-        kill(backend.pid);
-        process.exit(exitCode);
     }
+
+    process.exit(exitCode);
 }
 
 main();

bin/testLoader.js

@@ -1,3 +1,5 @@
+//@ts-check
+
 const Mocha = require("mocha");
 const path = require("path");
 

bin/validateRelease.sh

@@ -22,7 +22,7 @@ fi
 packageLockVersion=`grep -Eo '"version":.+$' package-lock.json`
 if [[ ! $packageLockVersion =~ '"version": "'$tagVersion'",' ]]
 then
-    echo "Error: The version in package-lock.json doesn't match with the tag. Did you forget to run npm install?"
+    echo "Error: The version in package-lock.json doesn't match with the tag."
     exitCode=1
 fi
 
@@ -35,4 +35,12 @@ then
     exitCode=1
 fi
 
+# All configured Langs versions should exist on the download server.
+node ./bin/verifyThatLangsBuildsExist.js
+if [ $? != 0 ]
+then
+    echo "Error: Failed to verify that all Langs builds exist."
+    exitCode=1
+fi
+
 exit $exitCode