@getik-public/cli 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+### v1.3.0
+Added prebuild checks before any production builds for store
+
+
 ### v1.2.1
 Fixed typo on versionCode extraction.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getik-public/cli",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public"
   },

package/src/mobile-build.js

@@ -19,7 +19,7 @@ async function applyPatchersForExternalNpmPackages() {
   for (const filename of patchesInFolder) {
     if (filename.indexOf(filenameEndsWith) === filename.length - filenameEndsWith.length) {
       let pathToFile = path.join(process.cwd(), patchesFolderName, filename);
-      if (process.platform === "win32") {
+      if (process.platform === 'win32') {
         pathToFile = path.join('file:\\', pathToFile);
       }
       const patcherImport = await import(pathToFile);
@@ -88,7 +88,7 @@ function readVersionsFromPackageJson() {
   const zTransformed = (z < 10) ? `0${z}` : z;
   const versionCode = `${x}${yTransformed}${zTransformed}`;
 
-  console.log(`Extracted versions: versionName = ${versionName}, versionCode = ${versionCode}.`);
+  console.log(`Extracted versions: versionName = \x1b[32m${versionName}\x1b[0m, versionCode = \x1b[32m${versionCode}\x1b[0m.`);
 
   return {
     versionName: versionName,
@@ -196,7 +196,7 @@ function createCommandsForAndroid(options) {
 
 function createCommandsForIos(options) {
   const workspace = './App/App.xcworkspace';
-  const debugMode = (options.environment.indexOf("Debug") >= 0);
+  const debugMode = (options.environment.indexOf('Debug') >= 0);
   const config = (debugMode ? 'Debug' : 'Release');
   const environment = (options.environment.split('Debug')[0]);
   const archive = `./build/archive/${environment}.xcarchive`;
@@ -343,6 +343,20 @@ function runCliCommand(command, callback, path) {
 }
 
 
+function runCliCommandSilent(command, callback, path) {
+  callback = callback || function() {};
+  const ls = spawn(command, [], {shell: true, env: { ...process.env, FORCE_COLOR: true }, cwd: path || ''});
+  const output = [];
+  ls.stdout.on('data', (data) => {
+    output.push(data);
+  });
+
+  ls.on('close', (code) => {
+    callback(code, output.toString());
+  });
+}
+
+
 function runCliCommandList(list, path, callback) {
   if (list.length === 0) {
     return;
@@ -357,6 +371,207 @@ function runCliCommandList(list, path, callback) {
 }
 
 
+function applyReleaseBuildChecks(versions, options, callback) {
+  const debugMode = (options.environment.indexOf('Debug') >= 0);
+  if (debugMode) {
+    callback()
+
+    return;
+  }
+
+  console.log('----------------------------------------------------------------------------------------------------------------------');
+  if (options.force) {
+    console.log('\x1b[31mWARNING: All checks before release build are skipped! Never use "--force" when uploading build to store! \x1b[0m');
+    console.log('----------------------------------------------------------------------------------------------------------------------');
+    callback();
+
+    return;
+  }
+
+  console.log('RUNNING CHECKS BEFORE PRODUCTION BUILD...');
+  let checkFailed = false;
+
+  console.log('');
+  checkForUncommitedFiles((checkForUncommitedFilesStatus) => {
+    checkFailed = (checkFailed || checkForUncommitedFilesStatus);
+
+    console.log('');
+    checkRemoteBranch((checkRemoteBranchStatus) => {
+      checkFailed = (checkFailed || checkRemoteBranchStatus);
+
+      console.log('');
+      checkEnvironmentToBranchScheme(versions, options, (checkEnvironmentToBranchSchemeStatus) => {
+        checkFailed = (checkFailed || checkEnvironmentToBranchSchemeStatus);
+
+        console.log('');
+        checkVersionInCommit(versions, (checkVersionInCommitStatus) => {
+          checkFailed = (checkFailed || checkVersionInCommitStatus);
+
+          console.log('');
+          checkLintErrors((checkLintErrorsStatus) => {
+            checkFailed = (checkFailed || checkLintErrorsStatus);
+
+            console.log('');
+            console.log('END "RUNNING CHECKS BEFORE PRODUCTION BUILD..."');
+            console.log('----------------------------------------------------------------------------------------------------------------------');
+            if (checkFailed) {
+              throw new Error('Some prebuild checks failed, see logs to find out which ones.');
+            }
+            callback();
+          });
+        });
+      });
+    });
+  });
+}
+
+
+function checkForUncommitedFiles(callback) {
+  console.log('- Check if branch is clear. No uncommited changes are allowed.');
+  const cliCommand = 'git status -u --porcelain';
+  runCliCommandSilent(cliCommand, (code, output) => {
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git status" command failed. \x1b[0m');
+      checkFailed = true;
+    } else if (output.length > 0) {
+      console.log('\x1b[31m FAILED! You have uncommited changes. \x1b[0m');
+      checkFailed = true;
+    } else {
+      console.log('\x1b[32m PASSED! \x1b[0m');
+    }
+    callback(checkFailed);
+  });
+}
+
+
+function checkRemoteBranch(callback) {
+  console.log('- Check if local branch is up to date with remote branch.');
+  const cliGetCurrentBranchName = 'git rev-parse --abbrev-ref HEAD';
+  runCliCommandSilent(cliGetCurrentBranchName, (code, branchName) => {
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git rev-parse" command failed. \x1b[0m');
+      callback(true);
+    } else {
+      branchName = branchName.trim();
+      const cliGitFetch = `git fetch origin ${branchName}`;
+      runCliCommandSilent(cliGitFetch, (code) => {
+        if (code !== 0) {
+          console.log('\x1b[31m FAILED! "git fetch" command failed. \x1b[0m');
+          callback(true);
+        } else {
+          const cliGitDiff = `git diff origin/${branchName} ${branchName} --name-only`;
+          runCliCommandSilent(cliGitDiff, (code, diffData) => {
+            if (code !== 0) {
+              console.log('\x1b[31m FAILED! "git diff" command failed. \x1b[0m');
+              callback(true);
+            } else if (diffData.length > 0) {
+              console.log('\x1b[31m FAILED! Local branch is not up to date with remote branch. \x1b[0m');
+              callback(true);
+            } else {
+              console.log('\x1b[32m PASSED! \x1b[0m');
+              callback(false);
+            }
+          });
+        }
+      });
+    }
+  });
+}
+
+
+function checkEnvironmentToBranchScheme(versions, options, callback) {
+  console.log('- Check if build for selected environment can be made from current branch.');
+
+  const cliGetCurrentBranchName = 'git rev-parse --abbrev-ref HEAD';
+  runCliCommandSilent(cliGetCurrentBranchName, (code, branchName) => {
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git rev-parse" command failed. \x1b[0m');
+      callback(true);
+    } else {
+      branchName = branchName.trim();
+      if (options.environment === 'getik') {
+        if (branchName === 'develop') {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log('\x1b[31m FAILED! You can build for "getik" environment only from "develop". \x1b[0m');
+          callback(true);
+        }
+      } else if (options.environment === 'qa') {
+        const requiredBranchName = `release/${versions.versionName.substring(0, versions.versionName.length - 2)}x`;
+        if (branchName === requiredBranchName) {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log(`\x1b[31m FAILED! You can build for "qa" environment only from "${requiredBranchName}". \x1b[0m`);
+          callback(true);
+        }
+      } else if (options.environment === 'preprod' || options.environment === 'prod') {
+        if (branchName === 'master') {
+          console.log('\x1b[32m PASSED! \x1b[0m');
+          callback(false);
+        } else {
+          console.log(`\x1b[31m FAILED! You can build for "${options.environment}" environment only from "master". \x1b[0m`);
+          callback(true);
+        }
+      } else {
+        console.log('\x1b[32m PASSED! \x1b[0m');
+        callback(false);
+      }
+    }
+  });
+}
+
+
+function checkVersionInCommit(versions, callback) {
+  console.log('- Check if latest commit is a version update commit and it is the same as in "package.json".');
+  const cliCommand = 'git log -1 --pretty=%B';
+  runCliCommandSilent(cliCommand, (code, commitMessage) => {
+    commitMessage = commitMessage.trim();
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! "git log" command failed. \x1b[0m');
+      checkFailed = true;
+    } else {
+      const expectedMessage = `APP VERSION UPDATE: versionName: ${versions.versionName}`;
+      if (commitMessage === expectedMessage) {
+        console.log('\x1b[32m PASSED! \x1b[0m');
+        checkFailed = false;
+      } else {
+        console.log('\x1b[31m FAILED! Version in "package.json" is not the same as in commit message. \x1b[0m');
+        checkFailed = true;
+      }
+    }
+    callback(checkFailed);
+  });
+}
+
+
+function checkLintErrors(callback) {
+  console.log('- Check for lint errors.');
+  const P = ['\\', '|', '/', '-'];
+  let x = 0;
+  const ref = setInterval(() => {
+    process.stdout.write('\r' + P[x++]);
+    x &= 3;
+  }, 250);
+  const cliCommand = 'npm run lint';
+  runCliCommandSilent(cliCommand, (code, output) => {
+    clearInterval(ref);
+    process.stdout.write('\r');
+    let checkFailed = false;
+    if (code !== 0) {
+      console.log('\x1b[31m FAILED! There are "lint" errors. \x1b[0m');
+      checkFailed = true;
+    } else {
+      console.log('\x1b[32m PASSED! \x1b[0m');
+    }
+    callback(checkFailed);
+  });
+}
+
+
 export const mobileBuild = () => {
   program
     .command('mobile-build')
@@ -365,25 +580,29 @@ export const mobileBuild = () => {
     .option('--syncOnly', 'Apply capacitor sync only, without platform build')
     .option('--aab', 'Android platform only, final build as AAB')
     .option('--upload', 'iOS platform only, upload directly to AppStore')
+    .option('--force', 'Skip all checks for builds of type release')
     .action((options) => {
       console.log('INPUT OPTIONS: ', options);
       const cliCommands = createCliCommands(options);
-
       const versions = readVersionsFromPackageJson();
-      if (options.platform === 'android') {
-        checkKeystorePropertiesFile();
-        applyVersionForAndroid(versions);
-      } else if (options.platform === 'ios') {
-        checkSensitiveDataJsonFile();
-        applyVersionForIos(versions);
-      }
-      applyPatchersForExternalNpmPackages();
-      runCliCommand(cliCommands.buildAngular, function () {
-        runCliCommand(cliCommands.capacitorSync(), function () {
-          runCliCommandList(cliCommands.buildApp, options.platform, () => {
-            setTimeout(() => {
-              copyFinalBuildToRootFolder(options);
-            }, 100);
+
+      applyReleaseBuildChecks(versions, options, () => {
+        if (options.platform === 'android') {
+          checkKeystorePropertiesFile();
+          applyVersionForAndroid(versions);
+        } else if (options.platform === 'ios') {
+          checkSensitiveDataJsonFile();
+          applyVersionForIos(versions);
+        }
+        applyPatchersForExternalNpmPackages().then(() => {
+          runCliCommand(cliCommands.buildAngular, function () {
+            runCliCommand(cliCommands.capacitorSync(), function () {
+              runCliCommandList(cliCommands.buildApp, options.platform, () => {
+                setTimeout(() => {
+                  copyFinalBuildToRootFolder(options);
+                }, 100);
+              });
+            });
           });
         });
       });