-
Notifications
You must be signed in to change notification settings - Fork 374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add supported versions workflow #4210
base: master
Are you sure you want to change the base?
Changes from 6 commits
3f4560a
1980b6f
1b2986e
5bee321
b2818a9
53b807f
df5640a
2b15400
112db1f
3b5aae2
4ada6cf
b4526e2
d44249b
514be2c
65aee38
6fb1de7
3b8cff4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
require 'pathname' | ||
require 'rubygems' | ||
require 'json' | ||
|
||
def parse_gemfiles(directory = 'gemfiles/') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing |
||
minimum_gems_ruby = {} | ||
minimum_gems_jruby = {} | ||
maximum_gems_ruby = {} | ||
maximum_gems_jruby = {} | ||
|
||
|
||
gemfiles = Dir.glob(File.join(directory, '*')) | ||
gemfiles.each do |gemfile_name| | ||
runtime = File.basename(gemfile_name).split('_').first # ruby or jruby | ||
File.foreach(gemfile_name) do |line| | ||
if (gem_details = parse_gemfile_entry(line)) | ||
gem_name, version = gem_details | ||
elsif (gem_details = parse_gemfile_lock_entry(line)) | ||
gem_name, version = gem_details | ||
else | ||
next | ||
end | ||
|
||
# Validate and store the minimum version | ||
if version_valid?(version) | ||
if runtime == 'ruby' | ||
if minimum_gems_ruby[gem_name].nil? || Gem::Version.new(version) < Gem::Version.new(minimum_gems_ruby[gem_name]) | ||
minimum_gems_ruby[gem_name] = version | ||
end | ||
if maximum_gems_ruby[gem_name].nil? || Gem::Version.new(version) > Gem::Version.new(maximum_gems_ruby[gem_name]) | ||
maximum_gems_ruby[gem_name] = version | ||
end | ||
end | ||
if runtime == 'jruby' | ||
if minimum_gems_jruby[gem_name].nil? || Gem::Version.new(version) < Gem::Version.new(minimum_gems_jruby[gem_name]) | ||
minimum_gems_jruby[gem_name] = version | ||
end | ||
if maximum_gems_jruby[gem_name].nil? || Gem::Version.new(version) > Gem::Version.new(maximum_gems_jruby[gem_name]) | ||
maximum_gems_jruby[gem_name] = version | ||
end | ||
end | ||
else | ||
next | ||
end | ||
end | ||
end | ||
|
||
[minimum_gems_ruby, minimum_gems_jruby, maximum_gems_ruby, maximum_gems_jruby] | ||
end | ||
|
||
# Helper: Parse a Gemfile-style gem declaration | ||
# ex. gem 'ruby-kafka', '~> 5.0' | ||
def parse_gemfile_entry(line) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing
quinna-h marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (match = line.match(/^\s*gem\s+["']([^"']+)["']\s*,?\s*["']?([^"']*)["']?/)) | ||
gem_name, version_constraint = match[1], match[2] | ||
version = extract_version(version_constraint) | ||
[gem_name, version] | ||
end | ||
end | ||
|
||
# Helper: Parse a Gemfile.lock-style entry | ||
# matches on ex. actionmailer (= 6.0.6) | ||
def parse_gemfile_lock_entry(line) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing
quinna-h marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (match = line.match(/^\s*([a-z0-9_-]+)\s+\(([^)]+)\)/)) | ||
[match[1], match[2]] | ||
end | ||
end | ||
|
||
# Helper: Validate the version format | ||
def version_valid?(version) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing |
||
version =~ /^\d+(\.\d+)*$/ | ||
end | ||
|
||
# Helper: Extract the actual version number from a constraint | ||
# Matches on the following version patterns: | ||
# 1. "pessimistic" versions, ex. '~> 1.2.3' | ||
# 2. '>= 1.2.3' | ||
# 3. 1.2.3 | ||
def extract_version(constraint) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing |
||
if constraint =~ /~>\s*([\d.]+(?:[-.\w]*))| # Handles ~> constraints | ||
>=\s*([\d.]+(?:[-.\w]*))| # Handles >= constraints | ||
([\d.]+(?:[-.\w]*)) # Handles plain versions | ||
/x | ||
Regexp.last_match(1) || Regexp.last_match(2) || Regexp.last_match(3) | ||
end | ||
end | ||
|
||
def get_integration_names(directory = 'lib/datadog/tracing/contrib/') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 Code Quality ViolationAvoid top-level methods definition. Organize methods in modules/classes. (...read more)This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse. Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope. To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing |
||
unless Dir.exist?(directory) | ||
puts "Directory '#{directory}' not found!" | ||
return [] | ||
end | ||
|
||
# Get all subdirectories inside the specified directory | ||
Dir.children(directory).select do |entry| | ||
File.directory?(File.join(directory, entry)) | ||
end | ||
quinna-h marked this conversation as resolved.
Show resolved
Hide resolved
|
||
end | ||
|
||
mapping = { | ||
quinna-h marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are some that I don't see and I don't think have a clear automation path that we could potentially just hardcode in:
Just went through the list of them here: https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby/#integrations There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. left comments about these on the generated PR: #4236 |
||
"action_mailer" => "actionmailer", | ||
"opensearch" => "opensearch-ruby", | ||
"concurrent_ruby" => "concurrent-ruby", | ||
"action_view" => "actionview", | ||
"action_cable" => "actioncable", | ||
"active_record" => "activerecord", | ||
"mongodb" => "mongo", | ||
"rest_client" => "rest-client", | ||
"active_support" => "activesupport", | ||
"action_pack" => "actionpack", | ||
"active_job" => "activejob", | ||
"httprb" => "http", | ||
"kafka" => "ruby-kafka", | ||
"presto" => "presto-client", | ||
"aws" => "aws-sdk-core" | ||
} | ||
|
||
excluded = ["configuration", "propagation", "utils"] | ||
min_gems_ruby, min_gems_jruby, max_gems_ruby, max_gems_jruby = parse_gemfiles("gemfiles/") | ||
integrations = get_integration_names('lib/datadog/tracing/contrib/') | ||
|
||
integration_json_mapping = {} | ||
|
||
integrations.each do |integration| | ||
if excluded.include?(integration) | ||
next | ||
end | ||
integration_name = mapping[integration] || integration | ||
|
||
min_version_jruby = min_gems_jruby[integration_name] | ||
min_version_ruby = min_gems_ruby[integration_name] | ||
max_version_jruby = max_gems_jruby[integration_name] | ||
max_version_ruby = max_gems_ruby[integration_name] | ||
|
||
# mapping jruby, ruby | ||
integration_json_mapping[integration] = [min_version_ruby, max_version_ruby, min_version_jruby, max_version_jruby] | ||
integration_json_mapping.replace(integration_json_mapping.sort.to_h) | ||
end | ||
|
||
File.write("gem_output.json", JSON.pretty_generate(integration_json_mapping)) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
require 'json' | ||
|
||
# Input and output file names | ||
input_file = 'gem_output.json' | ||
output_file = 'integration_versions.md' | ||
|
||
# Read JSON data from the input file | ||
data = JSON.parse(File.read(input_file)) | ||
|
||
# Prepare the Markdown content | ||
comment = "# This is a table of supported integration versions generated from gemfiles.\n\n" | ||
quinna-h marked this conversation as resolved.
Show resolved
Hide resolved
|
||
header = "| Integration | Ruby Min | Ruby Max | JRuby Min | JRuby Max |\n" | ||
separator = "|-------------|----------|-----------|----------|----------|\n" | ||
rows = data.map do |integration_name, versions| | ||
ruby_min, ruby_max, jruby_min, jruby_max = versions.map { |v| v || "None" } | ||
"| #{integration_name} | #{ruby_min} | #{ruby_max} | #{jruby_min} | #{jruby_max} |" | ||
end | ||
|
||
# Write the Markdown file | ||
File.open(output_file, 'w') do |file| | ||
file.puts comment | ||
file.puts header | ||
file.puts separator | ||
rows.each { |row| file.puts row } | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔵 Code Quality Violation
Avoid top-level methods definition. Organize methods in modules/classes. (...read more)
This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse.
Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope.
To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing
def some_method; end
, you should writeclass SomeClass def some_method; end end
. This not only adheres to the rule but also improves the readability and maintainability of your code.