SonarDelphi下載SonarDelphi源代碼下載

SonarDelphi

其他類別

v1.0.8

下載

請注意

Sonardelphi的叉子現在已經過時了，幾年來沒有任何貢獻。

Embarcadero建議您採用此處找到的叉子：https：//github.com/integrated-application-development/sonar-delphi

他們的叉子已被Sonarqube接受和採用，這是一項艱鉅的成就。

Embarcadero的Sonar Delphi插件的官方版本，用於使用Sonarqube分析Delphi源代碼。努力將其他版本的更新和貢獻收集到該版本中，並具有新功能。感謝Jam Software的Joachim Marder和Mendrix的Laurens Van Run與我們合作，以及其他為Github上的Sonar-Delphi項目做出貢獻的所有人。

~~我們正在接受拉動請求，並尋找更多的貢獻者。~~

我們不再接受拉的請求。我們建議您為上述替代存儲庫做出貢獻。

Sonarqube Delphi

是Sonarqube插件，提供

49 Delphi規則
使用Delphicodecoverage或SmartBear的AQTime（需要許可證）的測試分配
可選的.html輸出用於測試覆蓋
使用Dunitx的單位測試結果

這是插件Version 1.0。需要Sonarqube 7.9（LTS）或更高（用Sonarqube 7.9.3和8.2.0測試）

報告問題

Sonarqube Delphi插件使用GitHub的集成問題跟踪系統來記錄錯誤和功能請求。如果您想提出問題，請遵循以下建議：

在記錄錯誤之前，請搜索問題跟踪器，以查看是否有人已經報告了問題。
如果問題尚未存在，請創建一個新問題
請在問題報告中提供盡可能多的信息，我們想知道您正在使用的Sonarqube Delphi插件以及Sonarqube版本的版本。
如果可能的話，請嘗試創建複製問題的測試案例或項目。

實施功能

計數代碼，語句，文件數量
計數類，軟件包數量，方法數量，訪問者數量
計數公共API的數量（方法，類和字段）
計數評論比率，評論行（包括空白行）
CPD（代碼重複，多少行，屏蔽和數量數量）
代碼複雜性（每個方法，類，文件；方法，類和文件上的複雜性分佈）
LCOM4和RFC
代碼著色
語法中的彙編語法
包括聲明
解析預處理器語句
規則
可標記的問題
“死”代碼識別
未使用的文件識別
未使用的功能
未使用的程序（可選的AQTime和Delphicodecoverage）
- 使用AQTime的覆蓋範圍
- 足夠對新代碼的覆蓋範圍（可選的DUNIT）
- 測試結果

分析Delphi項目的步驟

安裝Sonarqube服務器（本地ZIP最簡單以獲取更多詳細信息）。檢查插件的最新版本的支持版本。
安裝Sonarqube Scanner Runner，並確保您可以從擁有源代碼的目錄中調用它
安裝Delphi插件（有關更多詳細信息，請參見安裝插件）。
檢查與您的跑步者相對應的示例項目，以了解您需要創建哪個配置文件。您可以在Sonar-Delphi/樣品中找到樣品。
從項目根目錄中運行分析儀命令
請按照分析結束時提供的鏈接來瀏覽您項目在Sonarqube UI中的質量（請參閱：瀏覽Sonarqube）

代碼假設

語法不是案例不敏感的，但是Delphi代碼是。插件處理了Delphisourcesanitizer類，該類別為Antlr Parser小寫字符（“ LA”方法）
類的數量包括：類，記錄
目錄被視為包裝。軟件包數量等於目錄數。
{$ if xxx}和{$ ifend}之間的預處理器定義被刪除，{$ else}零件保留。（defineresolver類）。
進口到Sonarqube的來源通過InclubleSolver類解析。這意味著源將被降低，未知的預處理器定義將被切除。

編碼和單位測試

可以通過Delphicodecoverage工具完成編解碼。使用

 CodeCoverage.exe -xml -xmllines

要創建可以通過此插件導入的XML輸出。因此，您必須編輯您的聲納項目屬性：

 sonar.delphi.codecoverage.tool=dcc
sonar.delphi.codecoverage.report=Test/CoverageResults/CodeCoverage_Summary.xml

與Dunit的UNITSEST

要從Dunit導入測試結果，您必須使用[Dunit擴展]（https://github.com/mendrix/dunit-extension）並使用提供的跑步者（不需要將測試類更改為ttestCaseexeension）。

 ExitCode := TTestRunnerUtils.RunRegisteredTests;

如果沒有給出參數，這將使用GUI進行測試。使用參數-xml該工具將創建與Sonarqube的Junit兼容的XML輸出。使用-output您的可以指定輸出目錄

 MyTester.exe -xml -output <outputdirectory>

要導入這些測試結果，請將以下行添加到您的聲納項目屬性：

 sonar.junit.reportsPath=TestResults

您還必須指定插件可以在何處找到測試文件。重要的是，您的測試中的源文件在您的源目錄中被排除在外。

 sonar.exclusions=MyTestFiles/*
sonar.tests=MyTestFiles

與Dunitx的Unitests

也可以從Dunitx導入結果。因此，您必須添加文件

 DUnitX.Loggers.XML.SonarQube.pas

到您的Dunitx項目。然後更改應用程序的.dpr並為源目錄添加功能（這用於查找與Unittest的Delphi單元相對應的正確.pas文件）：

 TOptionsRegistry.RegisterOption<String>('sources', 's', 'Specify a file with on each line a directory where the PAS-files of the unittests can be found.', procedure (AString: String) begin
  LSourcesDir := AString;
end);
sqLogger := TDUnitXXMLSonarQubeFileLogger.Create(LSourcesDir, TDUnitX.Options.XMLOutputFile);
runner.AddLogger(sqLogger);

要導入所得的XML文件，請將以下行添加到您的聲納項目屬性：

 sonar.testExecutionReportPaths=Test/TEST-dunitx-sqresults.xml

帶有代碼覆蓋示例的UNITSESTS

要獲得Sonarqube的編碼範圍和Unitests結果，您必須將上述選項結合在一起。例如：

 CodeCoverage.exe -e MyTester.exe -m MyTester.map -a ^^-xml^^ ^^-output TestResults^^ -ife -spf sourcedirs.txt -uf unitstotest.txt -od CoverageResults -html -xml -xmllines

如何構建插件

先決條件

要構建插件，您需要Java 8和Maven 3.1（或更大）。

JDK
小牛

編譯和測試

 mvn compile
mvn test

包裝為插件

 mvn package

現在，您可以將插件從/target/目錄複製到Sonarqube插件目錄。

進食

首先運行Eclipse Maven目標：

 mvn eclipse:eclipse

然後，可以使用文件 - >導入將項目導入Eclipse，然後選擇“常規” - >現有項目中的工作空間。

導入Intellij

只需在Intellij中打開pom.xml，就可以自行解決大多數依賴。

如何開發和調試插件

Sonarqube擁有有關開發插件的出色文檔。要使用Sonarqube掃描儀調試此插件，您只需設置以下環境變量（在Windows上）：

 SET SONAR_SCANNER_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8000"

現在，您將日食（或其他）調試器附加到端口8000以開始調試。

用Anltrworks更改語法

該插件使用Antlr3語法來解析Delphi語言。語法定義可以在/src/main/antlr3/org/sonar/plugins/delphi/antlr/delphi.g中找到。檢查和修改此語法的一種簡單方法是使用Antlrworks。在這裡，您可以在新文件上測試語法並實現新的語言定義。

成功更改和測試delphi.g語法後，您必須生成新的解析器代碼（菜單生成，選項生成代碼）。現在，從/src/main/antlr3/org/sonar/plugins/delphi/antlr/output/ to /src/src/main/java/org/org/org/org/org/org/plugins / /src/main/java/org/sonar/plugins/delphi/antlr/ utpects delphilexer.java和delphipharser.java。

注意：確保還測試您的新語法更改很重要。如果您只需要確保可以在沒有錯誤的情況下解析它們，則可以在/src/main/java/org/org/org/sonar/plugins/delphi/antlr中添加新的語言功能（最新是Grammartest2020.pas ）。