آموزش تست API با TestComplete — از ارسال اولین درخواست تا CI/CD

def Test_GetProductList():
    # ساخت HTTP request
    url = "https://api.arinshop.example.com/api/products"
    
    httpRequest = TestComplete.CreateObject("TestComplete.HTTPRequest")
    httpRequest.Method = "GET"
    httpRequest.URL = url
    httpRequest.AddHeader("Accept", "application/json")
    httpRequest.AddHeader("Authorization", "Bearer " + GetAuthToken())
    
    # ارسال درخواست
    response = httpRequest.Send()
    
    # اعتبارسنجی status code
    if response.StatusCode != 200:
        Log.Error("Status code نادرست: " + str(response.StatusCode))
        return
    
    Log.Message("✓ Status 200 OK")
    
    # اعتبارسنجی Content-Type
    contentType = response.GetHeader("Content-Type")
    if "application/json" not in contentType:
        Log.Error("Content-Type اشتباه است: " + contentType)
        return
    
    Log.Message("✓ Content-Type صحیح است")
    
    # parse کردن JSON
    import json
    body = json.loads(response.Body)
    
    # بررسی اینکه پاسخ یک لیست است
    if not isinstance(body, list):
        Log.Error("پاسخ باید آرایه باشد")
        return
    
    # بررسی اینکه حداقل یک محصول وجود دارد
    if len(body) == 0:
        Log.Error("لیست محصولات خالی است")
        return
    
    Log.Message("✓ تعداد محصولات دریافت‌شده: " + str(len(body)))
    
    # بررسی ساختار اولین آیتم
    first_product = body[0]
    required_fields = ["id", "name", "price", "stock"]
    
    for field in required_fields:
        if field not in first_product:
            Log.Error("فیلد '" + field + "' در پاسخ وجود ندارد")
        else:
            Log.Message("✓ فیلد '" + field + "' موجود است")

def GetAuthToken():
    """
    Login می‌کند و access token برمی‌گرداند.
    نتیجه را در یک متغیر project ذخیره می‌کند 
    تا در هر test session فقط یک بار فراخوانی شود.
    """
    # اگر قبلاً token گرفته‌ایم، همان را برگردان
    cached_token = Project.Variables.AuthToken
    if cached_token != "":
        return cached_token
    
    httpRequest = TestComplete.CreateObject("TestComplete.HTTPRequest")
    httpRequest.Method = "POST"
    httpRequest.URL = "https://api.arinshop.example.com/api/auth/login"
    httpRequest.AddHeader("Content-Type", "application/json")
    
    import json
    credentials = json.dumps({
        "username": Project.Variables.TestUsername,
        "password": Project.Variables.TestPassword
    })
    httpRequest.Body = credentials
    
    response = httpRequest.Send()
    
    if response.StatusCode != 200:
        Log.Error("Login ناموفق بود. Status: " + str(response.StatusCode))
        return ""
    
    body = json.loads(response.Body)
    token = body.get("access_token", "")
    
    # ذخیره در Project Variable برای استفاده مجدد
    Project.Variables.AuthToken = token
    
    Log.Message("✓ Authentication موفق")
    return token

def Test_CreateOrder():
    import json
    
    # آماده‌سازی داده سفارش
    order_payload = {
        "items": [
            {"product_id": 101, "quantity": 2},
            {"product_id": 205, "quantity": 1}
        ],
        "shipping_address": {
            "city": "تهران",
            "street": "خیابان آزادی",
            "postal_code": "1234567890"
        },
        "payment_method": "wallet"
    }
    
    httpRequest = TestComplete.CreateObject("TestComplete.HTTPRequest")
    httpRequest.Method = "POST"
    httpRequest.URL = "https://api.arinshop.example.com/api/orders"
    httpRequest.AddHeader("Content-Type", "application/json")
    httpRequest.AddHeader("Authorization", "Bearer " + GetAuthToken())
    httpRequest.Body = json.dumps(order_payload, ensure_ascii=False)
    
    response = httpRequest.Send()
    
    # ۲۰۱ Created انتظار داریم، نه ۲۰۰
    aqVerification.CheckEqual(
        response.StatusCode, 
        201, 
        "Status code ثبت سفارش باید 201 باشد"
    )
    
    body = json.loads(response.Body)
    
    # بررسی وجود order_id در پاسخ
    aqVerification.CheckNotEqual(
        body.get("order_id", None),
        None,
        "پاسخ باید order_id داشته باشد"
    )
    
    # بررسی status اولیه سفارش
    aqVerification.CheckEqual(
        body.get("status"),
        "pending",
        "سفارش جدید باید status = pending داشته باشد"
    )
    
    # ذخیره order_id برای استفاده در تست بعدی
    Project.Variables.LastOrderId = str(body["order_id"])
    
    Log.Message("✓ سفارش با ID " + str(body["order_id"]) + " ثبت شد")
    
    return body["order_id"]

def Test_FullOrderFlow():
    """
    یک flow کامل را تست می‌کند:
    ۱. دریافت لیست محصولات
    ۲. بررسی موجودی یک محصول خاص
    ۳. ثبت سفارش
    ۴. تأیید وضعیت سفارش
    """
    import json
    
    # ---- مرحله ۱: دریافت محصولات ----
    Log.AppendFolder("مرحله ۱: دریافت لیست محصولات")
    
    req = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req.Method = "GET"
    req.URL = "https://api.arinshop.example.com/api/products?category=shoes"
    req.AddHeader("Authorization", "Bearer " + GetAuthToken())
    
    resp = req.Send()
    aqVerification.CheckEqual(resp.StatusCode, 200, "دریافت محصولات")
    
    products = json.loads(resp.Body)
    first_available = next(
        (p for p in products if p["stock"] > 0), 
        None
    )
    
    if first_available is None:
        Log.Error("هیچ محصول موجودی یافت نشد")
        return
    
    product_id = first_available["id"]
    Log.Message("✓ محصول انتخاب‌شده: " + first_available["name"])
    Log.PopLogFolder()
    
    # ---- مرحله ۲: بررسی جزئیات محصول ----
    Log.AppendFolder("مرحله ۲: بررسی جزئیات محصول")
    
    req2 = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req2.Method = "GET"
    req2.URL = "https://api.arinshop.example.com/api/products/" + str(product_id)
    req2.AddHeader("Authorization", "Bearer " + GetAuthToken())
    
    resp2 = req2.Send()
    product_detail = json.loads(resp2.Body)
    
    aqVerification.CheckEqual(
        product_detail["id"], 
        product_id, 
        "ID محصول در جزئیات صحیح است"
    )
    aqVerification.CheckNotEqual(
        product_detail.get("price"), 
        None, 
        "قیمت محصول وجود دارد"
    )
    
    Log.PopLogFolder()
    
    # ---- مرحله ۳: ثبت سفارش ----
    Log.AppendFolder("مرحله ۳: ثبت سفارش")
    
    order_id = Test_CreateOrder()
    
    if order_id is None:
        Log.Error("ثبت سفارش ناموفق بود — flow متوقف شد")
        return
    
    Log.PopLogFolder()
    
    # ---- مرحله ۴: بررسی وضعیت سفارش ----
    Log.AppendFolder("مرحله ۴: بررسی وضعیت سفارش")
    
    req4 = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req4.Method = "GET"
    req4.URL = "https://api.arinshop.example.com/api/orders/" + str(order_id)
    req4.AddHeader("Authorization", "Bearer " + GetAuthToken())
    
    resp4 = req4.Send()
    order = json.loads(resp4.Body)
    
    aqVerification.CheckEqual(resp4.StatusCode, 200, "دریافت وضعیت سفارش")
    aqVerification.CheckEqual(
        order["id"], 
        order_id, 
        "ID سفارش در پاسخ صحیح است"
    )
    
    valid_statuses = ["pending", "confirmed", "processing"]
    if order["status"] not in valid_statuses:
        Log.Error("وضعیت سفارش نامعتبر است: " + order["status"])
    else:
        Log.Message("✓ وضعیت سفارش: " + order["status"])
    
    Log.PopLogFolder()
    
    Log.Message("✓ Full order flow با موفقیت تست شد")

def Test_ErrorScenarios():
    import json
    
    # ---- تست ۱: درخواست بدون Authentication ----
    Log.AppendFolder("تست بدون token")
    
    req = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req.Method = "GET"
    req.URL = "https://api.arinshop.example.com/api/orders"
    # عمداً header Authorization اضافه نمی‌کنیم
    
    resp = req.Send()
    aqVerification.CheckEqual(
        resp.StatusCode, 
        401, 
        "بدون token باید 401 Unauthorized برگردد"
    )
    
    Log.PopLogFolder()
    
    # ---- تست ۲: ID محصول نامعتبر ----
    Log.AppendFolder("تست ID نامعتبر")
    
    req2 = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req2.Method = "GET"
    req2.URL = "https://api.arinshop.example.com/api/products/99999999"
    req2.AddHeader("Authorization", "Bearer " + GetAuthToken())
    
    resp2 = req2.Send()
    aqVerification.CheckEqual(
        resp2.StatusCode, 
        404, 
        "محصول ناموجود باید 404 برگرداند"
    )
    
    Log.PopLogFolder()
    
    # ---- تست ۳: body ناقص در POST ----
    Log.AppendFolder("تست body ناقص")
    
    req3 = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req3.Method = "POST"
    req3.URL = "https://api.arinshop.example.com/api/orders"
    req3.AddHeader("Content-Type", "application/json")
    req3.AddHeader("Authorization", "Bearer " + GetAuthToken())
    req3.Body = json.dumps({"items": []})  # items خالی
    
    resp3 = req3.Send()
    aqVerification.CheckEqual(
        resp3.StatusCode, 
        400, 
        "سبد خرید خالی باید 400 Bad Request برگرداند"
    )
    
    # بررسی پیام خطا در body پاسخ
    error_body = json.loads(resp3.Body)
    if "error" not in error_body and "message" not in error_body:
        Log.Warning("پاسخ خطا باید فیلد 'error' یا 'message' داشته باشد")
    
    Log.PopLogFolder()

def Test_DataDriven_OrderCreation():
    import json
    
    # اتصال به فایل Excel
    DDT.ExcelDriver(
        "C:\\TestData\\order_scenarios.xlsx", 
        "Sheet1",
        True  # first row = header
    )
    
    while not DDT.CurrentDriver.EOF():
        product_id    = int(DDT.CurrentDriver.Value("product_id"))
        quantity      = int(DDT.CurrentDriver.Value("quantity"))
        expected_http = int(DDT.CurrentDriver.Value("expected_http"))
        
        # ساخت و ارسال درخواست
        req = TestComplete.CreateObject("TestComplete.HTTPRequest")
        req.Method = "POST"
        req.URL = "https://api.arinshop.example.com/api/orders"
        req.AddHeader("Content-Type", "application/json")
        req.AddHeader("Authorization", "Bearer " + GetAuthToken())
        req.Body = json.dumps({
            "items": [{"product_id": product_id, "quantity": quantity}],
            "payment_method": "wallet"
        })
        
        resp = req.Send()
        
        # اعتبارسنجی
        label = "product_id=" + str(product_id) + ", qty=" + str(quantity)
        aqVerification.CheckEqual(
            resp.StatusCode,
            expected_http,
            "HTTP status برای سناریو: " + label
        )
        
        DDT.CurrentDriver.Next()
    
    DDT.CurrentDriver.Close()

def Test_SoapPaymentService():
    # فراخوانی متد SOAP
    ws = WebServices.PaymentService
    
    result = ws.ProcessPayment(
        OrderId="ORD-2025-001",
        Amount=850000,
        Currency="IRR",
        PaymentMethod="BankTransfer"
    )
    
    # اعتبارسنجی پاسخ SOAP
    aqVerification.CheckEqual(
        result.StatusCode, 
        "SUCCESS",
        "پرداخت باید موفق باشد"
    )
    
    aqVerification.CheckNotEqual(
        result.TransactionId,
        "",
        "TransactionId نباید خالی باشد"
    )
    
    Log.Message("✓ پرداخت موفق — TransactionId: " + result.TransactionId)

stages:
  - api-test
  - ui-test

api-regression:
  stage: api-test
  script:
    - |
      "C:\Program Files\SmartBear\TestComplete 15\Bin\TestComplete.exe"
      "ArinShopApiTests\ArinShopApiTests.pjs"
      /run /TestItem:"ApiTests"
      /exit /SilentMode
      /ExportLog:"TestResults\api-results.xml"
  artifacts:
    reports:
      junit: TestResults/api-results.xml
  variables:
    TC_TEST_USERNAME: $TEST_API_USERNAME
    TC_TEST_PASSWORD: $TEST_API_PASSWORD
  only:
    - main
    - develop

import os
username = os.environ.get("TC_TEST_USERNAME", "default_test_user")

def Teardown_DeleteTestOrder(order_id):
    req = TestComplete.CreateObject("TestComplete.HTTPRequest")
    req.Method = "DELETE"
    req.URL = "https://api.arinshop.example.com/api/test/orders/" + str(order_id)
    req.AddHeader("Authorization", "Bearer " + GetAdminToken())
    req.Send()

import time

start = time.time()
resp = req.Send()
elapsed = time.time() - start

if elapsed > 2.0:
    Log.Warning("API کند است: " + str(round(elapsed, 2)) + " ثانیه")
else:
    Log.Message("✓ Response time: " + str(round(elapsed, 2)) + " ثانیه")