1715

pending completion

Build # 1715

Build Type

Pull #510

travis-ci-com

Committed by

web-flow

Commit Message

Merge 4878d51bb into 16ce450d7

Pull Request Pull Request #510: DeviceDatabase: implement automatic device updates

Run Details

10903 of 23366 branches covered (46.66%)

Branch coverage included in aggregate %.

7 of 19 new or added lines in 2 files covered. (36.84%)

24 existing lines in 4 files now uncovered.

25466 of 44019 relevant lines covered (57.85%)

567086.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

6.86

/tool/assistant.js

// -*- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 -*-
//
// This file is part of Genie
//
// Copyright 2020 The Board of Trustees of the Leland Stanford Junior University
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: Giovanni Campagna <gcampagn@cs.stanford.edu>


import * as readline from 'readline';

import Engine from '../lib/engine';
import Platform from './lib/cmdline-platform';

const THINGPEDIA_URL = 'https://dev.almond.stanford.edu/thingpedia';
const NL_SERVER_URL = 'https://nlp-staging.almond.stanford.edu';

class LocalUser {
    constructor() {
        this.id = process.getuid();
        this.account = 'local:'+this.id;
        this.name = 'Local User';
    }
}

class CommandLineDelegate {
    constructor(rl) {
        this._rl = rl;
    }

    setHypothesis(hypothesis) {
        // go to beginning of line
        this._rl.write('', { ctrl: true, name: 'a' });
        // erase line
        this._rl.write('', { ctrl: true, name: 'k' });
        // write the new hypothesis
        this._rl.write(hypothesis);
    }
    setExpected(expect) {
        console.log('>> expecting: ' + expect);
    }

    addMessage(msg) {
        switch (msg.type) {
        case 'text':
        case 'result':
            console.log('>> ' + msg.text);
            break;

        case 'picture':
            console.log('>> picture: ' + msg.url);
            break;

        case 'rdl':
            console.log('>> rdl: ' + msg.rdl.displayTitle + ' ' + (msg.rdl.callback || msg.rdl.webCallback));
            break;

        case 'choice':
            console.log('>> choice ' + msg.idx + ': ' + msg.title);
            break;

        case 'link':
            console.log('>> link: ' + msg.title + ' ' + msg.url);
            break;

        case 'button':
            console.log('>> button: ' + msg.title + ' ' + JSON.stringify(msg.json));
            break;
        }
    }
}

class CommandLineHandler {
    constructor(engine, conversation, rl) {
        this._engine = engine;
        this._conversation = conversation;

        this._rl = rl;
        this._rl.on('line', (line) => this._onLine(line));
        this._rl.on('SIGINT', () => this._quit());

        this._oauthKind = null;
        this._oauthSession = {};
    }

    _quit() {
        console.log('Bye\n');
        this._engine.stop();
    }

    _help() {
        console.log('Available commands:');
        console.log('\\q : quit');
        console.log('\\r <json-or-nn-tt> : send parsed command to Genie');
        console.log('\\y : answer yes');
        console.log('\\n : answer no');
        console.log('\\c <number> : make a choice');
        console.log('\\t <code> : send ThingTalk to Genie');
        console.log('\\a list : list apps');
        console.log('\\a stop [<uuid> | all] : stop app');
        console.log('\\d list : list devices');
        console.log('\\d start-oauth <kind> : start oauth');
        console.log('\\d complete-oauth <url> : finish oauth');
        console.log('\\d update <kind> : update devices');
        console.log('\\= <pref> : show a preference value');
        console.log('\\= <pref> <value> : set a preference value');
        console.log('\\? or \\h : show this help');
        console.log('Any other command is interpreted as an English sentence and sent to Genie');
    }

    _runAppCommand(cmd, param) {
        if (cmd === 'list') {
            this._engine.apps.getAllApps().forEach((app) => {
                console.log('- ' + app.uniqueId + ' ' + app.name + ': ' + app.description);
            });
        } else if (cmd === 'stop') {
            if (param === 'all') {
                for (let app of this._engine.apps.getAllApps())
                    this._engine.apps.removeApp(app);
            } else {
                let app = this._engine.apps.getApp(param);
                if (!app)
                    console.log('No app with ID ' + param);
                else
                    this._engine.apps.removeApp(app);
            }
        }
    }

    _runPrefCommand(param, value) {
        const prefs = this._engine.platform.getSharedPreferences();
        if (value)
            console.log(prefs.set(param, JSON.parse(value)) ? "ok" : "failed to set");
        else
            console.log(prefs.get(param));
    }

    _runDeviceCommand(cmd, param) {
        if (cmd === 'list') {
            this._engine.devices.getAllDevices().forEach((dev) => {
                console.log('- ' + dev.uniqueId + ' (' + dev.kind +') ' + dev.name + ': ' + dev.description);
            });
        } else if (cmd === 'start-oauth' || cmd === 'start-oauth2') {
            this._oauthKind = param;
            return this._engine.devices.addFromOAuth(param).then(([redirect, session]) => {
                this._oauthSession = session;
                console.log(redirect);
            });
        } else if (cmd === 'complete-oauth' || cmd === 'complete-oauth2') {
            return this._engine.devices.completeOAuth(this._oauthKind, param, this._oauthSession);
        } else if (cmd === 'update' || cmd === 'upgrade') {
            return this._engine.devices.updateDevicesOfKind(param);
        }

        return Promise.resolve();
    }

    _handleSlashR(line) {
        line = line.trim();
        if (line.startsWith('{'))
            return this._conversation.handleParsedCommand(JSON.parse(line));
        else
            return this._conversation.handleParsedCommand({ code: line.split(' '), entities: {} });
    }

    _onLine(line) {
        Promise.resolve().then(() => {
            if (line[0] === '\\') {
                if (line[1] === 'q')
                    return this._quit();
                else if (line[1] === '?' || line === 'h')
                    return this._help();
                else if (line[1] === 'r')
                    return this._handleSlashR(line.substr(3));
                else if (line[1] === 't')
                    return this._conversation.handleThingTalk(line.substr(3));
                else if (line[1] === 'c')
                    return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'choice', line.substr(3)], entities: {} });
                else if (line[1] === 'y')
                    return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'special', 'special:yes'], entities: {} });
                else if (line[1] === 'n')
                    return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'special', 'special:no'], entities: {} });
                else if (line[1] === 'a')
                    return this._runAppCommand(...line.substr(3).split(' '));
                else if (line[1] === 'd')
                    return this._runDeviceCommand(...line.substr(3).split(' '));
                else if (line[1] === '=')
                    return this._runPrefCommand(...line.substr(3).split(' '));
                else
                    console.log('Unknown command ' + line[1]);
            } else if (line.trim()) {
                return this._conversation.handleCommand(line);
            }

            // quiet warning
            return Promise.resolve();
        }).then(() => {
            this._rl.prompt();
        });
    }
}

export function initArgparse(subparsers) {
    const parser = subparsers.add_parser('assistant', {
        add_help: true,
        description: "Test/demo the assistant interactively."
    });
    parser.add_argument('--workdir', {
        required: false,
        help: 'Directory where to store the assistant database and other files (defaults to the ~/.config/genie-toolkit).'
    });
    parser.add_argument('-l', '--locale', {
        required: false,
        default: 'en-US',
        help: `BGP 47 locale tag of the language to use for the assistant (defaults to 'en-US', English)`
    });
    parser.add_argument('--thingpedia-url', {
        required: false,
        default: THINGPEDIA_URL,
        help: 'URL of Thingpedia to use.'
    });
    parser.add_argument('--thingpedia-dir', {
        required: false,
        nargs: '+',
        help: 'Path to a directory containing Thingpedia device definitions (overrides --thingpedia-url).'
    });
    parser.add_argument('--nlu-server', {
        required: false,
        default: NL_SERVER_URL,
        help: 'NLP server URL to use for NLU (can be a file:/// URL).'
    });
    parser.add_argument('--nlg-server', {
        required: false,
        help: 'NLP server URL to use for NLG; must be specified to use neural NLG.'
    });
}

export async function execute(args) {
    const platform = new Platform(args.workdir, args.locale, args.thingpedia_url);
    const prefs = platform.getSharedPreferences();
    if (args.thingpedia_dir && args.thingpedia_dir.length)
        prefs.set('developer-dir', args.thingpedia_dir);
    prefs.set('experimental-use-neural-nlg', !!args.nlg_server);
    const engine = new Engine(platform);

    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
    rl.setPrompt('$ ');

    await engine.open();
    const conversation = await engine.assistant.openConversation('main', new LocalUser(), {
        nluServerUrl: args.nlu_server,
        nlgServerUrl: args.nlg_server,
        debug: false,
        showWelcome: true
    });
    await conversation.addOutput(new CommandLineDelegate(rl));

    new CommandLineHandler(engine, conversation, rl);
    await conversation.start();
    rl.prompt();

    await engine.run();

    rl.close();
    await engine.close();
}

1	// -- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 --
2	//
3	// This file is part of Genie
4	//
5	// Copyright 2020 The Board of Trustees of the Leland Stanford Junior University
6	//
7	// Licensed under the Apache License, Version 2.0 (the "License");
8	// you may not use this file except in compliance with the License.
9	// You may obtain a copy of the License at
10	//
11	// http://www.apache.org/licenses/LICENSE-2.0
12	//
13	// Unless required by applicable law or agreed to in writing, software
14	// distributed under the License is distributed on an "AS IS" BASIS,
15	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16	// See the License for the specific language governing permissions and
17	// limitations under the License.
18	//
19	// Author: Giovanni Campagna <gcampagn@cs.stanford.edu>
20
21
22	import * as readline from 'readline';	58✔
23
24	import Engine from '../lib/engine';	58✔
25	import Platform from './lib/cmdline-platform';	58✔
26
27	const THINGPEDIA_URL = 'https://dev.almond.stanford.edu/thingpedia';	58✔
28	const NL_SERVER_URL = 'https://nlp-staging.almond.stanford.edu';	58✔
29
30	class LocalUser {
31	constructor() {
32	this.id = process.getuid();	×
33	this.account = 'local:'+this.id;	×
34	this.name = 'Local User';	×
35	}
36	}
37
38	class CommandLineDelegate {
39	constructor(rl) {
40	this._rl = rl;	×
41	}
42
43	setHypothesis(hypothesis) {
44	// go to beginning of line
45	this._rl.write('', { ctrl: true, name: 'a' });	×
46	// erase line
47	this._rl.write('', { ctrl: true, name: 'k' });	×
48	// write the new hypothesis
49	this._rl.write(hypothesis);	×
50	}
51	setExpected(expect) {
52	console.log('>> expecting: ' + expect);	×
53	}
54
55	addMessage(msg) {
56	switch (msg.type) {	×
57	case 'text':	×
58	case 'result':
59	console.log('>> ' + msg.text);	×
60	break;	×
61
62	case 'picture':
63	console.log('>> picture: ' + msg.url);	×
64	break;	×
65
66	case 'rdl':
67	console.log('>> rdl: ' + msg.rdl.displayTitle + ' ' + (msg.rdl.callback \|\| msg.rdl.webCallback));	×
68	break;	×
69
70	case 'choice':
71	console.log('>> choice ' + msg.idx + ': ' + msg.title);	×
72	break;	×
73
74	case 'link':
75	console.log('>> link: ' + msg.title + ' ' + msg.url);	×
76	break;	×
77
78	case 'button':
79	console.log('>> button: ' + msg.title + ' ' + JSON.stringify(msg.json));	×
80	break;	×
81	}
82	}
83	}
84
85	class CommandLineHandler {
86	constructor(engine, conversation, rl) {
87	this._engine = engine;	×
88	this._conversation = conversation;	×
89
90	this._rl = rl;	×
91	this._rl.on('line', (line) => this._onLine(line));	×
92	this._rl.on('SIGINT', () => this._quit());	×
93
94	this._oauthKind = null;	×
95	this._oauthSession = {};	×
96	}
97
98	_quit() {
99	console.log('Bye\n');	×
100	this._engine.stop();	×
101	}
102
103	_help() {
104	console.log('Available commands:');	×
105	console.log('\\q : quit');	×
106	console.log('\\r <json-or-nn-tt> : send parsed command to Genie');	×
107	console.log('\\y : answer yes');	×
108	console.log('\\n : answer no');	×
109	console.log('\\c <number> : make a choice');	×
110	console.log('\\t <code> : send ThingTalk to Genie');	×
111	console.log('\\a list : list apps');	×
112	console.log('\\a stop [<uuid> \| all] : stop app');	×
113	console.log('\\d list : list devices');	×
114	console.log('\\d start-oauth <kind> : start oauth');	×
115	console.log('\\d complete-oauth <url> : finish oauth');	×
116	console.log('\\d update <kind> : update devices');	×
117	console.log('\\= <pref> : show a preference value');	×
118	console.log('\\= <pref> <value> : set a preference value');	×
119	console.log('\\? or \\h : show this help');	×
120	console.log('Any other command is interpreted as an English sentence and sent to Genie');	×
121	}
122
123	_runAppCommand(cmd, param) {
124	if (cmd === 'list') {	×
125	this._engine.apps.getAllApps().forEach((app) => {	×
126	console.log('- ' + app.uniqueId + ' ' + app.name + ': ' + app.description);	×
127	});
128	} else if (cmd === 'stop') {	×
129	if (param === 'all') {	×
130	for (let app of this._engine.apps.getAllApps())	×
131	this._engine.apps.removeApp(app);	×
132	} else {
133	let app = this._engine.apps.getApp(param);	×
134	if (!app)	×
135	console.log('No app with ID ' + param);	×
136	else
137	this._engine.apps.removeApp(app);	×
138	}
139	}
140	}
141
142	_runPrefCommand(param, value) {
143	const prefs = this._engine.platform.getSharedPreferences();	×
144	if (value)	×
145	console.log(prefs.set(param, JSON.parse(value)) ? "ok" : "failed to set");	×
146	else
147	console.log(prefs.get(param));	×
148	}
149
150	_runDeviceCommand(cmd, param) {
151	if (cmd === 'list') {	×
152	this._engine.devices.getAllDevices().forEach((dev) => {	×
153	console.log('- ' + dev.uniqueId + ' (' + dev.kind +') ' + dev.name + ': ' + dev.description);	×
154	});
155	} else if (cmd === 'start-oauth' \|\| cmd === 'start-oauth2') {	×
156	this._oauthKind = param;	×
157	return this._engine.devices.addFromOAuth(param).then(([redirect, session]) => {	×
158	this._oauthSession = session;	×
159	console.log(redirect);	×
160	});
161	} else if (cmd === 'complete-oauth' \|\| cmd === 'complete-oauth2') {	×
162	return this._engine.devices.completeOAuth(this._oauthKind, param, this._oauthSession);	×
163	} else if (cmd === 'update' \|\| cmd === 'upgrade') {	×
164	return this._engine.devices.updateDevicesOfKind(param);	×
165	}
166
167	return Promise.resolve();	×
168	}
169
170	_handleSlashR(line) {
171	line = line.trim();	×
172	if (line.startsWith('{'))	×
173	return this._conversation.handleParsedCommand(JSON.parse(line));	×
174	else
175	return this._conversation.handleParsedCommand({ code: line.split(' '), entities: {} });	×
176	}
177
178	_onLine(line) {
179	Promise.resolve().then(() => {	×
180	if (line[0] === '\\') {	×
181	if (line[1] === 'q')	×
182	return this._quit();	×
183	else if (line[1] === '?' \|\| line === 'h')	×
184	return this._help();	×
185	else if (line[1] === 'r')	×
186	return this._handleSlashR(line.substr(3));	×
187	else if (line[1] === 't')	×
188	return this._conversation.handleThingTalk(line.substr(3));	×
189	else if (line[1] === 'c')	×
190	return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'choice', line.substr(3)], entities: {} });	×
191	else if (line[1] === 'y')	×
192	return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'special', 'special:yes'], entities: {} });	×
193	else if (line[1] === 'n')	×
194	return this._conversation.handleParsedCommand({ code: ['bookkeeping', 'special', 'special:no'], entities: {} });	×
195	else if (line[1] === 'a')	×
196	return this._runAppCommand(...line.substr(3).split(' '));	×
197	else if (line[1] === 'd')	×
198	return this._runDeviceCommand(...line.substr(3).split(' '));	×
199	else if (line[1] === '=')	×
200	return this._runPrefCommand(...line.substr(3).split(' '));	×
201	else
202	console.log('Unknown command ' + line[1]);	×
203	} else if (line.trim()) {	×
204	return this._conversation.handleCommand(line);	×
205	}
206
207	// quiet warning
208	return Promise.resolve();	×
209	}).then(() => {
210	this._rl.prompt();	×
211	});
212	}
213	}
214
215	export function initArgparse(subparsers) {	58✔
216	const parser = subparsers.add_parser('assistant', {	58✔
217	add_help: true,
218	description: "Test/demo the assistant interactively."
219	});
220	parser.add_argument('--workdir', {	58✔
221	required: false,
222	help: 'Directory where to store the assistant database and other files (defaults to the ~/.config/genie-toolkit).'
223	});
224	parser.add_argument('-l', '--locale', {	58✔
225	required: false,
226	default: 'en-US',
227	help: `BGP 47 locale tag of the language to use for the assistant (defaults to 'en-US', English)`
228	});
229	parser.add_argument('--thingpedia-url', {	58✔
230	required: false,
231	default: THINGPEDIA_URL,
232	help: 'URL of Thingpedia to use.'
233	});
234	parser.add_argument('--thingpedia-dir', {	58✔
235	required: false,
236	nargs: '+',
237	help: 'Path to a directory containing Thingpedia device definitions (overrides --thingpedia-url).'
238	});
239	parser.add_argument('--nlu-server', {	58✔
240	required: false,
241	default: NL_SERVER_URL,
242	help: 'NLP server URL to use for NLU (can be a file:/// URL).'
243	});
244	parser.add_argument('--nlg-server', {	58✔
245	required: false,
246	help: 'NLP server URL to use for NLG; must be specified to use neural NLG.'
247	});
248	}
249
250	export async function execute(args) {	58✔
NEW 251	const platform = new Platform(args.workdir, args.locale, args.thingpedia_url);	×
252	const prefs = platform.getSharedPreferences();	×
253	if (args.thingpedia_dir && args.thingpedia_dir.length)	×
254	prefs.set('developer-dir', args.thingpedia_dir);	×
255	prefs.set('experimental-use-neural-nlg', !!args.nlg_server);	×
256	const engine = new Engine(platform);	×
257
258	const rl = readline.createInterface({ input: process.stdin, output: process.stdout });	×
259	rl.setPrompt('$ ');	×
260
261	await engine.open();	×
262	const conversation = await engine.assistant.openConversation('main', new LocalUser(), {	×
263	nluServerUrl: args.nlu_server,
264	nlgServerUrl: args.nlg_server,
265	debug: false,
266	showWelcome: true
267	});
268	await conversation.addOutput(new CommandLineDelegate(rl));	×
269
270	new CommandLineHandler(engine, conversation, rl);	×
271	await conversation.start();	×
272	rl.prompt();	×
273
274	await engine.run();	×
275
276	rl.close();	×
277	await engine.close();	×
278	}

stanford-oval / genie-toolkit / 1715

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous