Add custom email template for failed CI

Fixes: QTQAINFRA-4731
Change-Id: Iff7a95e407205ec0562f41d11eae1717ffee40fa
Reviewed-by: Tor Arne Vestbø <[email protected]>
Reviewed-by: Daniel Smith <[email protected]>

Author: jujokini

BUILD

@@ -11,7 +11,7 @@ gerrit_plugin(
         "Implementation-Title: Qt Code Review Flow Plugin",
         "Implementation-URL: https://codereview.qt-project.org/p/qtqa/gerrit-plugin-qt-workflow.git",
     ],
-    resources = glob(["src/main/**/*"]),
+    resources = glob(["src/main/resources/**/*"]),
 )
 
 junit_tests(

src/main/java/com/googlesource/gerrit/plugins/qtcodereview/QtBuildFailedEmailTemplateRegister.java

@@ -0,0 +1,24 @@
+//
+// Copyright (C) 2022 The Qt Company
+//
+
+package com.googlesource.gerrit.plugins.qtcodereview;
+
+import com.google.gerrit.server.mail.send.MailSoyTemplateProvider;
+import com.google.inject.Singleton;
+import java.util.HashSet;
+import java.util.Set;
+
+public class QtBuildFailedEmailTemplateRegister implements MailSoyTemplateProvider {
+
+  public String getPath() {
+    return "mail";
+  }
+
+  public Set<String> getFileNames() {
+    Set<String> set = new HashSet<>();
+    set.add("QtBuildFailed.soy");
+    set.add("QtBuildFailedHtml.soy");
+    return set;
+  }
+}

src/main/java/com/googlesource/gerrit/plugins/qtcodereview/QtBuildFailedSender.java

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2019-21 The Qt Company
+// Copyright (C) 2019-22 The Qt Company
 //
 
 package com.googlesource.gerrit.plugins.qtcodereview;
@@ -24,7 +24,7 @@ public interface Factory {
   @Inject
   public QtBuildFailedSender(
       EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
-    super(ea, "comment", newChangeData(ea, project, id));
+    super(ea, "qtbuildfailed", newChangeData(ea, project, id));
   }
 
   @Override
@@ -39,7 +39,10 @@ protected void init() throws EmailException {
 
   @Override
   protected void formatChange() throws EmailException {
-    appendText(textTemplate("Comment"));
+    appendText(textTemplate("QtBuildFailed"));
+    if (useHtml()) {
+      appendHtml(soyHtmlTemplate("QtBuildFailedHtml"));
+    }
   }
 
   @Override

src/main/java/com/googlesource/gerrit/plugins/qtcodereview/QtModule.java

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 The Qt Company
+// Copyright (C) 2020-22 The Qt Company
 //
 
 package com.googlesource.gerrit.plugins.qtcodereview;
@@ -13,6 +13,7 @@
 import com.google.gerrit.extensions.restapi.RestApiModule;
 import com.google.gerrit.server.git.ChangeMessageModifier;
 import com.google.gerrit.server.events.EventTypes;
+import com.google.gerrit.server.mail.send.MailSoyTemplateProvider;
 
 public class QtModule extends FactoryModule {
 
@@ -30,6 +31,7 @@ protected void configure() {
     factory(QtBuildFailedSender.Factory.class);
     factory(QtChangeUpdateOp.Factory.class);
     DynamicSet.bind(binder(), ChangeMessageModifier.class).to(QtChangeMessageModifier.class);
+    DynamicSet.bind(binder(), MailSoyTemplateProvider.class).to(QtBuildFailedEmailTemplateRegister.class);
 
     install(
         new RestApiModule() {

src/main/resources/mail/QtBuildFailed.soy

@@ -0,0 +1,27 @@
+/**
+ * Copyright (C) 2022 The Qt Company
+ */
+
+{namespace com.google.gerrit.server.mail.template}
+
+/**
+ * The .QtBuildFailed template will determine the contents of the email related to a
+ * change failed CI.
+ */
+
+{template .QtBuildFailed kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  The change has failed CI.
+  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
+  {\n}
+  Change subject: {$change.subject}{\n}
+  ......................................................................{\n}
+  {if $coverLetter}
+    {\n}
+    {\n}
+    {$coverLetter}
+    {\n}
+  {/if}
+{/template}

src/main/resources/mail/QtBuildFailedHtml.soy

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2022 The Qt Company
+ */
+
+{namespace com.google.gerrit.server.mail.template}
+
+/**
+ * The .QtBuildFailed template will determine the contents of the email related to a
+ * change failed CI.
+ */
+
+{template .QtBuildFailedHtml}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  <p>
+    The change has <strong>failed</strong> CI.
+  </p>
+
+  {if $email.changeUrl}
+    <p>
+      {call .ViewChangeButton data="all" /}
+    </p>
+  {/if}
+
+  {if $coverLetter}
+    <div style="white-space:pre-wrap">{$coverLetter}</div>
+  {/if}
+{/template}

src/test/java/com/googlesource/gerrit/plugins/qtcodereview/QtEmailSendingIT.java

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2019-21 The Qt Company
+// Copyright (C) 2019-22 The Qt Company
 //
 
 package com.googlesource.gerrit.plugins.qtcodereview;
@@ -64,7 +64,7 @@ public void stagedByOwnerBuildFail() throws Exception {
     sender.clear();
     QtFailBuild("master", "test_build_02");
 
-    FakeEmailSender.Message m = sender.getMessages(c.getChangeId(), "comment").get(0);
+    FakeEmailSender.Message m = sender.getMessages(c.getChangeId(), "qtbuildfailed").get(0);
     Address expectedTo = Address.create(user.fullName(), user.email());
     assertThat(m.rcpt()).containsExactly(expectedTo);
     assertThat(((EmailHeader.AddressList) m.headers().get("To")).getAddressList())
@@ -99,7 +99,7 @@ public void stagedByOtherBuildFail() throws Exception {
     sender.clear();
     QtFailBuild("master", "test_build_04");
 
-    FakeEmailSender.Message m = sender.getMessages(c.getChangeId(), "comment").get(0);
+    FakeEmailSender.Message m = sender.getMessages(c.getChangeId(), "qtbuildfailed").get(0);
     Address expectedTo = Address.create(user.fullName(), user.email());
     assertThat(m.rcpt()).containsExactly(expectedTo);
     assertThat(((EmailHeader.AddressList) m.headers().get("To")).getAddressList())