From: Sangwan Kwon <sangwan.kwon@samsung.com>
Date: Thu, 24 Oct 2019 02:21:40 +0000 (+0900)
Subject: Rename Property API to VirtualTable
X-Git-Tag: accepted/tizen/unified/20200810.122954~176
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d926c820fafc08eb88ac7659f1141e6ef946a167;p=platform%2Fcore%2Fsecurity%2Fvist.git

Rename Property API to VirtualTable

Signed-off-by: Sangwan Kwon <sangwan.kwon@samsung.com>
---

diff --git a/api/README.md b/api/README.md
deleted file mode 100644
index df8eccb..0000000
--- a/api/README.md
+++ /dev/null
@@ -1,113 +0,0 @@
-# *Programming interface for client*
-
-# Type-safe getter API
-## Senario #1 Get process informations
-### Check Processes Struct
-```cpp
-// api/schema/processes.h
-struct Processes {
-	int pid;
-	std::string name;
-	std::string path;
-	std::string cmdline;
-/// ...
-	std::string user_time;
-	std::string system_time;
-	std::string start_time;
-};
-```
-
-### Use Properties API
-```cpp
-#include <property.h>
-#include <schema/processes.h>
-
-Properties<Processes> processes;
-for (auto& p : processes) {
-	std::cout << p[&Processes::pid] << std::endl;
-	std::cout << p[&Processes::name] << std::endl;
-	std::cout << p[&Processes::path] << std::endl;
-	std::cout << p[&Processes::cmdline] << std::endl;
-	std::cout << p[&Processes::uid] << std::endl;
-	std::cout << p[&Processes::gid] << std::endl;
-	std::cout << p[&Processes::euid] << std::endl;
-	std::cout << p[&Processes::egid] << std::endl;
-}
-```
-
-## Senario #2 Get system time
-### Check Time Struct
-```cpp
-// api/schema/time.h
-struct Time {
-	int hour;
-	int minutes;
-	int seconds;
-};
-```
-### Use Property API
-```cpp
-Property<Time> time;
-std::cout << time[&Time::hour] << std::endl;
-std::cout << time[&Time::minutes] << std::endl;
-std::cout << time[&Time::seconds] << std::endl;
-```
----
-
-# Osquery F/W API
-## #1. Query execution
-### Check smack table schema
-| name | type |
-|---|---|
-| subject_label | TEXT |
-| object_label | TEXT |
-| access_type | TEXT |
-| permission | TEXT |
-
-### Use OsqueryManager to get smack information
-```cpp
-using namespace osquerypp;
-
-// 1. Write query as std::string
-std::string query = "SELECT subject_label, object_label FROM smack WHERE access_type = 'read'";
-
-// 2. Execute query by using OsqueryManager
-auto rows = OsqueryManager::execute(query);
-
-// 3. Get result
-for (const auto& row : rows) {
-  std::string slabel = row["subject_label"];
-  std::string olabel = row["object_label];
-}
-```
-
-## #2. Event subscription
-### Check smack_deny_events table schema
-- The name of the event table ends with *_events.  
-| name | type |
-|---|---|
-| action | TEXT |
-| subject_label | TEXT |
-| object_label | TEXT |
-| access_type | TEXT |
-| permission | TEXT |
-| requested | TEXT |
-| pid | INTEGER |
-
-### Use OsqueryManager to subscribe smack-deny-events
-```cpp
-using namespace osquerypp;
-
-// 1. Write callback function
-auto onDeny = [&](const EventContext& ec, const Row& row)
-{
-  // get data of event table
-  std::cout << row["action"] << std::endl;
-  std::cout << row["permission"] << std::endl;
-  std::cout << row["subject_label"] << std::endl;
-  std::cout << row["object_label"] << std::endl;
-}
-
-// 2. Register callback with event_table by using OsqueryManager
-OsqueryManager::subscribe("smack_deny_events", onDeny);
-```
diff --git a/src/vist/CMakeLists.txt b/src/vist/CMakeLists.txt
index adb7459..52b8725 100644
--- a/src/vist/CMakeLists.txt
+++ b/src/vist/CMakeLists.txt
@@ -24,7 +24,6 @@ INCLUDE_DIRECTORIES(. common)
 ADD_SUBDIRECTORY(client)
 ADD_SUBDIRECTORY(common)
 ADD_SUBDIRECTORY(notification)
-ADD_SUBDIRECTORY(property)
 ADD_SUBDIRECTORY(service)
 
 ADD_LIBRARY(${TARGET_VIST_LIB} STATIC ${${TARGET_VIST_LIB}_SRCS})
diff --git a/src/vist/client/CMakeLists.txt b/src/vist/client/CMakeLists.txt
index 821d857..8d893ab 100644
--- a/src/vist/client/CMakeLists.txt
+++ b/src/vist/client/CMakeLists.txt
@@ -12,7 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
-ADD_VIST_LIBRARY(vist_client query.cpp)
+ADD_VIST_LIBRARY(vist_client query.cpp
+							 virtual-table.cpp)
 
 FILE(GLOB CLIENT_TESTS "tests/*.cpp")
 ADD_VIST_TEST(${CLIENT_TESTS})
diff --git a/api/schema/processes.h b/src/vist/client/schema/processes.h
similarity index 100%
rename from api/schema/processes.h
rename to src/vist/client/schema/processes.h
diff --git a/api/schema/time.h b/src/vist/client/schema/time.h
similarity index 100%
rename from api/schema/time.h
rename to src/vist/client/schema/time.h
diff --git a/src/vist/property/tests/property_tests.cpp b/src/vist/client/tests/virtual_table_tests.cpp
similarity index 82%
rename from src/vist/property/tests/property_tests.cpp
rename to src/vist/client/tests/virtual_table_tests.cpp
index e505712..7e17835 100644
--- a/src/vist/property/tests/property_tests.cpp
+++ b/src/vist/client/tests/virtual_table_tests.cpp
@@ -18,20 +18,20 @@
 
 #include <osquery/logger.h>
 
-#include <property.h>
+#include "../virtual-table.h"
 
-#include <schema/time.h>
-#include <schema/processes.h>
+#include "../schema/time.h"
+#include "../schema/processes.h"
 
 using namespace osquery;
 using namespace vist;
 
-class PropertyTests : public testing::Test {};
+class VirtualTableTests : public testing::Test {};
 
-TEST_F(PropertyTests, property) {
+TEST_F(VirtualTableTests, time_row_at) {
 	Time result = { -1, -1, -1 };
 
-	Property<Time> time;
+	VirtualRow<Time> time;
 	result.hour = time.at(&Time::hour);
 	result.minutes = time.at(&Time::minutes);
 	result.seconds = time.at(&Time::seconds);
@@ -44,19 +44,19 @@ TEST_F(PropertyTests, property) {
 
 	/// Each query execution
 	LOG(INFO) << "[Test] time table:";
-	LOG(INFO) << "\t hour: " << Property<Time>().at(&Time::hour);
-	LOG(INFO) << "\t minutes: " << Property<Time>().at(&Time::minutes);
-	LOG(INFO) << "\t seconds: " <<  Property<Time>().at(&Time::seconds);
+	LOG(INFO) << "\t hour: " << VirtualRow<Time>().at(&Time::hour);
+	LOG(INFO) << "\t minutes: " << VirtualRow<Time>().at(&Time::minutes);
+	LOG(INFO) << "\t seconds: " <<  VirtualRow<Time>().at(&Time::seconds);
 
 	EXPECT_NE(result.hour, -1);
 	EXPECT_NE(result.minutes, -1);
 	EXPECT_NE(result.seconds, -1);
 }
 
-TEST_F(PropertyTests, propertyArrayOp) {
+TEST_F(VirtualTableTests, time_row_arry_op) {
 	Time result = { -1, -1, -1 };
 
-	Property<Time> time;
+	VirtualRow<Time> time;
 	result.hour = time[&Time::hour];
 	result.minutes = time[&Time::minutes];
 	result.seconds = time[&Time::seconds];
@@ -72,9 +72,9 @@ TEST_F(PropertyTests, propertyArrayOp) {
 	EXPECT_NE(result.seconds, -1);
 }
 
-TEST_F(PropertyTests, propertiesProcesses) {
+TEST_F(VirtualTableTests, processes_table) {
 	Processes result;
-	Properties<Processes> processes;
+	VirtualTable<Processes> processes;
 	EXPECT_TRUE(processes.size() > 0);
 
 	for(auto& p : processes) {
diff --git a/src/vist/property/property.cpp b/src/vist/client/virtual-table.cpp
similarity index 66%
rename from src/vist/property/property.cpp
rename to src/vist/client/virtual-table.cpp
index 094a952..3248306 100644
--- a/src/vist/property/property.cpp
+++ b/src/vist/client/virtual-table.cpp
@@ -14,17 +14,16 @@
  *  limitations under the License
  */
 /*
- * @file property.cpp
+ * @file virtual-table.cpp
  * @author Sangwan Kwon (sangwan.kwon@samsung.com)
- * @brief Implementation of Property
+ * @brief Implementation of virtual object
  */
 
-#include <property.h>
+#include "virtual-table.h"
+#include "query.h" 
 
-#include <schema/time.h>
-#include <schema/processes.h>
-
-#include "../service/vist.h"
+#include "schema/time.h"
+#include "schema/processes.h"
 
 #include <osquery/logger.h>
 
@@ -59,21 +58,21 @@ auto db = make_database("db", time, processes);
 namespace vist {
 
 template <typename T>
-Property<T>::Property()
+VirtualRow<T>::VirtualRow()
 {
-	auto results = Vist::Query(db.selectAll<T>());
+	auto results = Query::Execute(db.selectAll<T>());
 	if (results.size() > 0)
 		this->data = std::move(results[0]);
 }
 
 template <typename T>
-Property<T>::Property(KeyValuePair&& kvp) : data(std::move(kvp))
+VirtualRow<T>::VirtualRow(KeyValuePair&& kvp) : data(std::move(kvp))
 {
 }
 
 template <typename T>
 template<typename Struct, typename Member>
-Member Property<T>::at(Member Struct::* field) const
+Member VirtualRow<T>::at(Member Struct::* field) const
 {
 	if (this->data.size() == 0)
 		throw std::runtime_error("Data is not exist.");
@@ -103,32 +102,32 @@ Member Property<T>::at(Member Struct::* field) const
 
 template <typename T>
 template<typename Struct, typename Member>
-Member Property<T>::operator[](Member Struct::*field) const
+Member VirtualRow<T>::operator[](Member Struct::*field) const
 {
 	return this->at(field);
 }
 
 template <typename T>
-Properties<T>::Properties()
+VirtualTable<T>::VirtualTable()
 {
-	auto results = Vist::Query(db.selectAll<T>());
+	auto results = Query::Execute(db.selectAll<T>());
 	for (auto& r : results)
-		this->datas.emplace_back(Property<T>(std::move(r)));
+		this->dataset.emplace_back(VirtualRow<T>(std::move(r)));
 }
 
 /// Explicit instantiation
-template class Property<Time>;
-template class Properties<Time>;
-template int Property<Time>::at(int Time::*) const;
-template int Property<Time>::operator[](int Time::*) const;
-
-template class Property<Processes>;
-template class Properties<Processes>;
-template int Property<Processes>::at(int Processes::*) const;
-template int Property<Processes>::operator[](int Processes::*) const;
-template long long int Property<Processes>::at(long long int Processes::*) const;
-template long long int Property<Processes>::operator[](long long int Processes::*) const;
-template std::string Property<Processes>::at(std::string Processes::*) const;
-template std::string Property<Processes>::operator[](std::string Processes::*) const;
+template class VirtualTable<Time>;
+template class VirtualRow<Time>;
+template int VirtualRow<Time>::at(int Time::*) const;
+template int VirtualRow<Time>::operator[](int Time::*) const;
+
+template class VirtualTable<Processes>;
+template class VirtualRow<Processes>;
+template int VirtualRow<Processes>::at(int Processes::*) const;
+template int VirtualRow<Processes>::operator[](int Processes::*) const;
+template long long int VirtualRow<Processes>::at(long long int Processes::*) const;
+template long long int VirtualRow<Processes>::operator[](long long int Processes::*) const;
+template std::string VirtualRow<Processes>::at(std::string Processes::*) const;
+template std::string VirtualRow<Processes>::operator[](std::string Processes::*) const;
 
 } // namespace vist
diff --git a/api/property.h b/src/vist/client/virtual-table.h
similarity index 65%
rename from api/property.h
rename to src/vist/client/virtual-table.h
index 373102e..e6da834 100644
--- a/api/property.h
+++ b/src/vist/client/virtual-table.h
@@ -14,13 +14,6 @@
  *  limitations under the License
  */
 
-
-/**
- * @file property.h
- * @brief Provides type-safe getter method
- */
-
-
 #pragma once
 
 #include <map>
@@ -30,14 +23,13 @@
 
 namespace vist {
 
-/// TBD: Consider error handling.
 template <typename T>
-class Property {
+class VirtualRow final {
 public:
 	using KeyValuePair = std::map<std::string, std::string>;
 
-	explicit Property();
-	explicit Property(KeyValuePair&&);
+	explicit VirtualRow();
+	explicit VirtualRow(KeyValuePair&&);
 
 	template<typename Struct, typename Member>
 	Member at(Member Struct::*) const;
@@ -53,23 +45,23 @@ private:
 
 
 template <typename T>
-class Properties {
+class VirtualTable final {
 public:
-	explicit Properties();
+	explicit VirtualTable();
 
 	/// Make iteratable
-	using Iter = typename std::vector<Property<T>>::iterator;
-	using CIter = typename std::vector<Property<T>>::const_iterator;
+	using Iter = typename std::vector<VirtualRow<T>>::iterator;
+	using CIter = typename std::vector<VirtualRow<T>>::const_iterator;
 
-	inline Iter begin() { return datas.begin(); }
-	inline CIter begin() const { return datas.cbegin(); }
-	inline Iter end() { return datas.end(); }
-	inline CIter end() const { return datas.end(); }
+	inline Iter begin() { return dataset.begin(); }
+	inline CIter begin() const { return dataset.cbegin(); }
+	inline Iter end() { return dataset.end(); }
+	inline CIter end() const { return dataset.end(); }
 
-	inline std::size_t size() const { return datas.size(); }
+	inline std::size_t size() const { return dataset.size(); }
 
 private:
-	std::vector<Property<T>> datas;
+	std::vector<VirtualRow<T>> dataset;
 };
 
 } // namespace vist
diff --git a/src/vist/property/CMakeLists.txt b/src/vist/property/CMakeLists.txt
deleted file mode 100644
index e216823..0000000
--- a/src/vist/property/CMakeLists.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-#  Copyright (c) 2019 Samsung Electronics Co., Ltd 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
-
-ADD_VIST_LIBRARY(property property.cpp)
-
-FILE(GLOB PROPERTY_TESTS "tests/*.cpp")
-ADD_VIST_TEST(${PROPERTY_TESTS})