Java Spring Boot (Maven) with MariaDB - RESTful API

spring簡易RESTAPI程式碼範例-docker

如何增加Sonarqube掃描(用預設的QualiyGate)

在app/pom.xml的檔案內plugins新增如下段落後pipeline即可運行Sonarqube掃描，(此專案Sonarqube掃描不包含Unit Test)
在Spring專案的Sonarqube掃描會在openjdk11的環境執行(目前安裝僅支援到java11)，但是對Dockerfile編寫或是部署的網頁用任意Java版本都沒問題。

	<build>
		<plugins>
			<plugin>
          		<groupId>org.sonarsource.scanner.maven</groupId>
          		<artifactId>sonar-maven-plugin</artifactId>
          		<version>3.7.0.1746</version>
        	</plugin>
        	<plugin>
          		<groupId>org.jacoco</groupId>
          		<artifactId>jacoco-maven-plugin</artifactId>
          		<version>0.8.6</version>
        	</plugin>
		</plugins>
	</build>

	<profiles>
    <profile>
      <id>coverage</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <build>
        <plugins>
          <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <executions>
              <execution>
                <id>prepare-agent</id>
                <goals>
                  <goal>prepare-agent</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
  </profiles>

若要設定其他額外的細節也可寫在app/pom.xml，例如排除特定資料夾(與程式碼無關的)、指定的QualityGate、Rule等等
相關可用額外參數說明可參考sonarscanner-for-maven

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

檔案可按照需求做修改，postman_collection_local.json是要快速部署時進行Postman collection測試的的檔案，測試結果會自動產生newman-report.xml。openapi_local.yaml主要是透過owasp ZAP來進行安全掃描，測試報告會自動產生owasp-report.md，內包含詳細的掃描內容與建議，app資料夾內主要放入專案的程式碼(此為選擇性操作與Dockerfile的結構關聯較大)。

型態	名稱	說明	路徑
資料夾	app	專案主要程式碼	根目錄
資料夾	iiidevops	⚠️ devops系統測試所需檔案	根目錄
檔案	spring-mariadb-restapi.sql	(選擇性)請務必放在根目錄, 其為資料庫初始匯入檔案，可為任意檔案名稱，副檔名.sql	根目錄
檔案	.rancher-pipeline.yml	⚠️ pipeline 的定義檔, 除非對 yml 與 rancher pipeline 的語法有足夠的了解, 否則建議不要隨意對內容進行更動, 有可能會造成 pipeline 無法正常運作	根目錄
檔案	Dockerfile	(可調整)devops k8s環境部署檔案	根目錄
檔案	SonarScan	(可調整)整合SonarQube執行檔案	根目錄
檔案	docker-compose.yaml	(非必要)本地端快速部署使用	根目錄
檔案	Dockerfile.local	(非必要)本地端部署使用	根目錄
檔案	README.local.md	(非必要) 本地端使用說明文件	根目錄
檔案	postman_collection_local.json	(可調整)本地端快速部署使用(Postman collection)	app
檔案	openapi_local.yaml	(可調整)本地端快速部署使用(openAPI文件)	app
檔案	newman-report.xml	(自動產生)Postman collection本地端測試報告	app
檔案	owasp-report.md	(自動產生)owasp ZAP-本地端掃描測試報告	app
檔案	app.env	(可調整)提供實證環境之環境變數(env)定義檔	iiidevops
檔案	app.env.develop	(可調整)提供特定分支(develop)實證環境之環境變數(env)定義檔	iiidevops
檔案	pipeline_settings.json	⚠️ (不可更動)devops系統測試所需檔案	iiidevops
資料夾	bin	⚠️ devops系統測試所需執行檔案	iiidevops
資料夾	postman	⚠️ devops系統整合postman測試所需執行檔案	iiidevops
檔案	postman_collection.json	(可調整)devops newman部署測試檔案	iiidevops/postman
檔案	postman_environment.json	(可調整)devops newman部署測試檔案	iiidevops/postman
資料夾	sideex	⚠️ devops系統測整合sideex試所需執行檔案	iiidevops
檔案	Global Variables.json	(可調整)devops sideex部署測試檔案	iiidevops/sideex
檔案	sideex.json	(可調整)devops sideex部署測試檔案	iiidevops/sideex

開發者注意事項

• ⚠️ 若專案建立後程式碼Pull到local端測試, 可參考以下兩個處理方式
  • 透過docker-compose來進行專案快速部署並直接修改符合您作業的環境變數
  • 使用docker部署, 並設定環境變數連上已經建置好的 mysql 或 mariadb, 需要設定環境變數如下:

  `db_host`: 指向到您的資料庫，例如localhost或是其他IP
  `db_name`: 指向到您的資料庫名稱
  `db_username`: 指向到您的資料庫使用者名稱
  `db_password`: 指向到您的資料庫密碼

修改程式碼注意事項

1. 修改資料庫連線
   由於此範本包含自動建立出全新的開發用資料庫, 因此在 pipeline 執行過程會透過環境變數來設定資料庫位址與帳號密碼, 因此專案的資料庫連線部分請不要更動app/src/main/resources/application.properties內的

spring.datasource.url=jdbc:mariadb://${db_host}:3306/${db_name}
spring.datasource.username=${db_username}
spring.datasource.password=${db_password}

2. 修改環境版本
   若實際開發使用並非maven:3.6.3 JDK15, 請至Dockefile修改為自己想要的版本(如需要本機上做測試則須一併連同Dockerfile.local去做修改)

iiidevops

• 專案內.rancher-pipeline.yml是 pipeline 的定義檔, 除非對 yml 與 rancher pipeline 的語法有足夠的了解, 否則建議不要隨意對內容進行更動, 有可能會造成 pipeline 無法正常運作
• 目前範本是依照 tomcat 預設服務的定義 port:8080 設定服務 port 號，如果您的程式需要更改使用其他 port 號 , 請將 .rancher-pipeline.yml 內所有 web.port: 所定義的 8080 改成您實際需要的 port 號。
• iiidevops資料夾
  • postman資料夾內是devops整合API測試工具(postman)的自動測試檔案放置目錄，devops系統會以postman資料夾內 postman_collection.json 的檔案內容進行自動測試
  • sideex資料夾內則是devops整合Web測試工具(sideex)的自動測試檔案放置目錄，devops系統會以sideex資料夾內 sideex 匯出的 json 檔案內容進行自動測試
• Dockerfile內加上前置dockerhub，是為使image能透過本地端harbor擔任Image Proxy的方式抓取Docker Hub上的Images，增加不同專案抓取相同 Image 的效率

Local範本開發

請參考 README.local.md

教學參考來源:

spring-boot-mariadb-crud-example-tutorial

API URL	Method	說明
/api/v1/employees	POST	建立員工身分資料
/api/v1/employees	GET	取得員工身分資料
/api/v1/employees/{id}	GET	取得id是{id}的員工身分資料
/api/v1/employees/{id}	PUT	更新id是{id}的員工身分資料
/api/v1/employees/{id}	GET	刪除id是{id}的員工身分資料

reference

https://www.javaguides.net/2020/01/spring-boot-mariadb-crud-example-tutorial.html

JDK15