examples/chip-tool/commands/tests/TestCommand.cpp

/*
 *   Copyright (c) 2021 Project CHIP Authors
 *   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.
 *   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.
 *
 */

#include "TestCommand.h"

CHIP_ERROR TestCommand::RunCommand()
{
    if (mPICSFilePath.HasValue())
    {
        PICS.SetValue(PICSBooleanReader::Read(mPICSFilePath.Value()));
    }

    NextTest();

    return CHIP_NO_ERROR;
}

CHIP_ERROR TestCommand::WaitForCommissionee(const char * identity,
                                            const chip::app::Clusters::DelayCommands::Commands::WaitForCommissionee::Type & value)
{
    chip::FabricIndex fabricIndex = GetCommissioner(identity).GetFabricIndex();
    ReturnErrorCodeIf(fabricIndex == chip::kUndefinedFabricIndex, CHIP_ERROR_INCORRECT_STATE);

    //
    // There's a chance the commissionee may have rebooted before this call here as part of a test flow
    // or is just starting out fresh outright. Let's make sure we're not re-using any cached CASE sessions
    // that will now be stale and mismatched with the peer, causing subsequent interactions to fail.
    //
    if (value.expireExistingSession.ValueOr(true))
    {
        GetCommissioner(identity).SessionMgr()->ExpireAllSessions(chip::ScopedNodeId(value.nodeId, fabricIndex));
    }

    SetIdentity(identity);
    return GetCommissioner(identity).GetConnectedDevice(value.nodeId, &mOnDeviceConnectedCallback,
                                                        &mOnDeviceConnectionFailureCallback);
}

void TestCommand::OnDeviceConnectedFn(void * context, chip::OperationalDeviceProxy * device)
{
    ChipLogProgress(chipTool, " **** Test Setup: Device Connected\n");
    auto * command = static_cast<TestCommand *>(context);
    VerifyOrReturn(command != nullptr, ChipLogError(chipTool, "Device connected, but cannot run the test, as the context is null"));
    command->mDevices[command->GetIdentity()] = device;

    LogErrorOnFailure(command->ContinueOnChipMainThread(CHIP_NO_ERROR));
}

void TestCommand::OnDeviceConnectionFailureFn(void * context, const chip::ScopedNodeId & peerId, CHIP_ERROR error)
{
    ChipLogProgress(chipTool, " **** Test Setup: Device Connection Failure [deviceId=%" PRIu64 ". Error %" CHIP_ERROR_FORMAT "\n]",
                    peerId.GetNodeId(), error.Format());
    auto * command = static_cast<TestCommand *>(context);
    VerifyOrReturn(command != nullptr, ChipLogError(chipTool, "Test command context is null"));

    LogErrorOnFailure(command->ContinueOnChipMainThread(error));
}

void TestCommand::ExitAsync(intptr_t context)
{
    auto testCommand = reinterpret_cast<TestCommand *>(context);
    testCommand->InteractionModel::Shutdown();
    testCommand->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
}

void TestCommand::Exit(std::string message, CHIP_ERROR err)
{
    bool shouldContinueOnFailure = mContinueOnFailure.HasValue() && mContinueOnFailure.Value();
    if (shouldContinueOnFailure)
    {
        if (CHIP_NO_ERROR != err)
        {
            ChipLogError(chipTool, " ***** Step Failure: %s\n", message.c_str());
            mErrorMessages.push_back(message);
            ContinueOnChipMainThread(CHIP_NO_ERROR);
            return;
        }

        // If the test runner has been configured to not stop after a test failure, exit can be called with a success but it could
        // be pending errors from previous steps.
        uint32_t errorsCount = static_cast<uint32_t>(mErrorMessages.size());
        if (errorsCount)
        {
            ChipLogError(chipTool, "Error: %u error(s) has been encountered:", errorsCount);

            for (uint32_t i = 0; i < errorsCount; i++)
            {
                ChipLogError(chipTool, "\t%u. %s", (i + 1), mErrorMessages.at(i).c_str());
            }
            err = CHIP_ERROR_INTERNAL;
        }
    }

    mContinueProcessing = false;

    LogEnd(message, err);

    if (CHIP_NO_ERROR == err)
    {
        InteractionModel::Shutdown();
        SetCommandExitStatus(err);
    }
    else
    {
        chip::DeviceLayer::PlatformMgr().ScheduleWork(ExitAsync, reinterpret_cast<intptr_t>(this));
    }
}

CHIP_ERROR TestCommand::ContinueOnChipMainThread(CHIP_ERROR err)
{
    if (mContinueProcessing == false)
    {
        return CHIP_NO_ERROR;
    }

    if (CHIP_NO_ERROR == err)
    {
        chip::app::Clusters::DelayCommands::Commands::WaitForMs::Type value;
        value.ms = 0;
        return WaitForMs(GetIdentity().c_str(), value);
    }

    Exit(chip::ErrorStr(err), err);
    return CHIP_NO_ERROR;
}