Add npm run quality script, Update Readme

.buddyrc

@@ -0,0 +1,5 @@
+{
+  "detectObjects": true,
+  "enforceConst":  true,
+  "reporter":  "detailed"
+}

.eslintignore

@@ -1,2 +1,3 @@
-/node_modules
-/coverage
+node_modules/*
+coverage/*
+test/feature/*

.eslintrc.json

@@ -1,6 +1,18 @@
 {
     "extends": "airbnb-base",
+    "env" : {
+        "node": true,
+        "mocha": true
+    },
     "rules": {
-        "max-lines-per-function" : ["error", 30]
+        "max-lines-per-function" : ["error", 30],
+        "no-plusplus" : ["error", { "allowForLoopAfterthoughts": true }],
+        "no-console" : ["off"],
+        "no-unused-vars": [
+            "error",
+            {
+              "varsIgnorePattern": "should|expect|Before|After|Given"
+            }
+        ]
     }
 }

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 .nyc_output/
 coverage/
 coverage.lcov
+module-depencency.svg

.jsinspectrc

@@ -0,0 +1,9 @@
+{
+  "threshold":     30,
+  "identifiers":   true,
+  "literals":      true,
+  "color":         true,
+  "ignore":        "coverage",
+  "minInstances":  2,
+  "truncate":      100
+}

.madgerc

@@ -0,0 +1,12 @@
+{
+	"fontSize": "10px",
+    "backgroundColor" : "#ffffff",
+    "nodeColor": "#000000",
+    "edgeColor" : "#000000",
+    "noDependencyColor" : "#7f7f7f",
+	"graphVizOptions": {
+		"G": {
+			"rankdir": "LR"
+		}
+	}
+}

.travis.yml

@@ -10,3 +10,4 @@ script:
   - npm run post-unit
   - npm run integration
   - npm run post-integration
+  - npm run quality

README.md

@@ -12,9 +12,11 @@ A client command line interface for submissions to [AutolabJS](https://github.co
 * `autolabjs exit` - Logout off AutolabJS
 * `autolabjs prefs changeserver [ --type ms --host <host> --port <port>]` - To change the host for main server.
 * `autolabjs prefs changeserver [ --type gitlab --host <host>]` - To change the host for gitlab server.
+* `autolabjs prefs logger [--maxsize <size> --blacklist <keyword>]` - To change logger file's maxsize and add keyword to log blacklist
 * `autolabjs prefs show` - Show the saved preferences
 * `autolabjs eval [-l <lab_name> --lang <language>]` - To submit your code for evaluation
 * `autolabjs help` - Print help manual
+* `autolabjs <command> [options] -v` - To print debug/error log messages to log file (Default location `~/.autolabjs/cli.log`)
 
 ## License ##
 GNU General Public License

lib/cli/input/eval.js

@@ -1,10 +1,11 @@
 const inquirer = require('inquirer');
 const path = require('path');
+const fs = require('fs');
 const PromptGenerator = require('../../utils/PromptGenerator');
 const preferenceManager = require('../../utils/preference-manager');
 
 const defaultPrefPath = path.join(__dirname, '../../../default-prefs.json');
-const defaultPrefs = JSON.parse(require('fs').readFileSync(defaultPrefPath, 'utf8'));
+const defaultPrefs = JSON.parse(fs.readFileSync(defaultPrefPath, 'utf8'));
 
 const { supportedLanguages } = defaultPrefs;
 const { logger } = require('../../utils/logger');
@@ -50,15 +51,16 @@ const getSubmitInfo = () => {
 
 const getIdNo = (options) => {
   logger.moduleLog('debug', 'Eval Input', 'Fetching id to submit.');
-  const username = preferenceManager.getPreference({ name: 'gitLabPrefs' }).username;
+  const { username } = preferenceManager.getPreference({ name: 'gitLabPrefs' });
   if (username === 'root') {
     logger.moduleLog('debug', 'Eval Input', `Root user detected, passing up the ID provided : ${options.i}.`);
     return options.i || '';
   }
   return username;
 };
 
-const isValidOptions = options => options.l && options.lang && supportedLanguages.indexOf(options.lang) !== -1;
+const isValidOptions = options => options.l && options.lang
+                                  && supportedLanguages.indexOf(options.lang) !== -1;
 
 const getInput = async (args, options) => {
   let evalOptions = {};

lib/cli/input/init.js

@@ -1,6 +1,5 @@
 const inquirer = require('inquirer');
 const PromptGenerator = require('../../utils/PromptGenerator');
-const { logger } = require('../../utils/logger');
 
 const getLengthValidator = invalidMessage => (value) => {
   if (value.length) {

lib/cli/input/prefs.js

@@ -87,16 +87,20 @@ const changeGitlab = (host) => {
 };
 
 const changeServer = async (options) => {
-  let { host, port, type } = options;
+  const { host, port } = options;
+  let { type } = options;
   if (!type) {
     const typePrompt = prefPrompts.getServerTypePrompt();
-    type = (await inquirer.prompt(typePrompt)).type;
+    ({ type } = (await inquirer.prompt(typePrompt)));
   }
   if (type === 'ms') {
     return changeMainServer(host, port);
   } if (type === 'gitlab') {
     return changeGitlab(host);
   }
+  return {
+    name: 'invalid_server',
+  };
 };
 
 const changeLogger = async (options) => {
@@ -124,15 +128,19 @@ const changeLogger = async (options) => {
 const getInput = async (args, options) => {
   switch (args.preference) {
     case 'changelang':
-      return await changeLang(options);
+      return changeLang(options);
     case 'changeserver':
-      return await changeServer(options);
+      return changeServer(options);
     case 'show':
       return {
         name: 'show_prefs',
       };
     case 'logger':
-      return await changeLogger(options);
+      return changeLogger(options);
+    default:
+      return {
+        name: 'invalid_command',
+      };
   }
 };
 

lib/cli/input/prefsprompt.js

@@ -1,12 +1,13 @@
 const inquirer = require('inquirer');
 const path = require('path');
+const fs = require('fs');
 
 const validator = require('validator');
 const PromptGenerator = require('../../utils/PromptGenerator');
 const preferenceManager = require('../../utils/preference-manager');
 
 const defaultPrefPath = path.join(__dirname, '../../../default-prefs.json');
-const defaultPrefs = JSON.parse(require('fs').readFileSync(defaultPrefPath, 'utf8'));
+const defaultPrefs = JSON.parse(fs.readFileSync(defaultPrefPath, 'utf8'));
 
 const { supportedLanguages } = defaultPrefs;
 
@@ -145,12 +146,15 @@ const changeBlacklist = async () => {
 
 const changeLoggerPrompt = async () => {
   const loggerPrompt = getLoggerPreferncePrompt();
-  const type = (await inquirer.prompt(loggerPrompt)).type;
+  const { type } = (await inquirer.prompt(loggerPrompt));
   if (type === 'maxsize') {
     return changeMaxSize();
   } if (type === 'blacklist') {
     return changeBlacklist();
   }
+  return {
+    name: 'invalid_logger_pref',
+  };
 };
 
 module.exports = {

lib/cli/output/eval.js

@@ -23,12 +23,16 @@ const onSubmissionPending = () => {
 };
 
 const printTableAndGetScore = (data) => {
+  const testCaseColWidth = 15;
+  const statusColWidth = 25;
+  const scoreColWidth = 15;
+
   const table = new Table({
     head: [chalk.cyan('Test Case #'), chalk.cyan('Status'), chalk.cyan('Score')],
-    colWidths: [15, 25, 15],
+    colWidths: [testCaseColWidth, statusColWidth, scoreColWidth],
   });
   let totalScore = 0;
-  for (i = 0; i < data.marks.length; i++) {
+  for (let i = 0; i < data.marks.length; ++i) {
     totalScore += +data.marks[i];
     table.push([(i + 1), data.comment[i], data.marks[i]]);
   }
@@ -37,9 +41,9 @@ const printTableAndGetScore = (data) => {
 };
 
 const printStatusAndLog = (data, totalScore) => {
-  logger.moduleLog('debug', 'Eval Output', `Evaluation logs: ${new Buffer(data.log, 'base64').toString()}.`);
+  logger.moduleLog('debug', 'Eval Output', `Evaluation logs: ${Buffer.from(data.log, 'base64').toString()}.`);
 
-  console.log(`\n${chalk.yellow('Log :\n')}${new Buffer(data.log, 'base64').toString()}`);
+  console.log(`\n${chalk.yellow('Log :\n')}${Buffer.from(data.log, 'base64').toString()}`);
   if (data.status !== 0) {
     console.log(chalk.red('Penalty : ') + data.penalty);
   } else if (data.status === 0) {
@@ -71,6 +75,8 @@ const sendOutput = (event) => {
       stopSpinner();
       onScores(event.details);
       break;
+    default:
+      console.log(chalk.red('\nInvalid Event'));
   }
 };
 

lib/cli/output/exit.js

@@ -10,6 +10,8 @@ const sendOutput = (event) => {
     case 'logout_success':
       sendLogoutMessage();
       break;
+    default:
+      console.log(chalk.red('\nInvalid Event'));
   }
 };
 

lib/cli/output/init.js

@@ -26,14 +26,15 @@ const sendSuccessWelcome = (user) => {
 };
 
 const sendError = (error) => {
-  error = chalk.red(error);
-  console.log(error);
+  console.log(chalk.red(error));
 };
 
 const handleResponse = (status) => {
-  if (status.code === 200) {
+  const httpOK = 200;
+  const httpFailure = 4;
+  if (status.code === httpOK) {
     sendSuccessWelcome(status.name);
-  } else if (status.code === 4) {
+  } else if (status.code === httpFailure) {
     sendError('\nPlease check your network connection');
   } else {
     sendError('\nInvalid Username or Password');
@@ -54,6 +55,9 @@ const sendOutput = (event) => {
       stopSpinner();
       handleResponse(event.details);
       break;
+
+    default:
+      console.log(chalk.red('\nInvalid Event'));
   }
 };
 

lib/cli/output/prefs.js

@@ -2,9 +2,11 @@ const chalk = require('chalk');
 const Table = require('cli-table');
 
 const showPrefs = (prefs) => {
+  const prefsColWidth = 25;
+  const valuesColWidth = 27;
   const table = new Table({
     head: [chalk.cyan('Preferences'), chalk.cyan('Values')],
-    colWidths: [25, 27],
+    colWidths: [prefsColWidth, valuesColWidth],
   });
   table.push(
     ['Gitlab host', prefs.gitlab_host],
@@ -18,17 +20,21 @@ const showPrefs = (prefs) => {
   console.log(table.toString());
 };
 
+const showServerChange = (event) => {
+  if (event.details.type === 'ms') {
+    console.log(chalk.green(`Your main server has been changed to ${event.details.host} at port ${event.details.port}`));
+  } else if (event.details.type === 'gitlab') {
+    console.log(chalk.green(`Your gitlab server has been changed to ${event.details.host}`));
+  }
+};
+
 const sendOutput = (event) => {
   switch (event.name) {
     case 'lang_changed':
       console.log(chalk.green(`Your submission language has been changed to ${event.details.lang}`));
       break;
     case 'server_changed':
-      if (event.details.type === 'ms') {
-        console.log(chalk.green(`Your main server has been changed to ${event.details.host} at port ${event.details.port}`));
-      } else if (event.details.type === 'gitlab') {
-        console.log(chalk.green(`Your gitlab server has been changed to ${event.details.host}`));
-      }
+      showServerChange(event);
       break;
     case 'show_prefs':
       showPrefs(event.details);
@@ -47,6 +53,9 @@ const sendOutput = (event) => {
       break;
     case 'invalid_logger_prefs':
       console.log(chalk.red('Keyword already exixts, please provide valid blacklist keyword'));
+      break;
+    default:
+      console.log(chalk.red('\nInvalid Event'));
   }
 };
 

lib/controller/index.js

@@ -5,7 +5,7 @@ const { logger } = require('../utils/logger');
 const init = require('./init');
 const exit = require('./exit');
 const prefs = require('./prefs');
-const eval = require('./eval');
+const evaluate = require('./eval');
 
 
 const start = async () => {
@@ -20,7 +20,7 @@ const start = async () => {
   init.addTo(program);
   exit.addTo(program);
   prefs.addTo(program);
-  eval.addTo(program);
+  evaluate.addTo(program);
 
   await program.parse(process.argv);
 };

lib/model/eval.js

@@ -5,8 +5,8 @@ const { logger } = require('../utils/logger');
 
 const connectToSocket = () => {
   const cliPrefs = preferenceManager.getPreference({ name: 'cliPrefs' });
-  const host = cliPrefs.main_server.host;
-  const port = cliPrefs.main_server.port;
+  const { host } = cliPrefs.main_server;
+  const { port } = cliPrefs.main_server;
 
   logger.moduleLog('debug', 'Eval Model', `Opening a socket connection to http://${host}:${port}`);
 
@@ -21,6 +21,7 @@ const getRequestArray = (evalOptions) => {
   return [idNo, lab, commitHash, lang];
 };
 
+/* eslint-disable max-lines-per-function */
 const socketEventHandler = (event, socket, data, callback) => {
   let response;
   switch (event) {
@@ -45,6 +46,13 @@ const socketEventHandler = (event, socket, data, callback) => {
         },
       };
       break;
+    default:
+      response = {
+        name: event,
+        details: {
+          ...data,
+        },
+      };
   }
 
   logger.moduleLog('error', 'Eval Model', data);