CircleCI: kiến thức cơ bản, orbs và tích hợp liên tục

Kiến trúc CircleCI: Orbs, Executors và Contexts

Kiến trúc CircleCI bao gồm ba cấp độ: Pipeline, Workflow và Job. Pipeline là quy trình gốc được kích hoạt khi commit. Pipeline bao gồm các Workflows — một đồ thị các Jobs có thể chạy tuần tự hoặc song song. Mỗi Job chạy trên một Executor — một môi trường với một hình ảnh cụ thể. Workflow có thể bao gồm các approval gates — xác nhận thủ công trước khi triển khai.

Orbs là các gói cấu hình YAML có thể tái sử dụng được phân phối thông qua CircleCI Orb Registry. Một Orb có thể chứa jobs, commands, executors và các ví dụ. Orbs phổ biến: android, ios, flutter, firebase, slack. Ví dụ, thêm orb android thay thế hơn 50 dòng cấu hình bằng một dòng duy nhất. CircleCI CLI cho phép tạo, kiểm thử và xuất bản các orbs của riêng bạn để tiêu chuẩn hóa pipeline trong tổ chức.

Các loại Executors

Contexts là các tập hợp biến môi trường được đặt tên, có sẵn ở cấp tổ chức. Ví dụ, ngữ cảnh app-store-credentials chứa Apple ID và mật khẩu để xuất bản lên App Store. Điều này đơn giản hóa việc quản lý secrets giữa các dự án mà không trùng lặp.

Thiết lập CircleCI cho các dự án Android và iOS

Đối với dự án Android, CircleCI sử dụng Docker image cibuilds/android với Android SDK. Quy trình làm việc điển hình bao gồm: checkout, cài đặt JDK, bộ nhớ đệm Gradle, build, chạy kiểm thử. Đối với iOS, cần có executor macOS với Xcode và thiết lập code signing. Khi kết nối lần đầu, CircleCI tự động phát hiện loại dự án và tạo cấu hình cơ bản với các cài đặt được đề xuất.

Đối với các dự án Flutter, CircleCI cung cấp orb circleci/flutter, bao gồm các executor với Flutter SDK được cài đặt sẵn cho Linux và macOS. Orb hỗ trợ build cho cả hai nền tảng, bộ nhớ đệm pub-cache và chạy kiểm thử. Việc thiết lập chỉ đơn giản là chỉ định phiên bản Flutter và các lệnh build. Đối với các phiên bản Flutter hoặc Dart tùy chỉnh, bạn có thể sử dụng Docker image với SDK cần thiết. Flutter orb cũng hỗ trợ các tùy chọn nâng cao — ví dụ, phân tích mã qua dart analyze trước khi build.

Android Orb — Bắt đầu nhanh

Android orb từ CircleCI cung cấp các job có sẵn: build-and-test, deploy-to-play-store. Orb tự động cấu hình môi trường, bộ nhớ đệm và chữ ký. Sau khi thêm orb, bạn chỉ cần chỉ định phiên bản SDK và các lệnh build.

Build iOS với macOS Executor

Đối với build iOS, executor được đặt thành macos với một phiên bản Xcode. CircleCI cung cấp các image với Xcode 14, 15 và 16. Sau khi checkout, mã được biên dịch qua xcodebuild và các bài kiểm thử được chạy trên trình mô phỏng. Code signing được cấu hình qua fastlane match hoặc cài đặt chứng chỉ thủ công.

Bộ nhớ đệm và thực thi song song

Bộ nhớ đệm là yếu tố hiệu suất chính trong CircleCI. Cơ chế bộ nhớ đệm lưu các thư mục giữa các lần chạy workflow bằng cách sử dụng một khóa. Đối với Gradle, ~/.gradle được lưu vào bộ nhớ đệm; cho CocoaPods — Pods/; cho npm/SPM — node_modules/.build. Khi tệp khóa thay đổi, bộ nhớ đệm được cập nhật tự động. CircleCI hỗ trợ các chính sách riêng biệt: save_cache có thể được trì hoãn (when: always), trong khi restore_cache là bắt buộc.

Song song hóa kết hợp với resource class cho phép tinh chỉnh hiệu suất build. Resource class xác định CPU và RAM cho một container: small (1 CPU, 2 GB), medium (2 CPU, 4 GB), medium+ (3 CPU, 5 GB) và large (4 CPU, 8 GB). Đối với build iOS với Xcode, nên sử dụng executor macOS với resource class medium hoặc larger — việc biên dịch mã Swift yêu cầu tài nguyên đáng kể.

Song song hóa chia các bài kiểm thử trên nhiều container, giảm thời gian chạy. Ví dụ: parallelism: 4 chạy kiểm thử trong 4 container song song. CircleCI tự động phân phối các tệp kiểm thử giữa các container. Lệnh circleci tests glob thu thập danh sách kiểm thử và circleci tests split phân phối chúng đồng đều.

Ví dụ về bộ nhớ đệm Gradle

- restore_cache:
    keys:
      - v1-gradle-{{ checksum "build.gradle" }}
      - v1-gradle-

- run: ./gradlew assembleDebug

- save_cache:
    key: v1-gradle-{{ checksum "build.gradle" }}
    paths:
      - ~/.gradle/caches
      - ~/.gradle/wrapper

Ví dụ cấu hình .circleci/config.yml

Hãy xem xét cấu hình CircleCI đầy đủ cho một dự án Android với hai job: build và test. Cấu hình bao gồm một Docker executor với Android SDK, bộ nhớ đệm Gradle và thực thi kiểm thử song song. Các artifact được lưu để tải xuống. Workflow build-and-test chạy cả hai job mỗi khi push lên nhánh chính.

version: 2.1

orbs:
  android: circleci/android@2.5.0

jobs:
  build:
    executor: android/default
    steps:
      - checkout
      - android/restore-gradle-cache
      - run: ./gradlew assembleRelease
      - android/save-gradle-cache
      - store_artifacts:
          path: app/build/outputs/apk/release
      - store_test_results:
          path: app/build/reports/tests

  test:
    executor: android/default
    parallelism: 4
    steps:
      - checkout
      - android/restore-gradle-cache
      - run:
          command: |
            cd app
            ./gradlew test

workflows:
  version: 2
  build-and-test:
    jobs:
      - build
      - test

Orbs: giải pháp CI/CD có sẵn

Khi lựa chọn giữa CircleCI và các giải pháp thay thế — nếu nhóm của bạn sử dụng GitHub, GitHub Actions có thể là lựa chọn đơn giản hơn. CircleCI phù hợp hơn cho các nhóm cần thực thi kiểm thử song song linh hoạt, cấu hình môi trường executor tùy chỉnh và thống kê build chi tiết. CircleCI Insights cung cấp bảng điều khiển với các chỉ số hiệu suất pipeline: thời gian build trung bình, xu hướng và điểm nghẽn. Insights giúp xác định các job chạy lâu và tối ưu hóa chúng. CircleCI API cho phép quản lý pipeline theo chương trình, kích hoạt build và lấy các chỉ số.

Để quản lý secrets an toàn, CircleCI hỗ trợ Contexts — các tập hợp biến môi trường được đặt tên ở cấp tổ chức. Contexts được bảo vệ bằng quyền truy cập dựa trên vai trò: chỉ các nhóm cụ thể mới có thể sử dụng một ngữ cảnh nhất định. Ví dụ, ngữ cảnh production-deploy chứa khóa App Store Connect và chỉ dành cho các nhà phát triển chính. Kết hợp với approval gates, điều này tạo thành một hệ thống bảo mật CI/CD toàn diện.

CircleCI Orb Registry chứa hàng trăm gói có sẵn cho các tác vụ CI/CD khác nhau. Đối với phát triển di động, các orbs chính bao gồm: circleci/android, circleci/ios, circleci/flutter, laurencerussell/firebase-app-distribution. Mỗi orb được quản lý phiên bản và có tài liệu. Orbs có thể công khai (có sẵn cho tất cả mọi người) hoặc riêng tư (chỉ cho tổ chức của bạn).

Sử dụng orbs giảm cấu hình từ 5–10 lần. Ví dụ, orb circleci/android cung cấp executor android/default với SDK được cài đặt sẵn và các lệnh restore-gradle-cache, save-gradle-cache. Orb circleci/ios bao gồm một executor với Xcode và các lệnh cho code signing qua fastlane. Orbs có thể dễ dàng kết hợp: thêm orb android để build và orb slack để nhận thông báo.

CircleCI cũng cung cấp hỗ trợ báo cáo kiểm thử tích hợp. Store_test_results tự động phân tích và trực quan hóa kết quả kiểm thử từ JUnit, XCTest và các định dạng khác. Đối với các dự án di động, điều này có nghĩa là xem tập trung các kiểm thử thất bại, xu hướng thời gian chạy và lịch sử ổn định build, giúp đơn giản hóa việc duy trì chất lượng mã.

Ví dụ với iOS Orb

orbs:
  ios: circleci/ios@2.0.0

jobs:
  build-and-test:
    executor: ios/default
    steps:
      - checkout
      - ios/install-dependencies
      - ios/build-and-test

Xuất bản orb tùy chỉnh có sẵn qua CircleCI CLI. Các lệnh circleci orb create và circleci orb publish tải orb lên registry. Điều này hữu ích để tiêu chuẩn hóa CI/CD trong tổ chức — tạo một lần, sử dụng trong tất cả các dự án.