├── README.adoc ├── images └── banner.png └── sessions ├── session_00 └── README.md ├── session_01 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md ├── chirp_cli_db.csv ├── images │ ├── BDSA_git_intro_01.png │ ├── BDSA_git_intro_01.svg │ ├── BDSA_git_intro_02.png │ ├── BDSA_git_intro_03.png │ ├── BDSA_git_intro_04.png │ ├── BDSA_git_intro_05.png │ ├── BDSA_git_intro_06.png │ ├── first_names.png │ └── grades.html └── menti_results.pdf ├── session_02 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md ├── bdsa_greeter │ ├── Makefile │ ├── Program.cs │ └── bdsa_greeter.csproj ├── hello.zip └── images │ ├── accross_pkg_dep.png │ ├── accross_pkg_dep_ui.png │ ├── git_branching_strategies.jpeg │ └── within_pkg_dep.png ├── session_03 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── SE_TDD.png │ ├── instable_component.png │ └── stable_component.png ├── session_04 ├── .gitkeep ├── AsyncAwaitHTTP │ ├── .idea │ │ └── .idea.AsyncAwaitHTTP.dir │ │ │ └── .idea │ │ │ ├── .gitignore │ │ │ ├── encodings.xml │ │ │ ├── indexLayout.xml │ │ │ └── vcs.xml │ └── src │ │ ├── Client │ │ ├── Client.csproj │ │ └── Program.cs │ │ └── Server │ │ ├── Program.cs │ │ ├── Properties │ │ └── launchSettings.json │ │ ├── Server.csproj │ │ ├── appsettings.Development.json │ │ └── appsettings.json ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── client_server_comp.png │ ├── client_server_comp_db.png │ ├── client_server_seq.png │ ├── client_server_seq_db.png │ ├── db_schema.png │ ├── deployment.png │ ├── inspector.png │ ├── middleware.png │ └── multi_clients_server_comp.png ├── session_05 ├── .gitkeep ├── Chirp.SQLite │ ├── .vscode │ │ ├── launch.json │ │ └── tasks.json │ ├── Chirp.SQLite.csproj │ ├── Program.cs │ ├── data │ │ ├── dump.sql │ │ └── schema.sql │ └── scripts │ │ └── initDB.sh ├── DIExample │ ├── DIExample.csproj │ ├── DirectDependency.cs │ ├── InjectedDependency.cs │ ├── Program.cs │ ├── Properties │ │ └── launchSettings.json │ ├── Writer.cs │ ├── appsettings.Development.json │ └── appsettings.json ├── READING_MATERIAL.md ├── README_PROJECT.md ├── SimpleHTMLServer │ ├── Program.cs │ ├── Properties │ │ └── launchSettings.json │ ├── SimpleHTMLServer.csproj │ ├── appsettings.Development.json │ └── appsettings.json ├── Slides.html ├── Slides.md ├── data │ ├── dump.sql │ └── schema.sql ├── images │ ├── accross_pkg_dep.png │ ├── direct_dep.png │ ├── inversed_dep.png │ ├── simpledb_deployment.png │ ├── sqlite_deployment.png │ └── ssr_sq.png └── scripts │ └── initDB.sh ├── session_06 ├── .gitkeep ├── Feedback.html ├── Feedback.md ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md ├── data │ └── DbInitializer.cs └── images │ ├── .png │ ├── CS-to-db-changed.svg │ ├── CS-to-db.svg │ ├── DBContext.svg │ ├── EF-Core.png │ ├── ORM-overview.png │ ├── Repository.svg │ ├── azure_logs.png │ ├── banner-transparent.png │ ├── commit_freqs.png │ ├── domain_model.svg │ ├── repository-pattern.png │ └── unit-of-work.png ├── session_07 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── Onion-Diagram-a.svg │ ├── Onion-Diagram-b.svg │ ├── Onion-Diagram.svg │ ├── banner-transparent.png │ ├── domain_model.png │ ├── domain_model_constrained.png │ ├── entity-framework-core.jpg │ ├── fake-provider-and-repository-pattern.png │ ├── onion_architecture.webp │ └── unit-of-work-diagram.png ├── session_08 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── Oauth_logo.svg │ ├── arduino-login.png │ ├── authentication_login.png │ ├── authentication_subsequent.png │ ├── banner-transparent.png │ ├── chirp_after_auth.png │ ├── chirp_before_auth.png │ ├── claims_principle.png │ ├── cookie-basic-example.png │ ├── cookie-monster.png │ ├── domain_model.svg │ ├── domain_model_with_identity.svg │ ├── gh_oauth_local_config.png │ ├── github-oauth-settings.png │ ├── oauth_azure_config.png │ ├── oauth_dance-chirp-authenticate.png │ ├── oauth_dance-redirect.png │ ├── oauth_dance-resource-access.png │ ├── oauth_dance-user-authenticate.png │ ├── oauth_dance.png │ └── oauth_dance.psd ├── session_09 ├── .gitkeep ├── Feedback.html ├── Feedback.md ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── HTML form UI.png │ ├── Playwright recording.png │ ├── banner-transparent.png │ └── request-handling-razor-pages.png ├── session_10 ├── .gitkeep ├── Git_Crash_Course_by_daso.pdf ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── CDN.jpg │ ├── CSRF-1.png │ ├── CSRF-2.png │ ├── CSRF-3.png │ ├── CSRF-4.png │ ├── CSRF.png │ ├── CSRF.psd │ ├── XSS-attack.png │ ├── XSS-result-protected-rendered.png │ ├── XSS-result-protected.png │ ├── XSS-result-unprotected-rendered.png │ ├── XSS-result-unprotected.png │ ├── banner-transparent.png │ ├── http-unencrypted.png │ ├── https-decision-diagram.svg │ ├── https-encrypted.png │ ├── https-hsts.png │ ├── https-locally-browser.png │ ├── https-offloading.png │ ├── https-passthrough.png │ ├── https-redirects.png │ ├── load-testing.png │ ├── owasp-top-ten.png │ └── xkcd-bobby-tables.png ├── session_11 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── Slides.html ├── Slides.md └── images │ ├── accross_pkg_dep_ui.png │ ├── activity.png │ ├── activity_syntax.png │ ├── authenticated_request.png │ ├── bpmn.png │ ├── bpmn_legend.png │ ├── class.png │ ├── class_association.png │ ├── class_inheritance.png │ ├── client_server_comp_db.png │ ├── domain_model.png │ ├── domain_model_constrained.png │ ├── feature_model.png │ ├── login_logout_sm.png │ ├── multi_clients_server_comp.png │ ├── non_func_reqs.png │ ├── non_func_reqs2.png │ ├── sd_call.png │ ├── sd_oauth_dance.png │ ├── state_follow.png │ ├── wireframe.png │ └── wireframe_online_editor.png ├── session_12 ├── .gitkeep ├── READING_MATERIAL.md ├── README_PROJECT.md ├── README_REPORT.md ├── Slides.html ├── Slides.md └── docs │ ├── images │ └── domain_model.png │ └── report.md └── session_13 ├── .gitkeep ├── README_PROJECT.md ├── Slides.html └── Slides.md /images/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/images/banner.png -------------------------------------------------------------------------------- /sessions/session_00/README.md: -------------------------------------------------------------------------------- 1 | The following describes what we would like you to do before the first session of the course _Analysis, Design and Software Architecture_ on Wednesday, Aug. 28th (10:00). 2 | 3 | We would like that you prepare the following three things: 4 | 5 | * [A) Survey](#A-survey) 6 | * [B) Register accounts](#B-register-accounts) 7 | * [C) Setup workstation](#C-setup-workstation) 8 | 9 | In case you have problems with installation of any of the tools, do not despair. 10 | You will be able to ask the TAs for help during the first exercise session on Wednesday, Aug. 28th (14:00). 11 | 12 | ------------------------------------------------------------------------------- 13 | 14 | # A) Survey 15 | 16 | Please fill out the survey on menti.com, which will allow us to better adapt our teaching to you. 17 | The link is shared with you in a message that you received via LearnIT and via our Teams channel. 18 | 19 | ------------------------------------------------------------------------------- 20 | 21 | # B) Register accounts 22 | 23 | ## Create an account on [GitHub](https://github.com) 24 | 25 | If you do not have an account on [GitHub](https://github.com) yet, sign-up via https://github.com/signup 26 | 27 | Note, in this course we are using [GitHub.com](https://github.com) **not** [ITU's GitHub instance](https://github.itu.dk/). 28 | 29 | 30 | ## GitHub Student Developer Pack 31 | 32 | Sign up for the [GitHub Student Developer Pack](https://education.github.com/experiences/virtual_event_kit) to receive free credit for Azure services. 33 | Some of which, we will use later in the course. 34 | 35 | 36 | -------------------------------------------------------------------------------- 37 | 38 | # C) Setup workstation 39 | 40 | ## Install a package manager 41 | 42 | - Windows 43 | - You should have [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/) already installed. If not make sure to install it. 44 | - MacOS 45 | - Install [homebrew](https://brew.sh/) by running the following in your terminal: 46 | 47 | ```bash 48 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 49 | ``` 50 | - Linux 51 | - Depending on your distribution, you have a package manager like `apt` (Debian-based distributions) or `rpm` (RedHat-based distributions), etc. already installed. 52 | 53 | ## Install software (latest versions) 54 | 55 | 1. Windows only: 56 | 1. [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/) 57 | 2. [Custom prompt](https://docs.microsoft.com/en-us/windows/terminal/tutorials/custom-prompt-setup) 58 | 3. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) with Ubuntu 59 | 2. [Git](https://git-scm.com/downloads) 60 | 3. [.NET **7**](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) 61 | - If your operating, sytstem is Windows install .NET 7 in WSL 62 | 4. A full IDE: 63 | - [JetBrains Rider](https://www.jetbrains.com/rider/) (all operating systems) Note, you can get a free student license for all JetBrais IDEs that you use during your education, see 64 | - *Optionally* [Visual Studio Community](https://visualstudio.microsoft.com/downloads/) (Windows and Mac only) 65 | 5. *Optionally* [Visual Studio Code](https://code.visualstudio.com/Download) with extensions: 66 | - [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) 67 | - [.NET Core Test Explorer](https://marketplace.visualstudio.com/items?itemName=formulahendry.dotnet-test-explorer) 68 | - [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) 69 | - [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) 70 | -------------------------------------------------------------------------------- /sessions/session_01/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/.gitkeep -------------------------------------------------------------------------------- /sessions/session_01/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 01 2 | 3 | 4 | ## About Git 5 | 6 | * In case you are in doubt about any of the basic Git command, see [section 2 of the Pro Git book](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository). 7 | * [A visual explanation of various Git commands](https://onlywei.github.io/explain-git-with-d3/) 8 | * [A Visual Git Reference](https://marklodato.github.io/visual-git-guide/index-en.html) 9 | * [A Git Beginner Reference Guide](https://mukulrathi.com/git-beginner-cheatsheet/) 10 | 11 | 12 | ## Help on C♯ 13 | 14 | * [Introduction to C♯](https://learn.microsoft.com/en-us/dotnet/csharp/) 15 | - [A tour of the C♯ language](https://learn.microsoft.com/en-us/dotnet/csharp/tour-of-csharp/) 16 | - [The C♯ type system](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/types/) 17 | - [Description of C♯ top-level statements](https://learn.microsoft.com/en-us/dotnet/core/tutorials/top-level-templates) 18 | * [.NET Naming Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines) 19 | 20 | 21 | ## Debugging 22 | 23 | * [Debugging in JetBrains Rider](https://www.jetbrains.com/help/rider/Debugging_Code.html) 24 | * [Debugging in Visual Studio Code](https://code.visualstudio.com/Docs/editor/debugging) 25 | -------------------------------------------------------------------------------- /sessions/session_01/chirp_cli_db.csv: -------------------------------------------------------------------------------- 1 | Author,Message,Timestamp 2 | ropf,"Hello, BDSA students!",1690891760 3 | adho,"Welcome to the course!",1690978778 4 | adho,"I hope you had a good summer.",1690979858 5 | ropf,"Cheeping cheeps on Chirp :)",1690981487 6 | -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_01.png -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_01.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | Produced by OmniGraffle 7.18.6\n2024-08-27 10:07:35 +0000 22 | 23 | Canvas 1 24 | 25 | 26 | Layer 1 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | commit 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | tree 83 | 84 | 85 | 86 | 87 | parent 88 | 89 | 90 | 91 | 92 | author 93 | 94 | 95 | 96 | 97 | committer 98 | 99 | 100 | 101 | 102 | f40beda2 103 | 104 | 105 | 106 | 107 | Initial commit 108 | 109 | 110 | 111 | 112 | 359b5b4a 113 | 114 | 115 | 116 | 117 | HelgeCPH <ropf@itu.dk> 118 | 119 | 120 | 121 | 122 | HelgeCPH <ropf@itu.dk> 123 | 124 | 125 | 126 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_02.png -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_03.png -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_04.png -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_05.png -------------------------------------------------------------------------------- /sessions/session_01/images/BDSA_git_intro_06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/BDSA_git_intro_06.png -------------------------------------------------------------------------------- /sessions/session_01/images/first_names.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/images/first_names.png -------------------------------------------------------------------------------- /sessions/session_01/images/grades.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | Grades plot 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 |
38 | 39 | 40 | 41 | 42 | 43 | 46 | 82 | 83 | 84 | 85 | -------------------------------------------------------------------------------- /sessions/session_01/menti_results.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_01/menti_results.pdf -------------------------------------------------------------------------------- /sessions/session_02/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/.gitkeep -------------------------------------------------------------------------------- /sessions/session_02/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 02 2 | 3 | ## Collaborative Work (on GitHub) 4 | 5 | * Read [chapter 9 on Teamwork from Mark Seemann's _Code That Fits in Your Head_](https://ituniversity.sharepoint.com/:b:/r/sites/2024AnalysisDesignandSoftwareArchitecture/Shared%20Documents/General/Documents/code-that-fits-your-head_ch9_scan.pdf?csf=1&web=1&e=LSaXUp) 6 | * How to use [issues](https://docs.github.com/issues) and [projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects) on GitHub 7 | * More details [about GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) 8 | * More details [about GitHub projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) 9 | 10 | 11 | ## C♯ Language Features 12 | 13 | * [`record` reference types in C♯](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/record) 14 | * [Generics in C♯](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/types/generics) 15 | 16 | 17 | ## Building C♯/.NET Projects 18 | 19 | * [Publish .NET applications with the .NET CLI](https://learn.microsoft.com/en-us/dotnet/core/deploying/deploy-with-cli) 20 | * [Single-file deployments](https://learn.microsoft.com/en-us/dotnet/core/deploying/single-file/overview?tabs=cli) 21 | * Official documentation on the CLI commands 22 | - [`dotnet run`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-run) 23 | - [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) 24 | - [`dotnet clean`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-clean) 25 | - [`dotnet publish`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish) 26 | * [Training material for handling external dependencies](https://learn.microsoft.com/en-us/training/modules/dotnet-dependencies/) 27 | 28 | 29 | ## Parsing CLI Arguments and Options 30 | 31 | * Using: [`System.CommandLine`](https://learn.microsoft.com/en-us/archive/msdn-magazine/2019/march/net-parse-the-command-line-with-system-commandline) 32 | * Using: [`CommandLine`](https://github.com/commandlineparser/commandline) 33 | * Using: [`docopt.net`](https://docopt.github.io/docopt.net/dev/) 34 | 35 | ## Diagrams 36 | 37 | * [UML class diagrams](https://www.uml-diagrams.org/class-diagrams-overview.html) 38 | https://www.uml-diagrams.org/class.html 39 | -------------------------------------------------------------------------------- /sessions/session_02/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Process](#1-process) 8 | - [2) Software Development](#2-software-development) 9 | - [3) Ethics](#3-ethics) 10 | 11 | Remember, you have to perform work on each topic and on **each** bullet point. 12 | Be done with the project work before we meet again next week's lecture. 13 | 14 | 15 | ## 1) Process 16 | 17 | * From now on, organize your project work into issues (tickets) on GitHub. 18 | Describe each issue drawing inspiration from the guidelines presented in class. 19 | - Issues shall describe the tasks presented in the `README_PROJECT.md` files. 20 | Add additional issues for tasks that you identify to complete your project work. 21 | - Make sure that you label your issues according to their type, e.g., do they describe a new feature, an enhancement, a bug, etc. 22 | * From now on, make sure that you record your work in multiple _small_ commits. 23 | Not one big one per task, as suggested by Mark Seeman in the [reading material](READING_MATERIAL.md#collaborative-work-(on-github)). 24 | - Remember, to register all co-authors that contributed to a commit, see session 01. 25 | - Each co-author is registered on a separate line in the commit message, see [feedback in lecture notes](Slides.md#feedback-III). 26 | - Make all these small commits in short-lived feature branches, which you merge with main (at least once per day). 27 | * From now on, use a GitHub project board to organize your work and to make your work status visible. 28 | - Use the project template called _"Team planning"_, i.e., use the _board layout_ (not the table or project layout). 29 | - Add all issues that you might have already created to the project board, this can be done [manually](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project#bulk-adding-issues-and-pull-requests) or [automatically](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically). 30 | - Make sure that the status of the issues is properly reflected in the project board, i.e., move issues that are work-in-progress to the respective column, etc. 31 | 32 | 33 | ## 2) Software Development 34 | 35 | The following are separate tasks. 36 | That is, treat them as such. 37 | Even though it might tempting to perform all the refactorings in one big chunk of work, train to work on separate concerns, one at a time. 38 | 39 | 40 | ### 2.a) Refactor _Chirp!_ to use an external library for CSV file handling 41 | 42 | In general, comprehensive support for CSV files with correct handling of escape characters, line breaks, etc. is quite difficult. 43 | In case you are using "manual" parsing and unparsing of comma-separated values when receiving and storing cheeps to and from disk, refactor your implementation of _Chirp!_ so that it uses a library that handles CSV files properly. 44 | One of the most used libraries for handling CSV files in C♯ seems to be [`CsvHelper`](https://joshclose.github.io/CsvHelper/getting-started/). 45 | Use this or a [comparable library](https://www.nuget.org/packages?q=CSV&frameworks=&tfms=&packagetype=&prerel=true) to read cheeps from and write cheeps to a CSV file. 46 | 47 | For now, cheeps shall be objects that are instances of a respective [`record`](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/record) that was presented in class: 48 | 49 | ```csharp 50 | public record Cheep(string Author, string Message, long Timestamp); 51 | ``` 52 | 53 | 54 | ### 2.b) Refactor data persistence to library project `SimpleDB` 55 | 56 | Refactor the entire data persistence solution so that it resides in a library project `SimpleDB` on which your `Chirp.CLI` project depends, see [the official documentation on how to establish references between projects](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-add-reference). 57 | 58 | Create a new .NET `classlib` project called `SimpleDB` (or reuse the one from class) and create a class `CSVDatabase` in it that implements the `IDatabaseRepository` that was presented in the lecture. 59 | Note, it shall not be possible to create further sub-classes of class `CSVDatabase`, see [the official documentation on how to achieve that](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/sealed). 60 | 61 | Make sure that your `SimpleDB` relies on the refactored code from the task above, i.e., that it depends on an external library for parsing and unparsing of CSV data. 62 | 63 | Note, after this refactoring, your `Chirp.CLI` project is likely quite "slim" and contains only code for retrieving command-line arguments and for printing output, i.e., it contains the application's user interface. 64 | 65 | When illustrated as UML class diagram, your current program (the one that you created in last week's project work) looks likely as on the left below. That is, all functionality is contained in a single `Program` class, which is contained in your `Program.cs` file. 66 | 67 | After the refactoring, it should look as on the right below. That is, a generic class `CSVDatabase` implements the generic interface `IDatabaseRepository` and the two methods `Read` and `Store`. A reference to the `database` is used in the main program class so that cheeps can be stored to the database and be retrieved from it. 68 | 69 | | Before refactoring | After refactoring | 70 | |:-------------------------------:|:------------------------------:| 71 | | ![](images/within_pkg_dep.png ) | ![](images/accross_pkg_dep.png)| 72 | 73 | 74 | ### 2.c) Refactor `Chirp.CLI`'s `Program.cs` so that all User Interface code resides in a separate class 75 | 76 | Refactor all code that is concerned with printing cheeps to the terminal into a separate class called `UserInterface`. That is, after refactoring, your main program depends on this new class and calls a respective method whenever cheeps are printed to the terminal. 77 | 78 | Likely, it is a good design to make the UserInterface and the contained methods [`static`](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/static-classes-and-static-class-members) 79 | 80 | | Before refactoring | After refactoring | 81 | |:--------------------------------:|:---------------------------------:| 82 | | ![](images/accross_pkg_dep.png ) | ![](images/accross_pkg_dep_ui.png)| 83 | 84 | 85 | ### 2.d) Refactor `Chirp.CLI`'s `Program.cs` to use an external library CLI interface 86 | 87 | Proper parsing of arguments and options that are provided to a program is difficult and error prone. 88 | Therefore, refactor your current `Program.cs` so that arguments passed to the program are not manually parsed out of the `args` property. 89 | 90 | You may want to choose [`System.CommandLine`](https://learn.microsoft.com/en-us/archive/msdn-magazine/2019/march/net-parse-the-command-line-with-system-commandline), [`CommandLine`](https://github.com/commandlineparser/commandline), [`docopt.net`](https://docopt.github.io/docopt.net/dev/), or any other comparable library that you find on [nuget.org](https://www.nuget.org/). 91 | 92 | 93 | ## 3) Ethics 94 | 95 | Consider if want to share telemetry data with Microsoft. Per default, Microsoft collects data about many actions that you perform using their tools, see e.g., https://learn.microsoft.com/en-us/dotnet/core/tools/telemetry and https://dotnet.microsoft.com/en-us/platform/telemetry. 96 | 97 | You can disable telemetry when using the `dotnet` command by creating an environment variable (in your `.bashrc` or whichever shell you are using) before invoking any `dotnet` commands: 98 | 99 | * `DOTNET_CLI_TELEMETRY_OPTOUT=1` or 100 | * `DOTNET_CLI_TELEMETRY_OPTOUT=true` 101 | 102 | 103 | Additionally, VSCode collects telemetry data on how you are using it. 104 | You might want to disable that in the settings (set `telemetry.telemetryLevel` to off), see https://code.visualstudio.com/docs/getstarted/telemetry. 105 | 106 | 107 | **OBS:** In general, when you build software in your later professional lives, it is a good practice to make collection of telemetry opt-in and not opt-out. 108 | -------------------------------------------------------------------------------- /sessions/session_02/bdsa_greeter/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all build clean 2 | 3 | all: build 4 | 5 | bin/Release/net7.0/linux-x64/publish/hello: Program.cs bdsa_greeter.csproj 6 | dotnet publish -r linux-x64 7 | 8 | bin/Release/net7.0/win-x64/publish/hello.exe: Program.cs bdsa_greeter.csproj 9 | dotnet publish -r win-x64 10 | 11 | bin/Release/net7.0/win-arm64/publish/hello.exe: Program.cs bdsa_greeter.csproj 12 | dotnet publish -r win-arm64 13 | 14 | bin/Release/net7.0/osx-x64/publish/hello: Program.cs bdsa_greeter.csproj 15 | dotnet publish -r osx-x64 16 | 17 | bin/Release/net7.0/osx-arm64/publish/hello: Program.cs bdsa_greeter.csproj 18 | dotnet publish -r osx-arm64 19 | 20 | build: bin/Release/net7.0/linux-x64/publish/hello bin/Release/net7.0/win-x64/publish/hello.exe bin/Release/net7.0/win-arm64/publish/hello.exe bin/Release/net7.0/osx-x64/publish/hello bin/Release/net7.0/osx-arm64/publish/hello 21 | 22 | clean: 23 | rm -r ./bin/ ./obj/ 24 | -------------------------------------------------------------------------------- /sessions/session_02/bdsa_greeter/Program.cs: -------------------------------------------------------------------------------- 1 | // Project was generated on Linux with: 2 | // dotnet new console --framework net6.0 3 | 4 | // Nice message is generated here: 5 | // https://patorjk.com/software/taag/#p=display&f=Bloody&t=Welcome%0A%20%20%20%20%20%20%20to%0A%20%20%20%20%20%20ITU 6 | string msg = @" 7 | █ █░▓█████ ██▓ ▄████▄ ▒█████ ███▄ ▄███▓▓█████ 8 | ▓█░ █ ░█░▓█ ▀ ▓██▒ ▒██▀ ▀█ ▒██▒ ██▒▓██▒▀█▀ ██▒▓█ ▀ 9 | ▒█░ █ ░█ ▒███ ▒██░ ▒▓█ ▄ ▒██░ ██▒▓██ ▓██░▒███ 10 | ░█░ █ ░█ ▒▓█ ▄ ▒██░ ▒▓▓▄ ▄██▒▒██ ██░▒██ ▒██ ▒▓█ ▄ 11 | ░░██▒██▓ ░▒████▒░██████▒▒ ▓███▀ ░░ ████▓▒░▒██▒ ░██▒░▒████▒ 12 | ░ ▓░▒ ▒ ░░ ▒░ ░░ ▒░▓ ░░ ░▒ ▒ ░░ ▒░▒░▒░ ░ ▒░ ░ ░░░ ▒░ ░ 13 | ▒ ░ ░ ░ ░ ░░ ░ ▒ ░ ░ ▒ ░ ▒ ▒░ ░ ░ ░ ░ ░ ░ 14 | ░ ░ ░ ░ ░ ░ ░ ░ ░ ▒ ░ ░ ░ 15 | ░ ░ ░ ░ ░░ ░ ░ ░ ░ ░ ░ 16 | ░ 17 | ▄▄▄█████▓ ▒█████ 18 | ▓ ██▒ ▓▒▒██▒ ██▒ 19 | ▒ ▓██░ ▒░▒██░ ██▒ 20 | ░ ▓██▓ ░ ▒██ ██░ 21 | ▒██▒ ░ ░ ████▓▒░ 22 | ▒ ░░ ░ ▒░▒░▒░ 23 | ░ ░ ▒ ▒░ 24 | ░ ░ ░ ░ ▒ 25 | ░ ░ 26 | 27 | ██▓▄▄▄█████▓ █ ██ 28 | ▓██▒▓ ██▒ ▓▒ ██ ▓██▒ 29 | ▒██▒▒ ▓██░ ▒░▓██ ▒██░ 30 | ░██░░ ▓██▓ ░ ▓▓█ ░██░ 31 | ░██░ ▒██▒ ░ ▒▒█████▓ 32 | ░▓ ▒ ░░ ░▒▓▒ ▒ ▒ 33 | ▒ ░ ░ ░░▒░ ░ ░ 34 | ▒ ░ ░ ░░░ ░ ░ 35 | ░ ░ 36 | 37 | "; 38 | Console.WriteLine(msg); 39 | -------------------------------------------------------------------------------- /sessions/session_02/bdsa_greeter/bdsa_greeter.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net7.0 6 | enable 7 | enable 8 | 9 | true 10 | true 11 | false 12 | embedded 13 | hello 14 | win-x64;win-arm64;linux-x64;osx-x64;osx-arm64 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /sessions/session_02/hello.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/hello.zip -------------------------------------------------------------------------------- /sessions/session_02/images/accross_pkg_dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/images/accross_pkg_dep.png -------------------------------------------------------------------------------- /sessions/session_02/images/accross_pkg_dep_ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/images/accross_pkg_dep_ui.png -------------------------------------------------------------------------------- /sessions/session_02/images/git_branching_strategies.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/images/git_branching_strategies.jpeg -------------------------------------------------------------------------------- /sessions/session_02/images/within_pkg_dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_02/images/within_pkg_dep.png -------------------------------------------------------------------------------- /sessions/session_03/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_03/.gitkeep -------------------------------------------------------------------------------- /sessions/session_03/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 03 2 | 3 | ## Testing 4 | 5 | * Read chapters 35 and 36 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 6 | * [Introduction to Unit Testing from official documentation](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-dotnet-test) 7 | * [Organize .NET Project for testing](https://learn.microsoft.com/en-us/dotnet/core/tutorials/testing-with-cli) 8 | * [Testing best practices](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-best-practices) 9 | 10 | 11 | ## GitHub Actions 12 | 13 | * [Introduction to GitHub Actions from Microsoft Trainings Center](https://learn.microsoft.com/en-us/training/modules/introduction-to-github-actions) 14 | * [GitHub's official documentation of GitHub Actions](https://docs.github.com/actions) 15 | * [Microsoft's official documentation of GitHub Actions for .NET projects](https://learn.microsoft.com/en-us/dotnet/devops/github-actions-overview) 16 | * [A blog post that provides an example of how to release binaries](https://patriksvensson.se/posts/2020/03/creating-release-artifacts-with-github-actions) 17 | 18 | 19 | ## Singleton Pattern 20 | 21 | * [_C♯ in Depth_](https://csharpindepth.com/Articles/Singleton)'s description of various implementations of the Singleton Pattern in C♯ 22 | * [An alternative description of it with examples](https://refactoring.guru/design-patterns/singleton) 23 | 24 | 25 | 26 | 27 | 30 | -------------------------------------------------------------------------------- /sessions/session_03/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Process](#1-process) 8 | - [2) Software Development](#2-software-development) 9 | - [3) Ethics](#3-ethics) 10 | - [4) Prepare for next session](#4-prepare-for-next-session) 11 | 12 | Remember, you have to perform work on each topic and on **each** bullet point. 13 | Be done with the project work before we meet again next Thursday. 14 | 15 | 16 | ## 1) Process 17 | 18 | ### 1.a) Automate build, test, and publishing with GitHub Workflows 19 | 20 | Add GitHub Actions workflows to your projects. 21 | Likely, you will add two or more of them. 22 | 23 | * Start with adding an adapted version of a [.NET starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/dotnet.yml). 24 | - When adapting it, make sure that you are using a .NET version 7, the same that we told you to install on your local computers. 25 | - That workflow shall be executed on all pushes and merge of pull-requests in your repository. 26 | * Add a workflow that releases your `chirp` executable, i.e., a single file .NET application. 27 | - The workflow should build and test your project whenever you push a new version that is accordingly tagged ([`git tag`](https://git-scm.com/book/en/v2/Git-Basics-Tagging)) to your repository. 28 | - When all tests pass, create at least three executables of your _Chirp!_ project, one for Windows, one for MacOS, and one for Linux (`-x64`). 29 | - If you want to, publish executables for ARM processors too. 30 | - Each executable shall be distributed as compressed with `zip` file. 31 | - All of the above steps shall be executed in an `ubuntu-latest` environment, i.e., you want to cross-compile for the different targets. 32 | - Since everybody in this course has .NET 7 installed it is sufficient to publish a platform-dependent single file application, i.e., not a self-contained application. 33 | 34 | ### Hints: 35 | 36 | * Likely you can combine the building blocks from the lecture notes and the reading material into a working solution. 37 | * To publish a release of your project, you might want to use the [`softprops/action-gh-release` action](https://github.com/softprops/action-gh-release) 38 | * You might use this [blog post](https://patriksvensson.se/posts/2020/03/creating-release-artifacts-with-github-actions) for inspiration on how to create releases for various operating systems. Note though, that you want to build in one environment (`ubuntu-latest`) instead of three as in the given example, i.e., you do not need a build matrix. 39 | * To allow a GitHub action to create releases, you have to grant it write access. You do that on GitHub in your repository under `Settings` → `Actions` → `General` under `Workflow permissions` enable `"Read and write permissions"`, see the [official documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository) 40 | 41 | ### 1.b) Automate certain project management tasks 42 | 43 | Using GitHub Actions, you can [automate certain tasks](https://docs.github.com/en/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management), like [adding labels to issues](https://docs.github.com/en/actions/managing-issues-and-pull-requests/adding-labels-to-issues), [moving labels to project board columns on state change](https://docs.github.com/en/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards), etc. 44 | Choose some of these project management tasks that you deem suitable and automate the with GitHub Actions workflow. 45 | 46 | ### 1.c) Enable automatic code formatting 47 | 48 | Make sure that everybody in the team formats code whenever it is edited with Rider. 49 | The IDE supports this by default, the [respective configuration needs to be activated](https://www.jetbrains.com/help/rider/Enforcing_Code_Formatting_Rules.html). 50 | 51 | 52 | ## 2) Software Development 53 | 54 | ### 2.a) Software Testing 55 | 56 | * Restructure your current project so that the _Chirp!_ application and the CSV database library reside under a `src/` directory 57 | - Hint: use `git mv` to move files and directories while restructuring. 58 | * Create XUnit .NET test projects, see `dotnet new list` in a `test` directory that is in the root of your project, see e.g., page 880 of A. Lock _ASP.NET Core in Action, Third Edition_. 59 | - That is, one test project that tests your _Chirp!_ CLI app and a second one that tests your CSV database library project. 60 | * Make your test projects depend on the respective system under test (SUT). 61 | - That is, add a reference from each of the two test projects to either the _Chirp!_ CLI app or to the CSV database library project with the [`dotnet add reference`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-add-reference) command. 62 | * Add unit tests to your _Chirp!_ CLI app. 63 | - Add unit tests for suitable functionality. For example, conversion of UNIX timestamps to user readable times and similar functionality are good candidates for unit testing. 64 | * Add integration tests that test your CSV database library works as intended. 65 | - For example, add a test case that checks that an entry can be received from the database after it was stored in there. 66 | * Add two end-to-end tests that test your _Chirp!_ CLI app: 67 | - For example, you want to test that given example data from [`chirp_cli_db.csv`](../session_01/chirp_cli_db.csv) calling `chirp read 10` from the command line produces output as in the following: 68 | ``` 69 | ropf @ 08/01/23 14:09:20: Hello, BDSA students! 70 | rnie @ 08/02/23 14:19:38: Welcome to the course! 71 | rnie @ 08/02/23 14:37:38: I hope you had a good summer. 72 | ropf @ 08/02/23 15:04:47: Cheeping cheeps on Chirp :) 73 | ``` 74 | - Additionally, you want to test that calling `chirp cheep "Hello!!!"` stores the respective values in the database. 75 | 76 | ### 2.b) Software Design 77 | 78 | We want to be able to express and to assure that there is at any given point in time only one CSV database on our system. 79 | That is we want to couple the database CSV file on the file system to a singleton object in our software. 80 | Consequently, refactor your `CSVDatabase` class that is responsible for `Read`ing cheeps from and `Store`ing cheeps to a CSV file to be a _singleton_. 81 | That is, make it adhere to the singleton design pattern. 82 | Likely, it is a good idea to skim the various implementations that are presented in [C♯ in Depth](https://csharpindepth.com/Articles/Singleton) and to adapt a suitable version for your implementation. 83 | For this session, it is not yet necessary that your implementation is thread-safe. 84 | 85 | 86 | ## 3) Ethics 87 | 88 | Now that you test and build your software with GitHub Actions, consider if want to share telemetry data with Microsoft. Per default, Microsoft collects data about many actions that you perform using their tools, see e.g., https://learn.microsoft.com/en-us/dotnet/core/tools/telemetry and https://dotnet.microsoft.com/en-us/platform/telemetry. 89 | 90 | Remember, that you can disable telemetry when using the `dotnet` command by creating an environment variable set to true before invoking any `dotnet` commands: 91 | 92 | * `DOTNET_CLI_TELEMETRY_OPTOUT=1` or 93 | * `DOTNET_CLI_TELEMETRY_OPTOUT=true` 94 | 95 | See the [official documentation](https://docs.github.com/en/actions/learn-github-actions/variables) to see how to define respective environment variables in GitHub Actions workflows. 96 | 97 | 98 | ## 4) Prepare for next session 99 | 100 | Next session, we need that you are signed-up to Microsoft's cloud-service platform, which is called _Azure_. 101 | 102 | - To sign up to Azure with free student credits, follow [this guide](https://app.tango.us/app/workflow/Steps-to-Sign-Up-for-Azure-with-Student-Mail-285020aa8d76412eada4b6915b695de2) 103 | - Note, follow mainly what is illustrated on the image. Except of the first link, you will just navigate through the illustrated flow of actions. 104 | - OBS: of course fill in your name, birthday, email address, etc. 105 | - Thereafter, [install the Azure CLI client](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) before class. 106 | - Make sure that you can login and out to Azure from the command-line via `az login` and `az logout` respectively. 107 | * Verify that you can log onto with your ITU credentials. 108 | -------------------------------------------------------------------------------- /sessions/session_03/images/SE_TDD.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_03/images/SE_TDD.png -------------------------------------------------------------------------------- /sessions/session_03/images/instable_component.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_03/images/instable_component.png -------------------------------------------------------------------------------- /sessions/session_03/images/stable_component.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_03/images/stable_component.png -------------------------------------------------------------------------------- /sessions/session_04/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/.gitkeep -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/.idea/.idea.AsyncAwaitHTTP.dir/.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Rider ignored files 5 | /contentModel.xml 6 | /projectSettingsUpdater.xml 7 | /.idea.AsyncAwaitHTTP.iml 8 | /modules.xml 9 | # Editor-based HTTP Client requests 10 | /httpRequests/ 11 | # Datasource local storage ignored files 12 | /dataSources/ 13 | /dataSources.local.xml 14 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/.idea/.idea.AsyncAwaitHTTP.dir/.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/.idea/.idea.AsyncAwaitHTTP.dir/.idea/indexLayout.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/.idea/.idea.AsyncAwaitHTTP.dir/.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Client/Client.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net7.0 6 | enable 7 | enable 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Client/Program.cs: -------------------------------------------------------------------------------- 1 | // Create an HTTP client object 2 | var baseURL = "http://localhost:5088"; 3 | using HttpClient client = new(); 4 | client.BaseAddress = new Uri(baseURL); 5 | 6 | // Sequential execution 7 | var watch = System.Diagnostics.Stopwatch.StartNew(); 8 | // first HTTP request 9 | var fstResponse = await client.GetAsync("/"); 10 | Console.WriteLine((fstResponse)); 11 | // second HTTP request 12 | var sndResponse = await client.GetAsync("/"); 13 | watch.Stop(); 14 | 15 | Console.WriteLine($"Sequential HTTP requests ... done after {watch.ElapsedMilliseconds}ms"); 16 | 17 | // Concurrent execution 18 | watch = System.Diagnostics.Stopwatch.StartNew(); 19 | // first HTTP request 20 | var fstRequestTask = client.GetAsync("/"); 21 | // second HTTP request 22 | var sndRequestTask = client.GetAsync("/"); 23 | 24 | var thrdResponse = await fstRequestTask; 25 | var frthResponse = await sndRequestTask; 26 | watch.Stop(); 27 | 28 | Console.WriteLine($"Concurrent HTTP requests ... done after {watch.ElapsedMilliseconds}ms"); 29 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Server/Program.cs: -------------------------------------------------------------------------------- 1 | var builder = WebApplication.CreateBuilder(args); 2 | var app = builder.Build(); 3 | 4 | app.MapGet("/", () => 5 | { 6 | Thread.Sleep(2000); 7 | return "Hello World!"; 8 | }); 9 | 10 | app.Run(); 11 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Server/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "iisSettings": { 3 | "windowsAuthentication": false, 4 | "anonymousAuthentication": true, 5 | "iisExpress": { 6 | "applicationUrl": "http://localhost:52790", 7 | "sslPort": 44357 8 | } 9 | }, 10 | "profiles": { 11 | "http": { 12 | "commandName": "Project", 13 | "dotnetRunMessages": true, 14 | "launchBrowser": true, 15 | "applicationUrl": "http://localhost:5088", 16 | "environmentVariables": { 17 | "ASPNETCORE_ENVIRONMENT": "Development" 18 | } 19 | }, 20 | "https": { 21 | "commandName": "Project", 22 | "dotnetRunMessages": true, 23 | "launchBrowser": true, 24 | "applicationUrl": "https://localhost:7088;http://localhost:5088", 25 | "environmentVariables": { 26 | "ASPNETCORE_ENVIRONMENT": "Development" 27 | } 28 | }, 29 | "IIS Express": { 30 | "commandName": "IISExpress", 31 | "launchBrowser": true, 32 | "environmentVariables": { 33 | "ASPNETCORE_ENVIRONMENT": "Development" 34 | } 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Server/Server.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net7.0 5 | enable 6 | enable 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Server/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /sessions/session_04/AsyncAwaitHTTP/src/Server/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | }, 8 | "AllowedHosts": "*" 9 | } 10 | -------------------------------------------------------------------------------- /sessions/session_04/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 04 2 | 3 | * For preparation: [install the Azure CLI client](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) 4 | * Read chapters three, four, and five from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 5 | 6 | 7 | ## HTTP Messages 8 | 9 | * [Description of HTTP Messages](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages) 10 | 11 | 12 | ## C♯ 13 | 14 | * [Lambda expressions and anonymous functions](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/lambda-expressions) 15 | * [Intro to C♯'s `await` operator](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/await) 16 | * [Introduction to asynchronous programming with `async` and `await` in C♯](https://learn.microsoft.com/en-us/dotnet/csharp/asynchronous-programming/) 17 | * Optional: A quite long but elaborate and historical explaination of [How Async/Await Really Works in C♯](https://devblogs.microsoft.com/dotnet/how-async-await-really-works/) 18 | 19 | ## (ASP).NET Core 20 | 21 | * [Minimal Web APIs](https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-7.0&tabs=visual-studio-code) 22 | * [Tutorial: Make HTTP requests in a .NET console app using C♯](https://learn.microsoft.com/en-us/dotnet/csharp/tutorials/console-webapiclient) 23 | * [Make HTTP requests with the `HttpClient` class](https://learn.microsoft.com/en-us/dotnet/fundamentals/networking/http/httpclient) 24 | * [Official documentation of `HttpClient` Class](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-7.0) 25 | * [ASP.NET Core Middleware](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/middleware/?view=aspnetcore-7.0) 26 | * [How to serialize and deserialize (marshal and unmarshal) JSON in .NET](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/how-to?pivots=dotnet-7-0) 27 | 28 | 29 | ## Patterns 30 | 31 | * [Builder pattern introduction](https://refactoring.guru/design-patterns/builder) 32 | * A [builder pattern example in Java](https://www.digitalocean.com/community/tutorials/builder-design-pattern-in-java) 33 | 34 | 35 | ## UML Diagram Notation 36 | 37 | * [UML Sequence Diagrams](https://www.uml-diagrams.org/sequence-diagrams.html) 38 | * [UML Component Diagrams](https://www.uml-diagrams.org/component-diagrams.html) 39 | * [UML Deployment Diagrams](https://www.uml-diagrams.org/deployment-diagrams-overview.html) 40 | 41 | 42 | ## GitHub Actions for Deployment to Azure App Services 43 | 44 | In case you want to read more detailed documentation on how to manually configure and setup a GitHub Actions workflow for deployment to Azure App Service, read the following official documentation documents from Microsoft and GitHub: 45 | 46 | * https://learn.microsoft.com/en-us/azure/app-service/deploy-github-actions 47 | * https://learn.microsoft.com/en-us/dotnet/architecture/devops-for-aspnet-developers/actions-deploy 48 | * https://docs.github.com/en/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service 49 | -------------------------------------------------------------------------------- /sessions/session_04/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! — Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Software Development](#1-software-development) 8 | - [2) Process](#2-process) 9 | - [3) Project Review 1](#3-project-review-1) 10 | - [4) Prepare for next session](#4-prepare-for-next-session) 11 | 12 | Remember, you have to perform work on each topic and on **each** bullet point. 13 | Be done with the project work before we meet again next Thursday. 14 | 15 | 16 | 17 | ## 1) Software Development 18 | 19 | ### 1.a) Refactor the CSV Database to a Web Service 20 | 21 | Implement two endpoints in your CSV database web service: `/cheep` and `/cheeps`. 22 | Sending a JSON object, e.g., of the form `{"Author":"ropf","Message":"Hello, World!", "Timestamp": 1684229348}` as the body of an HTTP POST request to the `/cheep` endpoint shall store the cheep in the remote database. 23 | An HTTP GET request to the `/cheeps` endpoint shall return all cheeps that are stored in the CSV database as a list of JSON objects. 24 | 25 | This is a refactoring step. 26 | That is, reuse suitable code from your current SimpleDB library project and move its functionality behind the web interface described above. 27 | 28 | 29 | ### 1.b) Refactor your _Chirp!_ CLI client to use the CSV Database Web Service 30 | 31 | Refactor your client application so that it uses the web service CSV database to store and read cheeps. 32 | That is, your _Chirp!_ CLI client shall now send HTTP `GET` and `POST` requests to the `/cheeps` and `/cheep` endpoint respectively. 33 | It shall not call the methods from your `SimpleDB` library project directly anymore. 34 | 35 | Do this refactoring in small steps: 36 | 37 | #### Make both the CSV Database Web Service and the _Chirp!_ CLI client work on `localhost` 38 | 39 | Make sure that the CSV database web service and the refactored _Chirp!_ CLI client work together as intended when both are executed on `localhost`. 40 | 41 | #### Adapt your test suite 42 | 43 | Adapt your unit, integration and end-to-end tests from last week's exercise so that they test the _Chirp!_ application with its new architecture. 44 | 45 | Suitable integration tests for the CSV Database Web Service are likely: 46 | 47 | a) When you send an HTTP `GET` request to the `/cheeps` endpoint the status code of the HTTP response is `200` and the response body contains a list of `Cheep` objects serialized to JSON. 48 | b) When you send an HTTP `POST` request to the `/cheep` endpoint with a request body containing a JSON serialized `Cheep` object, you receive `200` as status code of the HTTP response. 49 | 50 | Depending on your test cases of the CLI client, they will likely change only slightly compared to last week. 51 | But likely all `Read` and `Store` method calls of your `SimpleDB` library are replaced by respective HTTP calls. 52 | 53 | #### Deploy your CSV Database Web Service manually to Azure 54 | 55 | Once you are sure that your CSV Database Web Service and _Chirp!_ CLI client can operate as intended on your local computer, manually deploy the CSV Database Web Service to Azure App Services. Do that as in class via: 56 | 57 | ```bash 58 | az login 59 | az webapp up --sku F1 --name bdsagroupchirpremotedb --os-type Linux --location westeurope --runtime DOTNETCORE:7.0 60 | ``` 61 | 62 | **OBS**: replace `` in the `--name` option above with the number of your group **before** executing the command. 63 | 64 | Manually test if your client works together with the remote database when configured with the respective URL. 65 | That is, your client application has to send requests to the newly deployed web service (under URL `https://bdsagroupchirpremotedb.azurewebsites.net/`), not to a web service running on `localhost`. 66 | Note, that you can retrieve the correct URL from the output of above command. 67 | 68 | Additionally, from now on cheeps are no longer stored in a local CSV file on your computer but on the remote service hosted on Azure App Services. 69 | 70 | |:warning:| **Do not** interfere with the CSV Database Web Services from other groups! That is, do not send cheeps to be stored in another group's database!| 71 | |---------|------------------------------------| 72 | 73 | Once you verified that your client can interact with the CSV Database Web Service, shutdown that service with the following commands. The reason is, that you are configuring automatic deployment in the next task. 74 | 75 | ```bash 76 | az webapp delete 77 | az logout 78 | ``` 79 | 80 | ## 2) Process 81 | 82 | ### 2.a) Add Automatic Deployment of your CSV Database Web Service 83 | 84 | Add automatic deployments of your refactored CSV database to Azure App Services as a GitHub Action. 85 | Likely the easiest way to configure a respective GitHub Actions workflow, is by registering the web service once on Azure App Services in the following way: 86 | An illustrated guide of the following steps is accessible [here](https://app.tango.us/app/workflow/Creating-a-Remote-Azure-Database-for--NET-7--STS--on-Linux-with-Deployment-Center-cd9c4e3977184b7fb2a7e2d239e4d54f): 87 | 88 | * Log onto 89 | * Click the following sequence: top tab `App Services` → `+ Create` → choose `Web App` 90 | * Set `Name` to `bdsagroupchirpremotedb`, where `` has to be replaced with the number of your group. 91 | * Set `Region` to `North Europe` 92 | * Set `Runtime stack` to `.NET 7 (STS)` 93 | * Choose `Operating system` `Linux` 94 | * Choose `Pricing Plan` `Free F1 (Shared infrastructure)` 95 | * In the bottom, click the button `Review + create` 96 | * After checking that all configuration is as expected, click the button `Create` in the bottom 97 | 98 | * After reading a message saying _"`Your deployment is complete`"_, click `Go to resource` 99 | * On the left choose `Deployment Center` 100 | * Under `Source`, select `GitHub` 101 | * Click `Authorize` 102 | * Now choose organization (for you, it is your GitHub organization, i.e., `ITU-BDSA2024-GROUP`), your repository (`Chirp`) and the `main` branch 103 | * Finish by clicking the `Save` button on the top 104 | 105 | The last steps automatically create and store a GitHub Actions workflow in your repository and it automatically configures the required environment variables and secrets on GitHub. 106 | 107 | In case your project is organized into `src` and `test` directories, you have to point the build and publish commands to the right projects in the repository: 108 | - Change lines 25 - 29 to: 109 | ```yaml 110 | - name: Build with dotnet 111 | run: dotnet build src// --configuration Release 112 | 113 | - name: dotnet publish 114 | run: dotnet publish src// -c Release -o ${{env.DOTNET_ROOT}}/myapp 115 | ``` 116 | 117 | After successful execution of the workflow, the app is available under: `https://bdsagroupchirpremotedb.azurewebsites.net/` 118 | 119 | ### 2.b) Continue Automatic Releases of your _Chirp!_ CLI Clients 120 | 121 | Continue to automatically release new versions of the CLI client. That is, now release at least one new version of the _Chirp!_ CLI client that is able to interact with your CSV Database Web Service. 122 | 123 | Note, while all project groups are discouraged to interact with other group's CSV Database Web Services, be prepared for that the teachers or TAs send a small amount of `Cheeps` and want to read a small amount of these too. 124 | 125 | ## 3) Project Review 1 126 | 127 | Prepare for the first project review next week. 128 | Be prepared to demonstrate and inspect with the assigned TA: 129 | * How you build, test, and deploy your projects 130 | * The current state of your project, i.e., local CLI based clients that talk to a web service database or that interact with a local `SimpleDB` CSV database. 131 | 132 | In case you cannot meet with the TA who is assigned to your group, let her know well in advance that you cannot and reschedule to meeting to another suitable time slot! 133 | 134 | ## 4) Prepare for next session 135 | 136 | Next session, we need that you have the `sqlite3` CLI program installed. 137 | Do that on the terminal as described in the following: 138 | 139 | - On WSL and Linux: `sudo apt install sqlite3` 140 | - On MacOS `brew install sqlite3` 141 | -------------------------------------------------------------------------------- /sessions/session_04/images/client_server_comp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/client_server_comp.png -------------------------------------------------------------------------------- /sessions/session_04/images/client_server_comp_db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/client_server_comp_db.png -------------------------------------------------------------------------------- /sessions/session_04/images/client_server_seq.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/client_server_seq.png -------------------------------------------------------------------------------- /sessions/session_04/images/client_server_seq_db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/client_server_seq_db.png -------------------------------------------------------------------------------- /sessions/session_04/images/db_schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/db_schema.png -------------------------------------------------------------------------------- /sessions/session_04/images/deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/deployment.png -------------------------------------------------------------------------------- /sessions/session_04/images/inspector.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/inspector.png -------------------------------------------------------------------------------- /sessions/session_04/images/middleware.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/middleware.png -------------------------------------------------------------------------------- /sessions/session_04/images/multi_clients_server_comp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_04/images/multi_clients_server_comp.png -------------------------------------------------------------------------------- /sessions/session_05/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/.gitkeep -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | // Use IntelliSense to find out which attributes exist for C# debugging 6 | // Use hover for the description of the existing attributes 7 | // For further information visit https://github.com/dotnet/vscode-csharp/blob/main/debugger-launchjson.md 8 | "name": ".NET Core Launch (console)", 9 | "type": "coreclr", 10 | "request": "launch", 11 | "preLaunchTask": "build", 12 | // If you have changed target frameworks, make sure to update the program path. 13 | "program": "${workspaceFolder}/bin/Debug/net7.0/Chirp.SQLite.dll", 14 | "args": [], 15 | "cwd": "${workspaceFolder}", 16 | // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console 17 | "console": "internalConsole", 18 | "stopAtEntry": false 19 | }, 20 | { 21 | "name": ".NET Core Attach", 22 | "type": "coreclr", 23 | "request": "attach" 24 | } 25 | ] 26 | } -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "build", 6 | "command": "dotnet", 7 | "type": "process", 8 | "args": [ 9 | "build", 10 | "${workspaceFolder}/Chirp.SQLite.csproj", 11 | "/property:GenerateFullPaths=true", 12 | "/consoleloggerparameters:NoSummary" 13 | ], 14 | "problemMatcher": "$msCompile" 15 | }, 16 | { 17 | "label": "publish", 18 | "command": "dotnet", 19 | "type": "process", 20 | "args": [ 21 | "publish", 22 | "${workspaceFolder}/Chirp.SQLite.csproj", 23 | "/property:GenerateFullPaths=true", 24 | "/consoleloggerparameters:NoSummary" 25 | ], 26 | "problemMatcher": "$msCompile" 27 | }, 28 | { 29 | "label": "watch", 30 | "command": "dotnet", 31 | "type": "process", 32 | "args": [ 33 | "watch", 34 | "run", 35 | "--project", 36 | "${workspaceFolder}/Chirp.SQLite.csproj" 37 | ], 38 | "problemMatcher": "$msCompile" 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/Chirp.SQLite.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net$(NETCoreAppMaximumVersion) 6 | enable 7 | enable 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/Program.cs: -------------------------------------------------------------------------------- 1 | using System.Data; 2 | using Microsoft.Data.Sqlite; 3 | 4 | var sqlDBFilePath = "/tmp/chirp.db"; 5 | var sqlQuery = @"SELECT * FROM message ORDER by message.pub_date desc"; 6 | 7 | using (var connection = new SqliteConnection($"Data Source={sqlDBFilePath}")) 8 | { 9 | connection.Open(); 10 | 11 | var command = connection.CreateCommand(); 12 | command.CommandText = sqlQuery; 13 | 14 | using var reader = command.ExecuteReader(); 15 | while (reader.Read()) 16 | { 17 | // https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqldatareader?view=dotnet-plat-ext-7.0#examples 18 | var dataRecord = (IDataRecord)reader; 19 | for (int i = 0; i < dataRecord.FieldCount; i++) 20 | Console.WriteLine($"{dataRecord.GetName(i)}: {dataRecord[i]}"); 21 | 22 | // See https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqldatareader.getvalues?view=dotnet-plat-ext-7.0 23 | // for documentation on how to retrieve complete columns from query results 24 | Object[] values = new Object[reader.FieldCount]; 25 | int fieldCount = reader.GetValues(values); 26 | for (int i = 0; i < fieldCount; i++) 27 | Console.WriteLine($"{reader.GetName(i)}: {values[i]}"); 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/data/dump.sql: -------------------------------------------------------------------------------- 1 | INSERT INTO user VALUES(1,'Helge','ropf@itu.dk'); 2 | INSERT INTO user VALUES(2,'Adrian','adho@itu.dk'); 3 | 4 | INSERT INTO message VALUES(1,1,'Hello, BDSA students!',1690892208); 5 | INSERT INTO message VALUES(2,2,'Hej, velkommen til kurset.',1690895308); 6 | -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/data/schema.sql: -------------------------------------------------------------------------------- 1 | drop table if exists user; 2 | create table user ( 3 | user_id integer primary key autoincrement, 4 | username string not null, 5 | email string not null 6 | ); 7 | 8 | drop table if exists message; 9 | create table message ( 10 | message_id integer primary key autoincrement, 11 | author_id integer not null, 12 | text string not null, 13 | pub_date integer 14 | ); 15 | -------------------------------------------------------------------------------- /sessions/session_05/Chirp.SQLite/scripts/initDB.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | sqlite3 /tmp/chirp.db < data/schema.sql 3 | sqlite3 /tmp/chirp.db < data/dump.sql 4 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/DIExample.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net7.0 5 | enable 6 | enable 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/DirectDependency.cs: -------------------------------------------------------------------------------- 1 | namespace DirectDependencyExample; 2 | public class Informer 3 | { 4 | private readonly DIExample.Writer.StdIoWriter _messageWriter = new(); 5 | public void Inform(string message) => _messageWriter.Write(message); 6 | } 7 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/InjectedDependency.cs: -------------------------------------------------------------------------------- 1 | namespace InjectedDependencyExample; 2 | public class Informer 3 | { 4 | private readonly DIExample.Writer.IWriter _messageWriter; 5 | 6 | public Informer(DIExample.Writer.IWriter messageWriter) => _messageWriter = messageWriter; 7 | 8 | public void Inform(string message) => _messageWriter.Write(message); 9 | } 10 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/Program.cs: -------------------------------------------------------------------------------- 1 | var builder = WebApplication.CreateBuilder(args); 2 | var app = builder.Build(); 3 | 4 | app.MapGet("/a/{endpoint}", (string endpoint) => 5 | { 6 | var informer = new DirectDependencyExample.Informer(); 7 | informer.Inform(endpoint); 8 | }); 9 | 10 | app.MapGet("/b/{endpoint}", (string endpoint) => 11 | { 12 | var informer = new InjectedDependencyExample.Informer(new DIExample.Writer.StdIoWriter()); 13 | informer.Inform(endpoint); 14 | }); 15 | 16 | app.Run(); 17 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "iisSettings": { 3 | "windowsAuthentication": false, 4 | "anonymousAuthentication": true, 5 | "iisExpress": { 6 | "applicationUrl": "http://localhost:42770", 7 | "sslPort": 44309 8 | } 9 | }, 10 | "profiles": { 11 | "http": { 12 | "commandName": "Project", 13 | "dotnetRunMessages": true, 14 | "launchBrowser": true, 15 | "applicationUrl": "http://localhost:5163", 16 | "environmentVariables": { 17 | "ASPNETCORE_ENVIRONMENT": "Development" 18 | } 19 | }, 20 | "https": { 21 | "commandName": "Project", 22 | "dotnetRunMessages": true, 23 | "launchBrowser": true, 24 | "applicationUrl": "https://localhost:7173;http://localhost:5163", 25 | "environmentVariables": { 26 | "ASPNETCORE_ENVIRONMENT": "Development" 27 | } 28 | }, 29 | "IIS Express": { 30 | "commandName": "IISExpress", 31 | "launchBrowser": true, 32 | "environmentVariables": { 33 | "ASPNETCORE_ENVIRONMENT": "Development" 34 | } 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/Writer.cs: -------------------------------------------------------------------------------- 1 | namespace DIExample.Writer; 2 | 3 | public interface IWriter 4 | { 5 | public void Write(string message); 6 | } 7 | 8 | public class StdIoWriter : IWriter 9 | { 10 | public void Write(string message) => Console.WriteLine(message); 11 | } 12 | 13 | public class FileWriter : IWriter 14 | { 15 | public void Write(string message) 16 | { 17 | string docPath = Path.GetTempPath(); 18 | using StreamWriter outputFile = new(Path.Combine(docPath, "store.txt")); 19 | outputFile.WriteLine(message); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /sessions/session_05/DIExample/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | }, 8 | "AllowedHosts": "*" 9 | } 10 | -------------------------------------------------------------------------------- /sessions/session_05/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 05 2 | 3 | * Read chapters 13, 14, and 15 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | 5 | 6 | ## ASP.NET 7 | 8 | * [Intro to Razor Page applications](https://learn.microsoft.com/en-us/aspnet/core/tutorials/razor-pages/razor-pages-start?view=aspnetcore-7.0&tabs=visual-studio-code) (only this page is relevant for this week, the following become relevant next week) 9 | * [Use SQLite database](https://learn.microsoft.com/en-us/dotnet/standard/data/sqlite/?tabs=netcore-cli) 10 | 11 | 12 | ## Testing 13 | 14 | * [Integration tests of Razor Page Applications](https://learn.microsoft.com/en-us/aspnet/core/test/integration-tests?view=aspnetcore-7.0) 15 | 16 | 17 | ## GitHub 18 | 19 | * [Creating a pull request from one branch to another](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) 20 | * [Requesting a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) 21 | -------------------------------------------------------------------------------- /sessions/session_05/SimpleHTMLServer/Program.cs: -------------------------------------------------------------------------------- 1 | var builder = WebApplication.CreateBuilder(args); 2 | var app = builder.Build(); 3 | 4 | var htmlText = @"

Hello World!

5 | I am an HTML document from the ITU BDSA course. 6 | "; 7 | app.Map("/", () => Results.Content(htmlText, "text/html")); 8 | 9 | app.Run(); 10 | -------------------------------------------------------------------------------- /sessions/session_05/SimpleHTMLServer/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "iisSettings": { 3 | "windowsAuthentication": false, 4 | "anonymousAuthentication": true, 5 | "iisExpress": { 6 | "applicationUrl": "http://localhost:18780", 7 | "sslPort": 44384 8 | } 9 | }, 10 | "profiles": { 11 | "http": { 12 | "commandName": "Project", 13 | "dotnetRunMessages": true, 14 | "launchBrowser": true, 15 | "applicationUrl": "http://localhost:5181", 16 | "environmentVariables": { 17 | "ASPNETCORE_ENVIRONMENT": "Development" 18 | } 19 | }, 20 | "https": { 21 | "commandName": "Project", 22 | "dotnetRunMessages": true, 23 | "launchBrowser": true, 24 | "applicationUrl": "https://localhost:7216;http://localhost:5181", 25 | "environmentVariables": { 26 | "ASPNETCORE_ENVIRONMENT": "Development" 27 | } 28 | }, 29 | "IIS Express": { 30 | "commandName": "IISExpress", 31 | "launchBrowser": true, 32 | "environmentVariables": { 33 | "ASPNETCORE_ENVIRONMENT": "Development" 34 | } 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /sessions/session_05/SimpleHTMLServer/SimpleHTMLServer.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net$(NETCoreAppMaximumVersion) 5 | enable 6 | enable 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /sessions/session_05/SimpleHTMLServer/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /sessions/session_05/SimpleHTMLServer/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | }, 8 | "AllowedHosts": "*" 9 | } 10 | -------------------------------------------------------------------------------- /sessions/session_05/data/schema.sql: -------------------------------------------------------------------------------- 1 | drop table if exists user; 2 | create table user ( 3 | user_id integer primary key autoincrement, 4 | username string not null, 5 | email string not null, 6 | pw_hash string not null 7 | ); 8 | 9 | drop table if exists message; 10 | create table message ( 11 | message_id integer primary key autoincrement, 12 | author_id integer not null, 13 | text string not null, 14 | pub_date integer 15 | ); 16 | -------------------------------------------------------------------------------- /sessions/session_05/images/accross_pkg_dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/accross_pkg_dep.png -------------------------------------------------------------------------------- /sessions/session_05/images/direct_dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/direct_dep.png -------------------------------------------------------------------------------- /sessions/session_05/images/inversed_dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/inversed_dep.png -------------------------------------------------------------------------------- /sessions/session_05/images/simpledb_deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/simpledb_deployment.png -------------------------------------------------------------------------------- /sessions/session_05/images/sqlite_deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/sqlite_deployment.png -------------------------------------------------------------------------------- /sessions/session_05/images/ssr_sq.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_05/images/ssr_sq.png -------------------------------------------------------------------------------- /sessions/session_05/scripts/initDB.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | sqlite3 /tmp/chirp.db < data/schema.sql 3 | sqlite3 /tmp/chirp.db < data/dump.sql 4 | -------------------------------------------------------------------------------- /sessions/session_06/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/.gitkeep -------------------------------------------------------------------------------- /sessions/session_06/Feedback.md: -------------------------------------------------------------------------------- 1 | --- 2 | theme: gaia 3 | _class: lead 4 | paginate: true 5 | backgroundColor: #fff 6 | backgroundImage: url('https://marp.app/assets/hero-background.svg') 7 | footer: '![width:300px](https://github.com/itu-bdsa/lecture_notes/blob/main/images/banner.png?raw=true)' 8 | headingDivider: 2 9 | marp: true 10 | style: | 11 | section { 12 | font-size: 25px; 13 | } 14 | container { 15 | height: 300px; 16 | width: 100%; 17 | display: block; 18 | justify-content: right; 19 | text-align: right; 20 | } 21 | header { 22 | float: right; 23 | } 24 | 25 | a { 26 | color: blue; 27 | text-decoration: underline; 28 | background-color: lightgrey; 29 | font-size: 80%; 30 | } 31 | 32 | table { 33 | font-size: 22px; 34 | } 35 | --- 36 | 37 | # **Analysis, Design and Software Architecture (BDSA)** 38 | Session 6 — Feedback 39 | [Helge Pfeiffer](ropf@itu.dk) 40 | 41 | 42 | ## Feedback 43 | 44 | 45 | 46 | All groups are working on their projects. 47 | Super cool! 48 | 49 | 50 | ## Feedback 51 | 52 | 53 | 54 | 55 | ## Read carefully: follow URL specification! 56 | 57 | Timelines of users should appear under the endpoint with the name of the user. 58 | 59 | 60 | > For example, given the [example database dump](./data/dump.sql), a response body for a `GET` request send to `/Helge` shall contain a cheep written by `Helge` and the content of a cheep shall be `Hello, BDSA students!` 61 | > Similarly, a response body for a `GET` request send to `/Adrian` shall contain a cheep written by `Adrian` with the content `Hej, velkommen til kurset.` 62 | > 63 | > [1.c) Add initial testing](../session_05/README_PROJECT.md) 64 | 65 | That is, for example `/Author/Helge` is another endpoint. 66 | 67 | 68 | ## Feedback 69 | 70 | - Have **one** main branch called `main`. 71 | - Remember, we do trunk-based development in this course. That is, you do not have a long-lived `dev` branch (as in last semester's project). That would be another branching strategy. 72 | - You have short-lived feature branches. That is, at latest after a day your changes land on the main branch and thereby automatically in production (your deployment workflows deploy all changes from main, right?) 73 | 74 | What do we do if we cannot finish our feature during a day? 75 | 76 | - Good observation, that means likely that your task descriptions in your issues are too coarse grained. Over time you should train to make them smaller so that you can complete your tasks in max. a day. 77 | 78 | 79 | ## Feedback 80 | 81 | - Have **one** main branch called `main`. 82 | - It is not advisable to have a `main2.0` branch. 83 | - Likely, it is also not a good idea to call a branch `origin` since it is confusing when pointing to remote repositories in git commands. 84 | 85 | 86 | ## Process: Scientific problem solving 87 | 88 | Our software does not work as intended: What to do? 89 | 90 | > 1. Identify the problem 91 | > 2. Gather information 92 | > 3. Iterate potential solutions 93 | > 4. Test your solution 94 | Source: E. Cain 4 steps to solving any software problem 95 | 96 | 97 | 98 | ## Azure App Service: Reading the Logs 99 | 100 | One way to identify the problem for depolyed web-applications: read the logs 101 | 102 | ![w:1000px](images/azure_logs.png) 103 | 104 | 105 | ## Data Transfer Objects, what are these? 106 | 107 | > A Data Transfer Object is an object that is used to encapsulate data, and send it from one subsystem of an application to another. 108 | > 109 | > DTOs are most commonly used by the Services layer in an N-Tier application to transfer data between itself and the UI layer. 110 | > 111 | > [StackOverflow Question](https://stackoverflow.com/questions/1051182/what-is-a-data-transfer-object-dto) 112 | 113 | 114 | ## Data Transfer Objects (DTOs)? 115 | 116 | > Right now, our web API exposes the database entities to the client. The client receives data that maps directly to your database tables. However, that's not always a good idea. Sometimes you want to change the shape of the data that you send to client. For example, you might want to: 117 | > 118 | > - Remove circular references [...]. 119 | > - Hide particular properties that clients are not supposed to view. 120 | > - Omit some properties in order to reduce payload size. 121 | > - Flatten object graphs that contain nested objects, to make them more convenient for clients. 122 | > - Avoid "over-posting" vulnerabilities. [...] 123 | > - Decouple your service layer from your database layer. 124 | > 125 | > [Microsoft Documentation](https://learn.microsoft.com/en-us/aspnet/web-api/overview/data/using-web-api-with-entity-framework/part-5) 126 | 127 | 128 | ## Next Week: Guest Lecture 129 | 130 | ![bg right](https://www.twobirds.com/-/media/twobirdssite/people/lawyers/photos/denmark/martin-vonhaller/martin-vonhaller-mobile.jpg?h=435&iar=0&w=750&hash=2F2B45E76908434DCF00E39834D8F4C2) 131 | 132 | [Martin von Haller Grønbæk](https://www.twobirds.com/en/people/m/martin-von-haller-groenbaek), one of Denmark's leading IT lawyers, will give a guest lecture on _Software Licenses and Software License Compatibility_. 133 | 134 | The lecture will start at 11:00 (sharp) in Auditorium 1. So be there on time, best 10:50. 135 | After his guest lecture, Martin will be available for deeper questions and discussions in the canteen (12:00 - 12:30). 136 | -------------------------------------------------------------------------------- /sessions/session_06/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 06 2 | 3 | * Read chapter 12 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | 5 | ## ASP.NET Core 6 | 7 | * [Intro to Razor Page applications](https://learn.microsoft.com/en-us/aspnet/core/tutorials/razor-pages/razor-pages-start?view=aspnetcore-7.0&tabs=visual-studio-code) 8 | * [Getting Started with EF Core](https://learn.microsoft.com/en-us/ef/core/get-started/overview/first-app?tabs=netcore-cli) 9 | * [EF Core with Razor Pages](https://learn.microsoft.com/en-us/aspnet/core/data/ef-rp/intro?view=aspnetcore-7.0&tabs=visual-studio) 10 | * [Repository pattern](https://learn.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/infrastructure-persistence-layer-design) 11 | * On Data Transfer Objects: 12 | - [A blog post explaining DTO's in ASP.Net Razor Pages](https://www.nilebits.com/blog/2024/02/aspnet-mvc-data-transfer-objects/) 13 | - [DTOs in a WebAPI example](https://learn.microsoft.com/en-us/aspnet/web-api/overview/data/using-web-api-with-entity-framework/part-5) 14 | - [What is a DTO?](https://stackoverflow.com/questions/1051182/what-is-a-data-transfer-object-dto) 15 | -------------------------------------------------------------------------------- /sessions/session_06/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Software Development](#1-software-development) 8 | - [2) Process](#2-process) 9 | 10 | Remember, you have to perform work on each topic and on **each** bullet point. 11 | Be done with the project work before we meet again next week. 12 | 13 | 14 | ## 1) Software Development 15 | 16 | Refactor `Chirp.Razor` away from direct SQLite access to EF Core 17 | 18 | After this session, we realized that our direct dependence on SQLite and its dialect of SQL is less optimal. 19 | Consequently, refactor your `Chirp.Razor` application to use EF Core instead of SQLite directly. 20 | However, continue to use SQLite as your underlying database. 21 | 22 | The functionality of your `Chirp.Razor` application will not be different compared to last week. 23 | That is, you have an application that can display public and private timelines, both of which are paginated to 32 cheeps per page. 24 | 25 | ### 1.a) Data Model 26 | 27 | Create a data model for your `Chirp.Razor` application. 28 | In the end, your data model shall consist of two classes: `Cheep` and `Author`. 29 | For now, an author has a `Name` and an `Email` address (both of which are strings). 30 | A `Cheep` contains a `Text` and a `TimeStamp`, where the former is a string and the latter is a `DateTime`. 31 | Additionally, each `Cheep` refers to its `Author` and each `Author` keeps a reference to all its `Cheeps`. 32 | 33 | Note, we intend you to implement this data model by hand as two classes as in the in-class task. 34 | That is, we do not want you to convert last week's SQL schema into a data model via automatic tooling. 35 | 36 | ### 1.b) Repository Pattern 37 | 38 | Implement the _Repository_ pattern in your application. 39 | Likely, you will create a `CheepRepository`, which gathers information about the cheeps that your application displays in timelines. 40 | Configure the ASP.NET DI container (dependency injection container) so that instances of `CheepRepository` are injected into your application wherever needed. 41 | That is, none of your views, services, etc. has a direct dependency onto `CheepRepository`. 42 | 43 | ### 1.c) Data Transfer Objects (DTOs) 44 | 45 | The information that your application receives from the `CheepRepository` is more rich than what your application needs to display to users. 46 | Consequently, create DTOs that transport information to your views. 47 | Usually, it is advisable that DTOs consist of fields of predefined types only, i.e., `int`, `strings`, etc. `DateTime` is not a predefined type. 48 | 49 | ### 1.d) Seeding the database with example data. 50 | 51 | Use the file [`DbInitializer.cs`](./data/DbInitializer.cs) to import example data into you `Chirp.Razor` application on application start. 52 | 53 | This file becomes part of your project. 54 | That is, your deployed `Chirp.Razor` application on Azure App Services is always seeded with at least this information. 55 | Whenever we access your applications, we expect to find at least the cheeps written by the authors in that file. 56 | 57 | Right after creating your database context object, which we assume to be called `ChirpDBContext`, you can call the only method from `DbInitializer.cs` to seed the example data into your application. 58 | 59 | 60 | ## 2) Process 61 | 62 | ### 2.a) Scientific problem solving 63 | 64 | Do not start programming directly. 65 | Instead, follow the advice from the lecture and start by identification of the problem at hand, i.e., what is the task to be solved, what is the issue, etc. 66 | Now that you identified a problem, do not start programming yet. 67 | Instead, gather information. 68 | For all tasks, it is likely advisable to check the lecture notes, the reading material, and in particular the book for relevant information. 69 | All these sources contain building blocks for your solution. 70 | First now, implement a potential solution that addresses the task at hand. 71 | Evaluate via manual and automated tests if the solution you implemented suitably solves the problem, task, etc. 72 | If not, iterate over this cycle, i.e., problem identification, information gathering, implementation of potential solutions, testing of solutions. 73 | 74 | ### 2.b) Continuous Deployment 75 | 76 | Continue to release and deploy automatically. 77 | That is, during the next weeks, you bring **multiple** new versions `Chirp.Razor` into production, i.e., you deploy them automatically to Azure App Service. 78 | The latest version of the application in production is always the latest version of the application in your main branch. 79 | You decide if it is the latest tagged version or the latest committed version, i.e., if your workflow is triggered by pushes to main or pushes of tags. 80 | 81 | Likely, you have a respective GitHub Actions workflow already from last week. 82 | If not, this task is here to signal that it is high time creating a working deployment workflow. 83 | -------------------------------------------------------------------------------- /sessions/session_06/images/.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/.png -------------------------------------------------------------------------------- /sessions/session_06/images/EF-Core.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/EF-Core.png -------------------------------------------------------------------------------- /sessions/session_06/images/ORM-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/ORM-overview.png -------------------------------------------------------------------------------- /sessions/session_06/images/Repository.svg: -------------------------------------------------------------------------------- 1 | Chat.RepositoryIMessageRepositoryCreateMessage(newMessage : MessageDTO) : TaskReadMessages(userName : string) : Task<List<MessageDTO>>UpdateMessage(alteredMessage : MessageDTO) : TaskMessageRepository... -------------------------------------------------------------------------------- /sessions/session_06/images/azure_logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/azure_logs.png -------------------------------------------------------------------------------- /sessions/session_06/images/banner-transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/banner-transparent.png -------------------------------------------------------------------------------- /sessions/session_06/images/commit_freqs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/commit_freqs.png -------------------------------------------------------------------------------- /sessions/session_06/images/domain_model.svg: -------------------------------------------------------------------------------- 1 | UserUserId: intName: stringMessages: ICollection<Message>MessageMessageId: intUserId: intText: stringUser: User0..*1 -------------------------------------------------------------------------------- /sessions/session_06/images/repository-pattern.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/repository-pattern.png -------------------------------------------------------------------------------- /sessions/session_06/images/unit-of-work.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_06/images/unit-of-work.png -------------------------------------------------------------------------------- /sessions/session_07/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/.gitkeep -------------------------------------------------------------------------------- /sessions/session_07/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 07 2 | 3 | * Read chapters 8, 9, 10, 12, 35, and 36 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | 5 | 6 | ## EF Core 7 | 8 | - [Creating and Configuring a Model in EF Core](https://learn.microsoft.com/en-us/ef/core/modeling/) 9 | - [Use data annotations to configure a model](https://learn.microsoft.com/en-us/ef/core/modeling/#use-data-annotations-to-configure-a-model) 10 | - [Indexes and constraints](https://learn.microsoft.com/en-us/ef/core/modeling/indexes?tabs=data-annotations) 11 | - [Entity Properties](https://learn.microsoft.com/en-us/ef/core/modeling/entity-properties) 12 | 13 | 14 | ## Architecture 15 | 16 | - [Common web application architectures](https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/common-web-application-architectures) 17 | - [Clean Architecture](https://github.com/ardalis/CleanArchitecture/) 18 | - [Command–query separation](https://en.wikipedia.org/wiki/Command–query_separation) 19 | - [CQS versus server generated IDs](https://blog.ploeh.dk/2014/08/11/cqs-versus-server-generated-ids/) 20 | - [Command Query Separation when Queries should have side-effects](https://blog.ploeh.dk/2015/10/08/command-query-separation-when-queries-should-have-side-effects/) 21 | - [CQRS](https://www.martinfowler.com/bliki/CQRS.html) 22 | 23 | 24 | ## Razor Page Applications with EF Core 25 | 26 | - [Razor Pages with Entity Framework Core in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/data/ef-rp/intro?view=aspnetcore-7.0&tabs=visual-studio-code) 27 | 28 | 29 | ## Testing 30 | 31 | * Testing of ASP Chapters 35 and 36 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 32 | * [Unit testing of ASP.NET Core Razor Pages Applications](https://learn.microsoft.com/en-us/aspnet/core/test/razor-pages-tests?view=aspnetcore-7.0) 33 | * [Testing with in-memory database](https://learn.microsoft.com/en-us/ef/core/testing/testing-without-the-database) 34 | * [Integration tests of Razor Page Applications](https://learn.microsoft.com/en-us/aspnet/core/test/integration-tests?view=aspnetcore-7.0) 35 | * [Alternative to testing with in-memory SQLite database](https://learn.microsoft.com/en-us/ef/core/testing/choosing-a-testing-strategy) 36 | 37 | 38 | ## Choosing a Software License 39 | 40 | * [Overview of some potential software licenses](https://choosealicense.com/appendix/) 41 | * [How to add a license to a GitHub project](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) 42 | * [Overview of license compatibility](https://en.wikipedia.org/w/index.php?title=License_compatibility§ion=3#Compatibility_of_FOSS_licenses) 43 | -------------------------------------------------------------------------------- /sessions/session_07/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Software Development](#1-software-development) 8 | - [2) Process](#2-process) 9 | - [3) Project Review 2](#3-project-review-2) 10 | 11 | 12 | Remember, you have to perform work on each topic and on **each** bullet point. 13 | Be done with the project work before we meet again next week. 14 | 15 | 16 | ## 1) Software Development 17 | 18 | **Note**: You may want to perform these steps in a different order - or simultaneously for some. 19 | 20 | ### 1.a) Use In-memory SQLite Database for Testing 21 | 22 | As we realized during the last weeks, a direct dependency to a certain database is not advisable when running test suites. 23 | 24 | Consequently, configure your integration test suite so that it uses an in-memory SQLite database for testing. 25 | 26 | ### 1.b) Extend Your Repositories 27 | 28 | Expose methods in your repositories (OBS: that includes the respective interfaces) that enable to: 29 | 30 | - Find `Author` by `name` 31 | - Find `Author` by `email` 32 | - Create a new `Author` 33 | 34 | - If not implemented already, retrieve `cheeps` for a certain page. 35 | - If not implemented already, retrieve `cheeps` for a certain page that are written by a certain `Author` who is identified by `name` 36 | - Create a new `cheep`. Note, that might mean to also create a respective author if she does not exist yet in _Chirp!_. 37 | 38 | ### 1.c) Constrain Length of Cheeps 39 | 40 | Constrain cheeps so that only cheeps of length 160 characters are considered valid. 41 | Your _Chirp!_ application should not accept cheeps that are longer than 160 character. 42 | Such cheeps should never be stored to the database. 43 | 44 | Using the mechanisms presented by Adrian, ensure that only `cheep`s up to 160 characters length can be stored. 45 | 46 | ### 1.d) Add Unit Tests 47 | 48 | Now, that you have decoupled your data persistence code properly from your application, augment your test suite from last time. 49 | 50 | Implement a set of unit tests for suitable functionality, e.g., all of the repository methods from the task above, data conversion, etc. 51 | 52 | ### 1.e) Command Query Separation 53 | 54 | Ensure that the methods that are exposed in your repositories follow are separated into commands and queries: 55 | 56 | > Separate Commands from Queries. Commands are procedures that have side effects. Queries are functions that return data. Every method should be either a Command or a Query, but not both. 57 | Source: Mark Seemann "Code That Fits in Your Head" 58 | 59 | 60 | ### 1.f) Onion Architecture 61 | 62 | Refactor your projects into an onion architecture, as seen in class. 63 | That is, in your `src` directory, create a `Chirp.Core` project that contains your DTOs, Repository interface(s), etc., a `Chirp.Infrastucture` project that contains you Repositorie(s), data model, database context, etc., and a `Chirp.Web` project that contains the actual Razor Page application 64 | 65 | ### 1.g) Warnings 66 | 67 | Ensure that your project builds without any warnings. 68 | That is, make sure that *all* warnings in your code are addressed. 69 | 70 | 71 | ## 2) Process 72 | 73 | ### 2.a) Choose a license for your _Chirp!_ project. 74 | 75 | Choose a license for your _Chirp!_ project. 76 | If in doubt about which license might be suitable for your project, consult [choosealicense.com](https://choosealicense.com/) 77 | 78 | Make sure that you can choose the license you want to choose with the dependencies that you declare in your `.csproj` file. 79 | For license compatibility, consider the overview from a [corresponding Wikipedia article](https://en.wikipedia.org/w/index.php?title=License_compatibility§ion=3#Compatibility_of_FOSS_licenses): 80 | 81 | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/2/2b/Floss-license-slide-image.svg/2880px-Floss-license-slide-image.svg.png) 82 | 83 | Place the license text in a file `LICENSE.md`, which you place in the root directory of your project on the main branch. 84 | See [GitHub's documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) on how to add a license to an existing project. 85 | 86 | ### 2.b) Continue to Release 87 | 88 | Continue to release and deploy automatically. 89 | That is, whenever you deploy automatically, you also create a new release. 90 | Meaning, the latest version of the application in production is always the latest version of the application in your main branch. 91 | You decide if it is the latest tagged version or the latest committed version, i.e., if your workflow is triggered by pushes to main or pushes of tags. 92 | 93 | This task is not asking for any new functionality. 94 | Just for that you continue to release automatically as during the last weeks. 95 | 96 | 97 | ## 3) Project Review 2 98 | 99 | Prepare for the second project review (week 43, the week after fall break). 100 | Be prepared to demonstrate and inspect with the assigned TA: 101 | * How you build, test, and deploy your projects 102 | * The current state of your project 103 | 104 | In case you cannot meet with the TA who is assigned to your group, let him know well in advance that you cannot and reschedule to meeting to another suitable time slot! 105 | -------------------------------------------------------------------------------- /sessions/session_07/images/banner-transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/banner-transparent.png -------------------------------------------------------------------------------- /sessions/session_07/images/domain_model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/domain_model.png -------------------------------------------------------------------------------- /sessions/session_07/images/domain_model_constrained.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/domain_model_constrained.png -------------------------------------------------------------------------------- /sessions/session_07/images/entity-framework-core.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/entity-framework-core.jpg -------------------------------------------------------------------------------- /sessions/session_07/images/fake-provider-and-repository-pattern.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/fake-provider-and-repository-pattern.png -------------------------------------------------------------------------------- /sessions/session_07/images/onion_architecture.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/onion_architecture.webp -------------------------------------------------------------------------------- /sessions/session_07/images/unit-of-work-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_07/images/unit-of-work-diagram.png -------------------------------------------------------------------------------- /sessions/session_08/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/.gitkeep -------------------------------------------------------------------------------- /sessions/session_08/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 08 2 | 3 | * Read chapters 23, 6, and 7 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | 5 | 6 | ## Introduction to OAuth 7 | 8 | * Read this [blog post](https://developer.okta.com/blog/2019/10/21/illustrated-guide-to-oauth-and-oidc) that describes how OAuth works. 9 | - Alternatively watch [this video](https://youtu.be/t18YB3xDfXI) that accompanyings the article. 10 |
11 | 19 |
20 | 21 | 22 | ## ASP.NET Core Identity and Authentication with Azure App Service 23 | 24 | * [Choose an identity management solution](https://learn.microsoft.com/en-us/aspnet/core/security/how-to-choose-identity-solution) 25 | 26 | * Tutorial [Introduction to Identity on ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/identity) 27 | 28 | * [Microsoft Entra ID with ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/azure-active-directory/) 29 | 30 | * [Authentication and authorization in Azure App Service and Azure Functions](https://learn.microsoft.com/en-us/azure/app-service/overview-authentication-authorization) 31 | 32 | * [Configure your App Service or Azure Functions app to use GitHub login](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-github) 33 | 34 | * [Handling of User Secrets](https://learn.microsoft.com/en-gb/aspnet/core/security/app-secrets) 35 | -------------------------------------------------------------------------------- /sessions/session_08/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [1) Software Development](#1-software-development) 8 | - [2) Process](#2-process) 9 | 10 | 11 | Remember, you have to perform work on each topic and on **each** bullet point. 12 | Be done with the project work before we meet again next week. 13 | 14 | 15 | ## 1) Software Development 16 | 17 | 18 | Add login functionality to your _Chirp!_ applications. 19 | You can do this in many ways and you decide how to do it. 20 | The following two sections (1.a) and 1.b)) discuss possible solutions. 21 | You choose which one you want to implement. 22 | 23 | In any of the cases, we want to have a navigation bar directly below the headline of every page in the _Chirp!_ `

Icon1Chirp!

` 24 | and on top of the list of cheeps that looks similar to the following. 25 | 26 | ![](images/chirp_before_auth.png) 27 | 28 | ![](images/chirp_after_auth.png) 29 | 30 | Such a navigation bar may be implemented in a Razor View via code similar to the following. 31 | 32 | ```html 33 |
34 | @if (User.Identity.IsAuthenticated) 35 | { 36 | 41 | } 42 | else 43 | { 44 |
45 | public timeline | 46 | register 47 | login 48 |
49 | } 50 |
51 | ``` 52 | 53 | In the CSS file that you have in your _Chirp!_ projects, there is a style for a navigation element, which you should use, e.g., `
`. 54 | In case a user is authenticated, the navigation bar should display links to `my timeline` (links to endpoint `/`), `public timeline` (links to endpoint `/`), and `logout`. 55 | In case a user is not authenticated, the navigation bar should display links to the `public timeline` (links to endpoint `/`), `register` and `login`. 56 | 57 | Note, the link to the register endpoint, likely something like `register`, is relevant for registering a user with ASP.NET Core Identity. That is, task 1.a). 58 | For task 1.b), you do not provide a register endpoint, since users register themselves at GitHub. 59 | 60 | 61 | ### 1.a) ASP.NET Core Identity 62 | 63 | A valuable resource when choosing this solution is chapter 23 of the course book Andrew Lock _ASP.NET Core in Action_. 64 | The first sections in it discuss ASP.NET Core Identity based on an example [from the official documentation](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/identity?view=aspnetcore-7.0&tabs=netcore-cli) 65 | Section 23.4 explains in detail how to add ASP.NET Core Identity to an existing Razor Page application, which in your case is your current _Chirp!_ application. 66 | Since the book details the required steps so nicely, I do not describe them here in more detail. 67 | 68 | Implement this option first, please make sure that two users, `Helge` and `Adrian` respectively can login to your _Chirp!_ applications. 69 | They should be able to do so using their email addresses (`ropf@itu.dk` and `adho@itu.dk` respectively). 70 | Helge wants to login with the password `LetM31n!` and Adrian wants to login with the password `M32Want_Access`. 71 | 72 | 73 | ### 1.b) OAuth via GitHub 74 | 75 | After implementing login functionality via ASP.NET Core Identity in task 1.a, add a second login possibility via GitHun OAuth. 76 | ASP.NET Core supports other [external authentication providers](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/social/?view=aspnetcore-7.0&tabs=visual-studio) too. 77 | But in this course, we would like that you choose GitHub as an external authentication provider. 78 | 79 | To do so, and since the book does not describe it, we provide the following information to guide your work: 80 | 81 | - [Configure your _Chirp!_ application as an OAuth application on GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) ([direct link to configuration](https://github.com/settings/applications/new)). 82 | - Note, do that for your GitHub organization not for your GitHub users. 83 | - Likely, you have to create _two_ OAuth applications on GitHub. 84 | - One for local development and testing (pointing to `localhost` URLs) and one for the actual application on Azure App Service. 85 | For example, if your application for local development runs on `http://localhost:5273/`, then a corresponding configuration could look as in the following:to adapt your `Program.cs` file 86 | ![](images/gh_oauth_local_config.png) 87 | For the deployed application at Azure App Service the Homepage URL fields become the URLs like `https://bdsa2024groupchirprazor.azurewebsites.net/`, where `` is replaced with your group's number. 88 | - Now, you have to add a package to your web-application project with a GitHub OAuth provider [`AspNet.Security.OAuth.GitHub`](https://www.nuget.org/packages/AspNet.Security.OAuth.GitHub) 89 | - It is likely the best starting point, to consider the [official example](https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers) and to adapt your `Program.cs` file accordingly: 90 | ```csharp 91 | builder.Services.AddAuthentication(options => 92 | { 93 | options.DefaultAuthenticateScheme = CookieAuthenticationDefaults.AuthenticationScheme; 94 | options.DefaultSignInScheme = CookieAuthenticationDefaults.AuthenticationScheme; 95 | options.DefaultChallengeScheme = "GitHub"; 96 | }) 97 | .AddCookie() 98 | .AddGitHub(o => 99 | { 100 | o.ClientId = builder.Configuration["authentication:github:clientId"]; 101 | o.ClientSecret = builder.Configuration["authentication:github:clientSecret"]; 102 | o.CallbackPath = "/signin-github"; 103 | }); 104 | ... 105 | app.UseAuthentication(); 106 | app.UseAuthorization(); 107 | app.UseSession(); 108 | ... 109 | ``` 110 | - Note, the [official example](https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers) stores secrets from GitHub directly in code. You should not do that! 111 | Instead store them as user-secrets for local development, see the [documentation on "Safe storage of app secrets in development in ASP.NET Core"](https://learn.microsoft.com/en-gb/aspnet/core/security/app-secrets?view=aspnetcore-7.0&tabs=linux") 112 | ``` 113 | dotnet user-secrets init 114 | dotnet user-secrets set "authentication:github:clientId" "" 115 | dotnet user-secrets set "authentication:github:clientSecret" "" 116 | ``` 117 | - Since you cannot register secrets via the `dotnet` command on Azure App Service, you have to configure them via the application settings: 118 | ![](images/oauth_azure_config.png) 119 | 120 | ### Hints: 121 | 122 | * You should _NEVER_ hardcode API secrets into your source code and upload them to your repository. They will be a part of your repository history and everyone with access to the repository can read them in cleartext. 123 | * In development: Use the secret manager (see slides) 124 | * In CI/CD and production: Use environment variables. You set them through the resp. platform (Git Runners, Azure, etc.) 125 | * Example for Git Runners: 126 | * Go to `Settings` > `Secrets and Variables` > `Actions` and register your secrets, e.g., calling them `GITHUBCLIENTID` and `GITHUBCLIENTSECRET`. 127 | * In your actions, you can then reference the values without leaking them, e.g., to expose them as environment variables for your .NET app: 128 | ``` 129 | - name: Test 130 | run: | 131 | export GitHub__ClientId="${{ secrets.GITHUBCLIENTID }}" 132 | export GitHub__ClientSecret="${{ secrets.GITHUBCLIENTSECRET }}" 133 | dotnet test --no-build --verbosity normal 134 | ``` 135 | * Getting a partial view to be integrated into the `_Layout.cshtml` requires adding a tag helper as in the following 136 | ``` 137 | @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers 138 | ``` 139 | 140 | 141 | ## 2) Process 142 | 143 | Continue to automatically deploy your _Chirp!_ application to Azure App Service. 144 | -------------------------------------------------------------------------------- /sessions/session_08/images/arduino-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/arduino-login.png -------------------------------------------------------------------------------- /sessions/session_08/images/authentication_login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/authentication_login.png -------------------------------------------------------------------------------- /sessions/session_08/images/authentication_subsequent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/authentication_subsequent.png -------------------------------------------------------------------------------- /sessions/session_08/images/banner-transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/banner-transparent.png -------------------------------------------------------------------------------- /sessions/session_08/images/chirp_after_auth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/chirp_after_auth.png -------------------------------------------------------------------------------- /sessions/session_08/images/chirp_before_auth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/chirp_before_auth.png -------------------------------------------------------------------------------- /sessions/session_08/images/claims_principle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/claims_principle.png -------------------------------------------------------------------------------- /sessions/session_08/images/cookie-basic-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/cookie-basic-example.png -------------------------------------------------------------------------------- /sessions/session_08/images/cookie-monster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/cookie-monster.png -------------------------------------------------------------------------------- /sessions/session_08/images/domain_model.svg: -------------------------------------------------------------------------------- 1 | Chirp.Razor.InfrastructureAuthorname: stringemail: stringCheeptext: stringtimestamp: DateTime1 author* cheeps -------------------------------------------------------------------------------- /sessions/session_08/images/domain_model_with_identity.svg: -------------------------------------------------------------------------------- 1 | Microsoft.AspNetCore.IdentityChirp.Razor.InfrastructureIdentityUsername: stringemail: stringAuthorCheeptext: stringtimestamp: DateTime1 author* cheeps -------------------------------------------------------------------------------- /sessions/session_08/images/gh_oauth_local_config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/gh_oauth_local_config.png -------------------------------------------------------------------------------- /sessions/session_08/images/github-oauth-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/github-oauth-settings.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_azure_config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_azure_config.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance-chirp-authenticate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance-chirp-authenticate.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance-redirect.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance-redirect.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance-resource-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance-resource-access.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance-user-authenticate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance-user-authenticate.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance.png -------------------------------------------------------------------------------- /sessions/session_08/images/oauth_dance.psd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_08/images/oauth_dance.psd -------------------------------------------------------------------------------- /sessions/session_09/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_09/.gitkeep -------------------------------------------------------------------------------- /sessions/session_09/Feedback.md: -------------------------------------------------------------------------------- 1 | --- 2 | theme: gaia 3 | _class: lead 4 | paginate: true 5 | backgroundColor: #fff 6 | backgroundImage: url('https://marp.app/assets/hero-background.svg') 7 | footer: '![width:300px](https://github.com/itu-bdsa/lecture_notes/blob/main/images/banner.png?raw=true)' 8 | headingDivider: 2 9 | marp: true 10 | style: | 11 | section { 12 | font-size: 25px; 13 | } 14 | container { 15 | height: 300px; 16 | width: 100%; 17 | display: block; 18 | justify-content: right; 19 | text-align: right; 20 | } 21 | header { 22 | float: right; 23 | } 24 | 25 | a { 26 | color: blue; 27 | text-decoration: underline; 28 | background-color: lightgrey; 29 | font-size: 80%; 30 | } 31 | 32 | table { 33 | font-size: 22px; 34 | } 35 | --- 36 | 37 | # **Analysis, Design and Software Architecture (BDSA)** 38 | Session 9 — Feedback 39 | [Helge Pfeiffer](ropf@itu.dk) 40 | 41 | 42 | ## Feedback 43 | 44 | 45 | 46 | All groups are working on their projects. 47 | Super cool! 48 | 49 | 50 | ## Feedback 51 | 52 | **But** in some groups some members are not working on the projects? 53 | 54 | Recomendation: Do not gamble with coming to the re-exam instead of working on the project and taking the written exam. 55 | 56 | | :exclamation: Without active participation in the project, likely the re-exam will be very difficult to pass. | 57 | |--------------------------------------------------------------------------------------------------------------------------| 58 | 59 | ## Feedback 60 | 61 | 62 | 63 | 64 | ## Feedback - Short-lived branches 65 | 66 | - Remember, we do trunk-based development in this course. That is, you do not have a long-lived `dev` branch (as in last semester's project). That would be another branching strategy. 67 | - You have short-lived feature branches. That is, at latest after a day your changes land on the main branch and thereby automatically in production (your deployment workflows deploy all changes from main, right?) 68 | 69 | What do we do if we cannot finish our feature during a day? 70 | 71 | - Good observation, that means likely that your task descriptions in your issues are too coarse grained. Over time you should train to make them smaller so that you can complete your tasks in max. a day. 72 | 73 | 74 | ## Feedback - Size of commits 75 | 76 | Very few commits but big commits? 77 | 78 | Something is wrong, try to train to scope your work better to small tiny steps/features. 79 | 80 | 81 | ## Feedback - No tests? 82 | 83 | ![bg right:30% 100%](https://media1.tenor.com/m/ACBGhLB0v0gAAAAC/looney-tunes-telescope.gif) 84 | 85 | * Remember my words from session 3! 86 | 87 | > In this course, we do not follow TDD, i.e., we do not require you to _first_ write tests that fail, which you then implement to make them pass. Once the tests pass your implementation is "complete". 88 | > 89 | > However, we require that you from now on implement tests along side your solution. That is, at times you develop a test before the actual implementation of a feature, sometimes afterwards, and likely most of the time you implement them in combination, i.e., as your understanding and implementation of the solution evolves your tests evolve, etc. 90 | 91 | 92 | ## Feedback - No automatic deploy? 93 | 94 | 95 | That is, build, tests, and deploy are not triggered by a push/merge to main branch but you trigger them manually by clicking a button? 96 | 97 | Why do you do that? 98 | 99 | * Likely a fear of breaking sometinh with deployment is related to the lack of tests. 100 | * If all tests pass, then you should be confident to deploy automatically. 101 | 102 | 103 | ## Feedback - Mob programming vs. code review 104 | 105 | If you do mob programming all the time, then code reviews likely do not make sense and you do not use them since you do that already while programming. 106 | 107 | If you worked together on almost all features so far, then try to do something different from now on. For example, try to work for some weeks with pair programming 108 | 109 | 110 | 111 | ## Question: [Max length for message](https://teams.microsoft.com/l/message/19:f6bb39ba381f4c62ba51eba83c0e307f@thread.tacv2/1728570895930?tenantId=bea229b6-7a08-4086-b44c-71f57f716bdb&groupId=50f54173-84af-4d6f-bea1-b06854fb189e&parentMessageId=1728570895930&teamName=2024%20Analysis%2C%20Design%20and%20Software%20Architecture&channelName=Ask%20a%20TA&createdTime=1728570895930) 112 | 113 | > We were trying to enforce 1.c, stating that cheeps should have a max length of 160 characters, by "Using the mechanisms presented by Adrian, ensure that only cheeps up to 160 characters length can be stored." 114 | Unfortunately it seems SQLite doesn't support length limitations on strings, https://www.sqlite.org/faq.html#q9 115 | But the context should still, enforce it, before trying to commit it to the database right? Or have I misunderstood how DBContext work, and if so, are we then allowed to choose our own way of enforcing it? 116 | Below is a snippet of our code from our Context. 117 | >``` 118 | >entity.Property(c => c.Message).IsRequired().HasMaxLength(160); 119 | >``` 120 | 121 | 👏👏👏 I love it! 122 | 123 | Last year nobody realized this as an issue. This is a shortcomming of the ORM that hides a missing feature from the underlying DBMS. 124 | 125 | 126 | ## Exam 127 | 128 | > The exam consists of two parts. The two parts are: 129 | > a) the project, which is covered via the final submission (report) and which covers important aspects of the project work. 130 | > b) a written exam (two hours), which covers generic course contents. 131 | > 132 | > Each part is graded separately, i.e., students receive a grade for the project and another grade for the written exam. 133 | > Final grades are computed based on the two grades from the two parts. The precise weight of each part's grade will be communicated to all students in class at the start of the course. To pass the exam, both parts need to receive a passing grade. That is, the project has to be passed and the written exam needs to be passed. 134 | 135 | The **grading weight** is: project 1/2 written exam 1/2. 136 | 137 | see [LearnIT](https://learnit.itu.dk/local/coursebase/view.php?ciid=1478) 138 | 139 | 140 | ## Info: The written exam??? 141 | 142 | 147 | 148 | * On premises, Friday, January 3rd 2025, 09:00 - 11:00 149 | * Pen and paper exam. 150 | * No other books, tools, etc. 151 | * Two hours. 152 | * In person 153 | 154 | * The exam will be similar to last year's. That is, there will be free form, multiple choice, and sketching answers. 155 | * You can find last year's exam [here](https://ituniversity.sharepoint.com/:b:/r/sites/2024AnalysisDesignandSoftwareArchitecture/Shared%20Documents/General/Documents/2023-itu-bdsa-exam.pdf?csf=1&web=1&e=RnXPPm) 156 | * You can find the exam from 2022, [here](https://ituniversity.sharepoint.com/:b:/r/sites/2024AnalysisDesignandSoftwareArchitecture/Shared%20Documents/General/Documents/2022-itu-bdsa-exam.pdf?csf=1&web=1&e=CaAzNa) 157 | - Note, that exam only to get an idea of the structure and some contents of the exam. 158 | - Since course contents changed, not all contents of that exam apply. Good examples of kinds of questions to be prepared for are: Question 1 a-d, Question 2 a-b, Question 4 j-l, Question 6 a-g 159 | -------------------------------------------------------------------------------- /sessions/session_09/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 09 2 | 3 | * Read chapters 16, 17, and 18 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | 5 | ## Database 6 | 7 | * [Introducing DevOps-friendly EF Core Migration Bundles](https://devblogs.microsoft.com/dotnet/introducing-devops-friendly-ef-core-migration-bundles/) 8 | 9 | ## Validation 10 | 11 | * [FluentValidation](https://www.fluentvalidation.net/) 12 | 13 | ## Testing 14 | 15 | * [Integration tests in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/test/integration-tests) 16 | * [Installation | Playwright for .NET](https://playwright.dev/dotnet/docs/intro) 17 | -------------------------------------------------------------------------------- /sessions/session_09/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [Your turn now! -- Project Work](#your-turn-now----project-work) 8 | - [1) Software Development](#1-software-development) 9 | - [Add feature: Sending Cheeps](#add-feature-sending-cheeps) 10 | - [Constrain Length of Cheeps](#constrain-length-of-cheeps) 11 | - [Add UI Tests](#add-ui-tests) 12 | - [Add End-to-end Tests](#add-end-to-end-tests) 13 | - [2) Process](#2-process) 14 | 15 | 16 | Remember, you have to perform work on each topic and on **each** bullet point. 17 | Be done with the project work before we meet again next week. 18 | 19 | 20 | ## 1) Software Development 21 | 22 | ### Add feature: Sending Cheeps 23 | 24 | Extend your _Chirp!_ application so that users can send cheeps. 25 | 26 | Only users that are authenticated should be able to send cheeps. 27 | That is, after logging in, the user interface should display an input field on all public or private timelines. 28 | For authenticated users, that input field should be displayed under the second level headline (`

`) that says `Public Timeline` or ` Timeline`. 29 | 30 | In the CSS file that you have in your _Chirp!_ projects, there is a style for an input element, which you should use, e.g., `
`. 31 | A skeleton of a corresponding input field may look as in the following: 32 | 33 | ```html 34 |
35 |

What's on your mind @(User.Identity.Name)?

36 |
37 | 38 | 39 |
40 |
41 | ``` 42 | 43 | After sending a cheep, it should appear on the public timeline and on the timeline of the user that created it. 44 | 45 | To support sending of `cheep`s, you have to extend your `CheepRepository` accordingly. 46 | Besides extending your `CheepRepository`, remember to add test cases for creation of `cheep`s to your test suites. 47 | 48 | 49 | ### Constrain Length of Cheeps 50 | 51 | Constrain cheeps so that only cheeps of length 160 characters are considered valid. 52 | Your _Chirp!_ application should not accept cheeps that are longer that 160 character. 53 | Such cheeps should never be stored to the database. 54 | 55 | Using the mechanisms presented by Adrian or in chapter 18 of the course book Andrew Lock _ASP.NET Core in Action_, validate that only `cheep`s up to 160 characters length can be sent. 56 | 57 | 58 | ### Add UI Tests 59 | 60 | Add UI tests for suitable functionality related to sending cheeps. 61 | For example, good UI test cases are that a cheep box only appears on screen once a user sucessfully logged into your _Chirp!_ application. 62 | Another good test case is that you _Chirp!_ application displays a message or behaves according to your liking once a user tries to send a cheep with more than 160 characters. 63 | 64 | 65 | ### Add End-to-end Tests 66 | 67 | Similar to the UI tests above, implement some suitable end-to-end test cases. 68 | For example, test if a cheep that a user enters into a cheep box is stored in the database for the respective author. 69 | 70 | 71 | ## 2) Process 72 | 73 | Continue to automatically deploy your _Chirp!_ application to Azure App Service. 74 | -------------------------------------------------------------------------------- /sessions/session_09/images/HTML form UI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_09/images/HTML form UI.png -------------------------------------------------------------------------------- /sessions/session_09/images/Playwright recording.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_09/images/Playwright recording.png -------------------------------------------------------------------------------- /sessions/session_09/images/banner-transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_09/images/banner-transparent.png -------------------------------------------------------------------------------- /sessions/session_09/images/request-handling-razor-pages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_09/images/request-handling-razor-pages.png -------------------------------------------------------------------------------- /sessions/session_10/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/.gitkeep -------------------------------------------------------------------------------- /sessions/session_10/Git_Crash_Course_by_daso.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/Git_Crash_Course_by_daso.pdf -------------------------------------------------------------------------------- /sessions/session_10/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 10 2 | 3 | * Read chapters 28, and 29 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 4 | -------------------------------------------------------------------------------- /sessions/session_10/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [Your turn now! -- Project Work](#your-turn-now----project-work) 8 | - [1) Software Development](#1-software-development) 9 | 10 | 11 | Remember, you have to perform work on each topic and on **each** bullet point. 12 | Be done with the project work before we meet again next week. 13 | 14 | 15 | ## 1) Software Development 16 | 17 | ### Complete Login 18 | 19 | If not done yet, complete your implementation of login functionality. 20 | Users have to be able to log into your _Chirp!_ applications with GitHub. 21 | 22 | ### Complete Sending of Cheeps 23 | 24 | If not done yet, complete your implementation that allows users to send cheeps. 25 | 26 | ### Security Harden your application 27 | 28 | Now, that you accept cheeps from users, make sure that your _Chirp!_ application is not susceptible to cross-site scripting (XSS) or SQL injection attacks, see chapters 29.1 and 29.4.2 in the course book Andrew Lock _ASP.NET Core in Action, Third Edition_. 29 | -------------------------------------------------------------------------------- /sessions/session_10/images/CDN.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CDN.jpg -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF-1.png -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF-2.png -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF-3.png -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF-4.png -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF.png -------------------------------------------------------------------------------- /sessions/session_10/images/CSRF.psd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/CSRF.psd -------------------------------------------------------------------------------- /sessions/session_10/images/XSS-attack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/XSS-attack.png -------------------------------------------------------------------------------- /sessions/session_10/images/XSS-result-protected-rendered.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/XSS-result-protected-rendered.png -------------------------------------------------------------------------------- /sessions/session_10/images/XSS-result-protected.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/XSS-result-protected.png -------------------------------------------------------------------------------- /sessions/session_10/images/XSS-result-unprotected-rendered.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/XSS-result-unprotected-rendered.png -------------------------------------------------------------------------------- /sessions/session_10/images/XSS-result-unprotected.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/XSS-result-unprotected.png -------------------------------------------------------------------------------- /sessions/session_10/images/banner-transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/banner-transparent.png -------------------------------------------------------------------------------- /sessions/session_10/images/http-unencrypted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/http-unencrypted.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-decision-diagram.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | Do you need HTTPS? 110 | 111 | Do you care about your users at all? 112 | 113 | no 114 | 115 | 116 | 117 | 118 | no 119 | Do you process sensitive data? 120 | yes 121 | yes 122 | 123 | Yes, you definitely need HTTPS 124 | 125 | 126 | 127 | 128 | 129 | 130 | -------------------------------------------------------------------------------- /sessions/session_10/images/https-encrypted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-encrypted.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-hsts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-hsts.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-locally-browser.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-locally-browser.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-offloading.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-offloading.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-passthrough.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-passthrough.png -------------------------------------------------------------------------------- /sessions/session_10/images/https-redirects.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/https-redirects.png -------------------------------------------------------------------------------- /sessions/session_10/images/load-testing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/load-testing.png -------------------------------------------------------------------------------- /sessions/session_10/images/owasp-top-ten.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/owasp-top-ten.png -------------------------------------------------------------------------------- /sessions/session_10/images/xkcd-bobby-tables.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_10/images/xkcd-bobby-tables.png -------------------------------------------------------------------------------- /sessions/session_11/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/.gitkeep -------------------------------------------------------------------------------- /sessions/session_11/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 11 2 | 3 | 4 | ## Visualization of software design 5 | 6 | - [Intro to UML class diagrams](https://www.uml-diagrams.org/class-diagrams-overview.html) 7 | - [Intro to UML statecharts](https://www.uml-diagrams.org/state-machine-diagrams.html) 8 | - [Intro to UML activity diagrams](https://www.uml-diagrams.org/activity-diagrams.html) 9 | - [Intro to UML package diagrams](https://www.uml-diagrams.org/package-diagrams-overview.html) 10 | - [Intro to UML component diagrams](https://www.uml-diagrams.org/component-diagrams.html) 11 | - [Intro to UML deployment diagrams](https://www.uml-diagrams.org/deployment-diagrams-overview.html) 12 | - [Intro to UML sequence diagrams](https://www.uml-diagrams.org/sequence-diagrams.html) 13 | - [UML Cheatsheet](http://deptinfo.unice.fr/twiki/pub/Linfo/CooL3/refUML.pdf) 14 | -------------------------------------------------------------------------------- /sessions/session_11/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [Your turn now! -- Project Work](#your-turn-now----project-work) 8 | - [1) Software Development](#1-software-development) 9 | - [2) Process](#2-process) 10 | 11 | 12 | Remember, you have to perform work on each topic and on **each** bullet point. 13 | Be done with the project work before we meet again next Thursday. 14 | 15 | 16 | ## 1) Software Development 17 | 18 | ### Add feature: Users can follow and unfollow each other 19 | 20 | Extend your _Chirp!_ application so that users can follow and unfollow each other. 21 | 22 | Users can follow any other user, except themselves. 23 | Initially, users do not follow any other user. 24 | 25 | Once authenticated to your _Chirp!_ application, cheeps in public (on the root endpoint `/`) and private timelines (on the username endpoint `/`) should contain a link next to all listed user names with the link text `follow`. 26 | Clicking these links, shall register in your application that a user is now following the selected other user. 27 | Likely, clicking it just redirects a user to the currently displayed page. 28 | 29 | If a user already follows another user, the link text displayed to the other user's name in the public and private timelines is `unfollow`. 30 | 31 | Following another user has an impact on what is displayed in a user's private timeline (those on the username endpoint `/`). 32 | The cheeps of all followed users and those of the user logged into your _Chirp!_ application should be displayed in the private timeline of an authenticated user. 33 | That means also, that if an authenticated user visits the private timeline of any other user, she sees only the cheeps written by that user but not those that are written by other users that the the other user is following. 34 | 35 | 36 | To implement this feature, you have to extend your data model so that it can store the information on who is following whom. 37 | There are several possible solutions on how to implement this feature. 38 | You decide how to modify the data model, i.e., if you want to store the information about whom a user is following in a separate entity, as a property of a user, etc. 39 | Besides the changes in the datamodel, you have to refactor your repositories, DTOs, views, etc. accordingly. 40 | 41 | 42 | #### Example 43 | 44 | For example, imagine your _Chirp!_ application has three users `Anna`, `Bella`, and `Cheryl`. 45 | Since `Bella` likes `Cheryl`'s writing, she follows her, which is already stored in the _Chirp!_ application. 46 | Now, `Anna` logs into the system. 47 | Since she never logged in before, she does not follow any other user yet. 48 | Imagine now, `Anna` sends a first cheep. 49 | On the public timeline (`/` root endpoint), `Anna` gets presented a link to follow users `Bella` and `Cheryl` displayed next to their respective user names but **not** next to her own user name `Anna`. 50 | That is, users can only follow others but not themselves. 51 | `Anna` decides to follow both `Bella` and `Cheryl`, i.e., the _Chirp!_ application adds the information that `Anna` follows `Bella` and that `Anna` follows `Cheryl` on top of the information that `Bella` follows `Cheryl`. 52 | In her private timeline (`/Anna`), gets now displayed all the cheeps that are written by herself and all of those that are written by `Bella` and `Cheryl` respectively. 53 | However, when `Anna` is logged in and she visits `Bella`'s timeline, she can only see `Bella`'s cheeps, **not** those written by `Cheryl`. 54 | The same holds for `Bella` and any other user, i.e., if `Bella` was logged in, she would see her own cheeps and those of `Cheryl` on her own private timeline (`/Bella`), on `Anna`'s timeline (`/Anna`) she would only see cheeps written by `Anna` 55 | 56 | Now, still logged in, `Anna` realizes that she does not like `Bella`'s writing anymore. 57 | On both the public and private timelines next to `Bella`'s name a link to `unfollow` her is displayed. 58 | After clicking it, the _Chirp!_ application registers this new information and updates its data store accordingly. 59 | Now only, `Anna` follows `Cheryl` and `Bella` follows `Cheryl`. 60 | When visiting her own private timeline (`/Anna`), `Anna`'s timeline displays now only her own cheeps and those written by `Cheryl`. 61 | 62 | 63 | ### Assure requirements for users of _Chirp!_ 64 | 65 | - An author on your _Chirp!_ application has always a name and an email address. 66 | - An email address **is not** the name. 67 | - For login: be specific if you want the user to insert a name or an email address. 68 | 69 | * When logging in via GitHub OAuth, a user **shall not** provide an extra email or username. If you need this in your _Chirp!_ application receive this from GitHub with the help of the information that you receive in the ClaimsPrinciple. It should contain a GitHub user ID. 70 | 71 | 72 | ## 2) Process 73 | 74 | Since the (un-)following functionality is quite tricky, it is likely a good idea to implement a set of tests that assure only the right users can read cheeps written by those that they are following. 75 | Due to its trickiness, you might want to consider to start writing certain tests before you start your implementation of the new feature. 76 | 77 | The description of the example above is likely a very good candidate to be implemented as a set of tests. 78 | 79 | You can decide if these tests are implemented as integration tests or as UI tests. 80 | With integration tests, you could for example seed example data in your test database, e.g., `Bella` follows `Cheryl` and both of them have some example cheeps. 81 | Now, when you ask a certain repository that `Anna` wants to follow both `Bella` follows `Cheryl` and when 82 | Writing integration tests this way, allows you to circumvent that `Anna` has to be logged into _Chirp!_. 83 | You can test you repositories in isolation. 84 | If in doubt, consult the links in the reading material for how to build such integration tests. 85 | 86 | 87 | Alternatively, you might want to implement some of these tests as UI tests with PlayWright. 88 | When doing so, it is okay that the Playwright tests are not integrated into your GitHub Actions workflows. 89 | It can be done, but it requires a bit more of fiddling that may be to time intensive. 90 | However, one has to be able to execute them locally when checking out the main branch of your repository. 91 | 92 | If you cannot get these tests done until next week, continue working on them during the following weeks. 93 | Once you hand-in your project though, it is important that some of the aspects of un-/following each other are tested in some way. 94 | -------------------------------------------------------------------------------- /sessions/session_11/images/accross_pkg_dep_ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/accross_pkg_dep_ui.png -------------------------------------------------------------------------------- /sessions/session_11/images/activity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/activity.png -------------------------------------------------------------------------------- /sessions/session_11/images/activity_syntax.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/activity_syntax.png -------------------------------------------------------------------------------- /sessions/session_11/images/authenticated_request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/authenticated_request.png -------------------------------------------------------------------------------- /sessions/session_11/images/bpmn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/bpmn.png -------------------------------------------------------------------------------- /sessions/session_11/images/bpmn_legend.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/bpmn_legend.png -------------------------------------------------------------------------------- /sessions/session_11/images/class.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/class.png -------------------------------------------------------------------------------- /sessions/session_11/images/class_association.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/class_association.png -------------------------------------------------------------------------------- /sessions/session_11/images/class_inheritance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/class_inheritance.png -------------------------------------------------------------------------------- /sessions/session_11/images/client_server_comp_db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/client_server_comp_db.png -------------------------------------------------------------------------------- /sessions/session_11/images/domain_model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/domain_model.png -------------------------------------------------------------------------------- /sessions/session_11/images/domain_model_constrained.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/domain_model_constrained.png -------------------------------------------------------------------------------- /sessions/session_11/images/feature_model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/feature_model.png -------------------------------------------------------------------------------- /sessions/session_11/images/login_logout_sm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/login_logout_sm.png -------------------------------------------------------------------------------- /sessions/session_11/images/multi_clients_server_comp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/multi_clients_server_comp.png -------------------------------------------------------------------------------- /sessions/session_11/images/non_func_reqs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/non_func_reqs.png -------------------------------------------------------------------------------- /sessions/session_11/images/non_func_reqs2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/non_func_reqs2.png -------------------------------------------------------------------------------- /sessions/session_11/images/sd_call.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/sd_call.png -------------------------------------------------------------------------------- /sessions/session_11/images/sd_oauth_dance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/sd_oauth_dance.png -------------------------------------------------------------------------------- /sessions/session_11/images/state_follow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/state_follow.png -------------------------------------------------------------------------------- /sessions/session_11/images/wireframe.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/wireframe.png -------------------------------------------------------------------------------- /sessions/session_11/images/wireframe_online_editor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_11/images/wireframe_online_editor.png -------------------------------------------------------------------------------- /sessions/session_12/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_12/.gitkeep -------------------------------------------------------------------------------- /sessions/session_12/READING_MATERIAL.md: -------------------------------------------------------------------------------- 1 | # Reading Material for Session 12 2 | 3 | 4 | ## Visualization of software design 5 | 6 | 7 | ## Deleting a User 8 | 9 | - Chapter 12 in particular section 12.4.4 from [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition) 10 | 11 | 12 | ## Writing Documentation (Optional) 13 | 14 | - https://www.writethedocs.org/guide/ 15 | - https://jacobian.org/2009/nov/10/what-to-write/ 16 | - https://jacobian.org/2009/nov/11/technical-style/ 17 | - https://help.dozuki.com/Tech_Writing/chapter/0 18 | -------------------------------------------------------------------------------- /sessions/session_12/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [Your turn now! -- Project Work](#your-turn-now----project-work) 8 | - [1) Software Development](#1-software-development) 9 | - [2) Process](#2-process) 10 | 11 | 12 | Remember, you have to perform work on each topic and on **each** bullet point. 13 | Be done with the project work before we meet again next week. 14 | 15 | 16 | ## 1) Software Development 17 | 18 | ### Add feature: User information page 19 | 20 | After Jakob's lecture on GDPR, you learned that you have to be able to provide users information about their personal data that your application stores about them. 21 | 22 | In the navigation bar on top, in between links to timelines and login, create a link to a new page with the link text "about me". 23 | That link appears only if a user is authenticated in your _Chirp!_ application. 24 | If authenticated, a user should be able to see all information that your _Chirp!_ application stores about her on that page. 25 | That is all personal information, like name, email address, links to other users that this user is following, etc. should be presented 26 | Additionally, all cheeps of this user are listed. 27 | 28 | Optionally, you can implement functionality to download all this information as a zipped archive of text files. 29 | These might be CSV files, plain text files, etc. 30 | 31 | 32 | ### Add feature: Forget me. 33 | 34 | On the user information page, place a red button with the text `Forget me!`. 35 | An authenticated user can click this button. 36 | The system should then delete all information about this user, e.g., name, email address, links to other users that this user is following, etc. should be removed from your _Chirp!_ application. 37 | 38 | As you know from the lecture, there are various ways of implementing this feature. 39 | For this class and project, it is okay if you implement the technically most simply form of this feature as described in section 12.4.4 in [Andrew Lock _ASP.NET Core in Action, Third Edition_](https://www.manning.com/books/asp-net-core-in-action-third-edition). 40 | That is, so that a delete operation is not a real delete but an update operation that modifies the respective data so that it is not displayed anymore. 41 | This solution is of course not GDPR compliant. 42 | 43 | Alternatively, since you remember from Jakob that in terms of GDPR "anonymization == deletion", you can decide to implement deletion in this way. 44 | That is, you may want to implement this feature so that user names and other personal data are anonymized 45 | For this project, it is okay that you do not consider anonymizing the contents of a cheep. 46 | 47 | After a user clicked the `Forget me!` button, she shall be logged out of your _Chirp!_ application. 48 | 49 | 50 | ## 2) Process 51 | 52 | Make sure that the above features are tested in a suitable form. 53 | -------------------------------------------------------------------------------- /sessions/session_12/README_REPORT.md: -------------------------------------------------------------------------------- 1 | 2 | # _Chirp!_ Project Documentation 3 | 4 | 5 | ## Formal Requirements 6 | 7 | All your documentation for this report is written in Markdown, a lightweight markup language (https://www.markdownguide.org). 8 | In the root of your repository, create a directory called `docs`. 9 | Let it contain a file called `report.md`. 10 | 11 | In case you include illustrations from image files, put all of these of a subdirectory of `docs`, which shall be called `images`. 12 | 13 | Before Thursday, 19 December 2024, 14:00, hand-in a PDF file with your report on LearnIT (https://learnit.itu.dk/mod/exam/view.php?id=182186). 14 | The filename of your report has to be `2024_itubdsa_group__report.pdf`, where where `` is replaced with the group number from [here](https://ituniversity.sharepoint.com/:x:/r/sites/2024AnalysisDesignandSoftwareArchitecture/Shared%20Documents/General/Groups.xlsx?d=w6776b670fe464ef09d2d4eb3f1a559b7&csf=1&web=1&e=TSJ9jD). 15 | 16 | You can convert your report from markdown to PDF format with `pandoc`: 17 | ``` 18 | cd docs 19 | pandoc report.md -o 2024_itubdsa_group__report.pdf 20 | ``` 21 | 22 | Find instructions on how to install `pandoc` [here](https://pandoc.org/installing.html). 23 | In case you do not want to install `pandoc` locally to build your report PDF file, you can add the [GitHub Actions Pandoc Action](https://github.com/pandoc/pandoc-action-example) to a respective workflow that updates the PDF file on pushes to/merges with the `docs` directory in your repository. 24 | 25 | Use the [report template](./docs/report.md) that is provided next to this description. 26 | OBS: You have to adapt the metadata of `report.md` (the block within `---` on top) accordingly! 27 | 28 | Note, good project reports are spell- and grammar-checked! 29 | This can be done in many different ways. 30 | In case you write your report in VSCode, then you might consider the following extensions: for [spell-checking in VSCode]( 31 | https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) and for [spell- and grammar-checking](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex) 32 | 33 | OBS: Work on your documentation in the same way that you work on source code. 34 | That is, small iterative and incremental steps with respective commits. 35 | 36 | When you have to write something in the project report, write concisely. 37 | That is, write short and precise sentences that do not contain fluff. 38 | Important, all illustrations have to be legible in the produced PDF document. 39 | So make sure they do not become too small. 40 | 41 | Create all illustrations either with [PlantUML](https://plantuml.com/) or with [DrawIO](https://app.diagrams.net/). 42 | Store all sources of your diagrams, i.e., PlantUML diagram source code or DrawIO XML files under `docs` in a directory called `diagrams`. 43 | 44 | Before handing in your project report, make sure that your source code is suitably documented in-code. 45 | 46 | **OBS**: After handing in your reports, please let your deployed systems be operational until the end of the third week of January 2024. 47 | 48 | The following describes the sections that your report has to provide. 49 | These sections are also provided in the project template. 50 | 51 | ------------------------------------------------------------------------------- 52 | 53 | 54 | ## Design and architecture 55 | 56 | ### Domain model 57 | 58 | Provide an illustration of your domain model. 59 | Make sure that it is correct and complete. 60 | In case you are using ASP.NET Identity, make sure to illustrate that accordingly. 61 | 62 | ### Architecture — In the small 63 | 64 | Illustrate the organization of your code base. 65 | That is, illustrate which layers exist in your (onion) architecture. 66 | Make sure to illustrate which part of your code is residing in which layer. 67 | 68 | ### Architecture of deployed application 69 | 70 | Illustrate the architecture of your deployed application. 71 | Remember, you developed a client-server application. 72 | Illustrate the server component and to where it is deployed, illustrate a client component, and show how these communicate with each other. 73 | 74 | ### User activities 75 | 76 | Illustrate typical scenarios of a user journey through your _Chirp!_ application. 77 | That is, start illustrating the first page that is presented to a non-authorized user, illustrate what a non-authorized user can do with your _Chirp!_ application, and finally illustrate what a user can do after authentication. 78 | 79 | Make sure that the illustrations are in line with the actual behavior of your application. 80 | 81 | ### Sequence of functionality/calls trough _Chirp!_ 82 | 83 | With a UML sequence diagram, illustrate the flow of messages and data through your _Chirp!_ application. 84 | Start with an HTTP request that is send by an unauthorized user to the root endpoint of your application and end with the completely rendered web-page that is returned to the user. 85 | 86 | Make sure that your illustration is complete. 87 | That is, likely for many of you there will be different kinds of "calls" and responses. 88 | Some HTTP calls and responses, some calls and responses in C# and likely some more. 89 | (Note the previous sentence is vague on purpose. I want that you create a complete illustration.) 90 | 91 | ## Process 92 | 93 | ### Build, test, release, and deployment 94 | 95 | Illustrate with a UML activity diagram how your _Chirp!_ applications are build, tested, released, and deployed. 96 | That is, illustrate the flow of activities in your respective GitHub Actions workflows. 97 | 98 | Describe the illustration briefly, i.e., how your application is built, tested, released, and deployed. 99 | 100 | ### Team work 101 | 102 | Show a screenshot of your project board right before hand-in. 103 | Briefly describe which tasks are still unresolved, i.e., which features are missing from your applications or which functionality is incomplete. 104 | 105 | Briefly describe and illustrate the flow of activities that happen from the new creation of an issue (task description), over development, etc. until a feature is finally merged into the `main` branch of your repository. 106 | 107 | ### How to make _Chirp!_ work locally 108 | 109 | There has to be some documentation on how to come from cloning your project to a running system. 110 | That is, Adrian or Helge have to know precisely what to do in which order. 111 | Likely, it is best to describe how we clone your project, which commands we have to execute, and what we are supposed to see then. 112 | 113 | ### How to run test suite locally 114 | 115 | List all necessary steps that Adrian or Helge have to perform to execute your test suites. 116 | Here, you can assume that we already cloned your repository in the step above. 117 | 118 | Briefly describe what kinds of tests you have in your test suites and what they are testing. 119 | 120 | ## Ethics 121 | 122 | ### License 123 | 124 | State which software license you chose for your application. 125 | 126 | ### LLMs, ChatGPT, CoPilot, and others 127 | 128 | State which LLM(s) were used during development of your project. 129 | In case you were not using any, just state so. 130 | In case you were using an LLM to support your development, briefly describe when and how it was applied. 131 | Reflect in writing to which degree the responses of the LLM were helpful. 132 | Discuss briefly if application of LLMs sped up your development or if the contrary was the case. 133 | -------------------------------------------------------------------------------- /sessions/session_12/docs/images/domain_model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_12/docs/images/domain_model.png -------------------------------------------------------------------------------- /sessions/session_12/docs/report.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: _Chirp!_ Project Report 3 | subtitle: ITU BDSA 2024 Group `` 4 | author: 5 | - "Helge Pfeiffer " 6 | - "Adrian Hoff " 7 | numbersections: true 8 | --- 9 | 10 | # Design and Architecture of _Chirp!_ 11 | 12 | ## Domain model 13 | 14 | Here comes a description of our domain model. 15 | 16 | ![Illustration of the _Chirp!_ data model as UML class diagram.](docs/images/domain_model.png) 17 | 18 | ## Architecture — In the small 19 | 20 | ## Architecture of deployed application 21 | 22 | ## User activities 23 | 24 | ## Sequence of functionality/calls trough _Chirp!_ 25 | 26 | # Process 27 | 28 | ## Build, test, release, and deployment 29 | 30 | ## Team work 31 | 32 | ## How to make _Chirp!_ work locally 33 | 34 | ## How to run test suite locally 35 | 36 | # Ethics 37 | 38 | ## License 39 | 40 | ## LLMs, ChatGPT, CoPilot, and others 41 | -------------------------------------------------------------------------------- /sessions/session_13/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itu-bdsa/lecture_notes/8da343595474ad728f2f8d64375c1f2a7d5e3843/sessions/session_13/.gitkeep -------------------------------------------------------------------------------- /sessions/session_13/README_PROJECT.md: -------------------------------------------------------------------------------- 1 | # Your turn now! -- Project Work 2 | 3 | 4 | 5 | You have to work on the following topics. 6 | 7 | - [Your turn now! -- Project Work](#your-turn-now----project-work) 8 | - [1) Software Development](#1-software-development) 9 | - [2) Process](#2-process) 10 | - [3) Demo Day](#3-demo-day) 11 | 12 | 13 | 14 | Remember, you have to perform work on each topic and on **each** bullet point. 15 | Be done with the project work before we meet again next week. 16 | 17 | 18 | ## 1) Software Development 19 | 20 | ### Add feature(s): Wild Style 21 | 22 | Implement whichever feature you like to your _Chirp!_ applications. 23 | In case you have the time and energy, you might implement multiple such features. 24 | 25 | For inspiration, wild style features might be: 26 | - Ranking or liking of cheeps 27 | - Tags in cheeps (for example, strings preceded by a `#` sign might be indexed and cheeps containing tags might be listed in a separate page) 28 | - List of trending cheeps based on likes or tags 29 | - Support of images in cheeps 30 | - "Re-cheeping", i.e., forwarding of cheeps that are send by others to own timeline and own followers. 31 | - ... 32 | 33 | ### Refactoring: Repositories and Data-Transfer Objects (DTO) 34 | 35 | After the third round of project reviews, we became aware of that many groups implement only one repository class and only one DTO class. First, that is likely an issue with resepect to some of the SOLID design principles. Additionally, if you remember Adrian's lecture on the topic and the related reading material, you likely remember that it is often recommended to have one repository class per one domain model class. Similarly, each of these return separate data-transfer objects. 36 | 37 | Refactor your project so that it contains suitable repository classes and respective DTOs. 38 | 39 | 40 | ## 2) Process 41 | 42 | Make sure that the above features are tested in a suitable form. 43 | 44 | 45 | ## 3) Demo Day: Peer feedback 46 | 47 | Prepare for the Demo day next week (Tuesday 3/12/24 or Wednesday 4/12/24). 48 | You present your work to each other in clusters of three groups and you provide peer-feedback to each other. 49 | Each group has 10 minutes to present. The remaining time in the time slots is used for discussions and feedback. 50 | 51 | **OBS**: All times given below are sharp! That is, they are not with an academic quarter. 52 | 53 | ### Schedule 54 | 55 | Tuesday 3/12/24 56 | 57 | | Time | Room | Groups | TA | 58 | |-------------|--------|----------------|--------| 59 | | 14:00-14:40 | 4A56 | 1,2,3 | Phi Va | 60 | | | 4A58 | 4,5,6 | Rasmus | 61 | | 14:45-15:25 | 4A56 | 7,8,9 | Phi Va | 62 | | | 4A58 | 10,11,12 | Rasmus | 63 | 64 | 65 | Wednesday 4/12/24 66 | 67 | | Time | Room | Groups | TA | 68 | |-------------|---------|----------------|---------| 69 | | 14:15-14:55 | 4F03 | 13,14,15 | Patrick | 70 | | | 2A12-14 | 16,17,18 | David F | 71 | | | 2A52 | 19,20,21 | David S | 72 | | 15:00-15:40 | 4F03 | 22,23,24 | Patrick | 73 | | | 2A12-14 | 25,26,28 | David F | 74 | | | 2A52 | 29,30,31 | David S | 75 | 76 | 77 | ### What to present? 78 | 79 | - Quick tour of features and demonstration of their functionality 80 | - Brief demo of additional features. 81 | - Describe design descision that are characteristic for your projects. Amongst others: 82 | - How is "forget me" feature implemented? 83 | - How are additional features implemented? 84 | - Overview of tests. 85 | - If you already have some and want to show them, some of the visualizations that you intend to use in the report. 86 | 87 | 88 | ### How to provide feedback in the presentations? 89 | 90 | In the following you find a kind of checklist that you may use as inspiration when providing peer-feedback to the presentations of your fellow groups. 91 | 92 | 93 | - Functionality: 94 | - Is functionality complete or are major features missing? 95 | - Login with GitHub works without prompting for additional information? 96 | - Tests: 97 | - Are there any tests presented? 98 | - Are there different kinds of tests, like unit tests, integration tests, UI-tests, end-to-end tests? 99 | - Are the presented tests sensible? 100 | - The presented tests are well designed? (There was a pattern we discussed in class that test cases should adhere to.) 101 | - Visualizations: 102 | - Are the presented visualizations syntactically correct? 103 | - Are relation ends on the correct side of relations? 104 | - Are cardinalities correct? 105 | - Are the correct diagram types used? 106 | - Are there separate illustrations of structure and behaviour of the _Chirp!_ system or are they mixed? 107 | --------------------------------------------------------------------------------