.NET Day 2023: Clean as you Code: use Roslyn analyzers to focus on the code you modify

by dotnetday

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro 12 “90% of reported security incidents result from exploits against defects in the design or code of software.” (U.S. Dept. of Homeland Security) https://www.cisa.gov/sites/default/ﬁles/publications/infosheet_SoftwareAssurance.pdf

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro Sort(x => x.Downloads) xUnit.Analyzers - 314M StyleCop.Analyzers - 108M Microsoft.Azure.Functions.Analyzers - 31M Microsoft.VisualStudio.Threading.Analyzers - 30M SonarAnalyzer.CSharp - 29M Microsoft.CodeAnalysis.NetAnalyzers - 21M 23

Slide 24

Slide 24 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro xUnit.Analyzers StyleCop.Analyzers - coding style Microsoft.Azure.Functions.Analyzers Microsoft.VisualStudio.Threading.Analyzers ❤ SonarAnalyzer.CSharp ❤ Microsoft.CodeAnalysis.NetAnalyzers - built in 24 Sort(x => x.Downloads)

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro 31 SQLMoney.cs (dotnet/runtime) https://github.com/dotnet/runtime/blob/45acd38/src/libra ries/System.Data.Common/src/System/Data/SQLTypes/SQ LMoney.cs#L150-L161 (MIT License) Symbolic Execution Example

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro Clean as You Code after 1 year after 2 years after 5 years 20% clean code 35% clean code 50% clean code today Your existing codebase gets progressively clean 45

Slide 46

Slide 46 text

Slide 47

Slide 47 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro Implementing Clean as You Code 47 Set up a Quality Gate on new code based on your standard (Quality Proﬁle) Don’t merge unless it is green Don’t release unless it is green

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro On average, 50% of code* gets changed within 3.33 years. *of large open-source projects on GitHub https://github.com/erikbern/git-of-theseus 50 Why does it work?

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

Slide 54

Slide 54 text

Slide 55

Slide 55 text

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

Slide 59

Slide 59 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro My experience at Sonar In three years, for sonar-dotnet, we increased branch (conditional) coverage from 82% to 93% by using a Quality Gate at 95%. 59

Slide 60

Slide 60 text

450+ C# Rules 30+ languages, frameworks, infra technologies rules.sonarsource.com is more 60 T-SQL COBOL and more…

Slide 61

Slide 61 text

©2023, SonarSource S.A, Switzerland. AndreiEpure.ro Clean as You Code = improve the code you touch: ○ Set your common standard of clean code ○ Ensure every commit achieves that standard ○ Use static analysis to help consistently achieve it 61 Key takeaways Remember this!