// Licensed to the Apache Software Foundation (ASF) under one or more // contributor license agreements. See the NOTICE file distributed with // this work for additional information regarding copyright ownership. // The ASF 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. import org.ajoberstar.grgit.Grgit import org.gradle.api.JavaVersion import java.nio.charset.StandardCharsets buildscript { repositories { mavenCentral() } apply from: "$rootDir/gradle/dependencies.gradle" dependencies { // For Apache Rat plugin to ignore non-Git files classpath "org.ajoberstar.grgit:grgit-core:$versions.grgit" } } plugins { id 'com.github.ben-manes.versions' version '0.48.0' id 'idea' id 'jacoco' id 'java-library' id 'org.owasp.dependencycheck' version '8.2.1' id 'org.nosphere.apache.rat' version "0.8.1" id "io.swagger.core.v3.swagger-gradle-plugin" version "${swaggerVersion}" id "com.github.spotbugs" version '5.1.3' apply false id 'org.scoverage' version '7.0.1' apply false id 'com.github.johnrengelman.shadow' version '8.1.1' apply false id 'com.diffplug.spotless' version '6.14.0' apply false // 6.14.1 and newer require Java 11 at compile time, so we can't upgrade until AK 4.0 } ext { gradleVersion = versions.gradle minJavaVersion = 8 buildVersionFileName = "kafka-version.properties" defaultMaxHeapSize = "2g" defaultJvmArgs = ["-Xss4m", "-XX:+UseParallelGC"] // "JEP 403: Strongly Encapsulate JDK Internals" causes some tests to fail when they try // to access internals (often via mocking libraries). We use `--add-opens` as a workaround // for now and we'll fix it properly (where possible) via KAFKA-13275. if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16)) defaultJvmArgs.addAll( "--add-opens=java.base/java.io=ALL-UNNAMED", "--add-opens=java.base/java.lang=ALL-UNNAMED", "--add-opens=java.base/java.nio=ALL-UNNAMED", "--add-opens=java.base/java.nio.file=ALL-UNNAMED", "--add-opens=java.base/java.util=ALL-UNNAMED", "--add-opens=java.base/java.util.concurrent=ALL-UNNAMED", "--add-opens=java.base/java.util.regex=ALL-UNNAMED", "--add-opens=java.base/java.util.stream=ALL-UNNAMED", "--add-opens=java.base/java.text=ALL-UNNAMED", "--add-opens=java.base/java.time=ALL-UNNAMED", "--add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED" ) maxTestForks = project.hasProperty('maxParallelForks') ? maxParallelForks.toInteger() : Runtime.runtime.availableProcessors() maxScalacThreads = project.hasProperty('maxScalacThreads') ? maxScalacThreads.toInteger() : Math.min(Runtime.runtime.availableProcessors(), 8) userIgnoreFailures = project.hasProperty('ignoreFailures') ? ignoreFailures : false userMaxTestRetries = project.hasProperty('maxTestRetries') ? maxTestRetries.toInteger() : 0 userMaxTestRetryFailures = project.hasProperty('maxTestRetryFailures') ? maxTestRetryFailures.toInteger() : 0 skipSigning = project.hasProperty('skipSigning') && skipSigning.toBoolean() shouldSign = !skipSigning && !version.endsWith("SNAPSHOT") mavenUrl = project.hasProperty('mavenUrl') ? project.mavenUrl : '' mavenUsername = project.hasProperty('mavenUsername') ? project.mavenUsername : '' mavenPassword = project.hasProperty('mavenPassword') ? project.mavenPassword : '' userShowStandardStreams = project.hasProperty("showStandardStreams") ? showStandardStreams : null userTestLoggingEvents = project.hasProperty("testLoggingEvents") ? Arrays.asList(testLoggingEvents.split(",")) : null userEnableTestCoverage = project.hasProperty("enableTestCoverage") ? enableTestCoverage : false userKeepAliveModeString = project.hasProperty("keepAliveMode") ? keepAliveMode : "daemon" userKeepAliveMode = KeepAliveMode.values().find(m -> m.name().toLowerCase().equals(userKeepAliveModeString)) if (userKeepAliveMode == null) { def keepAliveValues = KeepAliveMode.values().collect(m -> m.name.toLowerCase()) throw new GradleException("Unexpected value for keepAliveMode property. Expected one of $keepAliveValues, but received: $userKeepAliveModeString") } // See README.md for details on this option and the reasoning for the default userScalaOptimizerMode = project.hasProperty("scalaOptimizerMode") ? scalaOptimizerMode : "inline-kafka" def scalaOptimizerValues = ["none", "method", "inline-kafka", "inline-scala"] if (!scalaOptimizerValues.contains(userScalaOptimizerMode)) throw new GradleException("Unexpected value for scalaOptimizerMode property. Expected one of $scalaOptimizerValues, but received: $userScalaOptimizerMode") generatedDocsDir = new File("${project.rootDir}/docs/generated") commitId = determineCommitId() } allprojects { repositories { mavenCentral() } dependencyUpdates { revision="release" resolutionStrategy { componentSelection { rules -> rules.all { ComponentSelection selection -> boolean rejected = ['snap', 'alpha', 'beta', 'rc', 'cr', 'm'].any { qualifier -> selection.candidate.version ==~ /(?i).*[.-]${qualifier}[.\d-]*/ } if (rejected) { selection.reject('Release candidate') } } } } } configurations.all { // zinc is the Scala incremental compiler, it has a configuration for its own dependencies // that are unrelated to the project dependencies, we should not change them if (name != "zinc") { resolutionStrategy { force( // be explicit about the javassist dependency version instead of relying on the transitive version libs.javassist, // ensure we have a single version in the classpath despite transitive dependencies libs.scalaLibrary, libs.scalaReflect, libs.jacksonAnnotations, // be explicit about the Netty dependency version instead of relying on the version set by // ZooKeeper (potentially older and containing CVEs) libs.nettyHandler, libs.nettyTransportNativeEpoll, // be explicit about the reload4j version instead of relying on the transitive versions libs.log4j ) } } } task printAllDependencies(type: DependencyReportTask) {} } def determineCommitId() { def takeFromHash = 16 if (project.hasProperty('commitId')) { commitId.take(takeFromHash) } else if (file("$rootDir/.git/HEAD").exists()) { def headRef = file("$rootDir/.git/HEAD").text if (headRef.contains('ref: ')) { headRef = headRef.replaceAll('ref: ', '').trim() if (file("$rootDir/.git/$headRef").exists()) { file("$rootDir/.git/$headRef").text.trim().take(takeFromHash) } } else { headRef.trim().take(takeFromHash) } } else { "unknown" } } apply from: file('wrapper.gradle') if (file('.git').exists()) { rat { dependsOn subprojects.collect { it.tasks.matching { it.name == "processMessages" || it.name == "processTestMessages" } } verbose.set(true) reportDir.set(project.file('build/rat')) stylesheet.set(file('gradle/resources/rat-output-to-html.xsl')) // Exclude everything under the directory that git should be ignoring via .gitignore or that isn't checked in. These // restrict us only to files that are checked in or are staged. def repo = Grgit.open(currentDir: project.getRootDir()) excludes = new ArrayList(repo.clean(ignore: false, directories: true, dryRun: true)) // And some of the files that we have checked in should also be excluded from this check excludes.addAll([ '**/.git/**', '**/build/**', 'CONTRIBUTING.md', 'PULL_REQUEST_TEMPLATE.md', 'gradlew', 'gradlew.bat', 'gradle/wrapper/gradle-wrapper.properties', 'trogdor/README.md', '**/README.md', '**/id_rsa', '**/id_rsa.pub', 'checkstyle/suppressions.xml', 'streams/quickstart/java/src/test/resources/projects/basic/goal.txt', 'streams/streams-scala/logs/*', 'licenses/*', '**/generated/**', 'clients/src/test/resources/serializedData/*' ]) } } else { rat.enabled = false } println("Starting build with version $version (commit id ${commitId == null ? "null" : commitId.take(8)}) using Gradle $gradleVersion, Java ${JavaVersion.current()} and Scala ${versions.scala}") println("Build properties: maxParallelForks=$maxTestForks, maxScalacThreads=$maxScalacThreads, maxTestRetries=$userMaxTestRetries") subprojects { // enable running :dependencies task recursively on all subprojects // eg: ./gradlew allDeps task allDeps(type: DependencyReportTask) {} // enable running :dependencyInsight task recursively on all subprojects // eg: ./gradlew allDepInsight --configuration runtime --dependency com.fasterxml.jackson.core:jackson-databind task allDepInsight(type: DependencyInsightReportTask) {showingAllVariants = false} doLast {} apply plugin: 'java-library' apply plugin: 'checkstyle' // spotbugs doesn't support Java 21 yet if (!JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)) apply plugin: "com.github.spotbugs" // We use the shadow plugin for the jmh-benchmarks module and the `-all` jar can get pretty large, so // don't publish it def shouldPublish = !project.name.equals('jmh-benchmarks') if (shouldPublish) { apply plugin: 'maven-publish' apply plugin: 'signing' // Add aliases for the task names used by the maven plugin for backwards compatibility // The maven plugin was replaced by the maven-publish plugin in Gradle 7.0 tasks.register('install').configure { dependsOn(publishToMavenLocal) } tasks.register('uploadArchives').configure { dependsOn(publish) } } // apply the eclipse plugin only to subprojects that hold code. 'connect' is just a folder. if (!project.name.equals('connect')) { apply plugin: 'eclipse' fineTuneEclipseClasspathFile(eclipse, project) } java { consistentResolution { // resolve the compileClasspath and then "inject" the result of resolution as strict constraints into the runtimeClasspath useCompileClasspathVersions() } } tasks.withType(JavaCompile) { options.encoding = 'UTF-8' options.compilerArgs << "-Xlint:all" // temporary exclusions until all the warnings are fixed if (!project.path.startsWith(":connect")) options.compilerArgs << "-Xlint:-rawtypes" options.compilerArgs << "-Xlint:-serial" options.compilerArgs << "-Xlint:-try" options.compilerArgs << "-Werror" // --release is the recommended way to select the target release, but it's only supported in Java 9 so we also // set --source and --target via `sourceCompatibility` and `targetCompatibility` a couple of lines below if (JavaVersion.current().isJava9Compatible()) options.release = minJavaVersion // --source/--target 8 is deprecated in Java 20, suppress warning until Java 8 support is dropped in Kafka 4.0 if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_20)) options.compilerArgs << "-Xlint:-options" } // We should only set this if Java version is < 9 (--release is recommended for >= 9), but the Scala plugin for IntelliJ sets // `-target` incorrectly if this is unset sourceCompatibility = minJavaVersion targetCompatibility = minJavaVersion if (shouldPublish) { publishing { repositories { // To test locally, invoke gradlew with `-PmavenUrl=file:///some/local/path` maven { url = mavenUrl credentials { username = mavenUsername password = mavenPassword } } } publications { mavenJava(MavenPublication) { from components.java afterEvaluate { ["srcJar", "javadocJar", "scaladocJar", "testJar", "testSrcJar"].forEach { taskName -> def task = tasks.findByName(taskName) if (task != null) artifact task } artifactId = archivesBaseName pom { name = 'Apache Kafka' url = 'https://kafka.apache.org' licenses { license { name = 'The Apache License, Version 2.0' url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' distribution = 'repo' } } } } } } } if (shouldSign) { signing { sign publishing.publications.mavenJava } } } // Remove the relevant project name once it's converted to JUnit 5 def shouldUseJUnit5 = !(["runtime"].contains(it.project.name)) def testLoggingEvents = ["passed", "skipped", "failed"] def testShowStandardStreams = false def testExceptionFormat = 'full' // Gradle built-in logging only supports sending test output to stdout, which generates a lot // of noise, especially for passing tests. We really only want output for failed tests. This // hooks into the output and logs it (so we don't have to buffer it all in memory) and only // saves the output for failing tests. Directory and filenames are such that you can, e.g., // create a Jenkins rule to collect failed test output. def logTestStdout = { def testId = { TestDescriptor descriptor -> "${descriptor.className}.${descriptor.name}".toString() } def logFiles = new HashMap() def logStreams = new HashMap() beforeTest { TestDescriptor td -> def tid = testId(td) // truncate the file name if it's too long def logFile = new File( "${projectDir}/build/reports/testOutput/${tid.substring(0, Math.min(tid.size(),240))}.test.stdout" ) logFile.parentFile.mkdirs() logFiles.put(tid, logFile) logStreams.put(tid, new FileOutputStream(logFile)) } onOutput { TestDescriptor td, TestOutputEvent toe -> def tid = testId(td) // Some output can happen outside the context of a specific test (e.g. at the class level) // and beforeTest/afterTest seems to not be invoked for these cases (and similarly, there's // a TestDescriptor hierarchy that includes the thread executing the test, Gradle tasks, // etc). We see some of these in practice and it seems like something buggy in the Gradle // test runner since we see it *before* any tests and it is frequently not related to any // code in the test (best guess is that it is tail output from last test). We won't have // an output file for these, so simply ignore them. If they become critical for debugging, // they can be seen with showStandardStreams. if (td.name == td.className || td.className == null) { // silently ignore output unrelated to specific test methods return } else if (logStreams.get(tid) == null) { println "WARNING: unexpectedly got output for a test [${tid}]" + " that we didn't previously see in the beforeTest hook." + " Message for debugging: [" + toe.message + "]." return } try { logStreams.get(tid).write(toe.message.getBytes(StandardCharsets.UTF_8)) } catch (Exception e) { println "ERROR: Failed to write output for test ${tid}" e.printStackTrace() } } afterTest { TestDescriptor td, TestResult tr -> def tid = testId(td) try { logStreams.get(tid).close() if (tr.resultType != TestResult.ResultType.FAILURE) { logFiles.get(tid).delete() } else { def file = logFiles.get(tid) println "${tid} failed, log available in ${file}" } } catch (Exception e) { println "ERROR: Failed to close stdout file for ${tid}" e.printStackTrace() } finally { logFiles.remove(tid) logStreams.remove(tid) } } } // The suites are for running sets of tests in IDEs. // Gradle will run each test class, so we exclude the suites to avoid redundantly running the tests twice. def testsToExclude = ['**/*Suite.class'] // Exclude PowerMock tests when running with Java 16 or newer until a version of PowerMock that supports the relevant versions is released // The relevant issues are https://github.com/powermock/powermock/issues/1094 and https://github.com/powermock/powermock/issues/1099 if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16)) { testsToExclude.addAll([ // connect tests "**/KafkaConfigBackingStoreTest.*", "**/StandaloneHerderTest.*", "**/WorkerSinkTaskTest.*", "**/WorkerSinkTaskThreadedTest.*" ]) } test { maxParallelForks = maxTestForks ignoreFailures = userIgnoreFailures maxHeapSize = defaultMaxHeapSize jvmArgs = defaultJvmArgs testLogging { events = userTestLoggingEvents ?: testLoggingEvents showStandardStreams = userShowStandardStreams ?: testShowStandardStreams exceptionFormat = testExceptionFormat displayGranularity = 0 } logTestStdout.rehydrate(delegate, owner, this)() exclude testsToExclude if (shouldUseJUnit5) useJUnitPlatform() retry { maxRetries = userMaxTestRetries maxFailures = userMaxTestRetryFailures } } task integrationTest(type: Test, dependsOn: compileJava) { maxParallelForks = maxTestForks ignoreFailures = userIgnoreFailures // Increase heap size for integration tests maxHeapSize = "2560m" jvmArgs = defaultJvmArgs testLogging { events = userTestLoggingEvents ?: testLoggingEvents showStandardStreams = userShowStandardStreams ?: testShowStandardStreams exceptionFormat = testExceptionFormat displayGranularity = 0 } logTestStdout.rehydrate(delegate, owner, this)() exclude testsToExclude if (shouldUseJUnit5) { if (project.name == 'streams') { useJUnitPlatform { includeTags "integration" includeTags "org.apache.kafka.test.IntegrationTest" // Both engines are needed to run JUnit 4 tests alongside JUnit 5 tests. // junit-vintage (JUnit 4) can be removed once the JUnit 4 migration is complete. includeEngines "junit-vintage", "junit-jupiter" } } else { useJUnitPlatform { includeTags "integration" } } } else { useJUnit { includeCategories 'org.apache.kafka.test.IntegrationTest' } } retry { maxRetries = userMaxTestRetries maxFailures = userMaxTestRetryFailures } } task unitTest(type: Test, dependsOn: compileJava) { maxParallelForks = maxTestForks ignoreFailures = userIgnoreFailures maxHeapSize = defaultMaxHeapSize jvmArgs = defaultJvmArgs testLogging { events = userTestLoggingEvents ?: testLoggingEvents showStandardStreams = userShowStandardStreams ?: testShowStandardStreams exceptionFormat = testExceptionFormat displayGranularity = 0 } logTestStdout.rehydrate(delegate, owner, this)() exclude testsToExclude if (shouldUseJUnit5) { if (project.name == 'streams') { useJUnitPlatform { excludeTags "integration" excludeTags "org.apache.kafka.test.IntegrationTest" // Both engines are needed to run JUnit 4 tests alongside JUnit 5 tests. // junit-vintage (JUnit 4) can be removed once the JUnit 4 migration is complete. includeEngines "junit-vintage", "junit-jupiter" } } else { useJUnitPlatform { excludeTags "integration" } } } else { useJUnit { excludeCategories 'org.apache.kafka.test.IntegrationTest' } } retry { maxRetries = userMaxTestRetries maxFailures = userMaxTestRetryFailures } } // remove test output from all test types tasks.withType(Test).all { t -> cleanTest { delete t.reports.junitXml.outputLocation delete t.reports.html.outputLocation } } jar { from "$rootDir/LICENSE" from "$rootDir/NOTICE" } task srcJar(type: Jar) { archiveClassifier = 'sources' from "$rootDir/LICENSE" from "$rootDir/NOTICE" from sourceSets.main.allSource } task javadocJar(type: Jar, dependsOn: javadoc) { archiveClassifier = 'javadoc' from "$rootDir/LICENSE" from "$rootDir/NOTICE" from javadoc.destinationDir } task docsJar(dependsOn: javadocJar) javadoc { options.charSet = 'UTF-8' options.docEncoding = 'UTF-8' options.encoding = 'UTF-8' options.memberLevel = JavadocMemberLevel.PUBLIC // Document only public members/API // Turn off doclint for now, see https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html for rationale options.addStringOption('Xdoclint:none', '-quiet') // The URL structure was changed to include the locale after Java 8 if (JavaVersion.current().isJava11Compatible()) options.links "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/" else options.links "https://docs.oracle.com/javase/8/docs/api/" } task systemTestLibs(dependsOn: jar) if (!sourceSets.test.allSource.isEmpty()) { task testJar(type: Jar) { archiveClassifier = 'test' from "$rootDir/LICENSE" from "$rootDir/NOTICE" from sourceSets.test.output } task testSrcJar(type: Jar, dependsOn: testJar) { archiveClassifier = 'test-sources' from "$rootDir/LICENSE" from "$rootDir/NOTICE" from sourceSets.test.allSource } } plugins.withType(ScalaPlugin) { scala { zincVersion = versions.zinc } task scaladocJar(type:Jar, dependsOn: scaladoc) { archiveClassifier = 'scaladoc' from "$rootDir/LICENSE" from "$rootDir/NOTICE" from scaladoc.destinationDir } //documentation task should also trigger building scala doc jar docsJar.dependsOn scaladocJar } tasks.withType(ScalaCompile) { scalaCompileOptions.keepAliveMode = userKeepAliveMode scalaCompileOptions.additionalParameters = [ "-deprecation", "-unchecked", "-encoding", "utf8", "-Xlog-reflective-calls", "-feature", "-language:postfixOps", "-language:implicitConversions", "-language:existentials", "-Ybackend-parallelism", maxScalacThreads.toString(), "-Xlint:constant", "-Xlint:delayedinit-select", "-Xlint:doc-detached", "-Xlint:missing-interpolator", "-Xlint:nullary-unit", "-Xlint:option-implicit", "-Xlint:package-object-classes", "-Xlint:poly-implicit-overload", "-Xlint:private-shadow", "-Xlint:stars-align", "-Xlint:type-parameter-shadow", "-Xlint:unused" ] // See README.md for details on this option and the meaning of each value if (userScalaOptimizerMode.equals("method")) scalaCompileOptions.additionalParameters += ["-opt:l:method"] else if (userScalaOptimizerMode.startsWith("inline-")) { List inlineFrom = ["-opt-inline-from:org.apache.kafka.**"] if (project.name.equals('core')) inlineFrom.add("-opt-inline-from:kafka.**") if (userScalaOptimizerMode.equals("inline-scala")) inlineFrom.add("-opt-inline-from:scala.**") scalaCompileOptions.additionalParameters += ["-opt:l:inline"] scalaCompileOptions.additionalParameters += inlineFrom } if (versions.baseScala != '2.12') { scalaCompileOptions.additionalParameters += ["-opt-warnings", "-Xlint:strict-unsealed-patmat"] // Scala 2.13.2 introduces compiler warnings suppression, which is a pre-requisite for -Xfatal-warnings scalaCompileOptions.additionalParameters += ["-Xfatal-warnings"] } // these options are valid for Scala versions < 2.13 only // Scala 2.13 removes them, see https://github.com/scala/scala/pull/6502 and https://github.com/scala/scala/pull/5969 if (versions.baseScala == '2.12') { scalaCompileOptions.additionalParameters += [ "-Xlint:by-name-right-associative", "-Xlint:nullary-override", "-Xlint:unsound-match" ] } // Scalac 2.12 `-release` requires Java 9 or higher, but Scala 2.13 doesn't have that restriction if (versions.baseScala == "2.13" || JavaVersion.current().isJava9Compatible()) scalaCompileOptions.additionalParameters += ["-release", String.valueOf(minJavaVersion)] configure(scalaCompileOptions.forkOptions) { memoryMaximumSize = defaultMaxHeapSize jvmArgs = defaultJvmArgs } } checkstyle { configDirectory = rootProject.layout.projectDirectory.dir("checkstyle") configProperties = checkstyleConfigProperties("import-control.xml") toolVersion = versions.checkstyle } configure(checkstyleMain) { group = 'Verification' description = 'Run checkstyle on all main Java sources' } configure(checkstyleTest) { group = 'Verification' description = 'Run checkstyle on all test Java sources' } test.dependsOn('checkstyleMain', 'checkstyleTest') // spotbugs doesn't support Java 21 yet if (!JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)) { spotbugs { toolVersion = versions.spotbugs excludeFilter = file("$rootDir/gradle/spotbugs-exclude.xml") ignoreFailures = false } test.dependsOn('spotbugsMain') } tasks.withType(com.github.spotbugs.snom.SpotBugsTask) { reports { // Continue supporting `xmlFindBugsReport` for compatibility xml.enabled(project.hasProperty('xmlSpotBugsReport') || project.hasProperty('xmlFindBugsReport')) html.enabled(!project.hasProperty('xmlSpotBugsReport') && !project.hasProperty('xmlFindBugsReport')) } maxHeapSize = defaultMaxHeapSize jvmArgs = defaultJvmArgs } // Ignore core since its a scala project if (it.path != ':core') { if (userEnableTestCoverage) { apply plugin: "jacoco" jacoco { toolVersion = versions.jacoco } // NOTE: Jacoco Gradle plugin does not support "offline instrumentation" this means that classes mocked by PowerMock // may report 0 coverage, since the source was modified after initial instrumentation. // See https://github.com/jacoco/jacoco/issues/51 jacocoTestReport { dependsOn tasks.test sourceSets sourceSets.main reports { html.required = true xml.required = true csv.required = false } } } } if (userEnableTestCoverage) { def coverageGen = it.path == ':core' ? 'reportScoverage' : 'jacocoTestReport' task reportCoverage(dependsOn: [coverageGen]) } dependencyCheck { suppressionFile = "$rootDir/gradle/resources/dependencycheck-suppressions.xml" } } gradle.taskGraph.whenReady { taskGraph -> taskGraph.getAllTasks().findAll { it.name.contains('spotbugsScoverage') || it.name.contains('spotbugsTest') }.each { task -> task.enabled = false } } def fineTuneEclipseClasspathFile(eclipse, project) { eclipse.classpath.file { beforeMerged { cp -> cp.entries.clear() // for the core project add the directories defined under test/scala as separate source directories if (project.name.equals('core')) { cp.entries.add(new org.gradle.plugins.ide.eclipse.model.SourceFolder("src/test/scala/integration", null)) cp.entries.add(new org.gradle.plugins.ide.eclipse.model.SourceFolder("src/test/scala/other", null)) cp.entries.add(new org.gradle.plugins.ide.eclipse.model.SourceFolder("src/test/scala/unit", null)) } } whenMerged { cp -> // for the core project exclude the separate sub-directories defined under test/scala. These are added as source dirs above if (project.name.equals('core')) { cp.entries.findAll { it.kind == "src" && it.path.equals("src/test/scala") }*.excludes = ["integration/", "other/", "unit/"] } /* * Set all eclipse build output to go to 'build_eclipse' directory. This is to ensure that gradle and eclipse use different * build output directories, and also avoid using the eclpise default of 'bin' which clashes with some of our script directories. * https://discuss.gradle.org/t/eclipse-generated-files-should-be-put-in-the-same-place-as-the-gradle-generated-files/6986/2 */ cp.entries.findAll { it.kind == "output" }*.path = "build_eclipse" /* * Some projects have explicitly added test output dependencies. These are required for the gradle build but not required * in Eclipse since the dependent projects are added as dependencies. So clean up these from the generated classpath. */ cp.entries.removeAll { it.kind == "lib" && it.path.matches(".*/build/(classes|resources)/test") } } } } def checkstyleConfigProperties(configFileName) { [importControlFile: "$configFileName"] } // Aggregates all jacoco results into the root project directory if (userEnableTestCoverage) { task jacocoRootReport(type: org.gradle.testing.jacoco.tasks.JacocoReport) { def javaProjects = subprojects.findAll { it.path != ':core' } description = 'Generates an aggregate report from all subprojects' dependsOn(javaProjects.test) additionalSourceDirs.from = javaProjects.sourceSets.main.allSource.srcDirs sourceDirectories.from = javaProjects.sourceSets.main.allSource.srcDirs classDirectories.from = javaProjects.sourceSets.main.output executionData.from = javaProjects.jacocoTestReport.executionData reports { html.required = true xml.required = true } // workaround to ignore projects that don't have any tests at all onlyIf = { true } doFirst { executionData = files(executionData.findAll { it.exists() }) } } } if (userEnableTestCoverage) { task reportCoverage(dependsOn: ['jacocoRootReport', 'core:reportCoverage']) } def connectPkgs = [ 'connect:api', 'connect:basic-auth-extension', 'connect:file', 'connect:json', 'connect:runtime', 'connect:test-plugins', 'connect:transforms', 'connect:mirror', 'connect:mirror-client' ] tasks.create(name: "jarConnect", dependsOn: connectPkgs.collect { it + ":jar" }) {} tasks.create(name: "testConnect", dependsOn: connectPkgs.collect { it + ":test" }) {} project(':core') { apply plugin: 'scala' // scaladoc generation is configured at the sub-module level with an artifacts // block (cf. see streams-scala). If scaladoc generation is invoked explicitly // for the `core` module, this ensures the generated jar doesn't include scaladoc // files since the `core` module doesn't include public APIs. scaladoc { enabled = false } if (userEnableTestCoverage) apply plugin: "org.scoverage" archivesBaseName = "kafka_${versions.baseScala}" configurations { generator } dependencies { // `core` is often used in users' tests, define the following dependencies as `api` for backwards compatibility // even though the `core` module doesn't expose any public API api project(':clients') api libs.scalaLibrary implementation project(':server-common') implementation project(':group-coordinator') implementation project(':metadata') implementation project(':storage:storage-api') implementation project(':tools:tools-api') implementation project(':raft') implementation project(':storage') implementation libs.argparse4j implementation libs.commonsValidator implementation libs.jacksonDatabind implementation libs.jacksonModuleScala implementation libs.jacksonDataformatCsv implementation libs.jacksonJDK8Datatypes implementation libs.joptSimple implementation libs.jose4j implementation libs.metrics implementation libs.scalaCollectionCompat implementation libs.scalaJava8Compat // only needed transitively, but set it explicitly to ensure it has the same version as scala-library implementation libs.scalaReflect implementation libs.scalaLogging implementation libs.slf4jApi implementation(libs.zookeeper) { // Dropwizard Metrics are required by ZooKeeper as of v3.6.0, // but the library should *not* be used in Kafka code implementation libs.dropwizardMetrics exclude module: 'slf4j-log4j12' exclude module: 'log4j' // Both Kafka and Zookeeper use slf4j. ZooKeeper moved from log4j to logback in v3.8.0, but Kafka relies on reload4j. // We are removing Zookeeper's dependency on logback so we have a singular logging backend. exclude module: 'logback-classic' exclude module: 'logback-core' } // ZooKeeperMain depends on commons-cli but declares the dependency as `provided` implementation libs.commonsCli compileOnly libs.log4j testImplementation project(':clients').sourceSets.test.output testImplementation project(':group-coordinator').sourceSets.test.output testImplementation project(':metadata').sourceSets.test.output testImplementation project(':raft').sourceSets.test.output testImplementation project(':server-common').sourceSets.test.output testImplementation project(':storage:storage-api').sourceSets.test.output testImplementation libs.bcpkix testImplementation libs.mockitoCore testImplementation(libs.apacheda) { exclude group: 'xml-apis', module: 'xml-apis' // `mina-core` is a transitive dependency for `apacheds` and `apacheda`. // It is safer to use from `apacheds` since that is the implementation. exclude module: 'mina-core' } testImplementation libs.apachedsCoreApi testImplementation libs.apachedsInterceptorKerberos testImplementation libs.apachedsProtocolShared testImplementation libs.apachedsProtocolKerberos testImplementation libs.apachedsProtocolLdap testImplementation libs.apachedsLdifPartition testImplementation libs.apachedsMavibotPartition testImplementation libs.apachedsJdbmPartition testImplementation libs.junitJupiter testImplementation libs.slf4jlog4j testImplementation(libs.jfreechart) { exclude group: 'junit', module: 'junit' } testImplementation libs.caffeine generator project(':generator') } if (userEnableTestCoverage) { scoverage { scoverageVersion = versions.scoverage reportDir = file("${rootProject.buildDir}/scoverage") highlighting = false minimumRate = 0.0 } } configurations { // manually excludes some unnecessary dependencies implementation.exclude module: 'javax' implementation.exclude module: 'jline' implementation.exclude module: 'jms' implementation.exclude module: 'jmxri' implementation.exclude module: 'jmxtools' implementation.exclude module: 'mail' // To prevent a UniqueResourceException due the same resource existing in both // org.apache.directory.api/api-all and org.apache.directory.api/api-ldap-schema-data testImplementation.exclude module: 'api-ldap-schema-data' } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "kafka.internals.generated", "-o", "src/generated/java/kafka/internals/generated", "-i", "src/main/resources/common/message", "-m", "MessageDataGenerator" ] inputs.dir("src/main/resources/common/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/kafka/internals/generated") } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' task genProtocolErrorDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.common.protocol.Errors' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "protocol_errors.html").newOutputStream() } task genProtocolTypesDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.common.protocol.types.Type' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "protocol_types.html").newOutputStream() } task genProtocolApiKeyDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.common.protocol.ApiKeys' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "protocol_api_keys.html").newOutputStream() } task genProtocolMessageDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.common.protocol.Protocol' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "protocol_messages.html").newOutputStream() } task genAdminClientConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.clients.admin.AdminClientConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "admin_client_config.html").newOutputStream() } task genProducerConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.clients.producer.ProducerConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "producer_config.html").newOutputStream() } task genConsumerConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.clients.consumer.ConsumerConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "consumer_config.html").newOutputStream() } task genKafkaConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'kafka.server.KafkaConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "kafka_config.html").newOutputStream() } task genTopicConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.storage.internals.log.LogConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "topic_config.html").newOutputStream() } task genConsumerMetricsDocs(type: JavaExec) { classpath = sourceSets.test.runtimeClasspath mainClass = 'org.apache.kafka.clients.consumer.internals.ConsumerMetrics' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "consumer_metrics.html").newOutputStream() } task genProducerMetricsDocs(type: JavaExec) { classpath = sourceSets.test.runtimeClasspath mainClass = 'org.apache.kafka.clients.producer.internals.ProducerMetrics' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "producer_metrics.html").newOutputStream() } task siteDocsTar(dependsOn: ['genProtocolErrorDocs', 'genProtocolTypesDocs', 'genProtocolApiKeyDocs', 'genProtocolMessageDocs', 'genAdminClientConfigDocs', 'genProducerConfigDocs', 'genConsumerConfigDocs', 'genKafkaConfigDocs', 'genTopicConfigDocs', ':connect:runtime:genConnectConfigDocs', ':connect:runtime:genConnectTransformationDocs', ':connect:runtime:genConnectPredicateDocs', ':connect:runtime:genSinkConnectorConfigDocs', ':connect:runtime:genSourceConnectorConfigDocs', ':streams:genStreamsConfigDocs', 'genConsumerMetricsDocs', 'genProducerMetricsDocs', ':connect:runtime:genConnectMetricsDocs', ':connect:runtime:genConnectOpenAPIDocs', ':connect:mirror:genMirrorSourceConfigDocs', ':connect:mirror:genMirrorCheckpointConfigDocs', ':connect:mirror:genMirrorHeartbeatConfigDocs', ':connect:mirror:genMirrorConnectorConfigDocs', ':storage:genRemoteLogManagerConfigDoc', ':storage:genRemoteLogMetadataManagerConfigDoc'], type: Tar) { archiveClassifier = 'site-docs' compression = Compression.GZIP from project.file("$rootDir/docs") into 'site-docs' duplicatesStrategy 'exclude' } tasks.create(name: "releaseTarGz", dependsOn: configurations.archives.artifacts, type: Tar) { into "kafka_${versions.baseScala}-${archiveVersion.get()}" compression = Compression.GZIP from(project.file("$rootDir/bin")) { into "bin/" } from(project.file("$rootDir/config")) { into "config/" } from(project.file("$rootDir/licenses")) { into "licenses/" } from "$rootDir/LICENSE-binary" rename {String filename -> filename.replace("-binary", "")} from "$rootDir/NOTICE-binary" rename {String filename -> filename.replace("-binary", "")} from(configurations.runtimeClasspath) { into("libs/") } from(configurations.archives.artifacts.files) { into("libs/") } from(project.siteDocsTar) { into("site-docs/") } from(project(':tools').jar) { into("libs/") } from(project(':tools').configurations.runtimeClasspath) { into("libs/") } from(project(':trogdor').jar) { into("libs/") } from(project(':trogdor').configurations.runtimeClasspath) { into("libs/") } from(project(':shell').jar) { into("libs/") } from(project(':shell').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:api').jar) { into("libs/") } from(project(':connect:api').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:runtime').jar) { into("libs/") } from(project(':connect:runtime').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:transforms').jar) { into("libs/") } from(project(':connect:transforms').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:json').jar) { into("libs/") } from(project(':connect:json').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:file').jar) { into("libs/") } from(project(':connect:file').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:basic-auth-extension').jar) { into("libs/") } from(project(':connect:basic-auth-extension').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:mirror').jar) { into("libs/") } from(project(':connect:mirror').configurations.runtimeClasspath) { into("libs/") } from(project(':connect:mirror-client').jar) { into("libs/") } from(project(':connect:mirror-client').configurations.runtimeClasspath) { into("libs/") } from(project(':streams').jar) { into("libs/") } from(project(':streams').configurations.runtimeClasspath) { into("libs/") } from(project(':streams:streams-scala').jar) { into("libs/") } from(project(':streams:streams-scala').configurations.runtimeClasspath) { into("libs/") } from(project(':streams:test-utils').jar) { into("libs/") } from(project(':streams:test-utils').configurations.runtimeClasspath) { into("libs/") } from(project(':streams:examples').jar) { into("libs/") } from(project(':streams:examples').configurations.runtimeClasspath) { into("libs/") } from(project(':tools:tools-api').jar) { into("libs/") } from(project(':tools:tools-api').configurations.runtimeClasspath) { into("libs/") } duplicatesStrategy 'exclude' } jar { dependsOn('copyDependantLibs') } jar.manifest { attributes( 'Version': "${version}" ) } tasks.create(name: "copyDependantTestLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('*.jar') } into "$buildDir/dependant-testlibs" //By default gradle does not handle test dependencies between the sub-projects //This line is to include clients project test jar to dependant-testlibs from (project(':clients').testJar ) { "$buildDir/dependant-testlibs" } duplicatesStrategy 'exclude' } systemTestLibs.dependsOn('jar', 'testJar', 'copyDependantTestLibs') checkstyle { configProperties = checkstyleConfigProperties("import-control-core.xml") } sourceSets { // Set java/scala source folders in the `scala` block to enable joint compilation main { java { srcDirs = [] } scala { srcDirs = ["src/generated/java", "src/main/java", "src/main/scala"] } } test { java { srcDirs = [] } scala { srcDirs = ["src/test/java", "src/test/scala"] } } } } project(':metadata') { archivesBaseName = "kafka-metadata" configurations { generator } dependencies { implementation project(':server-common') implementation project(':clients') implementation project(':raft') implementation libs.jacksonDatabind implementation libs.jacksonJDK8Datatypes implementation libs.metrics compileOnly libs.log4j testImplementation libs.junitJupiter testImplementation libs.jqwik testImplementation libs.hamcrest testImplementation libs.mockitoCore testImplementation libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output testImplementation project(':raft').sourceSets.test.output testImplementation project(':server-common').sourceSets.test.output generator project(':generator') } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.common.metadata", "-o", "src/generated/java/org/apache/kafka/common/metadata", "-i", "src/main/resources/common/metadata", "-m", "MessageDataGenerator", "JsonConverterGenerator", "-t", "MetadataRecordTypeGenerator", "MetadataJsonConvertersGenerator" ] inputs.dir("src/main/resources/common/metadata") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/common/metadata") } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated/java", "src/test/java"] } } } javadoc { enabled = false } checkstyle { configProperties = checkstyleConfigProperties("import-control-metadata.xml") } } project(':group-coordinator') { archivesBaseName = "kafka-group-coordinator" configurations { generator } dependencies { implementation project(':server-common') implementation project(':clients') implementation project(':metadata') implementation libs.slf4jApi testImplementation project(':clients').sourceSets.test.output testImplementation project(':server-common').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testRuntimeOnly libs.slf4jlog4j generator project(':generator') } sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated/java", "src/test/java"] } } } javadoc { enabled = false } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.coordinator.group.generated", "-o", "src/generated/java/org/apache/kafka/coordinator/group/generated", "-i", "src/main/resources/common/message", "-m", "MessageDataGenerator" ] inputs.dir("src/main/resources/common/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/coordinator/group/generated") } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' } project(':examples') { archivesBaseName = "kafka-examples" dependencies { implementation project(':clients') } javadoc { enabled = false } checkstyle { configProperties = checkstyleConfigProperties("import-control-core.xml") } } project(':generator') { dependencies { implementation libs.argparse4j implementation libs.jacksonDatabind implementation libs.jacksonJDK8Datatypes implementation libs.jacksonJaxrsJsonProvider testImplementation libs.junitJupiter } javadoc { enabled = false } } project(':clients') { archivesBaseName = "kafka-clients" configurations { generator } dependencies { implementation libs.zstd implementation libs.lz4 implementation libs.snappy implementation libs.slf4jApi compileOnly libs.jacksonDatabind // for SASL/OAUTHBEARER bearer token parsing compileOnly libs.jacksonJDK8Datatypes compileOnly libs.jose4j // for SASL/OAUTHBEARER JWT validation; only used by broker testImplementation libs.bcpkix testImplementation libs.jacksonJaxrsJsonProvider testImplementation libs.jose4j testImplementation libs.junitJupiter testImplementation libs.log4j testImplementation libs.mockitoCore testRuntimeOnly libs.slf4jlog4j testRuntimeOnly libs.jacksonDatabind testRuntimeOnly libs.jacksonJDK8Datatypes generator project(':generator') } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } clean.doFirst { delete "$buildDir/kafka/" } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.common.message", "-o", "src/generated/java/org/apache/kafka/common/message", "-i", "src/main/resources/common/message", "-t", "ApiMessageTypeGenerator", "-m", "MessageDataGenerator", "JsonConverterGenerator" ] inputs.dir("src/main/resources/common/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/common/message") } task processTestMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.common.message", "-o", "src/generated-test/java/org/apache/kafka/common/message", "-i", "src/test/resources/common/message", "-m", "MessageDataGenerator", "JsonConverterGenerator" ] inputs.dir("src/test/resources/common/message") .withPropertyName("testMessages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated-test/java/org/apache/kafka/common/message") } sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated-test/java", "src/test/java"] } } } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' compileTestJava.dependsOn 'processTestMessages' javadoc { include "**/org/apache/kafka/clients/admin/*" include "**/org/apache/kafka/clients/consumer/*" include "**/org/apache/kafka/clients/producer/*" include "**/org/apache/kafka/common/*" include "**/org/apache/kafka/common/acl/*" include "**/org/apache/kafka/common/annotation/*" include "**/org/apache/kafka/common/errors/*" include "**/org/apache/kafka/common/header/*" include "**/org/apache/kafka/common/metrics/*" include "**/org/apache/kafka/common/metrics/stats/*" include "**/org/apache/kafka/common/quota/*" include "**/org/apache/kafka/common/resource/*" include "**/org/apache/kafka/common/serialization/*" include "**/org/apache/kafka/common/config/*" include "**/org/apache/kafka/common/config/provider/*" include "**/org/apache/kafka/common/security/auth/*" include "**/org/apache/kafka/common/security/plain/*" include "**/org/apache/kafka/common/security/scram/*" include "**/org/apache/kafka/common/security/token/delegation/*" include "**/org/apache/kafka/common/security/oauthbearer/*" include "**/org/apache/kafka/common/security/oauthbearer/secured/*" include "**/org/apache/kafka/server/authorizer/*" include "**/org/apache/kafka/server/policy/*" include "**/org/apache/kafka/server/quota/*" } } project(':raft') { archivesBaseName = "kafka-raft" configurations { generator } dependencies { implementation project(':server-common') implementation project(':clients') implementation libs.slf4jApi implementation libs.jacksonDatabind testImplementation project(':server-common') testImplementation project(':clients') testImplementation project(':clients').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testImplementation libs.jqwik testRuntimeOnly libs.slf4jlog4j generator project(':generator') } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.raft.generated", "-o", "src/generated/java/org/apache/kafka/raft/generated", "-i", "src/main/resources/common/message", "-m", "MessageDataGenerator", "JsonConverterGenerator"] inputs.dir("src/main/resources/common/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/raft/generated") } sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated/java", "src/test/java"] } } } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } test { useJUnitPlatform { includeEngines 'jqwik', 'junit-jupiter' } } clean.doFirst { delete "$buildDir/kafka/" } javadoc { enabled = false } } project(':server-common') { archivesBaseName = "kafka-server-common" dependencies { api project(':clients') implementation libs.slf4jApi implementation libs.metrics implementation libs.joptSimple implementation libs.jacksonDatabind implementation libs.pcollections testImplementation project(':clients') testImplementation project(':clients').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testImplementation libs.hamcrest testRuntimeOnly libs.slf4jlog4j } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } sourceSets { main { java { srcDirs = ["src/main/java"] } } test { java { srcDirs = ["src/test/java"] } } } jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } clean.doFirst { delete "$buildDir/kafka/" } checkstyle { configProperties = checkstyleConfigProperties("import-control-server-common.xml") } } project(':storage:storage-api') { archivesBaseName = "kafka-storage-api" dependencies { implementation project(':clients') implementation project(':server-common') implementation libs.metrics implementation libs.slf4jApi testImplementation project(':clients') testImplementation project(':clients').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testRuntimeOnly libs.slf4jlog4j } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } sourceSets { main { java { srcDirs = ["src/main/java"] } } test { java { srcDirs = ["src/test/java"] } } } jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } clean.doFirst { delete "$buildDir/kafka/" } javadoc { include "**/org/apache/kafka/server/log/remote/storage/*" } checkstyle { configProperties = checkstyleConfigProperties("import-control-storage.xml") } } project(':storage') { archivesBaseName = "kafka-storage" configurations { generator } dependencies { implementation project(':storage:storage-api') implementation project(':server-common') implementation project(':clients') implementation libs.caffeine implementation libs.slf4jApi implementation libs.jacksonDatabind implementation libs.metrics testImplementation project(':clients') testImplementation project(':clients').sourceSets.test.output testImplementation project(':core') testImplementation project(':core').sourceSets.test.output testImplementation project(':server-common') testImplementation project(':server-common').sourceSets.test.output testImplementation libs.hamcrest testImplementation libs.junitJupiter testImplementation libs.mockitoCore testImplementation libs.bcpkix testRuntimeOnly libs.slf4jlog4j generator project(':generator') } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", " org.apache.kafka.server.log.remote.metadata.storage.generated", "-o", "src/generated/java/org/apache/kafka/server/log/remote/metadata/storage/generated", "-i", "src/main/resources/message", "-m", "MessageDataGenerator", "JsonConverterGenerator", "-t", "MetadataRecordTypeGenerator", "MetadataJsonConvertersGenerator" ] inputs.dir("src/main/resources/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/server/log/remote/metadata/storage/generated") } task genRemoteLogManagerConfigDoc(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.server.log.remote.storage.RemoteLogManagerConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "remote_log_manager_config.html").newOutputStream() } task genRemoteLogMetadataManagerConfigDoc(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.server.log.remote.metadata.storage.TopicBasedRemoteLogMetadataManagerConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "remote_log_metadata_manager_config.html").newOutputStream() } sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated/java", "src/test/java"] } } } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } test { useJUnitPlatform { includeEngines 'junit-jupiter' } } clean.doFirst { delete "$buildDir/kafka/" } javadoc { enabled = false } checkstyle { configProperties = checkstyleConfigProperties("import-control-storage.xml") } } project(':tools:tools-api') { archivesBaseName = "kafka-tools-api" dependencies { implementation project(':clients') testImplementation libs.junitJupiter } task createVersionFile() { def receiptFile = file("$buildDir/kafka/$buildVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } sourceSets { main { java { srcDirs = ["src/main/java"] } } test { java { srcDirs = ["src/test/java"] } } } jar { dependsOn createVersionFile from("$buildDir") { include "kafka/$buildVersionFileName" } } clean.doFirst { delete "$buildDir/kafka/" } javadoc { include "**/org/apache/kafka/tools/api/*" } } project(':tools') { archivesBaseName = "kafka-tools" dependencies { implementation project(':clients') implementation project(':server-common') implementation project(':connect:api') implementation project(':connect:runtime') implementation project(':log4j-appender') implementation project(':tools:tools-api') implementation libs.argparse4j implementation libs.jacksonDatabind implementation libs.jacksonJDK8Datatypes implementation libs.slf4jApi implementation libs.log4j implementation libs.joptSimple implementation libs.jose4j // for SASL/OAUTHBEARER JWT validation implementation libs.jacksonJaxrsJsonProvider testImplementation project(':clients') testImplementation project(':clients').sourceSets.test.output testImplementation project(':core') testImplementation project(':core').sourceSets.test.output testImplementation project(':server-common') testImplementation project(':server-common').sourceSets.test.output testImplementation project(':connect:api') testImplementation project(':connect:runtime') testImplementation project(':connect:runtime').sourceSets.test.output testImplementation project(':storage:storage-api').sourceSets.main.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testImplementation libs.mockitoJunitJupiter // supports MockitoExtension testImplementation libs.bcpkix // required by the clients test module, but we have to specify it explicitly as gradle does not include the transitive test dependency automatically testRuntimeOnly libs.slf4jlog4j } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } } project(':trogdor') { archivesBaseName = "trogdor" dependencies { implementation project(':clients') implementation project(':log4j-appender') implementation libs.argparse4j implementation libs.jacksonDatabind implementation libs.jacksonJDK8Datatypes implementation libs.slf4jApi implementation libs.log4j implementation libs.jacksonJaxrsJsonProvider implementation libs.jerseyContainerServlet implementation libs.jerseyHk2 implementation libs.jaxbApi // Jersey dependency that was available in the JDK before Java 9 implementation libs.activation // Jersey dependency that was available in the JDK before Java 9 implementation libs.jettyServer implementation libs.jettyServlet implementation libs.jettyServlets testImplementation project(':clients') testImplementation libs.junitJupiter testImplementation project(':clients').sourceSets.test.output testImplementation libs.mockitoCore testRuntimeOnly libs.slf4jlog4j } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } } project(':shell') { archivesBaseName = "kafka-shell" dependencies { implementation libs.argparse4j implementation libs.jacksonDatabind implementation libs.jacksonJDK8Datatypes implementation libs.jline implementation libs.slf4jApi implementation project(':server-common') implementation project(':clients') implementation project(':core') implementation project(':log4j-appender') implementation project(':metadata') implementation project(':raft') implementation libs.jose4j // for SASL/OAUTHBEARER JWT validation implementation libs.jacksonJaxrsJsonProvider testImplementation project(':clients') testImplementation libs.junitJupiter testRuntimeOnly libs.slf4jlog4j } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('jline-*jar') } from (configurations.runtimeClasspath) { include('jline-*jar') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } } project(':streams') { archivesBaseName = "kafka-streams" ext.buildStreamsVersionFileName = "kafka-streams-version.properties" configurations { generator } dependencies { api project(':clients') // `org.rocksdb.Options` is part of Kafka Streams public api via `RocksDBConfigSetter` api libs.rocksDBJni implementation libs.slf4jApi implementation libs.jacksonAnnotations implementation libs.jacksonDatabind // testCompileOnly prevents streams from exporting a dependency on test-utils, which would cause a dependency cycle testCompileOnly project(':streams:test-utils') testImplementation project(':clients').sourceSets.test.output testImplementation project(':core') testImplementation project(':tools') testImplementation project(':core').sourceSets.test.output testImplementation project(':server-common').sourceSets.test.output testImplementation libs.log4j testImplementation libs.junitJupiter testImplementation libs.junitVintageEngine testImplementation libs.easymock testImplementation libs.powermockJunit4 testImplementation libs.powermockEasymock testImplementation libs.bcpkix testImplementation libs.hamcrest testImplementation libs.mockitoCore testImplementation libs.mockitoJunitJupiter // supports MockitoExtension testRuntimeOnly project(':streams:test-utils') testRuntimeOnly libs.slf4jlog4j generator project(':generator') } task processMessages(type:JavaExec) { mainClass = "org.apache.kafka.message.MessageGenerator" classpath = configurations.generator args = [ "-p", "org.apache.kafka.streams.internals.generated", "-o", "src/generated/java/org/apache/kafka/streams/internals/generated", "-i", "src/main/resources/common/message", "-m", "MessageDataGenerator" ] inputs.dir("src/main/resources/common/message") .withPropertyName("messages") .withPathSensitivity(PathSensitivity.RELATIVE) outputs.cacheIf { true } outputs.dir("src/generated/java/org/apache/kafka/streams/internals/generated") } sourceSets { main { java { srcDirs = ["src/generated/java", "src/main/java"] } } test { java { srcDirs = ["src/generated/java", "src/test/java"] } } } compileJava.dependsOn 'processMessages' srcJar.dependsOn 'processMessages' javadoc { include "**/org/apache/kafka/streams/**" exclude "**/org/apache/kafka/streams/internals/**", "**/org/apache/kafka/streams/**/internals/**" } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.runtimeClasspath) { exclude('kafka-clients*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } task createStreamsVersionFile() { def receiptFile = file("$buildDir/kafka/$buildStreamsVersionFileName") inputs.property "commitId", commitId inputs.property "version", version outputs.file receiptFile doLast { def data = [ commitId: commitId, version: version, ] receiptFile.parentFile.mkdirs() def content = data.entrySet().collect { "$it.key=$it.value" }.sort().join("\n") receiptFile.setText(content, "ISO-8859-1") } } jar { dependsOn 'createStreamsVersionFile' from("$buildDir") { include "kafka/$buildStreamsVersionFileName" } dependsOn 'copyDependantLibs' } systemTestLibs { dependsOn testJar } task genStreamsConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.streams.StreamsConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "streams_config.html").newOutputStream() } task testAll( dependsOn: [ ':streams:test', ':streams:test-utils:test', ':streams:streams-scala:test', ':streams:upgrade-system-tests-0100:test', ':streams:upgrade-system-tests-0101:test', ':streams:upgrade-system-tests-0102:test', ':streams:upgrade-system-tests-0110:test', ':streams:upgrade-system-tests-10:test', ':streams:upgrade-system-tests-11:test', ':streams:upgrade-system-tests-20:test', ':streams:upgrade-system-tests-21:test', ':streams:upgrade-system-tests-22:test', ':streams:upgrade-system-tests-23:test', ':streams:upgrade-system-tests-24:test', ':streams:upgrade-system-tests-25:test', ':streams:upgrade-system-tests-26:test', ':streams:upgrade-system-tests-27:test', ':streams:upgrade-system-tests-28:test', ':streams:upgrade-system-tests-30:test', ':streams:upgrade-system-tests-31:test', ':streams:upgrade-system-tests-32:test', ':streams:upgrade-system-tests-33:test', ':streams:examples:test' ] ) } project(':streams:streams-scala') { apply plugin: 'scala' archivesBaseName = "kafka-streams-scala_${versions.baseScala}" dependencies { api project(':streams') api libs.scalaLibrary api libs.scalaCollectionCompat testImplementation project(':core') testImplementation project(':core').sourceSets.test.output testImplementation project(':server-common').sourceSets.test.output testImplementation project(':streams').sourceSets.test.output testImplementation project(':clients').sourceSets.test.output testImplementation project(':streams:test-utils') testImplementation libs.junitJupiter testImplementation libs.easymock testImplementation libs.hamcrest testRuntimeOnly libs.slf4jlog4j } javadoc { include "**/org/apache/kafka/streams/scala/**" } scaladoc { scalaDocOptions.additionalParameters = ["-no-link-warnings"] } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.runtimeClasspath) { exclude('kafka-streams*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } // spotless 6.14 requires Java 11 at runtime if (JavaVersion.current().isJava11Compatible()) { apply plugin: 'com.diffplug.spotless' spotless { scala { target '**/*.scala' scalafmt("$versions.scalafmt").configFile('../../checkstyle/.scalafmt.conf').scalaMajorVersion(versions.baseScala) licenseHeaderFile '../../checkstyle/java.header', 'package' } } } } project(':streams:test-utils') { archivesBaseName = "kafka-streams-test-utils" dependencies { api project(':streams') api project(':clients') implementation libs.slf4jApi testImplementation project(':clients').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.mockitoCore testImplementation libs.hamcrest testRuntimeOnly libs.slf4jlog4j } javadoc { include "**/org/apache/kafka/streams/test/**" } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.runtimeClasspath) { exclude('kafka-streams*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } } project(':streams:examples') { archivesBaseName = "kafka-streams-examples" dependencies { // this dependency should be removed after we unify data API implementation(project(':connect:json')) { // this transitive dependency is not used in Streams, and it breaks SBT builds exclude module: 'javax.ws.rs-api' } implementation project(':streams') implementation libs.slf4jlog4j testImplementation project(':streams:test-utils') testImplementation project(':clients').sourceSets.test.output // for org.apache.kafka.test.IntegrationTest testImplementation libs.junitJupiter testImplementation libs.hamcrest } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.runtimeClasspath) { exclude('kafka-streams*') } into "$buildDir/dependant-libs-${versions.scala}" duplicatesStrategy 'exclude' } jar { dependsOn 'copyDependantLibs' } } project(':streams:upgrade-system-tests-0100') { archivesBaseName = "kafka-streams-upgrade-system-tests-0100" dependencies { testImplementation(libs.kafkaStreams_0100) { exclude group: 'org.slf4j', module: 'slf4j-log4j12' exclude group: 'log4j', module: 'log4j' } testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-0101') { archivesBaseName = "kafka-streams-upgrade-system-tests-0101" dependencies { testImplementation(libs.kafkaStreams_0101) { exclude group: 'org.slf4j', module: 'slf4j-log4j12' exclude group: 'log4j', module: 'log4j' } testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-0102') { archivesBaseName = "kafka-streams-upgrade-system-tests-0102" dependencies { testImplementation libs.kafkaStreams_0102 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-0110') { archivesBaseName = "kafka-streams-upgrade-system-tests-0110" dependencies { testImplementation libs.kafkaStreams_0110 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-10') { archivesBaseName = "kafka-streams-upgrade-system-tests-10" dependencies { testImplementation libs.kafkaStreams_10 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-11') { archivesBaseName = "kafka-streams-upgrade-system-tests-11" dependencies { testImplementation libs.kafkaStreams_11 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-20') { archivesBaseName = "kafka-streams-upgrade-system-tests-20" dependencies { testImplementation libs.kafkaStreams_20 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-21') { archivesBaseName = "kafka-streams-upgrade-system-tests-21" dependencies { testImplementation libs.kafkaStreams_21 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-22') { archivesBaseName = "kafka-streams-upgrade-system-tests-22" dependencies { testImplementation libs.kafkaStreams_22 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-23') { archivesBaseName = "kafka-streams-upgrade-system-tests-23" dependencies { testImplementation libs.kafkaStreams_23 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-24') { archivesBaseName = "kafka-streams-upgrade-system-tests-24" dependencies { testImplementation libs.kafkaStreams_24 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-25') { archivesBaseName = "kafka-streams-upgrade-system-tests-25" dependencies { testImplementation libs.kafkaStreams_25 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-26') { archivesBaseName = "kafka-streams-upgrade-system-tests-26" dependencies { testImplementation libs.kafkaStreams_26 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-27') { archivesBaseName = "kafka-streams-upgrade-system-tests-27" dependencies { testImplementation libs.kafkaStreams_27 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-28') { archivesBaseName = "kafka-streams-upgrade-system-tests-28" dependencies { testImplementation libs.kafkaStreams_28 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-30') { archivesBaseName = "kafka-streams-upgrade-system-tests-30" dependencies { testImplementation libs.kafkaStreams_30 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-31') { archivesBaseName = "kafka-streams-upgrade-system-tests-31" dependencies { testImplementation libs.kafkaStreams_31 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-32') { archivesBaseName = "kafka-streams-upgrade-system-tests-32" dependencies { testImplementation libs.kafkaStreams_32 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':streams:upgrade-system-tests-33') { archivesBaseName = "kafka-streams-upgrade-system-tests-33" dependencies { testImplementation libs.kafkaStreams_33 testRuntimeOnly libs.junitJupiter } systemTestLibs { dependsOn testJar } } project(':jmh-benchmarks') { apply plugin: 'com.github.johnrengelman.shadow' shadowJar { archiveBaseName = 'kafka-jmh-benchmarks' } dependencies { implementation(project(':core')) { // jmh requires jopt 4.x while `core` depends on 5.0, they are not binary compatible exclude group: 'net.sf.jopt-simple', module: 'jopt-simple' } implementation project(':server-common') implementation project(':clients') implementation project(':group-coordinator') implementation project(':metadata') implementation project(':storage') implementation project(':streams') implementation project(':core') implementation project(':connect:api') implementation project(':connect:transforms') implementation project(':clients').sourceSets.test.output implementation project(':core').sourceSets.test.output implementation project(':server-common').sourceSets.test.output implementation libs.jmhCore annotationProcessor libs.jmhGeneratorAnnProcess implementation libs.jmhCoreBenchmarks implementation libs.jacksonDatabind implementation libs.metrics implementation libs.mockitoCore implementation libs.slf4jlog4j implementation libs.scalaLibrary implementation libs.scalaJava8Compat } tasks.withType(JavaCompile) { // Suppress warning caused by code generated by jmh: `warning: [cast] redundant cast to long` options.compilerArgs << "-Xlint:-cast" } jar { manifest { attributes "Main-Class": "org.openjdk.jmh.Main" } } checkstyle { configProperties = checkstyleConfigProperties("import-control-jmh-benchmarks.xml") } task jmh(type: JavaExec, dependsOn: [':jmh-benchmarks:clean', ':jmh-benchmarks:shadowJar']) { mainClass = "-jar" doFirst { if (System.getProperty("jmhArgs")) { args System.getProperty("jmhArgs").split(' ') } args = [shadowJar.archivePath, *args] } } javadoc { enabled = false } } project(':log4j-appender') { archivesBaseName = "kafka-log4j-appender" dependencies { implementation project(':clients') implementation libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output testImplementation libs.junitJupiter testImplementation libs.hamcrest testImplementation libs.mockitoCore } javadoc { enabled = false } } project(':connect:api') { archivesBaseName = "connect-api" dependencies { api project(':clients') implementation libs.slf4jApi implementation libs.jaxrsApi testImplementation libs.junitJupiter testRuntimeOnly libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output } javadoc { include "**/org/apache/kafka/connect/**" // needed for the `aggregatedJavadoc` task } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:transforms') { archivesBaseName = "connect-transforms" dependencies { api project(':connect:api') implementation libs.slf4jApi testImplementation libs.easymock testImplementation libs.junitJupiter testRuntimeOnly libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:json') { archivesBaseName = "connect-json" dependencies { api project(':connect:api') api libs.jacksonDatabind api libs.jacksonJDK8Datatypes implementation libs.slf4jApi testImplementation libs.easymock testImplementation libs.junitJupiter testRuntimeOnly libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:runtime') { configurations { swagger } archivesBaseName = "connect-runtime" dependencies { // connect-runtime is used in tests, use `api` for modules below for backwards compatibility even though // applications should generally not depend on `connect-runtime` api project(':connect:api') api project(':clients') api project(':connect:json') api project(':connect:transforms') implementation libs.slf4jApi implementation libs.log4j implementation libs.jose4j // for SASL/OAUTHBEARER JWT validation implementation libs.jacksonAnnotations implementation libs.jacksonJaxrsJsonProvider implementation libs.jerseyContainerServlet implementation libs.jerseyHk2 implementation libs.jaxbApi // Jersey dependency that was available in the JDK before Java 9 implementation libs.activation // Jersey dependency that was available in the JDK before Java 9 implementation libs.jettyServer implementation libs.jettyServlet implementation libs.jettyServlets implementation libs.jettyClient implementation libs.reflections implementation libs.mavenArtifact implementation libs.swaggerAnnotations // We use this library to generate OpenAPI docs for the REST API, but we don't want or need it at compile // or run time. So, we add it to a separate configuration, which we use later on during docs generation swagger libs.swaggerJaxrs2 testImplementation project(':clients').sourceSets.test.output testImplementation project(':core') testImplementation project(':metadata') testImplementation project(':core').sourceSets.test.output testImplementation project(':server-common') testImplementation project(':connect:test-plugins') testImplementation libs.easymock testImplementation libs.junitJupiterApi testImplementation libs.junitVintageEngine testImplementation libs.powermockJunit4 testImplementation libs.powermockEasymock testImplementation libs.mockitoCore testImplementation libs.httpclient testRuntimeOnly libs.slf4jlog4j testRuntimeOnly libs.bcpkix } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { // No need to copy log4j since the module has an explicit dependency on that include('slf4j-log4j12*') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } task genConnectConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.runtime.distributed.DistributedConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "connect_config.html").newOutputStream() } task genSinkConnectorConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.runtime.SinkConnectorConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "sink_connector_config.html").newOutputStream() } task genSourceConnectorConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.runtime.SourceConnectorConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "source_connector_config.html").newOutputStream() } task genConnectTransformationDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.tools.TransformationDoc' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "connect_transforms.html").newOutputStream() } task genConnectPredicateDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.tools.PredicateDoc' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "connect_predicates.html").newOutputStream() } task genConnectMetricsDocs(type: JavaExec) { classpath = sourceSets.test.runtimeClasspath mainClass = 'org.apache.kafka.connect.runtime.ConnectMetrics' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "connect_metrics.html").newOutputStream() } task setVersionInOpenAPISpec(type: Copy) { from "$rootDir/gradle/openapi.template" into "$buildDir/resources/docs" rename ('openapi.template', 'openapi.yaml') expand(kafkaVersion: "$rootProject.version") } task genConnectOpenAPIDocs(type: io.swagger.v3.plugins.gradle.tasks.ResolveTask, dependsOn: setVersionInOpenAPISpec) { classpath = sourceSets.main.runtimeClasspath buildClasspath = classpath + configurations.swagger outputFileName = 'connect_rest' outputFormat = 'YAML' prettyPrint = 'TRUE' sortOutput = 'TRUE' openApiFile = file("$buildDir/resources/docs/openapi.yaml") resourcePackages = ['org.apache.kafka.connect.runtime.rest.resources'] if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } outputDir = file(generatedDocsDir) } } project(':connect:file') { archivesBaseName = "connect-file" dependencies { implementation project(':connect:api') implementation libs.slf4jApi testImplementation libs.junitJupiter testImplementation libs.mockitoCore testRuntimeOnly libs.slf4jlog4j testImplementation project(':clients').sourceSets.test.output testImplementation project(':connect:runtime') testImplementation project(':connect:runtime').sourceSets.test.output testImplementation project(':core') testImplementation project(':core').sourceSets.test.output } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:basic-auth-extension') { archivesBaseName = "connect-basic-auth-extension" dependencies { implementation project(':connect:api') implementation libs.slf4jApi implementation libs.jaxrsApi implementation libs.jaxAnnotationApi testImplementation libs.bcpkix testImplementation libs.mockitoCore testImplementation libs.junitJupiter testImplementation project(':clients').sourceSets.test.output testRuntimeOnly libs.slf4jlog4j testRuntimeOnly libs.jerseyContainerServlet } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:mirror') { archivesBaseName = "connect-mirror" dependencies { implementation project(':connect:api') implementation project(':connect:runtime') implementation project(':connect:mirror-client') implementation project(':clients') implementation libs.argparse4j implementation libs.jacksonAnnotations implementation libs.slf4jApi implementation libs.jacksonAnnotations implementation libs.jacksonJaxrsJsonProvider implementation libs.jerseyContainerServlet implementation libs.jerseyHk2 implementation libs.jaxbApi // Jersey dependency that was available in the JDK before Java 9 implementation libs.activation // Jersey dependency that was available in the JDK before Java 9 implementation libs.jettyServer implementation libs.jettyServlet implementation libs.jettyServlets implementation libs.jettyClient implementation libs.swaggerAnnotations testImplementation libs.junitJupiter testImplementation libs.log4j testImplementation libs.mockitoCore testImplementation project(':clients').sourceSets.test.output testImplementation project(':connect:runtime').sourceSets.test.output testImplementation project(':core') testImplementation project(':core').sourceSets.test.output testRuntimeOnly project(':connect:runtime') testRuntimeOnly libs.slf4jlog4j testRuntimeOnly libs.bcpkix } javadoc { enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } task genMirrorConnectorConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.mirror.MirrorConnectorConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "mirror_connector_config.html").newOutputStream() } task genMirrorSourceConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.mirror.MirrorSourceConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "mirror_source_config.html").newOutputStream() } task genMirrorCheckpointConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.mirror.MirrorCheckpointConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "mirror_checkpoint_config.html").newOutputStream() } task genMirrorHeartbeatConfigDocs(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath mainClass = 'org.apache.kafka.connect.mirror.MirrorHeartbeatConfig' if( !generatedDocsDir.exists() ) { generatedDocsDir.mkdirs() } standardOutput = new File(generatedDocsDir, "mirror_heartbeat_config.html").newOutputStream() } jar { dependsOn copyDependantLibs } } project(':connect:mirror-client') { archivesBaseName = "connect-mirror-client" dependencies { implementation project(':clients') implementation libs.slf4jApi testImplementation libs.junitJupiter testImplementation project(':clients').sourceSets.test.output testRuntimeOnly libs.slf4jlog4j } javadoc { enabled = true } tasks.create(name: "copyDependantLibs", type: Copy) { from (configurations.testRuntimeClasspath) { include('slf4j-log4j12*') include('reload4j*jar') } from (configurations.runtimeClasspath) { exclude('kafka-clients*') exclude('connect-*') } into "$buildDir/dependant-libs" duplicatesStrategy 'exclude' } jar { dependsOn copyDependantLibs } } project(':connect:test-plugins') { archivesBaseName = "connect-test-plugins" dependencies { api project(':connect:api') implementation project(':server-common') implementation libs.slf4jApi implementation libs.jacksonDatabind } } task aggregatedJavadoc(type: Javadoc, dependsOn: compileJava) { def projectsWithJavadoc = subprojects.findAll { it.javadoc.enabled } source = projectsWithJavadoc.collect { it.sourceSets.main.allJava } classpath = files(projectsWithJavadoc.collect { it.sourceSets.main.compileClasspath }) includes = projectsWithJavadoc.collectMany { it.javadoc.getIncludes() } excludes = projectsWithJavadoc.collectMany { it.javadoc.getExcludes() } options.charSet = 'UTF-8' options.docEncoding = 'UTF-8' options.encoding = 'UTF-8' // Turn off doclint for now, see https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html for rationale options.addStringOption('Xdoclint:none', '-quiet') // The URL structure was changed to include the locale after Java 8 if (JavaVersion.current().isJava11Compatible()) options.links "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/" else options.links "https://docs.oracle.com/javase/8/docs/api/" }