Merge pull request #757 from watson-developer-cloud/unit-tests-for-stt

test: add unit tests for recognize() and createRecognizeStream()

Author: dpopp07

test/unit/test.speech_to_text.v1.js

@@ -1,10 +1,12 @@
 'use strict';
 
 const assert = require('assert');
-const watson = require('../../index');
+const SpeechToTextV1 = require('../../speech-to-text/v1');
 const nock = require('nock');
 const fs = require('fs');
 const isStream = require('isstream');
+const sinon = require('sinon');
+const requestWrapper = require('../../lib/requestwrapper');
 
 describe('speech_to_text', function() {
   const noop = function() {};
@@ -17,6 +19,13 @@ describe('speech_to_text', function() {
     silent: true, // hide deprecation warnings for recognizeLive and friends
   };
 
+  const rc_service = {
+    iam_apikey: 'abc123',
+    url: 'http://ibm.com:80',
+    version: 'v1',
+    silent: true, // hide deprecation warnings for recognizeLive and friends
+  };
+
   before(function() {
     nock.disableNetConnect();
   });
@@ -25,13 +34,15 @@ describe('speech_to_text', function() {
     nock.cleanAll();
   });
 
-  const speech_to_text = watson.speech_to_text(service);
+  const speech_to_text = new SpeechToTextV1(service);
+  const rc_speech_to_text = new SpeechToTextV1(rc_service);
 
   const missingParameter = function(err) {
     assert.ok(err instanceof Error);
     assert.ok(/required parameters/.test(err));
   };
 
+  // tests `listModels` in the generated code
   describe('getModels()', function() {
     const path = '/v1/models';
     const models = { models: [{ foo: 'foo' }, { bar: 'bar' }] };
@@ -142,6 +153,23 @@ describe('speech_to_text', function() {
       speech_to_text.recognize({ content_type: 'bar' }, missingParameter);
       speech_to_text.recognize({ continuous: 'false' }, missingParameter);
     });
+
+    it('should generate a valid payload', function() {
+      const path = '/v1/recognize';
+      const requestSpy = sinon.spy(requestWrapper, 'sendRequest');
+      speech_to_text.recognize(
+        {
+          audio: fs.createReadStream(__dirname + '/../resources/weather.wav'),
+          content_type: 'audio',
+        },
+        noop
+      );
+      assert.equal(requestSpy.called, true);
+      const req = requestSpy.returnValues[0];
+
+      assert.equal(req.uri.href, service.url + path);
+      assert.equal(req.method, 'POST');
+    });
   });
 
   describe('recognizeWebM()', function() {
@@ -152,63 +180,6 @@ describe('speech_to_text', function() {
     });
   });
 
-  // this test is severely broken
-  describe('recognizeStream()', function() {
-    const service_response = {
-      result: [
-        {
-          alternative: [
-            {
-              transcript: 'one two three',
-            },
-          ],
-          final: true,
-        },
-      ],
-      result_index: 0,
-    };
-
-    const options = {
-      content_type: 'audio/l16;rate=41100',
-      continuous: true,
-      timestamps: true,
-      inactivity_timeout: -1,
-      max_alternatives: 1,
-      interim_results: false,
-      keywords: ['one', 'Three'],
-      keywords_threshold: 0.9,
-      word_alternatives_threshold: 0.25,
-    };
-    const recognizeStream = speech_to_text.createRecognizeStream(options);
-    fs.createReadStream(__dirname + '/../resources/weather.wav').pipe(recognizeStream);
-    recognizeStream.setEncoding('utf8');
-
-    // note: none of these tests actually run(or even register with mocha), but the callbacks let the previous test pass :(
-    recognizeStream.on('open', function(socket) {
-      it('should have a socket connection with a correct config', function(done) {
-        assert.notStrictEqual(socket, socket.config, socket.config.fragmentOutgoingMessages);
-        assert.notStrictEqual(socket, socket.config, socket.config.fragmentOutgoingMessages);
-        done();
-      });
-    });
-
-    recognizeStream.on('error', function(err) {
-      it('should throw ECONNRESET with bad credentials', function(done) {
-        assert.equal(err.code, 'ECONNRESET');
-        assert.equal(err.errno, 'ECONNRESET');
-        done();
-      });
-    });
-
-    recognizeStream.on('data', function(obj) {
-      console.log(JSON.stringify(obj)); // eslint-disable-line no-console
-      it('should generate a valid response', function(done) {
-        assert.equal(obj, service_response);
-        done();
-      });
-    });
-  });
-
   describe('recognizeLive()', function() {
     const path = '/v1/sessions/foo/recognize';
     const payload = {
@@ -278,6 +249,22 @@ describe('speech_to_text', function() {
     it('should return a stream', function() {
       assert(isStream(speech_to_text.createRecognizeStream()));
     });
+
+    it('should pass the correct parameters into RecognizeStream', function() {
+      const stream = speech_to_text.createRecognizeStream();
+      assert.equal(stream.options.url, service.url);
+      assert(stream.options.headers.authorization);
+      assert(stream.authenticated);
+      assert.equal(stream.options.token_manager, undefined);
+    });
+
+    it('should create a token manager in RecognizeStream if using IAM', function() {
+      const stream = rc_speech_to_text.createRecognizeStream();
+      assert.equal(stream.options.url, service.url);
+      assert.equal(stream.options.headers.authorization, undefined);
+      assert.equal(stream.authenticated, false);
+      assert(stream.options.token_manager);
+    });
   });
 
   describe('asynchronous callback api', function() {
@@ -383,6 +370,7 @@ describe('speech_to_text', function() {
       assert.equal(req.method, 'POST');
     });
 
+    // tests `checkJobs` in the generated code
     it('should get list of jobs', function(done) {
       const path = '/v1/recognitions';
       const response = {
@@ -491,6 +479,7 @@ describe('speech_to_text', function() {
     });
   });
 
+  // tests `listCustomizations` in the generated code
   describe('getCustomizations()', function() {
     const path = '/v1/customizations';
 
@@ -562,6 +551,7 @@ describe('speech_to_text', function() {
       assert.equal(req.uri.href, service.url + path);
       assert.equal(req.method, 'POST');
 
+      // test `name` param for backwards compatibility
       const req2 = speech_to_text.addCorpus(
         {
           customization_id: 'customer_id_1',
@@ -592,6 +582,7 @@ describe('speech_to_text', function() {
       assert.equal(req.uri.href, service.url + path);
       assert.equal(req.method, 'GET');
 
+      // test `name` param for backwards compatibility
       const req2 = speech_to_text.getCorpus(
         { customization_id: 'customer_id_1', name: 'corpus_name_1' },
         noop
@@ -618,6 +609,7 @@ describe('speech_to_text', function() {
       assert.equal(req.uri.href, service.url + path);
       assert.equal(req.method, 'DELETE');
 
+      // test `name` param for backwards compatibility
       const req2 = speech_to_text.deleteCorpus(
         { customization_id: 'customer_id_1', name: 'corpus_name_1' },
         noop
@@ -627,6 +619,7 @@ describe('speech_to_text', function() {
     });
   });
 
+  // tests `listCorpora` in generated code
   describe('getCorpora()', function() {
     const path = '/v1/customizations/customer_id_1/corpora';
 
@@ -678,6 +671,7 @@ describe('speech_to_text', function() {
     });
   });
 
+  // tests `listWords` in the generated code
   describe('getWords()', function() {
     const path = '/v1/customizations/customer_id_1/words';