1112

pending completion

Build # 1112

Build Type

Pull #257

travis-ci-com

Committed by

web-flow

Commit Message

Merge 53ab30e2a into 65b4e469a

Pull Request Pull Request #257: Remove sound support from the test assistant

Run Details

6547 of 12308 branches covered (53.19%)

Branch coverage included in aggregate %.

0 of 1 new or added line in 1 file covered. (0.0%)

2 existing lines in 1 file now uncovered.

15097 of 23845 relevant lines covered (63.31%)

2771804.29 hits per line

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

7.04

/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>
"use strict";

const path = require('path');
const readline = require('readline');

const Engine = require('../lib/engine');
const Platform = require('./lib/cmdline-platform');

const THINGPEDIA_URL = 'https://thingpedia.stanford.edu/thingpedia';
const NL_SERVER_URL = 'https://almond-nl.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', this._onLine.bind(this));
        this._rl.on('SIGINT', this._quit.bind(this));

        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 {
                var 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();
        });
    }
}

module.exports = {
    initArgparse(subparsers) {
        const parser = subparsers.addParser('assistant', {
            addHelp: true,
            description: "Test/demo the assistant interactively."
        });
        parser.addArgument('--workdir', {
            required: false,
            defaultValue: process.cwd(),
            help: 'Directory where to store the assistant database and other files (defaults to the current working directory).'
        });
        parser.addArgument(['-l', '--locale'], {
            required: false,
            defaultValue: 'en-US',
            help: `BGP 47 locale tag of the language to use for the assistant (defaults to 'en-US', English)`
        });
        parser.addArgument('--thingpedia-url', {
            required: false,
            defaultValue: THINGPEDIA_URL,
            help: 'URL of Thingpedia to use.'
        });
        parser.addArgument('--thingpedia-dir', {
            required: false,
            help: 'Path to a directory containing Thingpedia device definitions (overrides --thingpedia-url).'
        });
        parser.addArgument('--nlu-server', {
            required: false,
            defaultValue: NL_SERVER_URL,
            help: 'NLP server URL to use for NLU (can be a file:/// URL).'
        });
        parser.addArgument('--nlg-server', {
            required: false,
            help: 'NLP server URL to use for NLG; must be specified to use neural NLG.'
        });
    },

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

stanford-oval / genie-toolkit / 1112

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