Skip to content

Commit ef08d5e

Browse files
rambasnetrambasnet
committed
update Testing Programs
1 parent 31f33f8 commit ef08d5e

5 files changed

+244
-323
lines changed

‎notebooks/CodingBestPractices.ipynb

+127
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,7 @@
838838
"metadata": {},
839839
"source": [
840840
"### Relative imports\n",
841+
"\n",
841842
"- import module, class, and function, relative to the current module\n",
842843
"- use `.` for the current package\n",
843844
"- use `..` for parent package\n",
@@ -848,6 +849,132 @@
848849
"```"
849850
]
850851
},
852+
{
853+
"cell_type": "markdown",
854+
"metadata": {},
855+
"source": [
856+
"## Unit testing with assert\n",
857+
"\n",
858+
"- testing is an essential part of software development\n",
859+
"- testing helps ensure that the code (functions) work as expected\n",
860+
"- testing helps catch bugs and errors early in the development cycle\n",
861+
"- testing helps improve code quality and maintainability\n",
862+
"- testing helps document the code and its behavior\n",
863+
"- testing helps ensure that new changes don't break existing functionality\n",
864+
"- testing helps ensure that the code is robust and reliable\n",
865+
"- testing helps ensure that the code is secure and performant\n",
866+
"- if there was no library and tools provided for unit testing, you could write your own\n",
867+
"- use the `assert` statement to assert how the two values are compared\n",
868+
" - mostly equal!"
869+
]
870+
},
871+
{
872+
"cell_type": "code",
873+
"execution_count": 2,
874+
"metadata": {},
875+
"outputs": [],
876+
"source": [
877+
"assert 'hello' == 'hello'"
878+
]
879+
},
880+
{
881+
"cell_type": "code",
882+
"execution_count": 3,
883+
"metadata": {},
884+
"outputs": [],
885+
"source": [
886+
"assert 1.5 == 1.5000"
887+
]
888+
},
889+
{
890+
"cell_type": "code",
891+
"execution_count": 4,
892+
"metadata": {},
893+
"outputs": [
894+
{
895+
"ename": "AssertionError",
896+
"evalue": "",
897+
"output_type": "error",
898+
"traceback": [
899+
"\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
900+
"\u001b[0;31mAssertionError\u001b[0m Traceback (most recent call last)",
901+
"Cell \u001b[0;32mIn[4], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01massert\u001b[39;00m \u001b[38;5;241m2.5\u001b[39m \u001b[38;5;241m==\u001b[39m \u001b[38;5;241m3\u001b[39m\n",
902+
"\u001b[0;31mAssertionError\u001b[0m: "
903+
]
904+
}
905+
],
906+
"source": [
907+
"assert 2.5 == 3"
908+
]
909+
},
910+
{
911+
"cell_type": "code",
912+
"execution_count": 5,
913+
"metadata": {},
914+
"outputs": [],
915+
"source": [
916+
"def add(a: int, b: int) -> int:\n",
917+
" return a + b"
918+
]
919+
},
920+
{
921+
"cell_type": "code",
922+
"execution_count": 7,
923+
"metadata": {},
924+
"outputs": [],
925+
"source": [
926+
"def test_add_positives():\n",
927+
" assert add(1, 2) == 3\n",
928+
"\n",
929+
"def test_add_negatives():\n",
930+
" assert add(-1, -2) == -3\n",
931+
"\n",
932+
"def test_add_mixed():\n",
933+
" assert add(-1, 1) == 0"
934+
]
935+
},
936+
{
937+
"cell_type": "code",
938+
"execution_count": 8,
939+
"metadata": {},
940+
"outputs": [],
941+
"source": [
942+
"test_add_positives()\n",
943+
"test_add_negatives()\n",
944+
"test_add_mixed()"
945+
]
946+
},
947+
{
948+
"cell_type": "markdown",
949+
"metadata": {},
950+
"source": [
951+
"## Pytest\n",
952+
"\n",
953+
"- Pytest helps your write better programs: [https://docs.pytest.org/en/8.0.x/](https://docs.pytest.org/en/8.0.x/)\n",
954+
"- Must explictly install pytest; not a part of standard library\n",
955+
"- `pip install -U pytest`\n",
956+
"- pytest can be executed for a single file, or all the files and subfolders within a folder\n",
957+
"- pytest can discover all the test modules that are named `test_*.py`\n",
958+
"- pytest will execute every `test_*()` function in the `test` module"
959+
]
960+
},
961+
{
962+
"cell_type": "markdown",
963+
"metadata": {},
964+
"source": [
965+
"## Code coverage by unit tests\n",
966+
"\n",
967+
"- though not sufficient, code coverage provides measureable metrics to determine how good the test cases are\n",
968+
"- we can use `pytest-cov` plugin for pytest to demonstrate the code coverage from our tests\n",
969+
"- it must be installed `pip install pytest-cov`\n",
970+
"- more on it here: [https://pytest-cov.readthedocs.io/en/latest/readme.html](https://pytest-cov.readthedocs.io/en/latest/readme.html)\n",
971+
"- see [https://github.com/rambasnet/course-container](https://github.com/rambasnet/course-container)\n",
972+
" - uses [https://app.codecov.io/](https://app.codecov.io/) that provides code coverage report and badge if ci-cd is configured\n",
973+
" - you can login with github on the service and just configure each repo to use the app\n",
974+
" - 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",
975+
"- see and run the Makefile in the root folder of this repo from a terminal"
976+
]
977+
},
851978
{
852979
"cell_type": "markdown",
853980
"metadata": {},

‎notebooks/ExpectingTheUnexpected.ipynb

+43-13
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@
3939
},
4040
{
4141
"cell_type": "code",
42-
"execution_count": 1,
42+
"execution_count": null,
4343
"id": "d4a06bab",
4444
"metadata": {},
4545
"outputs": [
4646
{
4747
"ename": "SyntaxError",
48-
"evalue": "Missing parentheses in call to 'print'. Did you mean print(...)? (3923495743.py, line 1)",
48+
"evalue": "Missing parentheses in call to 'print'. Did you mean print(...)? (528700135.py, line 2)",
4949
"output_type": "error",
5050
"traceback": [
51-
"\u001b[0;36m Cell \u001b[0;32mIn[1], line 1\u001b[0;36m\u001b[0m\n\u001b[0;31m print \"hello world\"\u001b[0m\n\u001b[0m ^\u001b[0m\n\u001b[0;31mSyntaxError\u001b[0m\u001b[0;31m:\u001b[0m Missing parentheses in call to 'print'. Did you mean print(...)?\n"
51+
"\u001b[0;36m Cell \u001b[0;32mIn[1], line 2\u001b[0;36m\u001b[0m\n\u001b[0;31m print \"hello world\"\u001b[0m\n\u001b[0m ^\u001b[0m\n\u001b[0;31mSyntaxError\u001b[0m\u001b[0;31m:\u001b[0m Missing parentheses in call to 'print'. Did you mean print(...)?\n"
5252
]
5353
}
5454
],
@@ -729,7 +729,7 @@
729729
},
730730
{
731731
"cell_type": "code",
732-
"execution_count": 28,
732+
"execution_count": 3,
733733
"id": "b5515f66",
734734
"metadata": {},
735735
"outputs": [],
@@ -752,7 +752,7 @@
752752
},
753753
{
754754
"cell_type": "code",
755-
"execution_count": 29,
755+
"execution_count": 4,
756756
"id": "6a866247",
757757
"metadata": {},
758758
"outputs": [
@@ -763,7 +763,7 @@
763763
"traceback": [
764764
"\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
765765
"\u001b[0;31mInvalidWithdrawl\u001b[0m Traceback (most recent call last)",
766-
"Cell \u001b[0;32mIn[29], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m InvalidWithdrawl(Decimal(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m25.00\u001b[39m\u001b[38;5;124m'\u001b[39m), Decimal(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m50.00\u001b[39m\u001b[38;5;124m'\u001b[39m))\n",
766+
"Cell \u001b[0;32mIn[4], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m InvalidWithdrawl(Decimal(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m25.00\u001b[39m\u001b[38;5;124m'\u001b[39m), Decimal(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m50.00\u001b[39m\u001b[38;5;124m'\u001b[39m))\n",
767767
"\u001b[0;31mInvalidWithdrawl\u001b[0m: account doesn't have 50.00 amount"
768768
]
769769
}
@@ -772,6 +772,41 @@
772772
"raise InvalidWithdrawl(Decimal('25.00'), Decimal('50.00'))"
773773
]
774774
},
775+
{
776+
"cell_type": "code",
777+
"execution_count": 5,
778+
"id": "f0e90085",
779+
"metadata": {},
780+
"outputs": [],
781+
"source": [
782+
"balance = Decimal('25.00')"
783+
]
784+
},
785+
{
786+
"cell_type": "code",
787+
"execution_count": 6,
788+
"id": "cb125ea9",
789+
"metadata": {},
790+
"outputs": [
791+
{
792+
"ename": "InvalidWithdrawl",
793+
"evalue": "account doesn't have 100 amount",
794+
"output_type": "error",
795+
"traceback": [
796+
"\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
797+
"\u001b[0;31mInvalidWithdrawl\u001b[0m Traceback (most recent call last)",
798+
"Cell \u001b[0;32mIn[6], line 3\u001b[0m\n\u001b[1;32m 1\u001b[0m withdrawal \u001b[38;5;241m=\u001b[39m Decimal(\u001b[38;5;28minput\u001b[39m(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124mEnter amount to withdraw: \u001b[39m\u001b[38;5;124m'\u001b[39m))\n\u001b[1;32m 2\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m withdrawal \u001b[38;5;241m>\u001b[39m balance:\n\u001b[0;32m----> 3\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m InvalidWithdrawl(balance, withdrawal)\n\u001b[1;32m 4\u001b[0m new_balance \u001b[38;5;241m=\u001b[39m balance \u001b[38;5;241m-\u001b[39m withdrawal\n",
799+
"\u001b[0;31mInvalidWithdrawl\u001b[0m: account doesn't have 100 amount"
800+
]
801+
}
802+
],
803+
"source": [
804+
"withdrawal = Decimal(input('Enter amount to withdraw: '))\n",
805+
"if withdrawal > balance:\n",
806+
" raise InvalidWithdrawl(balance, withdrawal)\n",
807+
"new_balance = balance - withdrawal"
808+
]
809+
},
775810
{
776811
"cell_type": "code",
777812
"execution_count": 30,
@@ -896,7 +931,7 @@
896931
],
897932
"metadata": {
898933
"kernelspec": {
899-
"display_name": "Python 3 (ipykernel)",
934+
"display_name": "Python 3",
900935
"language": "python",
901936
"name": "python3"
902937
},
@@ -910,12 +945,7 @@
910945
"name": "python",
911946
"nbconvert_exporter": "python",
912947
"pygments_lexer": "ipython3",
913-
"version": "3.12.2"
914-
},
915-
"vscode": {
916-
"interpreter": {
917-
"hash": "1a1af0ee75eeea9e2e1ee996c87e7a2b11a0bebd85af04bb136d915cefc0abce"
918-
}
948+
"version": "3.12.1"
919949
}
920950
},
921951
"nbformat": 4,

‎notebooks/PythonObjects.ipynb

+21
Original file line numberDiff line numberDiff line change
@@ -1115,6 +1115,27 @@
11151115
"test_singleton()"
11161116
]
11171117
},
1118+
{
1119+
"cell_type": "markdown",
1120+
"id": "ce4e86ec",
1121+
"metadata": {},
1122+
"source": [
1123+
"## Manager objects\n",
1124+
"\n",
1125+
"- higher-level objects that manage other objects\n",
1126+
" - the object that ties everything together\n",
1127+
"- these are sometimes called Facade objects because they present a pleasant, easy-to-use facade over some underlying complexity\n",
1128+
" - Facade is also a design pattern that's covered in more detail later in the course\n",
1129+
"- similar to managers in officers, management object, may not do the actual work\n",
1130+
"- the attributes of a management class tend to refer to other objects that do the actual work\n",
1131+
" - managers typically delegate to other classes at the right time and pass messages between them\n",
1132+
"- assemble manager objects by knitting other objects together\n",
1133+
"- to an extent, a manager is also an Adapter among the various interfaces\n",
1134+
" - another design pattern covered later in the course\n",
1135+
"- Solution/Main class in demo-assignments `A0-OOP, A1-OOP` are examples of a manager class\n",
1136+
"- Manger class can use Singleton pattern to ensure only one instance of the manager object is created"
1137+
]
1138+
},
11181139
{
11191140
"cell_type": "markdown",
11201141
"id": "fbaae722",

0 commit comments

Comments
 (0)