Refactor tests (#30)

* Renamed node.js.yml to build.yml

* Moved test files

1. Moved `tests/1/` and `tests/2/` to `src/1/__tests__/` and `src/2/__tests__/` respectively
2. Updated relative imports
3. Updated test file paths

* Moved test files for challenge 3, updated README for challenge 3

* Updated readme for challenge 1 and challenge 2

* Moved tests for challenge 4. Updated readme for challenge 4

* Updated readme and tests for challenge 5

* Updated tests and readme for challenge 6

* Updated tests and readme for challenge 7

* Updated tests and readme for challenge 8

* Updated test files and readme for challenge 9

* Updated tests and readme for challenge 10

* Updated readme and tests for challenge 11

* Updated tests and readme for challenge 13

* Updated readme and tests for challenge 14

* Updated tests and readme for challenge 15

* Updated tests and readme for challenge 16

* Updated readme and tests for challenge 17. Updated jest config file

* Updated comments for challenge 1 tests. Updated global readme.

* Updated tests for grep. Using LINUX path systems everywhere.

* Updated path to shell.js, added console statements in cat.test.ts

* Fixed challenge 14 and 15, updated readme for challenge 19

The challenges were referring to the `.js` file present in `./build/src` folders. Since the `tests` folder was removed, now there is no `src` folder present and we can directly using `./build` folder to refer to the `.js` files

Author: jainmohit2001

.github/workflows/node.js.yml .github/workflows/build.yml

@@ -1,5 +1,5 @@
 module.exports = {
-  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  roots: ['<rootDir>/src'],
   testMatch: [
     '**/__tests__/**/*.+(ts|tsx|js)',
     '**/?(*.)+(spec|test).+(ts|tsx|js)'

README.md

@@ -1,8 +1,12 @@
 import { execSync } from 'child_process';
 import fs from 'fs';
-import { myWC } from '../../src/1/wc';
+import { myWC } from '../wc';
+import path from 'path';
 
-const filePaths = ['./tests/1/test1.txt', './tests/1/test2.txt'];
+const filePaths = [
+  path.join(__dirname, 'test1.txt'),
+  path.join(__dirname, 'test2.txt')
+];
 
 describe('Testing with filenames', () => {
   filePaths.forEach((filePath) => {
@@ -11,7 +15,7 @@ describe('Testing with filenames', () => {
       .trim()
       .replace(/ +(?= )/g, '')
       .split(' ');
-    // Sample output - 0 0 0 ./tests/1/test1.txt
+    // Sample output - 0 0 0 ./src/1/__tests__/test1.txt
 
     const l = output[0];
     const w = output[1];
@@ -57,7 +61,7 @@ describe('Testing without filename', () => {
       .trim()
       .replace(/ +(?= )/g, '')
       .split(' ');
-    // Sample output - 0 0 0 ./tests/1/test1.txt
+    // Sample output - 0 0 0 ./src/1/__tests__/test1.txt
 
     const l = output[0];
     const w = output[1];

jest.config.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import { execSync } from 'child_process';
-import { uniq } from '../../src/10/uniq';
+import { uniq } from '../uniq';
+import path from 'path';
 
 function expectLineByLine(buffer: Buffer, output: string) {
   const expectedOutput = buffer
@@ -16,7 +17,10 @@ function expectLineByLine(buffer: Buffer, output: string) {
 }
 
 describe('Testing with files', () => {
-  const files = ['./tests/10/countries.txt', './tests/10/test.txt'];
+  const files = [
+    path.join(__dirname, 'countries.txt'),
+    path.join(__dirname, 'test.txt')
+  ];
 
   files.forEach((file) => {
     test(`Handle default behavior ${file}`, async () => {
@@ -58,7 +62,7 @@ describe('Testing with files', () => {
 });
 
 describe('Testing with streams', () => {
-  const file = './tests/10/test.txt';
+  const file = path.join(__dirname, 'test.txt');
   const stream = fs.createReadStream(file);
 
   test(`Handle default behavior ${file}`, async () => {

src/1/README.md

@@ -1,6 +1,6 @@
 import axios from 'axios';
-import { createWebServer } from '../../src/11';
-import { HttpServer } from '../../src/11/webserver';
+import { createWebServer } from '..';
+import { HttpServer } from '../webserver';
 
 describe('Testing WebServer', () => {
   const server: HttpServer = createWebServer(undefined, 8000);

tests/1/test1.txt src/1/__tests__/test1.txt

@@ -1,4 +1,4 @@
-import { lcs, lcsArray } from '../../src/13/diff';
+import { lcs, lcsArray } from '../diff';
 
 describe('Testing lcs Function', () => {
   // [s1, s2]

tests/1/test2.txt src/1/__tests__/test2.txt

@@ -1,28 +1,19 @@
 import { ChildProcessWithoutNullStreams, execSync, spawn } from 'child_process';
-import path from 'path';
 
 describe('Testing normal command execution', () => {
   const inputs = [
-    'uniq --count ./tests/10/countries.txt\n',
-    'uniq --repeated ./tests/10/test.txt\n',
+    'uniq --count ./src/10/__tests__/countries.txt\n',
+    'uniq --repeated ./src/10/__tests__/test.txt\n',
     'ls\n',
     'cat README.md\n',
     'cat README.md | wc\n',
     'cat README.md | wc | wc\n',
     'pwd\n',
-    'cut -f2 -d, ./tests/4/fourchords.csv | uniq | wc -l\n'
+    'cut -f2 -d, ./src/4/__tests__/fourchords.csv | uniq | wc -l\n'
   ];
 
   // File path to the shell.js file relative to this test file
-  const filePath = path.join(
-    __dirname,
-    '..',
-    '..',
-    'build',
-    'src',
-    '14',
-    'shell.js'
-  );
+  const filePath = './build/14/shell.js';
 
   let shell: ChildProcessWithoutNullStreams;
 

tests/1/wc.test.ts src/1/__tests__/wc.test.ts

@@ -1,4 +1,5 @@
 import { ChildProcessWithoutNullStreams, execSync, spawn } from 'child_process';
+import path from 'path';
 
 /**
  * This is a helper function which waits for the program to finish,
@@ -15,8 +16,12 @@ function catToolStdoutChecker(
   done: jest.DoneCallback,
   debug: boolean = false
 ) {
-  catTool.on('error', () => {});
-  catTool.stderr.on('data', () => {});
+  catTool.on('error', (err) => {
+    console.error(err);
+  });
+  catTool.stderr.on('data', (data) => {
+    console.error(data.toString());
+  });
   let finalData = '';
 
   catTool.stdout.on('data', (data) => {
@@ -32,11 +37,13 @@ function catToolStdoutChecker(
   });
 }
 
+const pathToCatJs = './build/15/cat.js';
+
 describe('Testing cat tool', () => {
   let catTool: ChildProcessWithoutNullStreams;
-  const testFile1 = './tests/15/test1.txt';
-  const testFile2 = './tests/15/test2.txt';
-  const testFile3 = './tests/15/test3.txt';
+  const testFile1 = path.join(__dirname, 'test1.txt');
+  const testFile2 = path.join(__dirname, 'test2.txt');
+  const testFile3 = path.join(__dirname, 'test3.txt');
 
   afterEach(() => {
     catTool.kill('SIGINT');
@@ -45,15 +52,15 @@ describe('Testing cat tool', () => {
   it('Should output when provided a valid file', (done) => {
     const expectedOutput = execSync('cat ' + testFile1).toString();
 
-    catTool = spawn('node', ['./build/src/15/cat.js', testFile1]);
+    catTool = spawn('node', [pathToCatJs, testFile1]);
 
     catToolStdoutChecker(catTool, expectedOutput, done);
   });
 
   it('Should handle input from stdin', (done) => {
     const expectedOutput = execSync(`head -n1 ${testFile1} | cat -`).toString();
 
-    catTool = spawn('node', ['./build/src/15/cat.js', '-']);
+    catTool = spawn('node', [pathToCatJs, '-']);
 
     catToolStdoutChecker(catTool, expectedOutput, done);
 
@@ -64,7 +71,7 @@ describe('Testing cat tool', () => {
   it('Should concatenate files', (done) => {
     const expectedOutput = execSync(`cat ${testFile1} ${testFile2}`).toString();
 
-    catTool = spawn('node', ['./build/src/15/cat.js', testFile1, testFile2]);
+    catTool = spawn('node', [pathToCatJs, testFile1, testFile2]);
 
     catToolStdoutChecker(catTool, expectedOutput, done);
   });
@@ -76,7 +83,7 @@ describe('Testing cat tool', () => {
         .split(/\r\n|\n/)
         .join('\r\n');
 
-      catTool = spawn('node', ['./build/src/15/cat.js', '-n']);
+      catTool = spawn('node', [pathToCatJs, '-n']);
 
       catToolStdoutChecker(catTool, expectedOutput, done);
 
@@ -91,7 +98,7 @@ describe('Testing cat tool', () => {
       .split(/\r\n|\n/)
       .join('\r\n');
 
-    catTool = spawn('node', ['./build/src/15/cat.js', '-b']);
+    catTool = spawn('node', [pathToCatJs, '-b']);
 
     catToolStdoutChecker(catTool, expectedOutput, done);
 

src/10/README.md

@@ -1,6 +1,6 @@
 import { createLogger, format, transports } from 'winston';
-import IRCClient from '../../src/16/irc-client';
-import { IRCClientInterface } from '../../src/16/types';
+import IRCClient from '../irc-client';
+import { IRCClientInterface } from '../types';
 import path from 'path';
 
 const host = 'irc.freenode.net';

tests/10/countries.txt src/10/__tests__/countries.txt

@@ -1,7 +1,7 @@
 import path from 'path';
 import { createLogger, format, transports } from 'winston';
-import { IRCClientInterface } from '../../src/16/types';
-import IRCClient from '../../src/16/irc-client';
+import { IRCClientInterface } from '../types';
+import IRCClient from '../irc-client';
 
 const host = 'irc.freenode.net';
 const port = 6667;

tests/10/test.txt src/10/__tests__/test.txt

@@ -1,7 +1,7 @@
 import { createLogger, format, transports } from 'winston';
-import IRCClient from '../../src/16/irc-client';
+import IRCClient from '../irc-client';
 import path from 'path';
-import { IRCClientInterface } from '../../src/16/types';
+import { IRCClientInterface } from '../types';
 
 const host = 'irc.freenode.net';
 const port = 6667;

tests/10/uniq.test.ts src/10/__tests__/uniq.test.ts

@@ -1,4 +1,4 @@
-import { IRCParser } from '../../src/16/parser';
+import { IRCParser } from '../parser';
 
 describe('Testing IRC Parser', () => {
   const validInputs = [

src/11/README.md

@@ -1,7 +1,7 @@
 import MemCached from 'memcached';
 
-import MemCachedServer from '../../src/17/memcached';
-import sleep from '../../src/utils/sleep';
+import MemCachedServer from '../memcached';
+import sleep from '../../utils/sleep';
 import { randomBytes } from 'crypto';
 
 describe('Testing set and get commands', () => {

tests/11/webserver.test.ts src/11/__tests__/webserver.test.ts

@@ -1,5 +1,5 @@
 import MemCached from 'memcached';
-import MemCachedServer from '../../src/17/memcached';
+import MemCachedServer from '../memcached';
 
 describe('Handling concurrent clients', () => {
   const key1 = 'test1',

src/13/README.md

@@ -1,8 +1,9 @@
 import fs from 'fs';
-import { JsonParser } from '../../src/2/json-parser';
+import { JsonParser } from '../json-parser';
+import path from 'path';
 
 describe('Tests provided by JSON ORG', () => {
-  const dir = './tests/2/json_checker/';
+  const dir = path.join(__dirname, 'json_checker/');
   const files = fs.readdirSync(dir);
 
   afterEach(() => {

tests/13/diff.test.ts src/13/__tests__/diff.test.ts

@@ -1,8 +1,9 @@
 import fs from 'fs';
-import { JsonParser } from '../../src/2/json-parser';
+import { JsonParser } from '../json-parser';
+import path from 'path';
 
 describe('Step 1 tests', () => {
-  const dir = './tests/2/step1/';
+  const dir = path.join(__dirname, 'step1/');
   const files = fs.readdirSync(dir);
 
   afterEach(() => {

tests/13/new.txt src/13/__tests__/new.txt

@@ -1,8 +1,9 @@
 import fs from 'fs';
-import { JsonParser } from '../../src/2/json-parser';
+import { JsonParser } from '../json-parser';
+import path from 'path';
 
 describe('Step 2 tests', () => {
-  const dir = './tests/2/step2/';
+  const dir = path.join(__dirname, 'step2/');
   const files = fs.readdirSync(dir);
 
   afterEach(() => {