Added post build command support

* Added post build command support
* Added validator for both pre and post build (former was missing)
Yet to be decided: Solution for analysis run: with or without pre/post build?
Addresses #786

Author: elektronikworkshop

README.md

@@ -102,6 +102,7 @@ The following settings are as per sketch settings of the Arduino extension. You
     "output": "../build",
     "debugger": "jlink",
     "prebuild": "bash prebuild.sh",
+    "postbuild": "bash postbuild.sh",
     "intelliSenseGen": "global"
 }
 ```
@@ -110,7 +111,8 @@ The following settings are as per sketch settings of the Arduino extension. You
 - `board` - Currently selected Arduino board alias. Can be set by the `Arduino: Change Board Type` command. Also, you can find the board list there.
 - `output` - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build leading to long verify/upload time, so it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or in a subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set. It's worth noting that the contents of this file could be deleted during the build process, so pick (or create) a directory that will not store files you want to keep.
 - `debugger` - The short name of the debugger that will be used when the board itself does not have a debugger and there is more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/master/misc/debuggerUsbMapping.json). By default, this option is not set.
-- `prebuild` - External command before building the sketch file. You should only set one `prebuild` command. `command1 && command2` does not work. If you need to run multiple commands before the build, then create a script.
+- `prebuild` - External command which will be invoked before any sketch build (verify, upload). You must only set one `prebuild` command. `command1 && command2` does not work. If you need to run multiple commands before the build, then create a script.
+- `postbuild` - External command to be run after the sketch has been built successfully. Same rules as for `prebuild` apply. <!-- TODO: note about cwd would be a good thing -->
 - `intelliSenseGen` - Override the global setting for auto-generation of the IntelliSense configuration (i.e. `.vscode/c_cpp_properties.json`). Three options are available:
   - `"global"`: Use the global settings (default)
   - `"disable"`: Disable the auto-generation even if globally enabled

misc/arduinoValidator.json

@@ -42,6 +42,16 @@
                 "disable",
                 "enable"
             ]
+        },
+        "prebuild": {
+            "description": "Command to be run before every build",
+            "type": "string",
+            "minLength": 1
+        },
+        "postbuild": {
+            "description": "Command to be run after every build",
+            "type": "string",
+            "minLength": 1
         }
     }
 }

src/arduino/arduino.ts

@@ -328,7 +328,10 @@ export class ArduinoApp {
         arduinoChannel.show();
         arduinoChannel.start(`${buildMode} sketch '${dc.sketch}'`);
 
-        if (!await this.runPreBuildCommand(dc)) {
+        // TODO EW: What should we do with pre-/post build commands when running
+        //   analysis? Some could use it to generate/manipulate code which could
+        //   be a prerequisite for a successful build
+        if (!await this.runPrePostBuildCommand(dc, "pre")) {
             return false;
         }
 
@@ -363,7 +366,10 @@ export class ArduinoApp {
         // Push sketch as last argument
         args.push(path.join(ArduinoWorkspace.rootPath, dc.sketch));
 
-        const cleanup = async () => {
+        const cleanup = async (result: "ok" | "error") => {
+            if (result === "ok") {
+                await this.runPrePostBuildCommand(dc, "post");
+            }
             await cocopa.conclude();
             if (buildMode === BuildMode.Upload || buildMode === BuildMode.UploadProgrammer) {
                 UsbDetector.getInstance().resumeListening();
@@ -417,11 +423,11 @@ export class ArduinoApp {
             undefined,
             { stdout: stdoutcb, stderr: stderrcb },
         ).then(async () => {
-            await cleanup();
+            await cleanup("ok");
             arduinoChannel.end(`${buildMode} sketch '${dc.sketch}'${os.EOL}`);
             return true;
         }, async (reason) => {
-            await cleanup();
+            await cleanup("error");
             const msg = reason.code
                 ? `Exit with code=${reason.code}`
                 : JSON.stringify(reason);
@@ -671,27 +677,40 @@ export class ArduinoApp {
     }
 
     /**
-     * Runs the pre build command.
+     * Runs the pre or post build command.
      * Usually before one of
      *  * verify
      *  * upload
      *  * upload using programmer
      * @param dc Device context prepared during one of the above actions
+     * @param what "pre" if the pre-build command should be run, "post" if the
+     * post-build command should be run.
      * @returns True if successful, false on error.
      */
-    protected async runPreBuildCommand(dc: DeviceContext): Promise<boolean> {
-        const prebuildcmdline = dc.prebuild;
-        if (prebuildcmdline) {
-            arduinoChannel.info(`Running pre-build command: ${prebuildcmdline}`);
-            const args = prebuildcmdline.split(/\s+/);
+    protected async runPrePostBuildCommand(dc: DeviceContext,
+                                           what: "pre" | "post"): Promise<boolean> {
+        const cmdline = what === "pre"
+            ? dc.prebuild
+            : dc.postbuild;
+
+        if (cmdline) {
+            arduinoChannel.info(`Running ${what}-build command: "${cmdline}"`);
+            // TODO 2020-02-27, EW: We could call bash -c "cmd" here at least for
+            //   UNIX systems. Windows users must live with their poor system :)
+            const args = cmdline.split(/\s+/);
             const cmd = args.shift();
             try {
                 await util.spawn(cmd,
                                  args,
                                  { shell: true, cwd: ArduinoWorkspace.rootPath },
                                  { channel: arduinoChannel.channel });
             } catch (ex) {
-                arduinoChannel.error(`Running pre-build command failed: ${os.EOL}${ex.error}`);
+                const msg = ex.error
+                    ? `${ex.error}`
+                    : ex.code
+                        ? `Exit code = ${ex.code}`
+                        : JSON.stringify(ex);
+                arduinoChannel.error(`Running ${what}-build command failed: ${os.EOL}${msg}`);
                 return false;
             }
         }

src/deviceContext.ts

@@ -181,6 +181,7 @@ export class DeviceContext implements IDeviceContext, vscode.Disposable {
     public get onChangeISAutoGen() { return this._settings.intelliSenseGen.emitter.event }
     public get onChangeConfiguration() { return this._settings.configuration.emitter.event }
     public get onChangePrebuild() { return this._settings.prebuild.emitter.event }
+    public get onChangePostbuild() { return this._settings.postbuild.emitter.event }
     public get onChangeProgrammer() { return this._settings.programmer.emitter.event }
 
     public get port() {
@@ -214,6 +215,10 @@ export class DeviceContext implements IDeviceContext, vscode.Disposable {
         return this._settings.prebuild.value;
     }
 
+    public get postbuild() {
+        return this._settings.postbuild.value;
+    }
+
     public get output() {
         return this._settings.output.value;
     }

src/deviceSettings.ts

@@ -112,6 +112,7 @@ export class DeviceSettings {
     public intelliSenseGen = new StrSetting();
     public configuration = new StrSetting();
     public prebuild = new StrSetting();
+    public postbuild = new StrSetting();
     public programmer = new StrSetting();
 
     /**
@@ -127,6 +128,7 @@ export class DeviceSettings {
                this.intelliSenseGen.modified ||
                this.configuration.modified ||
                this.prebuild.modified ||
+               this.postbuild.modified ||
                this.programmer.modified;
     }
     /**
@@ -141,6 +143,7 @@ export class DeviceSettings {
         this.intelliSenseGen.commit();
         this.configuration.commit();
         this.prebuild.commit();
+        this.postbuild.commit();
         this.programmer.commit();
     }
     /**
@@ -157,6 +160,7 @@ export class DeviceSettings {
         this.intelliSenseGen.reset();
         this.configuration.reset();
         this.prebuild.reset();
+        this.postbuild.reset();
         this.programmer.reset();
         if (commit) {
             this.commit();
@@ -181,6 +185,7 @@ export class DeviceSettings {
             this.debugger.value = settings.debugger;
             this.intelliSenseGen.value = settings.intelliSenseGen;
             this.prebuild.value = settings.prebuild;
+            this.postbuild.value = settings.postbuild;
             this.programmer.value = settings.programmer;
             if (commit) {
                 this.commit();