Support icons in folders #1258

strangelookingnerd · 2022-10-07T13:15:55Z

This PR enables the icon configuration on folders, multi-branch projects and organization folders to be accessible. This way one can customize the folder icon via jenkinsci/custom-folder-icon-plugin.
See jenkinsci/custom-folder-icon-plugin#92 as well for details and use case.

Here the jenkinsci/custom-folder-icon-plugin is installed, by default there is only stockFolderIcon and metaDataActionFolderIcon available.

Example configuration:

folder('stock')

userContent('customFolderIcons/custom.png', streamFileFromWorkspace('custom.png'))
folder('custom') {
  icon {
    customFolderIcon {
      foldericon('custom.png')
    } 
  }
}
folder('ionicon') {
  icon {
    ioniconFolderIcon {
      ionicon('jenkins')
    } 
  }
}
folder('build-status') {
  icon {
      buildStatusFolderIcon()
  }
}

strangelookingnerd · 2022-10-07T14:20:46Z

As for the failing test, I have no idea how to fix it if I'm honest other than removing the example. Any hints are highly appreciated.

jonesbusy · 2022-10-11T04:08:19Z

@jamietanna Can you take a look please ?

jonesbusy · 2022-10-29T10:15:25Z

Ping @jenkinsci/job-dsl-plugin-developers

strangelookingnerd · 2022-11-21T08:16:20Z

@jamietanna Any update on this? Just wondering if there is anything I could do to get this merged.

quilicicf · 2023-01-27T17:01:29Z

Stack trace from failing test is:

Expected no exception to be thrown, but got 'javaposse.jobdsl.dsl.DslScriptException'
	at spock.lang.Specification.noExceptionThrown(Specification.java:118)
	at javaposse.jobdsl.dsl.doc.ExampleValidationSpec.test examples in #file(ExampleValidationSpec.groovy:32)
Caused by: javaposse.jobdsl.dsl.DslScriptException: (script, line 8) No signature of method: javaposse.jobdsl.dsl.helpers.icon.FolderIconContext.customFolderIcon() is applicable for argument types: (script$_run_closure1$_closure4$_closure5) values: [script$_run_closure1$_closure4$_closure5@78eced16]
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at javaposse.jobdsl.dsl.AbstractDslScriptLoader.runScriptEngine(AbstractDslScriptLoader.groovy:114)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at javaposse.jobdsl.dsl.AbstractDslScriptLoader.runScripts_closure1(AbstractDslScriptLoader.groovy:61)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at groovy.lang.Closure.call(Closure.java:414)
	at groovy.lang.Closure.call(Closure.java:430)
	at javaposse.jobdsl.dsl.AbstractDslScriptLoader.runScripts(AbstractDslScriptLoader.groovy:46)
	at javaposse.jobdsl.dsl.doc.ExampleValidationSpec.test examples in #file(ExampleValidationSpec.groovy:29)
Caused by: groovy.lang.MissingMethodException: No signature of method: javaposse.jobdsl.dsl.helpers.icon.FolderIconContext.customFolderIcon() is applicable for argument types: (script$_run_closure1$_closure4$_closure5) values: [script$_run_closure1$_closure4$_closure5@78eced16]
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at javaposse.jobdsl.dsl.AbstractExtensibleContext.methodMissing(AbstractExtensibleContext.groovy:19)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at script.run_closure1$_closure4(script:8)
	at script.run_closure1$_closure4(script)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at javaposse.jobdsl.dsl.ContextHelper.executeInContext(ContextHelper.groovy:16)
	at javaposse.jobdsl.dsl.AbstractFolder.icon(AbstractFolder.groovy:66)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at script.run_closure1(script:7)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at groovy.lang.Closure.call(Closure.java:414)
	at groovy.lang.Closure.call(Closure.java:430)
	at javaposse.jobdsl.dsl.JobParent.processItem(JobParent.groovy:238)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at groovy.lang.GroovyObjectSupport.invokeMethod(GroovyObjectSupport.java:46)
	at groovy.lang.Script.invokeMethod(Script.java:80)
	at javaposse.jobdsl.dsl.JobParent.folder(JobParent.groovy:174)
	at script.run(script:6)
	at javaposse.jobdsl.dsl.AbstractDslScriptLoader.runScript(AbstractDslScriptLoader.groovy:138)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at javaposse.jobdsl.dsl.AbstractDslScriptLoader.runScriptEngine(AbstractDslScriptLoader.groovy:108)
	... 7 more

I'd wager that the custom icon plugin is not installed in the test instance and therefore the test script cannot be applied.

The problem is that I don't know how to fix this, a couple ideas:

make the plugin available on the test instance, but no other non-core plugins are installed, which is likely on purpose. This points to either:
- having this plugin added in core (not likely and probably not desirable)
- installing it in the build.gradle file (but it's likely not what the Job DSL plugin maintainers have in mind, they probably want to avoid pulling complexity from non-core plugins in their own)
update the custom folder icon plugin so that its configuration does not clash with that of the Folder plugin which is from the core and installed on all instances. I'm not sure this is the right option either, can the custom folder icon plugin overwrite settings from the Folder plugin? Was the Folder plugin planning for its configuration to be over-written? 🤔

Unfortunately, I'm far from a Gradle pro and I didn't manage to tweak this project's build.gradle file to test my hypothesis 😞

strangelookingnerd · 2023-01-29T11:25:27Z

@quilicicf sums it up perfectly.

I'd wager that the custom icon plugin is not installed in the test instance and therefore the test script cannot be applied.

I do second this, however I yet have to find a way to change that.

make the plugin available on the test instance, but no other non-core plugins are installed, which is likely on purpose. This points to either:

having this plugin added in core (not likely and probably not desirable)

installing it in the build.gradle file (but it's likely not what the Job DSL plugin maintainers have in mind, they probably want to avoid pulling complexity from non-core plugins in their own)

I would prefer the 2nd option where my plugin is only pulled as a "test dependency" but should by no means be a required dependency of the job-dsl-plugin otherwise.

update the custom folder icon plugin so that its configuration does not clash with that of the Folder plugin which is from the core and installed on all instances. I'm not sure this is the right option either, can the custom folder icon plugin overwrite settings from the Folder plugin? Was the Folder plugin planning for its configuration to be over-written? 🤔

My plugin uses the intended way of extending the Folders plugin and provides additional functionality alongside its own configuration. There is no clash in any way. To elaborate further, the "icon" property of a folder is intended to be overwritten but this was not foreseen in the job-dsl-plugin implementation - which is exactly what this PR is trying to change.

Unfortunately, I'm far from a Gradle pro and I didn't manage to tweak this project's build.gradle file to test my hypothesis 😞

I'm in the same boat as you and since there is basically little to no documentation for the gradle build process of Jenkins plugins or other plugin projects using gradle to look at I desperately hope for @jamietanna to help me out here and get this PR merged.

quilicicf · 2023-01-30T13:49:57Z

It would be super nice if the Job DSL plugin allowed extensions like this indeed.
Let's wait for maintainers to answer then.

jonesbusy · 2023-03-17T08:42:18Z

Apparently the plugin will switch to maven build (#1265)

strangelookingnerd · 2023-03-17T08:45:33Z

@jonesbusy I will look into this PR again once #1265 is merged ✌🏼

jamietanna · 2023-03-17T08:50:24Z

Thanks folks, sorry for the delay, but with the Maven changes in it may resolve the build issues 🤞🏽

jonesbusy · 2023-03-18T10:42:21Z

job-dsl-core/src/main/docs/examples/javaposse/jobdsl/dsl/Folder/icon.groovy

+}
+
+// use https://github.com/jenkinsci/custom-folder-icon-plugin for ionicons
+folder('ionicon') {


@strangelookingnerd Should we also have a test for new emoji type icons ?

job-dsl-plugin requires Jenkins 2.361.4 whereas custom-folder-icon-plugin 2.5 (which includes the emoji icons) requires 2.387.1 - so I guess this won't be possible right now.

I can probably get a release out next week. Once that's done I would have no problem with revving the minimum Jenkins core to 2.387.1.

@basil That would be great! On a side-note I found that the tests in javaposse.jobdsl.dsl.doc.ExampleValidationSpec do not seem to be run during the build anymore or are at least not reporting any failing tests. Running them manually however shows that the test for my icon.groovy example still fails. Before the switch to Maven the behavior was different. Any idea why that is?

I think it has something to do with the use of @Unroll with file << findAllExamples(), where the right-hand side is a function call rather than a static set of values. Seems that JUnit isn't able to invoke the function call correctly. Are you interested in opening a PR that removes the use of @Unroll in favor of a simple for loop inside of the test?

Remove icon examples in doc as it does not work by any means We keep a link to custom-folder-icon

strangelookingnerd · 2023-03-20T08:10:36Z

@jamietanna I cannot get the ExampleValidationSpec test for the icon.groovy to work the way I want it to. I have no idea why that is and I'm giving up on it for now. Unless you can give me any pointer on what I'm missing, I simply can not put more time into it. I removed the example that uses the custom-folder-icon-plugin and only left the default example.
However I verified manually that everything is working just fine: Once the custom-folder-icon-plugin is installed I have the full selection of implementations available and all of them can be configured and do work just as described in my initial comment.

I would still love to see this merged eventually.

basil

I have not reviewed this change thoroughly. At minimum it is missing @RequiresPlugin/@RequiresPlugins and the icon examples need to be restored.

strangelookingnerd · 2023-03-20T21:06:45Z

I have not reviewed this change thoroughly. At minimum it is missing @RequiresPlugin/@RequiresPlugins and the icon examples need to be restored.

@basil The icon property is provided by the Folders plugin and is not something introduced by the custom-folder-icon. So @RequiresPlugin needs to only be set to the Folders plugin, which is already the case.
For the example I tried everything that came to my mind over the course of now almost 6 month. I was unable to come up with any solution that does work other than disabling the test that fails because of it. As I already said, it would be great to have the examples included but unless someone comes up with an idea why it is not working and / or how to fix it there is nothing I can do.
The test setup with groovy, mocking via Spock and little to no docs / examples even drove me towards looking for a solution via ChatGPT, but it failed me as well. 🤷🏼

basil · 2023-03-21T18:53:29Z

I took a closer look. It looks like FolderPropertiesContext and FolderIconContext are defined in the old-style DSL but extended by the Dynamic DSL. This is inconsistent, but since it is a preëxisting issue I will not insist that you fix it in this PR.

Since the Dynamic DSL is not available in job-dsl-core, the only way for you to test this is in job-dsl-plugin. Please add custom-folder-icon in test scope to job-dsl-plugin/pom.xml and then write tests for this in javaposse.jobdsl.plugin.ExecuteDslScriptsSpec. In this environment, the custom-folder-icon plugin will be loaded by JenkinsRule and will be available for the Dynamic DSL.

(No LLMs were consulted during the writing of this answer.)

strangelookingnerd · 2023-03-21T21:22:00Z

@basil Thanks again for you help. As requested I added tests for every icon type we currently have, excluding the EmojiFolderIcon which I will add once the baseline is bumped to 2.387.1.

basil · 2023-03-21T23:04:48Z

which I will add once the baseline is bumped to 2.387.1.

#1288

strangelookingnerd · 2023-03-22T08:49:55Z

Added a test for the EmojiFolderIcon as well 👍🏼

basil

Thanks!

basil · 2023-03-22T15:30:34Z

Released in 1.83.

strangelookingnerd added 2 commits October 7, 2022 15:05

Enable configuration for icons in folders

41a0759

Add example configuration

03b93b7

strangelookingnerd mentioned this pull request Oct 7, 2022

Missing symbols for JobDSL jenkinsci/custom-folder-icon-plugin#92

Closed

Fix IDE formatting

fa3dc37

jamietanna self-requested a review October 29, 2022 10:22

Merge branch 'jenkinsci:master' into master

567898e

strangelookingnerd requested a review from a team as a code owner March 18, 2023 10:31

jonesbusy reviewed Mar 18, 2023

View reviewed changes

strangelookingnerd added 3 commits March 19, 2023 14:47

Merge branch 'jenkinsci:master' into master

243a543

Fix missing import

c240415

Fix tests

b90adee

Remove icon examples in doc as it does not work by any means We keep a link to custom-folder-icon

Fix IDE formatting

ed1e1fc

jonesbusy approved these changes Mar 20, 2023

View reviewed changes

basil requested changes Mar 20, 2023

View reviewed changes

basil added 2 commits March 21, 2023 11:41

Merge branch 'master' into master

802bf8a

Update @since version

b4b0a50

Add tests for custom folder icons

b4987b1

strangelookingnerd requested review from basil and removed request for jamietanna March 21, 2023 21:23

basil mentioned this pull request Mar 21, 2023

Bump baseline to 2.387.1 #1288

Merged

Merge branch 'master' into master

8e1827f

basil added the enhancement label Mar 22, 2023

strangelookingnerd added 2 commits March 22, 2023 08:09

Merge branch 'master' into master

783a899

Add test for EmojiFolderIcon

05bdb39

basil changed the title ~~Enable configuration for icons in folders~~ Support icons in folders Mar 22, 2023

basil approved these changes Mar 22, 2023

View reviewed changes

basil merged commit 2b2e3f7 into jenkinsci:master Mar 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support icons in folders #1258

Support icons in folders #1258

strangelookingnerd commented Oct 7, 2022

strangelookingnerd commented Oct 7, 2022

jonesbusy commented Oct 11, 2022

jonesbusy commented Oct 29, 2022

strangelookingnerd commented Nov 21, 2022

quilicicf commented Jan 27, 2023

strangelookingnerd commented Jan 29, 2023 •

edited

quilicicf commented Jan 30, 2023

jonesbusy commented Mar 17, 2023

strangelookingnerd commented Mar 17, 2023

jamietanna commented Mar 17, 2023

jonesbusy Mar 18, 2023

strangelookingnerd Mar 18, 2023

basil Mar 19, 2023

strangelookingnerd Mar 19, 2023

basil Mar 19, 2023 •

edited

basil Mar 19, 2023

strangelookingnerd commented Mar 20, 2023

basil left a comment

strangelookingnerd commented Mar 20, 2023

basil commented Mar 21, 2023

strangelookingnerd commented Mar 21, 2023

basil commented Mar 21, 2023

strangelookingnerd commented Mar 22, 2023

basil left a comment

basil commented Mar 22, 2023

Support icons in folders #1258

Support icons in folders #1258

Conversation

strangelookingnerd commented Oct 7, 2022

strangelookingnerd commented Oct 7, 2022

jonesbusy commented Oct 11, 2022

jonesbusy commented Oct 29, 2022

strangelookingnerd commented Nov 21, 2022

quilicicf commented Jan 27, 2023

strangelookingnerd commented Jan 29, 2023 • edited

quilicicf commented Jan 30, 2023

jonesbusy commented Mar 17, 2023

strangelookingnerd commented Mar 17, 2023

jamietanna commented Mar 17, 2023

jonesbusy Mar 18, 2023

Choose a reason for hiding this comment

strangelookingnerd Mar 18, 2023

Choose a reason for hiding this comment

basil Mar 19, 2023

Choose a reason for hiding this comment

strangelookingnerd Mar 19, 2023

Choose a reason for hiding this comment

basil Mar 19, 2023 • edited

Choose a reason for hiding this comment

basil Mar 19, 2023

Choose a reason for hiding this comment

strangelookingnerd commented Mar 20, 2023

basil left a comment

Choose a reason for hiding this comment

strangelookingnerd commented Mar 20, 2023

basil commented Mar 21, 2023

strangelookingnerd commented Mar 21, 2023

basil commented Mar 21, 2023

strangelookingnerd commented Mar 22, 2023

basil left a comment

Choose a reason for hiding this comment

basil commented Mar 22, 2023

strangelookingnerd commented Jan 29, 2023 •

edited

basil Mar 19, 2023 •

edited