feat: checks if Python>=3.8 and pip are available on the runner

KevinDeJong-TomTom · May 11, 2022 · 5ecfd1a · 5ecfd1a
1 parent 6a674ac
commit 5ecfd1a
Show file tree

Hide file tree

Showing 4 changed files with 127 additions and 58 deletions.
diff --git a/.github/workflows/commisery.yml b/.github/workflows/commisery.yml
@@ -25,7 +25,7 @@ jobs:
     - name: Check-out the repo under $GITHUB_WORKSPACE
       uses: actions/checkout@v3
 
-    - name: Setup Python
+    - name: Setup Python v3.8
       uses: actions/setup-python@v3
       with:
         python-version: '3.8'

diff --git a/README.md b/README.md
@@ -2,9 +2,10 @@
 
 Using this GitHub action, scan all commits in your Pull Request against the [Conventional Commits]
 standard using [Commisery] 
+## Prerequisites
 
-[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
-[Commisery]: https://pypi.org/project/commisery/
+* [Commisery] requires at least `Python>3.8`
+* `pip` needs to be installed for this Python version
 
 ## Usage
 
@@ -42,10 +43,14 @@ The workflow, usually declared in `.github/workflows/build.yml`, looks like:
 - **token**: GitHub Token provided by GitHub, see [Authenticating with the GITHUB_TOKEN]
 - **pull_request**: Pull Request number, provided by the [GitHub context].
 
-[Authenticating with the GITHUB_TOKEN]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token
-[GitHub context]: https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context
 
 
 ## Example of Conventional Commit check results
 
-![example](resources/example.png)
+![example](resources/example.png)
+
+[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
+[Commisery]: https://pypi.org/project/commisery/
+[Authenticating with the GITHUB_TOKEN]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token
+[GitHub context]: https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context
+
diff --git a/dist/commisery/index.js b/dist/commisery/index.js
@@ -9916,7 +9916,7 @@ function strip_ansicolor(message) {
  * @param message
  * @returns multiline message
  */
-function get_error_subjects(message, sha) {
+function get_error_subjects(message) {
     let errors = [];
     for (var line of strip_ansicolor(message).split("\n")) {
         if (line.startsWith(".commit-message")) {
@@ -9928,15 +9928,37 @@ function get_error_subjects(message, sha) {
     }
     return errors;
 }
+/**
+ * Confirms whether Python >=3.8 and pip are present on the runner
+ */
+function check_prerequisites() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const python_version_re = /Python\s*(\d+)\.(\d+)\.(\d+)/;
+        const { stdout: python_version } = yield exec.getExecOutput("python", ["--version"], { silent: true });
+        const match = python_version_re.exec(python_version);
+        if (!match || match.length != 4) {
+            throw new Error("Unable to determine the installed Python version.");
+        }
+        if (!(parseInt(match[1]) == 3 && parseInt(match[2]) >= 8)) {
+            throw new Error(`Incorrect Python version installed; found ${match[1]}.${match[2]}.${match[3]}, expected >= 3.8.0`);
+        }
+        try {
+            const { stdout: pip_version } = yield exec.getExecOutput("python", ["-m", "pip", "--version"], { silent: true });
+        }
+        catch (_a) {
+            throw new Error("Unable to determine the installed Pip version.");
+        }
+    });
+}
 /**
  * Installs the latest version of commisery
  */
 function prepare_environment() {
     return __awaiter(this, void 0, void 0, function* () {
-        // Upgrade pip to the latest version
-        yield exec.exec("python -m pip install --upgrade pip");
+        // Ensure Python (>= 3.8) and pip are installed
+        yield check_prerequisites();
         // Install latest version of commisery
-        yield exec.exec("python -m pip install --upgrade commisery");
+        yield exec.exec("python", ["-m", "pip", "install", "--upgrade", "commisery"]);
     });
 }
 /**
@@ -9981,33 +10003,38 @@ function is_commit_valid(commit) {
         catch (error) {
             core.debug("Error detected while executing commisery");
         }
-        return [stderr == "", get_error_subjects(stderr, commit.sha)];
+        return [stderr == "", get_error_subjects(stderr)];
     });
 }
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         // Ensure that commisery is installed
-        yield prepare_environment();
-        let [owner, repo] = (process.env.GITHUB_REPOSITORY || "").split("/");
-        // Validate each commit against Conventional Commit standard
-        let commits = yield get_commits(owner, repo, core.getInput("pull_request"));
-        let success = true;
-        for (const commit of commits) {
-            let [valid, errors] = yield is_commit_valid(commit);
-            if (!valid) {
-                core.summary
-                    .addHeading(commit.commit.message, 2)
-                    .addRaw(`<b>SHA:</b> <a href="${commit.html_url}"><code>${commit.sha}</code></a>`);
-                for (var error of errors) {
-                    core.summary.addCodeBlock(error);
+        try {
+            yield prepare_environment();
+            let [owner, repo] = (process.env.GITHUB_REPOSITORY || "").split("/");
+            // Validate each commit against Conventional Commit standard
+            let commits = yield get_commits(owner, repo, core.getInput("pull_request"));
+            let success = true;
+            for (const commit of commits) {
+                let [valid, errors] = yield is_commit_valid(commit);
+                if (!valid) {
+                    core.summary
+                        .addHeading(commit.commit.message, 2)
+                        .addRaw(`<b>SHA:</b> <a href="${commit.html_url}"><code>${commit.sha}</code></a>`);
+                    for (var error of errors) {
+                        core.summary.addCodeBlock(error);
+                    }
+                    success = false;
                 }
-                success = false;
+            }
+            if (!success) {
+                core.setFailed(`Commits in your Pull Request are not compliant to Conventional Commits`);
+                // Post summary
+                core.summary.write();
             }
         }
-        if (!success) {
-            core.setFailed(`Commits in your Pull Request are not compliant to Conventional Commits`);
-            // Post summary
-            core.summary.write();
+        catch (ex) {
+            core.setFailed(ex.message);
         }
     });
 }

diff --git a/src/main.ts b/src/main.ts
@@ -38,7 +38,7 @@ function strip_ansicolor(message: string) {
  * @param message
  * @returns multiline message
  */
-function get_error_subjects(message: string, sha: string) {
+function get_error_subjects(message: string) {
   let errors: string[] = [];
 
   for (var line of strip_ansicolor(message).split("\n")) {
@@ -52,15 +52,48 @@ function get_error_subjects(message: string, sha: string) {
   return errors;
 }
 
+/**
+ * Confirms whether Python >=3.8 and pip are present on the runner
+ */
+async function check_prerequisites() {
+  const python_version_re = /Python\s*(\d+)\.(\d+)\.(\d+)/;
+  const { stdout: python_version } = await exec.getExecOutput(
+    "python",
+    ["--version"],
+    { silent: true }
+  );
+  const match = python_version_re.exec(python_version);
+
+  if (!match || match.length != 4) {
+    throw new Error("Unable to determine the installed Python version.");
+  }
+
+  if (!(parseInt(match[1]) == 3 && parseInt(match[2]) >= 8)) {
+    throw new Error(
+      `Incorrect Python version installed; found ${match[1]}.${match[2]}.${match[3]}, expected >= 3.8.0`
+    );
+  }
+
+  try {
+    const { stdout: pip_version } = await exec.getExecOutput(
+      "python",
+      ["-m", "pip", "--version"],
+      { silent: true }
+    );
+  } catch {
+    throw new Error("Unable to determine the installed Pip version.");
+  }
+}
+
 /**
  * Installs the latest version of commisery
  */
 async function prepare_environment() {
-  // Upgrade pip to the latest version
-  await exec.exec("python -m pip install --upgrade pip");
+  // Ensure Python (>= 3.8) and pip are installed
+  await check_prerequisites();
 
   // Install latest version of commisery
-  await exec.exec("python -m pip install --upgrade commisery");
+  await exec.exec("python", ["-m", "pip", "install", "--upgrade", "commisery"]);
 }
 
 /**
@@ -111,44 +144,48 @@ async function is_commit_valid(commit): Promise<[boolean, string[]]> {
     core.debug("Error detected while executing commisery");
   }
 
-  return [stderr == "", get_error_subjects(stderr, commit.sha)];
+  return [stderr == "", get_error_subjects(stderr)];
 }
 
 async function run() {
   // Ensure that commisery is installed
-  await prepare_environment();
+  try {
+    await prepare_environment();
 
-  let [owner, repo] = (process.env.GITHUB_REPOSITORY || "").split("/");
+    let [owner, repo] = (process.env.GITHUB_REPOSITORY || "").split("/");
 
-  // Validate each commit against Conventional Commit standard
-  let commits = await get_commits(owner, repo, core.getInput("pull_request"));
-  let success = true;
+    // Validate each commit against Conventional Commit standard
+    let commits = await get_commits(owner, repo, core.getInput("pull_request"));
+    let success = true;
 
-  for (const commit of commits) {
-    let [valid, errors] = await is_commit_valid(commit);
+    for (const commit of commits) {
+      let [valid, errors] = await is_commit_valid(commit);
 
-    if (!valid) {
-      core.summary
-        .addHeading(commit.commit.message, 2)
-        .addRaw(
-          `<b>SHA:</b> <a href="${commit.html_url}"><code>${commit.sha}</code></a>`
-        );
+      if (!valid) {
+        core.summary
+          .addHeading(commit.commit.message, 2)
+          .addRaw(
+            `<b>SHA:</b> <a href="${commit.html_url}"><code>${commit.sha}</code></a>`
+          );
 
-      for (var error of errors) {
-        core.summary.addCodeBlock(error);
-      }
+        for (var error of errors) {
+          core.summary.addCodeBlock(error);
+        }
 
-      success = false;
+        success = false;
+      }
     }
-  }
 
-  if (!success) {
-    core.setFailed(
-      `Commits in your Pull Request are not compliant to Conventional Commits`
-    );
+    if (!success) {
+      core.setFailed(
+        `Commits in your Pull Request are not compliant to Conventional Commits`
+      );
 
-    // Post summary
-    core.summary.write();
+      // Post summary
+      core.summary.write();
+    }
+  } catch (ex) {
+    core.setFailed((ex as Error).message);
   }
 }