SPEC-1924: AGL Speech Framework's Voice Service High Level 1.0 Release.

Details:
1) Control plugin implementation for VSHL 1.0
2) Exposed APIs that are documented in the confluence page
   https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture
3) Implemented 39 unit tests based on GTest framework to test all the low
level components of VSHL binding.
4) Implemented a HTML5 based VSHL API tester application to test VSHL APIs.

API specification:
https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture#SpeechEGArchitecture-HighLevelVoiceService

Test performed:
1) Tested AGL service running Alexa Auto SDK https://github.com/alexa/aac-sdk on Ubuntu 16.04 and Renesas R-Car M3 board.

License:
Apache 2.0

Developers/Owners:
Naveen Bobbili (nbobbili@amazon.com)
Prakash Buddhiraja (buddhip@amazon.com)
Shotaro Uchida (shotaru@amazon.co.jp)

Change-Id: I3370f4ad65aff030f24f4ad571fb02d525bbfbca
Signed-off-by: Naveen Bobbili  <nbobbili@amazon.com>

6 files changed, 484 insertions, 0 deletions

diff --git a/src/plugins/capabilities/core/include/MessageChannel.h b/src/plugins/capabilities/core/include/MessageChannel.h
new file mode 100644
index 0000000..504e241
--- /dev/null
+++ b/src/plugins/capabilities/core/include/MessageChannel.h
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#ifndef VSHL_CAPABILITIES_CORE_MESSAGECHANNEL_H_
+#define VSHL_CAPABILITIES_CORE_MESSAGECHANNEL_H_
+
+#include <memory>
+
+#include "capabilities/core/include/PublisherForwarder.h"
+#include "capabilities/core/include/SubscriberForwarder.h"
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/capabilities/ICapability.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+/*
+ * MessageChannel has one end as publisher forwarder and the other end
+ * as subscriber forwarder.
+ */
+class MessageChannel {
+public:
+  // Create a MessageChannel.
+  static std::shared_ptr<MessageChannel>
+  create(shared_ptr<vshl::common::interfaces::ILogger> logger,
+         shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+         shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+  // Sends the message
+  bool publish(const string action, const string payload);
+
+  // Subscribe
+  bool subscribe(vshl::common::interfaces::IAFBRequest &request,
+                 const string action);
+
+  // Destructor
+  virtual ~MessageChannel() = default;
+
+private:
+  // Constructor
+  MessageChannel(shared_ptr<vshl::common::interfaces::ILogger> logger,
+                 shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+                 shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+  // Forwarders
+  shared_ptr<PublisherForwarder> mPublisherForwarder;
+  shared_ptr<SubscriberForwarder> mSubscriberForwarder;
+};
+
+} // namespace core
+} // namespace capabilities
+} // namespace vshl
+
+#endif // VSHL_CAPABILITIES_CORE_MESSAGECHANNEL_H_
diff --git a/src/plugins/capabilities/core/include/PublisherForwarder.h b/src/plugins/capabilities/core/include/PublisherForwarder.h
new file mode 100644
index 0000000..9cc89b5
--- /dev/null
+++ b/src/plugins/capabilities/core/include/PublisherForwarder.h
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#ifndef VSHL_CAPABILITIES_CORE_PUBLISHERFORWARDER_H_
+#define VSHL_CAPABILITIES_CORE_PUBLISHERFORWARDER_H_
+
+#include <memory>
+
+#include "capabilities/core/include/SubscriberForwarder.h"
+
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/capabilities/ICapability.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+/*
+ * This class is responsible for forwarding the messages to be published
+ * to subscriber forwarder. Subscriber forwarder will deliver the messages
+ * as AFB Events to all the subscribed clients.
+ * There is one PublisherForwarder and one SubscriberForwarder per capability.
+ */
+class PublisherForwarder {
+public:
+    // Create a PublisherForwarder.
+    static std::shared_ptr<PublisherForwarder> create(
+        shared_ptr<vshl::common::interfaces::ILogger> logger,
+        shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+    // Connect a subscriber forwarder to this publisher forwarder
+    void setSubscriberForwarder(shared_ptr<SubscriberForwarder> subscriberForwarder);
+
+    // Forward message to the subscriber forwarder
+    bool forwardMessage(const string action, const string payload);
+
+    // Destructor
+    ~PublisherForwarder();
+
+private:
+    // Constructor
+    PublisherForwarder(
+        shared_ptr<vshl::common::interfaces::ILogger> logger,
+        shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+    // Subscriber forwarder connected to this publisher forwarder.
+    shared_ptr<SubscriberForwarder> mSubscriberForwarder;
+
+    // Capability
+    shared_ptr<vshl::common::interfaces::ICapability> mCapability;
+
+    // Logger
+    shared_ptr<vshl::common::interfaces::ILogger> mLogger;
+};
+
+}  // namespace core
+}  // namespace capabilities
+}  // namespace vshl
+
+#endif  // VSHL_CAPABILITIES_CORE_PUBLISHERFORWARDER_H_
diff --git a/src/plugins/capabilities/core/include/SubscriberForwarder.h b/src/plugins/capabilities/core/include/SubscriberForwarder.h
new file mode 100644
index 0000000..94c04bf
--- /dev/null
+++ b/src/plugins/capabilities/core/include/SubscriberForwarder.h
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#ifndef VSHL_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_
+#define VSHL_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_
+
+#include <memory>
+#include <string>
+#include <unordered_map>
+
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/capabilities/ICapability.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+/*
+ * This class is responsible for forwarding the messages publishing
+ * to the actual clients using AFB.
+ */
+class SubscriberForwarder {
+public:
+  // Create a SubscriberForwarder.
+  static std::shared_ptr<SubscriberForwarder>
+  create(shared_ptr<vshl::common::interfaces::ILogger> logger,
+         shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+         shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+  // Publish a capability message to the actual client.
+  bool forwardMessage(const string action, const string payload);
+
+  // Subscribe
+  bool subscribe(vshl::common::interfaces::IAFBRequest &request,
+                 const string action);
+
+  // Destructor
+  ~SubscriberForwarder();
+
+private:
+  // Constructor
+  SubscriberForwarder(
+      shared_ptr<vshl::common::interfaces::ILogger> logger,
+      shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+      shared_ptr<vshl::common::interfaces::ICapability> capability);
+
+  // Creates both upstream and downstream events
+  void createEvents();
+
+  // Binding API reference
+  shared_ptr<vshl::common::interfaces::IAFBApi> mAfbApi;
+
+  // Capability
+  shared_ptr<vshl::common::interfaces::ICapability> mCapability;
+
+  // Maps of capability action events to its corresponding Event object.
+  // Event name maps to Action Name
+  unordered_map<string, shared_ptr<common::interfaces::IAFBApi::IAFBEvent>>
+      mUpstreamEventsMap;
+  unordered_map<string, shared_ptr<common::interfaces::IAFBApi::IAFBEvent>>
+      mDownstreamEventsMap;
+
+  // Logger
+  shared_ptr<vshl::common::interfaces::ILogger> mLogger;
+};
+
+} // namespace core
+} // namespace capabilities
+} // namespace vshl
+
+#endif // VSHL_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_
diff --git a/src/plugins/capabilities/core/src/MessageChannel.cpp b/src/plugins/capabilities/core/src/MessageChannel.cpp
new file mode 100644
index 0000000..eaa1349
--- /dev/null
+++ b/src/plugins/capabilities/core/src/MessageChannel.cpp
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#include "capabilities/core/include/MessageChannel.h"
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+
+// Create a MessageChannel.
+std::shared_ptr<MessageChannel> MessageChannel::create(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::IAFBApi> api,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) {
+    auto messageChannel = std::shared_ptr<MessageChannel>(new MessageChannel(logger, api, capability));
+    return messageChannel;
+}
+
+MessageChannel::MessageChannel(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::IAFBApi> api,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) {
+    // Subscriber forwarder
+    mSubscriberForwarder = SubscriberForwarder::create(logger, api, capability);
+    // Publisher forwarder
+    mPublisherForwarder = PublisherForwarder::create(logger, capability);
+    mPublisherForwarder->setSubscriberForwarder(mSubscriberForwarder);
+}
+
+bool MessageChannel::publish(const string action, const string payload) {
+    return mPublisherForwarder->forwardMessage(action, payload);
+}
+
+bool MessageChannel::subscribe(vshl::common::interfaces::IAFBRequest& request, const string action) {
+    return mSubscriberForwarder->subscribe(request, action);
+}
+
+}  // namespace core
+}  // namespace capabilities
+}  // namespace vshl
diff --git a/src/plugins/capabilities/core/src/PublisherForwarder.cpp b/src/plugins/capabilities/core/src/PublisherForwarder.cpp
new file mode 100644
index 0000000..81de6a0
--- /dev/null
+++ b/src/plugins/capabilities/core/src/PublisherForwarder.cpp
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#include "capabilities/core/include/PublisherForwarder.h"
+
+static string TAG = "vshl::capabilities::PublisherForwarder";
+
+using Level = vshl::common::interfaces::ILogger::Level;
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+
+// Create a PublisherForwarder.
+std::shared_ptr<PublisherForwarder> PublisherForwarder::create(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) {
+    if (logger == nullptr) {
+        return nullptr;
+    }
+
+    if (capability == nullptr) {
+        logger->log(Level::ERROR, TAG, "Failed to create PublisherForwarder: Capability null");
+        return nullptr;
+    }
+
+    auto publisherForwarder = std::shared_ptr<PublisherForwarder>(new PublisherForwarder(logger, capability));
+    return publisherForwarder;
+}
+
+// Constructor
+PublisherForwarder::PublisherForwarder(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) {
+    mCapability = capability;
+    mLogger = logger;
+}
+
+// Destructor
+PublisherForwarder::~PublisherForwarder() {
+}
+
+void PublisherForwarder::setSubscriberForwarder(shared_ptr<SubscriberForwarder> subscriberForwarder) {
+    mSubscriberForwarder = subscriberForwarder;
+}
+
+bool PublisherForwarder::forwardMessage(const string action, const string payload) {
+    if (!mSubscriberForwarder) {
+        mLogger->log(Level::ERROR, TAG, "Failed to forward message for capability: " + mCapability->getName());
+        return false;
+    }
+
+    return mSubscriberForwarder->forwardMessage(action, payload);
+}
+
+}  // namespace core
+}  // namespace capabilities
+}  // namespace vshl
diff --git a/src/plugins/capabilities/core/src/SubscriberForwarder.cpp b/src/plugins/capabilities/core/src/SubscriberForwarder.cpp
new file mode 100644
index 0000000..ea42305
--- /dev/null
+++ b/src/plugins/capabilities/core/src/SubscriberForwarder.cpp
@@ -0,0 +1,139 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+#include "capabilities/core/include/SubscriberForwarder.h"
+
+static string TAG = "vshl::capabilities::SubscriberForwarder";
+
+using Level = vshl::common::interfaces::ILogger::Level;
+
+namespace vshl {
+namespace capabilities {
+namespace core {
+
+// Create a SubscriberForwarder.
+std::shared_ptr<SubscriberForwarder> SubscriberForwarder::create(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) {
+    if (logger == nullptr) {
+        return nullptr;
+    }
+
+    if (afbApi == nullptr) {
+        logger->log(Level::ERROR, TAG, "Failed to create SubscriberForwarder: AFB API null");
+        return nullptr;
+    }
+
+    if (capability == nullptr) {
+        logger->log(Level::ERROR, TAG, "Failed to create SubscriberForwarder: Capability null");
+        return nullptr;
+    }
+
+    auto subscriberForwarder =
+        std::shared_ptr<SubscriberForwarder>(new SubscriberForwarder(logger, afbApi, capability));
+    return subscriberForwarder;
+}
+
+SubscriberForwarder::SubscriberForwarder(
+    shared_ptr<vshl::common::interfaces::ILogger> logger,
+    shared_ptr<vshl::common::interfaces::IAFBApi> afbApi,
+    shared_ptr<vshl::common::interfaces::ICapability> capability) :
+        mAfbApi(afbApi),
+        mLogger(logger),
+        mCapability(capability) {
+    createEvents();
+}
+
+SubscriberForwarder::~SubscriberForwarder() {
+    mUpstreamEventsMap.clear();
+    mDownstreamEventsMap.clear();
+}
+
+void SubscriberForwarder::createEvents() {
+    if (!mCapability) {
+        mLogger->log(Level::NOTICE, TAG, "Create Events failed. No capability assigned.");
+        return;
+    }
+
+    // Upstream events
+    auto upstreamEvents = mCapability->getUpstreamMessages();
+    for (auto upstreamEventName : upstreamEvents) {
+        auto it = mUpstreamEventsMap.find(upstreamEventName);
+        if (it == mUpstreamEventsMap.end() && mAfbApi) {
+            // create a new event and add it to the map.
+            shared_ptr<common::interfaces::IAFBApi::IAFBEvent> event = mAfbApi->createEvent(upstreamEventName);
+            if (event == nullptr) {
+                mLogger->log(Level::ERROR, TAG, "Failed to create upstream event: " + upstreamEventName);
+            } else {
+                mUpstreamEventsMap.insert(make_pair(upstreamEventName, event));
+            }
+        }
+    }
+
+    // Downstream events
+    auto downstreamEvents = mCapability->getDownstreamMessages();
+    for (auto downstreamEventName : downstreamEvents) {
+        auto it = mDownstreamEventsMap.find(downstreamEventName);
+        if (it == mDownstreamEventsMap.end() && mAfbApi) {
+            // create a new event and add it to the map.
+            shared_ptr<common::interfaces::IAFBApi::IAFBEvent> event = mAfbApi->createEvent(downstreamEventName);
+            if (event == nullptr) {
+                mLogger->log(Level::ERROR, TAG, "Failed to create downstream event: " + downstreamEventName);
+            } else {
+                mDownstreamEventsMap.insert(make_pair(downstreamEventName, event));
+            }
+        }
+    }
+}
+
+bool SubscriberForwarder::forwardMessage(const string action, const string payload) {
+    auto upstreamEventIt = mUpstreamEventsMap.find(action);
+    if (upstreamEventIt != mUpstreamEventsMap.end()) {
+        mLogger->log(Level::NOTICE, TAG, "Publishing upstream event: " + action);
+        upstreamEventIt->second->publishEvent(json_object_new_string(payload.c_str()));
+        return true;
+    }
+
+    auto downstreamEventIt = mDownstreamEventsMap.find(action);
+    if (downstreamEventIt != mDownstreamEventsMap.end()) {
+        mLogger->log(Level::NOTICE, TAG, "Publishing downstream event: " + action);
+        downstreamEventIt->second->publishEvent(json_object_new_string(payload.c_str()));
+        return true;
+    }
+
+    mLogger->log(Level::NOTICE, TAG, "Failed to publish upstream event: " + action);
+    return false;
+}
+
+bool SubscriberForwarder::subscribe(vshl::common::interfaces::IAFBRequest& request, const string action) {
+    auto upstreamEventIt = mUpstreamEventsMap.find(action);
+    if (upstreamEventIt != mUpstreamEventsMap.end()) {
+        mLogger->log(Level::NOTICE, TAG, "Subscribing to upstream event: " + action);
+        return upstreamEventIt->second->subscribe(request);
+    }
+
+    auto downstreamEventIt = mDownstreamEventsMap.find(action);
+    if (downstreamEventIt != mDownstreamEventsMap.end()) {
+        mLogger->log(Level::NOTICE, TAG, "Subscribing to downstream event: " + action);
+        return downstreamEventIt->second->subscribe(request);
+    }
+
+    mLogger->log(Level::NOTICE, TAG, "Failed to subscribe to upstream event: " + action);
+    return false;
+}
+
+}  // namespace core
+}  // namespace capabilities
+}  // namespace vshl