A Programmer with Microsoft tools

Introduction : This is a test for me to write ADR’s accordingly to https://github.com/joelparkerhenderson/architecture-decision-record . I will try those ADR and see the final result

ADR005 Logging

TITLE: ADR 005 – Logging​

• Status: accepted

• Deciders: Andrei Ignat
• Date: 2023-10-07

Technical Story: Must add some logging library in order to debug problems

Context and Problem Statement​

Every time there is a problem, logging could solve the problems by having more details about what is wrong

So I MUST add logging

Decision Drivers ​

• Making one library for logging is not so complicated , however
  • the exporters to other systems are cumbersome and difficult

  • also threading is a problem when writing to a file
• There are already production battle tested libraries that performs the work well.

Considered Options​

• NLog , https://nlog-project.org/
• Serilog , https://serilog.net/
• Others ( log4net )

Decision Outcome​

Choosing NLog because it is simpler to configure from a text file

Positive Consequences ​

Devops should be happy – the logging file for production could be also put into SourceControl without problems.

Negative Consequences​

Do not support yet SAMNE logging for a class. Could be alleviated by having DebuggerDisplayAttribute for the class and logging the function

Pros and Cons of the Options ​

Serilog​

• Good, because Widely adopted

• Good, because A lot of documentation
• Good, because Great community
• Bad, because A bit harder to learn when coming from log4net

NLOG​

Advantages

• Good, because A lot of documentation

• Good, because Having been around a long time, there are lots of blog posts
• Good, because Easy to get started when coming from other logging frameworks
• Bad, because Structured logging is still a bit behind Serilog
• Bad, because C#-based API is harder to use than Serilog’s fluent API

Links​

• Copied arguments from Elmah
• NLOG
• Serilog

ADR based on​

https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-by-jeff-tyree-and-art-akerman/index.md

Introduction : This is a test for me to write ADR’s accordingly to https://github.com/joelparkerhenderson/architecture-decision-record . I will try those ADR and see the final result

ADR003 Tests

TITLE: ADR 003 – Tests​

Submitters​

• Andrei Ignat

Change Log​

• Approved 2023-08-24

• Modified 2023-08-28

Referenced Use Case(s)​

All use cases, e.g.

• UseCases001 – No Authentication , upload

must be enforced via an automated Test.

Context​

The tests are an important part of the software – so the framework that I am using is important.

Also , the organization of the software must allow testing business rules more than endpoints / GUI that are changing very often.

Also, the code coverage is pretty important – should be at least 80%

Proposed Design​

Every GUI application ( Desktop,Console, WebAPI ) must be skinny – i.e. passing data to a business component.

Also, Business should not call static functions ( e.g. DateTime.Now, Environment.CurrentUser) but pass interfaces or functions in order to be Mocked.

Considerations​

Testing GUI’s / endpoints should be make at least possible in the developing of the app, because they are changing fast.

Decision​

As frameworks we will have :

XUnit ( preferable constructor over [SetUp] ) – see https://testsigma.com/blog/nunit-vs-xunit/

FluentAssertion – to improve running and debugging

LightBDD – to display tests in a good form

NSubstitute – instead of Moq – see https://github.com/moq/moq/issues/1374

Rocks – https://github.com/JasonBock/Rocks/

dotCover CLI – https://www.jetbrains.com/help/dotcover/Running_Coverage_Analysis_from_the_Command_LIne.html

Other Related ADRs​

Format:

• ADR002 – Architecture of the application

References​

• XUnit
• FluentAssertion
• LightBDD
• NSubstitute

ADR based on​

https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-by-edgex/index.md

Introduction : This is a test for me to write ADR’s accordingly to https://github.com/joelparkerhenderson/architecture-decision-record . I will try those ADR and see the final result

ADR002 Architecture of application

TITLE: ADR 002 – Type of application​

Prologue (Summary)​

The app will be used the people that are powershell users and wants their profile shared.

In the context of

Use Case 1 : No Authentication , upload

and

Use case 3: User can see data for a user name

the decision an WebSite. In order to achieve Use Case 1 from powershell, an WebAPI should be implemented.

Discussion (Context)​

From WebAPI we can decouple the GUI(SPA) from the WebAPI – and maybe modifying / trying different GUIs ( Angular, React, MVC)

Solution​

It is the common way those days to split the app in BackEnd and FrontEnd.

Consequences​

We have the possibility to upgrade separately the BackEnd and FrontEnd.

However, it will be more difficult to debug the SPA.

ADR based on

https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-for-alexandrian-pattern

Introduction : This is a test for me to write ADR’s accordingly to https://github.com/joelparkerhenderson/architecture-decision-record . I will try those ADR and see the final result

ADR001 Engine for documentation

TITLE: ADR 001 – Engine for documentation​

Status : accepted​

Context​

Need to have a static documentation site with blog also .

In those days there are many engines on the market. And I can built one 😉 .

Read https://docusaurus.io/docs#comparison-with-other-tools . The only that seems to fit the bill are REACT based – I cannot afford learning VUE after Angular and React.

The problem with REACT is that he is going also to server side …

Decision​

Docusaurus it is because

1. Apparently is it the best on REACT

2. I know REACT
3. It has BLOG and Documentation

Consequences​

The build process will be somehow different.

Could be hard to transfer what I have written to another engine

ADR based on​

https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-by-michael-nygard