Lợi ích của việc sử dụng cấu hình kết nối cơ sở dữ liệu đám mây
Trước khi chức năng cấu hình kết nối cơ sở dữ liệu đám mây được giới thiệu, việc chạy một kịch bản kiểm thử với các thao tác cơ sở dữ liệu qua CLI yêu cầu hoàn thành một số bước rườm rà:
- Quy trình xuất thủ công: Định vị mục xuất cấu hình kết nối cơ sở dữ liệu trong giao diện sản phẩm và xuất nó dưới dạng tệp
- Quản lý tệp: Chuyển tệp cấu hình kết nối cơ sở dữ liệu đã xuất sang máy thực thi CLI
- Cấu hình đường dẫn: Sao chép đường dẫn tệp trên máy
- Sửa đổi lệnh: Cập nhật các tùy chọn dòng lệnh với các giá trị đường dẫn thực tế, ví dụ:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --database-connection /Users/xxx/yyy/database-connections.json
Quá trình này bao gồm nhiều tác vụ chuẩn bị, và bất kỳ thay đổi nào đối với cấu hình kết nối cơ sở dữ liệu đều yêu cầu lặp lại tất cả các bước này. Trải nghiệm người dùng tổng thể không hiệu quả và tẻ nhạt.
Với cấu hình kết nối cơ sở dữ liệu đám mây, bạn có thể loại bỏ hoàn toàn nhu cầu xuất tệp cấu hình, chuyển chúng sang máy thực thi CLI và chỉ định thủ công các giá trị tùy chọn trong dòng lệnh. Chỉ cần đặt các giá trị thực tế cho các biến trong cấu hình kết nối cơ sở dữ liệu đám mây để chạy thành công, cải thiện đáng kể trải nghiệm người dùng.
Phương pháp 1: Sử dụng giá trị cục bộ + Cấu hình kết nối cơ sở dữ liệu đám mây
Khi tất cả các kết nối cơ sở dữ liệu trong kịch bản kiểm thử của bạn sử dụng cấu hình được lưu trên đám mây, tùy chọn xuất cấu hình kết nối cơ sở dữ liệu sẽ không xuất hiện (vì nó không còn cần thiết). Trong quá trình thực thi CLI, hệ thống có thể trực tiếp truy xuất các biến cần thiết từ cấu hình kết nối cơ sở dữ liệu đám mây và tìm các giá trị biến thực tế theo quy tắc thay thế biến để thiết lập kết nối.
Triển khai từng bước:
Cấu hình biến môi trường: Trong quản lý môi trường, đặt các giá trị kết nối cơ sở dữ liệu thực tế vào các giá trị cục bộ của các biến tương ứng cho mỗi môi trường bạn cần sử dụng.
Đảm bảo cấu hình dựa trên biến: Đảm bảo cấu hình kết nối cơ sở dữ liệu của bạn sử dụng hoàn toàn các biến (ngoại trừ cổng), đảm bảo nó được lưu dưới dạng kết nối cơ sở dữ liệu đám mây.
Xác minh cấu hình kịch bản kiểm thử: Xác nhận rằng tất cả các kịch bản kiểm thử bạn muốn chạy qua CLI đều sử dụng "cấu hình kết nối cơ sở dữ liệu đám mây" (tức là các cấu hình được lưu bằng biến).
Xuất giá trị cục bộ: Điều hướng đến trang CI/CD, chọn "Xuất giá trị cục bộ để sử dụng" dưới mục Biến môi trường/Toàn cục, sau đó nhấp vào nút xuất.
Xem xét và sửa đổi tệp xuất: Trong tệp đã xuất, bạn sẽ thấy các giá trị biến môi trường được sử dụng bởi cấu hình kết nối cơ sở dữ liệu. Bạn có thể sửa đổi thủ công các giá trị này trong tệp nếu cần. Đặt tệp trên máy CLI và sao chép đường dẫn tệp.
Cấu hình lệnh CI/CD: Trong trang CI/CD, chèn Mã truy cập của bạn, sao chép lệnh và dán đường dẫn thực tế của tệp biến vào giá trị tùy chọn:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --variables /Users/xxx/yyy/pptest_variables.json
Thực thi và xác minh: Chạy lệnh CLI trên. Kết nối cơ sở dữ liệu sẽ hoạt động chính xác và thực thi thành công.
Xem lại kết quả: Nếu cấu hình in kết quả, bạn có thể xem chi tiết thực thi kết nối cơ sở dữ liệu trong chi tiết báo cáo đã tải lên.
Những lưu ý quan trọng:
⚠️ Lưu ý bảo mật: Các giá trị cục bộ vẫn sử dụng bộ nhớ tệp cục bộ cho các cấu hình kết nối cơ sở dữ liệu thực tế để đảm bảo an toàn dữ liệu. Nếu bạn cần thay đổi cấu hình kết nối, hãy sửa đổi thủ công các giá trị biến tương ứng trong tệp này.
⚠️ Cảnh báo giá trị từ xa: Mặc dù việc sử dụng các giá trị từ xa cho các biến cấu hình kết nối cơ sở dữ liệu có thể tránh các thao tác bổ sung như xuất tệp giá trị cục bộ và thêm các tùy chọn dòng lệnh bổ sung (và cho phép sửa đổi trực tiếp các giá trị từ xa trong ứng dụng Apidog), phương pháp này tiềm ẩn rủi ro bảo mật dữ liệu và ❌ không được khuyến nghị.
⚠️ Sử dụng văn bản thuần túy: Nếu bạn sử dụng văn bản thuần túy hoàn toàn hoặc một phần (trừ các trường cổng) trong cấu hình kết nối của mình, bạn vẫn sẽ cần xuất tệp cấu hình và sử dụng chúng qua --database-connection trong các lệnh. Kiểu sử dụng này ❌ không được khuyến nghị.
Phương pháp 2: Sử dụng biến Vault + Cấu hình kết nối cơ sở dữ liệu đám mây
Nếu bạn đang sử dụng các giá trị từ xa của biến môi trường + biến Vault để duy trì kết nối cơ sở dữ liệu đám mây và muốn sử dụng các kết nối đã lưu trên đám mây này trong CLI, hãy làm theo các bước sau:
Triển khai từng bước:
Cấu hình biến Vault: Trong quản lý môi trường, đặt các biến Vault kết nối cơ sở dữ liệu vào các giá trị từ xa của các biến tương ứng, giữ các giá trị cục bộ theo sau các giá trị từ xa. Cấu hình điều này cho mỗi môi trường bạn cần sử dụng.
Đảm bảo cấu hình dựa trên biến: Đảm bảo cấu hình kết nối cơ sở dữ liệu của bạn sử dụng hoàn toàn các biến (ngoại trừ cổng), đảm bảo nó được lưu dưới dạng kết nối cơ sở dữ liệu đám mây.
Xác minh cấu hình kịch bản kiểm thử: Xác nhận rằng tất cả các kịch bản kiểm thử bạn muốn chạy qua CLI đều sử dụng "cấu hình kết nối cơ sở dữ liệu đám mây" (tức là các cấu hình được lưu bằng biến).
Cấu hình cài đặt CI/CD: Điều hướng đến trang CI/CD, chọn "Sử dụng giá trị từ xa" dưới mục Biến môi trường/Toàn cục, cấu hình theo tình huống thực tế của bạn, sau đó sao chép lệnh CLI.
Đặt biến Vault: Trên máy nơi bạn cần chạy CLI, trong pipeline hoặc terminal của bạn, trước tiên hãy nhập export APIDOG_VAULT_KEY=VALUE để thực sự sử dụng các biến Vault. Phân tách nhiều biến Vault bằng dấu cách.
Cú pháp dành riêng cho hệ điều hành:
| Linux & MacOS | Windows |
|---|---|
Đặt biến: Sử dụng export, phân tách các biến bằng dấu cáchexport APIDOG_VAULT_KEY1=VALUE1 APIDOG_VAULT_KEY2=VALUE2 APIDOG_VAULT_KEY3=VALUE3 |
Đặt biến: Sử dụng set, phân tách các biến bằng &set APIDOG_VAULT_KEY1=VALUE1&APIDOG_VAULT_KEY2=VALUE2&APIDOG_VAULT_KEY3=VALUE3 |
Truy vấn biến: Sử dụng echo $VARIABLE_NAMEecho $APIDOG_VAULT_KEY1 |
Truy vấn biến: Sử dụng echo %VARIABLE_NAME%echo %APIDOG_VAULT_KEY1% |
Thực thi lệnh CLI: Chạy lệnh CLI của bạn để bắt đầu thực thi.
Xác minh kết quả: Sau khi hoàn thành, bạn có thể xem kết quả kết nối cơ sở dữ liệu trong báo cáo, xác nhận kết nối cơ sở dữ liệu và thực thi thao tác thành công.
Xem lại chi tiết thực thi: Nếu cấu hình in kết quả, bạn có thể xem chi tiết thực thi kết nối cơ sở dữ liệu trong chi tiết báo cáo đã tải lên.
Nhắc nhở quan trọng:
⚠️ Yêu cầu trước khi thực thi: Trước khi thực thi các lệnh CLI chứa biến Vault cho kết nối cơ sở dữ liệu, luôn sử dụng export/set để nhập các giá trị biến Vault thực tế. Nếu không, kết nối cơ sở dữ liệu sẽ thất bại do không thể truy xuất cấu hình thực tế.
⚠️ Phạm vi biến tạm thời: Các giá trị thực tế của biến Vault được nhập qua export/set chỉ có hiệu lực cho lần thực thi hiện tại, hoạt động như các biến tạm thời. Bạn sẽ cần nhập lại chúng bằng phương pháp này cho các lần chạy tiếp theo.
Kết luận
Cấu hình kết nối cơ sở dữ liệu đám mây giúp tối ưu hóa đáng kể quy trình kiểm thử CLI bằng cách loại bỏ quản lý tệp thủ công và giảm độ phức tạp cấu hình. Dù sử dụng giá trị cục bộ hay biến Vault, phương pháp này cung cấp một giải pháp an toàn, hiệu quả và dễ bảo trì hơn để chạy các kịch bản kiểm thử kết nối cơ sở dữ liệu trong môi trường CI/CD.
Chọn phương pháp phù hợp nhất với yêu cầu bảo mật và ưu tiên vận hành của bạn:
- Giá trị cục bộ: Tốt hơn cho các kịch bản yêu cầu bảo mật dữ liệu tối đa với kiểm soát tệp cục bộ
- Biến Vault: Lý tưởng cho các pipeline CI/CD tự động với quản lý bí mật tập trung
Cả hai phương pháp đều đảm bảo kết nối cơ sở dữ liệu của bạn an toàn đồng thời cung cấp sự linh hoạt và hiệu quả cần thiết cho các quy trình kiểm thử hiện đại.