spring-security-docs.gradle 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
  2. plugins {
  3. id 'org.antora' version '1.0.0'
  4. id 'io.spring.antora.generate-antora-yml' version '0.0.1'
  5. id 'io.spring.convention.repository'
  6. id 'kotlin'
  7. }
  8. apply plugin: 'io.spring.convention.docs'
  9. apply plugin: 'java'
  10. antora {
  11. options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
  12. environment = [
  13. 'BUILD_REFNAME': 'HEAD',
  14. 'BUILD_VERSION': project.version,
  15. ]
  16. }
  17. tasks.register("syncAntoraAttachments", Sync) {
  18. group = 'Documentation'
  19. description = 'Syncs the Antora attachments'
  20. from project.provider( { project.tasks.api.outputs } )
  21. into project.layout.buildDirectory.dir('generated-antora-resources/modules/ROOT/assets/attachments/api/java')
  22. }
  23. tasks.named("generateAntoraYml") {
  24. asciidocAttributes = project.provider( { generateAttributes() } )
  25. asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) }))
  26. }
  27. tasks.register("generateAntoraResources") {
  28. dependsOn 'generateAntoraYml', 'syncAntoraAttachments'
  29. }
  30. dependencies {
  31. testImplementation platform(project(':spring-security-dependencies'))
  32. testImplementation project(':spring-security-config')
  33. testImplementation project(path : ':spring-security-config', configuration : 'tests')
  34. testImplementation project(':spring-security-test')
  35. testImplementation project(':spring-security-oauth2-client')
  36. testImplementation 'com.squareup.okhttp3:mockwebserver'
  37. testImplementation 'com.unboundid:unboundid-ldapsdk'
  38. testImplementation libs.webauthn4j.core
  39. testImplementation 'org.jetbrains.kotlin:kotlin-reflect'
  40. testImplementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'
  41. testImplementation 'org.springframework:spring-core'
  42. testImplementation 'org.springframework:spring-test'
  43. testImplementation 'org.springframework:spring-webmvc'
  44. testImplementation 'jakarta.servlet:jakarta.servlet-api'
  45. testImplementation 'io.mockk:mockk'
  46. testImplementation "org.junit.jupiter:junit-jupiter-api"
  47. testImplementation "org.junit.jupiter:junit-jupiter-params"
  48. testImplementation "org.junit.jupiter:junit-jupiter-engine"
  49. testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
  50. }
  51. def generateAttributes() {
  52. def springFrameworkVersion = libs.org.springframework.spring.framework.bom.get().versionConstraint.displayName
  53. springFrameworkVersion = springFrameworkVersion.contains("-")
  54. ? springFrameworkVersion.substring(0, springFrameworkVersion.indexOf("-"))
  55. : springFrameworkVersion
  56. def springBootVersion = project.property("springBootVersion")
  57. def samplesBranch = project.property("samplesBranch")
  58. def docsTag = snapshotBuild ? 'current' : project.version
  59. def ghTag = snapshotBuild ? 'main' : project.version
  60. def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
  61. def ghOldSamplesUrl = 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples'
  62. def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch"
  63. def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag"
  64. def securityApiUrl = "$securityDocsUrl/api/"
  65. def securityReferenceUrl = "$securityDocsUrl/reference/html5/"
  66. def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/"
  67. def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/reference/$springFrameworkVersion/"
  68. def springBootReferenceUrl = "https://docs.spring.io/spring-boot/$springBootVersion/"
  69. def springBootApiUrl = "https://docs.spring.io/spring-boot/$springBootVersion/api/java/"
  70. return ['gh-old-samples-url': ghOldSamplesUrl.toString(),
  71. 'gh-samples-url': ghSamplesUrl.toString(),
  72. 'gh-url': ghUrl.toString(),
  73. 'security-api-url': securityApiUrl.toString(),
  74. 'security-reference-url': securityReferenceUrl.toString(),
  75. 'spring-framework-api-url': springFrameworkApiUrl.toString(),
  76. 'spring-framework-reference-url': springFrameworkReferenceUrl.toString(),
  77. 'spring-boot-api-url': springBootApiUrl.toString(),
  78. 'spring-boot-reference-url': springBootReferenceUrl.toString(),
  79. 'spring-security-version': project.version]
  80. + resolvedVersions(project.configurations.testRuntimeClasspath)
  81. }
  82. def resolvedVersions(Configuration configuration) {
  83. return configuration.resolvedConfiguration
  84. .resolvedArtifacts
  85. .collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] }
  86. }
  87. test {
  88. useJUnitPlatform()
  89. }
  90. tasks.withType(KotlinCompile).configureEach {
  91. kotlinOptions {
  92. languageVersion = "1.7"
  93. apiVersion = "1.7"
  94. freeCompilerArgs = ["-Xjsr305=strict", "-Xsuppress-version-warnings"]
  95. jvmTarget = "17"
  96. }
  97. }