libperfmgr/tests/NodeTest.cc

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * 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 specic language governing permissions and
 * limitations under the License.
 */

#include <algorithm>
#include <thread>

#include <android-base/file.h>
#include <android-base/stringprintf.h>
#include <android-base/test_utils.h>

#include <gtest/gtest.h>

#include "perfmgr/Node.h"

namespace android {
namespace perfmgr {

using namespace std::chrono_literals;

constexpr double kTIMING_TOLERANCE_MS = std::chrono::milliseconds(25).count();
constexpr auto kSLEEP_TOLERANCE_MS = 2ms;

static inline void _VerifyPathValue(const std::string& path,
                                    const std::string& value) {
    std::string s;
    EXPECT_TRUE(android::base::ReadFileToString(path, &s)) << strerror(errno);
    EXPECT_EQ(value, s);
}

// Test init with no default value
TEST(NodeTest, NoInitDefaultTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 1, false);
    _VerifyPathValue(tf.path, "");
}

// Test init with default value
TEST(NodeTest, InitDefaultTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 1, true);
    _VerifyPathValue(tf.path, "value1");
    TemporaryFile tf2;
    Node t2("t2", tf2.path, {{"value0"}, {"value1"}, {"value2"}}, 0, true);
    _VerifyPathValue(tf2.path, "value0");
}

// Test DumpToFd
TEST(NodeTest, DumpToFdTest) {
    TemporaryFile tf;
    Node t("test_dump", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 1, true);
    TemporaryFile dumptf;
    t.DumpToFd(dumptf.fd);
    fsync(dumptf.fd);
    std::string buf(
        android::base::StringPrintf("test_dump\t%s\t1\tvalue1\n", tf.path));
    _VerifyPathValue(dumptf.path, buf);
}

// Test GetValueIndex
TEST(NodeTest, GetValueIndexTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 1, false);
    std::size_t index = 0;
    EXPECT_TRUE(t.GetValueIndex("value2", &index));
    EXPECT_EQ(2u, index);
    index = 1234;
    EXPECT_FALSE(t.GetValueIndex("NON_EXIST", &index));
    EXPECT_EQ(1234u, index);
}

// Test GetValues
TEST(NodeTest, GetValuesTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 1, false);
    std::vector values = t.GetValues();
    EXPECT_EQ(3u, values.size());
    EXPECT_EQ("value0", values[0]);
    EXPECT_EQ("value1", values[1]);
    EXPECT_EQ("value2", values[2]);
}

// Test get more properties
TEST(NodeTest, GetPropertiesTest) {
    std::string test_name = "TESTREQ_1";
    std::string test_path = "TEST_PATH";
    Node t(test_name, test_path, {}, 0, false, true);
    EXPECT_EQ(test_name, t.GetName());
    EXPECT_EQ(test_path, t.GetPath());
    EXPECT_EQ(0u, t.GetValues().size());
    EXPECT_EQ(0u, t.GetDefaultIndex());
    EXPECT_FALSE(t.GetResetOnInit());
    EXPECT_TRUE(t.GetHoldFd());
}

// Test add request fail and retry
TEST(NodeTest, AddRequestTestFail) {
    Node t("t", "/sys/android/nonexist_node_test",
           {{"value0"}, {"value1"}, {"value2"}}, 2, true);
    auto start = std::chrono::steady_clock::now();
    EXPECT_TRUE(t.AddRequest(1, "INTERACTION", start + 200ms));
    std::chrono::milliseconds expire_time = t.Update();
    // Add request @ value1
    EXPECT_NEAR(std::chrono::milliseconds(200).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 higher prio than value1
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 2000ms));
    expire_time = t.Update();
    // Retry in 500 ms
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
}

// Test add request
TEST(NodeTest, AddRequestTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 2, true);
    auto start = std::chrono::steady_clock::now();
    EXPECT_TRUE(t.AddRequest(1, "INTERACTION", start + 500ms));
    std::chrono::milliseconds expire_time = t.Update();
    // Add request @ value1
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 higher prio than value1
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 200ms));
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value0");
    EXPECT_NEAR(std::chrono::milliseconds(200).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Let high prio request timeout, now only request @ value1 active
    std::this_thread::sleep_for(expire_time + kSLEEP_TOLERANCE_MS);
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(300).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Let all requests timeout, now default value2
    std::this_thread::sleep_for(expire_time + kSLEEP_TOLERANCE_MS);
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value2");
    EXPECT_EQ(std::chrono::milliseconds::max(), expire_time);
}

// Test remove request
TEST(NodeTest, RemoveRequestTest) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 2, true);
    auto start = std::chrono::steady_clock::now();
    EXPECT_TRUE(t.AddRequest(1, "INTERACTION", start + 500ms));
    std::chrono::milliseconds expire_time = t.Update();
    // Add request @ value1
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 higher prio than value1
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 200ms));
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value0");
    EXPECT_NEAR(std::chrono::milliseconds(200).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Remove high prio request, now only request @ value1 active
    t.RemoveRequest("LAUNCH");
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Remove request, now default value2
    t.RemoveRequest("INTERACTION");
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value2");
    EXPECT_EQ(std::chrono::milliseconds::max(), expire_time);
}

// Test add request with holding fd
TEST(NodeTest, AddRequestTestHoldFdOverride) {
    TemporaryFile tf;
    Node t("t", tf.path, {{"value0"}, {"value1"}, {"value2"}}, 2, true, true);
    EXPECT_TRUE(t.GetHoldFd());
    auto start = std::chrono::steady_clock::now();
    EXPECT_TRUE(t.AddRequest(1, "INTERACTION", start + 500ms));
    std::chrono::milliseconds expire_time = t.Update();
    // Add request @ value1
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 higher prio than value1
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 200ms));
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value0");
    EXPECT_NEAR(std::chrono::milliseconds(200).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 shorter
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 100ms));
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value0");
    EXPECT_NEAR(std::chrono::milliseconds(200).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Add request @ value0 longer
    EXPECT_TRUE(t.AddRequest(0, "LAUNCH", start + 300ms));
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value0");
    EXPECT_NEAR(std::chrono::milliseconds(300).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Remove high prio request, now only request @ value1 active
    t.RemoveRequest("LAUNCH");
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value1");
    EXPECT_NEAR(std::chrono::milliseconds(500).count(), expire_time.count(),
                kTIMING_TOLERANCE_MS);
    // Remove request, now default value2
    t.RemoveRequest("INTERACTION");
    expire_time = t.Update();
    _VerifyPathValue(tf.path, "value2");
    EXPECT_EQ(std::chrono::milliseconds::max(), expire_time);
}

}  // namespace perfmgr
}  // namespace android