적용 대상: Azure Logic Apps(표준)
단위 테스트는 소프트웨어 개발 수명 주기 내내 앱 또는 솔루션을 안정적이고 정확하게 유지하는 필수 사례입니다. 단위 테스트를 사용하면 솔루션의 주요 구성 요소를 효율적이고 체계적으로 검증할 수 있습니다.
표준 논리 앱 워크플로의 경우 Visual Studio Code 및 Azure Logic Apps(표준) 확장을 사용하여 단위 테스트를 만들 수 있습니다. 이 기능을 사용하면 이전에 실행한 워크플로 실행을 사용하여 단위 테스트를 만들고 논리 앱 솔루션에서 지원하는 시나리오에 맞게 조정할 수 있습니다. 이 접근 방식에는 다음과 같은 이점이 있습니다.
워크플로 실행을 다시 사용하여 워크플로의 특정 작업에 대한 모의 데이터를 생성합니다.
이 데이터를 사용하면 외부 서비스, 시스템 또는 API를 호출하지 않고도 워크플로를 테스트할 수 있습니다. 시간을 절약하고 워크플로가 실제 워크플로 실행 시나리오에 맞게 유지됩니다.
다른 환경에 배포하기 전에 잠재적인 문제를 식별하고 해결하여 워크플로 품질을 개선합니다.
일관되고 정확한 워크플로 동작을 보장하면서 개발 프로세스와의 단위 테스트 통합을 간소화합니다.
이 가이드에서는 워크플로 실행에서 단위 테스트 정의를 만드는 방법을 보여줍니다. 이 정의는 워크플로 논리를 변경하지 않고 각 워크플로 작업의 외부 호출을 모의합니다. 워크플로 실행에서 단위 테스트를 만들면 다음 두 개의 폴더가 포함된 단위 테스트 프로젝트가 생성됩니다.
워크플로의 각 모의 작업에 대해 강력한 형식의 클래스가 포함된 폴더입니다.
다음 파일을 포함하는 각 단위 테스트 정의에 대한 폴더입니다.
워크플로에서 생성된 모의 작업을 나타내는 JSON 파일입니다.
사용자 고유의 어설션을 설정하는 데 사용하는 샘플 클래스 및 메서드가 포함된 C# 파일은 워크플로가 예상대로 작동하는지 확인하고, 더 큰 Azure 에코시스템에서 워크플로가 안정적이고 예측 가능하게 동작하는지 확인합니다.
필수 조건
Azure 계정 및 구독 구독이 없는 경우 Azure 체험 계정에 등록합니다.
단위 테스트를 만드는 데 사용할 이전에 로컬로 실행된 워크플로를 하나 이상 포함하는 Visual Studio Code의 표준 논리 앱 프로젝트입니다.
Visual Studio Code 설정 및 프로젝트 만들기에 대한 자세한 내용은 Visual Studio Code를 사용하여 표준 논리 앱 워크플로 만들기를 참조하세요.
제한 사항 및 알려진 문제
이 릴리스는 현재 단위 테스트를 만들기 위한 C#만 지원합니다.
이 릴리스는 모의 작업이 아닌 작업을 지원하지 않습니다. 워크플로 실행 경로의 모든 작업이 모의 작업인지 확인합니다.
이 릴리스는 다음 작업 유형을 지원하지 않습니다.
- 통합 계정 작업
- 데이터 매퍼 작업
- 사용자 지정 코드 작업
- XML 작업
- 액체 조작
- EDI 인코딩 및 디코딩 작업
기본 개념 검토
다음 목록에는 표준 워크플로에 대한 단위 테스트에 대한 기본적이지만 중요한 개념이 포함되어 있습니다.
논리 앱 단위 테스트
모의 개체를 삽입하는 제어된 워크플로 실행입니다. 이러한 개체는 외부 서비스 또는 시스템에 종속된 워크플로 트리거 또는 작업을 나타냅니다.
모의 액션
외부 서비스 또는 시스템에 종속된 워크플로 작업입니다. 단위 테스트 만들기 및 실행을 위해 이러한 작업을 모의 작업으로 변환할 수 있습니다.
워크플로 실행에서 단위 테스트 만들기
Visual Studio Code에서 표준 논리 앱 프로젝트를 엽니다.
Visual Studio Code 도구 모음의 실행 메뉴에서 디버깅 시작을 선택합니다. (키보드: F5 키 누르기)
탐색기 창으로 돌아갑니다. 프로젝트에서 워크플로 정의 폴더를 확장합니다.
workflow.json 바로 가기 메뉴를 열고 개요를 선택합니다.
개요 페이지의 실행 기록에서 단위 테스트를 만드는 데 사용할 워크플로 실행을 선택합니다.
실행 기록 도구 모음에서 실행에서 단위 테스트 만들기를 선택합니다.
단위 테스트, 단위 테스트 클래스 및 C# 파일에 사용할 이름을 제공합니다.
탐색기 창에서 Tests라는 새 프로젝트 폴더가 논리 앱 프로젝트 폴더 아래에 나타납니다. Tests 폴더에는 다음 폴더와 파일이 포함됩니다.
폴더 또는 파일 설명 Tests
|| <logic-app-name>폴더 Tests의 폴더 <logic-app-name>는 논리 앱 프로젝트에 단위 테스트를 추가할 때 나타납니다.Tests
|| <logic-app-name>
||| <workflow-name>< logic-app-name> 폴더에서 워크플로에 대한 단위 테스트를 추가하면 <workflow-name> 폴더가 나타납니다.Tests
|| <logic-app-name>
||| <workflow-name>
||||MockOutputs
|||||<operation-name-outputs>.cs< workflow-name> 폴더 안의MockOutputs폴더에는 워크플로의 각 커넥터 작업에 대한 강력한 형식의 클래스가 있는 C# (.cs) 파일이 포함되어 있습니다. 각 .cs 파일 이름은 다음 형식을 사용합니다.
<operation-name>[Trigger\|Action]Output.cs
커넥터 작업에 동적 계약이 있는 경우 각 동적 형식에 대한 클래스가 나타납니다. 동적 형식은 해당 매개 변수에 대해 제공된 값에 따라 입력 및 출력이 다른 작업 매개 변수를 나타냅니다. 이러한 클래스를 사용하여 단위 테스트를 확장하고 처음부터 새 모의 항목을 만들 수 있습니다.Tests
|| <logic-app-name>
||| <workflow-name>
|||| <unit-test-name>
||||| <unit-test-name>-mock.json
||||| <unit-test-name>.cs< workflow-name> 폴더 내 <unit-test-name> 폴더에는 다음 파일들이 포함되어 있습니다.
- 파일은 <unit-test-name>-mock.json단위 테스트를 만든 워크플로 실행을 기반으로 생성된 모의 항목에 대한 JSON 표현을 포함합니다.
- 파일에는 <unit-test-name>.cs샘플 C# 클래스와 파일을 사용하여*-mock.json결과를 실행하고 어설션하는 메서드가 포함되어 있습니다. 특정 테스트 시나리오와 일치하도록 이 파일을 편집할 수 있습니다.
*-mock.json 파일 검토
이 파일에는 다음과 같은 주요 섹션이 있습니다.
triggerMocks 섹션
이 섹션에는 triggerMocks 워크플로 트리거의 모의 결과가 포함되어 있습니다. 이 섹션은 다음 예제와 같이 워크플로 실행을 시작하는 데 필요합니다.
{
"triggerMocks": {
"When_messages_are_available_in_a_queue_(peek-lock)": {
"name": "When_messages_are_available_in_a_queue_(peek-lock)",
"status": "Succeeded",
"outputs": {
"body": {
"contentData": {
"messageId": "1234",
"status": "new",
"contentType": "application/json",
"userProperties": {},
"scheduledEnqueueTimeUtc": "1/1/0001 12:00:00 AM",
"timeToLive": "14.00:00:00",
"deliveryCount": 1,
"enqueuedSequenceNumber": 0,
"enqueuedTimeUtc": "2025-04-07T01:10:09.738Z",
"lockedUntilUtc": "2025-04-07T01:11:09.769Z",
"lockToken": "78232fa8-03cf-4baf-b1db-3375a64e0ced",
"sequenceNumber": 5
}
}
}
}
},
"actionMocks": {...}
}
actionMocks 섹션
워크플로 실행 actionMocks 의 각 모의 작업에 대해 이 섹션에는 모의 작업이 포함되고 워크플로의 제어된 실행이 보장됩니다.
{
"triggerMocks": {...},
"actionMocks": {
"Call_External_API": {
"name": "Call_External_API",
"status": "Succeeded",
"outputs": {
"statusCode": 200,
"body": {
"status": "Awesome!"
}
}
},
"CompleteMessage": {
"name": "CompleteMessage",
"status": "Succeeded",
"outputs": {
"statusCode": "OK",
"body": {}
}
}
}
}
유닛 테스트 *.cs 파일을 검토
이 단위 테스트 클래스는 트리거 및 작업을 모의하여 표준 논리 앱 워크플로를 테스트하기 위한 프레임워크를 제공합니다. 이 클래스를 사용하면 실제로 외부 서비스 또는 API를 호출하지 않고 워크플로를 테스트할 수 있습니다.
테스트 클래스 구조
일반적인 단위 테스트 클래스는 다음 구조를 사용합니다.
[TestClass]
public class <unit-test-name>
{
public TestExecutor TestExecutor;
[TestInitialize]
public void Setup()
{
this.TestExecutor = new TestExecutor("<workflow-name>/testSettings.config");
}
// Add test methods here.
// Add helper methods here.
}
Setup() 메서드
이 메서드는 TestExecutor 테스트 설정 구성 파일의 경로를 사용하여 클래스를 인스턴스화합니다. 메서드는 각 테스트 실행 전에 실행되고 새 인스턴스를 TestExecutor만듭니다.
[TestInitialize]
public void Setup()
{
this.TestExecutor = new TestExecutor("<workflow-name>/testSettings.config");
}
샘플 테스트 방법
다음 섹션에서는 단위 테스트 클래스에서 사용할 수 있는 샘플 테스트 메서드에 대해 설명합니다.
정적 모의 데이터 테스트
다음 메서드는 정적 모의 데이터를 사용하여 워크플로를 테스트하는 방법을 보여 줍니다. 이 메서드에서는 다음 작업을 완료할 수 있습니다.
- 모의 작업에 속성 값을 설정합니다.
- 구성된 모의 데이터를 사용하여 워크플로를 실행합니다.
- 실행이 성공했는지 확인합니다.
[TestMethod]
public async Task <workflow-name>_<unit-test-name>_ExecuteWorkflow_SUCCESS_Sample1()
{
// PREPARE mock: Generate mock action and trigger data.
var mockData = this.GetTestMockDefinition();
var sampleActionMock = mockData.ActionMocks["Call_External_API"];
sampleActionMock.Outputs["your-property-name"] = "your-property-value";
// ACT: Create the UnitTestExecutor instance. Run the workflow with mock data.
var testRun = await this.TestExecutor
.Create()
.RunWorkflowAsync(testMock: mockData).ConfigureAwait(continueOnCapturedContext: false);
// ASSERT: Confirm successful workflow execution and that the status is 'Succeeded'.
Assert.IsNotNull(value: testRun);
Assert.AreEqual(expected: TestWorkflowStatus.Succeeded, actual: testRun.Status);
}
동적 모의 데이터 테스트
다음 메서드는 콜백 메서드와 함께 동적 모의 데이터를 사용하는 방법을 보여 줍니다. 이 방법은 모의 데이터를 동적으로 생성하는 두 가지 옵션을 제공합니다.
- 별도의 콜백 메서드를 정의합니다.
- 인라인 람다 함수를 사용합니다.
두 방법 모두 단위 테스트 실행 컨텍스트를 기반으로 동적 응답을 만들 수 있습니다.
[TestMethod]
public async Task <workflow-name>_<unit-test-name>_ExecuteWorkflow_SUCCESS_Sample2()
{
// PREPARE: Generate mock action and trigger data.
var mockData = this.GetTestMockDefinition();
// OPTION 1: Define a callback class.
mockData.ActionMocks["Call_External_API"] = new CallExternalAPIActionMock(
name: "Call_External_API",
onGetActionMock: CallExternalAPIActionMockOutputCallback);
// OPTION 2: Define an inline lambda function.
mockData.ActionMocks["Call_External_API"] = new CallExternalAPIActionMock(
name: "Call_External_API",
onGetActionMock: (testExecutionContext) =>
{
return new CallExternalAPIActionMock(
status: TestWorkflowStatus.Succeeded,
outputs: new CallExternalAPIActionOutput {
// If this account contains a JObject Body,
// set the properties you want here:
// Body = "something".ToJObject()
}
);
});
// ACT: Create UnitTestExecutor instance. Run the workflow with mock data.
var testRun = await this.TestExecutor
.Create()
.RunWorkflowAsync(testMock: mockData).ConfigureAwait(continueOnCapturedContext: false);
// ASSERT: Confirm successful workflow execution and that the status is 'Succeeded'.
Assert.IsNotNull(value: testRun);
Assert.AreEqual(expected: TestWorkflowStatus.Succeeded, actual: testRun.Status);
}
오류 시나리오 테스트
다음 메서드는 실패 조건을 테스트하는 방법을 보여 있습니다. 이 메서드에서는 다음 작업을 완료할 수 있습니다.
- 특정 오류 코드 및 메시지와 함께 실패하도록 모의 작업을 구성합니다.
- 워크플로가 이러한 오류 조건을 올바르게 처리하는지 확인합니다.
[TestMethod]
public async Task <workflow-name>_<unit-test-name>_ExecuteWorkflow_FAILED_Sample3()
{
// PREPARE: Generate mock action and trigger data.
var mockData = this.GetTestMockDefinition();
var mockError = new TestErrorInfo(code: ErrorResponseCode.BadRequest, message: "Input is invalid.");
mockData.ActionMocks["Call_External_API"] = new CallExternalAPIActionMock(
status: TestWorkflowStatus.Failed,
error: mockError);
// ACT: Create UnitTestExecutor instance. Run the workflow with mock data.
var testRun = await this.TestExecutor
.Create()
.RunWorkflowAsync(testMock: mockData).ConfigureAwait(continueOnCapturedContext: false);
// ASSERT: Confirm successful workflow execution and that the status is 'Succeeded'.
Assert.IsNotNull(value: testRun);
Assert.AreEqual(expected: TestWorkflowStatus.Failed, actual: testRun.Status);
}
도우미 메서드
다음 섹션에서는 샘플 테스트 메서드에서 사용하는 메서드에 대해 설명합니다. 도우미 메서드는 클래스 정의의 테스트 메서드 아래에 표시됩니다.
GetTestMockDefinition()
다음 메서드는 JSON 파일에서 모의 정의를 로드합니다. 모의 데이터가 다른 위치 또는 형식으로 저장된 경우 이 메서드를 편집할 수 있습니다.
private TestMockDefinition GetTestMockDefinition()
{
var mockDataPath = Path.Combine(TestExecutor.rootDirectory, "Tests", TestExecutor.logicAppName,
TestExecutor.workflow, "<unit-test-name>", "<unit-test-name>-mock.json");
return JsonConvert.DeserializeObject<TestMockDefinition>(File.ReadAllText(mockDataPath));
}
콜백 메서드
다음 메서드는 모의 데이터를 동적으로 생성합니다. 메서드 이름은 정적 또는 동적 모의 데이터에 대한 테스트 메서드의 모의 작업 이름에 따라 달라집니다. 이 메서드를 편집하여 테스트 시나리오 요구 사항에 따라 다른 모의 응답을 반환하거나 템플릿으로 사용하여 고유한 동적 콜백 메서드를 만들 수 있습니다.
public CallExternalAPIActionMock CallExternalAPIActionMockOutputCallback(TestExecutionContext context)
{
// Sample mock data: Dynamically change the mocked data for "actionName".
return new CallExternalAPIActionMock(
status: TestWorkflowStatus.Succeeded,
outputs: new CallExternalAPIActionOutput {
// If this account contains a JObject Body,
// set the properties you want here:
// Body = "something".ToJObject()
}
);
}