xref: /foundation/ability/ability_runtime/tools/aa/include/itest_observer.h

/*
 * Copyright (c) 2022 Huawei Device Co., Ltd.
 * 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.
 */

#ifndef OHOS_ABILITY_RUNTIME_ITEST_OBSERVER_H
#define OHOS_ABILITY_RUNTIME_ITEST_OBSERVER_H

#include "iremote_broker.h"
#include "shell_command_result.h"

namespace OHOS {
namespace AAFwk {
class ITestObserver : public IRemoteBroker {
public:
    DECLARE_INTERFACE_DESCRIPTOR(u"ohos.aafwk.ITestObserver");

    /**
     * Outputs test status.
     *
     * @param msg, Indicates the status information.
     * @param resultCode, Indicates the result code.
     */
    virtual void TestStatus(const std::string& msg, const int64_t& resultCode) = 0;

    /**
     * Outputs information and result code that the test has finished.
     *
     * @param msg, Indicates the status information.
     * @param resultCode, Indicates the result code.
     */
    virtual void TestFinished(const std::string& msg, const int64_t& resultCode) = 0;

    /**
     * Executes the specified shell command.
     *
     * @param cmd, Indicates the specified shell command.
     * @param timeoutSec, Indicates the specified time out time, in seconds.
     * @return the result of the specified shell command.
     */
    virtual ShellCommandResult ExecuteShellCommand(const std::string& cmd, const int64_t timeoutSec) = 0;

    enum class Message {
        // ipc id for test status (1)
        AA_TEST_STATUS = 1,
        // ipc id for test finished (2)
        AA_TEST_FINISHED = 2,
        // ipc id for execute shell command (3)
        AA_EXECUTE_SHELL_COMMAND = 3,
    };
};
}  // namespace AAFwk
}  // namespace OHOS

#endif  // OHOS_ABILITY_RUNTIME_ITEST_OBSERVER_H