From c1b60b381867293c551f9a00db44625b42be9113 Mon Sep 17 00:00:00 2001 From: Allan Liebold Date: Mon, 17 Jul 2017 14:25:49 -0700 Subject: [PATCH 1/2] creates tests for greet and arithmetic modules --- lab-allan/.eslintignore | 5 ++ lab-allan/.eslintrc | 33 ++++++++ lab-allan/.gitignore | 136 ++++++++++++++++++++++++++++++ lab-allan/README.md | 59 +++++++++++++ lab-allan/lib/arithmetic.js | 13 +++ lab-allan/lib/greet.js | 11 +++ lab-allan/test/arithmetic-test.js | 19 +++++ lab-allan/test/greet-test.js | 17 ++++ 8 files changed, 293 insertions(+) create mode 100644 lab-allan/.eslintignore create mode 100644 lab-allan/.eslintrc create mode 100644 lab-allan/.gitignore create mode 100644 lab-allan/README.md create mode 100644 lab-allan/lib/arithmetic.js create mode 100644 lab-allan/lib/greet.js create mode 100644 lab-allan/test/arithmetic-test.js create mode 100644 lab-allan/test/greet-test.js diff --git a/lab-allan/.eslintignore b/lab-allan/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/lab-allan/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/lab-allan/.eslintrc b/lab-allan/.eslintrc new file mode 100644 index 0000000..881053e --- /dev/null +++ b/lab-allan/.eslintrc @@ -0,0 +1,33 @@ +{ +"rules": { +"no-console": "off", +"indent": [ +"error", +2 +], +"quotes": [ +"error", +"single" +], +"semi": [ +"error", +"always" +], +"linebreak-style": [ +"error", +"unix" +] +}, +"env": { +"es6": true, +"node": true, +"mocha": true, +"jasmine": true +}, +"ecmaFeatures": { +"modules": true, +"experimentalObjectRestSpread": true, +"impliedStrict": true +}, +"extends": "eslint:recommended" +} diff --git a/lab-allan/.gitignore b/lab-allan/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/lab-allan/.gitignore @@ -0,0 +1,136 @@ +# Created by https://www.gitignore.io/api/osx,vim,node,macos,windows + +### macOS ### +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + + +### OSX ### + +# Icon must end with two \r + +# Thumbnails + +# Files that might appear in the root of a volume + +# Directories potentially created on remote AFP share + +### Vim ### +# swap +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-v][a-z] +[._]sw[a-p] +# session +Session.vim +# temporary +.netrwhist +*~ +# auto-generated tag files +tags + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.gitignore.io/api/osx,vim,node,macos,windows diff --git a/lab-allan/README.md b/lab-allan/README.md new file mode 100644 index 0000000..a3aca54 --- /dev/null +++ b/lab-allan/README.md @@ -0,0 +1,59 @@ +![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 01: Node Ecosystem +=== + +## Submission Instructions + * work in a fork of this repository + * work in a branch on your fork + * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` + * submit a pull request to this repository + * submit a link to your pull request on canvas + * submit a question, observation, and how long you spent on canvas + +## Resources +* [node assert docs](https://nodejs.org/dist/latest-v4.x/docs/api/assert.html) +* [mocha docs](http://mochajs.org/#getting-started) + +## Requirements + +#### Configuration + +* include the following: + * **README.md** - contains documentation about your lab + * **.gitignore** - contains a robust `.gitignore` file + * **.eslintrc** - contains the provided `.eslintrc` file + * **.eslintignore** - contains the provided `.eslintignore` file + * **.package.json** - contains all necessary dependencies and developer dependencies + * **lib/** - should contain your modules + * **test/** - should contain your unit tests + +#### Feature Tasks +* create a node.js module (`greet.js`) that exports a single function + * the `greet` function should have a single parameter that should expect a string as it's input + * the `greet` function should return the input name, concatenated with "hello " + * the `greet` function should return `null` if the input is not a string +* create a node.js module named `arithmetic.js` + * this module should have `add` and `sub` methods + * the `add` method should contain 2 parameters + * these parameters should be numbers and the method should return the sum of the 2 numbers + * the `sub` method should contain 2 parameters + * these parameters should be numbers and the method should return the first number minus the second number +* decide on the expected behavior for non-number inputs + +#### Testing +* write a test the expects the greet module to return "hello world!" + * this should happen when invoked with "world!" as a parameter +* write a test for the `add` and `subtract` methods on the arithmetic module + * this should ensure that your functions work with number inputs + +#### Documentation +* write a description of your project (this should be in your `README.md` file) + +###### BONUS 1pt +* write a test that expects the greet module to return null when you use non string values +* write a test that ensures the functions work as expected with non number inputs + +## Rubric +* 2pts configuration +* 3pts feature tasks +* 3pts tests +* 2pts documentation diff --git a/lab-allan/lib/arithmetic.js b/lab-allan/lib/arithmetic.js new file mode 100644 index 0000000..783215e --- /dev/null +++ b/lab-allan/lib/arithmetic.js @@ -0,0 +1,13 @@ +'use strict'; + +module.exports = exports = {}; + +exports.add = function(first, second) { + if (isNaN(first) || isNaN(second)) throw new Error('not a number'); + return first + second; +}; + +exports.sub = function(first, second) { + if (isNaN(first) || isNaN(second)) throw new Error('not a number'); + return first - second; +}; diff --git a/lab-allan/lib/greet.js b/lab-allan/lib/greet.js new file mode 100644 index 0000000..f7ce0e2 --- /dev/null +++ b/lab-allan/lib/greet.js @@ -0,0 +1,11 @@ +'use strict'; + +module.exports = exports = {}; + +exports.sayHello = function(name) { + if (name.length === 0) throw new Error('no name'); + if (typeof name !== 'string') + return null; + + return `hello ${name}!`; +}; diff --git a/lab-allan/test/arithmetic-test.js b/lab-allan/test/arithmetic-test.js new file mode 100644 index 0000000..4d33892 --- /dev/null +++ b/lab-allan/test/arithmetic-test.js @@ -0,0 +1,19 @@ +'use strict'; + +const arithmetic = require('../lib/arithmetic.js'); +const assert = require('assert'); + +describe('Arithmetic Module Test', function() { + describe('#add', function() { + it('should return 5', function() { + let result = arithmetic.add(3, 2); + assert.ok(result === 5, 'not equal to 5'); + }); + }); + describe('#sub', function() { + it('should return 1', function() { + let result = arithmetic.sub(3, 2); + assert.ok(result === 1, 'not equal to 1'); + }); + }); +}); diff --git a/lab-allan/test/greet-test.js b/lab-allan/test/greet-test.js new file mode 100644 index 0000000..b8c0420 --- /dev/null +++ b/lab-allan/test/greet-test.js @@ -0,0 +1,17 @@ +'use strict'; + +const greet = require('../lib/greet.js'); +const assert = require('assert'); + +describe('Greet Module Test', function() { + describe('#sayHello', function() { + it('should return hello world!', function() { + let result = greet.sayHello('world'); + assert.ok(result === 'hello world!', 'not equal to hello world!'); + }); + it('should return null', function() { + let result = greet.sayHello(5); + assert.ok(result === null, 'null not returned'); + }); + }); +}); From 1088ca1c4f0df198758fec05aaa67ab5b25bce11 Mon Sep 17 00:00:00 2001 From: Allan Liebold Date: Mon, 17 Jul 2017 14:41:17 -0700 Subject: [PATCH 2/2] tests for non-string arguments in greet.js as non-number arguments in arithmetic.js --- lab-allan/README.md | 68 ++++++------------------------- lab-allan/lib/arithmetic.js | 6 ++- lab-allan/test/arithmetic-test.js | 8 ++++ 3 files changed, 24 insertions(+), 58 deletions(-) diff --git a/lab-allan/README.md b/lab-allan/README.md index a3aca54..ec827da 100644 --- a/lab-allan/README.md +++ b/lab-allan/README.md @@ -1,59 +1,15 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 01: Node Ecosystem -=== +## arithmetic.js +- add function returns the sum of two numbers +- sub function returns the difference of two numbers -## Submission Instructions - * work in a fork of this repository - * work in a branch on your fork - * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` - * submit a pull request to this repository - * submit a link to your pull request on canvas - * submit a question, observation, and how long you spent on canvas +## greet.js +- sayHello function returns 'hello' concatenated with a name argument +- if the name argument is not a string, null is returned -## Resources -* [node assert docs](https://nodejs.org/dist/latest-v4.x/docs/api/assert.html) -* [mocha docs](http://mochajs.org/#getting-started) +## arithmetic-test.js +- tests that add and sub return the correct values when numbers are passed as arguments +- tests that null is returned if any argument is not a number -## Requirements - -#### Configuration - -* include the following: - * **README.md** - contains documentation about your lab - * **.gitignore** - contains a robust `.gitignore` file - * **.eslintrc** - contains the provided `.eslintrc` file - * **.eslintignore** - contains the provided `.eslintignore` file - * **.package.json** - contains all necessary dependencies and developer dependencies - * **lib/** - should contain your modules - * **test/** - should contain your unit tests - -#### Feature Tasks -* create a node.js module (`greet.js`) that exports a single function - * the `greet` function should have a single parameter that should expect a string as it's input - * the `greet` function should return the input name, concatenated with "hello " - * the `greet` function should return `null` if the input is not a string -* create a node.js module named `arithmetic.js` - * this module should have `add` and `sub` methods - * the `add` method should contain 2 parameters - * these parameters should be numbers and the method should return the sum of the 2 numbers - * the `sub` method should contain 2 parameters - * these parameters should be numbers and the method should return the first number minus the second number -* decide on the expected behavior for non-number inputs - -#### Testing -* write a test the expects the greet module to return "hello world!" - * this should happen when invoked with "world!" as a parameter -* write a test for the `add` and `subtract` methods on the arithmetic module - * this should ensure that your functions work with number inputs - -#### Documentation -* write a description of your project (this should be in your `README.md` file) - -###### BONUS 1pt -* write a test that expects the greet module to return null when you use non string values -* write a test that ensures the functions work as expected with non number inputs - -## Rubric -* 2pts configuration -* 3pts feature tasks -* 3pts tests -* 2pts documentation +## greet-test.js +- tests that the correct string is returned with the name argument +- tests that null is returned if the argument is not a string diff --git a/lab-allan/lib/arithmetic.js b/lab-allan/lib/arithmetic.js index 783215e..65a283b 100644 --- a/lab-allan/lib/arithmetic.js +++ b/lab-allan/lib/arithmetic.js @@ -3,11 +3,13 @@ module.exports = exports = {}; exports.add = function(first, second) { - if (isNaN(first) || isNaN(second)) throw new Error('not a number'); + if (isNaN(first) || isNaN(second)) + return null; return first + second; }; exports.sub = function(first, second) { - if (isNaN(first) || isNaN(second)) throw new Error('not a number'); + if (isNaN(first) || isNaN(second)) + return null; return first - second; }; diff --git a/lab-allan/test/arithmetic-test.js b/lab-allan/test/arithmetic-test.js index 4d33892..ad9fd8a 100644 --- a/lab-allan/test/arithmetic-test.js +++ b/lab-allan/test/arithmetic-test.js @@ -9,11 +9,19 @@ describe('Arithmetic Module Test', function() { let result = arithmetic.add(3, 2); assert.ok(result === 5, 'not equal to 5'); }); + it('should return null', function() { + let result = arithmetic.add('word', 5); + assert.ok(result === null, 'null not returned'); + }); }); describe('#sub', function() { it('should return 1', function() { let result = arithmetic.sub(3, 2); assert.ok(result === 1, 'not equal to 1'); }); + it('should return null', function() { + let result = arithmetic.sub('word', 50); + assert.ok(result === null, 'null not returned'); + }); }); });