xref: /base/hiviewdfx/hiappevent/test/unittest/common/native/hiappevent_cache_test.cpp

/*
 * 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.
 */

#include "hiappevent_cache_test.h"

#include "app_event_cache_common.h"
#include "app_event_store.h"
#include "file_util.h"
#include "hiappevent_base.h"
#include "hiappevent_clean.h"
#include "hiappevent_config.h"
#include "hiappevent_write.h"

using namespace testing::ext;
using namespace OHOS::HiviewDFX;
using namespace OHOS::HiviewDFX::AppEventCacheCommon;
namespace {
const std::string TEST_DIR = "/data/test/hiappevent/";
const std::string TEST_DB_PATH = "/data/test/hiappevent/databases/appevent.db";
const std::string TEST_OBSERVER_NAME = "test_observer";
const std::string TEST_EVENT_DOMAIN = "test_domain";
const std::string TEST_EVENT_NAME = "test_name";
constexpr int TEST_EVENT_TYPE = 1;
const std::string TEST_PACKAGE = "{\"domain_\":\"hiappevent\", \"name_\":\"testEvent\"}";
const std::string TEST_RUNNING_ID = "running_test";

std::shared_ptr<AppEventPack> CreateAppEventPack()
{
    return std::make_shared<AppEventPack>(TEST_EVENT_DOMAIN, TEST_EVENT_NAME, TEST_EVENT_TYPE);
}
}

void HiAppEventCacheTest::SetUp()
{
    HiAppEventConfig::GetInstance().SetStorageDir(TEST_DIR);
}

/**
 * @tc.name: HiAppEventDBTest001
 * @tc.desc: check the query result of DB operation.
 * @tc.type: FUNC
 * @tc.require: issueI5K0X6
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest001, TestSize.Level0)
{
    /**
     * @tc.steps: step1. open the db.
     * @tc.steps: step2. insert record to the tables.
     * @tc.steps: step3. query records from tables.
     */
    int result = AppEventStore::GetInstance().InitDbStore();;
    ASSERT_EQ(result, 0);

    int64_t eventSeq = AppEventStore::GetInstance().InsertEvent(CreateAppEventPack());
    ASSERT_GT(eventSeq, 0);
    int64_t observerSeq = AppEventStore::GetInstance().InsertObserver(TEST_OBSERVER_NAME);
    ASSERT_GT(observerSeq, 0);
    int64_t mappingSeq = AppEventStore::GetInstance().InsertEventMapping(eventSeq, observerSeq);
    ASSERT_GT(mappingSeq, 0);

    std::vector<std::shared_ptr<AppEventPack>> events;
    result = AppEventStore::GetInstance().QueryEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    ASSERT_GT(events.size(), 0);
    ASSERT_EQ(events[0]->GetDomain(), TEST_EVENT_DOMAIN);
    ASSERT_EQ(events[0]->GetName(), TEST_EVENT_NAME);
    ASSERT_EQ(events[0]->GetType(), TEST_EVENT_TYPE);

    std::vector<int64_t> observerSeqs;
    result = AppEventStore::GetInstance().QueryObserverSeqs(TEST_OBSERVER_NAME, observerSeqs);
    ASSERT_EQ(result, 0);
    ASSERT_GT(observerSeqs.size(), 0);
    ASSERT_EQ(observerSeqs[0], observerSeq);

    result = AppEventStore::GetInstance().DestroyDbStore();;
    ASSERT_EQ(result, 0);
}

/**
 * @tc.name: HiAppEventDBTest002
 * @tc.desc: check the take result of DB operation.
 * @tc.type: FUNC
 * @tc.require: issueI5K0X6
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest002, TestSize.Level0)
{
    /**
     * @tc.steps: step1. open the db.
     * @tc.steps: step2. insert record to the tables.
     * @tc.steps: step3. take records from tables.
     */
    int result = AppEventStore::GetInstance().InitDbStore();;
    ASSERT_EQ(result, 0);

    auto eventSeq = AppEventStore::GetInstance().InsertEvent(CreateAppEventPack());
    ASSERT_GT(eventSeq, 0);
    auto observerSeq = AppEventStore::GetInstance().InsertObserver(TEST_OBSERVER_NAME);
    ASSERT_GT(observerSeq, 0);
    auto mappingSeq = AppEventStore::GetInstance().InsertEventMapping(eventSeq, observerSeq);
    ASSERT_GT(mappingSeq, 0);

    std::vector<std::shared_ptr<AppEventPack>> events;
    result = AppEventStore::GetInstance().TakeEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    ASSERT_GT(events.size(), 0);
    ASSERT_EQ(events[0]->GetDomain(), TEST_EVENT_DOMAIN);
    ASSERT_EQ(events[0]->GetName(), TEST_EVENT_NAME);
    ASSERT_EQ(events[0]->GetType(), TEST_EVENT_TYPE);

    events.clear();
    result = AppEventStore::GetInstance().QueryEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    ASSERT_EQ(events.size(), 0);

    result = AppEventStore::GetInstance().DestroyDbStore();;
    ASSERT_EQ(result, 0);
}

/**
 * @tc.name: HiAppEventDBTest003
 * @tc.desc: check the delete result of DB operation.
 * @tc.type: FUNC
 * @tc.require: issueI5NTOD
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest003, TestSize.Level0)
{
   /**
     * @tc.steps: step1. open the db.
     * @tc.steps: step2. insert record to the tables.
     * @tc.steps: step3. delete records from tables.
     */
    int result = AppEventStore::GetInstance().InitDbStore();;
    ASSERT_EQ(result, 0);

    auto eventSeq = AppEventStore::GetInstance().InsertEvent(CreateAppEventPack());
    ASSERT_GT(eventSeq, 0);
    auto observerSeq = AppEventStore::GetInstance().InsertObserver(TEST_OBSERVER_NAME);
    ASSERT_GT(observerSeq, 0);
    auto mappingSeq = AppEventStore::GetInstance().InsertEventMapping(eventSeq, observerSeq);
    ASSERT_GT(mappingSeq, 0);

    result = AppEventStore::GetInstance().DeleteObserver(observerSeq);
    ASSERT_EQ(result, 1); // 1 recored
    std::vector<int64_t> observerSeqs;
    result = AppEventStore::GetInstance().QueryObserverSeqs(TEST_OBSERVER_NAME, observerSeqs);
    ASSERT_EQ(result, 0);
    ASSERT_EQ(observerSeqs.size(), 0);

    result = AppEventStore::GetInstance().DeleteEventMapping(observerSeq, {eventSeq});
    ASSERT_EQ(result, 0); // 0 recored
    std::vector<std::shared_ptr<AppEventPack>> events;
    result = AppEventStore::GetInstance().QueryEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    ASSERT_EQ(events.size(), 0);
}

/**
 * @tc.name: HiAppEventDBTest004
 * @tc.desc: revisit the DB after destroying it.
 * @tc.type: FUNC
 * @tc.require: issueI5NTOS
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest004, TestSize.Level1)
{
    /**
     * @tc.steps: step1. open the db.
     * @tc.steps: step2. create block table.
     * @tc.steps: step3. add record to the block table.
     * @tc.steps: step4. config the max storage size.
     * @tc.steps: step5. trigger cleanup.
     * @tc.steps: step6. close the db.
     */
    int result = AppEventStore::GetInstance().DestroyDbStore();;
    ASSERT_EQ(result, 0);

    int64_t eventSeq = AppEventStore::GetInstance().InsertEvent(CreateAppEventPack());
    ASSERT_GT(eventSeq, 0);
    int64_t observerSeq = AppEventStore::GetInstance().InsertObserver(TEST_OBSERVER_NAME);
    ASSERT_GT(observerSeq, 0);
    int64_t mappingSeq = AppEventStore::GetInstance().InsertEventMapping(eventSeq, observerSeq);
    ASSERT_GT(mappingSeq, 0);

    std::vector<std::shared_ptr<AppEventPack>> events;
    result = AppEventStore::GetInstance().QueryEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    std::vector<int64_t> observerSeqs;
    result = AppEventStore::GetInstance().QueryObserverSeqs(TEST_OBSERVER_NAME, observerSeqs);
    ASSERT_EQ(result, 0);
    result = AppEventStore::GetInstance().TakeEvents(events, observerSeq);
    ASSERT_EQ(result, 0);

    result = AppEventStore::GetInstance().DeleteObserver(observerSeq);
    ASSERT_EQ(result, 1); // 1 recored
    result = AppEventStore::GetInstance().DeleteEventMapping(observerSeq, {eventSeq});
    ASSERT_EQ(result, 0); // 0 recored
}

/**
 * @tc.name: HiAppEventDBTest005
 * @tc.desc: check the result of clear data.
 * @tc.type: FUNC
 * @tc.require: issueI5NTOS
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest005, TestSize.Level1)
{
    /**
     * @tc.steps: step1. create log file.
     * @tc.steps: step2. create db file.
     * @tc.steps: step3. clear the data.
     */
    WriteEvent(std::make_shared<AppEventPack>("name", 1));
    std::vector<std::string> files;
    FileUtil::GetDirFiles(TEST_DIR, files);
    ASSERT_FALSE(files.empty());
    ASSERT_TRUE(FileUtil::IsFileExists(TEST_DIR));
    ASSERT_TRUE(FileUtil::IsFileExists(TEST_DB_PATH));

    HiAppEventClean::ClearData(TEST_DIR);
    ASSERT_TRUE(FileUtil::IsFileExists(TEST_DB_PATH));
    ASSERT_TRUE(FileUtil::IsFileExists(TEST_DIR));
    for (const auto& file : files) {
        ASSERT_FALSE(FileUtil::IsFileExists(file));
    }
}

/**
 * @tc.name: HiAppEventDBTest006
 * @tc.desc: check the query result of DB operation.
 * @tc.type: FUNC
 * @tc.require: issueI5K0X6
 */
HWTEST_F(HiAppEventCacheTest, HiAppEventDBTest006, TestSize.Level0)
{
    /**
     * @tc.steps: step1. open the db.
     * @tc.steps: step2. insert record to the tables, insert custom param.
     * @tc.steps: step3. query records from tables.
     * @tc.steps: step3. delete custom param, query records from tables.
     */
    int result = AppEventStore::GetInstance().InitDbStore();;
    ASSERT_EQ(result, 0);

    auto event = CreateAppEventPack();
    event->SetRunningId(TEST_RUNNING_ID);
    int64_t eventSeq = AppEventStore::GetInstance().InsertEvent(event);
    ASSERT_GT(eventSeq, 0);
    int64_t observerSeq = AppEventStore::GetInstance().InsertObserver(TEST_OBSERVER_NAME);
    ASSERT_GT(observerSeq, 0);
    int64_t mappingSeq = AppEventStore::GetInstance().InsertEventMapping(eventSeq, observerSeq);
    ASSERT_GT(mappingSeq, 0);
    auto eventParams = CreateAppEventPack();
    eventParams->SetRunningId(TEST_RUNNING_ID);
    eventParams->AddParam("custom_data", "value_str");
    int64_t ret = AppEventStore::GetInstance().InsertCustomEventParams(eventParams);
    ASSERT_EQ(ret, 0);

    std::vector<std::shared_ptr<AppEventPack>> events;
    result = AppEventStore::GetInstance().QueryEvents(events, observerSeq);
    ASSERT_EQ(result, 0);
    ASSERT_GT(events.size(), 0);
    ASSERT_EQ(events[0]->GetDomain(), TEST_EVENT_DOMAIN);
    ASSERT_EQ(events[0]->GetName(), TEST_EVENT_NAME);
    ASSERT_EQ(events[0]->GetType(), TEST_EVENT_TYPE);
    ASSERT_EQ(events[0]->GetRunningId(), TEST_RUNNING_ID);
    ASSERT_EQ(events[0]->GetParamStr(), "{\"custom_data\":\"value_str\"}\n");

    // delete custom params
    AppEventStore::GetInstance().DeleteCustomEventParams();
    std::vector<std::shared_ptr<AppEventPack>> events1;
    result = AppEventStore::GetInstance().QueryEvents(events1, observerSeq, 1);
    ASSERT_EQ(result, 0);
    ASSERT_EQ(events1.size(), 1);
    ASSERT_EQ(events1[0]->GetDomain(), TEST_EVENT_DOMAIN);
    ASSERT_EQ(events1[0]->GetName(), TEST_EVENT_NAME);
    ASSERT_EQ(events1[0]->GetType(), TEST_EVENT_TYPE);
    ASSERT_EQ(events1[0]->GetRunningId(), TEST_RUNNING_ID);
    ASSERT_EQ(events1[0]->GetParamStr(), "{}\n");

    result = AppEventStore::GetInstance().DestroyDbStore();;
    ASSERT_EQ(result, 0);
}