libddprof 0.2.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7d6f24e3511e2560edb611e06fae670921fcbcda86eeaf4475b6432c17d395a
+  data.tar.gz: 270084987103083b79fb0ad99bd15b64bfa44351460e0b43ce504ea7d7e94890
+SHA512:
+  metadata.gz: 89aa189f92a623a51785c098e4358f97ec8b955e22dc0c008afb6eaf9388cce6559acc9390986252da1fab23058ee47803a15d078b00c68b872dd07bd7253483
+  data.tar.gz: d8309cfec327b55f159c13a76e8ff32b18040720a545e6496270472145db54a089506183d362264a07cdc211d31f53ed3af630896411bb5d95d2df22a7fcc058

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.1

data/Rakefile

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake" unless RUBY_VERSION < "2.5"
+
+require "fileutils"
+require "http"
+require "pry"
+require "rubygems/package"
+
+RSpec::Core::RakeTask.new(:spec)
+
+LIB_GITHUB_RELEASES = {
+  "0.2.0" => [
+    {
+      file: "libddprof-x86_64-unknown-linux-gnu.tar.gz",
+      sha256: "cba0f24074d44781d7252b912faff50d330957e84a8f40a172a8138e81001f27",
+      ruby_platform: "x86_64-linux"
+    },
+    {
+      file: "libddprof-x86_64-alpine-linux-musl.tar.gz",
+      sha256: "d519a6241d78260522624b8e79e98502510f11d5d9551f5f80fc1134e95fa146",
+      ruby_platform: "x86_64-linux-musl"
+    }
+  ]
+  # Add more versions here
+}
+
+task default: [
+  :spec,
+  (:'standard:fix' unless RUBY_VERSION < "2.5")
+].compact
+
+desc "Download lib release from github"
+task :fetch do
+  Helpers.each_github_release_variant do |file:, sha256:, target_directory:, target_file:, **_|
+    target_url = "https://github.com/DataDog/libddprof/releases/download/v#{Libddprof::LIB_VERSION}/#{file}"
+
+    if File.exist?(target_file)
+      if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
+        puts "Found #{target_file} matching the expected sha256, skipping download"
+        next
+      else
+        puts "Found #{target_file} BUT IT DID NOT MATCH THE EXPECTED sha256, skipping download"
+      end
+    end
+
+    puts "Going to download #{target_url} into #{target_file}"
+
+    File.open(target_file, "wb") do |file|
+      HTTP.follow.get(target_url).body.each { |chunk| file.write(chunk) }
+    end
+
+    if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
+      puts "Success!"
+    else
+      raise "Downloaded file is corrupt, does not match expected sha256"
+    end
+  end
+end
+
+desc "Extract lib downloaded releases"
+task extract: [:fetch] do
+  Helpers.each_github_release_variant do |target_directory:, target_file:, **_|
+    puts "Extracting #{target_file}"
+    File.open(target_file, "rb") do |file|
+      Gem::Package.new("").extract_tar_gz(file, target_directory)
+    end
+  end
+end
+
+desc "Package lib downloaded releases as gems"
+task package: [:extract] do
+  gemspec = eval(File.read("libddprof.gemspec"), nil, "libddprof.gemspec") # standard:disable Security/Eval
+  FileUtils.mkdir_p("pkg")
+
+  Helpers.package_without_binaries(gemspec)
+  Helpers.package_linux_x86_64(gemspec)
+end
+
+desc "Release all packaged gems"
+task package: [
+  :package,
+  :'release:guard_clean',
+] do
+
+end
+
+module Helpers
+  def self.each_github_release_variant(version: Libddprof::LIB_VERSION)
+    LIB_GITHUB_RELEASES.fetch(version).each do |file:, sha256:, ruby_platform:|
+      # These two are so common that we just centralize them here
+      target_directory = "vendor/libddprof-#{version}/#{ruby_platform}"
+      target_file = "#{target_directory}/#{file}"
+
+      FileUtils.mkdir_p(target_directory)
+
+      yield(file: file, sha256: sha256, ruby_platform: ruby_platform, target_directory: target_directory, target_file: target_file)
+    end
+  end
+
+  def self.package_without_binaries(gemspec)
+    target_gemspec = gemspec.dup
+
+    puts "Building a variant without binaries including: (this can take a while)"
+    pp target_gemspec.files
+
+    package = Gem::Package.build(target_gemspec)
+    FileUtils.mv(package, "pkg")
+    puts("-" * 80)
+  end
+
+  def self.package_linux_x86_64(gemspec)
+    # We include both glibc and musl variants in the same binary gem to avoid the issues
+    # documented in https://github.com/rubygems/rubygems/issues/3174
+    target_gemspec = gemspec.dup
+    target_gemspec.files += files_for("x86_64-linux", "x86_64-linux-musl")
+    target_gemspec.platform = "x86_64-linux"
+
+    puts "Building for x86_64-linux including:"
+    pp target_gemspec.files
+
+    package = Gem::Package.build(target_gemspec)
+    FileUtils.mv(package, "pkg")
+    puts("-" * 80)
+  end
+
+  def self.files_for(*included_platforms, version: Libddprof::LIB_VERSION)
+    files = []
+
+    each_github_release_variant(version: version) do |ruby_platform:, target_directory:, target_file:, **_|
+      next unless included_platforms.include?(ruby_platform)
+
+      files += Dir.glob("#{target_directory}/**/*").select { |path| File.file?(path) } - [target_file]
+    end
+
+    files
+  end
+end

data/gems.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in libddprof.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "standard", "~> 1.3" unless RUBY_VERSION < "2.5"
+gem "http", "~> 5.0"
+gem "pry"

data/lib/libddprof/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Libddprof
+  # Current libddprof version
+  LIB_VERSION = "0.2.0"
+
+  # This is the Ruby gem version -- often it will match LIB_VERSION, but sometimes it may not
+  VERSION = "#{LIB_VERSION}.beta1"
+end

data/lib/libddprof.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "libddprof/version"
+
+module Libddprof
+  # Is this a no-op libddprof release without binaries?
+  def self.no_binaries?
+    available_binaries.empty?
+  end
+
+  def self.available_binaries
+    Dir.children(vendor_directory)
+  end
+
+  def self.pkgconfig_folder
+    current_platform = Gem::Platform.local.to_s
+
+    return unless available_binaries.include?(current_platform)
+
+    pkgconfig_file = Dir.glob("#{vendor_directory}/#{current_platform}/**/ddprof_ffi.pc").first
+
+    return unless pkgconfig_file
+
+    File.absolute_path(File.dirname(pkgconfig_file))
+  end
+
+  private_class_method def self.vendor_directory
+    ENV["LIBDDPROF_VENDOR_OVERRIDE"] || "#{__dir__}/../vendor/libddprof-#{Libddprof::LIB_VERSION}/"
+  end
+end

data/libddprof.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "libddprof/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "libddprof"
+  spec.version = Libddprof::VERSION
+  spec.authors = ["Datadog, Inc."]
+  spec.email = ["dev@datadoghq.com"]
+
+  spec.summary = "Library of common code used by Datadog Continuous Profiler for Ruby"
+  spec.description =
+    "libddprof contains implementation bits used by Datadog's ddtrace gem as part of its Continuous Profiler feature."
+  spec.homepage = "https://docs.datadoghq.com/tracing/profiler/"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DataDog/libddprof/tree/main/ruby"
+
+  # Require releases on rubygems.org to be coming from multi-factor-auth-authenticated accounts
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: libddprof
+version: !ruby/object:Gem::Version
+  version: 0.2.0.beta1
+platform: ruby
+authors:
+- Datadog, Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-01 00:00:00.000000000 Z
+dependencies: []
+description: libddprof contains implementation bits used by Datadog's ddtrace gem
+  as part of its Continuous Profiler feature.
+email:
+- dev@datadoghq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Rakefile
+- gems.rb
+- lib/libddprof.rb
+- lib/libddprof/version.rb
+- libddprof.gemspec
+homepage: https://docs.datadoghq.com/tracing/profiler/
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://docs.datadoghq.com/tracing/profiler/
+  source_code_uri: https://github.com/DataDog/libddprof/tree/main/ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Library of common code used by Datadog Continuous Profiler for Ruby
+test_files: []