powerbi-visuals-tools 4.0.4 → 4.0.6

package/spec/e2e/pbivizStartSpec.js

@@ -0,0 +1,380 @@
+/*
+ *  Power BI Visual CLI
+ *
+ *  Copyright (c) Microsoft Corporation
+ *  All rights reserved.
+ *  MIT License
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the ""Software""), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+"use strict";
+
+const fs = require('fs-extra');
+const path = require('path');
+const async = require('async');
+const FileSystem = require('../helpers/FileSystem.js');
+const writeMetadata = require("./utils").writeMetadata;
+const download = require("../../lib/utils").download;
+const createFolder = require("../../lib/utils").createFolder;
+
+const tempPath = FileSystem.getTempPath();
+const startPath = process.cwd();
+
+// these tests can take a bit longer
+jasmine.DEFAULT_TIMEOUT_INTERVAL = 180000;
+
+let startChecker = (proc) => new Promise((resolve) => {
+    proc.stdout.on('data', (data) => {
+        let dataStr = (data.toString()).toLowerCase();
+        if ((dataStr.indexOf("compiled") !== -1 && dataStr.indexOf("successfully") !== -1) || dataStr.match(/Compiled with\s*(\d)* warnings/) !== null) {
+            resolve();
+        }
+    });
+});
+
+let procKiller = (proc, done) => {
+    FileSystem.killProcess(proc, 'SIGTERM', (error) => {
+        expect(error).toBeNull();
+        done();
+    });
+};
+
+describe("E2E - pbiviz start", () => {
+    const visualName = 'visualname';
+    const visualPath = path.join(tempPath, visualName);
+    const tmpPath = path.join(visualPath, '.tmp');
+    const dropPath = path.join(tmpPath, 'drop');
+    const assetFiles = ['visual.js', 'visual.css', 'pbiviz.json', 'status'];
+
+    beforeEach(() => {
+        FileSystem.resetTempDirectory();
+        process.chdir(tempPath);
+        FileSystem.runPbiviz('new', visualName, '--force');
+        FileSystem.runCMDCommand('npm i', visualPath, tempPath);
+
+        writeMetadata(visualPath);
+    });
+
+    afterEach(() => {
+        process.chdir(startPath);
+    });
+
+    afterAll(() => {
+        process.chdir(startPath);
+        FileSystem.deleteTempDirectory();
+    });
+
+    xit("Should throw error if not in the visual root", () => {
+        let error;
+
+        try {
+            FileSystem.runPbiviz('start', "-d");
+        } catch (e) {
+            error = e;
+        }
+        expect(error).toBeDefined();
+        expect(error.status).toBe(1);
+        expect(error.message).toContain("Error: pbiviz.json not found. You must be in the root of a visual project to run this command");
+    });
+
+    describe("Build and Server", () => {
+        let pbivizProc;
+
+        beforeEach(() => {
+            process.chdir(visualPath);
+            pbivizProc = FileSystem.runPbivizAsync("start", "-d");
+        });
+
+        it("Should build visual and generate resources in drop folder", (done) => {
+            let visualConfig = fs.readJsonSync(path.join(visualPath, 'pbiviz.json')).visual;
+            let visualCapabilities = fs.readJsonSync(path.join(visualPath, 'capabilities.json'));
+            startChecker(pbivizProc).then(() => {
+                //check files on filesystem
+                expect(fs.statSync(dropPath).isDirectory()).toBe(true);
+                try {
+                    assetFiles.forEach(file => {
+                        let filePath = path.join(dropPath, file);
+                        expect(fs.statSync(filePath).isFile()).toBe(true);
+                    });
+                } catch (error) {
+                    expect(error).toBeNull();
+                }
+                //check metadata
+                let pbivizPath = path.join(dropPath, 'pbiviz.json');
+                let pbiviz = fs.readJsonSync(pbivizPath);
+                //should append "_DEBUG" to guid to avoid collisions
+                visualConfig.guid += "_DEBUG";
+                expect(pbiviz.visual).toEqual(visualConfig);
+                expect(pbiviz.capabilities).toEqual(visualCapabilities);
+                expect(pbiviz.content.js).toBeDefined();
+                expect(pbiviz.content.css).toBeDefined();
+                expect(pbiviz.content.iconBase64).toBeDefined();
+                procKiller(pbivizProc, done);
+            });
+        });
+
+
+        it("Should serve files from drop folder on port 8080", (done) => {
+            startChecker(pbivizProc).then(() => {
+                async.each(
+                    assetFiles,
+                    (file, next) => {
+                        let errorMessage = `error in request to "${file}" response,`;
+                        let filePath = path.join(dropPath, file);
+                        let testFolder = createFolder("./testFolder");
+                        let testFile = path.join(testFolder, file);
+                        const options = {
+                            host: 'localhost',
+                            hostname: 'localhost',
+                            port: 8080,
+                            path: '/assets/' + file,
+                            method: 'GET',
+                            rejectUnauthorized: false
+                        };
+
+                        download(options, testFile)
+                            .then(() => {
+                                let downloadedBody = fs.existsSync(testFile) ? fs.readFileSync(testFile).toString() : null;
+                                let comparisonBody = fs.existsSync(filePath) ? fs.readFileSync(filePath).toString() : null;
+                                expect(downloadedBody).withContext(`${errorMessage} body`).toBe(comparisonBody);
+                                next();
+                            })
+                            .catch((error) => {
+                                expect(error).toBeNull();
+                                next(`request to "${file}" error.`);
+                            });
+                    },
+                    error => {
+                        if (error) {
+                            procKiller(pbivizProc, done);
+                        } else {
+                            procKiller(pbivizProc, done);
+                        }
+                    }
+                );
+            });
+        });
+
+
+        // TODO rewrite this UT because build sequence is different
+        xit("Should rebuild files on change and update status", (done) => {
+            let statusPath = path.join(dropPath, 'status');
+            let lastStatus;
+            let tsChangeCount = 0;
+            let lessChangeCount = 0;
+            let jsonChangeCount = 0;
+
+            function getStatus() {
+                return fs.readFileSync(statusPath);
+            }
+
+            let callbackCalled = false;
+            pbivizProc.stdout.on('data', (data) => {
+                let dataStr = data.toString();
+                if (dataStr.indexOf("Compiled successfully") !== -1 || dataStr.match(/Compiled with\s*(\d)* warnings/) !== null) {
+                    if (callbackCalled) {
+                        return;
+                    }
+                    callbackCalled = true;
+                    expect(tsChangeCount).toBe(0);
+                    expect(lessChangeCount).toBe(0);
+                    expect(jsonChangeCount).toBe(0);
+                    lastStatus = getStatus();
+
+                    //trigger ts change
+                    let tsSrcPath = path.join(visualPath, 'src/visual.ts');
+                    fs.appendFileSync(tsSrcPath, '// appended to ts file');
+                }
+
+                if (dataStr.indexOf('Visual rebuild completed') !== -1) {
+                    tsChangeCount++;
+                    expect(tsChangeCount).toBe(1);
+                    expect(lessChangeCount).toBe(0);
+                    expect(jsonChangeCount).toBe(0);
+                    let status = getStatus();
+                    expect(status).not.toBe(lastStatus);
+                    lastStatus = status;
+
+                    //trigger less change
+                    let lessSrcPath = path.join(visualPath, 'style/visual.less');
+                    fs.appendFileSync(lessSrcPath, '/* appended to less file */');
+                }
+
+                if (dataStr.indexOf('Less build complete') !== -1) {
+                    lessChangeCount++;
+                    expect(tsChangeCount).toBe(1);
+                    expect(lessChangeCount).toBe(1);
+                    expect(jsonChangeCount).toBe(0);
+                    let status = getStatus();
+                    expect(status).not.toBe(lastStatus);
+                    lastStatus = status;
+
+                    //trigger json change
+                    let capabilitiesPath = path.join(visualPath, 'capabilities.json');
+                    let visualCapabilities = fs.readJsonSync(capabilitiesPath);
+                    visualCapabilities.dataRoles.pop();
+                    fs.writeJsonSync(capabilitiesPath, visualCapabilities);
+                }
+
+                if (dataStr.indexOf('JSON build complete') !== -1) {
+                    jsonChangeCount++;
+                    expect(tsChangeCount).toBe(1);
+                    expect(lessChangeCount).toBe(1);
+                    expect(jsonChangeCount).toBe(1);
+                    let status = getStatus();
+                    expect(status).not.toBe(lastStatus);
+                    lastStatus = status;
+
+                    //the end
+                    FileSystem.killProcess(pbivizProc, 'SIGTERM', (error) => {
+                        expect(error).toBeNull();
+                        done();
+                    });
+                }
+            });
+        });
+    });
+
+    // custom port wans't implemented in new tools
+    xit("Should serve files from drop folder on custom port with -p flag", (done) => {
+        process.chdir(visualPath);
+        let pbivizProc = FileSystem.runPbivizAsync('start', ['-p', '3333']);
+        pbivizProc.stderr.on('data', (data) => {
+            if (data.toString().indexOf("DeprecationWarning") === -1) {
+                throw new Error(data.toString());
+            }
+        });
+        let callbackCalled = false;
+        pbivizProc.stdout.on('data', (data) => {
+            let dataStr = data.toString();
+
+            if (dataStr.indexOf("Compiled successfully") !== -1 || dataStr.match(/Compiled with\s*(\d)* warnings/) !== null) {
+                if (callbackCalled) {
+                    return;
+                }
+                callbackCalled = true;
+                async.each(
+                    assetFiles,
+                    (file, next) => {
+                        let filePath = path.join(dropPath, file);
+                        request({
+                            url: 'https://localhost:3333/assets/' + file,
+                            //allow self signed cert
+                            strictSSL: false
+                        }, (error, response, body) => {
+                            expect(error).toBeNull();
+                            expect(response.statusCode).toBe(200);
+                            expect(body).toBe(fs.readFileSync(filePath).toString());
+                            next();
+                        });
+                    },
+                    error => {
+                        if (error) { throw error; }
+                        FileSystem.killProcess(pbivizProc, 'SIGTERM', (error) => {
+                            expect(error).toBeNull();
+                            done();
+                        });
+                    }
+                );
+
+            }
+        });
+    });
+
+});
+
+describe("E2E - pbiviz start for R Visuals", () => {
+
+    let visualName = 'visualname';
+    let visualPath = path.join(tempPath, visualName);
+    let dropPath = path.join(visualPath, '.tmp', 'drop');
+
+    beforeEach(() => {
+        FileSystem.resetTempDirectory();
+        process.chdir(tempPath);
+        FileSystem.runPbiviz('new', visualName, '--template rvisual');
+    });
+
+    afterEach(() => {
+        process.chdir(startPath);
+    });
+
+    afterAll(() => {
+        process.chdir(startPath);
+        FileSystem.deleteTempDirectory();
+    });
+
+    // todo check R visuals build
+    xdescribe("Build and Server for R Visuals", () => {
+        let pbivizProc;
+
+        beforeEach(() => {
+            process.chdir(visualPath);
+            FileSystem.runCMDCommand('npm i', visualPath);
+            pbivizProc = FileSystem.runPbivizAsync('start');
+            pbivizProc.stderr.on('data', (data) => {
+                if (data.toString().indexOf("DeprecationWarning") === -1) {
+                    throw new Error(data.toString());
+                }
+            });
+        });
+
+        it("Should rebuild files on change and update status for R Visuals", (done) => {
+            let statusPath = path.join(dropPath, 'status');
+            let lastStatus;
+            let rChangeCount = 0;
+
+            function getStatus() {
+                return fs.readFileSync(statusPath);
+            }
+
+            let callbackCalled = false;
+            pbivizProc.stdout.on('data', (data) => {
+                let dataStr = data.toString();
+                if (dataStr.indexOf("Compiled successfully") !== -1 || dataStr.match(/Compiled with\s*(\d)* warnings/) !== null) {
+                    if (callbackCalled) {
+                        return;
+                    }
+                    callbackCalled = true;
+                    expect(rChangeCount).toBe(0);
+                    lastStatus = getStatus();
+
+                    //trigger r change
+                    let rScriptPath = path.join(visualPath, 'script.r');
+                    fs.appendFileSync(rScriptPath, '// appended to R file');
+                }
+
+                if (dataStr.indexOf('RScript build complete') !== -1) {
+                    rChangeCount++;
+                    expect(rChangeCount).toBe(1);
+                    let status = getStatus();
+                    expect(status).not.toBe(lastStatus);
+                    lastStatus = status;
+
+                    //the end
+                    FileSystem.killProcess(pbivizProc, 'SIGTERM', (error) => {
+                        expect(error).toBeNull();
+                        done();
+                    });
+                }
+            });
+        });
+    });
+});

package/spec/e2e/pbivizWebpackVerSpec.js

@@ -0,0 +1,102 @@
+/*
+ *  Power BI Visual CLI
+ *
+ *  Copyright (c) Microsoft Corporation
+ *  All rights reserved.
+ *  MIT License
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the ""Software""), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+"use strict";
+
+const fs = require('fs-extra');
+const path = require('path');
+
+const FileSystem = require('../helpers/FileSystem.js');
+const writeMetadata = require("./utils").writeMetadata;
+const semver = require('semver');
+
+const tempPath = FileSystem.getTempPath();
+const startPath = process.cwd();
+const visualName = 'visualname';
+const visualPath = path.join(tempPath, visualName);
+
+describe("E2E - webpack tools", () => {
+    beforeEach(() => {
+        FileSystem.resetTempDirectory();
+        process.chdir(tempPath);
+        FileSystem.runPbiviz('new', visualName, ' -t default --force');
+        process.chdir(visualPath);
+
+        writeMetadata(visualPath);
+    });
+
+    afterEach(() => {
+        process.chdir(startPath);
+    });
+
+    afterAll(() => {
+        process.chdir(startPath);
+        FileSystem.deleteTempDirectory();
+    });
+
+    let removeApi = () => {
+        let packageJson = fs.readJsonSync(path.join(visualPath, 'package.json'));
+        packageJson.dependencies = {
+            "powerbi-visuals-utils-dataviewutils": "2.0.1"
+        };
+        fs.writeJsonSync(path.join(visualPath, 'package.json'), packageJson);
+        
+        fs.removeSync(path.join(visualPath, "node_modules", "powerbi-visuals-api"));
+    };
+
+    it("Should not add empty dependencies option into visual config", () => {
+        FileSystem.runPbiviz('package');
+
+        let packageJson = fs.readJsonSync(path.join(visualPath, '.tmp/drop/pbiviz.json'));
+        expect(packageJson.dependencies).not.toBeDefined();
+    });
+
+    it("Should install the latest powerbi-visual-api if apiVersion is undefined", () => {
+        let pbivizJson = fs.readJsonSync(path.join(visualPath, 'pbiviz.json'));
+        pbivizJson.apiVersion = null;
+        fs.writeJsonSync(path.join(visualPath, 'pbiviz.json'), pbivizJson);
+
+        removeApi();
+        FileSystem.runPbiviz('package');
+
+        let packageJson = fs.readJsonSync(path.join(visualPath, 'package.json'));
+        expect(packageJson.dependencies["powerbi-visuals-api"]).toBeDefined();
+    });
+
+    it("Should install powerbi-visual-api with version from pbiviz.json on 'pbiviz start/package'", () => {
+        let pbivizJson = fs.readJsonSync(path.join(visualPath, 'pbiviz.json'));
+        removeApi();
+        FileSystem.runPbiviz('package');
+
+        let packageJson = fs.readJsonSync(path.join(visualPath, 'package.json'));
+        expect(packageJson.dependencies["powerbi-visuals-api"]).toBeDefined();
+        expect(semver.major(pbivizJson.apiVersion))
+            .toBe(semver.major(packageJson.dependencies["powerbi-visuals-api"].replace(/\^|\~/, ""))); // eslint-disable-line no-useless-escape
+        expect(semver.minor(pbivizJson.apiVersion))
+            .toBe(semver.minor(packageJson.dependencies["powerbi-visuals-api"].replace(/\^|\~/, ""))); // eslint-disable-line no-useless-escape
+    });
+
+});

package/spec/e2e/utils.js

@@ -0,0 +1,63 @@
+/*
+ *  Power BI Visual CLI
+ *
+ *  Copyright (c) Microsoft Corporation
+ *  All rights reserved.
+ *  MIT License
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the ""Software""), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+"use strict";
+
+const path = require("path");
+const fs = require('fs-extra');
+
+let readdirSyncRecursive = (baseDir) => {
+    let read = (dir) => {
+        let results = [];
+        let list = fs.readdirSync(dir);
+        list.forEach((file) => {
+            file = dir + '/' + file;
+            let stat = fs.statSync(file);
+            if (stat && stat.isDirectory()) { 
+                /* Recurse into a subdirectory */
+                results = results.concat(read(file));
+            } else { 
+                /* Is a file */
+                results.push(file.replace(baseDir, ""));
+            }
+        });
+        return results;
+    };
+    return read(baseDir);
+};
+
+let writeMetadata = (visualPath) => {
+    let pbivizJSONFile = path.join(visualPath, '/pbiviz.json');
+    let pbiviz = fs.readJSONSync(pbivizJSONFile);
+    pbiviz.visual.description = "description";
+    pbiviz.visual.supportUrl = "supportUrl";
+    pbiviz.author.name = "Microsoft";
+    pbiviz.author.email = "pbicvsupport";
+    fs.writeJSONSync(pbivizJSONFile, pbiviz);
+};
+
+module.exports.readdirSyncRecursive = readdirSyncRecursive;
+module.exports.writeMetadata = writeMetadata;