© Kellie L. Folkerts/Shutterstock.com
Das SharePoint Code Analysis Framework im Einsatz

Einfach mehr wissen


Das SPCAF, SharePoint Code Analysis Framework, ist eine generische Codeanalyse-Engine, die jegliche Art von Code im Kontext von SharePoint analysieren kann. Dazu gehören XML, JavaScript, .NET-Code, ASPX, HTLM und CSS. Mithilfe von Regeln können Standards für die Programmierung definiert und überprüft werden. Ergebnis dieser Analysen ist jeweils ein Report, der die Analyseergebnisse zusammenfast und grafisch aufbereitet. Dieser Artikel beschreibt die Komponenten und Mehrwerte des SPCAF und zeigt darüber hinaus die Verwendung des Frameworks mit Visual Studio. Ebenso wird erklärt, wie individuelle Regeln zum Framework hinzugefügt werden können.

Das SharePoint Code Analysis Framework beinhaltet verschiedene Komponenten, um SharePoint-Code zu analysieren und zu bewerten. Ziel ist es dabei, die zentralen Fragen von Administratoren, Entwicklern, Qualitätsmanagern und Architekten zu beantworten. Laut Rencore [1], dem Hersteller des SPCAF, beschäftigen diese Stakeholder besonders die folgenden zentralen Fragen: „Wird die Lösung unsere bestehende SharePoint-Farm zerstören?“ „Ist mein Code richtig, und entspricht er Best Practices?“ „Entspricht der Code unserer Unternehmensstrategie und unseren Standards?“ „Ist der Code gut entwickelt und wartbar?“ Um diese Fragen beantworten zu können, lassen sich mit SPCAF .wsp-Dateien und Add-ins für Office 365 und SharePoint 2007–2016 analysieren. Dabei werden SSOM, CSOM, JSOM, REST, XML, HTML, ASPX, JavaScript, CSS und andere Quellen untersucht.

Diese Analyse dient neben der Beantwortung der oben genannten Fragen dem Ziel, Qualitätsstandards einzuhalten, Best Practices anzuwenden, die Wartbarkeit sicherzustellen, Sicherheits- und Governance-Aspekte zu betrachten und die Richtigkeit des Codes zu garantieren.

Die vier Analysekomponenten

Mithilfe von vier verschiedenen Analysekomponenten sollen alle Aspekte der Lösung analysiert werden (Abb. 1). Der SPCop führt Codequalitätsanalyse durch, für die über siebenhundert Regeln in verschiedenen Kategorien zur Verfügung stehen und aktiviert werden können. Diese Regeln beziehen sich auf einzelne Assemblies oder Anwendungen mit einer SharePoint-Abhängigkeit. Außerdem umfassen diese Regeln Elemente innerhalb der .wsp-Dateien bzw. Add-ins und Richtlinien für die Richtigkeit, Sicherheit und Wartbarkeit. Darüber hinaus gibt es Prüfmechanismen zur Einhaltung von Best Practices und Code-Guideline-Regeln, wie etwa die Benennung. Es können eigene Entwicklungsrichtlinien definiert werden, die überprüft und eingehalten werden müssen. Wie diese Regelwerke definiert und angewendet werden, wird im weiteren Verlauf dieses Artikels an einer exemplarischen Analyse ausführlich beschrieben.

Abb. 1: Die vier Analysekomponenten des SPCAF [1]

Abhängigkeiten zwischen Artefakten und SharePoint-Anpassungen werden von der Komponente SPDepend visualisiert. Welche Zusammenhänge durch diese Komponente analysiert werden und welchen Nutzen sie bieten, wird nachfolgend mit Beispielen beschreiben.

Von SPMetrics werden messbare Zahlen berechnet und gezählt. Mit diesem Tool können beispielsweise die Anzahl von Features, Inhaltstypen, Feldern oder die Anzahl der Codezeilen der einzelnen Programmiersprachen gezählt werden. Durch diese Zahlen lässt sich die Komplexität einer Lösung besser beurteilen. Dies reduziert die Entwicklungs- und Betriebsrisiken und hilft dabei, Migrationen transparenter zu gestalten, da für alle Beteiligten besser ersichtlich ist, was in einem Package steckt. Außerdem ermöglichen diese Kennzahlen beispielsweise, im Verlaufe eines Projekts den Fortschritt zu beobachten und verschiedene Analysen zu vergleichen.

Eine wichtige Aufgabe für Administratoren ist die Dokumentation von Änderungen in SharePoint. Mittels SPInventory kann eine vollständige Dokumentation des Codes generiert werden. Diese technische Dokumentation aus den Lösungen wird in Form eines Word-Dokuments generiert und kann individuell angepasst werden. Dabei werden alle SharePoint-Anpassungen wie Timer Jobs, Web Services und Event Receiver aufgelistet. Dazu gehören auch Informationen über die Version der installierten Komponenten, das Datum der Installation und weitere. Wenn Fehlermeldungen auftreten, können diese Reports dabei unterstützen, eine Feature-ID oder die ID eines Inhaltstyps zuzuordnen.

Analyse einer Solution bzw. eines Add-ins

Die SPCAF-Installation beinhaltet einen eigenständigen Client und eine Visual-Studio-Integration. Daraus ergeben sich verschiedene Wege, um eine Analyse zu starten. Die Analyse kann grundsätzlich auf allen SharePoint-Projekten angewendet werden, so beispielsweise einer Solution, einem SharePoint- oder Provider-Host...

Neugierig geworden? Wir haben diese Angebote für dich:

Angebote für Gewinner-Teams

Wir bieten Lizenz-Lösungen für Teams jeder Größe: Finden Sie heraus, welche Lösung am besten zu Ihnen passt.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang