[WIP] Implements `show` commands by mukkachaitanya · Pull Request #117 · AutolabJS/autolabcli

mukkachaitanya · 2019-01-23T07:23:46Z

Requirements

Need for new commands for AutolabJS services

Description of the Change

Benefits

Possible Drawbacks

Applicable Issues

mukkachaitanya · 2019-01-23T07:30:53Z

Output of autolabjs show status command :

Output

| Fetching request results, please wait...
 { components:
   [ { role: 'execution_node', hostname: '10.1.*.***', port: '8091', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8092', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8093', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8094', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8095', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8096', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8097', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8098', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8099', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8100', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8101', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8102', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8103', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8104', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8105', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8106', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8107', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8108', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8109', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8110', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8091', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8092', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8093', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8094', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8095', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8096', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8097', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8098', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8099', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8100', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8101', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8102', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8103', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8104', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8105', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8106', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8107', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8108', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8109', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8110', status: 'down' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8091', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8092', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8093', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8094', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8095', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8096', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8097', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8098', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8099', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8100', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8101', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8102', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8103', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8104', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8105', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8106', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8107', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8108', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8109', status: 'up' },
     { role: 'execution_node', hostname: '10.1.*.***', port: '8110', status: 'up' },
     { role: 'load_balancer',
       hostname: 'autolab.bits-goa.ac.in',
       port: '8081',
       cmd: 'log',
       status: 'up' } ],
  job_queue_length: 0,
  timestamp: 'Wed Jan 23 2019 12:58:55 GMT+0530 (IST)' }

(hostnames hidded purposefully)

prasadtalasila

@mukkachaitanya Please see the suggested changes.

prasadtalasila · 2019-01-23T09:19:10Z

@@ -0,0 +1,16 @@
+const getInput = async (args) => {


Don't we need

const inquirer = require('inquirer'); const PromptGenerator = require('../../utils/PromptGenerator');

How did the output come without these requires?

I have only implemented the status command, sir. That needs no prompt.

prasadtalasila · 2019-01-23T11:36:01Z

+};
+
+const onShow = async (args, options, logger) => {
+  logger.moduleLog('info', 'Exit', 'Show command invoked.');


This may be logger.moduleLog('info', 'Show', 'Show command invoked.');

prasadtalasila · 2019-01-23T11:37:49Z

+  const showOptions = await showInput.getInput(args, options);
+  const validatedOptions = showValidate.validate(showOptions);
+
+  logger.moduleLog('debug', 'Eval', 'Show request for');


These two log statements again belong to Show module, not Eval and the statements can be better.

prasadtalasila · 2019-01-23T11:39:58Z

@@ -0,0 +1,10 @@
+const validate = (showEvent) => {


There is no validation logic here. Are you planning to add more later?

Yes, sir. The status command had not validation.

prasadtalasila · 2019-01-23T11:43:53Z

+  spinner.stop();
+};
+
+const sendOutput = (event) => {


Starting with this PR, perhaps we can move away from arrow functions to proper functions where there is a bulky function. We had this discussion during the refactoring of tests. The added benefit the the following flow in a module.

module.exports... //functions arranged to follow top-down rule

prasadtalasila · 2019-01-23T11:49:19Z

@mukkachaitanya I can't see the presentation code in lib/model/show.js which actually hides the IP addresses of the execution nodes.

mukkachaitanya · 2019-01-23T12:02:08Z

@mukkachaitanya I can't see the presentation code in lib/model/show.js which actually hides the IP addresses of the execution nodes.

The IP is hidden here on GitHub. The actual code output doesn't sir.

codecov · 2019-01-30T11:10:56Z

Codecov Report

Merging #117 into dev will decrease coverage by 0.09%.
The diff coverage is 98.75%.

@@            Coverage Diff            @@
##              dev     #117     +/-   ##
=========================================
- Coverage   99.28%   99.18%   -0.1%     
=========================================
  Files          24       29      +5     
  Lines         695      856    +161     
=========================================
+ Hits          690      849    +159     
- Misses          5        7      +2

Flag	Coverage Δ
#integration	`93.92% <91.3%> (-0.32%)`	⬇️
#unit	`99.18% <98.75%> (-0.1%)`	⬇️

Impacted Files	Coverage Δ
lib/cli/input/show.js	`100% <100%> (ø)`
lib/controller/validate/show.js	`100% <100%> (ø)`
lib/controller/show.js	`100% <100%> (ø)`
lib/controller/index.js	`100% <100%> (ø)`	⬆️
lib/cli/output/show.js	`100% <100%> (ø)`
lib/model/show.js	`95.83% <95.83%> (ø)`
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0534f8...afde03d. Read the comment docs.

mukkachaitanya · 2019-01-30T11:19:23Z

Output of autolabjs show score command :

(ID hidden purposefully)

mukkachaitanya · 2019-01-30T11:21:26Z

+  const file = '/tmp/autolabjs/scoreboard';
+  try {
+    await fs.outputFile(file, scoreboard);
+    spawn('cat /tmp/autolabjs/scoreboard | less -r', {


exec() spawns a shell then executes the command within that shell, buffering any generated output to the callback provides. That is the reason I have used spawn() instead.

prasadtalasila · 2019-01-30T11:57:11Z

@mukkachaitanya The output of autolabjs show score looks good. Please remember to add the display score option for a user (autolabjs show score -l lab_name -i student_id ).

mukkachaitanya · 2019-01-30T12:13:22Z

@mukkachaitanya The output of autolabjs show score looks good. Please remember to add the display score option for a user (autolabjs show score -l lab_name -i student_id ).

That is also implemented, sir.

mukkachaitanya added the Feature label Jan 23, 2019

mukkachaitanya force-pushed the show-commands branch from 4dcff7f to 9b4155c Compare January 23, 2019 07:24

prasadtalasila requested changes Jan 23, 2019

View reviewed changes

mukkachaitanya commented Jan 30, 2019

View reviewed changes

mukkachaitanya added 6 commits February 8, 2019 16:18

Adds show status command

8140f7b

Implements show score command

1ec202c

Adds unit tests

3b89a7c

Minor logic changes

a90d21e

Fixes buddy and npm-check issues

81d6368

Adds integration tests for show commands

d9b9487

mukkachaitanya force-pushed the show-commands branch from 63be8c8 to d9b9487 Compare February 8, 2019 10:53

Adds feature tests for show commands

afde03d

snyk-bot mentioned this pull request Sep 14, 2021

[Snyk] Security upgrade caporal from 0.9.0 to 1.0.0 #139

Open

prasadtalasila mentioned this pull request May 17, 2022

[Snyk] Security upgrade caporal from 0.9.0 to 1.0.0 #142

Open

prasadtalasila mentioned this pull request Nov 28, 2023

[Snyk] Security upgrade caporal from 0.9.0 to 1.0.0 #149

Open

prasadtalasila mentioned this pull request Apr 17, 2024

[Snyk] Fix for 1 vulnerabilities #151

Open

Conversation

mukkachaitanya commented Jan 23, 2019

Requirements

Description of the Change

Benefits

Possible Drawbacks

Applicable Issues

Uh oh!

mukkachaitanya commented Jan 23, 2019

Uh oh!

prasadtalasila left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prasadtalasila commented Jan 23, 2019

Uh oh!

mukkachaitanya commented Jan 23, 2019

Uh oh!

codecov Bot commented Jan 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mukkachaitanya commented Jan 30, 2019

Uh oh!

mukkachaitanya Jan 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prasadtalasila commented Jan 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mukkachaitanya commented Jan 30, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Jan 30, 2019 •

edited

Loading

mukkachaitanya Jan 30, 2019 •

edited

Loading

prasadtalasila commented Jan 30, 2019 •

edited

Loading