appoptics_apm 4.12.2 → 4.13.0

data/ext/oboe_metal/test/CMakeLists.txt

@@ -0,0 +1,53 @@
+cmake_minimum_required(VERSION 3.13)
+project(test)
+
+ # specify the C++ standard
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+# set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR} ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_LIST_DIR}/FindGMock.cmake)
+
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip
+#  URL https://github.com/google/googletest/archive/refs/tags/release-1.11.0.zip
+)
+
+# For Windows: Prevent overriding the parent project's compiler/linker settings
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(googletest)
+
+include_directories(
+  ${gtest_SOURCE_DIR}/include
+  ../src/
+  $ENV{RUBY_INC_DIR}
+  $ENV{RUBY_INC_DIR}/x86_64-linux/
+)
+
+link_directories(
+#  /usr/lib/
+  $ENV{RUBY_PREFIX}/lib/
+  ../../../lib/
+  ../lib
+)
+
+enable_testing()
+set (sources
+  test_main.cc
+  frames_test.cc
+  profiling_test.cc
+)
+
+## Link runTests with what we want to test and the GTest and pthread library
+add_executable(runTests ${sources})
+target_link_libraries(runTests
+#  ${GTEST_LIBRARIES}
+  gtest
+  appoptics_apm.so
+  liboboe.so
+  libruby.so
+  pthread
+)
+
+include(GoogleTest)
+gtest_discover_tests(runTests)

data/ext/oboe_metal/test/FindGMock.cmake

@@ -0,0 +1,43 @@
+# This content copied from
+# https://git.simply-life.net/simply-life.net/talltower/-/blob/639293a366da43eb94a72d2e7596242314c9809c/cmake/FindGMock.cmake
+
+
+# Try to find GMock
+find_package(GTest)
+
+# the following issues a warning, but it works nonetheless
+find_package(PkgConfig)
+pkg_check_modules(PC_GMOCK QUIET gmock)
+set(GMOCK_DEFINITIONS ${PC_GMOCK_CFLAGS_OTHER})
+
+find_path(GMOCK_INCLUDE_DIR gmock.h
+          HINTS ${PC_GMOCK_INCLUDEDIR} ${PC_GMOCK_INCLUDE_DIRS}
+          PATH_SUFFIXES gmock)
+
+find_library(GMOCK_LIBRARY NAMES gmock libgmock
+             HINTS ${PC_GMOCK_LIBDIR} ${PC_GMOCK_LIBRARY_DIRS} )
+
+find_library(GMOCK_MAIN_LIBRARY NAMES gmock_main libgmock_main
+             HINTS ${PC_GMOCK_LIBDIR} ${PC_GMOCK_LIBRARY_DIRS} )
+
+include(FindPackageHandleStandardArgs)
+# handle the QUIETLY and REQUIRED arguments and set GMOCK_FOUND to TRUE
+# if all listed variables are TRUE
+find_package_handle_standard_args(GMock DEFAULT_MSG
+                                  GMOCK_LIBRARY GMOCK_INCLUDE_DIR GTEST_FOUND)
+
+mark_as_advanced(GMOCK_INCLUDE_DIR GMOCK_LIBRARY GMOCK_MAIN_LIBRARY)
+
+set(GMOCK_LIBRARIES ${GMOCK_LIBRARY} )
+set(GMOCK_INCLUDE_DIRS ${GMOCK_INCLUDE_DIR} )
+set(GMOCK_MAIN_LIBRARIES ${GMOCK_MAIN_LIBRARY} )
+
+if (NOT TARGET GMock)
+    add_library(GMock IMPORTED SHARED)
+    set_property(TARGET GMock PROPERTY IMPORTED_LOCATION ${GMOCK_LIBRARY})
+    set_property(TARGET GMock PROPERTY INTERFACE_INCLUDE_DIRECTORY ${GMOCK_INCLUDE_DIR})
+
+    add_library(GMockMain IMPORTED SHARED)
+    set_property(TARGET GMockMain PROPERTY IMPORTED_LOCATION ${GMOCK_MAIN_LIBRARY})
+    set_property(TARGET GMockMain PROPERTY INTERFACE_LINK_LIBRARIES GMock GTest)
+endif()

data/ext/oboe_metal/test/README.md

@@ -0,0 +1,56 @@
+C-code tests:
+
+CMakeLists.txt includes downloading and compiling googletest if necessary
+
+In the ext/oboe_metal/test directory:
+
+Set an environment variable for the current path:
+```
+export TEST_DIR=`pwd`
+```
+
+Every time the ruby version changes the appoptics_apm gem needs to be 
+re-installed or its c++-code recompiled and relinked
+
+These environment variables need to be set every time the ruby version is set:
+```
+export RUBY_INC_DIR=$(ruby ruby_inc_dir.rb)
+export RUBY_PREFIX=$(ruby ruby_prefix.rb)
+```
+
+create the Makefile (needs to be remade when the ruby version changes)
+```
+cmake -S . -B build
+```
+build
+```
+cmake --build build
+```
+run 
+```
+cd build && ctest && cd -
+```
+
+Most testing of profiling is done via Ruby integration tests
+
+For example logging is tested in Ruby tests that verify the different
+KVs and values in the resulting traces, using the same approach as 
+for traces without profiling.
+
+Gotchas:
+ 
+- In alpine the `ruby/config.h` file is in an architecture specific folder and needs 
+  to be symlinked to the location set via RUBY_INC_DIR (see: Dockerfile_alpine)
+  
+TODO:
+
+- write a script for this
+
+```
+export TEST_DIR=`pwd`
+export RUBY_INC_DIR=$(ruby ruby_inc_dir.rb)
+export RUBY_PREFIX=$(ruby ruby_prefix.rb)
+cmake -S . -B build
+cmake --build build
+cd build && ctest && cd -
+```

data/ext/oboe_metal/test/frames_test.cc

@@ -0,0 +1,164 @@
+
+
+#include <string.h>
+
+#include <algorithm>
+
+#include "../src/profiling.h"
+#include "../src/frames.h"
+#include "gtest/gtest.h"
+#include "ruby/debug.h"
+#include "ruby/ruby.h"
+#include "test.h"
+
+extern unordered_map<VALUE, FrameData> cached_frames;
+
+static VALUE test_frames[BUF_SIZE];
+static int test_lines[BUF_SIZE];
+int test_num;
+
+static int ruby_version;
+
+VALUE RubyCallsFrames::c_get_frames() {
+    test_num = rb_profile_frames(1, sizeof(test_frames) / sizeof(VALUE), test_frames, test_lines);
+    return Qnil;
+}
+
+void Init_RubyCallsFrames() {
+    static VALUE cTest = rb_define_module("RubyCalls");
+    rb_define_singleton_method(cTest, "get_frames", reinterpret_cast<VALUE (*)(...)>(RubyCallsFrames::c_get_frames), 0);
+
+    VALUE result;
+    result = rb_eval_string("RUBY_VERSION[0].to_i");
+    ruby_version = NUM2INT(result);
+};
+
+TEST(Frames, reserve_cached_frames) {
+    // it should only reserve once used during init
+    // unordered_map grows automatically
+    cached_frames.clear();
+
+    Frames::reserve_cached_frames();
+    int bucket_count = cached_frames.bucket_count();
+
+    Frames::reserve_cached_frames();
+    EXPECT_EQ(bucket_count, cached_frames.bucket_count());
+}
+
+TEST(Frames, collect_frame_data) {
+    rb_eval_string("TestMe::Snapshot::all_kinds");
+
+    int num = Frames::remove_garbage(test_frames, test_num);
+
+    vector<FrameData> data;
+    // Ruby 3 reports a <cfunc>, before the "take_snapshot" method
+    // we have to adjust the index of the trace we are checking
+    int i = ruby_version == 2 ? 0 : 1;
+    Frames::collect_frame_data(test_frames, i + 1, data);
+
+    EXPECT_EQ("take_snapshot", data[i].method) << "method name incorrect";
+    EXPECT_EQ("TestMe::Snapshot", data[i].klass) << "klass name incorrect";
+    std::size_t found = data[i].file.find("ext/oboe_metal/test/ruby_test_helper.rb");
+    EXPECT_EQ(data[i].file.length() - 39, found)
+        << "filename incorrect " << found << " " << data[i].file.length();
+    EXPECT_EQ(7, data[i].lineno) << "line number incorrect";
+}
+
+TEST(Frames, remove_garbage) {
+    // run some Ruby code and get a snapshot
+    rb_eval_string("TestMe::Snapshot::all_kinds");
+
+    int num = Frames::remove_garbage(test_frames, test_num);
+
+    int expected = (ruby_version == 2) ? 7 : 9;
+    EXPECT_EQ(expected, num)
+        << "wrong number of expected frames after remove_garbage";
+    // check no lineno 0 frame at top
+    VALUE val;
+    int i = (ruby_version == 2) ? 0 : 1;
+    val = rb_profile_frame_first_lineno(test_frames[i]);  // returns line number
+    if (RB_TYPE_P(val, T_FIXNUM)) {
+        EXPECT_NE(0, NUM2INT(val))
+            << "the frame with linenumber 0 was not removed";
+    } else {
+        EXPECT_TRUE(false) << " ************ line number not an int **********";
+    }
+    // check no repeated frames
+    for (i = 0; i < num; i++)
+        for (int j = i + 1; j < num; j++)
+            EXPECT_NE(test_frames[i], test_frames[j])
+                << "not all repeated frames were removed";
+}
+
+TEST(Frames, num_matching) {
+    VALUE a[BUF_SIZE];
+    VALUE b[BUF_SIZE];
+
+    int a_num = 0;
+    int b_num = 0;
+    EXPECT_EQ(0, Frames::num_matching(a, a_num, b, b_num))
+        << "* empty frames array should have 0 matches";
+
+    a[0] = (VALUE)11;
+    a[1] = (VALUE)12;
+    a[2] = (VALUE)13;
+    b[0] = (VALUE)11;
+    b[1] = (VALUE)12;
+    b[2] = (VALUE)13;
+    a_num = 3;
+    b_num = 3;
+    EXPECT_EQ(3, Frames::num_matching(a, a_num, b, b_num))
+        << "* equal frames array should have matched";
+
+    b[1] = (VALUE)222;
+    EXPECT_EQ(1, Frames::num_matching(a, a_num, b, b_num))
+        << "* only one should match for same length but different content";
+
+    b[1] = (VALUE)12;
+    a[3] = 14;
+    a_num = 4;
+    EXPECT_EQ(0, Frames::num_matching(a, a_num, b, b_num))
+        << "* different length, frames NOT matching from the end";
+
+    a[0] = 10;
+    a[1] = 11;
+    a[2] = 12;
+    a[3] = 13;
+    EXPECT_EQ(3, Frames::num_matching(a, a_num, b, b_num))
+        << "* different length, frames matching from the end";
+
+    b[0] = (VALUE)18;
+    b[1] = (VALUE)19;
+    b[2] = (VALUE)11;
+    b[3] = (VALUE)12;
+    b[4] = (VALUE)13;
+    b_num = 5;
+
+    EXPECT_EQ(3, Frames::num_matching(a, a_num, b, b_num))
+        << "* different length, frames matching from the end";
+}
+
+TEST(Frames, cached_frames) {
+    cached_frames.clear();
+    // run some Ruby code and get a snapshot
+    rb_eval_string("TestMe::Snapshot::all_kinds");
+
+    Frames::remove_garbage(test_frames, test_num);
+
+    // Check the expected size
+    int expected = (ruby_version == 2) ? 8 : 10;
+    EXPECT_EQ(expected, cached_frames.size());
+
+    // check that each frame is cached
+    for (int i = 0; i < test_num; i++)
+        EXPECT_EQ(1, cached_frames.count(test_frames[i]));
+
+    // repeat
+    rb_eval_string("TestMe::Snapshot::all_kinds");
+    Frames::remove_garbage(test_frames, test_num);
+
+    expected = (ruby_version == 2) ? 9 : 11;
+    EXPECT_EQ(expected, cached_frames.size());  // +1 for an extra main frame
+    for (int i = 0; i < test_num; i++)
+        EXPECT_EQ(1, cached_frames.count(test_frames[i]));
+}

data/ext/oboe_metal/test/profiling_test.cc

@@ -0,0 +1,93 @@
+
+#include "../src/frames.h"
+
+#include <string.h>
+
+#include <algorithm>
+#include <thread>
+#include <array>
+
+#include "../src/profiling.h"
+#include "gtest/gtest.h"
+#include "ruby/debug.h"
+#include "ruby/ruby.h"
+#include "test.h"
+
+extern atomic_bool profiling_shut_down;
+// extern oboe_reporter_t *cur_reporter;
+
+// FIXME how can I access profiling_shut_down ?
+TEST(Profiling, try_catch_shutdown) {
+    EXPECT_FALSE(profiling_shut_down);
+
+    int result;
+    result = Profiling::try_catch_shutdown([] {
+        // provoke exception
+        std::string ().replace (100, 1, 1, 'c');
+        return 0;
+    }, "Profiling::try_catch()");
+
+    EXPECT_NE(0, result);
+    EXPECT_TRUE(profiling_shut_down); 
+
+    // reset global var
+    profiling_shut_down = false;
+}
+
+TEST(Profiling, oboe_0_profiling) {
+    atomic_bool atomic_a1{true};
+    atomic_bool atomic_a2{false};
+
+    atomic_bool running;
+
+    cout << running << endl;
+    cout << running.exchange(true) << endl;
+    cout << running.exchange(true) << endl;
+
+    // cout << "prev val " << atomic_a2.exchange(false) << endl;
+    // cout << atomic_a2 << endl;
+    // cout << "prev val " <<  atomic_a2.exchange(true) << endl;
+    // cout << atomic_a2 << endl;
+    // cout << "prev val " <<  atomic_a2.exchange(true) << endl;
+    // cout << atomic_a2 << endl;
+    // cout << "prev val " <<  atomic_a2.exchange(false) << endl;
+    // cout << atomic_a2 << endl;
+
+
+
+    // static bool b1{true};
+    // static bool b2{false};
+
+    // array<thread, 4> threads;
+
+    // for (auto& t : threads) {
+    //     t = thread([] { Profiling::profiler_signal_handler(0, NULL, NULL); });
+    // }
+
+    // cout << "waiting..." << endl;
+
+    // for (auto& t : threads) {
+    //     t.join();
+    // }
+
+    // cout << "Done." << endl;
+
+
+    // cout << atomic_a1 << ", " << b1 << endl;
+    // cout << atomic_a1 << ", " << b1 << ", " << atomic_a1.compare_exchange_weak(b1, false) << endl;
+    // cout << atomic_a1 << ", " << b1 << endl;
+    // cout << atomic_a2 << ", " << b2 << endl;
+    // cout << atomic_a2 << ", " << b2 << ", " << atomic_a2.compare_exchange_weak(b2, true) << endl;
+    // cout << atomic_a2 << ", " << b2 << endl;
+    // cout << endl;
+
+    // cout << atomic_a1 << ", " << b1 << endl;
+    // cout << atomic_a1 << ", " << b1 << ", " << atomic_a1.compare_exchange_weak(b1, false) << endl;
+    // cout << atomic_a1 << ", " << b1 << endl;
+    // cout << atomic_a2 << ", " << b2 << endl;
+    // cout << atomic_a2 << ", " << b2 << ", " << atomic_a2.compare_exchange_weak(b2, true) << endl;
+    // cout << atomic_a2 << ", " << b2 << endl;
+    // cout << endl;
+    
+     
+}

data/ext/oboe_metal/test/ruby_inc_dir.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2021 SolarWinds, LLC.
+# All rights reserved.
+
+require 'mkmf'
+puts $topdir
+

data/ext/oboe_metal/test/ruby_prefix.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2021 SolarWinds, LLC.
+# All rights reserved.
+
+require 'mkmf'
+puts CONFIG["prefix"]
+

data/ext/oboe_metal/test/ruby_test_helper.rb

@@ -0,0 +1,67 @@
+class TestMe
+  class Snapshot
+
+    class << self
+      # !!! do not shift the definition of take_snapshot from line 7 !!!
+      # the line number is used to verify a test in frames_test.cc
+      def take_snapshot
+        # puts "getting frames ...."
+        begin
+          ::RubyCalls::get_frames
+        rescue => e
+          puts "oops, getting frames didn't work"
+          puts e
+        end
+      end
+
+      def all_kinds
+        begin
+          Teddy.new.sing do
+            take_snapshot
+          end
+        rescue => e
+          puts "Ruby call did not work"
+          puts e
+        end
+      end
+    end
+  end
+
+  class Teddy
+
+    attr_accessor :name
+
+    def sing
+      3.times do
+        yodel do
+          html_wrap("title", "Hello") { |_html| yield }
+        end
+      end
+    end
+
+    private
+
+    def yodel
+      a_proc = -> (x) { x * x;  yield }
+      in_block(&a_proc)
+    end
+
+    def in_block(&block)
+      begin
+        yield 7
+        # puts "block called!"
+      rescue => e
+        puts "no, this should never happen"
+        puts e
+      end
+    end
+
+    def html_wrap(tag, text)
+      html = "<#{tag}>#{text}</#{tag}>"
+      yield html
+    end
+
+  end
+end
+
+