Merge pull request #1 from Fatemeh-sadat-Torabi/test-tweaks

Test tweaks

Author: Fatemeh-sadat-Torabi

README.md

@@ -1,9 +1,51 @@
-Like learning a musical instrument, programming requires daily practise.
+# Coursework
 
-The exercises are split into three folders: `exercises`, `mandatory` and `extra`. All homework in the `exercise` and `mandatory` section **must** be completed for homework by the following lesson. 
+Like learning a musical instrument, programming requires daily practice.
+
+The exercises are split into two folders: `mandatory` and `extra`. All homework in the `mandatory` section **must** be completed for homework by the following lesson.
 
 The `extra` folder contains exercises that you can complete to challenge yourself, but are not required for the following lesson.
 
+If you think you need to do more practice with the basics, then you can find some more exercises listed in `resources.md`. These exercises are not mandatory and won't be assigned as part of your coursework for the week.
+
+## Setting up your code editor
+
+
+There are some tools that will help you to write code. One of these, [Prettier](https://prettier.io/), formats your code, making it easier for you and others to read.
+
+### 1. Install prettier
+
+- In Visual Studio open the extensions panel (see https://code.visualstudio.com/docs/editor/extension-gallery#_browse-and-install-extensions)
+- Search for `Prettier - Code formatter`
+- Click install on the top result
+
+### 2. Enable formatting on save
+
+- In Visual Studio open the settings file (see https://code.visualstudio.com/docs/getstarted/settings#_creating-user-and-workspace-settings)
+- Search for `editor format`
+- Set `editor.formatOnSave` and `editor.formatOnPaste` to true
+
+
+## Running the code/tests
+
+The files for the mandatory/extra exercises are intended to be run as jest tests. 
+
+- Once you have cloned the repository, run `npm install` once in the terminal to install jest (and any necessary dependencies).
+- To run the tests for all mandatory/extra exercises, run `npm test`
+- To run only the tests for the mandatory exercises, run `npm test -- --selectProjects mandatory`
+- To run only the tests for the extra exercises, run `npm test -- --selectProjects extra`
+- To run a single exercise/test (for example `mandatory/1-writer.js`), run `npm test -- --testPathPattern mandatory/1-writer.js` (Remember, you can use tab-completion to get files relative to the current directory, so m`Tab ↹`/1-`Tab ↹` will autocomplete get you the test file starting with 1-)
+
+For more information about tests, look here:
+
+https://syllabus.codeyourfuture.io/guides/intro-to-tests
+
+Try out variant way of running tests:
+
+- `npm test` -> run all mandatory and extra tests
+- `npm test -- --selectProjects mandatory` -> run only mandatory tests
+- `npm test -- --testPathPattern mandatory/1-syntax-errors.js` -> run single test
+
 ## Solutions
 
 The solutions for this coursework can be found here:
@@ -12,15 +54,9 @@ https://github.com/CodeYourFuture/JavaScript-Core-1-Coursework-Week2-Solution
 
 This is a **private** repository. Please request access from your Teachers, Buddy or City Coordinator after the start of your next lesson.
 
-## Testing your work
-
-- Each of the *.js files in the `exercises` folder can be run from the terminal using the `node` command with the path to the file. For example, `node exercises/B-boolean-literals/exercise.js` can be run from the root of the project.
-- To run the tests in the `mandatory` folder, run `npm run test` from the root of the project (after having run `npm install` once before).
-- To run the tests in the `extra` folder, run `npm run extra-tests` from the root of the project (after having run `npm install` once before).
-
 ## Instructions for submission
 
-For your homework, we'll be using [**test driven development**](https://medium.com/@adityaalifnugraha/test-driven-development-tdd-in-a-nutshell-b9e05dfe8adb) to check your answers. Test driven development (or TDD) is the practice of writing tests for your code first, and then write your code to pass those tests. This is a very useful way of writing good quality code and is used in a lot of industries. You don't have to worry about knowing how this works, but if you're curious, engage with a volunteer to find out more! :)
+For your homework, we'll be using tests to check your answers. The tests will assert that your functions behave in the correct way. A **failing test** ❌ indicates that a function _is not_ behaving correctly; a **passing test** ✅ indicates that your function is behaving correctly.
 
 1. Complete the challenges in each file and save it once you're happy with your changes
 2. Run the script to check the results against the tests - all tests should read PASSED if you completed the challenges correctly. If a test reads FAILED, find the associated test to identify which function failed and fix it.

extra/1-factorial.js

@@ -9,19 +9,21 @@
 */
 
 function factorial(input) {
-    // TODO
+  // TODO
 }
 
 /* ======= TESTS - DO NOT MODIFY ===== */
 
-test("3! should be 6", () => {
+describe("factorial", () => {
+  test("3! should be 6", () => {
     expect(factorial(3)).toEqual(6);
-});
+  });
 
-test("5! should be 120", () => {
+  test("5! should be 120", () => {
     expect(factorial(5)).toEqual(120);
-});
+  });
 
-test("10! should be 3628800", () => {
+  test("10! should be 3628800", () => {
     expect(factorial(10)).toEqual(3628800);
+  });
 });

mandatory/1-fix-functions.js

@@ -10,7 +10,7 @@
 
 */
 
-function mood() {
+function getMood() {
   let isHappy = true;
 
   if (isHappy) {
@@ -32,26 +32,30 @@ function greaterThan10(num) {
 
 /* ======= TESTS - DO NOT MODIFY ===== */
 
-test("mood function works for true", () => {
-  expect(mood(true)).toEqual("I am happy");
-});
+describe("getMood", () => {
+  test("getMood function works for true", () => {
+    expect(getMood(true)).toEqual("I am happy");
+  });
 
-test("mood function works for false", () => {
-  expect(mood(false)).toEqual("I am not happy");
+  test("getMood function works for false", () => {
+    expect(getMood(false)).toEqual("I am not happy");
+  });
 });
 
-test("greaterThanTen function works for value greater than 10", () => {
-  expect(greaterThan10(11)).toEqual("num is greater than 10");
-});
+describe("greaterThanTen", () => {
+  test("works for value greater than 10", () => {
+    expect(greaterThan10(11)).toEqual("num is greater than 10");
+  });
 
-test("greaterThanTen function works for value much greater than 10", () => {
-  expect(greaterThan10(96)).toEqual("num is greater than 10");
-});
+  test("works for value much greater than 10", () => {
+    expect(greaterThan10(96)).toEqual("num is greater than 10");
+  });
 
-test("greaterThanTen function works for value less than 10", () => {
-  expect(greaterThan10(9)).toEqual("num is not big enough");
-});
+  test("works for value less than 10", () => {
+    expect(greaterThan10(9)).toEqual("num is not big enough");
+  });
 
-test("greaterThanTen function works for value equal to 10", () => {
-  expect(greaterThan10(10)).toEqual("num is not big enough");
+  test("works for value equal to 10", () => {
+    expect(greaterThan10(10)).toEqual("num is not big enough");
+  });
 });

mandatory/2-function-creation.js

@@ -49,93 +49,108 @@ function countReverse(number) {}
 
 /* ======= TESTS - DO NOT MODIFY ===== */
 
-test("isAcceptableUser function returns true if over 18 and logged in", () => {
-  expect(isAcceptableUser(21, true)).toEqual(true);
-});
+describe("isAcceptableUser", () => {
+  test("returns true if over 18 and logged in", () => {
+    expect(isAcceptableUser(21, true)).toEqual(true);
+  });
 
-test("isAcceptableUser function returns true if 18 and logged in", () => {
-  expect(isAcceptableUser(18, true)).toEqual(true);
-});
+  test("returns true if 18 and logged in", () => {
+    expect(isAcceptableUser(18, true)).toEqual(true);
+  });
 
-test("isAcceptableUser function returns false if under 18 and logged in", () => {
-  expect(isAcceptableUser(17, true)).toEqual(false);
-});
+  test("returns false if under 18 and logged in", () => {
+    expect(isAcceptableUser(17, true)).toEqual(false);
+  });
 
-test("isAcceptableUser function returns false if over 18 and not logged in", () => {
-  expect(isAcceptableUser(21, false)).toEqual(false);
+  test("returns false if over 18 and not logged in", () => {
+    expect(isAcceptableUser(21, false)).toEqual(false);
+  });
 });
 
-test("applyDiscount function returns price with 5% discount", () => {
-  expect(applyDiscount(120)).toEqual(114);
-});
+describe("applyDiscount", () => {
+  test("returns price with 5% discount", () => {
+    expect(applyDiscount(120)).toEqual(114);
+  });
 
-test("applyDiscount function returns price with 10% discount", () => {
-  expect(applyDiscount(280)).toEqual(252);
+  test("returns price with 10% discount", () => {
+    expect(applyDiscount(280)).toEqual(252);
+  });
 });
 
-test("printOddNumbers function prints odd numbers between 1 and 2", () => {
-  expectprintOddNumbersToLog([1], 2);
-});
+describe("printOddNumbers", () => {
+  test("printOddNumbers function prints odd numbers between 1 and 2", () => {
+    const consoleLogSpy = jest.spyOn(console, "log");
+    printOddNumbers(2);
+
+    expect(consoleLogSpy).toBeCalledWith(1);
+    consoleLogSpy.mockRestore();
+  });
+
+  test("printOddNumbers function prints odd numbers between 1 and 10", () => {
+    const consoleLogSpy = jest.spyOn(console, "log");
 
-test("printOddNumbers function prints odd numbers between 1 and 10", () => {
-  expectprintOddNumbersToLog([1, 3, 5, 7, 9], 10);
+    printOddNumbers(10);
+    expect(consoleLogSpy).toBeCalledWith(1);
+    expect(consoleLogSpy).toBeCalledWith(3);
+    expect(consoleLogSpy).toBeCalledWith(5);
+    expect(consoleLogSpy).toBeCalledWith(7);
+    expect(consoleLogSpy).toBeCalledWith(9);
+
+    consoleLogSpy.mockRestore();
+  });
 });
 
-function expectprintOddNumbersToLog(expectedValues, limit) {
-  const consoleLogSpy = jest.spyOn(console, "log");
-  printOddNumbers(limit);
-  expect(consoleLogSpy).toBeCalledTimes(expectedValues.length);
-  expectedValues.forEach((value, i) => {
-    expect(consoleLogSpy).nthCalledWith(i + 1, value);
+describe("buyTwoGetTheCheapestFree", () => {
+  test("buyTwoGetTheCheapestFree function returns first price when it is largest", () => {
+    expect(buyTwoGetTheCheapestFree(700, 500)).toEqual(700);
   });
-  consoleLogSpy.mockRestore();
-}
 
-test("buyTwoGetTheCheapestFree function returns first price when it is largest", () => {
-  expect(buyTwoGetTheCheapestFree(700, 500)).toEqual(700);
+  test("buyTwoGetTheCheapestFree function returns second price when it is largest", () => {
+    expect(buyTwoGetTheCheapestFree(500, 700)).toEqual(700);
+  });
 });
 
-test("buyTwoGetTheCheapestFree function returns second price when it is largest", () => {
-  expect(buyTwoGetTheCheapestFree(500, 700)).toEqual(700);
-});
+describe("canRegister", () => {
+  test("returns in case of a person of age 7", () => {
+    expect(canRegister(7)).toEqual("You Are Too Young To Register");
+  });
 
-test("(canRegister function returns in case of a person of age 7", () => {
-  expect(canRegister(7)).toEqual("You Are Too Young To Register");
-});
+  test("returns in case of a person of age 12", () => {
+    expect(canRegister(12)).toEqual("You Are Too Young To Register");
+  });
 
-test("canRegister function returns in case of a person of age 12", () => {
-  expect(canRegister(12)).toEqual("You Are Too Young To Register");
-});
+  test("returns in case of a person of age 13", () => {
+    expect(canRegister(13)).toEqual("You Can Register");
+  });
 
-test("canRegister function returns in case of a person of age 13", () => {
-  expect(canRegister(13)).toEqual("You Can Register");
-});
+  test("returns in case of a person of age 89", () => {
+    expect(canRegister(89)).toEqual("You Can Register");
+  });
 
-test("canRegister function returns in case of a person of age 89", () => {
-  expect(canRegister(89)).toEqual("You Can Register");
-});
+  test("returns in case of a person of age 90", () => {
+    expect(canRegister(90)).toEqual("You Don't Need To Register");
+  });
 
-test("canRegister function returns in case of a person of age 90", () => {
-  expect(canRegister(90)).toEqual("You Don't Need To Register");
+  test("returns in case of a person of age 112", () => {
+    expect(canRegister(112)).toEqual("You Don't Need To Register");
+  });
 });
 
-test("canRegister function returns in case of a person of age 112", () => {
-  expect(canRegister(112)).toEqual("You Don't Need To Register");
-});
+describe("countReverse", () => {
+  test("countReverse function logs values from 7 to 1", () => {
+    const consoleLogSpy = jest.spyOn(console, "log");
 
-test("countReverse function logs values from 7 to 1", () => {
-  expectcountReverseToLog([7, 6, 5, 4, 3, 2, 1], 7);
-});
+    expect(consoleLogSpy).toBeCalledWith(7);
+    expect(consoleLogSpy).toBeCalledWith(6);
+    expect(consoleLogSpy).toBeCalledWith(5);
+    expect(consoleLogSpy).toBeCalledWith(4);
+    expect(consoleLogSpy).toBeCalledWith(3);
+    expect(consoleLogSpy).toBeCalledWith(2);
+    expect(consoleLogSpy).toBeCalledWith(1);
 
-function expectcountReverseToLog(expectedValues, start) {
-  const consoleLogSpy = jest.spyOn(console, "log");
-  countReverse(start);
-  expect(consoleLogSpy).toBeCalledTimes(expectedValues.length);
-  expectedValues.forEach((value, i) => {
-    expect(consoleLogSpy).nthCalledWith(i + 1, value);
+    consoleLogSpy.mockRestore();
   });
-  consoleLogSpy.mockRestore();
-}
+});
 
 /*
 CHECK OUT solutions.md FOR MORE INFO ON OUR SOLUTION

package.json

@@ -4,8 +4,23 @@
   "description": "Exercises for JS1 Week 2",
   "license": "CC-BY-SA-4.0",
   "scripts": {
-    "test": "jest --testRegex='mandatory[/\\\\].*\\.js$' --testPathIgnorePatterns=playing-computer",
-    "extra-tests": "jest --testRegex='extra[/\\\\].*\\.js$'"
+    "test": "jest"
+  },
+    "jest": {
+    "projects": [
+      {
+        "displayName": "mandatory",
+        "testMatch": [
+          "<rootDir>/mandatory/*.js"
+        ]
+      },
+      {
+        "displayName": "extra",
+        "testMatch": [
+          "<rootDir>/extra/*.js"
+        ]
+      }
+    ]
   },
   "repository": {
     "type": "git",