@webos-tools/cli 3.0.0

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@webos-tools/cli",
+  "version": "3.0.0",
+  "description": "Command Line Interface for development webOS application and service",
+  "main": "APIs.js",
+  "author": "ye.kim",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webos-tools/cli.git"
+  },
+  "license": "Apache-2.0",
+  "bin": {
+    "ares": "bin/ares.js",
+    "ares-config": "bin/ares-config.js",
+    "ares-device": "bin/ares-device.js",
+    "ares-device-info": "bin/ares-device-info.js",
+    "ares-generate": "bin/ares-generate.js",
+    "ares-inspect": "bin/ares-inspect.js",
+    "ares-install": "bin/ares-install.js",
+    "ares-launch": "bin/ares-launch.js",
+    "ares-log": "bin/ares-log.js",
+    "ares-novacom": "bin/ares-novacom.js",
+    "ares-package": "bin/ares-package.js",
+    "ares-push": "bin/ares-push.js",
+    "ares-pull": "bin/ares-pull.js",
+    "ares-server": "bin/ares-server.js",
+    "ares-setup-device": "bin/ares-setup-device.js",
+    "ares-shell": "bin/ares-shell.js"
+  },
+  "engines": {
+    "node": ">=14.15.1"
+  },
+  "engineStrict": true,
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "dependencies": {
+    "ar-async": "0.1.4",
+    "async": "0.2.10",
+    "bluebird": "3.7.2",
+    "body-parser": "1.19.0",
+    "chalk": "1.1.3",
+    "chardet": "0.8.0",
+    "chokidar": "3.5.2",
+    "combined-stream": "1.0.8",
+    "csv-writer": "1.6.0",
+    "decompress": "4.2.1",
+    "easy-table": "1.1.1",
+    "elfy": "1.0.0",
+    "encoding": "0.1.13",
+    "express": "4.17.1",
+    "extract-zip": "1.7.0",
+    "fs-extra": "8.1.0",
+    "fstream": "1.0.12",
+    "graceful-fs": "4.2.4",
+    "inherits": "1.0.2",
+    "inquirer": "7.0.0",
+    "jsonschema": "1.2.6",
+    "mkdirp": "0.5.5",
+    "nopt": "2.1.2",
+    "npmlog": "4.1.2",
+    "ora": "5.4.0",
+    "request": "2.88.2",
+    "rimraf": "3.0.2",
+    "semver": "7.3.2",
+    "shelljs": "0.8.4",
+    "sprintf-js": "1.1.2",
+    "ssdp-js": "1.0.1",
+    "ssh2": "0.8.9",
+    "stream-buffers": "3.0.2",
+    "strip-bom": "1.0.0",
+    "tar": "2.2.2",
+    "temp": "0.9.1",
+    "terser": "4.8.0"
+  },
+  "devDependencies": {
+    "eslint": "6.8.0",
+    "eslint-plugin-import": "2.22.0",
+    "jasmine": "3.8.0",
+    "jasmine-pretty-html-reporter-jasmine3.8": "0.2.5",
+    "jasmine-spec-reporter": "4.2.1"
+  },
+  "keywords": [
+    "ares-cli",
+    "webOS",
+    "webOS OSE",
+    "webOS TV",
+    "webOS CLI",
+    "webOS SDK",
+    "LG"
+  ],
+  "bugs": {
+    "url": "https://github.com/webos-tools/cli/issues"
+  },
+  "homepage": "https://github.com/webos-tools/cli#readme"
+}

package/spec/helpers/reporter.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path');
+const SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+const HtmlReporter = require('jasmine-pretty-html-reporter-jasmine3.8').Reporter;
+
+jasmine.getEnv().configure({
+    random: false,
+    oneFailurePerSpec: false
+});
+
+jasmine.DEFAULT_TIMEOUT_INTERVAL = 25000;
+jasmine.getEnv().clearReporters(); // remove default reporter logs
+jasmine.getEnv().addReporter(new SpecReporter({ // add jasmine-spec-reporter
+    suite: {
+        // display each suite number (hierarchical)
+        displayNumber: true
+    },
+    spec: {
+        // display error messages for each failed assertion
+        displayErrorMessages: true,
+
+        // display stacktrace for each failed assertion
+        displayStacktrace: true,
+
+        // display each successful spec
+        displaySuccessful: true,
+
+        // display each failed spec
+        displayFailed: true,
+
+        // display each pending spec
+        displayPending: true,
+
+        // display each spec duration
+        displayDuration: false
+    },
+    summary: {
+        // display error messages for each failed assertion
+        displayErrorMessages: false,
+
+        // display stacktrace for each failed assertion
+        displayStacktrace: false,
+
+        // display summary of all successes after execution
+        displaySuccessful: true,
+
+        // display summary of all failures after execution
+        displayFailed: true,
+
+        // display summary of all pending specs after execution
+        displayPending: true,
+
+        // display execution duration
+        displayDuration: false
+    }
+}));
+
+jasmine.getEnv().addReporter(new HtmlReporter({
+    path: path.join(__dirname, '../../')
+}));

package/spec/jsSpecs/apiTest/generator.spec.js

@@ -0,0 +1,372 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const path = require('path'),
+    fs = require('fs'),
+    common = require('../common-spec'),
+    Generator = require('../../../lib/generator');
+
+const generator = new Generator(),
+    aresCmd = 'Generator',
+    outputPath = path.resolve(__dirname, "../..", "tempFiles"),
+    sampleAppPath = path.resolve(outputPath, "sampleApp"),
+    sampleServicePath =  path.resolve(outputPath, "sampleService");
+
+let expectedTemplate,
+    expectedList;
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function() {
+        return common.getExpectedResult("ares-generate");
+    }).then(function(result) {
+        expectedTemplate = result.template;
+        expectedList = result.list;
+        done();
+    });
+});
+
+afterAll(function(done) {
+    common.removeOutDir(sampleAppPath); // can be in afterAll
+    common.removeOutDir(sampleServicePath); // can be in afterAll
+    done();
+});
+
+describe(aresCmd + ' --list', function() {
+    it('List the available templates', function(done) {
+        generator.showTemplates(false, function(err, value) {
+            expectedList = expectedList.join('\n'); // multi string in array. need to join
+            value.msg = value.msg.trim().replace(/\s+['\n']/g, '\n');
+            expect(value.msg).toContain(expectedList);
+            done();
+        });
+    });
+});
+
+describe(aresCmd +' --property', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+    afterEach(function(done) {
+        setTimeout(() => {
+            common.removeOutDir(sampleAppPath);
+            done();
+        }, 3000);
+    });
+
+    it('Set the properties of appinfo.json', function(done) {
+        const id = "com.sample.app",
+            version = "2.0.0",
+            title = "First App",
+            options = {
+                tmplName: "webappinfo",
+                props: ['id='+`${id}`, 'version='+`${version}` , 'title='+`${title}`],
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text, outputObj;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating webappinfo");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "appinfo.json"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                    outputObj = JSON.parse(text);
+                } catch (error) {
+                    console.error(error);
+                }    
+                expect(outputObj.id).toBe(id);
+                expect(outputObj.version).toBe(version);
+                expect(outputObj.title).toBe(title);
+                done();
+            }, 5000);
+        });
+    });
+
+    it('Set the properties of services.json', function(done) {
+        const id = "com.sample.app.service",
+            version = "1.1.1",
+            options = {
+                tmplName :"jsserviceinfo",
+                props: ['id='+`${id}`, 'version='+`${version}`],
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text, outputObj;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating jsserviceinfo");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "services.json"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath, "services.json"));
+                    outputObj = JSON.parse(text);
+                } catch (error) {
+                    console.error(error);
+                }    
+                expect(outputObj.id).toBe(id);
+                done();
+            }, 5000);
+        });
+    });
+
+    it('Set the properties of qmlappinfo.json', function(done) {
+        const id = "com.qml.app",
+            version = "2.0.0",
+            options = {
+                tmplName :"qmlappinfo",
+                props: ['id='+`${id}`, 'version='+`${version}`],
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text, outputObj;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating qmlappinfo");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "appinfo.json"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                    outputObj = JSON.parse(text);
+                } catch (error) {
+                    console.error(error);
+                }    
+                expect(outputObj.id).toBe(id);
+                done();
+            }, 5000);
+        });
+    });
+});
+
+describe(aresCmd + ' --template', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleAppPath);
+        done();
+    });
+    afterEach(function(done) {
+        setTimeout(() => {
+            common.removeOutDir(sampleAppPath);
+            done();
+        }, 5000);
+    });
+
+    
+    it('webapp : appinfo.json for web app', function(done) {
+        const options = {
+            tmplName: "webapp",
+            out:sampleAppPath
+        };
+            
+        let outputTxt = "", fileList;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating webapp");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+                try {
+                    fileList = fs.readdirSync(sampleAppPath);
+                } catch (error) {
+                    console.error(error);
+                }
+                expect(fileList.toString()).toContain(expectedTemplate.webappinfo.toString());
+                done();
+            }, 5000);
+        });
+    });
+    
+    it('hosted_webapp : generate hosted template app', function(done) {
+        const url = "http://www.google.com",
+            options = {
+                tmplName: "hosted_webapp",
+                props: ['url='+`${url}`],
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating hosted_webapp");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "index.html"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath,"index.html"));
+                } catch (error) {
+                    console.error(error);
+                }
+                expect(text.toString()).toContain(url);
+                done();
+            }, 5000);
+        });
+    });
+
+    it('qmlapp : generate qml template app', function(done) {
+        const id = "com.qml.app",
+            title = "First App",
+            options = {
+                tmplName: "qmlapp",
+                props: ['id='+`${id}`, 'title='+`${title}`],
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating qmlapp");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "main.qml"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath,"main.qml"), 'utf8');
+                } catch (error) {
+                    console.error(error);
+                }
+                expect(text).toContain("com.qml.app");
+                done();
+            }, 5000);
+        });
+    });
+
+    it('js_service : generate js_service template', function(done) {
+        const id = "com.sample.app.service'",
+            options = {
+                tmplName: "js_service",
+                svcinfo: {id:`${id}`},
+                out:sampleAppPath
+            };
+            
+        let outputTxt = "", text;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating js_service");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "services.json"))).toBe(true);
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath,"services.json"));
+                } catch (error) {
+                    console.error(error);
+                }
+                expect(text.toString()).toContain(id);
+                done();
+            }, 5000);
+        });
+    });
+});
+
+describe(aresCmd + ' --overwrite(-f)', function() {
+    afterEach(function(done) {
+        setTimeout(() => {
+            common.removeOutDir(sampleAppPath);
+            done();
+        }, 5000);
+    });
+
+    it('webappinfo : appinfo.json for web app', function(done) {
+        const options = {
+            tmplName: "webappinfo",
+            out:sampleAppPath
+        };
+            
+        let outputTxt = "", fileList;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating webappinfo");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath))).toBe(true);
+
+                try {
+                    fileList = fs.readdirSync(sampleAppPath);
+                } catch (error) {
+                    console.error(error);
+                }
+                expect(JSON.stringify(fileList)).toBe(JSON.stringify(expectedTemplate.webappinfo));
+                done();
+            }, 3000);
+        });
+    });
+
+    it('Overwirte existing files', function(done) {
+        const id = "com.domain.app",
+            version = "2.0.0",
+            title = "First App",
+            options = {
+                tmplName: "webappinfo",
+                props: ['id='+`${id}`, 'version='+`${version}`, 'title='+`${title}`],
+                out:sampleAppPath,
+                overwrite:true
+            };
+            
+        let outputTxt = "", text, outputObj;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating webapp");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleAppPath, "appinfo.json"))).toBe(true);
+
+                try {
+                    text = fs.readFileSync(path.join(sampleAppPath, "appinfo.json"));
+                    outputObj = JSON.parse(text);
+                } catch (error) {
+                    console.error(error);
+                }    
+                expect(outputObj.id).toBe(id);
+                expect(outputObj.version).toBe(version);
+                expect(outputObj.title).toBe(title);
+                done();
+            }, 3000);
+        });
+    });
+});
+
+describe(aresCmd + ' --servicename', function() {
+    beforeEach(function(done) {
+        common.removeOutDir(sampleServicePath);
+        done();
+    });
+    afterEach(function(done) {
+        setTimeout(() => {
+            common.removeOutDir(sampleServicePath);
+            done();
+        }, 5000);
+    });
+
+    it('Set the servicename for webOS service.', function(done) {
+        const id = "com.test.app.service",
+            options = {
+                tmplName: "jsserviceinfo",
+                svcName: id,
+                out:sampleServicePath
+            };
+            
+        let outputTxt = "", text, outputObj;
+        generator.generate(options, function(err, value) {
+            outputTxt += value.msg;
+            setTimeout(() => {
+                expect(outputTxt).toContain("Generating jsserviceinfo");
+                expect(outputTxt).toContain("Success");
+                expect(fs.existsSync(path.join(sampleServicePath, "services.json"))).toBe(true);
+
+                try {
+                    text = fs.readFileSync(path.join(sampleServicePath, "services.json"));
+                    outputObj = JSON.parse(text);
+                } catch (error) {
+                    console.error(error);
+                }    
+                expect(outputObj.id).toBe(id);
+                done();
+            }, 3000);
+        });
+    });
+});

package/spec/jsSpecs/apiTest/inspector.spec.js

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const exec = require('child_process').exec,
+    common = require('../common-spec'),
+    inspector = require('../../../lib/inspect'),
+    async = require('async');
+
+const aresCmd = 'Inspector',
+    inspectOptions = {
+        open: true,
+    };
+
+let options;
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        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', 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");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + '.inspect()', function() {
+    it('Run web inspector for sample app', function(done) {
+        inspectOptions.appId = options.pkgId;
+        async.waterfall([
+            inspector.inspect.bind(inspector, inspectOptions),
+            function(inspectInfo, next) {
+                expect(inspectInfo.msg).toContain('Application Debugging - http://localhost');
+                setTimeout(() => {
+                    inspector.stop(inspectInfo.session, next);
+                }, 5000);
+            }
+        ], function(err, results) {
+            expect(results.msg).toContain('This inspection has stopped');
+            done();
+            delete inspectOptions.appId;
+        });
+    });
+});
+
+describe(aresCmd + '.inspect()', function() {
+    it('Run service inspector for sample service', function(done) {
+        inspectOptions.serviceId = options.pkgService;
+        async.waterfall([
+            inspector.inspect.bind(inspector, inspectOptions),
+            function(inspectInfo, next) {
+                expect(inspectInfo.msg).toContain('To debug your service, set');
+                expect(inspectInfo.msg).toContain("Cannot support \"--open option\" on platform node version 8 and later");
+                setTimeout(() => {
+                    inspector.stop(inspectInfo.session, next);
+                }, 7000);
+            }
+        ], function(err, results) {
+            expect(results.msg).toContain('This inspection has stopped');
+            done();
+        });
+    });
+});

package/spec/jsSpecs/apiTest/installer.spec.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2023-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const common = require('../common-spec'),
+    installer = require('../../../lib/install');
+
+const aresCmd = 'Installer',
+    installOptions = {
+        opkg: false
+    };
+
+let options;
+
+beforeAll(function(done) {
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        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 + '.install()', function() {
+    it('Install sample ipk to device', function(done) {
+        installer.install(installOptions, `${options.ipkPath}`, function(err, value) {
+            expect(value.msg).toContain("Success");
+            done();
+        }, function(data) {
+            expect(data).toContain("Installing package");
+        });
+    });
+});
+
+describe(aresCmd + '.list()', function() {
+    it('List the installed apps on device', function(done) {
+        installer.list(installOptions, function(err, value) {
+            expect(JSON.stringify(value)).toContain(`${options.pkgId}`);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + '.remove()', function() {
+    it('Install sample ipk to device', function(done) {
+        installer.remove(installOptions, `${options.pkgId}`, function(err, value) {
+            expect(value.msg).toContain(`Removed package ${options.pkgId}`);
+            done();
+        });
+    });
+});