클라우드 실행기 테스트 사용자 REST API

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기15분

    • ATF(Automated Test Framework)용 클라우드 실행기에서 실행할 테스트 사용자 작업을 관리합니다.

    Cloud Runner 테스트 사용자 API에는 (sn_atf_tg) 플러그인이 ATF Test Generator and Cloud Runner 필요합니다. 이 API에서 사용할 수 있는 메서드는 now 네임스페이스에서 실행되며 REST API 탐색기에서 ATF에 대한 원클릭 회귀 테스트인 API 이름을 사용하여 호출할 수 있습니다. 이 API에 액세스하려면 관리자 역할이 필요합니다.

    이 API는 다음 작업에 사용할 수 있습니다.
    • 사용자 테스트 작업을 시작합니다.
    • 클라우드 사용자를 설정합니다.
    • 지정된 사용자가 유효한지 확인합니다.
    • 사용자 테스트 작업의 진행률을 확인합니다.
    • 테스트 작업을 취소합니다.

    Cloud Runner Test Runner API 클라우드 실행기 테스트 생성 REST API 는 및 클라우드 실행기 테스트 사용자 REST API. 예를 들어 테스트(Cloud Runner Test Generation API)를 생성한 다음 브라우저 오케스트레이션 큐(Cloud Runner 테스트 생성 API)에서 테스트 진행률을 가져오고 통과 또는 실패한 테스트 수를 확인할 수 있습니다.

    이 API의 서버 API 참조 문서를 보려면 을 참조하십시오 클라우드 실행기 TestUserApi – 범위가 지정됨, 전역.

    클라우드 실행기 테스트 사용자 - GET /now/sn_atf_tg/test_user_progress

    제공된 BOQ(브라우저 오케스트레이션 큐) 기록에 대한 테스트 사용자 작업의 상태를 제공합니다.

    URL 형식

    기본 URL: GET /api/now/sn_atf_tg/test_user_progress

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    snboqID 필수 진행률을 가져올 테스트 사용자 작업의 BOQ 기록 sys_id입니다. BOQ [sn_atf_tg_sn_boq] 테이블에 있습니다.

    데이터 유형: 문자열
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 테스트 사용자 작업의 진행률을 성공적으로 검색했습니다.
    400 BOQ 기록 상태를 가져오는 동안 오류가 발생했습니다. 다음 메시지 중 하나를 반환합니다.
    • BOQ ID가 전달되지 않음 – BOQ ID가 제공되지 않았습니다. 요청 본문에 BOQ ID를 추가합니다.
    • BOQ 기록을 찾을 수 없음 – 시스템 ID가 잘못되었습니다. BOQ 기록의 sys_id이 유효하고 기록이 존재하는지 확인합니다.
    403 엔드포인트에 대한 사용자 액세스 권한 부여 중 오류가 발생했습니다. 사용자에게 관리자 역할이 있는지 확인합니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 테스트 러너 작업의 진행 결과 또는 요청이 실패한 이유를 설명하는 메시지가 포함된 객체입니다.
    "result": { 
    "progress": 100, 
    "state": "completed" 
  }

    또는:

    "result": { 
    "message": "String"
}

    데이터 유형: 객체
    결과.메시지 테스트 러너 진행률을 검색할 수 없는 이유를 자세히 설명하는 오류 메시지입니다. message 매개 변수는 성공적인 응답에서 반환되지 않습니다.

    데이터 유형: 문자열
    결과.진행률 실행 중인 상태에서 테스트 완료에 얼마나 근접했는지를 나타내는 백분율입니다.

    데이터 유형: 숫자
    결과.상태 BOQ 기록의 현재 상태입니다.

    가능한 값:

    • 보류 중 – 요청한 테스트 활동이 작성되어 실행 대기 중입니다.
    • 처리 중 – 요청이 클라우드 인프라로 전송되기 전에 인스턴스가 실행 추적기가 클라우드 실행기에 대해 표시되었는지 확인하기 위해 레코드를 스캔합니다.
    • 브라우저 요청됨 – 테스트 생성 또는 테스트 실행을 위해 브라우저를 시작하라는 요청이 클라우드 인프라로 전송되었습니다.
    • 실행 중 – 클라우드 인프라 브라우저는 보류 중인 테스트를 찾아 실행합니다.
    • 완료됨 – 테스트 작업이 완료되었습니다.
    • Failed state – 테스트 작업이 실패했습니다.

    데이터 유형: 문자열

    cURL 요청

    다음 요청 예제에서는 테스트 사용자 작업의 진행 상황을 확인하는 방법을 보여 줍니다.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user_progress?snboqId=<sys_id of SNBOQ record>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    응답 본문:

    { 
  "result": { 
    "progress": 100, 
    "state": "completed" 
  } 
}

    클라우드 실행기 테스트 사용자 - GET /now/sn_atf_tg/is_valid_cloud_user

    제공된 사용자가 유효한 클라우드 사용자인지 확인합니다.

    이 메서드는 사용자가 다음 조건을 통과하는지 확인합니다.
    • 존재
    • 활성 상태이며,
    • 잠겨 있지 않습니다.
    • 암호 재설정이 필요함,
    • 관리자인 경우
    • 읽기 전용입니다.
    • 웹 서비스 전용임

    URL 형식

    기본 URL: GET /api/now/sn_atf_tg/is_valid_cloud_user

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    없음
    표 8. 쿼리 매개변수
    이름 설명
    username 필수 사용자가 다음 기준선 기준을 통과하는지 확인할 sys_user의 사용자 이름입니다.
    • 존재
    • 활성 상태이며,
    • 잠겨 있지 않습니다.
    • 암호 재설정이 필요함,
    • 관리자인 경우
    • 읽기 전용입니다.
    • 웹 서비스 전용임

    이러한 조건 중 하나라도 실패하면 API는 실패한 기준에 대한 메시지와 함께 false 부울을 반환합니다.

    데이터 유형: 문자열
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 12. 상태 코드
    상태 코드 설명
    200 사용자가 유효하고 클라우드 사용자 기준을 충족하는 경우 예 또는 아니오를 반환합니다.
    403 엔드포인트에 대한 사용자 액세스 권한 부여 중 오류가 발생했습니다. 사용자에게 관리자 역할이 있는지 확인합니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청 결과를 포함하는 객체입니다.
    
  "result": { 
    "validUser": Boolean 
  }

    데이터 유형: 객체
    결과.유효 사용자 사용자가 클라우드 사용자 기준을 충족하는지 여부를 나타내는 플래그입니다. true인 경우 사용자가 기준을 충족합니다.

    데이터 유형: 부울

    cURL 요청

    다음 요청은 제공된 sys_user 클라우드 기능을 사용하기 위한 기준을 충족하는지 확인합니다.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/is_valid_cloud_user?username=<username of sys_user to check>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    응답 본문:

    { 
  "result": { 
    "validUser": <Boolean value indicating whether user is valid cloud user> 
  } 
}

    클라우드 실행기 테스트 사용자 - POST /now/sn_atf_tg/test_user

    지정된 사용자 이름의 BOQ [sn_atf_tg_sn_boq] 테이블에 테스트 사용자 작업을 삽입한 다음 클라우드 실행기에서 실행합니다.

    URL 형식

    기본 URL: POST /api/now/sn_atf_tg/test_user

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    없음
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    username 필수 클라우드 실행기의 엔드 투 엔드 인프라를 테스트하기 위한 sys_user의 사용자 이름입니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 18. 상태 코드
    상태 코드 설명
    200 테스트 사용자 BOQ 작업을 성공적으로 삽입했습니다.
    400 테스트 사용자 작업을 시작하는 동안 오류가 발생했습니다.

    빈 사용자 이름이 제공되거나 sys_user 테이블에서 사용자를 찾을 수 없는 경우 서버에서 오류가 발생합니다.
    403 엔드포인트에 대한 사용자 액세스 권한 부여 중 오류가 발생했습니다. 사용자에게 관리자 역할이 있는지 확인합니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청 결과를 포함하는 객체입니다.
    
  "result": { 
    "snboqId": String
  }

    또는:

    "result": { 
    "message": "String"
}

    데이터 유형: 객체
    결과.메시지 사용자 이름에 테스트 역량을 할당할 수 없는 이유를 자세히 설명하는 오류 메시지입니다. message 매개 변수는 성공적인 응답에서 반환되지 않습니다.

    데이터 유형: 문자열
    결과.snboqId 테스트 사용자 작업이 성공적으로 시작될 때 삽입되는 BOQ 기록의 Sys_id입니다. BOQ [sn_atf_tg_sn_boq] 테이블에 있습니다.

    데이터 유형: 문자열

    cURL 요청

    다음 요청 예제에서는 지정된 사용자 이름에 대한 BOQ [sn_atf_tg_sn_boq] 테이블에 테스트 사용자 작업을 삽입하는 방법을 보여 줍니다.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to test cloud infrastructure>\"}" \ 
--user "username:password"

    응답은 테스트 사용자 작업이 시작될 때 삽입되는 BOQ 기록의 sys_id 반환합니다.

    { 
  "result": { 
    "snboqId": "<sys_id of newly inserted BOQ record>" 
  } 
}

    다음 예제에서는 사용자 이름이 전달되지 않거나 잘못된 사용자 이름이 전달될 때 400 오류 메시지를 반환합니다.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user" \
--request POST \
--header "Accept:application/json" \
--user "username:password"

    응답:

    {
  "result": {
    "message": "Unable to set cloud user as cloud user not valid"
  }
}

    클라우드 실행기 테스트 사용자 - POST /now/sn_atf_tg/cancel_test_user

    브라우저 오케스트레이션 큐(BOQ) [sn_atf_tg_sn_boq] 테이블에서 테스트 사용자 작업 상태를 완료로 설정합니다.

    URL 형식

    기본 URL: POST /api/now/sn_atf_tg/cancel_test_user

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    없음
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    snboqID 필수 테스트 사용자 작업과 관련하여 취소할 BOQ 기록의 Sys_id입니다. SNBOQ [sn_atf_tg_sn_boq] 테이블에 있습니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 24. 상태 코드
    상태 코드 설명
    200 BOQ 작업을 성공적으로 취소했습니다.
    400 작업을 취소하는 동안 오류가 발생했습니다. 다음 메시지 중 하나를 반환합니다.
    • BOQ ID가 전달되지 않음 – BOQ ID가 제공되지 않았습니다. 요청 본문에 BOQ ID를 추가합니다.
    • BOQ 기록을 찾을 수 없음 – 시스템 ID가 잘못되었습니다. BOQ 기록의 sys_id이 유효하고 기록이 존재하는지 확인합니다.
    403 엔드포인트에 대한 사용자 액세스 권한 부여 중 오류가 발생했습니다. 사용자에게 관리자 역할이 있는지 확인합니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청 결과를 포함하는 객체입니다.
    
  "result": { 
    "message": String
  }

    데이터 유형: 객체
    결과.메시지 테스트 사용자 취소가 성공했는지 여부를 자세히 설명하는 메시지입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 요청은 브라우저 오케스트레이션 큐 [sn_atf_tg_sn_boq] 테이블에서 테스트 사용자 작업을 취소하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
--user "username:password"

    성공 응답 본문:

    { 
  "result": { 
    "message": "success" 
  } 
}

    클라우드 실행기 테스트 사용자 - POST /now/sn_atf_tg/select_cloud_user

    클라우드 실행기에서 엔드 투 엔드 테스트 사용자 작업을 시작합니다. 사용자가 관리자 역할로 로그인할 수 있는 경우 클라우드 사용자 속성은 이후 테스트 실행 및 테스트 생성을 위해 이 사용자로 기본 설정됩니다.

    URL 형식

    기본 URL: POST /api/now/sn_atf_tg/select_cloud_user

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    없음
    표 26. 쿼리 매개변수
    이름 설명
    없음
    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    username 필수 테스트할 sys_user의 사용자 이름이며 향후 테스트 러너 및 테스트 생성 작업을 위해 클라우드 사용자를 설정합니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 28. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 29. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 30. 상태 코드
    상태 코드 설명
    200 엔드 투 엔드 클라우드 실행기 인프라를 성공적으로 테스트하고 향후 테스트 실행 및 테스트 생성 작업을 위해 클라우드 사용자를 설정했습니다.
    400 전체 엔드 투 엔드 클라우드 실행기 인프라를 테스트하고 클라우드 사용자를 설정하는 동안 오류가 발생했습니다. 사용자 이름이 비어 있지 않거나 지정된 사용자 이름의 sys_user 테이블에 사용자가 있는지 확인합니다.
    403 엔드포인트에 대한 사용자 액세스 권한 부여 중 오류가 발생했습니다. 사용자에게 관리자 역할이 있는지 확인합니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청 결과를 포함하는 객체입니다.
    
  "result": { 
    "message": "String"
  }

    데이터 유형: 객체
    결과.메시지 클라우드 실행기 인프라에서 향후 테스트 실행 및 테스트 생성을 위해 사용자가 성공적으로 선택되었는지 여부를 자세히 설명하는 메시지입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예제에서는 클라우드 실행기 인프라에서 향후 테스트 실행 및 테스트 생성을 위해 특정 사용자를 선택하도록 요청하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/select_cloud_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to set as cloud user>\"}" \ 
--user "username:password"

    응답 본문은 테스트 실행 및 생성을 위해 클라우드 사용자가 성공적으로 선택되었음을 나타내는 성공 메시지를 반환합니다.

    { 
  "result": { 
    "message": "success" 
  } 
}