ASP.NET MVC Web Example

注意事項

根目錄sln檔案為Sonarqube掃描必須檔案，若僅部屬服務不一定需要此sln檔案，僅原始碼+Dockerfile即可
掃描後仍需檢查確認送至Sonarqube UI的檔案是否相符

流程說明

(選擇性)透過Visual Studio 2019來建立專案

選擇選擇建立新的專案
上方過濾選擇C#、所有平台、Web
再選擇ASP.NET Core Web 應用程式 (Model-View-Controller) 這個選擇性非強制性的，就是只要是.Net Core或是其他有支援雲端的均可，只是此範本主要針對Asp.Net Core，以及初始範本建立即是MVC的選項。
輸入專案名稱，這裡輸入自己的專案名稱在這裡將以使用者常面臨的狀況，自訂專案名稱，因此取WebApplication2
在這裡勾選啟用Docker、並在下方下拉的Docker OS內選擇Linux 一般使用者若再自身電腦上安裝Docker Deskktop，其預設為Linux，而Docker OS為Windows的支援僅有Windows pro或是enterprise版本才有提供，iiidevops所提供的為Linux基礎的k8s部屬環境，所以無論是要在本地端或是iiidevops請都下拉Docker OS為Linux的選項。
完成上述步驟後壓下建立專案 這個步驟請稍待幾分鐘，第一次會花費一些時間，若已完成會看到左下角出現就緒的文字
測試本地端環境上方執行測試環境請選擇Docker選項後執行一次確認是否Visual Studio建立的專案可以確實在本地端Docker上執行選擇測試環境正常運作畫面
均正常以後可以參考下方文件根據狀況做修改並放到專案內進行測試

(選擇性)透過iiidevops的UI來建置專案

如果沒有現成專案的話可以考慮用範本

準備專案+從程式碼建立專案用範本主要目的是為了省下.rancher-pipeline.yaml與iiidevops資料夾檔案
放程式碼進去 iiidevops規定須放在app資料夾內如果一般剛從Visual Studio建立專案名稱為ASP-MVC-example的專案，則會有下列目錄結構，sln檔案在上層，然後同一層會看到ASP-MVC-example的資料夾，這個資料夾放過去建立的iiidevops專案時資料夾要改名為app，sln檔案則一樣放在與專案同一層的目錄

D:.
│  .dockerignore
│  ASP-MVC-example.sln
│
└─ASP-MVC-example
    │  appsettings.Development.json
    │  appsettings.json
    │  ASP-MVC-example.csproj
    │  ASP-MVC-example.csproj.user
    │  Dockerfile
    │  Program.cs
    │  Startup.cs
    │
    ├─bin
    │  └─Debug
    │      └─netcoreapp3.1
    │              appsettings.Development.json
    │              appsettings.json
    │              ASP-MVC-example.deps.json
    │              ASP-MVC-example.dll
    │              ASP-MVC-example.exe
    │              ASP-MVC-example.pdb
    │              ASP-MVC-example.runtimeconfig.dev.json
    │              ASP-MVC-example.runtimeconfig.json
    │              ASP-MVC-example.Views.dll
    │              ASP-MVC-example.Views.pdb
    │
    ├─Controllers
    │      HomeController.cs
    │
    ├─Models
    │      ErrorViewModel.cs
    │
    ├─obj
    │  │  ASP-MVC-example.csproj.nuget.dgspec.json
    │  │  ASP-MVC-example.csproj.nuget.g.props
    │  │  ASP-MVC-example.csproj.nuget.g.targets
    │  │  project.assets.json
    │  │  project.nuget.cache
    │  │
    │  ├─Container
    │  │      ContainerDevelopmentMode.cache
    │  │      ContainerId.cache
    │  │      ContainerName.cache
    │  │      ContainerRunContext.cache
    │  │
    │  └─Debug
    │      └─netcoreapp3.1
    │          │  .NETCoreApp,Version=v3.1.AssemblyAttributes.cs
    │          │  apphost.exe
    │          │  ASP-MVC-example.AssemblyInfo.cs
    │          │  ASP-MVC-example.AssemblyInfoInputs.cache
    │          │  ASP-MVC-example.assets.cache
    │          │  ASP-MVC-example.csproj.AssemblyReference.cache
    │          │  ASP-MVC-example.csproj.CopyComplete
    │          │  ASP-MVC-example.csproj.CoreCompileInputs.cache
    │          │  ASP-MVC-example.csproj.FileListAbsolute.txt
    │          │  ASP-MVC-example.csprojAssemblyReference.cache
    │          │  ASP-MVC-example.dll
    │          │  ASP-MVC-example.GeneratedMSBuildEditorConfig.editorconfig
    │          │  ASP-MVC-example.genruntimeconfig.cache
    │          │  ASP-MVC-example.MvcApplicationPartsAssemblyInfo.cache
    │          │  ASP-MVC-example.pdb
    │          │  ASP-MVC-example.RazorAssemblyInfo.cache
    │          │  ASP-MVC-example.RazorAssemblyInfo.cs
    │          │  ASP-MVC-example.RazorCoreGenerate.cache
    │          │  ASP-MVC-example.RazorTargetAssemblyInfo.cache
    │          │  ASP-MVC-example.RazorTargetAssemblyInfo.cs
    │          │  ASP-MVC-example.TagHelpers.input.cache
    │          │  ASP-MVC-example.TagHelpers.output.cache
    │          │  ASP-MVC-example.Views.dll
    │          │  ASP-MVC-example.Views.pdb
    │          │
    │          ├─Razor
    │          │  └─Views
    │          │      │  _ViewImports.cshtml.g.cs
    │          │      │  _ViewStart.cshtml.g.cs
    │          │      │
    │          │      ├─Home
    │          │      │      Index.cshtml.g.cs
    │          │      │      Privacy.cshtml.g.cs
    │          │      │
    │          │      └─Shared
    │          │              Error.cshtml.g.cs
    │          │              _Layout.cshtml.g.cs
    │          │              _ValidationScriptsPartial.cshtml.g.cs
    │          │
    │          └─staticwebassets
    │                  ASP-MVC-example.StaticWebAssets.Manifest.cache
    │                  ASP-MVC-example.StaticWebAssets.xml
    │
    ├─Properties
    │      launchSettings.json
    │
    ├─Views
    │  │  _ViewImports.cshtml
    │  │  _ViewStart.cshtml
    │  │
    │  ├─Home
    │  │      Index.cshtml
    │  │      Privacy.cshtml
    │  │
    │  └─Shared
    │          Error.cshtml
    │          _Layout.cshtml
    │          _ValidationScriptsPartial.cshtml
    │
    └─wwwroot
        │  favicon.ico
        │
        ├─css
        │      site.css
        │
        ├─js
        │      site.js
        │
        └─lib
            ├─bootstrap
            │  │  LICENSE
            │  │
            │  └─dist
            │      ├─css
            │      │      bootstrap-grid.css
            │      │      bootstrap-grid.css.map
            │      │      bootstrap-grid.min.css
            │      │      bootstrap-grid.min.css.map
            │      │      bootstrap-reboot.css
            │      │      bootstrap-reboot.css.map
            │      │      bootstrap-reboot.min.css
            │      │      bootstrap-reboot.min.css.map
            │      │      bootstrap.css
            │      │      bootstrap.css.map
            │      │      bootstrap.min.css
            │      │      bootstrap.min.css.map
            │      │
            │      └─js
            │              bootstrap.bundle.js
            │              bootstrap.bundle.js.map
            │              bootstrap.bundle.min.js
            │              bootstrap.bundle.min.js.map
            │              bootstrap.js
            │              bootstrap.js.map
            │              bootstrap.min.js
            │              bootstrap.min.js.map
            │
            ├─jquery
            │  │  LICENSE.txt
            │  │
            │  └─dist
            │          jquery.js
            │          jquery.min.js
            │          jquery.min.map
            │
            ├─jquery-validation
            │  │  LICENSE.md
            │  │
            │  └─dist
            │          additional-methods.js
            │          additional-methods.min.js
            │          jquery.validate.js
            │          jquery.validate.min.js
            │
            └─jquery-validation-unobtrusive
                    jquery.validate.unobtrusive.js
                    jquery.validate.unobtrusive.min.js
                    LICENSE.txt

放過去以後會像是這樣

修改.rancher-pipeline.yaml檔案

這個是因為目前的範本Rancher-pipeline掃描並未針對.NET做處理，因此要進行修正，同時需要注意要修改sln的檔案位置與名稱為專案的名稱，詳細如下:

原本範本(未修改前)

- name: Test--SonarQube source code scan
  steps:
  - applyAppConfig:
      answers:
        git.branch: ${CICD_GIT_BRANCH}
        git.commitID: ${CICD_GIT_COMMIT}
        git.repoName: ${CICD_GIT_REPO_NAME}
        git.url: ${CICD_GIT_URL}
        pipeline.sequence: ${CICD_EXECUTION_SEQUENCE}
      catalogTemplate: cattle-global-data:iii-dev-charts3-scan-sonarqube
      name: ${CICD_GIT_REPO_NAME}-${CICD_GIT_BRANCH}-sq
      targetNamespace: ${CICD_GIT_REPO_NAME}
      version: 0.1.0
  when:
    branch:
      include:
      - master
      - develop

修改範本(修改後)

這裡有一行是dotnet build ../ASP-MVC-example.sln;這個是指專案根目錄的ASP-MVC-example.sln檔案，這個sln名稱根據放進來的sln檔案名稱與路徑替換過去即可。

- name: Test--SonarQube source code scan
  steps:
  - runScriptConfig:
      image: mcr.microsoft.com/dotnet/sdk
      shellScript: cd app; 
        echo 'Install scan package';
        apt-get update && apt install -y default-jre nodejs;
        dotnet tool install --global dotnet-sonarscanner;
        export PATH="$PATH:/root/.dotnet/tools";
        dotnet-sonarscanner begin /k:${CICD_GIT_REPO_NAME} /n:${CICD_GIT_REPO_NAME} /v:${CICD_GIT_BRANCH}:${CICD_GIT_COMMIT} /d:sonar.host.url=http://sonarqube-server-service.default:9000;
        dotnet build ../ASP-MVC-example.sln;
        dotnet-sonarscanner end
  when:
    branch:
      include:
      - master
      - develop

修改sln檔案

這個是因為前面有一個部分修改了專案的路徑從專案名稱資料夾，變成app資料夾，因此會有解析錯誤的問題需要修正。在下面說明將以範本內附送的sln檔案為例，變化主要就是Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ASP-MVC-example", "ASP-MVC-example\ASP-MVC-example.csproj", "{7898E239-AEB3-49F7-9707-394E19EADFE6}"這裡變成Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ASP-MVC-example", "app\ASP-MVC-example.csproj", "{7898E239-AEB3-49F7-9707-394E19EADFE6}" EndProject。也就是ASP-MVC-example\ASP-MVC-example.csproj變成app\ASP-MVC-example.csproj

修改前

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.31129.286
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ASP-MVC-example", "ASP-MVC-example\ASP-MVC-example.csproj", "{7898E239-AEB3-49F7-9707-394E19EADFE6}"
EndProject
Global
	GlobalSection(SolutionConfigurationPlatforms) = preSolution
		Debug|Any CPU = Debug|Any CPU
		Release|Any CPU = Release|Any CPU
	EndGlobalSection
	GlobalSection(ProjectConfigurationPlatforms) = postSolution
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Release|Any CPU.Build.0 = Release|Any CPU
	EndGlobalSection
	GlobalSection(SolutionProperties) = preSolution
		HideSolutionNode = FALSE
	EndGlobalSection
	GlobalSection(ExtensibilityGlobals) = postSolution
		SolutionGuid = {B05AE01E-CEBE-4344-B3DA-646698293E91}
	EndGlobalSection
EndGlobal

修改後

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.31129.286
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ASP-MVC-example", "app\ASP-MVC-example.csproj", "{7898E239-AEB3-49F7-9707-394E19EADFE6}"
EndProject
Global
	GlobalSection(SolutionConfigurationPlatforms) = preSolution
		Debug|Any CPU = Debug|Any CPU
		Release|Any CPU = Release|Any CPU
	EndGlobalSection
	GlobalSection(ProjectConfigurationPlatforms) = postSolution
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
		{7898E239-AEB3-49F7-9707-394E19EADFE6}.Release|Any CPU.Build.0 = Release|Any CPU
	EndGlobalSection
	GlobalSection(SolutionProperties) = preSolution
		HideSolutionNode = FALSE
	EndGlobalSection
	GlobalSection(ExtensibilityGlobals) = postSolution
		SolutionGuid = {B05AE01E-CEBE-4344-B3DA-646698293E91}
	EndGlobalSection
EndGlobal

如果沒有Build Sonarqube會跳出甚麼錯誤

09:29:30.676  The SonarScanner for MSBuild integration failed: SonarQube was unable to collect the required information about your projects.
Possible causes:
  1. The project has not been built - the project must be built in between the begin and end steps
  2. An unsupported version of MSBuild has been used to build the project. Currently MSBuild 14.0.25420.1 and higher are supported.
  3. The begin, build and end steps have not all been launched from the same folder
  4. None of the analyzed projects have a valid ProjectGuid and you have not used a solution (.sln)
09:29:30.676  Generation of the sonar-properties file failed. Unable to complete the analysis.
09:29:30.682  Post-processing failed. Exit code: 1

專案資料夾與檔案格式說明

檔案可按照需求做修改，此主要針對大部分專案規定來進行描述，針對不同專案可能會有些許變化，詳細使用方式請參考iiidevops教學說明文件。

型態	名稱	說明	路徑
資料夾	app	專案主要程式碼	根目錄
資料夾	iiidevops	⚠️ (不可更動)devops系統測試所需檔案	在根目錄
檔案	.rancher-pipeline.yml	⚠️ (不可更動)devops系統測試所需檔案	在根目錄
檔案	pipeline_settings.json	⚠️ (不可更動)devops系統測試所需檔案	在iiidevops資料夾內
檔案	app.env	(可調整)實證環境 `web`環境變數添加	在iiidevops資料夾內
檔案	postman_collection.json	(可調整)devops newman部屬測試案例檔案	iiidevops/postman資料夾內
檔案	postman_environment.json	(可調整)devops newman部屬測試環境變數檔案	iiidevops/postman資料夾內
檔案	sideex.json	(可調整)devops Sideex部屬測試檔案	iiidevops/sideex資料夾內
檔案	Dockerfile	(可調整)devops k8s環境部屬檔案	根目錄

iiidevops

專案內.rancher-pipeline.yml請勿更動，產品系統設計上不支援pipeline修改，但若預設README.md文件內有寫引導說明部分則例外。
iiidevops資料夾內pipeline_settings.json請勿更動。
postman資料夾內則是您在devops管理網頁上的Postman-collection(newman)自動測試檔案，devops系統會以postman資料夾內檔案做自動測試。
Dockerfile內可能會看到很多來源都加上前墜dockerhub，此為必須需求，為使image能從iiidevops產品所架設的harbor上作為來源擷取出Docker Hub的image來源。
若使用上有任何問題請至https://www.iiidevops.org/內的聯絡方式頁面做問題回報。

Reference and FAQ

sonarscanner-for-msbuild/
activity-diagram-beta :::info Find this document incomplete? Leave a comment! :::

QskytimQ/asp-dotnet-core-example

ASP.NET MVC Web Example

注意事項

流程說明

(選擇性)透過Visual Studio 2019來建立專案

(選擇性)透過iiidevops的UI來建置專案

修改.rancher-pipeline.yaml檔案

原本範本(未修改前)

修改範本(修改後)

修改sln檔案

修改前

修改後

如果沒有Build Sonarqube會跳出甚麼錯誤

專案資料夾與檔案格式說明

iiidevops

Reference and FAQ

tags: `iiidevops Templates README` `Sonarqube免費版` `Documentation`

QskytimQ/asp-dotnet-core-example

ASP.NET MVC Web Example

注意事項

流程說明

(選擇性)透過Visual Studio 2019來建立專案

(選擇性)透過iiidevops的UI來建置專案

修改.rancher-pipeline.yaml檔案

原本範本(未修改前)

修改範本(修改後)

修改sln檔案

修改前

修改後

如果沒有Build Sonarqube會跳出甚麼錯誤

專案資料夾與檔案格式說明

iiidevops

Reference and FAQ

tags: iiidevops Templates README Sonarqube免費版 Documentation

tags: `iiidevops Templates README` `Sonarqube免費版` `Documentation`