avs-device-sdk/AuthDelegate/test/AuthDelegateTest.cpp

/*
 * AuthDelegateTest.cpp
 *
 * Copyright 2017 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 <condition_variable>
#include <chrono>
#include <functional>
#include <memory>
#include <string>

#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include "AuthDelegate/AuthDelegate.h"
#include "AuthDelegate/MockHttpPost.h"
#include "AVSCommon/AVS/Initialization/AlexaClientSDKInit.h"
#include "MockAuthObserver.h"

using namespace alexaClientSDK::authDelegate;
using namespace alexaClientSDK::authDelegate::test;

using namespace ::testing;
using namespace alexaClientSDK::avsCommon::avs::initialization;
using namespace alexaClientSDK::avsCommon::sdkInterfaces;

/// URL to which the refresh token and access token request should be sent.
static const std::string DEFAULT_LWA_URL = "https://api.amazon.com/auth/o2/token";

/**
 * Time out for AuthDelegateObserver to wait for a state change. Wait for 60 seconds to make sure AuthDelegate has
 * enough time to notify the change of state or fail quickly enough on timeout.
 */
static const auto TIME_OUT_IN_SECONDS = std::chrono::seconds(60);

/**
 * 'invalid_request' Error Code from LWA
 * @see https://images-na.ssl-images-amazon.com/images/G/01/lwa/dev/docs/website-developer-guide._TTH_.pdf
 */
static const std::string ERROR_CODE_INVALID_REQUEST = "invalid_request";

/// The HTTP response code for a bad request.
static const long HTTP_RESPONSE_CODE_BAD_REQUEST = 400;

/// Default SDK configuration.
static const std::string DEFAULT_SDK_CONFIGURATION = R"({
    "authDelegate" : {
        "clientId" : "invalid clientId",
        "refreshToken" : "invalid refreshToken",
        "clientSecret" : "invalid clientSecret",
        "authTokenRefreshHeadStart" : 1
    }
})";

/// Define test fixture for testing AuthDelegate.
class AuthDelegateTest : public ::testing::Test {
protected:
    /// Initialize the objects for testing
    AuthDelegateTest() {
        m_mockHttpPost = std::unique_ptr<MockHttpPost>(new MockHttpPost());
        m_mockAuthObserver = std::make_shared<NiceMock<MockAuthObserver>>();
    }

    /// Stub certain mock objects with default actions
    virtual void SetUp() override {
        ON_CALL(*m_mockHttpPost, doPost(_, _, _, _))
            .WillByDefault(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED));
        std::stringstream configuration;
        configuration << DEFAULT_SDK_CONFIGURATION;
        ASSERT_TRUE(AlexaClientSDKInit::initialize({&configuration}));
    }

    virtual void TearDown() override {
        AlexaClientSDKInit::uninitialize();
    }

    /**
     * Wait on a condition for the specified duration.
     *
     * @param seconds Specify how many seconds to wait on a condition before timeout.
     * @param predicate The condition to wait on until it becomes true.
     * @return false if timed out, true otherwise.
     */
    bool waitFor(std::chrono::seconds seconds, std::function<bool()> predicate) {
        std::unique_lock<std::mutex> lock(m_mutex);
        return m_cv.wait_for(lock, seconds, predicate);
    }

    /**
     * Generate a valid LWA response with specified expiration duration in seconds.
     *
     * @param seconds Specify in how many seconds the token would become expire.
     * @return the a valid JSON string response that has the expected expiration.
     */
    std::string generateValidLwaResponseWithExpiration(std::chrono::seconds seconds) {
        std::string response = R"({
                    "access_token":"Atza|IQEBLjAsAhQ3yD47Jkj09BfU_qgNk4",
                    "expires_in":)";
        response += std::to_string(seconds.count());
        response += R"(,
                    "refresh_token":"Atzr|IQEBLzAtAhUAibmh-1N0EVztZJofMx",
                    "token_type":"bearer"
                })";
        return response;
    }

    /**
     * Generate a error LWA response with specified error code.
     *
     * @param errorCode the error code in LWA's response.
     * @return the JSON string that contains error code and descriptions.
     */
    std::string generateErrorLwaResponseWithErrorCode(const std::string& errorCode) {
        std::string response = R"({
                    "error":")";
        response += errorCode;
        response += R"(",
                    "error_description":"invalid request",
                    "request_id":"test_ID"})";
        return response;
    }

    /// Mock object of @c HttpPostInterface through which refresh token request is sent in AuthDelegate.
    std::unique_ptr<MockHttpPost> m_mockHttpPost;

    /// Mock object of @c AuthObserverInterface which will be notified on current AuthDelegate status.
    std::shared_ptr<NiceMock<MockAuthObserver>> m_mockAuthObserver;

    /// Condition variable used by @c waitFor function.
    std::condition_variable m_cv;

    /// Mutex used with condition variable @c m_cv.
    std::mutex m_mutex;
};

/**
 * Test create() with a @c nullptr Config, expecting @c nullptr to be returned.
 */
TEST_F(AuthDelegateTest, createNullConfig) {
    AlexaClientSDKInit::uninitialize();
    ASSERT_TRUE(AlexaClientSDKInit::initialize({}));
    ASSERT_FALSE(AuthDelegate::create(std::move(m_mockHttpPost)));
}

/**
 * Test create() without a clientId set, expecting a @c nullptr to be returned.
 */
TEST_F(AuthDelegateTest, createMissingClientId) {
    AlexaClientSDKInit::uninitialize();
    std::stringstream configuration;
    configuration << DEFAULT_SDK_CONFIGURATION;
    std::stringstream overlay;
    overlay << R"X({
            "authDelegate" : {
                "clientId" : ""
            }
        })X";
    ASSERT_TRUE(AlexaClientSDKInit::initialize({&configuration, &overlay}));
    ASSERT_FALSE(AuthDelegate::create(std::move(m_mockHttpPost)));
}

/**
 * Test create() without a clientSecret set, expecting a @c nullptr to be returned.
 */
TEST_F(AuthDelegateTest, createMissingClientSecret) {
    AlexaClientSDKInit::uninitialize();
    std::stringstream configuration;
    configuration << DEFAULT_SDK_CONFIGURATION;
    std::stringstream overlay;
    overlay << R"X({
            "authDelegate" : {
                "clientSecret" : ""
            }
        })X";
    ASSERT_TRUE(AlexaClientSDKInit::initialize({&configuration, &overlay}));
    ASSERT_FALSE(AuthDelegate::create(std::move(m_mockHttpPost)));
}

/**
 * Test create() without a refresh token set, expecting a @c nullptr to be returned.
 */
TEST_F(AuthDelegateTest, createMissingRefreshToken) {
    AlexaClientSDKInit::uninitialize();
    std::stringstream configuration;
    configuration << DEFAULT_SDK_CONFIGURATION;
    std::stringstream overlay;
    overlay << R"X({
            "authDelegate" : {
                "refreshToken" : ""
            }
        })X";
    ASSERT_TRUE(AlexaClientSDKInit::initialize({&configuration, &overlay}));
    ASSERT_FALSE(AuthDelegate::create(std::move(m_mockHttpPost)));
}

/**
 * Test create() with a valid Config, expecting a valid AuthDelegate to be returned.
 */
TEST_F(AuthDelegateTest, create) {
    ASSERT_TRUE(AuthDelegate::create(std::move(m_mockHttpPost)));
}

/**
 * Test addAuthObserver() with a @c nullptr, expecting no exceptions or crashes.
 */
TEST_F(AuthDelegateTest, addAuthObserverNull) {
    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    ASSERT_TRUE(authDelegate);

    authDelegate->addAuthObserver(nullptr);

    SUCCEED();
}

/**
 * Test removeAuthObserver() with a @c nullptr, expecting no exceptions or crashes.
 */
TEST_F(AuthDelegateTest, removeAuthObserverNull) {
    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    ASSERT_TRUE(authDelegate);

    authDelegate->removeAuthObserver(nullptr);

    SUCCEED();
}

/**
 * Test setAuthObserver() with a valid observer, expecting the observer to be updated with an UNINITIALIZED
 * state.
 */
TEST_F(AuthDelegateTest, addMultipleAuthObserver) {
    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    std::shared_ptr<NiceMock<MockAuthObserver>> m_mockAuthObserver2 = std::make_shared<NiceMock<MockAuthObserver>>();
    ASSERT_TRUE(authDelegate);

    EXPECT_CALL(*m_mockAuthObserver, onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, _))
        .Times(AtMost(1));

    EXPECT_CALL(*m_mockAuthObserver, onAuthStateChange(AuthObserverInterface::State::EXPIRED, _)).Times(AtMost(1));

    EXPECT_CALL(*m_mockAuthObserver2, onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, _))
        .Times(AtMost(1));

    EXPECT_CALL(*m_mockAuthObserver2, onAuthStateChange(AuthObserverInterface::State::EXPIRED, _)).Times(AtMost(1));

    authDelegate->addAuthObserver(m_mockAuthObserver);
    authDelegate->addAuthObserver(m_mockAuthObserver2);
}

/**
 * Test retry logic of AuthDelegate.
 *
 * The initial AuthObserver should be in state UNINITIALIZED when there is no
 * valid response. After getting valid response from "server", the status state should be changed to REFRESHED.
 */
TEST_F(AuthDelegateTest, retry) {
    bool tokenRefreshed = false;
    const auto& validResponse = generateValidLwaResponseWithExpiration(std::chrono::seconds(60));
    EXPECT_CALL(*m_mockHttpPost, doPost(_, _, _, _))
        .WillOnce(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED))
        .WillOnce(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED))
        .WillOnce(DoAll(SetArgReferee<3>(validResponse), Return(HttpPostInterface::HTTP_RESPONSE_CODE_SUCCESS_OK)));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, AuthObserverInterface::Error::NO_ERROR))
        .Times(AtMost(1));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::REFRESHED, AuthObserverInterface::Error::NO_ERROR))
        .WillOnce(InvokeWithoutArgs([this, &tokenRefreshed]() {
            tokenRefreshed = true;
            m_cv.notify_all();
        }));

    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    authDelegate->addAuthObserver(m_mockAuthObserver);
    ASSERT_TRUE(waitFor(TIME_OUT_IN_SECONDS, [&tokenRefreshed]() { return tokenRefreshed; }));
}

/**
 * Test expiration notification from AuthDelegate
 *
 * When access token expired before the earliest time AuthDelegate can send a refresh token request,
 * the observer of AuthDelegate should be notified of the token expiration.
 */
TEST_F(AuthDelegateTest, expirationNotification) {
    bool tokenExpired = false;
    const auto& validResponse = generateValidLwaResponseWithExpiration(std::chrono::seconds(1));

    EXPECT_CALL(*m_mockHttpPost, doPost(_, _, _, _))
        .WillOnce(DoAll(SetArgReferee<3>(validResponse), Return(HttpPostInterface::HTTP_RESPONSE_CODE_SUCCESS_OK)))
        .WillRepeatedly(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED));

    ::testing::InSequence s;
    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, AuthObserverInterface::Error::NO_ERROR))
        .Times(AtMost(1));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::REFRESHED, AuthObserverInterface::Error::NO_ERROR))
        .Times(1);

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::EXPIRED, AuthObserverInterface::Error::UNKNOWN_ERROR))
        .WillOnce(InvokeWithoutArgs([this, &tokenExpired]() {
            tokenExpired = true;
            m_cv.notify_all();
        }));

    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    authDelegate->addAuthObserver(m_mockAuthObserver);
    ASSERT_TRUE(waitFor(TIME_OUT_IN_SECONDS, [&tokenExpired]() { return tokenExpired; }));
}

/**
 * Test AuthDelegate can recover after token expiration
 *
 * After a token expiration, AuthDelegate should be able to recover to REFRESHED state after getting a valid
 * token from LWA
 */
TEST_F(AuthDelegateTest, recoverAfterExpiration) {
    bool tokenRefreshed = false;
    const auto& validResponse = generateValidLwaResponseWithExpiration(std::chrono::seconds(3));

    EXPECT_CALL(*m_mockHttpPost, doPost(_, _, _, _))
        .WillOnce(DoAll(SetArgReferee<3>(validResponse), Return(HttpPostInterface::HTTP_RESPONSE_CODE_SUCCESS_OK)))
        .WillOnce(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED))
        .WillOnce(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED))
        .WillOnce(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED))
        .WillOnce(DoAll(SetArgReferee<3>(validResponse), Return(HttpPostInterface::HTTP_RESPONSE_CODE_SUCCESS_OK)));

    ::testing::InSequence s;
    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, AuthObserverInterface::Error::NO_ERROR))
        .Times(AtMost(1));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::REFRESHED, AuthObserverInterface::Error::NO_ERROR))
        .Times(1);

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::EXPIRED, AuthObserverInterface::Error::UNKNOWN_ERROR))
        .Times(1);

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::REFRESHED, AuthObserverInterface::Error::NO_ERROR))
        .WillOnce(InvokeWithoutArgs([this, &tokenRefreshed]() {
            tokenRefreshed = true;
            m_cv.notify_all();
        }));

    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    authDelegate->addAuthObserver(m_mockAuthObserver);
    ASSERT_TRUE(waitFor(TIME_OUT_IN_SECONDS, [&tokenRefreshed]() { return tokenRefreshed; }));
}

/**
 * Test AuthDelegate will notify the observer of the UNRECOVERABLE_ERROR
 *
 * After sending a invalid request to LWA, LWA should send us an invalid_request error and the AuthObserver should be
 * notified of the UNRECOVERABLE_ERROR state.
 */
TEST_F(AuthDelegateTest, unrecoverableErrorNotification) {
    bool errorReceived = false;
    const auto& invalidRequestResponse = generateErrorLwaResponseWithErrorCode(ERROR_CODE_INVALID_REQUEST);

    EXPECT_CALL(*m_mockHttpPost, doPost(_, _, _, _))
        .WillOnce(DoAll(SetArgReferee<3>(invalidRequestResponse), Return(HTTP_RESPONSE_CODE_BAD_REQUEST)))
        .WillRepeatedly(Return(HttpPostInterface::HTTP_RESPONSE_CODE_UNDEFINED));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(AuthObserverInterface::State::UNINITIALIZED, AuthObserverInterface::Error::NO_ERROR))
        .Times(AtMost(1));

    EXPECT_CALL(
        *m_mockAuthObserver,
        onAuthStateChange(
            AuthObserverInterface::State::UNRECOVERABLE_ERROR, AuthObserverInterface::Error::INVALID_REQUEST))
        .WillOnce(InvokeWithoutArgs([this, &errorReceived]() {
            errorReceived = true;
            m_cv.notify_all();
        }));

    auto authDelegate = AuthDelegate::create(std::move(m_mockHttpPost));
    authDelegate->addAuthObserver(m_mockAuthObserver);
    ASSERT_TRUE(waitFor(TIME_OUT_IN_SECONDS, [&errorReceived]() { return errorReceived; }));
}