@webos-tools/cli 3.0.0

package/spec/jsSpecs/ares-setup-device.spec.js

@@ -0,0 +1,281 @@
+/*
+ * 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-setup-device',
+    device = 'testDevice',
+    initDevicePath = path.join(__dirname,"../../files/conf","novacom-devices.json");
+
+let cmd,
+    options;
+
+beforeAll(function(done) {
+    cmd = common.makeCmd(aresCmd);
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        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();
+        });
+    });
+});
+const killUsedPort = function() {
+    return new Promise(function(resolve) {
+        exec("lsof -i :3333 | grep node | awk '{print $2}'", function(error, stdout) {
+            console.log("used port pid : " + (stdout ? stdout.trim() : "not used"));
+            exec("kill -9 " + stdout, function() {
+                resolve(true);
+            });
+        });
+    });
+};
+
+describe(aresCmd + ' -h -v', function() {
+    it('Print help message with verbose log', function(done) {
+        exec(cmd + ' -h -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 + ' --add(-a)', function() {
+    it('Add DEVICE', function(done) {
+        const host = '192.168.0.5';
+        const port = '1234';
+        const username = 'developer';
+        exec(cmd + ` -a ${device} -i username=${username} -i host=${host} -i port=${port}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(device);
+            expect(stdout).toContain(host);
+            expect(stdout).toContain(port);
+            expect(stdout).toContain(username);
+            expect(stdout).toContain("emulator");
+            expect(stdout).toContain(options.device + " (default)");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --add(-a)', function() {
+    it('Add DEVICE as default property', function(done) {
+        const host = '192.168.0.5';
+        const port = '1234';
+        const username = 'developer';
+        const newDevice = 'test1';
+        exec(cmd + ` -a ${newDevice} -i username=${username} -i host=${host} -i port=${port} -i default=true`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(newDevice);
+            expect(stdout).toContain(host);
+            expect(stdout).toContain(port);
+            expect(stdout).toContain(username);
+            expect(stdout).toContain(newDevice + " (default)");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --list(-l)', function() {
+    it('Should List all device information', function(done) {
+        exec(cmd + ' --list', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(device);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --listfull(-F)', function() {
+    it('Should List all device detail information', function(done) {
+        exec(cmd + ' -F', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(device);
+            expect(stdout).toContain("description");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --modify(-m)', function() {
+    it('Modifiy DEVICE information', function(done) {
+        const username = 'developer';
+        const host = '192.168.0.1';
+        const port = '4321';
+        exec(cmd + ` -m ${device} -i username=${username} -i host=${host} -i port=${port}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(username);
+            expect(stdout).toContain(host);
+            expect(stdout).toContain(port);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --default(-f)', function() {
+    it('Set default device', function(done) {
+        exec(cmd + ` -f ${device}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(device + " (default)");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --remove(-r)', function() {
+    it('Should remove added device information', function(done) {
+        exec(cmd + ` -r ${device}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).not.toContain(device);
+            expect(error).toBeNull();
+            expect(stdout).not.toContain(device);
+            expect(stdout).toContain("emulator (default)");
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --search(-s), --timeout(-t)', function() {
+    // Check only "Searching" print
+
+    beforeEach(function(done) {
+        killUsedPort()
+        .then(function() {
+            done();
+        });
+    });
+
+    it('Search webOS Devices', function(done) {
+        const child = exec(cmd + ' -s -t 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("Searching...");
+            done();
+        }, 2000);
+    });
+});
+
+describe(aresCmd + ' --reset(-R)', function() {
+    it('Add DEVICE', function(done) {
+        const host = '192.168.0.5';
+        const port = '1234';
+        const username = 'developer';
+        exec(cmd + ` -a ${device} -i username=${username} -i host=${host} -i port=${port}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(device);
+            expect(stdout).toContain(host);
+            expect(stdout).toContain(port);
+            expect(stdout).toContain(username);
+            done();
+        });
+    });
+
+    it('Reset Device Info', function(done) {
+        const initObj = JSON.parse(fs.readFileSync(initDevicePath));
+        let initDevice;
+        initObj.forEach(function(item) {
+            if (item.profile === options.profile) {
+                initDevice = item;
+            }
+        });
+
+        exec(cmd + ' -R', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(initDevice.name +" (default)");
+            expect(stdout).toContain(initDevice.username);
+            expect(stdout).toContain(initDevice.host);
+            expect(stdout).toContain(initDevice.port);
+            expect(stdout).toContain(initDevice.profile);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it('Remove invaild device target', function(done) {
+        exec(cmd + ` -r invalidTarget`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares-setup-device ERR! [Tips]: Invalid value <DEVICE_NAME> : invalidTarget");
+            }
+            done();
+        });
+    });
+
+    it('Remove emulator device', function(done) {
+        exec(cmd + ` -r emulator`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares-setup-device ERR! [Tips]: Cannot remove the device <emulator>");
+            }
+            done();
+        });
+    });
+    
+    it('Add invalid DEVICE', function(done) {
+        const deivceName = "invalid#@!";
+        exec(cmd + ` -a ${deivceName}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares-setup-device ERR! [Tips]: Invalid device name. The device name should consist");
+            }
+            done();
+        });
+    });
+});

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

@@ -0,0 +1,220 @@
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/* eslint-disable no-useless-escape */
+const exec = require('child_process').exec,
+    common = require('./common-spec');
+
+const aresCmd = 'ares-shell';
+
+let cmd,
+    options,
+    hasSession = false;
+
+beforeAll(function(done) {
+    cmd = common.makeCmd(aresCmd);
+    common.getOptions()
+    .then(function(result) {
+        options = result;
+        done();
+    });
+});
+
+describe(aresCmd, function() {
+    it("Add device with ares-setup-device", function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        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 + ' -h -v', function() {
+    it('Print help message with verbose log', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd + ' -h -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 + ' --device-list(-D)', function() {
+    it('Show available device list', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd + ' -D', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).toContain(options.device);
+            expect(stdout).toContain(options.profile);
+            done();
+        });
+    });
+});
+
+describe('Check if there are sessions on the device', function() {
+    it('Check session', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        const deviceCmd = common.makeCmd('ares-device');
+        exec(deviceCmd + ` -s ${options.device}`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+
+            if (stdout.includes("sessionId")) {
+                hasSession = true;
+            }
+            done();
+        });
+    });
+});
+describe(aresCmd, function() {
+    it('Open shell on default device', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout).not.toContain("[Info] Set target device : " + options.device);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --display(-dp)', function() {
+    it('Set display', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd + ' -dp 1', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                // case of auto emulator using developer user
+                if (options.device === "emulator" && hasSession) {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: Unable to connect to the target device. root access required <connect user session>", error);
+                } else {
+                    // TO-DO: uncaughtException TypeError: process.stdin.setRawMode is not a function
+                    // expect(stderr).toContain("ares-shell ERR! [Tips]: This device does not support multiple sessions");
+                }
+            } else {
+                expect(stdout).toContain(`Start ${options.device} shell`, error);
+            }
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --run in session', function() {
+    it('Run CMD', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd + ' -dp 1 -r \"echo hello webOS\"', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                // case of auto emulator using developer user
+                if (options.device === "emulator" && hasSession) {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: Unable to connect to the target device. root access required <connect user session>", error);
+                } else {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: This device does not support multiple sessions");
+                }
+            } else {
+                expect(stdout.trim()).toBe("hello webOS", stderr);
+            }
+            done();
+        });
+    });
+});
+
+
+describe(aresCmd + ' --run echo $PATH', function() {
+    it('Check environment variable with --run option', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        let tmpCmd = cmd + ' -r \"echo \\$PATH\"';
+        if (process.platform === "win32") {
+            tmpCmd = cmd + ' -r \"echo $PATH\"';
+        }
+
+        exec(tmpCmd, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(stdout.trim()).toBe("/usr/sbin:/usr/bin:/sbin:/bin", stderr);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --run echo $PATH in session', function() {
+    it('Check environment variable with --run option', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        let tmpCmd = cmd + ' -dp 1 -r \"echo \\$PATH\"';
+        if (process.platform === "win32") {
+            tmpCmd = cmd + ' -dp 1 -r \"echo $PATH\"';
+        }
+
+        exec(tmpCmd, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                // case of auto emulator using developer user
+                if (options.device === "emulator" && hasSession) {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: Unable to connect to the target device. root access required <connect user session>", error);
+                } else {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: This device does not support multiple sessions");
+                }
+            } else {
+                expect(stdout.trim()).toBe("/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", stderr);
+            }
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it('Set invalid display', function(done) {
+        if (options.profile === "tv") {
+            pending(options.skipTxt);
+        }
+        exec(cmd + ` -dp 9`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                if (hasSession) {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: Invalid value <DISPLAY_ID> : 9");
+                } else {
+                    expect(stderr).toContain("ares-shell ERR! [Tips]: This device does not support multiple sessions");
+                }
+            }
+            done();
+        });
+    });
+});

package/spec/jsSpecs/ares.spec.js

@@ -0,0 +1,83 @@
+/*
+ * 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';
+
+let cmd,
+    expectedList;
+
+beforeAll(function(done) {
+    cmd = common.makeCmd(aresCmd);
+    common.getOptions()
+    .then(function() {
+        return common.getExpectedResult(aresCmd);
+    }).then(function(result) {
+        expectedList = result.list;
+        done();
+    });
+});
+
+
+// ares command test
+describe(aresCmd + ' --list(-l)', function() {
+    it('Should show all the ares commands', function(done) {
+        exec(cmd + ' --list', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            // get expected list
+            expectedList = expectedList.join('\n'); // multi string in array. need to join
+            stdout = stdout.trim().replace(/\s+['\n']/g, '\n');
+            expect(stdout).toBe(expectedList);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --version(-v)', function() {
+    it('Check version info with package.json', function(done) {
+        exec(cmd + ' --version', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            // get CLI version
+            const text = fs.readFileSync(path.join(__dirname, "../../", "package.json"), 'utf8');
+            const pkgInfoObj = JSON.parse(text);
+            const cliVersion = "Version: " + pkgInfoObj.version;
+            expect(stdout.trim()).toBe(cliVersion);
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' --<COMMAND>', function() {
+    it('Display the help information of the generate', function(done) {
+        exec(cmd + ' -generate', function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+            }
+            expect(error).toBeNull();
+            done();
+        });
+    });
+});
+
+describe(aresCmd + ' negative TC', function() {
+    it('Set invalid command', function(done) {
+        exec(cmd + ` --build`, function(error, stdout, stderr) {
+            if (stderr && stderr.length > 0) {
+                common.detectNodeMessage(stderr);
+                expect(stderr).toContain("ares ERR! [Tips]: This command is invalid. Please check the supported commands using ares -l");
+            }
+            done();
+        });
+    });
+});