Improve testcase handling in Bugzilla Template

Author: gitstart_bot

server/frontend/package-lock.json

@@ -19,6 +19,7 @@
         "handlebars": "^4.7.8",
         "js-base64": "^3.7.7",
         "lodash": "^4.17.21",
+        "mime": "^4.0.6",
         "prismjs": "^1.29.0",
         "sweetalert": "^2.1.2",
         "vue": "^3.4.21",

server/frontend/package.json

@@ -117,15 +117,16 @@
           @update-not-attach-data="notAttachData = $event"
           @update-data="crashData = $event"
         />
-
         <TestCaseSection
           v-if="entry.testcase"
           mode="comment"
           :initial-not-attach-test="notAttachTest"
           :entry="entry"
           :template="template"
+          :file-extension="fileExtension"
+          :file-name="fileName"
           @update-not-attach-test="notAttachTest = $event"
-          @update-filename="entry.testcase = $event"
+          @update-filename="newFileName = $event"
           @update-content="testCaseContent = $event"
         />
 
@@ -227,6 +228,7 @@
 <script>
 import Handlebars from "handlebars";
 import { Base64 } from "js-base64";
+import mime from "mime";
 import { defineComponent } from "vue";
 import * as api from "../../../api";
 import * as bugzillaApi from "../../../bugzilla_api";
@@ -289,6 +291,7 @@ export default defineComponent({
       testCaseContent: "",
       notAttachData: false,
       crashData: "",
+      newFileName: null,
     };
   },
 
@@ -342,7 +345,7 @@ export default defineComponent({
       if (!this.template || !this.entry) return "";
       try {
         const compiled = Handlebars.compile(this.template.comment);
-        let rendered = compiled({
+        const renderedData = {
           summary: this.summary,
           shortsig: this.entry.shortSignature,
           product: this.entry.product,
@@ -359,7 +362,15 @@ export default defineComponent({
             ? "(Crash data not available)"
             : "For detailed crash information, see attachment.",
           ...this.metadataExtension(this.template.comment),
-        });
+        };
+
+        if (!this.notAttachTest) {
+          renderedData["testcase_attachment"] = this.filenameWithExtension;
+        } else {
+          delete renderedData["testcase_attachment"];
+        }
+
+        let rendered = compiled(renderedData);
 
         // Remove the specified pathPrefix from traces and assertion
         if (this.entryMetadata.pathprefix) {
@@ -371,6 +382,32 @@ export default defineComponent({
         return "";
       }
     },
+    fileName() {
+      const { attachmentFilename } = this.getFileDetails();
+
+      return this.newFileName ?? attachmentFilename;
+    },
+    fileExtension() {
+      const { attachmentFilenameExtension } = this.getFileDetails();
+
+      return attachmentFilenameExtension;
+    },
+    filenameWithExtension() {
+      return this.fileName + "." + this.fileExtension;
+    },
+    fileMimetype() {
+      const mimeType = mime.getType(this.filenameWithExtension);
+
+      if (mimeType) {
+        return mimeType;
+      }
+
+      if (this.entry.testcase_isbinary) {
+        return "application/octet-stream";
+      }
+
+      return "text/plain";
+    },
   },
 
   watch: {
@@ -440,6 +477,8 @@ export default defineComponent({
         is_private: this.isPrivate,
       };
 
+      await this.publishAttachments();
+
       try {
         let data = await bugzillaApi.createComment({
           hostname: this.provider.hostname,
@@ -471,9 +510,9 @@ export default defineComponent({
         const payload = {
           ids: [this.externalBugId],
           data: Base64.encode(this.crashData),
-          file_name: "crash_data.txt",
+          file_name: this.filenameWithExtension,
           summary: "Detailed Crash Information",
-          content_type: "text/plain",
+          content_type: this.fileMimetype,
         };
 
         try {
@@ -510,11 +549,9 @@ export default defineComponent({
           data: this.entry.testcase_isbinary
             ? Base64.fromUint8Array(content)
             : Base64.encode(content),
-          file_name: this.entry.testcase,
+          file_name: this.filenameWithExtension,
           summary: `Testcase for ${comment}`,
-          content_type: this.entry.testcase_isbinary
-            ? "application/octet-stream"
-            : "text/plain",
+          content_type: this.fileMimetype,
         };
 
         try {
@@ -529,6 +566,27 @@ export default defineComponent({
         }
       }
     },
+
+    getFileDetails() {
+      let attachmentFilename = "";
+      let attachmentFilenameExtension = "";
+      if (this.entry) {
+        // extract file name
+        const splittedAttachmentFilename = this.template?.testcase_filename
+          ? this.template.testcase_filename
+          : this.entry.testcase.split("/");
+
+        const attachmentFilenameAndExtension =
+          splittedAttachmentFilename[
+            splittedAttachmentFilename?.length - 1
+          ].split(".");
+
+        attachmentFilename = attachmentFilenameAndExtension[0];
+        attachmentFilenameExtension = attachmentFilenameAndExtension[1];
+      }
+
+      return { attachmentFilename, attachmentFilenameExtension };
+    },
   },
 });
 </script>

server/frontend/src/components/Bugs/Comments/PublicationForm.vue

@@ -519,12 +519,22 @@
             >
             <input
               id="testcase_filename"
-              v-model="template.testcase_filename"
+              v-model="fileName"
               name="testcase_filename"
               type="text"
               class="form-control"
             />
           </div>
+          <div class="col-md-2">
+            <label for="file_extension">File extension:</label>
+            <input
+              id="file_extension"
+              type="text"
+              class="form-control"
+              disabled
+              :value="fileExtension"
+            />
+          </div>
         </div>
 
         <hr />
@@ -543,8 +553,10 @@
             :initial-not-attach-test="notAttachTest"
             :entry="entry"
             :template="template"
+            :file-extension="fileExtension"
+            :file-name="fileName"
             @update-not-attach-test="notAttachTest = $event"
-            @update-filename="entry.testcase = $event"
+            @update-filename="fileName = $event"
             @update-content="testCaseContent = $event"
           />
 
@@ -691,6 +703,8 @@ import {
   watch,
 } from "vue";
 import * as api from "../../api";
+
+import mime from "mime";
 import * as bugzillaApi from "../../bugzilla_api";
 import * as HandlebarsHelpers from "../../handlebars_helpers";
 import { errorParser } from "../../helpers";
@@ -793,11 +807,48 @@ export default defineComponent({
     const bugzillaTemplateFieldErrors = ref({});
     const bugZillaTemplateError = ref(null);
     const formElement = ref(null);
+    const fileExtension = ref(null);
+    const fileName = ref(null);
 
     const bugLink = computed(() => {
       return `https://${provider.value.hostname}/${createdBugId.value}`;
     });
 
+    const filenameWithExtension = computed(() => {
+      return `${fileName.value}.${fileExtension.value}`;
+    });
+
+    watch(() => {
+      if (entry.value) {
+        // extract file name
+        const splittedAttachmentFilename = template.value?.testcase_filename
+          ? template.value.testcase_filename
+          : entry.value.testcase.split("/");
+
+        const attachmentFilenameAndExtension =
+          splittedAttachmentFilename[
+            splittedAttachmentFilename?.length - 1
+          ].split(".");
+
+        fileName.value = attachmentFilenameAndExtension[0];
+        fileExtension.value = attachmentFilenameAndExtension[1];
+      }
+    });
+
+    const fileMimetype = computed(() => {
+      const mimeType = mime.getType(filenameWithExtension.value);
+
+      if (mimeType) {
+        return mimeType;
+      }
+
+      if (entry.value.testcase_isbinary) {
+        return "application/octet-stream";
+      }
+
+      return "text/plain";
+    });
+
     const bugzillaToken = computed(() => {
       return localStorage.getItem(
         "provider-" + provider.value?.id + "-api-key",
@@ -855,7 +906,7 @@ export default defineComponent({
       if (!template.value || !entry.value) return "";
       try {
         const compiled = Handlebars.compile(template.value.description);
-        let rendered = compiled({
+        const renderedData = {
           summary: summary.value,
           shortsig: entry.value.shortSignature,
           product: entry.value.product,
@@ -872,7 +923,15 @@ export default defineComponent({
             ? "(Crash data not available)"
             : "For detailed crash information, see attachment.",
           ...metadataExtension(template.value.description),
-        });
+        };
+
+        if (!notAttachTest.value) {
+          renderedData["testcase_attachment"] = filenameWithExtension.value;
+        } else {
+          delete renderedData["testcase_attachment"];
+        }
+
+        let rendered = compiled(renderedData);
 
         // Remove the specified pathPrefix from traces and assertion
         if (entryMetadata.value.pathprefix)
@@ -1053,6 +1112,7 @@ export default defineComponent({
       } else {
         const payload = {
           ...template.value,
+          testcase_filename: filenameWithExtension.value,
           product: product.value,
           component: component.value,
           op_sys: opSys.value,
@@ -1089,9 +1149,9 @@ export default defineComponent({
           payload = {
             ids: [createdBugId.value],
             data: Base64.encode(crashData.value),
-            file_name: "crash_data.txt",
+            file_name: filenameWithExtension.value,
             summary: "Detailed Crash Information",
-            content_type: "text/plain",
+            content_type: fileMimetype.value,
           };
 
           await bugzillaApi.createAttachment({
@@ -1119,11 +1179,9 @@ export default defineComponent({
             data: entry.value.testcase_isbinary
               ? Base64.fromUint8Array(content)
               : Base64.encode(content),
-            file_name: entry.value.testcase,
+            file_name: filenameWithExtension.value,
             summary: "Testcase",
-            content_type: entry.value.testcase_isbinary
-              ? "application/octet-stream"
-              : "text/plain",
+            content_type: fileMimetype.value,
           };
 
           await bugzillaApi.createAttachment({
@@ -1232,9 +1290,13 @@ export default defineComponent({
       renderedWhiteboard,
       renderedKeywords,
       renderedAttrs,
+      filenameWithExtension,
+      fileMimetype,
       bugZillaTemplateError,
       bugzillaTemplateFieldErrors,
       formElement,
+      fileExtension,
+      fileName,
       goBack,
       createExternalBug,
       createOrUpdateBugzillabugTemplate,