projektor-publish 3.5.1 → 3.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "projektor-publish",
-  "version": "3.5.1",
+  "version": "3.8.0",
   "homepage": "https://projektor.dev/docs/node-script/",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
     "projektor": "env-cmd -f ~/.env projektor-publish"
   },
   "dependencies": {
-    "axios": "0.21.1",
+    "axios": "0.21.2",
     "glob": "7.1.4",
     "lodash": "4.17.21",
     "minimist": "1.2.5",
@@ -26,10 +26,10 @@
   "devDependencies": {
     "axios-mock-adapter": "1.17.0",
     "env-cmd": "10.1.0",
-    "jest": "27.0.4",
-    "jest-junit": "12.2.0",
-    "prettier": "2.3.1",
-    "projektor-publish": "3.5.0",
+    "jest": "27.2.5",
+    "jest-junit": "13.0.0",
+    "prettier": "2.4.1",
+    "projektor-publish": "3.7.0",
     "wait-for-expect": "3.0.2"
   },
   "jest": {

package/publish-functional-test/package.json

@@ -9,11 +9,11 @@
     "format": "prettier --write src/**/*.js"
   },
   "devDependencies": {
-    "axios": "0.21.1",
+    "axios": "0.21.2",
     "env-cmd": "10.1.0",
-    "jest": "26.6.3",
-    "jest-junit": "12.0.0",
-    "prettier": "2.1.2",
+    "jest": "27.2.5",
+    "jest-junit": "13.0.0",
+    "prettier": "2.4.1",
     "projektor-publish": "file:../",
     "wait-for-expect": "3.0.1"
   }

package/src/index.js

@@ -1,3 +1,5 @@
+const { writeNoResultsSlackMessageFileToDisk } = require("./slack");
+
 async function runCLI(cliArgs, publishToken, defaultConfigFilePath) {
   const parsedArgs = require("minimist")(cliArgs, {
     boolean: "exitWithFailure",
@@ -23,6 +25,7 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
   let performanceFileGlobs;
   let baseDirectoryPath;
   let exitWithFailure;
+  let failOnPublishError;
   let writeSlackMessageFile;
   let slackMessageFileName;
   let slackProjectName;
@@ -32,6 +35,7 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
   let resultsMaxSizeMB;
   let attachmentMaxSizeMB;
   let groupResults;
+  let gitMainBranchNames;
 
   const configFilePath = args.configFile || defaultConfigFilePath;
 
@@ -45,7 +49,10 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
     coverageFileGlobs = config.coverage;
     performanceFileGlobs = config.performance;
     baseDirectoryPath = config.baseDirectoryPath;
+
     exitWithFailure = config.exitWithFailure;
+    failOnPublishError = config.failOnPublishError;
+
     writeSlackMessageFile = config.writeSlackMessageFile;
     slackMessageFileName = config.slackMessageFileName;
     slackProjectName = config.slackProjectName;
@@ -55,6 +62,7 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
     resultsMaxSizeMB = config.resultsMaxSizeMB;
     attachmentMaxSizeMB = config.attachmentMaxSizeMB;
     groupResults = config.groupResults;
+    gitMainBranchNames = config.gitMainBranchNames;
   } else {
     serverUrl = args.serverUrl;
     resultsFileGlobs = args.resultsFileGlobs;
@@ -75,7 +83,10 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
         : [args.performance];
     }
     baseDirectoryPath = args.baseDirectoryPath;
+
     exitWithFailure = args.exitWithFailure;
+    failOnPublishError = args.failOnPublishError;
+
     writeSlackMessageFile = args.writeSlackMessageFile;
     slackMessageFileName = args.slackMessageFileName;
     slackProjectName = args.slackProjectName;
@@ -85,6 +96,12 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
     resultsMaxSizeMB = args.resultsMaxSizeMB;
     attachmentMaxSizeMB = args.attachmentMaxSizeMB;
     groupResults = args.groupResults;
+
+    if (args.gitMainBranchNames) {
+      gitMainBranchNames = Array.isArray(args.gitMainBranchNames)
+        ? args.gitMainBranchNames
+        : args.gitMainBranchNames.split(",");
+    }
   }
 
   if (_.isNil(compressionEnabled)) {
@@ -103,6 +120,10 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
     resultsMaxSizeMB = 20;
   }
 
+  if (_.isNil(gitMainBranchNames)) {
+    gitMainBranchNames = ["main", "master"];
+  }
+
   if (resultsFileGlobs || performanceFileGlobs) {
     // https://go-vela.github.io/docs/concepts/pipeline/steps/environment/
     // https://docs.github.com/en/actions/reference/environment-variables
@@ -124,28 +145,36 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
       group = buildNumber;
     }
 
-    const { resultsBlob, performanceResults, reportUrl, publicId } =
-      await collectAndSendResults(
-        serverUrl,
-        publishToken,
-        resultsFileGlobs,
-        attachmentFileGlobs,
-        coverageFileGlobs,
-        performanceFileGlobs,
-        gitRepoName,
-        gitBranchName,
-        gitCommitSha,
-        gitPullRequestNumber,
-        projectName,
-        isCI,
-        group,
-        compressionEnabled,
-        baseDirectoryPath,
-        resultsMaxSizeMB,
-        attachmentMaxSizeMB
-      );
+    const {
+      resultsBlob,
+      performanceResults,
+      reportUrl,
+      publicId,
+      error: publishError,
+    } = await collectAndSendResults(
+      serverUrl,
+      publishToken,
+      resultsFileGlobs,
+      attachmentFileGlobs,
+      coverageFileGlobs,
+      performanceFileGlobs,
+      gitRepoName,
+      gitBranchName,
+      gitCommitSha,
+      gitPullRequestNumber,
+      projectName,
+      isCI,
+      group,
+      compressionEnabled,
+      baseDirectoryPath,
+      resultsMaxSizeMB,
+      attachmentMaxSizeMB,
+      gitMainBranchNames
+    );
+
+    const hasResults = resultsBlob || performanceFileGlobs;
 
-    if (!resultsBlob && !performanceFileGlobs) {
+    if (!hasResults) {
       console.log(
         `No test results files found in locations ${resultsFileGlobs}`
       );
@@ -162,12 +191,27 @@ async function run(args, env, publishToken, defaultConfigFilePath) {
     }
 
     if (writeSlackMessageFile) {
-      writeSlackMessageFileToDisk(
-        reportUrl,
-        slackMessageFileName || "projektor_failure_message.json",
-        slackProjectName || projectName,
-        containsTestFailure(resultsBlob)
-      );
+      const messageFileName =
+        slackMessageFileName || "projektor_failure_message.json";
+      const messageProjectName = slackProjectName || projectName;
+
+      if (hasResults) {
+        writeSlackMessageFileToDisk(
+          reportUrl,
+          messageFileName,
+          messageProjectName,
+          containsTestFailure(resultsBlob)
+        );
+      } else {
+        writeNoResultsSlackMessageFileToDisk(
+          messageFileName,
+          messageProjectName
+        );
+      }
+    }
+
+    if (publishError && failOnPublishError) {
+      process.exitCode = 1;
     }
 
     if (exitWithFailure && containsTestFailure(resultsBlob)) {

package/src/publish-coverage.js

@@ -3,9 +3,11 @@ const { collectFileContents } = require("./file-utils");
 const collectCoverage = (coverageFileGlobs, baseDirectoryPath) => {
   const coverageFiles = collectFileContents(coverageFileGlobs);
 
-  console.log(
-    `Found ${coverageFiles.length} coverage file(s) in ${coverageFileGlobs}`
-  );
+  if (coverageFileGlobs) {
+    console.log(
+      `Found ${coverageFiles.length} coverage file(s) in ${coverageFileGlobs}`
+    );
+  }
 
   return coverageFiles.map((coverageFile) => {
     const coverageFilePayload = {

package/src/publish.js

@@ -53,7 +53,8 @@ const sendResults = async (
   isCI,
   group,
   compressionEnabled,
-  resultsMaxSizeMB
+  resultsMaxSizeMB,
+  gitMainBranchNames
 ) => {
   const headers = {};
 
@@ -82,7 +83,10 @@ const sendResults = async (
       git: {
         repoName: gitRepoName,
         branchName: gitBranchName,
-        isMainBranch: gitBranchName === "main" || gitBranchName === "master",
+        isMainBranch:
+          gitBranchName &&
+          gitMainBranchNames &&
+          gitMainBranchNames.includes(gitBranchName),
         projectName,
         commitSha: gitCommitSha,
         pullRequestNumber: gitPullRequestNumber,
@@ -148,7 +152,8 @@ const collectAndSendResults = async (
   compressionEnabled,
   baseDirectoryPath,
   resultsMaxSizeMB,
-  attachmentMaxSizeMB
+  attachmentMaxSizeMB,
+  gitMainBranchNames
 ) => {
   console.log(
     createResultsLogMessage(resultsFileGlobs, coverageFileGlobs, serverUrl)
@@ -177,7 +182,8 @@ const collectAndSendResults = async (
         isCI,
         group,
         compressionEnabled,
-        resultsMaxSizeMB
+        resultsMaxSizeMB,
+        gitMainBranchNames
       );
 
       const publicId = resultsResponseData.id;
@@ -207,6 +213,7 @@ const collectAndSendResults = async (
         performanceResults,
         publicId: null,
         reportUrl: null,
+        error: e,
       };
     }
   } else {

package/src/slack.js

@@ -1,3 +1,5 @@
+const fs = require("fs");
+
 function writeSlackMessageFileToDisk(
   reportUrl,
   slackMessageFileName,
@@ -45,7 +47,40 @@ function createSlackMessageJson(
   return JSON.stringify(message);
 }
 
+function writeNoResultsSlackMessageFileToDisk(
+  slackMessageFileName,
+  projectName
+) {
+  const fs = require("fs");
+
+  const messageJson = createNoResultsSlackMessageJson(projectName);
+
+  fs.writeFileSync(slackMessageFileName, messageJson);
+}
+
+function createNoResultsSlackMessageJson(projectName, currentTimestamp) {
+  const projectNameToDisplay = projectName || "";
+
+  const message = {
+    attachments: [
+      {
+        fallback: "Projektor test report",
+        color: "#FFFF00",
+        pretext: "No test results found",
+        title: "Projektor test report",
+        text: `No test results found to publish in project ${projectNameToDisplay}`,
+        footer: "Projektor",
+        ts: currentTimestamp || new Date().getTime(),
+      },
+    ],
+  };
+
+  return JSON.stringify(message);
+}
+
 module.exports = {
   writeSlackMessageFileToDisk,
   createSlackMessageJson,
+  writeNoResultsSlackMessageFileToDisk,
+  createNoResultsSlackMessageJson,
 };