forked from elastic/logstash
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rubyUtils.gradle
463 lines (408 loc) · 19.1 KB
/
rubyUtils.gradle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you 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.
*/
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath "org.yaml:snakeyaml:${snakeYamlVersion}"
classpath "de.undercouch:gradle-download-task:4.0.4"
classpath "org.jruby:jruby-core:9.4.5.0"
}
}
import de.undercouch.gradle.tasks.download.Download
import de.undercouch.gradle.tasks.download.Verify
import org.yaml.snakeyaml.Yaml
import org.jruby.Ruby
import org.jruby.embed.PathType
import org.jruby.embed.ScriptingContainer
import java.lang.annotation.Annotation
import java.nio.file.Files
import java.nio.file.Paths
ext {
bundle = this.&bundle
bundleWithEnv = this.&bundleWithEnv
bundleQAGems = this.&bundleQAGems
gem = this.&gem
buildGem = this.&buildGem
rake = this.&rake
setupJruby = this.&setupJruby
generateRubySupportFilesForPlugin = this.&generateRubySupportFilesForPlugin
validatePluginJar = this.&validatePluginJar
versionMap = new HashMap()
pluginInfo = new PluginInfo()
}
/**
* Executes a bundler bin script with given parameters.
* @param projectDir Gradle projectDir
* @param buildDir Gradle buildDir
* @param pwd Current worker directory to execute in
* @param bundleBin Bundler Bin Script
* @param args CLI Args to Use with Bundler
*/
void bundle(File projectDir, File buildDir, String pwd, String bundleBin, Iterable<String> args) {
bundleWithEnv(projectDir, buildDir, pwd, bundleBin, args, Collections.emptyMap())
}
/**
* Executes a bundler bin script with given parameters.
* @param projectDir Gradle projectDir
* @param buildDir Gradle buildDir
* @param pwd Current worker directory to execute in
* @param bundleBin Bundler Bin Script
* @param args CLI Args to Use with Bundler
* @param env Environment Variables to Set
*/
void bundleWithEnv(File projectDir, File buildDir, String pwd, String bundleBin, Iterable<String> args, Map<String, String> env) {
executeJruby projectDir, buildDir, { ScriptingContainer jruby ->
jruby.environment.putAll(env)
jruby.currentDirectory = pwd
jruby.argv = args.toList().toArray()
jruby.runScriptlet(PathType.ABSOLUTE, bundleBin)
}
}
void bundleQAGems(File projectDir, String qaBuildPath) {
def jruby = new ScriptingContainer()
jruby.setLoadPaths(["${projectDir}/vendor/jruby/lib/ruby/stdlib".toString()])
try {
jruby.currentDirectory = qaBuildPath
jruby.runScriptlet("""
require "bundler"
require "bundler/cli"
Bundler::CLI.start(['install', '--path', "${qaBuildPath}/vendor", '--gemfile', "${projectDir}/qa/integration/Gemfile"])
""")
} finally {
jruby.terminate()
Ruby.clearGlobalRuntime()
}
}
/**
* Installs a Gem with the given version to the given path.
* @param projectDir Gradle projectDir
* @param buildDir Gradle buildDir
* @param gem Gem Name
* @param version Version to Install
* @param path Path to Install to
*/
void gem(File projectDir, File buildDir, String gem, String version, String path) {
executeJruby projectDir, buildDir, { ScriptingContainer jruby ->
jruby.currentDirectory = projectDir
jruby.runScriptlet("""
require 'rubygems/commands/install_command'
cmd = Gem::Commands::InstallCommand.new
cmd.handle_options ['--no-document', '${gem}', '-v', '${version}', '-i', '${path}']
begin
cmd.execute
rescue Gem::SystemExitException => e
raise e unless e.exit_code == 0
end
"""
)
}
}
void buildGem(File projectDir, File buildDir, String gemspec) {
executeJruby projectDir, buildDir, { ScriptingContainer jruby ->
jruby.currentDirectory = projectDir
jruby.runScriptlet("""
require 'rubygems/commands/build_command'
cmd = Gem::Commands::BuildCommand.new
cmd.handle_options ['${gemspec}']
begin
cmd.execute
rescue Gem::SystemExitException => e
raise e unless e.exit_code == 0
end
"""
)
}
}
/**
* Executes RSpec for a given plugin.
* @param projectDir Gradle projectDir
* @param buildDir Gradle buildDir
* @param plugin Plugin to run specs for
* @param args CLI arguments to pass to rspec
*/
void rake(File projectDir, File buildDir, String task) {
executeJruby projectDir, buildDir, { ScriptingContainer jruby ->
jruby.currentDirectory = projectDir
jruby.runScriptlet("require 'rake'; require 'time'")
jruby.runScriptlet("""
rake = Rake.application
rake.init
rake.load_rakefile
rake['${task}'].invoke
"""
)
}
}
void setupJruby(File projectDir, File buildDir) {
executeJruby projectDir, buildDir, { ScriptingContainer jruby ->
jruby.currentDirectory = projectDir
jruby.runScriptlet("require '${projectDir}/lib/bootstrap/environment'")
jruby.runScriptlet("LogStash::Bundler.invoke!")
jruby.runScriptlet("LogStash::Bundler.genericize_platform")
}
}
/**
* Executes Closure using a fresh JRuby environment, safely tearing it down afterwards.
* @param projectDir Gradle projectDir
* @param buildDir Gradle buildDir
* @param block Closure to run
*/
Object executeJruby(File projectDir, File buildDir, Closure<?> /* Object*/ block) {
def jruby = new ScriptingContainer()
def env = jruby.environment
def gemDir = "${projectDir}/vendor/bundle/jruby/3.1.0".toString()
jruby.setLoadPaths(["${projectDir}/vendor/jruby/lib/ruby/stdlib".toString()])
env.put "USE_RUBY", "1"
env.put "GEM_HOME", gemDir
env.put "GEM_SPEC_CACHE", "${buildDir}/cache".toString()
env.put "GEM_PATH", gemDir
try {
block(jruby)
} finally {
jruby.terminate()
Ruby.clearGlobalRuntime()
}
}
//===============================================================================
// Ruby variables
//===============================================================================
def versionsPath = project.hasProperty("LOGSTASH_CORE_PATH") ? LOGSTASH_CORE_PATH + "/../versions.yml" : "${projectDir}/versions.yml"
versionMap = (Map) (new Yaml()).load(new File("${versionsPath}").text)
String jRubyURL
String previousJRubyVersion = "9.3.9.0"
String previousJRubyURL = "https://repo1.maven.org/maven2/org/jruby/jruby-dist/${previousJRubyVersion}/jruby-dist-${previousJRubyVersion}-bin.tar.gz"
String jRubyVersion
String jRubySha1
Boolean doChecksum
if (versionMap["jruby-runtime-override"]) {
jRubyVersion = versionMap["jruby-runtime-override"]["version"]
jRubyURL = versionMap["jruby-runtime-override"]["url"]
doChecksum = false
} else {
jRubyVersion = versionMap["jruby"]["version"]
jRubySha1 = versionMap["jruby"]["sha1"]
jRubyURL = "https://repo1.maven.org/maven2/org/jruby/jruby-dist/${jRubyVersion}/jruby-dist-${jRubyVersion}-bin.tar.gz"
doChecksum = true
}
def jrubyTarPath = "${projectDir}/vendor/_/jruby-dist-${jRubyVersion}-bin.tar.gz"
def previousJrubyTarPath = "${projectDir}/vendor/_/jruby-dist-${previousJRubyVersion}-bin.tar.gz"
def customJRubyDir = project.hasProperty("custom.jruby.path") ? project.property("custom.jruby.path") : ""
def customJRubyVersion = customJRubyDir == "" ? "" : Files.readAllLines(Paths.get(customJRubyDir, "VERSION")).get(0).trim()
def customJRubyTar = customJRubyDir == "" ? "" : (customJRubyDir + "/maven/jruby-dist/target/jruby-dist-${customJRubyVersion}-bin.tar.gz")
tasks.register("downloadJRuby", Download) {
description "Download JRuby artifact from this specific URL: ${jRubyURL}"
src jRubyURL
onlyIfNewer true
inputs.file(versionsPath)
outputs.file(jrubyTarPath)
dest new File("${projectDir}/vendor/_", "jruby-dist-${jRubyVersion}-bin.tar.gz")
}
tasks.register("downloadPreviousJRuby", Download) {
description "Download previous JRuby artifact from this specific URL: ${previousJRubyURL}"
src previousJRubyURL
onlyIfNewer true
inputs.file(versionsPath)
outputs.file(previousJrubyTarPath)
dest new File("${projectDir}/vendor/_", "jruby-dist-${previousJRubyVersion}-bin.tar.gz")
}
downloadJRuby.onlyIf { customJRubyDir == "" }
tasks.register("verifyFile", Verify) {
dependsOn downloadJRuby
description "Verify the SHA1 of the download JRuby artifact"
inputs.file(jrubyTarPath)
outputs.file(jrubyTarPath)
src new File(jrubyTarPath)
algorithm 'SHA-1'
checksum jRubySha1
}
verifyFile.onlyIf { customJRubyDir == "" }
verifyFile.onlyIf { doChecksum }
tasks.register("buildCustomJRuby", Exec) {
description "Build tar.gz and .jar artifacts from JRuby source directory"
workingDir (customJRubyDir == "" ? "./" : customJRubyDir)
commandLine './mvnw', 'clean', 'install', '-Pdist', '-Pcomplete'
standardOutput = new ByteArrayOutputStream()
errorOutput = new ByteArrayOutputStream()
ext.output = {
standardOutput.toString() + errorOutput.toString()
}
}
buildCustomJRuby.onlyIf { customJRubyDir != "" }
tasks.register("installCustomJRuby", Copy) {
dependsOn buildCustomJRuby
description "Install custom built JRuby in the vendor directory"
inputs.file(customJRubyTar)
outputs.dir("${projectDir}/vendor/jruby")
from tarTree(customJRubyTar == "" ? jrubyTarPath : customJRubyTar)
eachFile { f ->
f.path = f.path.replaceFirst("^jruby-${customJRubyVersion}", '')
}
includeEmptyDirs = false
into "${projectDir}/vendor/jruby"
}
installCustomJRuby.onlyIf { customJRubyDir != "" }
tasks.register("downloadAndInstallPreviousJRubyFFI", Copy) {
dependsOn=[downloadPreviousJRuby]
description "Install previous JRuby FFI files in the new JRuby directory"
inputs.file(previousJrubyTarPath)
outputs.dir("${projectDir}/vendor/jruby/tmp")
from tarTree(downloadPreviousJRuby.dest)
eachFile { f ->
f.path = f.path.replaceFirst("^jruby-${previousJRubyVersion}", '')
}
// Copy only the previous builds of libjffi that changed from JRuby 9.3.9.0 to 9.3.10.0
include "**/lib/jni/**/*"
includeEmptyDirs = false
into "${projectDir}/vendor/jruby/tmp"
}
tasks.register("downloadAndInstallJRuby", Copy) {
// TODO remove downloadAndInstallPreviousJRubyFFI after https://github.com/elastic/logstash/issues/14873 is fixed
dependsOn=[verifyFile, downloadAndInstallPreviousJRubyFFI, installCustomJRuby]
description "Install JRuby in the vendor directory"
inputs.file(jrubyTarPath)
outputs.dir("${projectDir}/vendor/jruby")
from tarTree(downloadJRuby.dest)
eachFile { f ->
f.path = f.path.replaceFirst("^jruby-${jRubyVersion}", '')
}
exclude "**/did_you_mean-*/evaluation/**" // licensing issue https://github.com/jruby/jruby/issues/6471
exclude "**/lib/jni/**/**"
includeEmptyDirs = false
into "${projectDir}/vendor/jruby"
doLast {
ant.jar(destfile: "${projectDir}/vendor/jruby/lib/jruby.jar", update: true) {
fileset(dir: "${projectDir}/vendor/jruby/tmp/lib")
}
delete files("${projectDir}/vendor/jruby/tmp")
}
}
downloadAndInstallJRuby.onlyIf { customJRubyDir == "" }
//===============================================================================
// Ruby auto-gen utilities for Java plugins
//===============================================================================
class PluginInfo {
public String[] licenses
public String longDescription
public String[] authors
public String[] email
public String homepage
public String pluginType
public String pluginClass
public String pluginName
String pluginFullName() {
return "logstash-" + pluginType + "-" + pluginName
}
}
void generateRubySupportFilesForPlugin(String projectDescription, String projectGroup, String version) {
File gemFile = file("Gemfile")
gemFile.write("# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.\n")
gemFile.append("source 'https://rubygems.org'\n")
gemFile.append("\n")
gemFile.append("gemspec\n")
gemFile.append("\n")
gemFile.append("logstash_path = ENV[\"LOGSTASH_PATH\"] || \"../../logstash\"\n")
gemFile.append("use_logstash_source = ENV[\"LOGSTASH_SOURCE\"] && ENV[\"LOGSTASH_SOURCE\"].to_s == \"1\"\n")
gemFile.append("\n")
gemFile.append("if Dir.exist?(logstash_path) && use_logstash_source\n")
gemFile.append(" gem 'logstash-core', :path => \"#{logstash_path}/logstash-core\"\n")
gemFile.append(" gem 'logstash-core-plugin-api', :path => \"#{logstash_path}/logstash-core-plugin-api\"\n")
gemFile.append("end\n")
File gemspecFile = file(pluginInfo.pluginFullName() + ".gemspec")
gemspecFile.write("# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.\n")
gemspecFile.append("Gem::Specification.new do |s|\n")
gemspecFile.append(" s.name = '" + pluginInfo.pluginFullName() + "'\n")
gemspecFile.append(" s.version = ::File.read('VERSION').split('\\n').first\n")
gemspecFile.append(" s.licenses = ['" + String.join("', '", pluginInfo.licenses) + "']\n")
gemspecFile.append(" s.summary = '" + projectDescription + "'\n")
gemspecFile.append(" s.description = '" + pluginInfo.longDescription + "'\n")
gemspecFile.append(" s.authors = ['" + String.join("', '", pluginInfo.authors) + "']\n")
gemspecFile.append(" s.email = ['" + String.join("', '", pluginInfo.email) + "']\n")
gemspecFile.append(" s.homepage = '" + pluginInfo.homepage + "'\n")
gemspecFile.append(" s.require_paths = ['lib', 'vendor/jar-dependencies']\n")
gemspecFile.append("\n")
gemspecFile.append(" s.files = Dir[\"lib/**/*\",\"*.gemspec\",\"*.md\",\"CONTRIBUTORS\",\"Gemfile\",\"LICENSE\",\"NOTICE.TXT\", \"vendor/jar-dependencies/**/*.jar\", \"vendor/jar-dependencies/**/*.rb\", \"VERSION\", \"docs/**/*\"]\n")
gemspecFile.append("\n")
gemspecFile.append(" # Special flag to let us know this is actually a logstash plugin\n")
gemspecFile.append(" s.metadata = { 'logstash_plugin' => 'true', 'logstash_group' => '" + pluginInfo.pluginType + "', 'java_plugin' => 'true'}\n")
gemspecFile.append("\n")
gemspecFile.append(" # Gem dependencies\n")
gemspecFile.append(" s.add_runtime_dependency \"logstash-core-plugin-api\", \">= 1.60\", \"<= 2.99\"\n")
gemspecFile.append(" s.add_runtime_dependency 'jar-dependencies'\n")
gemspecFile.append(" s.add_development_dependency 'logstash-devutils'\n")
gemspecFile.append("end\n")
String moduleName = pluginInfo.pluginType.substring(0, 1).toUpperCase() + pluginInfo.pluginType.substring(1) + "s"
File pluginRb = file("lib/logstash/" + pluginInfo.pluginType + "s/" + pluginInfo.pluginName + ".rb")
Files.createDirectories(pluginRb.toPath().getParent())
pluginRb.write("# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.\n")
pluginRb.append("# encoding: utf-8\n")
pluginRb.append("require \"logstash/" + pluginInfo.pluginType + "s/base\"\n")
pluginRb.append("require \"logstash/namespace\"\n")
pluginRb.append("require \"" + pluginInfo.pluginFullName() + "_jars\"\n")
pluginRb.append("require \"java\"\n")
pluginRb.append("\n")
pluginRb.append("class LogStash::" + moduleName + "::" + pluginInfo.pluginClass + " < LogStash::" + moduleName + "::Base\n")
pluginRb.append(" config_name \"" + pluginInfo.pluginName + "\"\n")
pluginRb.append("\n")
pluginRb.append(" def self.javaClass() Java::" + projectGroup + "." + pluginInfo.pluginClass + ".java_class; end\n")
pluginRb.append("end\n")
File pluginJarsRb = file("lib/" + pluginInfo.pluginFullName() + "_jars.rb")
pluginJarsRb.write("# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.\n")
pluginJarsRb.append("# encoding: utf-8\n")
pluginJarsRb.append("\n")
pluginJarsRb.append("require 'jar_dependencies'\n")
pluginJarsRb.append("require_jar('" + projectGroup + "', '" + pluginInfo.pluginFullName() + "', '" + version +"')\n")
}
void validatePluginJar(File pluginJar, String group) {
List<String> validationErrors = new ArrayList<>()
if (group.equals('org.logstash') || group.startsWith('org.logstash.') || group.equals('co.elastic.logstash') || group.startsWith('co.elastic.logstash.')) {
validationErrors.add("The plugin should not be placed in the 'org.logstash' or 'co.elastic.logstash' packages")
throw new GradleScriptException("Plugin validation errors:" + System.lineSeparator() +
String.join(System.lineSeparator(), validationErrors), null)
}
URLClassLoader cl = URLClassLoader.newInstance([pluginJar.toURI().toURL()] as URL[])
String pluginClassName = group + "." + pluginInfo.pluginClass
Class<?> pluginClass = null
try {
pluginClass = cl.loadClass(pluginClassName)
} catch (ClassNotFoundException ex) {
validationErrors.add(String.format("Unable to locate plugin class defined in build.gradle as '%s' in jar '%s'", pluginClassName, pluginJar))
throw new GradleScriptException("Plugin validation errors:" + System.lineSeparator() +
String.join(System.lineSeparator(), validationErrors), null)
}
if (pluginClass != null) {
Annotation[] logstashPlugin = pluginClass.getAnnotations().findAll({ x -> x.annotationType().toString().equals("interface co.elastic.logstash.api.LogstashPlugin") })
if (logstashPlugin.length != 1) {
validationErrors.add("There must be a single @LogstashPlugin annotation on the plugin class")
} else {
String pluginAnnotation = logstashPlugin[0].name()
if (pluginAnnotation != pluginInfo.pluginName) {
validationErrors.add("The 'name' property on the @LogstashPlugin (which is '" + pluginAnnotation + "') must match the 'pluginName' property which is defined as '" + pluginInfo.pluginName + "' in the build.gradle file")
}
if (pluginAnnotation.replace("_", "").toLowerCase() != pluginInfo.pluginClass.toLowerCase()) {
validationErrors.add("The 'name' property on the @LogstashPlugin (which is '" + pluginAnnotation + "') must match the plugin class name '" + pluginInfo.pluginClass + "' excluding casing and underscores")
}
}
}
if (validationErrors.size() > 0) {
throw new GradleScriptException("Plugin validation errors:" + System.lineSeparator() +
String.join(System.lineSeparator(), validationErrors), null)
}
}