update MockingPatching

Author: rambasnet

notebooks/CodingBestPractices.ipynb

@@ -944,37 +944,6 @@
     "test_add_mixed()"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Pytest\n",
-    "\n",
-    "- Pytest helps your write better programs: [https://docs.pytest.org/en/8.0.x/](https://docs.pytest.org/en/8.0.x/)\n",
-    "- Must explictly install pytest; not a part of standard library\n",
-    "- `pip install -U pytest`\n",
-    "- pytest can be executed for a single file, or all the files and subfolders within a folder\n",
-    "- pytest can discover all the test modules that are named `test_*.py`\n",
-    "- pytest will execute every `test_*()` function in the `test` module"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Code coverage by unit tests\n",
-    "\n",
-    "- though not sufficient, code coverage provides measureable metrics to determine how good the test cases are\n",
-    "- we can use `pytest-cov` plugin for pytest to demonstrate the code coverage from our tests\n",
-    "- it must be installed `pip install pytest-cov`\n",
-    "- more on it here: [https://pytest-cov.readthedocs.io/en/latest/readme.html](https://pytest-cov.readthedocs.io/en/latest/readme.html)\n",
-    "- see [https://github.com/rambasnet/course-container](https://github.com/rambasnet/course-container)\n",
-    "    - uses [https://app.codecov.io/](https://app.codecov.io/) that provides code coverage report and badge if ci-cd is configured\n",
-    "    - you can login with github on the service and just configure each repo to use the app\n",
-    "    - see the ci-test.yml file: [https://github.com/rambasnet/course-container/blob/main/.github/workflows/ci-test.yml](https://github.com/rambasnet/course-container/blob/main/.github/workflows/ci-test.yml)\n",
-    "- see and run the Makefile in the root folder of this repo from a terminal"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1033,6 +1002,69 @@
     "- Makefile is installed in Docker image"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Pytest\n",
+    "\n",
+    "- Pytest helps your write better programs: [https://docs.pytest.org/en/8.0.x/](https://docs.pytest.org/en/8.0.x/)\n",
+    "- Must explictly install pytest; not a part of standard library\n",
+    "- `pip install -U pytest`\n",
+    "- pytest can be executed for a single file, or all the files and subfolders within a folder\n",
+    "- pytest can discover all the test modules that are named `test_*.py`\n",
+    "- pytest will execute every `test_*()` function in the `test` module"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Code coverage by unit tests\n",
+    "\n",
+    "- though not sufficient, code coverage provides measureable metrics to determine how good the test cases are\n",
+    "- more on it here: [https://pytest-cov.readthedocs.io/en/latest/readme.html](https://pytest-cov.readthedocs.io/en/latest/readme.html)\n",
+    "- **code coverage** is a count of the number of lines of code that are executed by a program and by test code\n",
+    "- we can download and use **pytest-cov** plugin to do just that\n",
+    "- install coverage first; Docker image already has it installed\n",
+    "\n",
+    "```bash\n",
+    "pip install pytest-cov\n",
+    "```\n",
+    "\n",
+    "- use `#pragma: no cover` directive to tell pytest-cov not to count the function/code if you don't know how to test certain code (yet!)\n",
+    "- html report is created in `htmlcov` folder\n",
+    "- note coverage creates `.gitignore` file inside `htmlcov` that ignores all the files in the folder to be tracked\n",
+    "- delete the `.gitignore` file to track and html reports into your repository\n",
+    "\n",
+    "### Write more tests for 100% code coverage\n",
+    "\n",
+    "- first run coverage on test_averages.py file as it is\n",
+    "- then add more tests to to cover 100% code\n",
+    "- run pytest-cov to verify...\n",
+    "- see Makefile in demo-assignments\n",
+    "- run the Makefile in the root folder of this repo from a terminal\n",
+    "\n",
+    "```bash\n",
+    "(py) ╭─rbasnet@M-rbasnetMBP ~/projects/Object-Oriented-Programming-Design-Patterns/demo-assignments \n",
+    "╰─$ make run-test-coverage\n",
+    "\n",
+    "...\n",
+    "\n",
+    "---------- coverage: platform darwin, python 3.10.9-final-0 ----------\n",
+    "Name                                                   Stmts   Miss  Cover   Missing\n",
+    "------------------------------------------------------------------------------------\n",
+    "demo-assignments/A2-ABC/egypt/egypt.py                    45      0   100%\n",
+    "demo-assignments/A2-ABC/egypt/kattis.py                   20      0   100%\n",
+    "demo-assignments/A2-ABC/egypt/tests/__init__.py            0      0   100%\n",
+    "demo-assignments/A2-ABC/egypt/tests/test_egypt.py         68      0   100%\n",
+    "demo-assignments/A2-ABC/egypt/tests/test_triangle.py      28      0   100%\n",
+    "demo-assignments/A2-ABC/egypt/triangle.py                 34      0   100%\n",
+    "------------------------------------------------------------------------------------\n",
+    "TOTAL                                                    195      0   100%\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1041,7 +1073,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -1055,7 +1087,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,