Merge Grails Spring Security Plugin repositories #1057

matrei · 2025-02-24T14:49:18Z

This PR merges the following Grails Spring Security Plugins into this repository:

ACL
CAS
LDAP
Oauth2
Rest
UI

WIP - Publishing

…s-jose-jwt-9.x Update dependency com.nimbusds:nimbus-jose-jwt to v9.41.2

Update pac4jVersion to v5.7.7

Bumps [commons-codec:commons-codec](https://github.com/apache/commons-codec) from 1.16.0 to 1.16.1. - [Changelog](https://github.com/apache/commons-codec/blob/master/RELEASE-NOTES.txt) - [Commits](apache/commons-codec@rel/commons-codec-1.16.0...rel/commons-codec-1.16.1) --- updated-dependencies: - dependency-name: commons-codec:commons-codec dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [net.bytebuddy:byte-buddy](https://github.com/raphw/byte-buddy) from 1.14.11 to 1.14.19. - [Release notes](https://github.com/raphw/byte-buddy/releases) - [Changelog](https://github.com/raphw/byte-buddy/blob/master/release-notes.md) - [Commits](raphw/byte-buddy@byte-buddy-1.14.11...byte-buddy-1.14.19) --- updated-dependencies: - dependency-name: net.bytebuddy:byte-buddy dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

…mons-codec-commons-codec-1.16.1 Bump commons-codec:commons-codec from 1.16.0 to 1.16.1

Update dependency com.google.guava:guava to v33.3.1-jre

Update dependency gradle to v7.6.4

…mons-codec-commons-codec-1.16.1 Bump commons-codec:commons-codec from 1.16.0 to 1.16.1

….bytebuddy-byte-buddy-1.14.19 Bump net.bytebuddy:byte-buddy from 1.14.11 to 1.14.19

…ons-codec-1.x Update dependency commons-codec:commons-codec to v1.17.1

Disable `standardOut` and `standardError` test event output

Because GitHub action stalled.

Removed PDF and EPUB from `acl` and `cas` for now.

jdaugherty

My main concerns are:

the doc publishing, i think only core is publishing
the nested readme files need updated to remove their badges and links to refer to the new repo

I pointed out some out dated code in the docs, but we can ticket to fix that later if you want.

If I can help with the doc publishing, please let me know. I'm happy to make those changes to expedite this.

jdaugherty · 2025-02-25T14:08:23Z

plugin-cas/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License


Only the license file at the root of the project needs to remain; this can be removed.

jdaugherty · 2025-02-25T14:08:39Z

plugin-ldap/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License


Only the license file at the root of the project needs to remain; this can be removed.

jdaugherty · 2025-02-25T14:08:51Z

plugin-oauth2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License


Only the license file at the root of the project needs to remain; this can be removed.

jdaugherty · 2025-02-25T14:09:02Z

plugin-rest/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License


Only the license file at the root of the project needs to remain; this can be removed.

jdaugherty · 2025-02-25T14:16:47Z

gradle.properties

+commonsLangVersion=2.6
+dumbsterVersion=1.6
+grailsRedisVersion=5.0.0-M1
+hibernateVersion=5.6.15.Final


I see this is being used under acl-examples-functional-test-app, but the gorm-hibernate5 should already be including this library. Why are we including it separately and having to maintain the hibernate version separately?

acl-examples-functional-test-app is using org.hibernate.ObjectNotFoundException

ui-examples-extended and ui-examples-simple are using org.hibernate.SessionFactory

This makes org.hibernate:hibernate-core-jakarta a direct dependency of these projects, so it should be declared as such. If we add the version to grails-bom (hibernate5.version?) or when we move to Hibernate 6 (hibernate.version is available in spring-boot-dependencies) we can omit this.

What are your thoughts on exposing hibernate5 as an API as part of gorm-hibernate5?

ObjectNotFoundException is directly thrown by DomainClass.get(id) - if you want performant applications, you'll have to add @GrailsCompileStatic which means any place someone uses a get() method, they will be forced to add this gradle library. I suspect that means pretty much everywhere for any real world use of hibernate.

Again, if type checking is enabled, the Hibernate Session class will be the argument to helpers like withNewSession { }.

I'd normally agree you have to manually expose these, but with the hibernate5 not being able to be put in the bom, the gorm implementation acting as a wrapper around hibernate, and the compatibility issues between 5 & 6, it seems worth to expose as an API dependency.

Wait, looking closer at the gorm-hibernate5 project:

api "org.hibernate:hibernate-core-jakarta:$hibernateVersion", {

It's already added as an api. We shouldn't be overriding it since that's a maintenance burden.

Yes, it adds a minimal maintenance burden (in this case I think the burden is actually zero as I don't think the version will change), but declaring your direct dependencies is a best practice that also brings stability and clarity.

If you still oppose this I will remove the dependency declaration, as these are only example/test apps, but for libraries I think we should be more rigid as not adhering to this has been a source problems and confusion historically (at least for me).

I 100% agree we should be declaring direct dependencies for our libraries / internal projects to grails-core. We should be as detailed as possible in our gradle projects given the scope.

With that said, I want to be careful about having end grails apps do so. These are examples, so they are end apps in my mind. I disagree with adding extra dependencies here. Developers are going to use this as an example and I view gorm-hibernate5 as an extension of hibernate5, not an addition. We want our examples to represent end user apps and we don't want the user to have to redefine these. There's the added benefit that it's less maintenance burden long term as we upgrade too.

jdaugherty · 2025-02-25T14:26:10Z

plugin-acl/docs/src/docs/code/gradle/wrapper/gradle-wrapper.jar

Not sure why there's a nested project under the docs, can this whole project be moved out to a test example and referenced? I'm going to stop making comments similar to this on everything in the code directory under docs

jdaugherty · 2025-02-25T14:26:56Z

.github/workflows/gradle.yml

+          MAVEN_PUBLISH_PASSWORD: ${{ secrets.MAVEN_PUBLISH_PASSWORD }}
+        run: ./gradlew --no-build-cache publish
+      - name: "🔨 Generate Snapshot Documentation"
+        run: ./gradlew core-docs:docs


This only publishes the core-docs. Do we intend to combine the docs together or leave separate and publish as subdirectories? My first reaction is to keep them separate.

jdaugherty · 2025-02-25T14:36:50Z

plugin-oauth2/README.md

@@ -0,0 +1,78 @@
+Spring Security OAuth2 Plugin
+=======
+[![Java CI](https://github.com/grails/grails-spring-security-oauth2/actions/workflows/gradle.yml/badge.svg)](https://github.com/grails/grails-spring-security-oauth2/actions/workflows/gradle.yml)


Can we remove the badges from this file since they won't be valid anymore?

jdaugherty · 2025-02-25T14:37:36Z

plugin-oauth2/README.md

+```groovy
+dependencies {
+...
+    implementation 'org.grails.plugins:spring-security-core:5.2.1'


Can we move the installation instructions to the docs so the versions can be updated as part of the build process?

I'll defer updating the README files to another PR.

jdaugherty · 2025-02-25T14:38:11Z

plugin-rest/docs/build.gradle

+        'icons'           : 'font',
+        'version'         : project.version,
+        'sourcedir'       : "${rootProject.allprojects.find { it.name == 'spring-security-rest' }.projectDir}/src/main/groovy",
+        'baseGroovyApiUrl': "https://grails-plugins.github.io/grails-spring-security-rest/${project.version}/docs/gapi/"


I believe this link will be invalid now.

Only keep the LICENSE file in the root project directory.

These files are not used anymore as the projects are merged and only need one `ghpages.html` file.

For removing aggregated docs.

Plus some other housekeeping.

jdaugherty · 2025-02-27T21:04:00Z

plugin-cas/docs/src/docs/index.adoc

@@ -1,15 +1,14 @@
-:includedir: src/docs/
 = Spring Security CAS Plugin - Reference Documentation
 Puneet Behl <behlp@unityfoundation.io>


Should we remove this since we dont' typically put the original author or maintainers in the docs at the top?

jdaugherty and others added 30 commits October 15, 2024 13:16

Initial publishing configuration for repo.grails.org

8ec6ae6

Merge pull request apache#524 from jdaugherty/5.0.x

d7655c4

WIP - Publishing

Remove equals to fix pom developer

71e7cba

Merge remote-tracking branch 'upstream/5.0.x' into 5.0.x

21920c7

Merge remote-tracking branch 'upstream/5.0.x' into 5.0.x

9035a48

Fix doc location

3cc12f9

Rename index page

8e8afcd

Place ghpages in docs folder

f376106

Fix old version references

5073e90

Merge branch '5.0.x' into 6.0.x

f059a4f

Update pac4jVersion to v5.7.7

af3a3bd

Update dependency com.google.guava:guava to v33.3.1-jre

3220be4

Update dependency com.nimbusds:nimbus-jose-jwt to v9.41.2

16f103e

Merge pull request apache#526 from grails/renovate/com.nimbusds-nimbu…

c08c053

…s-jose-jwt-9.x Update dependency com.nimbusds:nimbus-jose-jwt to v9.41.2

Merge pull request apache#525 from grails/renovate/pac4jversion

ba7ea80

Update pac4jVersion to v5.7.7

Update dependabot

46503c2

Merge pull request apache#528 from grails/dependabot/gradle/6.0.x/com…

068fc7e

…mons-codec-commons-codec-1.16.1 Bump commons-codec:commons-codec from 1.16.0 to 1.16.1

Merge pull request apache#510 from grails/renovate/guava-monorepo

32b0415

Update dependency com.google.guava:guava to v33.3.1-jre

Update dependency commons-codec:commons-codec to v1.17.1

03f759b

Merge pull request apache#505 from grails/renovate/gradle-7.x

f3dd564

Update dependency gradle to v7.6.4

Merge pull request apache#527 from grails/dependabot/gradle/5.0.x/com…

d5decab

…mons-codec-commons-codec-1.16.1 Bump commons-codec:commons-codec from 1.16.0 to 1.16.1

Merge pull request apache#531 from grails/dependabot/gradle/6.0.x/net…

92e5b89

….bytebuddy-byte-buddy-1.14.19 Bump net.bytebuddy:byte-buddy from 1.14.11 to 1.14.19

Merge pull request apache#512 from grails/renovate/commons-codec-comm…

a968507

…ons-codec-1.x Update dependency commons-codec:commons-codec to v1.17.1

Update plugin com.github.ben-manes.versions to v0.51.0

ca5888b

Update gradle/wrapper-validation-action action to v3

664475b

Grails 7 support

f3b23a4

Merge remote-tracking branch 'upstream/6.0.x' into 6.0.x

c47fadc

matrei added 7 commits February 24, 2025 16:31

test: fix another getWithAuth() error

d0350b8

build: add group to rest-testapp-profile project

20f339a

build: fix core-docs generation

fb4c43e

ci: update gradle.yml

cbb624d

ci: Update build scan and build cache config

219742c

build: disable some test output

f4b40f8

Disable `standardOut` and `standardError` test event output

ci: set --max-workers=2

e5b0471

Because GitHub action stalled.

matrei requested a review from jdaugherty February 24, 2025 17:08

build(docs): fix guide docs generation

90a687d

Removed PDF and EPUB from `acl` and `cas` for now.

jdaugherty reviewed Feb 25, 2025

View reviewed changes

jamesfredley linked an issue Feb 25, 2025 that may be closed by this pull request

Merge 6 additional Spring Security projects into grails-spring-security-core #1052

Closed

matrei added 6 commits February 26, 2025 11:35

refactor: remove individual LICENSE files

7ab635b

Only keep the LICENSE file in the root project directory.

docs: remove unused index.tmpl files

81094c7

These files are not used anymore as the projects are merged and only need one `ghpages.html` file.

build: remove unused import in root build.gradle

9afaa98

build: add clean task to root project

d05d4ff

For removing aggregated docs.

docs: update all README files

32e5e12

docs: aggregate all docs for publishing

af1e1fa

matrei marked this pull request as draft February 27, 2025 17:18

matrei added 2 commits February 27, 2025 21:29

build: cleanup commented code

c535f4a

ci: update workflows of aggregated docs

90ab3e7

Plus some other housekeeping.

matrei marked this pull request as ready for review February 27, 2025 20:50

build: remove hibernateVersion

0f7feef

jdaugherty approved these changes Feb 27, 2025

View reviewed changes

docs: remove author from cas guide

0a30930

jamesfredley added this to Grails 7 Feb 27, 2025

jamesfredley added this to the grails:7.0.0-M2 milestone Feb 27, 2025

jamesfredley moved this to In Progress in Grails 7 Feb 27, 2025

matrei merged commit 270ccd4 into apache:7.0.x Feb 27, 2025
14 checks passed

github-project-automation bot moved this from In Progress to Done in Grails 7 Feb 27, 2025

matrei deleted the matrei/merge-security-repos branch February 27, 2025 22:14

Merge Grails Spring Security Plugin repositories #1057

Merge Grails Spring Security Plugin repositories #1057

Conversation

matrei commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jdaugherty left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdaugherty Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

matrei commented Feb 24, 2025 •

edited

Loading

jdaugherty Feb 26, 2025 •

edited

Loading