Modify api documentation
[platform/core/appfw/appcore-agent.git] / unittests / mock / test_fixture.h
1 /*
2  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef MOCK_TEST_FIXTURE_H_
18 #define MOCK_TEST_FIXTURE_H_
19
20 #include <gtest/gtest.h>
21
22 #include <memory>
23 #include <stdexcept>
24 #include <string>
25 #include <utility>
26
27 #include "module_mock.h"
28
29 class TestFixture : public ::testing::Test {
30  public:
31   explicit TestFixture(std::unique_ptr<ModuleMock>&& mock) {
32     mock_ = std::move(mock);
33   }
34   virtual ~TestFixture() {
35     mock_.reset();
36   }
37
38   virtual void SetUp() {}  // LCOV_EXCL_LINE
39   virtual void TearDown() {}  // LCOV_EXCL_LINE
40
41   template <typename T>
42   static T& GetMock() {
43     auto ptr = dynamic_cast<T*>(mock_.get());
44     if (!ptr) {
45       // LCOV_EXCL_START
46       throw std::invalid_argument("The test does not provide mock of \"" +
47           std::string(typeid(T).name()) + "\"");
48       // LCOV_EXCL_STOP
49     }
50
51     return *ptr;
52   }
53
54   static std::unique_ptr<ModuleMock> mock_;
55 };
56
57 #endif  // MOCK_TEST_FIXTURE_H_