[KYUUBI #5255] Add an optional comment field to the authz specs for better recognition

[davidyuan1223]

🔍 Description

Issue References 🔗

This pull request fixes #5255

Describe Your Solution 🔧

Add Optional comment field for desc, so that we can get information when the command from third party

Types of changes 🔖

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Test Plan 🧪

Behavior Without This Pull Request ⚰️

Behavior With This Pull Request 🎉

Related Unit Tests

---

Checklists

📝 Author Self Checklist

• My code follows the style guidelines of this project
• I have performed a self-review
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• This patch was not authored or co-authored using Generative Tooling

📝 Committer Pre-Merge Checklist

• Pull request title is okay.
• No license issues.
• Milestone correctly set?
• Test coverage is ok
• Assignees are selected.
• Minimum number of approvals
• No changes are requested

Be nice. Be informative.

[davidyuan1223]

@yaooqinn Is the first step in implementing this issue to add this field? Then add corresponding comment for the third party?

[yaooqinn]

Is the first step in implementing this issue to add this field?

Yes,

Then add corresponding comment for the third party?

Not really necessary for a new separate PR, the comment can go with new features together.

[davidyuan1223]

@yaooqinn please review this, i think comment filed be string is a better way, and i add comment in the error message when the desc is failed, but i'm not sure which comment should add in third parties, so i only set their name to the comment

[yaooqinn]

Hi @davidyuan1223, sorry for the late reply, please fix the conflicts when you have some time.

[davidyuan1223]

Hi @davidyuan1223, sorry for the late reply, please fix the conflicts when you have some time.

ok

[yaooqinn]

please also remove the wip in the pr title

[yaooqinn]

Hi @davidyuan1223 please make the ci pass.

[davidyuan1223]

Hi @davidyuan1223 please make the ci pass.

the test case failed reason maybe not from my code change, the update should not effect the test case, it's only a comment

  "Permission denied: user [someone] does not have [select] privilege on [delta_ns/table2_delta/id,delta_ns/table2_delta/name,delta_ns/table2_delta/gender,delta_ns/table2_delta/birthDate]" did not end with "does not have [select] privilege on [delta_ns/table2_delta/id,delta_ns/table2_delta/name,delta_ns/table2_delta/gender,delta_ns/table2_delta/birthDate], [write] privilege on [[/home/runner/work/kyuubi/kyuubi/extensions/spark/kyuubi-spark-authz/target/tmp/kyuubi-c67ef1f6-4cdf-43b8-882d-6593868d42a2, /home/runner/work/kyuubi/kyuubi/extensions/spark/kyuubi-spark-authz/target/tmp/kyuubi-c67ef1f6-4cdf-43b8-882d-6593868d42a2/]]" (DeltaCatalogRangerSparkExtensionSuite.scala:426)
- optimize path-based table *** FAILED ***

[yaooqinn]

I believe in you. But SORRY, the CI has to pass for each single PR.

[davidyuan1223]

I believe in you. But SORRY, the CI has to pass for each single PR.

ok, i will find the root cause

[zml1206]

@davidyuan1223 The above two places are the reasons why CI fails.

[davidyuan1223]

@davidyuan1223 The above two places are the reasons why CI fails.

thanks, i will fix that

[zml1206]

table_command_spec.json has no synchronized changes.

[davidyuan1223]

table_command_spec.json has no synchronized changes.

my bad, will fix this

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fdcb456) 61.40% compared to head (46234e1) 61.42%.
Report is 8 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #5706      +/-   ##
============================================
+ Coverage     61.40%   61.42%   +0.02%     
  Complexity       23       23              
============================================
  Files           607      607              
  Lines         35897    35940      +43     
  Branches       4923     4932       +9     
============================================
+ Hits          22042    22077      +35     
- Misses        11474    11480       +6     
- Partials       2381     2383       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[yaooqinn]

thanks, merged to master