[TT-1624] Make sure that each Solidity change has a corresponding Solidity Review issue in Jira

.github/scripts/jira/changeset-lib.ts

@@ -0,0 +1,64 @@
+import * as core from "@actions/core";
+import { join } from "path";
+import { getGitTopLevel } from "./lib";
+import { promises as fs } from "fs";
+
+export async function appendIssueNumberToChangesetFile(
+    prefix: string,
+    changesetFile: string,
+    issueNumber: string
+  ) {
+    const gitTopLevel = await getGitTopLevel();
+    const fullChangesetPath = join(gitTopLevel, changesetFile);
+    const changesetContents = await fs.readFile(fullChangesetPath, "utf-8");
+    // Check if the issue number is already in the changeset file
+    if (changesetContents.includes(issueNumber)) {
+      core.info("Issue number already exists in changeset file, skipping...");
+      return;
+    }
+
+    const updatedChangesetContents = `${changesetContents}\n\n${prefix}${issueNumber}`;
+    await fs.writeFile(fullChangesetPath, updatedChangesetContents);
+  }
+
+/**
+ * Extracts the list of changeset files. Intended to be used with https://github.com/dorny/paths-filter with
+ * the 'csv' output format.
+ *
+ * @returns An array of strings representing the changeset files.
+ * @throws {Error} If the required environment variable CHANGESET_FILES is missing.
+ * @throws {Error} If no changeset file exists.
+ */
+export function extractChangesetFiles(): string[] {
+  const changesetFiles = process.env.CHANGESET_FILES;
+  if (!changesetFiles) {
+    throw Error("Missing required environment variable CHANGESET_FILES");
+  }
+  const parsedChangesetFiles = changesetFiles.split(",");
+  if (parsedChangesetFiles.length === 0) {
+    throw Error("At least one changeset file must exist");
+  }
+
+  core.info(
+    `Changeset to extract issues from: ${parsedChangesetFiles.join(", ")}`
+  );
+  return parsedChangesetFiles;
+}
+
+/**
+ * Extracts a single changeset file. Intended to be used with https://github.com/dorny/paths-filter with
+ * the 'csv' output format.
+ *
+ * @returns A single changeset file path.
+ * @throws {Error} If the required environment variable CHANGESET_FILES is missing.
+ * @throws {Error} If no changeset file exists.
+ * @throws {Error} If more than one changeset file exists.
+ */
+export function extractChangesetFile(): string {
+  const changesetFiles = extractChangesetFiles()
+  if (changesetFiles.length > 1) {
+    throw new Error(`Found ${changesetFiles.length} changeset files, but only 1 was expected.`)
+  }
+
+  return changesetFiles[0]
+}

.github/scripts/jira/create-jira-traceability.ts

@@ -6,32 +6,10 @@ import {
   generateJiraIssuesLink,
   getJiraEnvVars,
   handleError,
+  PR_PREFIX,
 } from "./lib";
 import * as core from "@actions/core";
-
-/**
- * Extracts the list of changeset files. Intended to be used with https://github.com/dorny/paths-filter with
- * the 'csv' output format.
- *
- * @returns An array of strings representing the changeset files.
- * @throws {Error} If the required environment variable CHANGESET_FILES is missing.
- * @throws {Error} If no changeset file exists.
- */
-function extractChangesetFiles(): string[] {
-  const changesetFiles = process.env.CHANGESET_FILES;
-  if (!changesetFiles) {
-    throw Error("Missing required environment variable CHANGESET_FILES");
-  }
-  const parsedChangesetFiles = changesetFiles.split(",");
-  if (parsedChangesetFiles.length === 0) {
-    throw Error("At least one changeset file must exist");
-  }
-
-  core.info(
-    `Changeset to extract issues from: ${parsedChangesetFiles.join(", ")}`
-  );
-  return parsedChangesetFiles;
-}
+import { extractChangesetFiles } from './changeset-lib'
 
 /**
  * Adds traceability to JIRA issues by commenting on each issue with a link to the artifact payload
@@ -188,7 +166,7 @@ async function main() {
       ", "
     )}`
   );
-  const jiraIssueNumbers = await extractJiraIssueNumbersFrom(changesetFiles);
+  const jiraIssueNumbers = await extractJiraIssueNumbersFrom(PR_PREFIX, changesetFiles);
 
   const client = createJiraClient();
   const label = generateIssueLabel(product, baseRef, headRef);

.github/scripts/jira/enforce-jira-issue.ts

@@ -1,57 +1,17 @@
 import * as core from "@actions/core";
-import jira from "jira.js";
-import { createJiraClient, getGitTopLevel, handleError, parseIssueNumberFrom } from "./lib";
-import { promises as fs } from "fs";
-import { join } from "path";
-
-async function doesIssueExist(
-  client: jira.Version3Client,
-  issueNumber: string,
-  dryRun: boolean
-) {
-  const payload = {
-    issueIdOrKey: issueNumber,
-  };
-
-  if (dryRun) {
-    core.info("Dry run enabled, skipping JIRA issue enforcement");
-    return true;
-  }
-
-  try {
-    /**
-     * The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed.
-     * If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.
-     */
-    const issue = await client.issues.getIssue(payload);
-    core.debug(
-      `JIRA issue id:${issue.id} key: ${issue.key} found while querying for ${issueNumber}`
-    );
-    if (issue.key !== issueNumber) {
-      core.error(
-        `JIRA issue key ${issueNumber} not found, but found issue key ${issue.key} instead. This can happen if the identifier doesn't match an issue, in which case a case-insensitive search and check for moved issues is performed. Make sure the issue key is correct.`
-      );
-      return false;
-    }
-
-    return true;
-  } catch (e) {
-    handleError(e)
-    return false;
-  }
-}
+import { createJiraClient, EMPTY_PREFIX, parseIssueNumberFrom, doesIssueExist, PR_PREFIX } from "./lib";
+import { appendIssueNumberToChangesetFile, extractChangesetFile } from "./changeset-lib";
 
 async function main() {
   const prTitle = process.env.PR_TITLE;
   const commitMessage = process.env.COMMIT_MESSAGE;
   const branchName = process.env.BRANCH_NAME;
   const dryRun = !!process.env.DRY_RUN;
-  const { changesetFile } = extractChangesetFile();
-
+  const changesetFile = extractChangesetFile();
   const client = createJiraClient();
 
   // Checks for the Jira issue number and exit if it can't find it
-  const issueNumber = parseIssueNumberFrom(prTitle, commitMessage, branchName);
+  const issueNumber = parseIssueNumberFrom(EMPTY_PREFIX, prTitle, commitMessage, branchName);
   if (!issueNumber) {
     const msg =
       "No JIRA issue number found in PR title, commit message, or branch name. This pull request must be associated with a JIRA issue.";
@@ -69,40 +29,7 @@ async function main() {
   }
 
   core.info(`Appending JIRA issue ${issueNumber} to changeset file`);
-  await appendIssueNumberToChangesetFile(changesetFile, issueNumber);
-}
-
-async function appendIssueNumberToChangesetFile(
-  changesetFile: string,
-  issueNumber: string
-) {
-  const gitTopLevel = await getGitTopLevel();
-  const fullChangesetPath = join(gitTopLevel, changesetFile);
-  const changesetContents = await fs.readFile(fullChangesetPath, "utf-8");
-  // Check if the issue number is already in the changeset file
-  if (changesetContents.includes(issueNumber)) {
-    core.info("Issue number already exists in changeset file, skipping...");
-    return;
-  }
-
-  const updatedChangesetContents = `${changesetContents}\n\n${issueNumber}`;
-  await fs.writeFile(fullChangesetPath, updatedChangesetContents);
-}
-
-function extractChangesetFile() {
-  const changesetFiles = process.env.CHANGESET_FILES;
-  if (!changesetFiles) {
-    throw Error("Missing required environment variable CHANGESET_FILES");
-  }
-  const parsedChangesetFiles = JSON.parse(changesetFiles);
-  if (parsedChangesetFiles.length !== 1) {
-    throw Error(
-      "This action only supports one changeset file per pull request."
-    );
-  }
-  const [changesetFile] = parsedChangesetFiles;
-
-  return { changesetFile };
+  await appendIssueNumberToChangesetFile(PR_PREFIX, changesetFile, issueNumber);
 }
 
 async function run() {