Adding casc support to plugin

[Kirk Fitzsimons]

Hi,

I am trying to add casc support to Sonar Quality Gates plugin, this is my attempt.

Try add casc · kirk-fitz/sonar-quality-gates-plugin@ea75469 (github.com)

I can see the root of the plugin config, but I am not getting any properties, can someone help me identify what I am missing

"sonarQualityGates": {
                    "additionalProperties": false,
                    "type": "object",
                    "properties": {}
                },

Kirk

[Winter, Markus]

The class GlobalConfigDataForSonarInstance must be a Describable

See https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/docs/PLUGINS.md#step-2

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/7132814d-69f0-4d35-ae2f-5aeb0e6e35fdn%40googlegroups.com.

[Kirk Fitzsimons]

Thanks for the reply

Apologies, but I am very new to this, I have pushed a change to my branch, I must be missing something else

Ensure GlobalConfigDataForSonarInstance extends Describable · kirk-fitz/sonar-quality-gates-plugin@415ede3 (github.com)

Kirk

[Winter, Markus]

Took a look and tried things out:

You also need a DataBoundConstructor for the noarg contructor of GlobalConfig

And create a method “setListOfGlobalConfigData” and annotate as DataBoundSetter.

Remove the DataBoundSetter from setGlobalConfigDataForSonarInstances

 

The way of configuring with the GlobalConfigurationService might be a problem with CasC

 

Line 19 in GlobalConfig should be transient, it doesn’t contain data that should be saved

 

You can remove the wrapping table in config.jelly

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/7ebba756-7178-4769-b05c-7c2dcdfa523cn%40googlegroups.com.

[Kirk Fitzsimons]

You can only have one  DataBoundConstructor  annotation i believe.
I removed the table from the config.jelly

I renamed the method  setGlobalConfigDataForSonarInstances to  setListOfGlobalConfigData

It looks like it is working now:



I was also able to export the casc

 sonarQualityGates:
    listOfGlobalConfigData:
    - maxWaitTime: 300000
      name: "test"
      timeToWait: 10000
    - maxWaitTime: 500000
      name: "test2"
      timeToWait: 20000


I think perhaps I need to look at the naming convetion etc,  listOfGlobalConfigData doesnt sound descriptive, perhaps its should be listOfSonarInstances, or maybe just sonarInstances

Will also need to look into adding tests

[Kirk Fitzsimons]

I have made some more updates and it appears to be working

https://github.com/kirk-fitz/sonar-quality-gates-plugin/commit/9043167264ff1106fc5ff58480b6ceb866982e92

Can somone suggest how I might add casc automation tests? I have added a template one, but im not sure how to instantiate my config etc before comparing it to the expected yaml config

[Ullrich Hafner]

Here is an example that verifies JCasC in the warnings plug-in:

-- 

Ulli - Typed with big thumbs on small phone

Am 20.08.2024 um 16:31 schrieb Kirk Fitzsimons <fitzsim...@gmail.com>:

I have made some more updates and it appears to be working

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/e2c2300b-9d96-401f-93c0-d0040b835e85n%40googlegroups.com.