<h1 style="text-align: justify;">Giới thiệu chung&nbsp;</h1>
Trong b&agrave;i viết trước, Tek4 đ&atilde; giới thiệu cho c&aacute;c bạn về Flutter cũng như c&aacute;ch <a href="https://tek4.vn/huong-dan-cai-dat-plugin-flutter-tren-windows">c&agrave;i đặt plugin</a> n&agrave;y. Vậy n&ecirc;n ta sẽ n&oacute;i kĩ hơn về SonarQube v&agrave; Docker.
SonarQube l&agrave; một trong những c&ocirc;ng cụ m&agrave; bất kỳ nh&agrave; ph&aacute;t triển n&agrave;o cũng n&ecirc;n biết.&nbsp;SonarQube (trước đ&acirc;y l&agrave; Sonar) l&agrave; một nền tảng m&atilde; nguồn mở do SonarSource ph&aacute;t triển nhằm mục đ&iacute;ch kiểm tra li&ecirc;n tục chất lượng m&atilde; để thực hiện việc đ&aacute;nh gi&aacute; tự động với ph&acirc;n t&iacute;ch tĩnh m&atilde; (SCA) để ph&aacute;t hiện lỗi tr&ecirc;n hơn 20 ng&ocirc;n ngữ lập tr&igrave;nh. N&oacute;i một c&aacute;ch đơn giản, n&oacute; đ&oacute;ng vai tr&ograve; như một &ldquo;nh&agrave; gi&aacute;m định&rdquo; chất lượng của c&aacute;c code.
<img style="width: 700px; display: block; margin-left: auto; margin-right: auto;" src="https://tek4.vn/public_files/4eb29ca4-a396-440f-8123-0f12c82576aa" alt="SonarQube l&agrave; g&igrave;" />
C&ograve;n Docker l&agrave; g&igrave;? Đ&acirc;y l&agrave; một nền tảng container m&atilde; nguồn mở, gi&uacute;p tự động triển khai c&aacute;c ứng dụng Linux v&agrave; Windows. Nhờ Docker, ta sẽ c&oacute; một m&aacute;y ảo nhẹ hơn nhiều với mọi thứ bạn cần đ&atilde; được cấu h&igrave;nh sẵn.<img style="width: 400px; display: block; margin-left: auto; margin-right: auto;" src="https://tek4.vn/public_files/888c9bba-2cf0-4f8e-93bb-1e6bc554ab86" alt="docker l&agrave; g&igrave;" />
<h1 style="text-align: justify;">C&aacute;c bước c&agrave;i đặt</h1>
<h2 style="text-align: justify;">Bước 1. Tải xuống v&agrave; c&agrave;i đặt Docker</h2>
V&agrave;o trang <a href="https://95.216.12.176/engine/install/?__cpo=aHR0cHM6Ly9kb2NzLmRvY2tlci5jb20">https://docs.docker.com/engine/install/</a> v&agrave; c&agrave;i đặt phi&ecirc;n bản Docker Desktop ph&ugrave; hợp với hệ điều h&agrave;nh của bạn.
Docker c&oacute; hỗ trợ cho cả Apple Silicon, v&agrave; kudos.
Sau khi tải xuống v&agrave; chạy, h&atilde;y truy cập <a href="https://95.216.12.176/?__cpo=aHR0cHM6Ly9odWIuZG9ja2VyLmNvbQ">https://hub.docker.com</a> &nbsp;để tạo t&agrave;i khoản. B&acirc;y giờ ch&uacute;ng ta đ&atilde; c&oacute; một t&agrave;i khoản miễn ph&iacute;.
ID của Docker sẽ ch&iacute;nh l&agrave; username của bạn.
<h2 style="text-align: justify;">Bước 2. Tải xuống SonarQube v&agrave; tạo container&nbsp;</h2>
Giả sử bạn muốn bắt đầu với phi&ecirc;n bản&nbsp;Community free, c&oacute; thể chạy từ ch&iacute;nh terminal trong m&aacute;y bạn:
<code>docker pull sonarqube:9.3-community</code>
Bạn c&oacute; thể gặp c&acirc;u b&aacute;o lỗi như sau:
<code>no matching manifest for linux/arm64/v8 in the manifest list entries</code>
Tại thời điểm viết b&agrave;i, SonarQube chưa c&oacute; hỗ trợ ch&iacute;nh thức cho Apple Silicon, v&igrave; vậy nếu bạn muốn tải phi&ecirc;n bản 9 + của SonarQube, bạn c&oacute; thể thử. Tuy nhi&ecirc;n,&nbsp; n&oacute; sẽ hoạt động rất chậm v&agrave; nếu một số t&aacute;c vụ sẽ mất hơn 30 gi&acirc;y tải tr&ecirc;n Apple Silicon, &iacute;t nhất l&agrave; trong năm đầu ti&ecirc;n. Vậy n&ecirc;n Tek4 kh&ocirc;ng khuy&ecirc;n bạn n&ecirc;n tải bản đ&oacute;.
Lệnh dưới đ&acirc;y sẽ buộc ta phải download h&igrave;nh ảnh Docker:
<code>docker pull sonarqube:9.3-community --platform linux/amd64</code>
<h2 style="text-align: justify;">Bước 3. Bỏ qua bước 2 v&agrave; thử lại lần nữa</h2>
V&igrave; vậy, h&atilde;y qu&ecirc;n bước 2 đi v&agrave; t&igrave;m một h&igrave;nh ảnh Docker kh&ocirc;ng ch&iacute;nh thức c&oacute; thể hoạt động tr&ecirc;n chip Silicon.
<code>docker pull mwizner/sonarqube:8.9.5-community</code>
Bước tiếp theo l&agrave; tạo container/app, nhưng trước ti&ecirc;n, ta cần kiểm tra h&igrave;nh ảnh vừa tải xuống.
<code>docker images</code> <code>REPOSITORY &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; TAG &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; IMAGE ID &nbsp; &nbsp; &nbsp; mwizner/sonarqube&nbsp; &nbsp; 8.9.5-community &nbsp; f5e2e7d2d122 &nbsp;&nbsp;</code>
H&atilde;y đặt t&ecirc;n sonarqubeapp cho container v&agrave; sử dụng ID h&igrave;nh ảnh từ tr&ecirc;n:
<code>docker create --name sonarqubeapp -p 9000:9000 f5e2e7d2d122</code>
B&acirc;y giờ, ch&uacute;ng ta h&atilde;y bắt đầu tạo container:
<code>docker start sonarqubeapp</code>
Sau khi tải trong 15-20 gi&acirc;y, bạn c&oacute; thể truy cập <a href="https://95.216.12.176/?__cpo=aHR0cDovL2xvY2FsaG9zdDo5MDAw">http://localhost:9000</a> v&agrave; c&oacute; một trang web đang chạy. Để bắt đầu, h&atilde;y d&ugrave;ng admin/admin&nbsp;l&agrave;m t&ecirc;n người d&ugrave;ng v&agrave; mật khẩu.
<h2 style="text-align: justify;">Bước 4. C&agrave;i plugin để ph&acirc;n t&iacute;ch Dart v&agrave; Flutter</h2>
Tại thời điểm viết b&agrave;i, ta kh&ocirc;ng c&oacute; bản hỗ trợ ch&iacute;nh thức cho Dart v&agrave; Flutter từ SonarQube, nhưng ta c&oacute; thể lấy từ GitHub.
<a href="https://95.216.12.176/insideapp-oss/sonar-flutter?__cpo=aHR0cHM6Ly9naXRodWIuY29t">https://github.com/insideapp-oss/sonar-flutter</a>.
V&agrave;o Releases v&agrave; chọn bản mới nhất. Trong b&agrave;i viết n&agrave;y, ch&uacute;ng ta sẽ d&ugrave;ng <a href="https://95.216.12.176/insideapp-oss/sonar-flutter/releases/download/0.4.0/sonar-flutter-plugin-0.4.0.jar?__cpo=aHR0cHM6Ly9naXRodWIuY29t">sonar-flutter-plugin-0.4.0.jar</a>
<h2 style="text-align: justify;">Bước 5. Copy plugin .jar v&agrave;o container</h2>
V&agrave;o folder Downloads hoặc nơi plugin được tải xuống v&agrave; chạy lệnh sau:
<code>docker cp sonar-flutter-plugin-0.4.0.jar sonarqubeapp:/opt/sonarqube/extensions/plugins</code>
Ta đang thực hiện việc sao tệp bằng c&aacute;ch sử dụng docker cp v&igrave; hệ thống tệp của container kh&ocirc;ng hiển thị cho ta&nbsp; từ chế độ xem b&ecirc;n ngo&agrave;i.&nbsp;
sonarqubeapp l&agrave; t&ecirc;n của container, v&agrave; sau dấu &ldquo;:&rdquo; l&agrave; đường dẫn đến thư mục plugin b&ecirc;n trong container.
Sau đ&oacute;, ch&uacute;ng ta cần khởi động lại container để c&aacute;c plugin l&agrave;m mới.
<code>docker restart sonarqubeapp</code>
Nếu tất cả c&aacute;c bước cho đến nay đ&atilde; th&agrave;nh c&ocirc;ng, th&igrave; b&ecirc;n trong Portal, ch&uacute;ng ta sẽ c&oacute; thể thấy giao diện như sau:
<img style="width: 700px; display: block; margin-left: auto; margin-right: auto;" src="https://tek4.vn/public_files/6a444701-0429-4b8a-9807-7aff02444e79" alt="SonarQube l&agrave; g&igrave;" />
<h2 style="text-align: justify;">Bước 6. Tải SonarScanner về</h2>
M&aacute;y qu&eacute;t sẽ cho ph&eacute;p ta tải kết quả cục bộ l&ecirc;n Portal để hiển thị dữ liệu.
N&oacute; c&oacute; thể chạy từ h&igrave;nh ảnh Docker với quyền truy cập v&agrave;o kho lưu trữ nguồn, nhưng ta sẽ tập trung v&agrave;o việc c&agrave;i đặt cục bộ ngay b&acirc;y giờ.
V&agrave;o trang <a href="https://95.216.12.176/latest/analysis/scan/sonarscanner/?__cpo=aHR0cHM6Ly9kb2NzLnNvbmFycXViZS5vcmc">https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/</a> v&agrave; tải kho lưu trữ xuống v&agrave; giải n&eacute;n thư mục trong thư mục nh&agrave; của m&igrave;nh.
Đừng qu&ecirc;n th&ecirc;m đường dẫn v&agrave;o .bash_profile hoặc .zshrc hoặc bất kỳ cấu h&igrave;nh vỏ n&agrave;o ta c&oacute; thể c&oacute; tr&ecirc;n hệ thống của m&igrave;nh để lệnh sẽ hiển thị ở mọi nơi v&agrave; sau đ&oacute; khởi động lại terminal của m&igrave;nh.
<code>export PATH="$HOME/sonar-scanner-4.7.0.2747-macosx/bin:$PATH"</code>
<h2 style="text-align: justify;">Bước 7. Tạo tệp cấu h&igrave;nh</h2>
Bước cuối c&ugrave;ng, ch&uacute;ng ta cần một tệp cấu h&igrave;nh trong file gốc của dự &aacute;n Flutter để trao đổi một số th&ocirc;ng tin giữa m&atilde; nguồn v&agrave; portal của SonarQube.
<code># Project identification, either hardcode it or use Environment variables</code>
<code>sonar.projectKey=my-project-key</code>
<code>sonar.projectName=My Project</code>
<code>sonar.login=my-long-token</code>
<code>sonar.host.url=http://localhost:9000</code>
<code># Source code __cpLocation.</code>
<code># Path is relative to the sonar-project.properties file. Defaults to .</code>
<code># Use commas to specify more than one folder.</code>
<code>sonar.sources=lib</code>
<code>sonar.tests=test</code>
<code># Encoding of the source code. Default is default system encoding.</code>
<code>sonar.sourceEncoding=UTF-8</code>
<code># exclude generated files</code>
<code>sonar.exclusions=test/**/*_test.mocks.dart,lib/**/*.g.dart</code>
D&ograve;ng 2&ndash;4: bạn sẽ nhận được ch&uacute;ng sau khi tạo một dự &aacute;n mới b&ecirc;n trong portal.
<h2 style="text-align: justify;">Bước 8. Chạy phần mềm</h2>
Trong bước cuối c&ugrave;ng, ch&uacute;ng ta h&atilde;y đặt tất cả lại với nhau v&agrave; chạy như sau:
<code>flutter pub get # just in case flutter test --machine --coverage &gt; tests.output sonar-scanner</code>
N&oacute; sẽ tải l&ecirc;n kết quả kiểm tra của ch&uacute;ng ta v&agrave; c&aacute;c th&ocirc;ng tin chi tiết về cơ sở m&atilde; l&ecirc;n Portal để ph&acirc;n t&iacute;ch. N&oacute; sẽ giao diện như sau nếu ch&uacute;ng ta kh&ocirc;ng gặp lỗi g&igrave;:
<img style="width: 700px; display: block; margin-left: auto; margin-right: auto;" src="https://tek4.vn/public_files/650154b0-6605-4775-bad3-7f8d7e1cde94" alt="SonarQube l&agrave; g&igrave;" />
<h3 style="text-align: justify;">Lưu &yacute;:</h3>
Mọi người ch&uacute; &yacute; ở bước thứ 3. Ch&uacute;ng ta đ&atilde; nhận được h&igrave;nh ảnh ban đầu từ đ&acirc;u đ&oacute;, sau đ&oacute; cấu h&igrave;nh n&oacute; cho ph&ugrave; hợp với trường hợp cụ thể của m&igrave;nh.
Nếu ch&uacute;ng t&ocirc;i muốn lưu h&igrave;nh ảnh của to&agrave;n bộ thiết lập để sử dụng tr&ecirc;n m&aacute;y Mac kh&aacute;c hoặc thậm ch&iacute; ph&acirc;n phối n&oacute; ra thế giới, ch&uacute;ng ta c&oacute; thể xuất bản container/app của m&igrave;nh dưới dạng kho lưu trữ ri&ecirc;ng tư hoặc c&ocirc;ng cộng.
<code># First head to your Docker Hub account and create a new repository (either private or public)</code>
<code>docker commit sonarqubeapp</code>
<code>docker images # get the newly created empty image id</code>
<code>docker tag [Empty Image Id] [Docker Id]/[Repository Name]:[Version]</code>
<code>docker push [Docker Id]/[Image Name]:[Version]</code>
V&iacute; dụ:
<code>docker commit sonarqubeapp</code> <code>docker images </code> <code>docker tag b0dcc123456 myaccount/project-image:1.0</code> <code>docker push myaccount/project-image:1.0</code>
Ở c&aacute;c lần sau, ta c&oacute; thể bỏ qua c&aacute;c bước 2&ndash;5.
<h1 style="text-align: justify;">Tổng kết</h1>
SonarQube l&agrave; một c&ocirc;ng cụ tuyệt vời c&oacute; thể tăng tốc độ v&agrave; số lượng chất lượng code bằng c&aacute;ch tận dụng c&aacute;c số liệu thống k&ecirc; như code smell (code hỏng), v&ugrave;ng phủ s&oacute;ng m&atilde;, đường tr&ugrave;ng lặp, độ phức tạp của chu k&yacute; (cyclomatic complexity), v.v.
N&oacute; cũng c&oacute; thể được t&iacute;ch hợp với CI/CD để ch&uacute;ng ta c&oacute; th&ecirc;m nhiều t&iacute;nh năng hơn, như trang tr&iacute; pull request hoặc thiết lập đường ray bảo vệ chất lượng&nbsp; code của nh&oacute;m của ri&ecirc;ng m&igrave;nh, v.v.

Admin

8 bước cài đặt Flutter và SonarQube cho SCA

Cùng tác giả

Admin

Có liên quan