This presentation was held at SPC Adriatics 2014 in Zagreb 10/15/2014 http://spcadriatics.com/2014/session/assuring-the-code-quality-of-sharepoint-solutions-and-apps/ Abstract SharePoint development and fun do not always have much in common! Everyone who has ever developed for SharePoint might know what I mean. Even a small SharePoint solution or app consist already of a large number of different files (xml, cs, js, css, resx, jpg, aspx, etc.) which may be implemented and structured differently in every project. Especially with the shift of the development approach to the new App model, SharePoint veterans but also rookies find themselves confronted with many new technologies, frameworks, and coding practices. As a result the quality and maintainability of SharePoint solutions and apps differs very much depending on the experience and preference of the individual developers. In this session we will discuss the common challenges in SharePoint development, as well as the possibilities to standardize the development approach in the team and automatically assure these policies and practices.

1. Assuring the Code Quality of SharePoint Solutions and Apps
Matthias Einig, MVPRENCORE AB

3. Who is that guy?
matthias.einig@rencore.se
www.matthiaseinig.de
Matthias Einig
CEO, SharePoint MVP
Stockholm, Sweden

4. What is Code Quality?
Source: Consortium for IT Software Quality
•Reliability
•Security
•Efficiency
•Maintainability
•Size

5. Why should we care?
•Avoid bugs
•Reduce effort (coding & testing)
•Improve maintainability
•Prepare for changes/upgrade
•Increase team flexibility
Code Quality can’t be easily added later!

7. How to measure Code Quality?
•Architectural standards
•Coding Practices
•Complexity
•Documentation
•Portability
•Tech./Func. Volume
Reliability
Security
Efficiency
Maintainability
Size

8. How to analyse Code Quality?
•Static vs. Dynamic
•Source Code vs. Object Code
•Manual vs. Automated
•Ad hoc vs. Continuously

9. Why is it important for SharePoint?
•Solutions / apps are black boxes
•Code quality differs a lot
•Solutions change (ALM)
•Complexity
•Policies / Best Practices
•Dev Teams Change
•Farm stability / security / licensing

10. So, what is SharePoint Code?
.NET code
XML: Manifest, Features, Content Types, Templates
HTML, ASPX, ASCX
CSS, JavaScript
Images, resources, document templates…
Deployment locations!

11. Is my code
correctand followsbest practices?
Developer
Is the codewelldesignedand maintainable?
Architect
Does the codecomplywithcompanypoliciesand standards?
Quality Manager
Who needs it and why?
Will the code
harm my farm?
Administrator

12. What Tools do we have?`
ObjectCodeFxCop/VSCA
FxCop Metrics
CAT.net
SourceCode StyleCop
SPCode SPDisposeCheck
MSOCAF
Checks against general coding errors (not SharePoint-specific)
Calculates code metrics (only.NET code, not SharePoint specific)
Checks codingstyle guidelines(only .NET code, not SharePoint specific)
Analyzescode security
(not SharePoint-specific)
Checks memory leaks
(SharePoint-specific)
Combination of FxCop and SPDisposeCheck for SharePoint Online

13. The Gap…
What’smissing?
•Analyze SharePoint specific code quality!
•Analyze SharePoint dependencies!
•Gather SharePoint metrics!
•Documentthe SharePoint solution / app!
•Assess the migratabilityto the app model!

14. CommericalProducts
Free version
SPCopCommunity Edition
Free version
SPCAF Migration Assessment

15. CODE ANALYSISWITH SPCAF

16. •RunSPCAF manuallyor on solution build
•Doubleclickresultsin ErrorList to openthe lineofcode
SPCAF in Visual Studio

17. SPCAF Client Application

18. Use predefined rulesetse.g. SP2013 Compatibility
Create your own ruleset
Enable/disable rules
Adjust severity of notifications
Information
Warning
Error
Configure Rulesets

19. Run SPCAF in TeamBuildas Quality Gate
•Custom Build Activity
•Supports TFS 2010/2012/2013, VS Online, Team City etc.
Build in TFS on-premises
Build in Visual Studio Online
Continuous Integration

20. DEVELOP CUSTOM RULES

21. Youwantto ruleyourself? (1) usingSPCAF.Sdk; usingSPCAF.Sdk.Rules; usingSPCAF.Sdk.Model; usingSPCAF.Sdk.Model.Extensions;
1.Createemptyclasslibrary
2.AddSPCAF.SDK.dll assemblyreference
3.Createclassand addusings
4.Add methodstubby inheritingfrom ”Rule” namespaceSP24.Rules{ publicclassFeatureNameStartsWithSP24: Rule<FeatureDefinition> { publicoverridevoidVisit(FeatureDefinitiontarget, NotificationCollectionnotifications) {} }}

22. 5.Add RuleMetadatanamespaceSP24.Rules{ [RuleMetadata(typeof(Naming), CheckId= "SPC99001", DisplayName= "Feature name should start with SP24", Description = "A feature name should be prefixed with 'SP24'.", DefaultSeverity= Severity.Warning, SharePointVersion= newstring[] { "12", "14", "15"}, Message = "Feature '{0}' should start with 'SP24'.", Resolution = "Change the folder name of the feature and add the name at the beginning, e.g.‘SP24.Intranet.Components.ContentTypesFeature'.")] publicclassFeatureNameStartsWithSP24: Rule<FeatureDefinition> { ...
Youwantto ruleyourself? (2)

23. 7.Build and drop the assembly into the SPCAF installation folderpublicclassFeatureNameStartsWithSP24: Rule<FeatureDefinition> { publicoverridevoidVisit(FeatureDefinitiontarget, NotificationCollectionnotifications) { if(!target.FeatureName.StartsWith("SP24")) { stringmessage = string.Format(this.MessageTemplate(), target.FeatureName); Notify(target, message, notifications); } } }
6.Implement the rule
Youwantto ruleyourself? (3)

24. Summary
•Code Quality must notbe a fluke!
•Helps you to find problems earlier
•Saves yourtime & money
•Prepares you for changes and upgrades
•QA can be implemented in several steps
Also check out my session:
SharePoint Continuous Integration with VS Online and Azure
D2S3DEV 10/16/201411:30 AM

25. References
•SharePoint Code Analysis Frameworkspcaf.com
•FreeSPCopCode Checkgo.spcaf.com/spcopceI
•FreeSPCAF Code Migration Assessmentgo.spcaf.com/spcafma
•SharePoint health check: Extracting SP Customizationsurl.spcaf.com/extract

26. questions?
WWW.MATTHIASEINIG.DE
@MATTEIN

27. thank you.
SHAREPOINT AND PROJECT CONFERENCE ADRIATICS
ZAGREB, 10/15/2014 -10/16/2014