python - REST サービスのテストを自動化するために必要なアドバイス

Question

私はRESTとテスト部門の初心者です。REST サービスをテストするには、自動化スクリプトを作成する必要がありました。Jenkins CI ジョブからこれらのスクリプトを定期的に実行する予定です。Selenium IDEによって生成されたPythonでUI機能テストスクリプトを既に持っているので、これらをPythonで書くことを好みますが、私はどんな良い解決策にもオープンです。また、xml などから API 情報を読み取って、テンプレートを作成し、REST API ごとに実際のスクリプトを生成することをお勧めします。すべてのアドバイスに感謝します。

Answer 1

私は通常、Cucumberを使用して安静な API をテストします。次の例は Ruby ですが、 ruby​​py gemまたはlettuceを使用して簡単に Python に変換できます。

一連の RESTful 基本ステップから始めます。

When /^I send a GET request for "([^\"]*)"$/ do |path|
  get path
end

When /^I send a POST request to "([^\"]*)" with the following:$/ do |path, body|
  post path, body
end

When /^I send a PUT request to "([^\"]*)" with the following:$/ do |path, body|
  put path, body
end

When /^I send a DELETE request to "([^\"]*)"$/ do |path|
  delete path
end

Then /^the response should be "([^\"]*)"$/ do |status|
  last_response.status.should == status.to_i
end

Then /^the response JSON should be:$/ do |body|
  JSON.parse(last_response.body).should == JSON.parse(body)
end

これで、実際にリクエストを発行して API をテストする機能を作成できるようになりました。

Feature: The users endpoints

  Scenario: Creating a user
    When I send a POST request to "/users" with the following:
      """
      { "name": "Swift", "status": "awesome" }
      """
    Then the response should be "200"

  Scenario: Listing users
    Given I send a POST request to "/users" with the following:
      """
      { "name": "Swift", "status": "awesome" }
      """
    When I send a GET request for "/users"
    Then the response should be "200"
    And the response JSON should be:
      """
      [{ "name": "Swift", "status": "awesome" }]
      """

   ... etc ...

これらは、選択した CI システムで簡単に実行できます。参照については、次のリンクを参照してください。

• http://www.anthonyeden.com/2010/11/testing-rest-apis-with-cucumber-and-rack-test/
• http://jeffkreeftmeijer.com/2011/the-pain-of-json-api-testing/
• http://www.cheezyworld.com/2011/08/09/running-your-cukes-in-jenkins/

Answer 2

import openpyxl
import requests
import json
from requests.auth import HTTPBasicAuth

urlHead='https://IP_ADDRESS_HOST:PORT_NUMBER/'

rowStartAt=2
apiColumn=2
#payloadColumn=3
responseBodyColumn=12
statusCodeColumn=13

headerTypes = {'Content-Type':'application/json',
               'Accept':'application/json',
                'Authorization': '23324'
               }

wb = openpyxl.load_workbook('Excel_WORKBOOK.xlsx')

# PROCESS EACH SHEET
for sheetName in (wb.get_sheet_names()):
    print ('Sheet Name = ' + sheetName)

    flagVar = input('Enter N To avoid APIs Sheets')
    if (flagVar=='N'):
        print ('Sheet got skipped')
        continue


    #get a sheet
    sheetObj = wb.get_sheet_by_name(sheetName)

    #for each sheet iterate the API's
    for i in range(2, sheetObj.max_row+1):
        #below is API with method type
        apiFromSheet = (sheetObj.cell(row=i, column=apiColumn).value)
        if apiFromSheet is None:
            continue

        #print (i, apiFromSheet)
        #Let's split the api
        apiType = apiFromSheet.split()[0]
        method = apiFromSheet.split()[1]

        if (apiType!='GET'):
            continue

        #lets process GET API's
        absPath = urlHead + method
        print ("REQUESTED TYPE AND PATH = ", apiType, absPath)
        print('\n')


        res = requests.get(absPath, auth=HTTPBasicAuth(user, pwd),           verify=False, headers=headerTypes)

        #LET's write res body into relevant cell
        sheetObj.cell(row=i, column=responseBodyColumn).value = (res.text)
        sheetObj.cell(row=i, column=statusCodeColumn).value =  (res.status_code)
        wb.save('Excel_WORKBOOK.xlsx')



          `#exit(0)`