@webos-tools/cli 3.0.0

package/spec/jsSpecs/apiTest/launcher.spec.js

@@ -0,0 +1,150 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path'),
+    exec = require('child_process').exec,
+    common = require('../common-spec'),
+    launcher = require('../../../lib/launch');
+
+const aresCmd = 'Launcher',
+    sampleAppPath = path.join(__dirname, "../..", "tempFiles/sampleApp"),
+    launchOptions = {
+        display: 0
+    };
+
+let options,
+    expectedTemplate;
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        return common.getExpectedResult("ares-generate");
+    }).then(function(result) {
+        expectedTemplate = result.template;
+        done();
+    });
+});
+
+describe("Test setting", function() {
+    it("Add device with ares-setup-device", function(done) {
+        common.resetDeviceList()
+        .then(function() {
+            return common.addDeviceInfo();
+        }).then(function(result) {
+            expect(result).toContain(options.device);
+            done();
+        }).catch(function(err) {
+            expect(err).toContain("The specified value already exist");
+            done();
+        });
+    });
+
+    it('Install sample ipk to device with ares-install', function(done) {
+        const installCmd = common.makeCmd('ares-install');
+        exec(installCmd + ` ${options.ipkPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain("Success");
+            setTimeout(function() {
+                done();
+            },3000);
+        });
+    });
+});
+
+
+describe(aresCmd + '.launch()', function() {
+    it('Launch sample App', function(done) {
+        launcher.launch(launchOptions, options.pkgId, {}, function(err, value) {
+            expect(value.msg).toContain(`Launched application ${options.pkgId}`);
+            setTimeout(function() {
+                done();
+            },1000);
+        });
+       
+    });
+});
+
+describe(aresCmd + '.listRunningApp()', function() {
+    it('List up sample app', function(done) {
+        launcher.listRunningApp(launchOptions, function(err, value) {
+            expect(JSON.stringify(value)).toContain(`${options.pkgId}`);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + '.close()', function() {
+    it('Close sample app', function(done) {
+        launcher.close(launchOptions, options.pkgId, {}, function(err, value) {
+            expect(value.msg).toContain(`${options.pkgId}`);
+            done();
+        });
+    });
+});
+
+describe("Test setting", function() {
+    it('Remove installed sample app with ares-install', function(done) {
+        const installCmd = common.makeCmd('ares-install');
+        exec(installCmd + ` -r ${options.pkgId}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(`Removed package ${options.pkgId}`);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + '.launch() with hosted option', function() {
+    beforeAll(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+    afterAll(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    it('Test setting: Generate SampleApp', function(done) {
+        const generateCmd = common.makeCmd('ares-generate');
+        exec(generateCmd + ` -t ${expectedTemplate.webapp} -p "id=com.sample.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(`Generating ${expectedTemplate.webapp}`);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it(aresCmd + '.launch() with hosted option', function(done) {
+        let outputData="";
+        launchOptions.installMode = "Hosted";
+        launchOptions.hostedurl = `${sampleAppPath}`;
+        launcher.launch(launchOptions, "com.sdk.ares.hostedapp", {}, function() {
+        }, function(output) {
+            outputData += output;
+            setTimeout(function() {
+                expect(outputData).toContain('Ares Hosted App is now running');
+                done();
+            },5000);
+        });
+    });
+
+    it('Test setting: Remove installed ares-hosted app with ares-install', function(done) {
+        const installCmd = common.makeCmd('ares-install');
+        exec(installCmd + ' -r com.sdk.ares.hostedapp', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(`Removed package com.sdk.ares.hostedapp`);
+            done();
+        });
+    });
+});

package/spec/jsSpecs/apiTest/packager.spec.js

@@ -0,0 +1,194 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const path = require('path'),
+    fs = require('fs'),
+    exec = require('child_process').exec,
+    common = require('../common-spec'),
+    Packager = require('../../../lib/package');
+
+const packager = new Packager.Packager(),
+    tempDirPath = path.join(__dirname, "../..", "tempFiles"),
+    sampleAppPath = path.join(tempDirPath, "sampleApp"),
+    sampleServicePath =  path.join(tempDirPath, "sampleService"),
+    outputPath = path.join(tempDirPath, "output"),
+    appPathByRom = path.join(outputPath, "usr/palm/applications"),
+    appPkgPath = path.join(outputPath, "com.webos.sample.app_1.0.0_all.ipk"),
+    ipkBasePath = path.join(tempDirPath, "ipks");
+
+const aresCmd = 'Packager',
+    sampleServicePaths = [],
+    packageOptions = {};
+
+let expectedTemplate;
+
+beforeAll(function(done) {
+    common.getExpectedResult("ares-generate")
+    .then(function(result) {
+        expectedTemplate = result.template;
+        done();
+    });
+});
+
+afterAll(function(done) {
+    common.removeOutDir(sampleAppPath); // can be in afterAll
+    common.removeOutDir(sampleServicePath); // can be in afterAll
+    done();
+});
+
+describe("Test setting", function() {
+    it('Generate a sample app for packaging', function(done) {
+        common.removeOutDir(sampleAppPath);
+        const generateCmd = common.makeCmd('ares-generate');
+        exec(generateCmd + ` -t ${expectedTemplate.webapp} -p "id=com.webos.sample.app" -p "version=1.0.0" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain("Generating");
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('Generate two sample services for packaging', function(done) {
+        common.removeOutDir(sampleServicePath);
+        const serviceid = ["com.webos.sample.app.service", "com.webos.sample.service1", "com.webos.sample.service2"];
+        serviceid.forEach(function(svcId) {
+            const svcPath = path.join(sampleServicePath, svcId);
+            sampleServicePaths.push(path.join(sampleServicePath, svcId));
+            const generateCmd = common.makeCmd('ares-generate');
+            exec(generateCmd + ` -t ${expectedTemplate.jsservice} -s ${svcId} ${svcPath}`, function(error, stdout, stderr) {
+                if (stderr && stderr.length > 0) {
+                    common.detectNodeMessage(stderr);
+                }
+                expect(stdout).toContain("Generating");
+                done();
+            });
+        });
+    });
+});
+
+describe(aresCmd + '.generatePackage()', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(outputPath);
+        done();
+    });
+    afterEach(function(done) {
+        common.removeOutDir(outputPath);
+        done();
+    });
+
+    it('Package web app with -o(--outdir)', function(done) {
+        packager.generatePackage([`${sampleAppPath}`], outputPath, packageOptions, function(data) {
+            expect(data).toContain("Create");
+        }, function(err, value) {
+            expect(value.msg).toContain("Success");
+            expect(fs.existsSync(appPkgPath)).toBe(true);
+            setTimeout(function() {
+                done();
+            },3000);
+        });
+    });
+
+    it('Package web app & service with -o(--outdir)', function(done) {
+        const source = [sampleAppPath.toString(), sampleServicePaths[0].toString()];
+        packager.generatePackage(source, outputPath, packageOptions, function(data) {
+            expect(data).toContain("Create");
+        }, function(err, value) {
+            expect(value.msg).toContain("Success");
+            expect(fs.existsSync(appPkgPath)).toBe(true);
+            setTimeout(function() {
+                done();
+            },3000);
+        });
+    });
+
+    it('Create output a directory structure with app', function(done) {
+        const source = [sampleAppPath.toString(), sampleServicePaths[0].toString()];
+        packageOptions.rom = true;
+        packager.generatePackage(source, outputPath, packageOptions, function(data) {
+            expect(data).toContain("Create output directory");
+        }, function(err, value) {
+            expect(value.msg).toContain("Success");
+            setTimeout(function() {
+                const createdSvcPath = path.join(outputPath, 'usr/palm/services');
+                expect(fs.existsSync(appPathByRom)).toBe(true);
+                expect(fs.existsSync(createdSvcPath)).toBe(true);
+                done();
+            },3000);
+            delete packageOptions.rom;
+        });
+    });
+});
+
+describe(aresCmd + '.generatePackage()', function() {
+    const tmpFilePath = path.join(sampleAppPath, "tmpFile");
+    beforeEach(function(done) {
+        common.removeOutDir(outputPath);
+        fs.writeFileSync(tmpFilePath, "", 'utf8');
+        done();
+    });
+
+    afterEach(function(done) {
+        common.removeOutDir(tmpFilePath);
+        common.removeOutDir(outputPath);
+        done();
+    });
+
+    it('Check exclude file option', function(done) {
+        let outputData="";
+        packageOptions.rom = true;
+        packageOptions.excludefiles = "tmpFile";
+        packager.generatePackage([`${sampleAppPath}`], outputPath, packageOptions, function(data) {
+            outputData += data;
+        }, function(err, value) {
+            expect(outputData).toContain("Create");
+            expect(value.msg).toContain("Success");
+            expect(fs.existsSync(path.join(appPathByRom, "com.webos.sample.app/tmpFile"))).toBe(false);
+            done();
+            delete packageOptions.excludefiles;
+            delete packageOptions.rom;
+        });
+    });
+});
+
+describe(aresCmd + ".analyzeIPK()", function() { 
+    it('Info of web app and service package with info', function(done) {
+        const webIpk= path.join(ipkBasePath, "com.web.app_1.0.0_all.ipk");
+        packageOptions.info = webIpk;
+        packager.analyzeIPK(packageOptions, function(err, value) {
+            expect(value.msg).toContain("< Package Information >");
+            expect(value.msg).toContain("< Application Information >");
+            expect(value.msg).toContain("< Service Information >");
+            done();
+            delete packageOptions.info;
+        });
+    });
+
+    it('Info of web app and service package with infodetail', function(done) {
+        const webIpk= path.join(ipkBasePath, "com.web.app_1.0.0_all.ipk");
+        packageOptions.infodetail = webIpk;
+        packager.analyzeIPK(packageOptions, function(err, value) {
+            expect(value.msg).toContain("< packageinfo.json >");
+            expect(value.msg).toContain("< appinfo.json >");
+            expect(value.msg).toContain("< services.json >");
+            expect(value.msg).toContain("< package.json >");
+            done();
+            delete packageOptions.infodetail;
+        });
+    });
+
+    it('Info of external native app and service package', function(done) {
+        const externalAppIpk= path.join(ipkBasePath, "com.sample.echo_0.0.1_all.ipk");
+        packageOptions.info = externalAppIpk;
+        packager.analyzeIPK(packageOptions, function(err, value) {
+            expect(value.msg).toContain("< Package Information >");
+            expect(value.msg).toContain("< Application Information >");
+            expect(value.msg).toContain("< Service Information >");
+            done();
+            delete packageOptions.info;
+        });
+    });
+});

package/spec/jsSpecs/apiTest/puller.spec.js

@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path'),
+    exec = require('child_process').exec,
+    common = require('../common-spec'),
+    puller = require('../../../lib/pull');
+
+const aresCmd = 'Puller',
+    dstPath = path.join(__dirname, "../..", "tempFiles"),
+    pullOptions = {};
+
+let options,
+    outputData="";
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        done();
+    });
+});
+
+beforeEach(function(done) {
+    const shellCmd = common.makeCmd('ares-shell');
+    exec(shellCmd + ' -r "touch /tmp/aresfile"', function() {
+        done();
+    });
+});
+
+afterEach(function(done) {
+    common.removeOutDir(path.join(dstPath, "aresfile"));
+    done();
+});
+
+describe("Test setting", function() {
+    it("Add device with ares-setup-device", function(done) {
+        common.resetDeviceList()
+        .then(function() {
+            return common.addDeviceInfo();
+        }).then(function(result) {
+            expect(result).toContain(options.device);
+            done();
+        }).catch(function(err) {
+            expect(err).toContain("The specified value already exist");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + '.pull()', function() {
+    it('Copy file from a device to host machine', function(done) {
+        puller.pull("/tmp/aresfile", `${dstPath}`, pullOptions, function(err, value) {
+            expect(outputData).toContain(dstPath);
+            expect(outputData).toContain("1 file(s) pulled");
+            expect(value.msg).toContain("Success");
+            done();
+        }, function(output) {
+            outputData += output;
+        });
+    });
+
+    it('Copy file from a device to host machine with ignore option', function(done) {
+        outputData="";
+        pullOptions.ignore = true;
+        puller.pull("/tmp/aresfile", `${dstPath}`, pullOptions, function(err, value) {
+            expect(outputData).toContain("1 file(s) pulled");
+            expect(value.msg).toContain("Success");
+            done();
+        }, function(output) {
+            outputData += output;
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    beforeEach(function(done) {
+        const shellCmd = common.makeCmd('ares-shell');
+        exec(shellCmd + ' -r "touch /tmp/aresfile"', function() {
+            done();
+        });
+    });
+
+    it('Copy file to not exist local directory', function(done) {
+        puller.pull("/tmp/aresfile", 'invalidDir', pullOptions, function(err) {
+            expect(err.toString()).toContain("ENOENT: no such file or directory, lstat");
+            expect(err.toString()).toContain("Please check if the path is valid");
+            done();
+        });
+    });
+
+    it('Copy invalid file from target', function(done) {
+        puller.pull("/tmp/invalidFile", 'tempDir', pullOptions, function(err) {
+            expect(err.toString()).toContain("The specified path does not exist <SOURCE> : /tmp/invalidFile");
+            done();
+        });
+    });
+});

package/spec/jsSpecs/apiTest/pusher.spec.js

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path'),
+    exec = require('child_process').exec,
+    common = require('../common-spec'),
+    Pusher = require('../../../lib/pusher');
+
+const aresCmd = 'Pusher',
+    srcPath = path.join(__dirname, "../..", "tempFiles/copyFiles"),
+    push = new Pusher(),
+    src = [`${srcPath}`];
+
+let options;
+
+const pushOptions = {
+};
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        done();
+    });
+});
+
+afterAll(function(done) {
+    const shellCmd = common.makeCmd('ares-shell');
+    exec(shellCmd + ` -r "rm -rf /tmp/copyFiles"`, function() {
+        done();
+    });
+});
+
+describe("Test setting", function() {
+    it("Add device with ares-setup-device", function(done) {
+        common.resetDeviceList()
+        .then(function() {
+            return common.addDeviceInfo();
+        }).then(function(result) {
+            expect(result).toContain(options.device);
+            done();
+        }).catch(function(err) {
+            expect(err).toContain("The specified value already exist");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ".push", function() {
+    beforeEach(function(done) {
+        const shellCmd = common.makeCmd('ares-shell');
+        exec(shellCmd + ` -r "rm -rf /tmp/copyFiles"`, function() {
+            done();
+        });
+    });
+
+    it('Copy directory', function(done) {
+        let outputTxt = "";
+        push.push(src, '/tmp', pushOptions, function(err, value) {
+            expect(value.msg).toContain("Success");
+            expect(outputTxt).toContain("/tmp/copyFiles/testFile.txt");
+            expect(outputTxt).toContain("/tmp/copyFiles/helloFile.txt");
+            expect(outputTxt).toContain("2 file(s) pushed");
+            setTimeout(function() {
+                done();
+            },3000);
+        }, function(data) {
+            outputTxt += data;
+        });
+    });
+
+    it('Copy directory with ignore option', function(done) {
+        let outputTxt = "";
+        pushOptions.ignore = true;
+        push.push(src, '/tmp', pushOptions, function(err, value) {
+            expect(value.msg).toContain("Success");
+            expect(outputTxt).not.toContain("/tmp/copyFiles/testFile.txt");
+            expect(outputTxt).not.toContain("/tmp/copyFiles/helloFile.txt");
+            expect(outputTxt).toContain("2 file(s) pushed");
+            setTimeout(function() {
+                done();
+            },3000);
+        }, function(data) {
+            outputTxt += data;
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it('Set invaild source path', function(done) {
+        push.push(["invalidDir"], '/tmp', pushOptions, function(err) {
+            expect(err.toString()).toContain("ENOENT: no such file or directory, lstat");
+            expect(err.toString()).toContain("Please check if the path is valid");
+            setTimeout(function() {
+                done();
+            },3000);
+        }, function() {
+        });
+    });
+});

package/spec/jsSpecs/apiTest/server.spec.js

@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path'),
+    fs = require('fs'),
+    exec = require('child_process').exec,
+    common = require('../common-spec'),
+    server = require('../../../lib/base/server'),
+    async = require('async');
+
+const aresCmd = 'Server',
+    sampleAppPath = path.join(__dirname, "../..", "tempFiles/sampleApp"),
+    serverOption = {
+        path: undefined
+    };
+
+let expectedTemplate,
+    killTimer,
+    serverUrl;
+
+function _reqHandler(code, res) {
+    if (code === "@@ARES_CLOSE@@") {
+        res.status(200).send();
+        killTimer = setTimeout(function() {
+        }, 2 * 1000);
+    } else if (code === "@@GET_URL@@") {
+        clearTimeout(killTimer);
+        res.status(200).send(serverUrl);
+    }
+}
+
+beforeAll(function(done) {
+    common.getExpectedResult("ares-generate")
+    .then(function(result) {
+        expectedTemplate = result.template;
+        done();
+    });
+});
+
+afterAll(function(done) {
+    common.removeOutDir(sampleAppPath);
+    done();
+});
+
+describe("Test setting", function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    it('Generate sample app', function(done) {
+        const generateCmd = common.makeCmd('ares-generate');
+        exec(generateCmd + ` -t ${expectedTemplate.webapp} -p "id=com.domain.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let outputObj;
+            try {
+                const text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+            expect(outputObj.id).toBe("com.domain.app");
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ".runServer() and " + aresCmd + ".stop()", function() {
+    it('Run a local web server', function(done) {
+        async.waterfall([
+            server.runServer.bind(server, `${sampleAppPath}`, 0, _reqHandler),
+            function(serverInfo, next) {
+                expect(serverInfo.msg).toContain('Local server running on http://localhost:');
+                serverUrl = serverInfo.url;
+                server.openBrowser(serverInfo.openBrowserUrl, serverOption.path, next);
+            },
+            function(returnObj, next) {
+                expect(returnObj.msg).toContain('Browser opened');
+                setTimeout(() => {
+                    server.stop(next);
+                }, 3000);
+            }
+        ], function(err, results) {
+                expect(results.msg).toContain('Local server is stopped');
+                done();
+        });
+    });
+
+    it('Run a local web server with port option', function(done) {
+        async.waterfall([
+            server.runServer.bind(server, `${sampleAppPath}`, 1234, _reqHandler),
+            function(serverInfo, next) {
+                expect(serverInfo.msg).toContain('Local server running on http://localhost:');
+                serverUrl = serverInfo.url;
+                server.openBrowser(serverInfo.openBrowserUrl, serverOption.path, next);
+            },
+            function(returnObj, next) {
+                expect(returnObj.msg).toContain('Browser opened');
+                setTimeout(() => {
+                    server.stop(next);
+                }, 3000);
+            }
+        ], function(err, results) {
+                expect(results.msg).toContain('Local server is stopped');
+                done();
+        });
+    });
+});