กระพือและ SonarQube
หากคุณมีแอป Flutter และต้องการทราบเกี่ยวกับคุณภาพของโค้ดของคุณหรือส่วนใดของโปรเจ็กต์ที่จำเป็นต้องปรับปรุง คุณสามารถใช้ Sonarqube เพื่อวิเคราะห์โค้ดของคุณและดำเนินการข้อมูลนั้นต่อให้คุณได้
SonarQube (หรือที่เรียกว่า Sonar) เป็นแพลตฟอร์มโอเพ่นซอร์สที่วัดคุณภาพของโค้ดตามการวิเคราะห์โค้ดเพื่อตรวจจับกลิ่นโค้ด จุดบกพร่อง การครอบคลุมของโค้ด ความซับซ้อนของโค้ด ปัญหาด้านความปลอดภัย และอื่นๆ
ในบทความนี้ ฉันจะแสดงรายละเอียดวิธีวิเคราะห์โค้ด Flutter ของคุณโดยใช้ SonarQube และ Docker ในขั้นตอนต่อไปนี้:
- ใช้โซนาร์ในพื้นที่
- สร้างโครงการโซนาร์
- กำลังดาวน์โหลดเครื่องสแกนโซนาร์
- กำลังวิเคราะห์โครงการ Flutter ของคุณ
- การตรวจสอบผลลัพธ์
ใช้โซนาร์ในพื้นที่
คุณสามารถเรียกใช้ Sonar ในเครื่องได้โดยใช้ docker สำหรับการรันคำสั่ง docker run --rm -d -p 9000:9000/tcp edsondiasalves/sonarqube-flutter ในเทอร์มินัลของคุณ มันจะดึงและเรียกใช้อิมเมจ SonarQube ที่ติดตั้ง SonarQube Flutter Plugin ไว้แล้ว
โปรดสังเกตว่าปลั๊กอิน SonarQube Flutter ไม่เป็นทางการ และอิมเมจนักเทียบท่าที่ฉันใช้นั้นอยู่ในที่เก็บนักเทียบท่าของตัวเอง อย่าลังเลที่จะใช้มัน แต่ฉันไม่รับผิดชอบต่อปัญหาใด ๆ ที่อาจมี
หากต้องการสร้างภาพโซนาร์และติดตั้งปลั๊กอินด้วยตัวเอง ให้ "ดาวน์โหลดปลั๊กอิน" และคัดลอกไปยังอิมเมจนักเทียบท่าที่ทำงานอยู่:
docker cp ThePluginDownload.jar YourSonarQubeImage:/opt/sonarqube/extensions/plugins
เมื่อรูปภาพดึงเสร็จแล้วและกำลังทำงานอยู่ รูปภาพนั้นจะพร้อมใช้งานในที่อยู่ http://localhost:9000 เพื่อเข้าสู่ระบบให้ใช้ ผู้ดูแลระบบ ในฐานะผู้ใช้และ 1234 เป็นรหัสผ่าน
เมื่อคลิกที่ตัวเลือกเมนู การดูแลระบบ และในส่วน ติดตั้งแล้ว เราจะเห็นว่าติดตั้ง Flutter Plugin เวอร์ชัน 0.4.0 แล้ว
สร้างโครงการโซนาร์
ตอนนี้ถึงเวลาสร้างโครงการโซนาร์ของเรา โดยการคลิกที่ตัวเลือกเมนู โครงการ
และในปุ่ม เพิ่มโครงการ ที่อยู่ตรงกลางหน้า
ตอนนี้ คลิก ด้วยตนเอง และระบุ รหัสโครงการ โปรดทราบว่าชื่อที่แสดงจะเสร็จสมบูรณ์โดยอัตโนมัติ คุณไม่จำเป็นต้องเปลี่ยน-
คลิกที่ปุ่ม ตั้งค่า และหน้าจอใหม่จะปรากฏขึ้นโดยคุณต้องสร้างโทเค็นใหม่ ระบุชื่อ และคลิกที่ปุ่ม สร้าง
โทเค็นใหม่จะถูกสร้างขึ้นสำหรับชื่อโทเค็นที่ระบุ
เมื่อคลิกปุ่ม ดำเนินการต่อ จะแสดงวิธีดำเนินการวิเคราะห์บนแพลตฟอร์มต่างๆ
ตอนนี้โครงการ Sonar ของคุณถูกสร้างขึ้นแล้ว
กำลังดาวน์โหลด SonarScanner
SonarScanner เป็นเครื่องมือ SonarQube อย่างเป็นทางการที่จะสแกนโครงการของคุณและอัปโหลดการวิเคราะห์ไปยังโครงการ Sonar ของคุณ
ดาวน์โหลดตามระบบปฏิบัติการของคุณและเพิ่มโฟลเดอร์ /bin ลงใน Path
ตามตัวอย่างของเวอร์ชัน 4.7.0 windows จำเป็นต้องเพิ่ม sonar-scanner-cli-4.7.0.2747-windows\bin ในเส้นทาง
เพื่อให้แน่ใจว่าใช้งานได้ ให้รัน sonar-scanner -v บนเทอร์มินัลของคุณและตรวจสอบว่าเวอร์ชันจะถูกส่งกลับอย่างถูกต้องหรือไม่
กำลังวิเคราะห์โครงการ Flutter ของคุณ
ตอนนี้ให้สร้าง sonar-project.properties บนโฟลเดอร์รูท Flutter ของคุณแล้ววางโค้ดต่อไปนี้
แทนที่ sonar.projectKey , sonar.projectName และ sonar.login ด้วยข้อมูลที่ให้ไว้เมื่อสร้างโปรเจ็กต์ Sonar ก่อนหน้านี้
ตอนนี้รัน flutter test --machine --coverage > tests.output มันจะรันการทดสอบในเครื่องของคุณและส่งออกเป็นไฟล์ก่อนที่จะอัพโหลดโดย Sonar Scanner
สุดท้าย ให้รัน sonar-scanner เพื่อเริ่มการวิเคราะห์และอัปโหลดไปยังโปรเจ็กต์ Sonar ของคุณ
หากทุกอย่างเรียบร้อย ข้อความที่คล้ายกันจะปรากฏขึ้นในตอนท้าย
การตรวจสอบผลลัพธ์
หลังจากสแกนเสร็จแล้ว ให้กลับไปที่โซนาร์แล้วกด f5 หรือเข้าสู่โปรเจ็กต์ของคุณอีกครั้ง ตอนนี้เราสามารถดูข้อมูลทั่วไปหลักเกี่ยวกับโครงการได้แล้ว
ในแท็บภาพรวม เราจะเห็นข้อมูลทั่วไปเพิ่มเติม
หากต้องการรายละเอียดเพิ่มเติม โปรดสำรวจแท็บอื่นๆ
และVoiláก็เสร็จแล้ว
ตามปกติ ฉันพูดถึงการใช้งานเครื่องมือขั้นพื้นฐานเท่านั้น โปรดตรวจสอบรายละเอียดเพิ่มเติมเกี่ยวกับ Docker, SonarQube และ Flutter ในหน้าเอกสารที่เกี่ยวข้อง
โปรดใช้ความระมัดระวังอีกครั้งโดยใช้รูปภาพและปลั๊กอินที่นำเสนอในบทความนี้ ไม่ใช่ปลั๊กอินอย่างเป็นทางการ และรูปภาพ Sonar docker อยู่ใน repo ส่วนตัวของฉัน
หวังว่าจะมีประโยชน์สำหรับคุณ และขอขอบคุณที่อ่านมาจนถึงตรงนี้ พบกันใหม่ตอนหน้า
