Continuum

Unable to configure subject line for email notifications

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: 1.3.1 (Alpha)
  • Fix Version/s: 1.3.2 (Beta)
  • Component/s: Notifier - Mail
  • Labels:
    None
  • Environment:
    1.3.1, also seen with trunk at r748719
  • Complexity:
    Intermediate
  • Number of attachments :
    0

Description

After upgrading to 1.3.x, I'm getting notification emails with the subject line:

[continuum] PREPARE BUILD SUCCESSFUL: $

{projectScmRoot.scmRootAddress}

Other than the subject, the notification looks the same as we used to get for normal scheduled builds in 1.2.x.

The subject line seems to be hard coded in MailContinuumNotifier.java, and was added in r709300 in the merge from the transient state branch.

Previously, the subject was configurable in
./apps/continuum/WEB-INF/classes/META-INF/plexus/application.xml
with
<subject-format>[continuum] BUILD ${state}: ${project.projectGroup.name} - ${project.name} - ${build.buildDefinition.description}</subject-format>
.

From continuum.log:
2009-02-27 20:25:48,106 [pool-1-thread-4] WARN velocityComponent - org.apache.velocity.runtime.exception.ReferenceException: reference : template = subjectPattern [line 1,column 37] : ${projectScmRoot.scmRootAddress}

is not a valid reference.
2009-02-27 20:25:48,106 [pool-1-thread-4] INFO org.apache.maven.continuum.notification.mail.MailContinuumNotifier - Message Subject: '[continuum] PREPARE BUILD SUCCESSFUL: $

{projectScmRoot.scmRootAddress}

'.

I'm less concerned about the 'not a valid reference' warning, since what I really want is for the subject line to be

  • configurable in plain text
  • the same as it was in 1.2.x

Related thread:
http://mail-archives.apache.org/mod_mbox/continuum-dev/200902.mbox/%3Cadba96190902261025o5f0f35cfk70554c62cafda630@mail.gmail.com%3E

Issue Links

is related to

Bug - A problem which impairs or prevents the functions of the product. CONTINUUM-2117 Expressions do not work in prepareBuildSubjectFormat

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Improvement - An improvement or enhancement to an existing feature or task. CONTINUUM-1929 Improve docs on configuring mail notifiers

  • Major - Major loss of function.
  • Open - The issue is open and ready for the assignee to start work on it.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Maria Catherine Tan added a comment -

Only the subject line for the mail notification of "Prepare build" is not configurable.

Preparation of build, which includes cleaning of directory, checkout and update, was separated from the actual build.
Any suggestion with the subject format?

Show
Maria Catherine Tan added a comment - Only the subject line for the mail notification of "Prepare build" is not configurable. Preparation of build, which includes cleaning of directory, checkout and update, was separated from the actual build. Any suggestion with the subject format?
Hide
Permalink
Maria Catherine Tan added a comment -

Here's what I did though I haven't committed it yet.

Both in MailContinuumNotifier and application.xml
(1) changed subjectFormat to buildSubjectFormat (use for actual build notification)
(2) added prepareBuildSubjectFormat ( use for prepare build notification )

WDYT?

Show
Maria Catherine Tan added a comment - Here's what I did though I haven't committed it yet. Both in MailContinuumNotifier and application.xml (1) changed subjectFormat to buildSubjectFormat (use for actual build notification) (2) added prepareBuildSubjectFormat ( use for prepare build notification ) WDYT?
Hide
Permalink
Wendy Smoak added a comment -

I don't understand why there would be two notifications for a single build.

I'll test it again, but it seemed to me the email I got was the normal build notification I'm used to, it just had this new hardcoded subject line. Are you saying there should be two?

I looked at the transient state issues CONTINUUM-1864 and CONTINUUM-1829 and didn't see adding a second notification mentioned there or in the threads linked from the issues.

Show
Wendy Smoak added a comment - I don't understand why there would be two notifications for a single build. I'll test it again, but it seemed to me the email I got was the normal build notification I'm used to, it just had this new hardcoded subject line. Are you saying there should be two? I looked at the transient state issues CONTINUUM-1864 and CONTINUUM-1829 and didn't see adding a second notification mentioned there or in the threads linked from the issues.
Hide
Permalink
Wendy Smoak added a comment -

Okay, after playing with this a bit more it seems like I get either the 'prepare' notification or the normal one, but not both. Is that correct?

For example, if the scm url in the pom is incorrect, I get a 'PREPARE BUILD ERROR' message. If I fix it and delete/re-add the project then I get only a 'BUILD SUCCESSFUL' message.

Show
Wendy Smoak added a comment - Okay, after playing with this a bit more it seems like I get either the 'prepare' notification or the normal one, but not both. Is that correct? For example, if the scm url in the pom is incorrect, I get a 'PREPARE BUILD ERROR' message. If I fix it and delete/re-add the project then I get only a 'BUILD SUCCESSFUL' message.
Hide
Permalink
Maria Catherine Tan added a comment -

For the successful 'prepare' notification, you can get it if alwaysSend is true or if the scmroot previous state while preparing is an Error. The Prepare Build Error notification is configurable in the ui.

So if the prepare build failed because let's say the svn is down, and you configured to received notification when prepare build failed then you will receive a mail notification for that.

I can remove the prepare build successful mail notification, since it seems like you'll get notification anyway during the build which also means the prepare build was successful.

Show
Maria Catherine Tan added a comment - For the successful 'prepare' notification, you can get it if alwaysSend is true or if the scmroot previous state while preparing is an Error. The Prepare Build Error notification is configurable in the ui. So if the prepare build failed because let's say the svn is down, and you configured to received notification when prepare build failed then you will receive a mail notification for that. I can remove the prepare build successful mail notification, since it seems like you'll get notification anyway during the build which also means the prepare build was successful.
Hide
Permalink
Wendy Smoak added a comment -

Thanks! I'd say go ahead and commit what you have, which makes the 'prepare build' subject line configurable... it sounds fine, it just needs to be documented.

If the 'PREPARE BUILD SUCCESSFUL' notifications get too noisy or are considered redundant, we can consider removing them in a separate issue.

Show
Wendy Smoak added a comment - Thanks! I'd say go ahead and commit what you have, which makes the 'prepare build' subject line configurable... it sounds fine, it just needs to be documented. If the 'PREPARE BUILD SUCCESSFUL' notifications get too noisy or are considered redundant, we can consider removing them in a separate issue.
Hide
Permalink
Maria Catherine Tan added a comment -

Fixed in revision 751253

Show
Maria Catherine Tan added a comment - Fixed in revision 751253
Hide
Permalink
Wendy Smoak added a comment -

Thanks, Marica! FYI I opened CONTINUUM-2117 for more work on this. The subject line is now configurable, but $

{project.projectGroup.name}

is not getting substituted (it comes through literally in the email subject).

Show
Wendy Smoak added a comment - Thanks, Marica! FYI I opened CONTINUUM-2117 for more work on this. The subject line is now configurable, but $ {project.projectGroup.name} is not getting substituted (it comes through literally in the email subject).

People

  • Assignee:
    Maria Catherine Tan
    Reporter:
    Wendy Smoak
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: