@iobroker/js-controller-cli 4.0.0-alpha.8-20210909-001a711c → 4.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 bluefox<dogafox@gmail.com>,
+Copyright (c) 2014-2022 bluefox<dogafox@gmail.com>,
 Copyright (c) 2014      hobbyquaker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

package/README.md

@@ -3,4 +3,4 @@ The Library contains the cli classes of ioBroker.
 
 ## License
 MIT
-Copyright 2018-2021 bluefox <dogafox@gmail.com>  
+Copyright 2018-2022 bluefox <dogafox@gmail.com>  

package/index.js

@@ -1,18 +1,19 @@
 module.exports = {
-    success:     require('./lib/cli/messages').success,
-    warn:        require('./lib/cli/messages').warn,
-    error:       require('./lib/cli/messages').error,
-    tools:       require('./lib/cli/cliTools'),
+    success: require('./lib/cli/messages').success,
+    warn: require('./lib/cli/messages').warn,
+    error: require('./lib/cli/messages').error,
+    tools: require('./lib/cli/cliTools'),
     command: {
-        object:  require('./lib/cli/cliObjects.js'),
-        state:   require('./lib/cli/cliStates.js'),
+        object: require('./lib/cli/cliObjects.js'),
+        state: require('./lib/cli/cliStates.js'),
         process: require('./lib/cli/cliProcess.js'),
         message: require('./lib/cli/cliMessage.js'),
-        logs:    require('./lib/cli/cliLogs.js'),
-        host:    require('./lib/cli/cliHost.js'),
-        cert:    require('./lib/cli/cliCert.js'),
+        logs: require('./lib/cli/cliLogs.js'),
+        host: require('./lib/cli/cliHost.js'),
+        cert: require('./lib/cli/cliCert.js'),
         compact: require('./lib/cli/cliCompact.js'),
-        debug:    require('./lib/cli/cliDebug.js'),
+        debug: require('./lib/cli/cliDebug.js'),
         plugin: require('./lib/cli/cliPlugin.js')
-    }
+    },
+    setupList: require('./lib/setup/setupList')
 };

package/lib/cli/cliCert.js

@@ -6,7 +6,6 @@ const { tools } = require('@iobroker/js-controller-common');
 
 /** Command ioBroker cert ... */
 module.exports = class CLICert extends CLICommand {
-
     /** @param {import('./cliCommand.js').CLICommandOptions} options */
     constructor(options) {
         super(options);
@@ -37,18 +36,25 @@ module.exports = class CLICert extends CLICommand {
      * create new private certificate
      * @param {any[]} [_args]
      */
-    create(_args) {
+    async create(_args) {
         const id = 'system.certificates';
         const certPropPath = 'native.certificates';
 
         const certificates = tools.generateDefaultCertificates();
         if (certificates) {
             console.log(JSON.stringify(certificates, null, 2));
-            // use the command `iobroker object set ...` to update the certificate
-            const objectsCommandArgs = ['set', id, certPropPath + '=' + JSON.stringify(certificates)];
-            const objectsCommand = new CLIObjects(this.options);
-            objectsCommand.execute(objectsCommandArgs);
+            for (const cert of Object.keys(certificates)) {
+                await new Promise(resolve => {
+                    // use the command `iobroker object set ...` to update the certificate
+                    console.log(`Update certificate ${cert}`);
+                    const objectsCommandArgs = ['set', id, `${certPropPath}.${cert}=${certificates[cert]}`];
+                    const objectsCommand = new CLIObjects({ ...this.options, callback: resolve });
+                    objectsCommand.execute(objectsCommandArgs);
+                });
+            }
         }
+
+        this.options.callback();
     }
 
     // view-command
@@ -77,4 +83,4 @@ module.exports = class CLICert extends CLICommand {
             });
         });
     }
-};
+};

package/lib/cli/cliCompact.js

@@ -6,13 +6,11 @@ const fs = require('fs-extra');
 
 /** Command ioBroker compact ... */
 module.exports = class CLICompact extends CLICommand {
-
     /** @param {import('./cliCommand.js').CLICommandOptions} options */
     constructor(options) {
         super(options);
         this.config = fs.readJSONSync(tools.getConfigFileName());
     }
-
     /**
      * Executes a command
      * @param {any[]} args
@@ -111,13 +109,18 @@ module.exports = class CLICompact extends CLICommand {
             objects.getObject('system.adapter.' + instance, (err, obj) => {
                 if (!err && obj) {
                     if (!obj.common.compact) {
-                        console.log('This adapter does not support compact mode. The below settings will have no effect!');
+                        console.log(
+                            'This adapter does not support compact mode. The below settings will have no effect!'
+                        );
                         console.log();
                     } else {
                         console.log('Adapter supports compact mode:     ' + !!obj.common.compact);
                     }
                     console.log('Compact mode enabled for instance: ' + !!obj.common.runAsCompactMode);
-                    console.log('Compact group:                     ' + (obj.common.compactGroup !== undefined ? obj.common.compactGroup : 1));
+                    console.log(
+                        'Compact group:                     ' +
+                            (obj.common.compactGroup !== undefined ? obj.common.compactGroup : 1)
+                    );
                     return void callback();
                 } else {
                     CLI.error.invalidInstance(instance);
@@ -138,7 +141,9 @@ module.exports = class CLICompact extends CLICommand {
             objects.getObject('system.adapter.' + instance, (err, obj) => {
                 if (!err && obj) {
                     if (!obj.common.compact) {
-                        console.log('This adapter does not support compact mode. The below settings will have no effect!');
+                        console.log(
+                            'This adapter does not support compact mode. The below settings will have no effect!'
+                        );
                         console.log();
                     } else {
                         console.log('Adapter supports compact mode :    ' + !!obj.common.compact);
@@ -158,8 +163,18 @@ module.exports = class CLICompact extends CLICommand {
                             newCompactGroup = groupId;
                         }
                     }
-                    console.log('Compact mode enabled for instance: ' + (newRunAsCompactMode !== undefined ? '--> ' + newRunAsCompactMode : !!obj.common.runAsCompactMode));
-                    console.log('Compact group:                     ' + (newCompactGroup !== undefined && obj.common.compactGroup !== newCompactGroup ? '--> ' + newCompactGroup : obj.common.compactGroup));
+                    console.log(
+                        'Compact mode enabled for instance: ' +
+                            (newRunAsCompactMode !== undefined
+                                ? '--> ' + newRunAsCompactMode
+                                : !!obj.common.runAsCompactMode)
+                    );
+                    console.log(
+                        'Compact group:                     ' +
+                            (newCompactGroup !== undefined && obj.common.compactGroup !== newCompactGroup
+                                ? '--> ' + newCompactGroup
+                                : obj.common.compactGroup)
+                    );
                     if (newRunAsCompactMode !== undefined || newCompactGroup !== undefined) {
                         if (newCompactGroup !== undefined) {
                             obj.common.compactGroup = newCompactGroup;
@@ -188,5 +203,4 @@ module.exports = class CLICompact extends CLICommand {
             });
         });
     }
-
 };

package/lib/cli/cliDebug.js

@@ -2,7 +2,7 @@
 const CLI = require('./messages.js');
 const CLICommand = require('./cliCommand.js');
 const CLITools = require('./cliTools');
-const { tools } = require('@iobroker/js-controller-common');
+const { tools, EXIT_CODES } = require('@iobroker/js-controller-common');
 const child_process = require('child_process');
 
 /** Command ioBroker debug ... */
@@ -12,6 +12,32 @@ module.exports = class CLICompact extends CLICommand {
         super(options);
     }
 
+    /**
+     * Cehcks if the adpter instance is running
+     *
+     * @param {string} adapter
+     * @param {string} instance
+     * @return {Promise<boolean>}
+     * @private
+     */
+    _isInstanceRunning(adapter, instance) {
+        const { dbConnect } = this.options;
+        return new Promise(resolve => {
+            dbConnect(async (objects, states) => {
+                try {
+                    const state = await states.getStateAsync(`system.adapter.${adapter}.${instance}.alive`);
+                    if (state && state.val) {
+                        resolve(true);
+                        return;
+                    }
+                } catch {
+                    // ignore
+                }
+                resolve(false);
+            });
+        });
+    }
+
     /**
      * Executes a command
      * @param {any[]} args
@@ -20,14 +46,16 @@ module.exports = class CLICompact extends CLICommand {
         const { callback, ...params } = this.options;
         const adapter = args[0];
         if (!adapter) {
-            CLI.error.requiredArgumentMissing(
-                'adaptername',
-                'debug <adaptername>'
-            );
+            CLI.error.requiredArgumentMissing('adaptername', 'debug <adaptername>');
             return void callback(34);
         }
 
-        const { instance } = CLITools.splitAdapterOrInstanceIdentifierWithVersion(adapter);
+        const { name, instance } = CLITools.splitAdapterOrInstanceIdentifierWithVersion(adapter);
+
+        if (await this._isInstanceRunning(name, instance || '0')) {
+            CLI.error.instanceAlreadyRunning(`${name}.${instance || '0'}`);
+            return void callback(EXIT_CODES.ADAPTER_ALREADY_RUNNING);
+        }
 
         const adapterDir = tools.getAdapterDir(adapter);
         if (!adapterDir) {
@@ -49,9 +77,7 @@ module.exports = class CLICompact extends CLICommand {
         const nodeArgs = [
             ...tools.getDefaultNodeArgs(mainFile),
             // --inspect[-brk][=[ip]:[port]]
-            `--inspect${params.wait ? '-brk' : ''}${
-                !!params.ip || !!params.port ? '=' : ''
-            }${params.ip || ''}${
+            `--inspect${params.wait ? '-brk' : ''}${!!params.ip || !!params.port ? '=' : ''}${params.ip || ''}${
                 !!params.ip && !!params.port ? ':' : ''
             }${params.port || ''}`
         ];

package/lib/cli/cliHost.js

@@ -1,14 +1,13 @@
 'use strict';
 const CLI = require('./messages.js');
 const CLICommand = require('./cliCommand.js');
-const {enumHosts, enumObjects, getObjectFrom, enumInstances} = require('./cliTools');
+const { enumHosts, enumObjects, getObjectFrom, enumInstances } = require('./cliTools');
 const { tools } = require('@iobroker/js-controller-common');
 const os = require('os');
 const fs = require('fs-extra');
 
 /** Command iobroker host ... */
 module.exports = class CLIHost extends CLICommand {
-
     /** @param {import('./cliCommand').CLICommandOptions} options */
     constructor(options) {
         super(options);
@@ -126,7 +125,6 @@ module.exports = class CLIHost extends CLICommand {
                 // Notify the user that we are done
                 CLI.success.hostDeleted(hostname);
                 return void callback();
-
             } catch (err) {
                 CLI.error.unknown(err.message);
                 return void callback(1);
@@ -261,8 +259,8 @@ module.exports = class CLIHost extends CLICommand {
 
                 // Also rename all instances
                 const instances = await enumInstances(objects);
-                const instancesToRename = oldHostname === undefined ? instances
-                    : instances.filter(i => i.common.host === oldHostname);
+                const instancesToRename =
+                    oldHostname === undefined ? instances : instances.filter(i => i.common.host === oldHostname);
                 if (instancesToRename.length > 0) {
                     for (const instance of instancesToRename) {
                         // Update each instance object
@@ -272,14 +270,12 @@ module.exports = class CLIHost extends CLICommand {
                     CLI.warn.noInstancesFoundOnHost(oldHostname);
                 }
                 return void callback();
-
             } catch (err) {
                 CLI.error.unknown(err.message);
                 return void callback(1);
             }
         });
     }
-
 };
 
 /**
@@ -287,23 +283,19 @@ module.exports = class CLIHost extends CLICommand {
  * @param {any} objects The objects DB to use
  * @param {any} instance The instance object
  * @param {string} newHostname The new hostname the instance should be running on
+ * @return Promise<void>
  */
-function changeInstanceHost(objects, instance, newHostname) {
-    return new Promise(resolve => {
-        const oldInstanceHost = instance.common.host;
-        instance.from = getObjectFrom();
-        instance.ts = Date.now();
-        instance.common.host = newHostname;
-        // and save it
-        objects.setObjectAsync(instance._id, instance)
-            .then(() => {
-                CLI.success.instanceHostChanged(instance._id, oldInstanceHost, newHostname);
-                resolve();
-            })
-            .catch(err => {
-                CLI.error.cannotChangeObject(instance._id, err.message);
-                // resolve anyways, we don't want to cause errors
-                resolve();
-            });
-    });
+async function changeInstanceHost(objects, instance, newHostname) {
+    const oldInstanceHost = instance.common.host;
+    instance.from = getObjectFrom();
+    instance.ts = Date.now();
+    instance.common.host = newHostname;
+    // and save it
+    try {
+        await objects.setObjectAsync(instance._id, instance);
+        CLI.success.instanceHostChanged(instance._id, oldInstanceHost, newHostname);
+    } catch (e) {
+        CLI.error.cannotChangeObject(instance._id, e.message);
+        // resolve anyways, we don't want to cause errors
+    }
 }

package/lib/cli/cliLogs.js

@@ -10,7 +10,6 @@ const { tools } = require('@iobroker/js-controller-common');
 
 /** Command ioBroker state ... */
 module.exports = class CLILogs extends CLICommand {
-
     /** @param {import('./cliCommand').CLICommandOptions} options */
     constructor(options) {
         super(options);
@@ -24,7 +23,6 @@ module.exports = class CLILogs extends CLICommand {
      * @param {any[]} args
      */
     execute(args, params) {
-
         /** @type {string | undefined} */
         const adapterName = args[0];
         const watch = params.watch || params.w;
@@ -36,7 +34,7 @@ module.exports = class CLILogs extends CLICommand {
         };
 
         const config = fs.readJSONSync(require.resolve(getConfigFileName()));
-        const logger = require('../logger')(config.log);
+        const logger = require('@iobroker/js-controller-common').logger(config.log);
         let fileName = logger.getFileName();
         if (fileName) {
             let lines = fs.readFileSync(fileName).toString('utf-8').split('\n');
@@ -60,10 +58,10 @@ module.exports = class CLILogs extends CLICommand {
                 fileName = fileName.replace(/\\/g, '/');
                 const parts = fileName.split('/');
                 parts.pop();
-                chokidar.watch(`${parts.join('/')}/iobroker*`, {awaitWriteFinish: {stabilityThreshold: 500}})
+                chokidar
+                    .watch(`${parts.join('/')}/iobroker*`, { awaitWriteFinish: { stabilityThreshold: 500 } })
                     .on('all', this.watchHandler.bind(this, options))
-                    .on('ready', () => this.isReady = true)
-                ;
+                    .on('ready', () => (this.isReady = true));
             }
         } else {
             console.log('No log file found');
@@ -86,12 +84,7 @@ module.exports = class CLILogs extends CLICommand {
     watchHandler(options, event, path, stats) {
         if (event === 'add' || !this.fileSizes.has(path)) {
             this.fileSizes.set(path, stats.size);
-            if (
-                stats.size > 0 && (
-                    this.isReady
-                    || (options.complete && this.isTodaysLogfile(path))
-                )
-            ) {
+            if (stats.size > 0 && (this.isReady || (options.complete && this.isTodaysLogfile(path)))) {
                 this.streamChange(path, 0, options);
             }
         } else if (event === 'change') {
@@ -111,7 +104,7 @@ module.exports = class CLILogs extends CLICommand {
      */
     isTodaysLogfile(path) {
         const YYYYMMDDDate = new Date().toJSON().slice(0, 10);
-        return path.indexOf(YYYYMMDDDate) > -1;
+        return path.includes(YYYYMMDDDate);
     }
 
     /**
@@ -123,7 +116,7 @@ module.exports = class CLILogs extends CLICommand {
     streamChange(path, start, options) {
         const input = fs.createReadStream(path, {
             encoding: 'utf8',
-            start: start,
+            start,
             autoClose: true
         });
         if (options.adapterName) {
@@ -131,14 +124,12 @@ module.exports = class CLILogs extends CLICommand {
             input
                 .pipe(es.split())
                 // @ts-ignore
-                .pipe(es.filterSync(line => line.indexOf(options.adapterName) > -1))
+                .pipe(es.filterSync(line => line.includes(options.adapterName)))
                 .pipe(es.mapSync(line => line + os.EOL))
-                .pipe(process.stdout)
-            ;
+                .pipe(process.stdout);
         } else {
             // just pipe the input through
             tools.pipeLinewise(input, process.stdout);
         }
     }
 };
-

package/lib/cli/cliMessage.js

@@ -6,7 +6,6 @@ const { enumInstances } = require('./cliTools');
 
 /** Command iobroker object ... */
 module.exports = class CLIMessage extends CLICommand {
-
     /** @param {import('./cliCommand').CLICommandOptions} options */
     constructor(options) {
         super(options);
@@ -19,8 +18,7 @@ module.exports = class CLIMessage extends CLICommand {
     execute(args) {
         const { callback, dbConnect, showHelp } = this.options;
         /** @type {[string, string, any?]} */
-        // eslint-disable-next-line prefer-const
-        let [adapter, command, message] = (args);
+        let [adapter, command, message] = args;
         if (adapter === null || adapter === undefined) {
             CLI.error.requiredArgumentMissing('adapter');
             showHelp();
@@ -37,11 +35,7 @@ module.exports = class CLIMessage extends CLICommand {
         }
         // Try to parse JSON
         // TODO: can we use the methods from cliObjects?
-        if (
-            typeof message === 'string'
-            && message.startsWith('{')
-            && message.endsWith('}')
-        ) {
+        if (typeof message === 'string' && message.startsWith('{') && message.endsWith('}')) {
             message = JSON.parse(message);
         }
 
@@ -68,12 +62,9 @@ module.exports = class CLIMessage extends CLICommand {
                 }
 
                 // Send the message to all targets
-                const messagePromises = messageTargets.map(
-                    t => sendMessage(states, t, command, message)
-                );
+                const messagePromises = messageTargets.map(t => sendMessage(states, t, command, message));
                 await Promise.all(messagePromises);
                 return void callback();
-
             } catch (err) {
                 CLI.error.unknown(err.message);
                 return void callback(1);