Poor error reporting when an anonymous Cause is used

This issue is archived. You can view it, but you can't modify it. Learn more

XMLWordPrintable

      EnvInject throws a StringIndexOutOfBoundsException in BuildCauseRetriever.getTriggeredCause if the class that triggered it was anonymous. This is because getTriggerName uses cause.getClass().getSimpleName(), which returns an empty string for anonymous classes, empty strings are skipped when getTriggeredCause iterates over build causes, but it always assumes that there is at least one non-empty build cause.

      To reproduce, create a trigger that uses an anonymous Cause like this:

      private static void scheduleBuild(BuildableItem job) {
          job.scheduleBuild(new Cause() {
              @Override
              public String getShortDescription() {
                  return "Triggered by XYZ";
              }
          });
      }
      

      To work around this, the above snippet can be rewritten to avoid the anonymous class:

      private static void scheduleBuild(BuildableItem job) {
          job.scheduleBuild(new XyzCause());
      }
      
      private static class XyzCause extends Cause {
          @Override
          public String getShortDescription() {
              return "Triggered by XYZ";
          }
      }
      

      I'm not sure which fix would be most consistent with the intent of the ENV_CAUSE variable for custom triggers. I see these options:

      • Skip setting an ENV_CAUSE, possibly log a warning
      • Use the parent class as the trigger name
      • make the trigger "ANONYMOUSTRIGGER", possibly prefixed by the parent class

            Assignee:
            Unassigned
            Reporter:
            David Eckel
            Archiver:
            Jenkins Service Account

              Created:
              Updated:
              Archived: