[JENKINS-23292] Add system property to disable jira mail address resolving #51
Conversation
|
Thank you for a pull request! Please check this document for how the Jenkins project handles pull requests |
|
Sounds good. |
|
This is probably an unusual enough use case to not warrant a UI option. |
| * | ||
| * To disable set the System property "-Dhudson.plugins.jira.JiraMailAddressResolver.DISABLE=true" | ||
| */ | ||
| public static final boolean DISABLE = Boolean.getBoolean(JiraMailAddressResolver.class.getName() + ".DISABLE"); |
There was a problem hiding this comment.
Since we are setting this argument through command line it shouldn't be modifiable. If I remove the final, then I can use a groovy script to set the value, and makes the argument useless.
There was a problem hiding this comment.
then I can use a groovy script to set the value
Exactly. You'll be able to test whether this has the desired effect while troubleshooting without having to reboot the production instance.
If it does, you'd set the argument so Jenkins will retain that value in the future.
There was a problem hiding this comment.
Fair enough. I'll remove final.
|
What's the stopper on this pull request? |
|
I don't think using class name in system property is a good idea. In case you rename this class, it will automatically change property name you read, so it will break functionality. And please provide tests for your changes. |
This is an often-used pattern in Jenkins, see https://wiki.jenkins-ci.org/display/JENKINS/Features+controlled+by+system+properties Backwards compatibility can easily be achieved by moving to a fixed string when renaming. Note that plugins that depend on Jira Plugin today may also break in case you rename the class, as it is a public class. |
…o test if this is the behavior they would like without restarting their Jenkins instance.
|
Test has been added. |
|
|
||
| @BeforeClass | ||
| public static void setUp() throws Exception { | ||
| System.setProperty(JiraMailAddressResolver.class.getName() + ".DISABLE", "true"); |
There was a problem hiding this comment.
If this used the full class name in a fixed string, it'd protect against class rename/move.
|
Can we keep the progress moving on this? Should this be named Thanks. |
|
".disabled" sounds good to me |
|
I installed the snapshot and have confirmed that email resolving no longer occurs. I think it would be safe to merge this change. |
[JENKINS-23292] Add system property -Dhudson.plugins.jira.JiraMailAddressResolver.disabled=true to disable jira mail address resolving
Setting the system property
-Dhudson.plugins.jira.JiraMailAddressResolver.DISABLE=truewill disable resolving email addresses with Jira.The reason for disabling the JiraMailAddressResolver is because it will access Jira to obtain the email address which could potentially return an invalid email (as in
JENKINS-23292). Disabling the email resolver for Jira will allow the email addresses to be resolved through another method (possibly withLDAP).