วิธีทำ API Mocking และทดสอบบน VPS ด้วยตัวเอง
เรียนรู้วิธีติดตั้ง WireMock และ Hurl บน VPS เพื่อจัดการ API mocking และการทดสอบอย่างเป็นระบบ ช่วยให้คุณควบคุมข้อมูลจำลองและผลลัพธ์การทดสอบได้แม่นยำโดยไม่ต้องพึ่งพาบริการภายนอก
สองงานที่ใช้ repository เดียวกัน
การทำ API mocking และการทดสอบ (testing) แบบ self-hosted เป็นงานสองประเภทที่แตกต่างกัน การพยายามรวมให้เป็นงานเดียวจะทำให้เสียเวลาไปเปล่าๆ หนึ่งสัปดาห์ Mock server ทำหน้าที่แทน dependency ที่คุณไม่สามารถเรียกใช้งานได้จาก CI เช่น ผู้ให้บริการชำระเงิน, API ของพาร์ทเนอร์, upstream ที่มีการจำกัดอัตราการเรียกใช้งาน (rate limit) หรือบริการที่ทีมอื่นยังไม่ได้ปล่อย (ship) ออกมา ส่วน API test runner จะเรียกใช้งาน endpoint ของคุณเองตามลำดับที่กำหนดและตรวจสอบผลลัพธ์ (assert) โดยนำค่าจาก response หนึ่งไปใช้ใน request ถัดไป
เครื่องมือบางอย่างสามารถทำงานได้ทั้งสองอย่าง งานหลักของ mock server คือการตอบสนองต่อ request ส่วน test runner ไม่ได้มีส่วนเกี่ยวข้องกับสิ่งที่ผู้ให้บริการชำระเงินจะตอบกลับมาเมื่อบัตรถูกปฏิเสธ ทีมส่วนใหญ่ที่เช่าเซิร์ฟเวอร์อยู่แล้วมักจะรันเครื่องมือทั้งสองประเภทนี้ควบคู่กัน โดยเริ่มการทำงานผ่าน Docker Compose file เดียวกันและตรวจสอบการเปลี่ยนแปลงผ่าน pull request เดียวกัน
เหตุใดจึงควร self-host ระบบจำลอง API และการทดสอบ?
ข้อมูลจำลอง (fixtures) ของคุณมีรูปแบบเหมือนข้อมูลที่ใช้งานจริง เนื้อหาของ request body ในการทดสอบ API คือบันทึกข้อมูลลูกค้าจริงที่ถูกเปลี่ยนชื่อ หรืออาจไม่ได้เปลี่ยนชื่อเพราะไม่มีใครตรวจสอบ ส่วนการบันทึก stub นั้นแย่กว่า เพราะการบันทึกผ่าน proxy จะเก็บทุกสิ่งที่ upstream ส่งกลับมา ดังนั้นไดเรกทอรี stub ที่สร้างจากการบันทึกจึงมีทั้ง token จริงและที่อยู่อีเมลของลูกค้าปะปนอยู่จนกว่าจะมีคนเข้าไปตรวจสอบไฟล์ทั้งหมด หากใช้บริการโฮสต์ภายนอก ข้อมูลเหล่านี้อาจกลายเป็นเหตุการณ์ละเมิดความปลอดภัยของผู้อื่นและกลายเป็นการเปิดเผยข้อมูลของคุณเอง
เหตุผลประการที่สองคือความสามารถในการเข้าถึง บริการที่ผูกอยู่กับ private address จำเป็นต้องมีการเชื่อมต่อเครือข่ายส่วนตัวก่อนที่ hosted runner จะเข้าถึงได้ ซึ่งทุกวิธีแก้ปัญหาชั่วคราวล้วนมีต้นทุน การเปิดเผย API สู่สาธารณะเพื่อทำการทดสอบเป็นการทำลายเหตุผลที่บริการนั้นควรเป็นส่วนตัวแต่แรก การใช้ tunnel หรือสำเนา staging แบบสาธารณะถือเป็นอีกระบบที่ต้องดูแลรักษา และสำเนา staging มักจะมีความแตกต่างจาก production เมื่อมีการปล่อย release ใหม่ๆ แม้ว่า GitHub-hosted runners จะรองรับการเข้าถึงแบบส่วนตัวผ่าน WireGuard overlay หรือ Azure Virtual Network แต่การใช้ runner บนเครือข่ายส่วนตัวเดียวกันเพื่อเรียกใช้บริการโดยตรงนั้นไม่จำเป็นต้องพึ่งพาวิธีการดังกล่าว ซึ่งเป็นเหตุผลเชิงปฏิบัติที่สนับสนุนการใช้ a self-hosted GitHub Actions runner
คุณควรเลือกใช้ self-hosted mock server ตัวใด?
แต่ละตัวทำงานเป็น container บนเซิร์ฟเวอร์ที่คุณดูแลเอง คำถามสำคัญคือแต่ละตัวใช้สิ่งใดเป็นแหล่งข้อมูลหลัก (source of truth) เพราะนั่นเป็นตัวตัดสินว่าการสร้าง container ใหม่จะใช้เวลาเพียงครู่เดียวหรือต้องเสียเวลาทั้งบ่าย
- WireMock เก็บ stub ทุกตัวไว้เป็นไฟล์ JSON ในไดเรกทอรี
mappings/โดยเก็บเนื้อหา response ขนาดใหญ่ไว้ใน__files/อิมเมจคือwiremock/wiremockและมี root directory ภายใน container คือ/home/wiremockนอกจากนี้ยังทำงานเป็น recording proxy ได้ การเก็บข้อมูลเป็นไฟล์บนดิสก์ทำให้ mock เหล่านี้สามารถจัดการผ่าน git ได้เหมือนซอร์สโค้ดทั่วไป - Mockoon CLI เก็บ API mock ทั้งชุดไว้ในไฟล์ข้อมูล JSON เพียงไฟล์เดียว ติดตั้งด้วย
npm install -g @mockoon/cliและเริ่มทำงานด้วยmockoon-cli start --data ./data-file.jsonหรือรันอิมเมจmockoon/cliโดยทำ bind mount ไฟล์ดังกล่าวเข้าไป ตัวแอปบนเดสก์ท็อปจะแก้ไขไฟล์เดียวกันนี้ ทำให้การออกแบบผ่าน UI และการ commit ผลลัพธ์สามารถทำงานร่วมกันได้ - MockServer ทำงานจากอิมเมจ
mockserver/mockserverและฟังพอร์ต 1080 การตั้งค่า expectation จะทำผ่าน REST API ของตัวมันเอง ซึ่งสะดวกต่อการใช้งานจากโค้ดทดสอบ แต่มีความเสี่ยงหากใช้ในสภาพแวดล้อม deployment เพราะโดยค่าเริ่มต้น expectation ที่สร้างผ่าน HTTP call จะหายไปเมื่อ container รีสตาร์ท ให้ใช้ไฟล์ initialization แบบ JSON สำหรับ stub ที่ต้องการให้คงอยู่ถาวร หากต้องการเก็บการเปลี่ยนแปลงที่เกิดขึ้นระหว่างรันไทม์ ให้เปิดใช้งานpersistExpectations, บันทึกไฟล์ผลลัพธ์ไว้นอก container และโหลดผ่านinitializationJsonPathในขั้นตอนเริ่มต้น - Prism สร้าง mock จากเอกสาร OpenAPI ของคุณโดยตรงแทนการใช้ไฟล์ stub แยกต่างหาก ติดตั้งด้วย
npm install -g @stoplight/prism-cliจากนั้นรันprism mock openapi.yamlภายใน container ให้เพิ่ม-h 0.0.0.0เนื่องจากโดยค่าเริ่มต้น Prism จะผูกกับ localhost ทำให้ไม่สามารถเข้าถึงจากภายนอก container ได้ - Microcks เป็นตัวเลือกขนาดใหญ่: มีเว็บ UI สำหรับนำเข้าเอกสาร OpenAPI และ Postman collections จากนั้นจะทำหน้าที่เป็น mock และรัน contract test การติดตั้งแบบเต็มรูปแบบต้องใช้ MongoDB และ Keycloak รวมถึง Kafka สำหรับฟีเจอร์แบบ async อิมเมจแบบ all-in-one
microcks-uberจะรวม MongoDB แบบ in-memory มาให้ด้วย ซึ่งเอกสารของโครงการระบุว่าเหมาะสำหรับการใช้งานชั่วคราว ดังนั้นให้ถือว่าข้อมูลใดๆ ที่สร้างใน UI นั้นเป็นข้อมูลที่ลบทิ้งได้ และควรเก็บ source artifact ไว้ใน git แทน
คุณควรใช้เครื่องมือทดสอบ API แบบ self-hosted ตัวใด
งานในส่วนนี้คือลำดับขั้นตอน: การยืนยันตัวตน, การสร้างคำสั่งซื้อ, การอ่านข้อมูลกลับมา และการตรวจสอบว่าสถานะมีการเปลี่ยนแปลงจริง ซึ่งจำเป็นต้องมีการดึงค่าจาก response หนึ่งเพื่อนำไปใช้ใน request ถัดไป เครื่องมือที่ไม่สามารถส่งผ่านสถานะระหว่างการเรียกใช้งานได้ถือเป็นเพียงเครื่องมือตรวจสอบสถานะ (health check) ไม่ใช่เครื่องมือทดสอบ API
- Hurl รันไฟล์ข้อความธรรมดาที่บรรจุ HTTP requests จาก binary ไฟล์เดียว ส่วน
[Captures]ใช้สำหรับดึงค่าจาก response, ส่วน[Asserts]ใช้สำหรับตรวจสอบค่าเหล่านั้น และ--testจะเปลี่ยนให้มันกลายเป็นเครื่องมือรันการทดสอบพร้อมสรุปผลและส่งค่า exit code ออกมา เวอร์ชัน 8.0.1 เป็นเวอร์ชันปัจจุบัน ณ เดือนสิงหาคม 2026 - Bruno CLI รันไฟล์ในโฟลเดอร์ที่เป็นรูปแบบ
.bruติดตั้งด้วยnpm install -g @usebruno/cliจากนั้นรันด้วยbru run folder --env Local --reporter-junit results.xmlรูปแบบของ collection ถูกออกแบบมาให้เป็นไฟล์ข้อความในไดเรกทอรี ทำให้สามารถอ่านค่า diff เพื่อตรวจสอบความเปลี่ยนแปลงได้ง่าย - Newman รัน Postman collections นอกโปรแกรม Postman: ใช้
npm install -g newmanจากนั้นรันnewman run collection.json -r cli,junit --reporter-junit-export results.xmlข้อควรระวังคือเรื่องรูปแบบไฟล์ Newman รัน collection ที่ส่งออกมาในรูปแบบ JSON v2.1 เท่านั้น ปัจจุบัน Postman รองรับรูปแบบ collection v3 และ Native Git workflows ผ่านทาง Postman CLI แล้ว เอกสารของ Postman ระบุว่า Newman จะไม่ได้รับการอัปเดตหรือแก้ไขเพิ่มเติมอีกต่อไป และแนะนำให้ย้ายสคริปต์และ CI pipelines ไปใช้ Postman CLI แทน - Schemathesis เป็นการตรวจสอบอีกรูปแบบหนึ่ง โดยจะอ่าน OpenAPI schema และสร้างกรณีทดสอบเพื่อพยายามทำให้เกิด response ที่ schema ของคุณระบุว่าเป็นไปไม่ได้:
uvx schemathesis run https://your.api/openapi.jsonมันสามารถตรวจพบการทำงานที่ผิดพลาด (crash) และการละเมิดสัญญา (contract violation) ได้ แต่เนื่องจากมันไม่ทราบกฎทางธุรกิจของคุณ จึงควรใช้ควบคู่ไปกับชุดทดสอบที่เขียนขึ้นเอง แทนที่จะใช้แทนที่กัน - Hoppscotch แบบ self-hosted เป็นตัวเลือกสำหรับเว็บ UI ซึ่งจำเป็นต้องใช้ Postgres instance โปรดทำความเข้าใจข้อแลกเปลี่ยนนี้ก่อนติดตั้ง: ข้อมูล collection จะถูกเก็บไว้ในฐานข้อมูล ไม่ใช่ใน repository ของคุณ
สิ่งที่ควรหลีกเลี่ยง: Step CI ยังคงปรากฏอยู่ในบทความรวบรวมเครื่องมือและรูปแบบ YAML workflow ของมันก็อ่านง่าย แต่ repository ดังกล่าวมีการ commit ครั้งล่าสุดในเดือนสิงหาคม 2024 โปรแกรมที่ทำหน้าที่เป็นตัวกลางระหว่าง CI และ API ของคุณไม่ใช่จุดที่เหมาะสมในการใช้ซอฟต์แวร์ที่ไม่มีการดูแลรักษา
การวาง mock server ไว้หลังไฟร์วอลล์
การตั้งค่าด้านล่างนี้เป็นการรัน WireMock เพื่อทำหน้าที่แทนผู้ให้บริการชำระเงิน หากคุณยังไม่คุ้นเคยกับรูปแบบไฟล์ compose บทความ Docker Compose บน VPS ได้อธิบายคำสั่งจัดการวงจรชีวิตที่ส่วนนี้อ้างถึงไว้แล้ว
services:
mock-payments:
image: wiremock/wiremock:3.13.2
command: ["--verbose"]
volumes:
- ./mocks/payments:/home/wiremock
ports:
- "127.0.0.1:8080:8080"
restart: unless-stoppedคำนำหน้า 127.0.0.1: ที่พอร์ตเป็นส่วนสำคัญ การใช้เพียง 8080:8080 จะเป็นการเผยแพร่ mock ออกไปทุกอินเทอร์เฟซรวมถึง IP สาธารณะของคุณ ซึ่งจะยังคงเข้าถึงได้แม้ว่า ufw จะปฏิเสธพอร์ตนั้นอยู่ก็ตาม เนื่องจาก Docker จะกำหนดเส้นทางทราฟฟิกที่เผยแพร่ผ่านตาราง nat ก่อนที่จะไปถึงกฎ INPUT ของ ufw ให้ทำการ bind เข้ากับ loopback address เพื่อให้พอร์ตที่เผยแพร่นั้นเข้าถึงได้เฉพาะจากโฮสต์เท่านั้น โดยใช้ bridge networking เริ่มต้นของ Docker บน Engine 28.0.0 หรือใหม่กว่า สำหรับเวอร์ชันที่เก่ากว่า โฮสต์ที่อยู่ในเครือข่าย layer 2 เดียวกันจะสามารถเข้าถึงพอร์ตที่ bind ไว้กับ localhost ได้ การ bind เข้ากับที่อยู่อินเทอร์เฟซส่วนตัวยังคงอนุญาตให้เข้าถึงได้จากเครือข่ายที่สามารถกำหนดเส้นทางไปยังที่อยู่นั้นได้
บริการภายใต้การทดสอบของคุณจะชี้ไปยัง mock เมื่อบริการรันอยู่ในโปรเจกต์ compose เดียวกัน URL พื้นฐานของ mock คือ http://mock-payments:8080 เนื่องจาก compose จะแก้ไขชื่อบริการบนเครือข่ายของตนเอง เมื่อบริการรันบนโฮสต์ URL จะเป็น http://127.0.0.1:8080 ให้ตั้งค่าผ่าน environment variable เท่านั้น ห้ามตั้งค่าในโค้ด มิฉะนั้น URL สำหรับทดสอบจะติดไปกับซอฟต์แวร์ที่นำไปใช้งานจริง (production)
ไฟล์ stub จะถูกเก็บไว้ใน ./mocks/payments/mappings/ โดยใช้ไฟล์ JSON หนึ่งไฟล์ต่อหนึ่ง stub
{
"request": {
"method": "POST",
"urlPath": "/v1/charges",
"bodyPatterns": [{ "matchesJsonPath": "$.amount" }]
},
"response": {
"status": 201,
"headers": { "Content-Type": "application/json" },
"jsonBody": { "id": "ch_test_001", "status": "succeeded", "amount": 4200 }
}
}เริ่มการทำงาน จากนั้นตรวจสอบสิ่งที่โหลดเข้ามาจริง
docker compose up -d --wait mock-payments
curl -fsS http://127.0.0.1:8080/__admin/mappings--wait จะรอจนกว่าคอนเทนเนอร์จะรายงานสถานะว่าพร้อมใช้งาน (healthy) ซึ่งทำงานได้เพราะอิมเมจ WireMock มี HEALTHCHECK ที่ตรวจสอบกับ endpoint /__admin/health ของมัน การเรียก mappings จะแสดงรายการ stub ทั้งหมดที่เซิร์ฟเวอร์อ่านได้ หาก stub ที่คุณเขียนไม่อยู่ในรายการนั้น แสดงว่ามันไม่ได้ถูกโหลด ให้ตรวจสอบว่าไฟล์วางอยู่ใน mappings/ ไม่ใช่ที่ root ของการ mount และตรวจสอบว่า JSON นั้นถูกต้อง
เมื่อมีคำขอเข้ามาและไม่มี stub ใดตรงกัน WireMock จะตอบกลับด้วย 404 หากพบสิ่งที่ใกล้เคียง เนื้อหาจะขึ้นต้นด้วย Request was not matched ตามด้วยส่วนต่าง (diff) เทียบกับ stub ที่ใกล้เคียงที่สุด หากไม่มีการแมป stub เลย เนื้อหาจะเป็น No response could be served as there are no stub mappings in this WireMock instance. ให้อ่านส่วนต่างเมื่อปรากฏขึ้นก่อนที่จะแก้ไขสิ่งใด เพราะมันจะระบุฟิลด์ที่แตกต่างกันอย่างชัดเจน โดยปกติจะเป็น path ที่มี /v1/charge ในขณะที่ stub ระบุเป็น /v1/charges
เขียนการทดสอบเป็นลำดับขั้นตอนโดยส่งผ่านสถานะระหว่างการเรียกใช้งาน
ไฟล์ Hurl เป็นข้อความธรรมดา ให้ติดตั้งไฟล์ deb จากหน้า releases ของโปรเจกต์
VERSION=8.0.1
curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl_${VERSION}_amd64.deb
sudo apt update && sudo apt install ./hurl_${VERSION}_amd64.debชุดทดสอบที่ใช้ตรวจสอบ API ของคุณเองเทียบกับ mock จะอยู่ใน tests/checkout.hurl
POST {{base_url}}/orders
Content-Type: application/json
{
"sku": "ssd-1tb",
"amount": 4200
}
HTTP 201
[Captures]
order_id: jsonpath "$['id']"
GET {{base_url}}/orders/{{order_id}}
HTTP 200
[Asserts]
jsonpath "$.status" == "paid"
jsonpath "$.charge_id" == "ch_test_001"บล็อก [Captures] คือสิ่งที่ทำให้การทดสอบนี้เป็นการทดสอบ API แทนที่จะเป็นเพียงการส่งคำขอสองรายการที่ไม่เกี่ยวข้องกัน โดย order_id จะถูกอ่านจาก response แรกและนำไปแทรกใน URL ของคำขอที่สอง การตรวจสอบที่ charge_id คือจุดประสงค์หลักของการทดสอบนี้ ซึ่งเป็นการพิสูจน์ว่าบริการของคุณได้เรียกใช้งานผู้ให้บริการชำระเงินและจัดเก็บข้อมูลที่ได้รับกลับมาจริง โดยค่าที่นำมาเปรียบเทียบคือค่าที่คุณเขียนไว้ใน WireMock stub ไฟล์เดียวจึงครอบคลุมการทำงานทั้งสองส่วนของกระบวนการ
hurl --test --variable base_url=http://127.0.0.1:3000 \
--report-junit reports/junit.xml \
--report-json reports/json \
tests/การรันที่ผ่านจะแสดงผลลัพธ์หนึ่งบรรทัดต่อไฟล์พร้อมสรุปผล
tests/checkout.hurl: Success (2 request(s) in 61 ms)
Executed files: 1
Executed requests: 2 (30.1/s)
Succeeded files: 1 (100.0%)
Failed files: 0 (0.0%)
Duration: 64 msหากการทดสอบล้มเหลว ระบบจะแสดง error: Assert failure พร้อมระบุชื่อไฟล์และหมายเลขบรรทัด ตามด้วยค่าที่ได้รับจริงเทียบกับค่าที่คาดหวัง และ hurl จะส่งค่า exit code ที่ไม่ใช่ศูนย์เพื่อให้ CI หยุดทำงาน หาก status อ่านค่าได้ pending ในขณะที่คุณคาดหวัง paid แสดงว่าบริการของคุณไม่ได้ประมวลผล response จาก mock สิ่งที่ควรตรวจสอบลำดับถัดไปคือบันทึกการเรียกใช้งาน (request journal) ของ WireMock ที่ /__admin/requests ซึ่งจะแสดงให้เห็นว่าคำขอดังกล่าวส่งไปถึง mock หรือไม่
การเรียกใช้ชุดทดสอบจาก CI runner ของคุณเอง
เมื่อมีการลงทะเบียน runner ไว้บนเครื่องเดียวกัน เวิร์กโฟลว์จะสั้นลง เนื่องจาก runner เป็นเพียง process หนึ่งบนโฮสต์ คุณจึงต้องติดตั้ง docker และ hurl ไว้บนโฮสต์นั้นด้วย โดยจะไม่มีการสืบทอดค่าใดๆ มาจาก hosted image
name: api-tests
on: [push]
jobs:
hurl:
runs-on: self-hosted
steps:
- uses: actions/checkout@v4
- name: Start the mock
run: docker compose up -d --wait mock-payments
- name: Run the suite
run: hurl --test --variable base_url=http://127.0.0.1:3000 --report-junit reports/junit.xml tests/
- name: Archive the reports
if: always()
run: install -d /srv/api-tests/reports/$GITHUB_SHA && cp -r reports/. /srv/api-tests/reports/$GITHUB_SHA/
- name: Stop the mock
if: always()
run: docker compose downif: always() ในขั้นตอนการทำ archive มีความสำคัญ หากไม่มีขั้นตอนนี้ การทดสอบที่ล้มเหลวจะข้ามการคัดลอกไฟล์ไป ทำให้คุณไม่ได้รับรายงานที่ต้องการอ่าน นอกจากนี้ การคัดลอกไฟล์จะต้องทำไว้นอก workspace เนื่องจาก actions/checkout@v4 จะรัน git clean -ffdx โดยอัตโนมัติก่อนการดึงข้อมูล ซึ่งจะลบรายงานที่ไม่ได้ถูกติดตาม (untracked reports) ออกจากไดเรกทอรีของ repository ในการ checkout ครั้งถัดไป
เก็บผลลัพธ์ไว้ ไม่ใช่แค่การรันครั้งล่าสุด
ไฟล์ JUnit XML ต่อหนึ่ง commit ตอบคำถามได้เพียงข้อเดียวคือ ผลการทดสอบผ่านหรือไม่ แต่ไม่สามารถตอบได้ว่า endpoint เริ่มทำงานช้าลงตั้งแต่เมื่อใด เพราะไม่มีใครอ่านไฟล์เหล่านั้นหลังจากที่คุณเลิกเปิดดู หากต้องการดูแนวโน้ม ให้เพิ่มข้อมูลหนึ่งแถวต่อการรันหนึ่งครั้งลงในฐานข้อมูลขนาดเล็กบนเครื่องเดียวกัน ตารางเดียวที่เก็บค่า commit SHA, ชื่อไฟล์, จำนวนที่ผ่าน, จำนวนที่ล้มเหลว และระยะเวลาการทำงานก็เพียงพอแล้ว และ การใช้งาน SQLite ในสภาพแวดล้อม production บน VPS เป็นตัวเลือกที่เหมาะสมในการจัดเก็บข้อมูลนี้ เนื่องจากเป็นไฟล์เดียว ไม่ต้องมีกระบวนการ server แยกต่างหาก และประวัติทั้งหมดจะถูกรวมอยู่ในไฟล์สำรองข้อมูลที่คุณทำไว้อยู่แล้ว ให้ใช้การ parse ผลลัพธ์จาก --report-json ของ Hurl เพื่อดึงข้อมูลการรันโดยละเอียด ทั้งรูปแบบ JSON และ JUnit XML สามารถอ่านได้ด้วยเครื่องมืออัตโนมัติ
สิ่งที่ต้องคงอยู่หลังจากการสร้างคอนเทนเนอร์ใหม่
คำจำกัดความของ Mock และชุดทดสอบถือเป็นซอร์สโค้ด สิ่งเหล่านี้ควรอยู่ในที่เก็บข้อมูล (repository) เดียวกันกับบริการที่อธิบาย และต้องมีการเปลี่ยนแปลงใน Pull Request เดียวกันกับการแก้ไข endpoint การแก้ไข Stub ผ่านเว็บ UI หรือการส่งค่าคาดหวัง (expectation) ไปยัง MockServer ผ่าน REST API ในขณะรันไทม์ จำเป็นต้องมีการตั้งค่าการส่งออกข้อมูล (export) หรือการคงอยู่ของข้อมูล (persistence) เพื่อให้ข้อมูลยังคงอยู่หลังจากการสร้างคอนเทนเนอร์ใหม่ หากคุณรันคำสั่ง docker compose down หน่วยความจำของคอนเทนเนอร์และเลเยอร์ที่เขียนทับได้จะสูญหายไป แต่ข้อมูลที่เก็บไว้ใน bind mounts หรือ named volumes จะยังคงอยู่ หาก repository ของคุณรันบนฮาร์ดแวร์ของคุณเอง เซิร์ฟเวอร์ git ที่โฮสต์เอง จะช่วยเก็บข้อมูลจำลอง (fixtures) และบริการไว้ภายในขอบเขตความปลอดภัยเดียวกัน
จากนั้นเป็นกฎในทางปฏิบัติ ให้ระบุเวอร์ชันของ image (pin image tags) เพราะ latest อาจเปลี่ยนวิธีการที่ Mock ของคุณจับคู่คำขอโดยที่คุณไม่ได้แก้ไข repository เลย ซึ่งความล้มเหลวนั้นจะหาสาเหตุได้ยากมาก ให้ mount ไดเรกทอรีของ Stub แบบอ่านได้อย่างเดียว (read only) ในกรณีที่เครื่องมือไม่จำเป็นต้องเขียนข้อมูลลงไป ห้ามเก็บ Stub ของ Mock ไว้ใน named Docker volume เพราะ volume นั้นจะกลายเป็นแหล่งข้อมูลหลัก (source of truth) และสำเนาที่อยู่ใน git จะกลายเป็นข้อมูลที่ผิดพลาดโดยไม่รู้ตัว
อีกหนึ่งข้อที่มักทำให้เกิดปัญหา หากคุณสร้าง Stub โดยการบันทึก traffic จริงผ่าน proxy ให้ตรวจสอบไฟล์ที่สร้างขึ้นทุกไฟล์ก่อนทำการ commit การบันทึกข้อมูลจะเก็บสิ่งที่ upstream ส่งกลับมาทั้งหมด รวมถึง bearer tokens และที่อยู่อีเมลของลูกค้า การ commit ข้อมูลเหล่านี้จะทำให้ข้อมูลดังกล่าวอยู่ใน repository ของคุณอย่างถาวร เนื่องจาก git จะเก็บประวัติของเนื้อหาที่ถูกลบไว้ด้วย
FAQ
API mock server กับ API test runner ต่างกันอย่างไร
Mock server ทำหน้าที่ตอบรับคำขอ โดยจำลอง dependency ที่คุณไม่สามารถเรียกใช้งานได้จาก CI บางเครื่องมือสามารถรัน contract test และรายงานผลได้ ส่วน API test runner จะส่งคำขอไปยังบริการของคุณ ตรวจสอบผลลัพธ์ (assert) ส่งผ่านค่าจากคำขอหนึ่งไปยังอีกคำขอหนึ่ง และส่งค่า exit code ที่ไม่ใช่ศูนย์เมื่อการตรวจสอบล้มเหลว ทั้งสองอย่างแก้ปัญหาที่ต่างกัน และการตั้งค่าทั่วไปมักใช้งานร่วมกัน คือ runner เรียกบริการของคุณ ในขณะที่บริการของคุณเรียก mock
ฉันสามารถทดสอบ API ภายในจาก hosted CI runner ได้หรือไม่
ได้ หากใช้เครือข่ายส่วนตัว (private networking) โดย GitHub-hosted runners รองรับการเชื่อมต่อผ่าน WireGuard overlay หรือ Azure Virtual Network เพื่อเข้าถึงทรัพยากรภายในโดยไม่ต้องเปิดเผย API สู่สาธารณะ ทางเลือกอื่นคือการเปิดเผย API, การรัน tunnel หรือการดูแลสำเนา staging แบบสาธารณะ ซึ่งแต่ละวิธีเป็นการเพิ่มระบบที่อาจเกิดความล้มเหลวหรือข้อมูลรั่วไหลได้ การใช้ runner บนเครือข่ายส่วนตัวเดียวกันเพื่อเรียกบริการโดยตรงจึงเป็นเหตุผลหลักในทางปฏิบัติที่ทีมงานเลือก self-host งานส่วนนี้
ควรเก็บ mock stubs และ API test suites ไว้ที่ใด
ควรเก็บไว้ใน git คู่กับบริการที่เกี่ยวข้อง เครื่องมือที่จัดเก็บนิยามเป็นไฟล์ เช่น ไดเรกทอรี mappings/ ของ WireMock, ไฟล์ข้อมูลของ Mockoon, ไฟล์ Hurl และโฟลเดอร์ .bru ของ Bruno ช่วยให้คุณทำ code review และ rebuild container ได้โดยไม่มีค่าใช้จ่ายเพิ่มเติม ส่วนเครื่องมือที่เก็บนิยามไว้ในฐานข้อมูลหรือ web UI จำเป็นต้องมีแผนสำรองและขั้นตอนการ export ซึ่งมักเป็นส่วนที่คนลืมทำจนกระทั่ง container หายไปแล้ว
ทำไม mock ของฉันถึงตอบกลับ 404 ทั้งที่ stub ดูถูกต้อง
WireMock จะตอบสนองด้วย stub ก็ต่อเมื่อคำขอตรงกับเงื่อนไขที่กำหนดไว้เท่านั้น คำขอที่ไม่ตรงจะได้รับ 404 หากมีคำขอที่ใกล้เคียง ส่วนเนื้อหา (body) จะขึ้นต้นด้วย Request was not matched ตามด้วยความแตกต่าง (diff) เทียบกับ stub ที่ใกล้เคียงที่สุด ซึ่งความแตกต่างนั้นจะระบุฟิลด์ที่ไม่ตรงกัน หากไม่มีการทำ stub mappings เนื้อหาจะอธิบายว่า instance นั้นไม่มี stub ใดเลย สาเหตุที่พบบ่อยคือการมี slash ต่อท้าย path, header Content-Type ที่ stub ต้องการแต่ client ของคุณไม่ได้ส่งมา, การใช้ urlPath ในจุดที่ stub ต้องการ urlPathPattern สำหรับส่วนที่เป็นตัวแปร และ body matcher ที่ไม่ตรงกับ payload ให้ตรวจสอบ /__admin/requests ก่อนเพื่อยืนยันว่าคำขอนั้นมาถึง mock จริงหรือไม่
ฉันยังจำเป็นต้องใช้ mocks หากมี staging environment อยู่แล้วหรือไม่
จำเป็น ด้วยเหตุผลสองประการ ประการแรก สำเนา staging ของ upstream ที่คุณควบคุมไม่ได้อาจล่มหรือจำกัดอัตราการเรียก (rate limit) ทำให้ชุดทดสอบของคุณล้มเหลวด้วยเหตุผลที่ไม่เกี่ยวกับโค้ดของคุณ ประการที่สอง staging ไม่สามารถสร้างการตอบสนองที่คุณต้องการทดสอบได้ เช่น กรณีบัตรถูกปฏิเสธหรือ gateway timeout แต่ mock สามารถส่งค่าเหล่านี้ได้ทันทีด้วยความเร็วเครือข่ายภายใน ซึ่งช่วยลดเวลาการรันชุดทดสอบจากหลายนาทีบน sandbox ให้เหลือเพียงไม่กี่วินาที ควรเก็บ staging ไว้สำหรับการตรวจสอบขั้นสุดท้ายก่อน release และใช้ mocks ใน CI แทน