provider-test-patterns

Tổng quan về skill provider-test-patterns

provider-test-patterns là một skill kiểm thử chấp nhận cho Terraform provider dành cho các nhóm đang dùng terraform-plugin-testing với Plugin Framework. Skill này giúp bạn viết, review và debug test provider với ít mò mẫm hơn so với prompt chung chung, đặc biệt khi bạn cần đúng TestCase, TestStep, kiểm tra state, kiểm tra plan, xác minh import, hoặc thiết lập sweeper.

Phù hợp nhất và công việc cần làm

Hãy dùng skill provider-test-patterns khi nhiệm vụ thực sự của bạn là: “Tôi cần một pattern kiểm thử chấp nhận đáng tin cậy cho một resource của provider, và tôi muốn biết kiểu test nào phù hợp với kịch bản này.” Skill này hữu ích nhất cho công việc backend phát triển provider, nơi cái khó không chỉ là cú pháp mà là chọn đúng chiến lược assertion và mức độ bao phủ vòng đời.

Skill này làm tốt điều gì

Skill provider-test-patterns mạnh nhất khi bạn cần hướng dẫn về:

• luồng vòng đời test qua plan, apply, refresh và destroy
• cấu trúc TestCase và TestStep
• ConfigStateChecks, plancheck, và CompareValue
• kiểm thử import với ImportStateKind
• sweeper và đảm bảo an toàn khi cleanup
• các pattern theo kịch bản như basic, update, disappears, validation, và regression
• kiểm thử resource tạm thời với pattern echoprovider

Khi nào đây là một lựa chọn cài đặt rất phù hợp

Nên cài provider-test-patterns nếu bạn muốn các pattern có quan điểm rõ ràng, ánh xạ trực tiếp sang acceptance tests cho Terraform provider, nhất là khi nhóm của bạn đang làm backend development trong Plugin Framework. Đây là lựa chọn tốt hơn một prompt chung khi rủi ro chính là bỏ sót một kiểm tra bắt buộc, dùng sai kiểu assertion, hoặc tổ chức test theo cách khó bảo trì.

Cách dùng skill provider-test-patterns

Cài và nạp skill vào ngữ cảnh

Dùng luồng cài đặt của repository cho skill manager của bạn, rồi mở SKILL.md trước tiên. Upstream skill không tự định nghĩa lệnh cài đặt riêng, nên bước thực tế kiểu provider-test-patterns install là thêm skill qua quy trình skills của agent rồi đọc skill cùng các tài liệu tham chiếu đi kèm.

Bắt đầu từ hình dạng của test, không phải từ code

Workflow dùng provider-test-patterns hiệu quả nhất là mô tả kịch bản trước khi yêu cầu code. Hãy nêu:

• loại resource và giai đoạn vòng đời
• đây là coverage basic, update, import, disappears, validation hay regression
• cần assert điều gì trong state hoặc plan
• có cần cleanup bằng sweeper hay không
• case này có dùng resource tạm thời hay không

Cách này giúp skill đủ ngữ cảnh để chọn giữa config check thông thường, statecheck, plancheck, hoặc so sánh chéo giữa các step.

Đọc các file này trước

Để vào việc nhanh, hãy đọc theo thứ tự:

1. SKILL.md cho bộ pattern chính và hướng dẫn vòng đời
2. references/checks.md cho statecheck, plancheck, known values, và comparers
3. references/ephemeral.md nếu resource là ephemeral hoặc dùng echoprovider
4. references/sweepers.md nếu bạn lo resource bị leak

Mẫu prompt mạnh

Một prompt tốt cho provider-test-patterns nên có resource, failure mode, và kiểu assertion mong muốn. Ví dụ:

Write an acceptance test for example_widget update behavior. I need a TestStep sequence that verifies the name changes, the old value is preserved until refresh, and the final state matches the new config. Use CompareValue if that is the right fit.

Cách này mạnh hơn “write a test” vì nó cho skill một đích quyết định rõ ràng, thay vì chỉ một chủ đề chung chung.

Câu hỏi thường gặp về skill provider-test-patterns

provider-test-patterns có chỉ dành cho Terraform provider engineer không?

Phần lớn là có. Skill này được thiết kế cho acceptance tests của Terraform provider và hữu ích nhất cho provider-test-patterns for Backend Development, nơi bạn cần coverage đáng tin cậy cho state, plan, và hành vi cleanup.

Tôi có cần biết terraform-plugin-testing trước không?

Không cần, nhưng skill giả định bạn đang làm trong hệ sinh thái đó. Nếu bạn là người mới, skill này vẫn hữu ích vì nó giảm phần đoán mò về cấu trúc test, nhưng bạn vẫn nên đối chiếu chi tiết với tài liệu được tham chiếu và conventions test sẵn có của provider.

Khác gì so với một prompt bình thường?

Một prompt bình thường có thể tạo ra một file test nghe có vẻ hợp lý, nhưng provider-test-patterns hữu ích hơn khi lựa chọn assertion là điều quan trọng. Nó giúp bạn quyết định nên dùng ConfigStateChecks, plan check, destroy check, xác minh import state, hay pattern sweeper dựa trên mục đích thật của test.

Khi nào không nên dùng?

Không nên dùng cho unit test chung chung, kiểm thử Go không liên quan, hoặc câu hỏi chỉ cần cú pháp nhanh. Nó cũng không phù hợp nếu bạn không làm Terraform provider acceptance tests, vì các pattern và ràng buộc đều rất đặc thù cho workflow này.

Cách cải thiện skill provider-test-patterns

Nêu sẵn những thông tin test còn thiếu

Cách tốt nhất để cải thiện kết quả từ provider-test-patterns là cung cấp đúng phần thông tin tối thiểu làm thay đổi thiết kế test:

• tên resource và package provider
• resource được tạo, cập nhật, import hay destroy
• các thuộc tính chính xác cần được kiểm tra
• giá trị là static, computed, sensitive hay cross-step
• test có phải bao phủ cleanup hoặc khôi phục leak hay không

Nêu rõ lỗi bạn đang cố ngăn chặn

Nếu bạn nói trước điều gì có thể hỏng, skill sẽ chọn assertion tốt hơn. Ví dụ, hãy nói rõ bạn đang phòng:

• drift sau refresh
• import state sai
• giá trị thay đổi giữa các step
• thiếu cleanup khi destroy
• dữ liệu ephemeral không thể assert trực tiếp

Cách này hữu ích hơn việc chỉ xin một “ví dụ hoàn chỉnh”, vì pattern của test phụ thuộc vào failure mode.

Lặp lại bằng cách siết chặt assertion

Sau lần xuất ra đầu tiên, hãy tinh chỉnh yêu cầu bằng chính khoảng trống bạn vẫn thấy. Những follow-up tốt gồm:

• “Make the ConfigStateChecks assert the computed ID format.”
• “Rewrite this as an import test with ImportStateKind.”
• “Add a sweeper and show the required TestMain setup.”
• “Convert this to an ephemeral-resource pattern using the echoprovider approach.”

Kiểu lặp này cải thiện đầu ra của provider-test-patterns guide hiệu quả hơn nhiều so với việc chỉ xin một bản dài hơn.