feat: Initiated benchmark workflow (#114)

* feat: Added benchmarking Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * feat: Added build test option Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * fix: removed overhead Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * feat: added GitHub Actions for benchmark Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * fix: Updated to Release config Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * fix: updated CopyRight Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in> * fix: Added 2021 copyright Signed-off-by: Yash Pandey (YP) <yash.btech.cs19@iiitranchi.ac.in>
casbin · Jun 30, 2021 · 617ba26 · 617ba26
1 parent 0cd1fc5
commit 617ba26
Show file tree

Hide file tree

Showing 24 changed files with 224 additions and 26 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -0,0 +1,43 @@
+#  Copyright 2021 The casbin Authors. 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.
+
+name: Benchmark
+
+on: [push, pull_request]
+
+jobs:
+  benchmark:
+    name: Benchmark
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v2
+      - name: Configuring CMake files
+        id: building-files
+        run: |
+          mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE:STRING=Release
+      - name: Building library
+        id: building-lib
+        run: |
+          cd build && cmake --build . --config Release --target all -j 10 --
+      - name: Run Benchmark
+        id: run-benchmark
+        run: |
+          cd ./build/tests/benchmarks
+          ./casbin_benchmark
+      - name: Cleanup
+        id: clean-up
+        run: |
+          rm -r build
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-#  Copyright 2020 The casbin Authors. All Rights Reserved.
+#  Copyright 2021 The casbin Authors. 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.
@@ -11,7 +11,6 @@
 #  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.
-#
 
 name: CI
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -48,12 +48,18 @@ endif()
 ###############################################################################
 # Global CMake options.
 
+option(CASBIN_BUILD_TEST "State whether to build test" ON)
+option(CASBIN_BUILD_BENCHMARK "State whether to build benchmarks" ON)
+
 # Do not output install messages.
 if(NOT DEFINED CMAKE_INSTALL_MESSAGE)
     set(CMAKE_INSTALL_MESSAGE "NEVER")
 endif()
 
-enable_testing()
+if(CASBIN_BUILD_TEST)
+    enable_testing()
+endif()
+
 add_subdirectory(tests)
 
 # Change the path max size to avoid problem on Windows.

diff --git a/README.md b/README.md
@@ -192,6 +192,7 @@ https://casbin.org/docs/en/tutorials
 Here's the summary:
 ```cpp
 #include <casbin/casbin.h>
+#include <string>
 
 void IsAuthorized() {
     casbin::Enforcer e("./path/to/model.conf", "./path/to/policy.csv");

diff --git a/casbin/CMakeLists.txt b/casbin/CMakeLists.txt
@@ -1,4 +1,4 @@
-#  Copyright 2020 The casbin Authors. All Rights Reserved.
+#  Copyright 2021 The casbin Authors. 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.

diff --git a/cmake/modules/FindExtPackages.cmake b/cmake/modules/FindExtPackages.cmake
@@ -1,3 +1,17 @@
+#  Copyright 2021 The casbin Authors. 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.
+
 ###############################################################################
 ### Global package options ###
 
@@ -13,3 +27,9 @@ set(CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY ON CACHE BOOL
 # googletest
 # https://github.com/google/googletest
 find_package(googletest 1.11.0 REQUIRED)
+
+if(CASBIN_BUILD_BENCHMARK)
+    # benchmark
+    # https://github.com/google/benchmark
+    find_package(benchmark 1.5.5 REQUIRED)
+endif()
diff --git a/cmake/modules/Findbenchmark.cmake b/cmake/modules/Findbenchmark.cmake
@@ -0,0 +1,23 @@
+#  Copyright 2021 The casbin Authors. 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.
+
+include(FetchContent)
+
+FetchContent_Declare(
+  benchmark
+  URL https://github.com/google/benchmark/archive/refs/tags/v1.5.5.zip
+)
+
+set(BENCHMARK_ENABLE_TESTING OFF)
+FetchContent_MakeAvailable(benchmark)
diff --git a/cmake/modules/Findgoogletest.cmake b/cmake/modules/Findgoogletest.cmake
@@ -1,3 +1,17 @@
+#  Copyright 2021 The casbin Authors. 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.
+
 include(FetchContent)
 FetchContent_Declare(
   googletest

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,4 +1,4 @@
-#  Copyright 2020 The casbin Authors. All Rights Reserved.
+#  Copyright 2021 The casbin Authors. 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.
@@ -12,7 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-set(CMAKE_CXX_STANDARD 17)
+if(CASBIN_BUILD_TEST)
+  set(CMAKE_CXX_STANDARD 17)
 
 add_executable(
   casbintest
@@ -30,13 +31,18 @@ add_executable(
   util_test.cpp
 )
 
-target_include_directories(casbintest PUBLIC ${CMAKE_SOURCE_DIR})
+  target_include_directories(casbintest PUBLIC ${CMAKE_SOURCE_DIR})
 
-target_link_libraries(
-  casbintest
-  gtest_main
-  casbin
-)
+  target_link_libraries(
+    casbintest
+    gtest_main
+    casbin
+  )
+
+  include(GoogleTest)
+  gtest_discover_tests(casbintest)
+endif()
 
-include(GoogleTest)
-gtest_discover_tests(casbintest)
+if(CASBIN_BUILD_BENCHMARK)
+  add_subdirectory(benchmarks)
+endif()
diff --git a/tests/benchmarks/CMakeLists.txt b/tests/benchmarks/CMakeLists.txt
@@ -0,0 +1,26 @@
+#  Copyright 2021 The casbin Authors. 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_executable(casbin_benchmark
+    main.cpp
+    enforcer_cached_b.cpp
+)
+
+target_include_directories(casbin_benchmark PUBLIC ${CMAKE_SOURCE_DIR})
+
+target_link_libraries(
+    casbin_benchmark
+    benchmark
+    casbin
+)
diff --git a/tests/benchmarks/enforcer_cached_b.cpp b/tests/benchmarks/enforcer_cached_b.cpp
@@ -0,0 +1,39 @@
+/*
+* Copyright 2021 The casbin Authors. 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.
+*
+* This is a test file for benchmarking the performance of casbin::CachedEnforcer
+*/
+
+#include <benchmark/benchmark.h>
+#include <casbin/casbin.h>
+
+static void BenchmarkCachedBasicModel(benchmark::State& state) {
+    casbin::CachedEnforcer e("../../../examples/basic_model.conf", "../../../examples/basic_policy.csv");
+    std::vector<std::string> request = {"alice", "data1", "read"};
+    for (auto _ : state)
+        e.Enforce(request);
+}
+
+BENCHMARK(BenchmarkCachedBasicModel);
+
+
+static void BenchmarkCachedRBACModel(benchmark::State& state) {
+    casbin::CachedEnforcer e("../../../examples/rbac_model.conf", "../../../examples/rbac_policy.csv");
+    std::vector<std::string> request = {"alice", "data2", "read"};
+    for (auto _ : state)
+        e.Enforce(request);
+}
+
+BENCHMARK(BenchmarkCachedRBACModel);
diff --git a/tests/benchmarks/main.cpp b/tests/benchmarks/main.cpp
@@ -0,0 +1,21 @@
+/*
+* Copyright 2021 The casbin Authors. 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.
+*
+* This is the main file that provides entry point to the entire benchmarking workflow
+*/
+
+#include <benchmark/benchmark.h>
+
+BENCHMARK_MAIN();
diff --git a/tests/built_in_functions_test.cpp b/tests/built_in_functions_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/config_test.cpp b/tests/config_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/enforcer_cached_test.cpp b/tests/enforcer_cached_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/enforcer_synced_test.cpp b/tests/enforcer_synced_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/enforcer_test.cpp b/tests/enforcer_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/management_api_test.cpp b/tests/management_api_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/model_enforcer_test.cpp b/tests/model_enforcer_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/model_test.cpp b/tests/model_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/rbac_api_test.cpp b/tests/rbac_api_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/rbac_api_with_domains_test.cpp b/tests/rbac_api_with_domains_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/role_manager_test.cpp b/tests/role_manager_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.

diff --git a/tests/util_test.cpp b/tests/util_test.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright 2020 The casbin Authors. All Rights Reserved.
+* Copyright 2021 The casbin Authors. 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.