@webos-tools/cli 3.0.0

package/spec/jsSpecs/ares-generate.spec.js

@@ -0,0 +1,397 @@
+/*
+ * Copyright (c) 2020-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');
+
+const aresCmd = 'ares-generate',
+    outputPath = path.resolve(__dirname, "..", "tempFiles"),
+    sampleAppPath = path.resolve(outputPath, "sampleApp"),
+    sampleServicePath =  path.resolve(outputPath, "sampleService");
+
+let cmd,
+    options,
+    expectedTemplate,
+    expectedList;
+
+beforeAll(function(done) {
+    cmd = common.makeCmd(aresCmd);
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        return common.getExpectedResult(aresCmd);
+    }).then(function(result) {
+        expectedTemplate = result.template;
+        expectedList = result.list;
+        done();
+    });
+});
+
+describe(aresCmd + ' -v', function() {
+    it('Print help message with verbose log', function(done) {
+        exec(cmd + ' -v', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("verb argv");
+            }
+            expect(stdout).toContain("SYNOPSIS");
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --list', function() {
+    it('List the available templates', function(done) {
+        exec(cmd + ' --list', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            expectedList = expectedList.join('\n'); // multi string in array. need to join
+            stdout = stdout.trim().replace(/\s+['\n']/g, '\n');
+            expect(stdout).toContain(expectedList);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd +' --property', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+    afterEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    it('Set the properties of appinfo.json', function(done) {
+        const id = "com.sample.app";
+        const version = "2.0.0";
+        const title = "First App";
+
+        exec(cmd + ` -t ${expectedTemplate.webapp} -p "id=${id}" -p "version=${version}" -p "title=${title}" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text, outputObj;
+            expect(fs.existsSync(path.join(sampleAppPath, "appinfo.json"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(outputObj.id).toBe(id);
+            expect(outputObj.version).toBe(version);
+            expect(outputObj.title).toBe(title);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('Set the properties of packageinfo.json', function(done) {
+        if (options.profile === "ose") {
+            pending(options.skipTxt);
+        }
+
+        const id = "com.sample.pkg";
+        const version = "1.1.1";
+        const test = "testData";
+
+        exec(cmd + ` -t packageinfo -p "id=${id}" -p "version=${version}" -p "test=${test}" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text, outputObj;
+            expect(fs.existsSync(path.join(sampleAppPath, "packageinfo.json"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath, "packageinfo.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(outputObj.id).toBe(id);
+            expect(outputObj.version).toBe(version);
+            expect(outputObj.test).toBe(test);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('Set the properties of services.json', function(done) {
+        const id = "com.sample.app.service";
+        const version = "1.1.1";
+
+        exec(cmd + ` -t jsserviceinfo -p "id=${id}" -p "version=${version}" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text, outputObj;
+            expect(fs.existsSync(path.join(sampleAppPath, "services.json"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath, "services.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(outputObj.id).toBe(id);
+            expect(outputObj.version).toBe(version);
+            expect(outputObj.services[0].name).toBe(id);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('Set the properties of qmlappinfo.json', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+
+        const id = "com.qml.app";
+        const version = "2.0.0";
+        const title = "First App";
+
+        exec(cmd + ` -t ${expectedTemplate.qmlappinfo} -p "id=${id}" -p "version=${version}" -p "title=${title}" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text, outputObj;
+            expect(fs.existsSync(path.join(sampleAppPath, "appinfo.json"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(outputObj.id).toBe(id);
+            expect(outputObj.version).toBe(version);
+            expect(outputObj.title).toBe(title);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --template', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+    afterEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    it('webappinfo : appinfo.json for web app', function(done) {
+        exec(cmd + ` -t webappinfo -p "id=com.domain.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            const fileList = [];
+
+            expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+            try {
+                fs.readdirSync(sampleAppPath).forEach(file => {
+                    fileList.push(file);
+                });
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(JSON.stringify(fileList)).toBe(JSON.stringify(expectedTemplate.webappinfo));
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('packageinfo : packageinfo.json for webOS package', function(done) {
+        if (options.profile === "ose") {
+            pending(options.skipTxt);
+        }
+
+        exec(cmd + ` -t packageinfo -p "id=com.domain" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            const  fileList= [];
+
+            expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+            try {
+                fs.readdirSync(sampleAppPath).forEach(file => {
+                    fileList.push(file);
+                });
+            } catch(err) {
+                console.error(err);
+            }
+
+            expect(JSON.stringify(fileList)).toContain(JSON.stringify(expectedTemplate.packageinfo));
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('hosted_webapp : generate hosted template app', function(done) {
+        const url = "http://www.google.com";
+        exec(cmd + ` -t hosted_webapp -p "url=${url}" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text;
+            expect(fs.existsSync(path.join(sampleAppPath, "index.html"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath,"index.html"));
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(text.toString()).toContain(url);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('qmlapp : generate qml template app', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+
+        exec(cmd + ` -t qmlapp -p "id=com.qml.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text;
+            expect(fs.existsSync(path.join(sampleAppPath, "main.qml"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleAppPath,"main.qml"),'utf8');
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(text).toContain("com.qml.app");
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --overwrite(-f)', function() {
+    beforeAll(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    afterAll(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+
+    it('generate sample app', function(done) {
+        exec(cmd + ` -t webappinfo -p "id=com.domain.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            const fileList = [];
+
+            expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+            try {
+                fs.readdirSync(sampleAppPath).forEach(file => {
+                    fileList.push(file);
+                });
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(JSON.stringify(fileList)).toBe(JSON.stringify(expectedTemplate.webappinfo));
+            expect(error).toBeNull();
+            done();
+        });
+    });
+
+    it('Overwirte existing files', function(done) {
+        exec(cmd + ` -f -t webappinfo -p "id=com.domain.app" ${sampleAppPath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            const fileList = [];
+
+            expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+            try {
+                fs.readdirSync(sampleAppPath).forEach(file => {
+                    fileList.push(file);
+                });
+            } catch (err) {
+                console.error(err);
+            }
+
+            expect(JSON.stringify(fileList)).toBe(JSON.stringify(expectedTemplate.webappinfo));
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --servicename', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleServicePath);
+        done();
+    });
+    afterEach(function(done) {
+        common.removeOutDir(sampleServicePath);
+        done();
+    });
+
+    it('Set the servicename for webOS service.', function(done) {
+        const serviceid = "com.domain.app.service";
+        exec(cmd + ` -t ${expectedTemplate.jsservice} -s ${serviceid} ${sampleServicePath}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            let text, outputObj;
+            expect(fs.existsSync(path.join(sampleServicePath, "services.json"))).toBe(true);
+            try {
+                text = fs.readFileSync(path.join(sampleServicePath, "services.json"));
+                outputObj = JSON.parse(text);
+            } catch (err) {
+                console.error(err);
+            }
+            expect(outputObj.id).toBe(serviceid);
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it("Set invalid template type", function(done) {
+        exec(cmd + ' -t invalidType sampleApp', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares-generate ERR! [Tips]: Invalid value <TEMPLATE> : invalidType", error);
+            }
+            done();
+        });
+    });
+});

package/spec/jsSpecs/ares-inspect.spec.js

@@ -0,0 +1,252 @@
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const exec = require('child_process').exec,
+    common = require('./common-spec');
+
+const aresCmd = 'ares-inspect';
+
+let cmd, 
+    options;
+
+beforeAll(function(done) {
+    cmd = common.makeCmd(aresCmd);
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        done();
+    });
+});
+
+describe(aresCmd + ' -v', function() {
+    it('Print help message with verbose log', function(done) {
+        exec(cmd + ' -v', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("verb argv");
+            }
+            expect(stdout).toContain("SYNOPSIS");
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd, 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 + ' --device-list(-D)', function() {
+    it('Show available device list', function(done) {
+        exec(cmd + ' -D', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(options.device, error);
+            expect(stdout).toContain(options.profile);
+            done();
+        });
+    });
+});
+
+describe(aresCmd, function() {
+    it('Install sample ipk to device', 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", stderr);
+            setTimeout(() => {
+                done();
+            }, 2000);
+        });
+    });
+});
+
+describe(aresCmd, function() {
+    it('Run web inspector for sample app', function(done) {
+        const child = exec(cmd + ` -a ${options.pkgId} -dp 0`);
+        let stdoutData = "";
+
+        child.stdout.on('data', function(data) {
+            process.stdout.write(data);
+            stdoutData += data;
+        });
+
+        child.stderr.on('data', function(data) {
+            if (data && data.length > 0) {
+                common.detectNodeMessage(data);
+            }
+            expect(data).toBeNull();
+        });
+
+        setTimeout(() => {
+            child.kill();
+            expect(stdoutData).toContain('Application Debugging - http://localhost');
+            done();
+        }, 7000);
+    });
+
+    it('Close sample App', function(done) {
+        const launchCmd = common.makeCmd('ares-launch');
+        exec(launchCmd + ` -c ${options.pkgId} -dp 0`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(`Closed application ${options.pkgId}`, error);
+            setTimeout(function() {
+                done();
+            }, 3000);
+        });
+    });
+});
+
+describe(aresCmd +' --open(-o)', function() {
+    it('Open web inspector for sample app', function(done) {
+        const child = exec(cmd + ` -a ${options.pkgId} -o -dp 1`);
+        let stdoutData = "";
+
+        child.stdout.on('data', function(data) {
+            process.stdout.write(data);
+            stdoutData += data;
+        });
+
+        child.stderr.on('data', function(data) {
+            if (data && data.length > 0) {
+                common.detectNodeMessage(data);
+            }
+            expect(data).toBeNull();
+        });
+
+        setTimeout(() => {
+            child.kill();
+            expect(stdoutData).toContain('Application Debugging - http://localhost');
+            done();
+        }, 3000);
+    });
+
+    it('Close sample App', function(done) {
+        const launchCmd = common.makeCmd('ares-launch');
+        exec(launchCmd + ` -c ${options.pkgId} -dp 1`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(`Closed application ${options.pkgId}`, error);
+            setTimeout(function() {
+                done();
+            }, 3000);
+        });
+    });
+});
+
+describe(aresCmd, function() {
+    let stdoutData = "";
+
+    it('Run Node\'s Inspector for sample Service', function(done) {
+        const child = exec(cmd + ` -s ${options.pkgService} -dp 1`);
+
+        child.stdout.on('data', function(data) {
+            process.stdout.write(data);
+            stdoutData += data;
+        });
+
+        child.stderr.on('data', function(data) {
+            if (data && data.length > 0) {
+                common.detectNodeMessage(data);
+            }
+            expect(data).toBeNull();
+        });
+
+        setTimeout(() => {
+            child.kill();
+            expect(stdoutData).toContain("[Info] Set target device : " + options.device);
+            expect(stdoutData).toContain("Processing");
+            expect(stdoutData).not.toContain("null");
+            expect(stdoutData).toContain("To debug your service, set ");
+            done();
+        }, 10000);
+    });
+});
+
+describe(aresCmd +' --open(-o)', function() {
+    let stdoutData = "";
+
+    it('Open Node\'s Inspector for sample Service', function(done) {
+        const child = exec(cmd + ` -s ${options.pkgService} -dp 0 -o`);
+
+        child.stdout.on('data', function(data) {
+            process.stdout.write(data);
+            stdoutData += data;
+        });
+
+        child.stderr.on('data', function(data) {
+            if (data && data.length > 0) {
+                common.detectNodeMessage(data);
+            }
+            expect(data).toBeNull();
+        });
+
+        setTimeout(() => {
+            child.kill();
+            expect(stdoutData).toContain("To debug your service, set ");
+            expect(stdoutData).toContain("Cannot support \"--open option\" on platform node version 8 and later");
+            done();
+        }, 7000);
+    });
+});
+
+describe(aresCmd, 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}`, stderr);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it("Set invalid app which is not installed", function(done) {
+        exec(cmd + ' com.invalid.app', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                if (options.profile === "ose") {
+                    expect(stderr).toContain("ares-inspect ERR! [com.webos.applicationManager failure]:" +
+                                            " luna-send command failed <Cannot find proper launchPoint>");
+                    expect(stderr).toContain("ares-inspect ERR! [Tips]: The app is not installed app. Please check the list by ares-install -l");
+                } else if (options.profile === "tv") {
+                    expect(stderr).toContain("ares-inspect ERR! [com.webos.applicationManager failure]: luna-send command failed <not exist>");
+                }
+            }
+            done();
+        });
+    });
+
+    it("Set invalid service which is not installed", function(done) {
+        exec(cmd + ' -s com.invalid.service', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares-inspect ERR! [Tips]: Failed to get service installation path <com.invalid.service>");
+            }
+            done();
+        });
+    });
+});