add test cases for board/library manager

add test cases for board/library manager

Author: testforstephen

test/boardmanager.test.ts

@@ -1,10 +1,12 @@
 import * as assert from "assert";
 import * as fs from "fs";
+
 import * as Path from "path";
 import * as TypeMoq from "typemoq";
 
 import * as Resources from "./resources";
 
+import ArduinoContext from "..//src/arduinoContext";
 import { ArduinoApp } from "../src/arduino/arduino";
 import { ArduinoSettings } from "../src/arduino/arduinoSettings";
 import { parseBoardDescriptor } from "../src/arduino/board";
@@ -46,7 +48,7 @@ suite("Arduino: Board Manager.", () => {
         assert.equal(platforms[0].name, "Arduino AVR Boards", "Board Manager should display built Arduino AVR Boards");
         assert.equal(platforms[0].installedVersion, "1.6.18", "Arduino IDE built-in AVR board package version should be 1.6.18");
         assert.equal(platforms[0].rootBoardPath, Path.join(Resources.mockedIDEPackagePath, "arduino", "avr"),
-        "Should be able to index root board path for installed boards");
+            "Should be able to index root board path for installed boards");
     });
 
     test("should be able to load installed platforms", () => {
@@ -63,7 +65,7 @@ suite("Arduino: Board Manager.", () => {
         assert.equal(boardManager.installedBoards.size, 46, "Arduino IDE should contains built-in AVR boards");
         assert.equal(boardManager.installedBoards.has("arduino:avr:yun"), true, "should parse installed boards from Arduino IDE built-in packages");
         assert.equal(boardManager.installedBoards.has("esp8266:esp8266:huzzah"), true,
-        "should parse installed boards from custom packages ($sketchbook/hardware directory)");
+            "should parse installed boards from custom packages ($sketchbook/hardware directory)");
     });
 
     test("should parse boards.txt correctly", () => {
@@ -96,4 +98,44 @@ suite("Arduino: Board Manager.", () => {
         assert.equal(platformConfig.get("name"), "ESP8266 Modules");
         assert.equal(platformConfig.get("version"), "2.2.0");
     });
+
+    // Arduino: Board Manager: Manage packages for boards.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to install boards packages", function(done) {
+        this.timeout(4 * 60 * 1000);
+        try {
+            // Board Manager: install boards packages.
+            ArduinoContext.arduinoApp.installBoard("Microsoft", "win10", "1.1.2", true).then((result) => {
+                const arduinoSettings = ArduinoContext.arduinoApp.settings;
+                const packagePath = Path.join(arduinoSettings.packagePath, "packages", "Microsoft");
+                // check if the installation succeeds or not
+                if (util.directoryExistsSync(packagePath)) {
+                    done();
+                } else {
+                    done(new Error("Microsoft board package install failure, can't find package path :" + packagePath));
+                }
+            });
+
+        } catch (error) {
+            done(new Error(error));
+        }
+    });
+
+    // Arduino: Board Manager: remove boards packages.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to remove boards packages", () => {
+        try {
+            // Board Manager: remove boards packages.
+            const arduinoSettings = ArduinoContext.arduinoApp.settings;
+            const packagePath = Path.join(arduinoSettings.packagePath, "packages", "Microsoft");
+            if (util.directoryExistsSync(packagePath)) {
+                ArduinoContext.arduinoApp.uninstallBoard("Microsoft", packagePath);
+                assert.equal(util.directoryExistsSync(packagePath), false,
+                 "Package path still exist after calling uninstall package,remove the board package failure");
+            }
+        } catch (error) {
+            assert.fail(true, false, new Error(error).message, new Error(error).name);
+        }
+    });
+
 });

test/commands.test.ts

@@ -6,7 +6,7 @@ import * as assert from "assert";
 import * as vscode from "vscode";
 
 // Defines a Mocha test suite to group tests of similar kind together
-suite("vscode-arduino extension commands test", () => {
+suite("Arduino: Commands Tests", () => {
     // tslint:disable-next-line: only-arrow-functions
     setup(function(done) {
         // Ensure that extension is activate while testing
@@ -23,6 +23,36 @@ suite("vscode-arduino extension commands test", () => {
         }
     });
 
+    // Arduino: Initialize：Scaffold a VS Code project with an Arduino sketch.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to run command: arduino.initialize", function(done) {
+        this.timeout(60 * 1000);
+        try {
+            // run "Arduino: Boards Manager" command.
+            vscode.commands.executeCommand("arduino.initialize").then((result)  => {
+                done();
+            });
+
+        } catch (error) {
+            done(new Error(error));
+        }
+    });
+
+    // Arduino: Library Manager: Add library to include path.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to run command: arduino.addLibPath", function(done) {
+        this.timeout(60 * 1000);
+        try {
+            // Library Manager: Add library to include path.
+            vscode.commands.executeCommand("arduino.addLibPath", "#include <AzureIoTHub.h>").then((result)  => {
+                done();
+            });
+
+        } catch (error) {
+            done(new Error(error));
+        }
+    });
+
     // Arduino: Boards Manager : Manage packages for boards
     // tslint:disable-next-line: only-arrow-functions
     test("should be able to run command: arduino.showBoardManager", function(done) {

test/extension.test.ts

@@ -7,7 +7,7 @@ import * as os from "os";
 import * as vscode from "vscode";
 
 // Defines a Mocha test suite to group tests of similar kind together
-suite("Arduino Extension Tests", () => {
+suite("Arduino: Extension Tests", () => {
     test("should be present", () => {
         assert.ok(vscode.extensions.getExtension("vsciot-vscode.vscode-arduino"));
     });
@@ -29,7 +29,7 @@ suite("Arduino Extension Tests", () => {
         }
     });
 
-    test("should be able to register Arduino commands", () => {
+    test("should be able to register arduino commands", () => {
             return vscode.commands.getCommands(true).then((commands) => {
                 const ARDUINO_COMMANDS = [
                     "arduino.verify",

test/librarymanager.test.ts

@@ -1,13 +1,16 @@
 import * as assert from "assert";
+
 import * as Path from "path";
 import * as TypeMoq from "typemoq";
 
 import * as Resources from "./resources";
 
+import ArduinoContext from "..//src/arduinoContext";
 import { ArduinoApp } from "../src/arduino/arduino";
 import { ArduinoSettings } from "../src/arduino/arduinoSettings";
 import { BoardManager } from "../src/arduino/boardManager";
 import { LibraryManager } from "../src/arduino/libraryManager";
+import * as util from "../src/common/util";
 
 suite("Arduino: Library Manager.", () => {
 
@@ -46,7 +49,7 @@ suite("Arduino: Library Manager.", () => {
             assert.equal(installedLibraries[0].name, "Ethernet");
             assert.equal(installedLibraries[0].builtIn, true);
             assert.equal(installedLibraries[0].srcPath, Path.join(Resources.mockedIDELibPath, "Ethernet", "src"),
-            "Should be able to find src path of install library");
+                "Should be able to find src path of install library");
 
             assert.equal(installedLibraries[1].name, "AzureIoTHub");
             assert.equal(installedLibraries[1].builtIn, false);
@@ -58,8 +61,50 @@ suite("Arduino: Library Manager.", () => {
 
             done();
         }).catch((error) => {
-          done(error);
+            done(error);
         });
     });
 
+    // Arduino: Library Manager: Install extenal libarary.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to install libraries", function(done) {
+        this.timeout(3 * 60 * 1000);
+        try {
+            // Library Manager: Install extenal libarary.
+            ArduinoContext.arduinoApp.installLibrary("AzureIoTHub", "1.0.35", true).then((result) => {
+                // check if the installation succeeds or not
+                const arduinoSettings = ArduinoContext.arduinoApp.settings;
+                const libPath = Path.join(arduinoSettings.sketchbookPath, "libraries", "AzureIoTHub");
+
+                if (util.directoryExistsSync(libPath)) {
+                    done();
+                } else {
+                    done(new Error("AzureIoTHub library install failure, can't find library path :" + libPath));
+                }
+            });
+
+        } catch (error) {
+            done(new Error(error));
+        }
+    });
+
+    // Arduino: Library Manager: remove extenal libarary.
+    // tslint:disable-next-line: only-arrow-functions
+    test("should be able to remove libraries", () => {
+        try {
+            // Library Manager: remove extenal libarary.
+            const arduinoSettings = ArduinoContext.arduinoApp.settings;
+            const libPath = Path.join(arduinoSettings.sketchbookPath, "libraries", "AzureIoTHub");
+
+            if (util.directoryExistsSync(libPath)) {
+                ArduinoContext.arduinoApp.uninstallLibrary("AzureIoTHub", libPath);
+                assert.equal(util.directoryExistsSync(libPath), false,
+                 "Library path still exist after calling uninstall library,remove the library failure");
+            }
+
+        } catch (error) {
+            assert.fail(true, false, new Error(error).message, new Error(error).name);
+        }
+    });
+
 });

test/verify.test.ts

@@ -8,7 +8,7 @@ import * as vscode from "vscode";
 // Defines a Mocha test suite to group tests of similar kind together
 suite("Arduino: Verify: Build (verify) your sketch files.", () => {
     // tslint:disable-next-line: only-arrow-functions
-    test("should be able to run command: Arduino verify", function(done) {
+    test("should be able to run command: arduino verify", function(done) {
         this.timeout(3 * 60 * 1000);
         try {
             // Press ctrl+alt+r to run "arduino:verify" command.