안녕하세요 여러분! 오늘 우리는 IT 대중에게 우리 제품, 즉 API 작업을 위한 IDE를 소개하고 싶습니다. 테스트메이스. 아마도 여러분 중 일부는 이미 우리에 대해 알고 있을 것입니다. 이전 기사. 그러나 도구에 대한 포괄적인 검토가 없었으므로 이 불행한 단점을 해결합니다.

자극

실제로 우리가 어떻게 이 세상에 왔고 API를 사용한 고급 작업을 위한 자체 도구를 만들기로 결정했는지부터 시작하고 싶습니다. 제품이 가져야 할 기능 목록부터 시작하겠습니다. 우리 의견으로는 "API 작업을 위한 IDE"라고 말할 수 있습니다.

• 쿼리 및 스크립트 생성 및 실행(쿼리 시퀀스)
• 다양한 종류의 테스트 작성
• 테스트 생성
• Swagger, OpenAPI, WADL 등과 같은 형식에서 가져오기를 포함하여 API 설명 작업
• 조롱 요청
• 인기 있는 라이브러리와의 통합을 포함하여 스크립트 작성을 위한 하나 이상의 언어에 대한 우수한 지원
• 기타

목록은 취향에 맞게 확장할 수 있습니다. 또한 IDE 자체뿐만 아니라 클라우드 동기화, 명령줄 도구, 온라인 모니터링 서비스 등과 같은 특정 인프라를 만드는 것이 중요합니다. 결국, 최근 몇 년간의 추세는 애플리케이션의 강력한 기능뿐만 아니라 쾌적한 인터페이스도 결정합니다.

누가 그런 도구를 필요로 합니까? 분명히 API 개발 및 테스트와 적어도 어떻게든 연결된 모든 사람들은 개발자 및 테스터입니다 =). 또한 전자의 경우 단일 쿼리와 간단한 스크립트를 실행하는 것으로 충분하다면 테스터의 경우 이는 주요 도구 중 하나이며 무엇보다도 테스트를 실행할 수 있는 기능을 갖춘 테스트를 작성하기 위한 강력한 메커니즘을 포함해야 합니다. CI.

그래서 우리는 이러한 지침에 따라 제품을 만들기 시작했습니다. 이 단계에서 우리가 무엇을 달성했는지 살펴보겠습니다.

빠른 시작

응용 프로그램에 대한 첫 번째 아는 것부터 시작하겠습니다. 당신은 그것을 다운로드 할 수 있습니다 우리 웹사이트에서. 현재 Windows, Linux, MacOS 등 3가지 주요 플랫폼이 모두 지원됩니다. 다운로드, 설치, 실행. 처음 실행하면 다음과 같은 창이 나타날 수 있습니다.

첫 번째 요청을 생성하려면 콘텐츠 영역 상단에 있는 더하기 기호를 클릭하세요. 쿼리 탭은 다음과 같습니다.

좀 더 자세히 살펴보겠습니다. 요청 인터페이스는 널리 사용되는 나머지 클라이언트의 인터페이스와 매우 유사하므로 유사한 도구에서 더 쉽게 마이그레이션할 수 있습니다. URL에 대한 첫 번째 요청을 만들어 보겠습니다. https://next.json-generator.com/api/json/get/NJv-NT-U8

일반적으로 언뜻보기에 응답 패널도 놀라움을 표시하지 않습니다. 그러나 다음과 같은 몇 가지 사항에 주목하고 싶습니다.

1. 응답 본문은 트리 형식으로 표시되며, 먼저 정보 콘텐츠를 추가하고 두 번째로 아래에 대한 몇 가지 흥미로운 기능을 추가할 수 있습니다.
2. 주어진 요청에 대한 테스트 목록을 표시하는 어설션 탭이 있습니다.

보시다시피, 우리 도구는 편리한 휴식 클라이언트로 사용할 수 있습니다. 그러나 그 기능이 요청 전송에만 제한되어 있다면 우리는 여기에 있지 않을 것입니다. 다음으로 TestMace의 기본 개념과 기능에 대해 간략하게 설명하겠습니다.

기본 개념 및 기능

노드

TestMace 기능은 다양한 유형의 노드로 구분됩니다. 위의 예에서는 RequestStep 노드의 작동을 시연했습니다. 그러나 이제 다음 유형의 노드도 애플리케이션에서 사용할 수 있습니다.

• 요청단계. 요청을 생성할 수 있는 노드입니다. 하나의 어설션 노드만 하위 요소로 가질 수 있습니다.
• 역설. 노드는 테스트를 작성하는 데 사용됩니다. RequestStep 노드의 하위 노드만 될 수 있습니다.
• 폴더. 폴더 및 RequestStep 노드를 자체적으로 그룹화할 수 있습니다.
• 프로젝트. 프로젝트 생성 시 자동으로 생성되는 루트 노드입니다. 그렇지 않으면 폴더 노드의 기능을 반복합니다.
• 링크. 폴더 또는 RequestStep 노드에 연결합니다. 쿼리와 스크립트를 재사용할 수 있습니다.
• 기타

노드는 스크래치("일회성" 쿼리를 빠르게 생성하는 데 사용되는 왼쪽 하단 패널)와 프로젝트(왼쪽 상단 패널)에 있으며 이에 대해 더 자세히 설명하겠습니다.

계획

애플리케이션을 실행하면 왼쪽 상단에 프로젝트 라인이 하나뿐인 것을 볼 수 있습니다. 이는 프로젝트 트리의 루트입니다. 프로젝트를 시작하면 운영 체제에 따라 경로가 달라지는 임시 프로젝트가 생성됩니다. 언제든지 프로젝트를 편리한 위치로 이동할 수 있습니다.

프로젝트의 주요 목적은 파일 시스템에 개발 내용을 저장하고 버전 제어 시스템을 통해 추가로 동기화하고 CI에서 스크립트를 실행하고 변경 사항을 검토하는 기능입니다.

변수들

변수는 애플리케이션의 주요 메커니즘 중 하나입니다. TestMace와 같은 도구를 사용하여 작업하는 분들은 이미 우리가 말하는 내용에 대한 아이디어를 갖고 계실 것입니다. 따라서 변수는 공통 데이터를 저장하고 노드 간 통신을 수행하는 방법입니다. 예를 들어 Postman 또는 Insomnia의 환경 변수는 유사합니다. 그러나 우리는 더 나아가 주제를 발전시켰습니다. TestMace에서는 노드 수준에서 변수를 설정할 수 있습니다. 어느. 또한 조상으로부터 변수를 상속받고 자손에서 변수가 겹치는 메커니즘도 있습니다. 또한 여러 가지 내장 변수가 있으며 내장 변수의 이름은 다음으로 시작합니다. $. 다음은 그 중 일부입니다.

• $prevStep — 이전 노드의 변수에 대한 링크
• $nextStep — 다음 노드의 변수에 대한 링크
• $parent - 같은 일이지만 조상에게만 해당됩니다.
• $response - 서버로부터의 응답
• $env - 현재 환경 변수
• $dynamicVar - 스크립트 또는 쿼리 실행 중에 생성된 동적 변수

$env - 이는 본질적으로 일반적인 프로젝트 노드 레벨 변수이지만, 선택한 환경에 따라 환경 변수 세트가 변경됩니다.

변수는 다음을 통해 액세스됩니다. ${variable_name}
변수의 값은 다른 변수일 수도 있고 전체 표현식일 수도 있습니다. 예를 들어, url 변수는 다음과 같은 표현식일 수 있습니다.
http://${host}:${port}/${endpoint}.

이와 별도로 스크립트 실행 중에 변수를 할당할 수 있다는 점도 주목할 가치가 있습니다. 예를 들어, 로그인 성공 후 서버에서 받은 인증 데이터(토큰 또는 전체 헤더)를 저장해야 하는 경우가 종종 있습니다. TestMace를 사용하면 이러한 데이터를 조상 중 하나의 동적 변수에 저장할 수 있습니다. 이미 존재하는 "정적" 변수와의 충돌을 피하기 위해 동적 변수는 별도의 객체에 배치됩니다. $dynamicVar.

시나리오

위의 모든 기능을 사용하면 전체 쿼리 스크립트를 실행할 수 있습니다. 예를 들어 엔터티 만들기 -> 엔터티 쿼리 -> 엔터티 삭제입니다. 예를 들어 이 경우 폴더 노드를 사용하여 여러 RequestStep 노드를 그룹화할 수 있습니다.

자동 완성 및 표현 강조 표시

변수를 편리하게 사용하려면 자동 완성 기능이 필요합니다. 물론, 특정 변수가 무엇인지 명확하게 하기 위해 표현식의 값을 강조 표시합니다. 백 번 듣는 것보다 한 번 보는 것이 더 나은 경우가 바로 이것이다.

자동 완성은 변수뿐만 아니라 헤더, 특정 헤더 값(예: Content-Type 헤더의 자동 완성), 프로토콜 등에 대해서도 구현된다는 점은 주목할 가치가 있습니다. 목록은 애플리케이션이 성장함에 따라 지속적으로 업데이트됩니다.

실행 취소/다시 실행

변경 사항을 실행 취소/다시 실행하는 것은 매우 편리한 작업이지만 어떤 이유로든 모든 곳에서 구현되지는 않습니다(API 작업 도구도 예외는 아닙니다). 하지만 우리는 그런 사람이 아닙니다!) 전체 프로젝트에 걸쳐 실행 취소/다시 실행을 구현하여 특정 노드 편집뿐만 아니라 생성, 삭제, 이동 등을 실행 취소할 수 있습니다. 가장 중요한 작업에는 확인이 필요합니다.

테스트 만들기

어설션 노드는 테스트 생성을 담당합니다. 주요 기능 중 하나는 내장 편집기를 사용하여 프로그래밍 없이 테스트를 생성하는 기능입니다.

어설션 노드는 어설션 집합으로 구성됩니다. 각 어설션에는 고유한 유형이 있습니다. 현재 여러 유형의 어설션이 있습니다.

1. 값 비교 - 단순히 2개의 값을 비교합니다. 비교 연산자에는 같음, 같지 않음, 보다 큼, 크거나 같음, 작음, 작거나 같음 등 여러 가지 비교 연산자가 있습니다.

2. 값 포함 - 문자열에서 하위 문자열의 발생을 확인합니다.

3. XPath - XML의 선택기에 특정 값이 포함되어 있는지 확인합니다.

4. JavaScript 어설션은 성공 시 true를 반환하고 실패 시 false를 반환하는 임의의 javascript 스크립트입니다.

마지막 하나만 사용자의 프로그래밍 기술이 필요하고 나머지 3개의 어설션은 그래픽 인터페이스를 사용하여 생성됩니다. 예를 들어, 비교 값 어설션을 생성하기 위한 대화 상자는 다음과 같습니다.

가장 좋은 점은 응답에서 단언문을 빠르게 생성하는 것입니다. 한번 살펴보세요!

그러나 이러한 주장에는 분명한 한계가 있으며 이를 극복하기 위해 자바스크립트 주장을 사용할 수 있습니다. 또한 TestMace는 자동 완성, 구문 강조 및 정적 분석기를 갖춘 편안한 환경도 제공합니다.

API 설명

TestMace를 사용하면 API를 사용할 수 있을 뿐만 아니라 API를 문서화할 수도 있습니다. 게다가 설명 자체도 계층 구조를 갖고 있어 프로젝트의 나머지 부분에 유기적으로 들어맞습니다. 또한 현재 Swagger 2.0/OpenAPI 3.0 형식에서 API 설명을 가져올 수 있습니다. 설명 자체는 단지 중요하지 않으며 프로젝트의 나머지 부분과 긴밀하게 통합되어 있습니다. 특히 URL, HTTP 헤더, 쿼리 매개변수 등의 자동 완성이 가능하며 앞으로 테스트를 추가할 계획입니다. API 설명에 대한 응답 준수를 위해.

공유 노드

사례: 문제가 있는 요청이나 전체 스크립트를 동료와 공유하거나 단순히 버그에 첨부하고 싶습니다. TestMace는 이 경우도 다룹니다. 애플리케이션을 사용하면 URL의 모든 노드와 하위 트리까지 직렬화할 수 있습니다. 복사하여 붙여넣으면 요청을 다른 기계나 프로젝트로 쉽게 전송할 수 있습니다.

사람이 읽을 수 있는 프로젝트 저장 형식

현재 각 노드는 yml 확장자를 가진 별도의 파일(어설션 노드의 경우처럼)에 저장되거나 노드 이름과 index.yml 파일이 포함된 폴더에 저장됩니다.
예를 들어 위 리뷰에서 작성한 요청 파일은 다음과 같습니다.

index.yml

children: []
variables: {}
type: RequestStep
assignVariables: []
requestData:
  request:
    method: GET
    url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
  headers: []
  disabledInheritedHeaders: []
  params: []
  body:
    type: Json
    jsonBody: ''
    xmlBody: ''
    textBody: ''
    formData: []
    file: ''
    formURLEncoded: []
  strictSSL: Inherit
authData:
  type: inherit
name: Scratch 1

보시다시피 모든 것이 매우 명확합니다. 원하는 경우 이 형식을 수동으로 쉽게 편집할 수 있습니다.

파일 시스템의 폴더 계층 구조는 프로젝트의 노드 계층 구조와 완전히 반복됩니다. 예를 들어 다음과 같은 스크립트가 있습니다.

파일 시스템을 다음 구조로 매핑합니다(폴더 계층만 표시되지만 본질은 명확함).

이렇게 하면 프로젝트 검토 프로세스가 더 쉬워집니다.

Postman에서 가져오기

위의 내용을 모두 읽은 후 일부 사용자는 새로운 제품을 사용해 보거나 (맞습니까?) 프로젝트에서 완전히 사용하고 싶어하거나 (농담이 아닙니다!) 해당 제품을 완전히 사용하고 싶어할 것입니다. 그러나 동일한 Postman에서 많은 수의 개발로 인해 마이그레이션이 중단될 수 있습니다. 이러한 경우 TestMace는 Postman에서 컬렉션 가져오기를 지원합니다. 현재는 테스트 없는 가져오기가 지원되지만 향후 지원도 배제하지 않습니다.

계획

지금까지 읽어주신 많은 분들이 저희 제품을 좋아하셨기를 바랍니다. 그러나 그것이 전부는 아닙니다! 제품 작업이 한창 진행 중이며 곧 추가할 예정인 몇 가지 기능이 있습니다.

클라우드 동기화

가장 많이 요청된 기능 중 하나입니다. 현재 우리는 동기화를 위해 버전 제어 시스템을 사용할 것을 제안하고 있으며, 이를 위해 이러한 유형의 저장소에 더 친숙한 형식을 만들고 있습니다. 하지만 이 작업 흐름은 모든 사람에게 적합하지 않으므로 서버를 통해 많은 사람에게 친숙한 동기화 메커니즘을 추가할 계획입니다.

CLI

위에서 언급했듯이 IDE 수준 제품은 기존 애플리케이션이나 워크플로와의 모든 종류의 통합 없이는 불가능합니다. CLI는 TestMace로 작성된 테스트를 지속적인 통합 프로세스에 통합하는 데 꼭 필요한 것입니다. CLI 작업이 본격적으로 진행되고 있으며, 초기 버전에서는 간단한 콘솔 보고서로 프로젝트가 시작됩니다. 앞으로는 JUnit 형식으로 보고서 출력을 추가할 계획입니다.

플러그인 시스템

우리 도구의 모든 기능에도 불구하고 솔루션이 필요한 사례는 무한합니다. 결국 특정 프로젝트와 관련된 작업이 있습니다. 그렇기 때문에 앞으로 우리는 플러그인 개발을 위한 SDK를 추가할 계획이며 각 개발자는 원하는 대로 기능을 추가할 수 있을 것입니다.

노드 유형의 범위 확장

이 노드 세트는 사용자가 요구하는 모든 경우를 다루지는 않습니다. 추가 예정인 노드:

• 스크립트 노드 - js 및 해당 API를 사용하여 데이터를 변환하고 배치합니다. 이 유형의 노드를 사용하면 Postman에서 사전 요청 및 사후 요청 스크립트와 같은 작업을 수행할 수 있습니다.
• GraphQL 노드 - graphql 지원
• 사용자 정의 어설션 노드 - 프로젝트의 기존 어설션 세트를 확장할 수 있습니다.
  당연히 이것은 최종 목록이 아니며 무엇보다도 귀하의 피드백을 통해 지속적으로 업데이트될 것입니다.

자주하는 질문

당신은 포스트맨과 어떻게 다른가요?

1. 프로젝트의 기능을 거의 끝없이 확장할 수 있는 노드 개념
2. 사람이 읽을 수 있는 프로젝트 형식으로 파일 시스템에 저장하여 버전 관리 시스템을 사용하여 작업을 단순화합니다.
3. 프로그래밍 없이 테스트를 생성하는 기능 및 테스트 편집기에서 고급 js 지원(자동 완성, 정적 분석기)
4. 고급 자동 완성 및 변수의 현재 값 강조 표시

오픈소스 제품인가요?

아니요, 현재는 소스가 폐쇄되어 있지만 향후 소스 공개 가능성을 고려하고 있습니다.

당신은 무엇으로 살아요?)

무료 버전과 함께 유료 버전도 출시할 예정입니다. 여기에는 주로 동기화와 같이 서버측이 필요한 사항이 포함됩니다.

결론

우리 프로젝트는 안정적인 릴리스를 향해 비약적으로 움직이고 있습니다. 하지만 해당 제품은 이미 사용이 가능하며, 초기 사용자들의 긍정적인 피드백이 이를 증명합니다. 커뮤니티와의 긴밀한 협력 없이는 좋은 도구를 만드는 것이 불가능하기 때문에 우리는 피드백을 적극적으로 수집합니다. 여기에서 우리를 찾을 수 있습니다:

공식 웹 사이트

텔레그램

느슨하게

페이스북

이슈 트래커

여러분의 희망과 제안을 기다리겠습니다!

출처 : habr.com