U/olmidy/wav file test generator (#531)

* Update test generator to support WAV file input. Correct debug build parameters

* Added code for customizable headers and updated the speechSDK

* added DialogData.cs

* fixed skipping column

* Add header value for ExpectedResponses

* Update documentationf for test tool generator.

* Push silence to stream in test tool to force segmentation by SR service.

* Simplify switch case

* refactored dialogData to eliminate warnings.

* removed "Type" from the complex object example in docs

* fixed other readme example

Co-authored-by: Olivier Midy <[email protected]>
Co-authored-by: Chris Schraer <[email protected]>

Author: 3 people

clients/csharp-dotnet-core/voice-assistant-test-generator/DialogData.cs

@@ -1,18 +1,65 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+// <copyright file="DialogData.cs" company="PlaceholderCompany">
+// Copyright (c) PlaceholderCompany. All rights reserved.
+// </copyright>
 
 namespace VoiceAssistantTestGenerator
 {
+    using System;
+    using System.Collections.Generic;
+    using System.Text;
+
+    /// <summary>
+    /// This class stores data associated with a Dialog.
+    /// </summary>
     public class DialogData
     {
-        public string Description = string.Empty;
-        public bool Skip = false;
-        public int TurnID = 0;
-        public int Sleep = 0;
-        public string WavFile = string.Empty;
-        public string Utterance = string.Empty;
-        public string Activity = string.Empty;
-        public bool Keyword = false;
+        private string description = string.Empty;
+        private bool skip = false;
+        private int turnID = 0;
+        private int sleep = 0;
+        private string wavFile = string.Empty;
+        private string utterance = string.Empty;
+        private string activity = string.Empty;
+        private bool keyword = false;
+
+        /// <summary>
+        /// Gets or sets The Description of the dialog.
+        /// </summary>
+        public string Description { get => this.description; set => this.description = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the dialog should be skipped.
+        /// </summary>
+        public bool Skip { get => this.skip; set => this.skip = value; }
+
+        /// <summary>
+        /// Gets or sets The TurnID of the dialog.
+        /// </summary>
+        public int TurnID { get => this.turnID; set => this.turnID = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating how long to sleep before beginning the Dialog.
+        /// </summary>
+        public int Sleep { get => this.sleep; set => this.sleep = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating the WavFile to be read.
+        /// </summary>
+        public string WavFile { get => this.wavFile; set => this.wavFile = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating the utterance to use as a message to the service.
+        /// </summary>
+        public string Utterance { get => this.utterance; set => this.utterance = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating the activity to send to the service.
+        /// </summary>
+        public string Activity { get => this.activity; set => this.activity = value; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether we should use keyword listening or not.
+        /// </summary>
+        public bool Keyword { get => this.keyword; set => this.keyword = value; }
     }
 }

clients/csharp-dotnet-core/voice-assistant-test-generator/README.md

@@ -56,13 +56,13 @@ Each column's header should specify the schema of that property. Currently all v
 It is supported to have in depth objects. Currently if no braces are specified all properties are expected to be in the top level of the received activity. If you wish to specify depth simply add an opening brace to the object that has depth and closing brace to the last element.
 
 ```
-Utterance | type | ExpectedResponses | complexObject{ | subProperty1 | subObject2{ | subSubProperty1} | subProperty3}
+Utterance | ExpectedResponses | complexObject{ | subProperty1 | subObject2{ | subSubProperty1} | subProperty3}
 ```
 
 Example test file ( '|' represents a tab). This test file defines messages that expect to correctly be interpreted to set a timer for 30 seconds and the service returns an activity with the extracted information as well as an added field about what the alarm should be.
 
 ```
-Utterance                   | Sleep | Keyword | type  | ExpectedResponses | details{ | duration | alarm}
-Set a timer for 30 seconds  | 200   | false   | timer |                   |          | "30"     | "audible"
-Make a timer for 30 seconds | 200   | false   | timer |                   |          | "30"     | "audible"
+Utterance                   | Sleep | Keyword | ExpectedResponses | type  | details{ | duration | alarm}
+Set a timer for 30 seconds  | 200   | false   |                   | timer |                   |          | "30"     | "audible"
+Make a timer for 30 seconds | 200   | false   |                   | timer |                   |          | "30"     | "audible"
 ```