다음을 통해 공유


Visual Studio Code를 사용하여 Azure Logic Apps의 표준 워크플로 정의에서 단위 테스트 만들기

적용 대상: Azure Logic Apps(표준)

단위 테스트는 소프트웨어 개발 수명 주기 내내 앱 또는 솔루션을 안정적이고 정확하게 유지하는 필수 사례입니다. 단위 테스트를 사용하면 솔루션의 주요 구성 요소를 효율적이고 체계적으로 검증할 수 있습니다.

표준 논리 앱 워크플로의 경우 Visual Studio Code 및 Azure Logic Apps(표준) 확장을 사용하여 단위 테스트를 만들 수 있습니다. 이 기능을 사용하면 워크플로 정의를 사용하여 단위 테스트를 만들고 외부 서비스, 시스템 또는 API에 연결할 필요 없이 논리 앱 솔루션에서 지원하는 시나리오에 맞게 조정할 수 있습니다. 이 방법을 사용하면 외부 서비스, 시스템 또는 API와 상호 작용하지 않고도 워크플로를 테스트할 수 있으며 다음과 같은 이점을 제공합니다.

  • 다른 환경에 배포하기 전에 잠재적인 문제를 식별하고 해결하여 워크플로 품질을 개선합니다.

  • 일관되고 정확한 워크플로 동작을 보장하면서 개발 프로세스와의 단위 테스트 통합을 간소화합니다.

이 가이드에서는 워크플로에서 단위 테스트 정의를 만드는 방법을 보여줍니다. 이 정의는 워크플로 논리를 변경하지 않고 각 워크플로 작업의 외부 호출을 모의합니다. 워크플로에 대한 단위 테스트를 만들면 다음 폴더가 포함된 단위 테스트 프로젝트가 생성됩니다.

  • 워크플로의 각 모의 작업에 대해 강력한 형식의 클래스가 포함된 폴더입니다.

  • 각 단위 테스트 정의에 대한 폴더입니다. 이 폴더에는 샘플 클래스 및 메서드가 포함된 C# 파일이 포함되어 있습니다. 이 클래스와 메서드를 사용하여 사용자 고유의 어설션을 설정하고, 워크플로가 예상대로 작동하는지 확인하고, 더 큰 Azure 에코시스템에서 워크플로가 안정적이고 예측 가능하게 동작하는지 확인합니다.

필수 조건

제한 사항 및 알려진 문제

  • 이 릴리스는 현재 단위 테스트를 만들기 위한 C#만 지원합니다.

  • 이 릴리스는 모의 작업이 아닌 작업을 지원하지 않습니다. 워크플로 실행 경로의 모든 작업이 모의 작업인지 확인합니다.

  • 이 릴리스는 다음 작업 유형을 지원하지 않습니다.

    • 통합 계정 작업
    • EDI 인코딩 및 디코딩 작업

기본 개념 검토

다음 목록에는 표준 워크플로에 대한 단위 테스트에 대한 기본적이지만 중요한 개념이 포함되어 있습니다.

  • 논리 앱 단위 테스트

    모의 개체를 삽입하는 제어된 워크플로 실행입니다. 이러한 개체는 외부 서비스 또는 시스템에 종속된 워크플로 트리거 또는 작업을 나타냅니다.

  • 모의 액션

    외부 서비스 또는 시스템에 종속된 워크플로 작업입니다. 단위 테스트 만들기 및 실행을 위해 이러한 작업을 모의 작업으로 변환할 수 있습니다.

워크플로 정의에서 단위 테스트 만들기

  1. Visual Studio Code에서 표준 논리 앱 프로젝트를 엽니다.

  2. 프로젝트에서 워크플로 정의 폴더를 확장합니다.

  3. workflow.json 파일의 바로 가기 메뉴에서 디자이너 열기를 선택합니다.

  4. 디자이너 도구 모음에서 단위 테스트 만들기를 선택합니다.

    스크린샷은 Visual Studio Code, 표준 논리 앱 프로젝트, 워크플로 디자이너 및 단위 테스트를 생성하기 위해 선택한 명령을 보여 줍니다.

  5. 단위 테스트, 단위 테스트 클래스 및 C# 파일에 사용할 이름을 제공합니다.

    이제 테스트 라는 새 폴더가 프로젝트 작업 영역에 나타납니다. 이 폴더의 구조는 다음과 같습니다.

    스크린샷은 단위 테스트 폴더 및 파일이 있는 Visual Studio Code, 표준 논리 앱 프로젝트 및 테스트 폴더를 보여줍니다.

    폴더 또는 파일 설명
    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>.cs
    폴더 <workflow-name> 안의 폴더 <unit-test-name>에는 파일 <unit-test-name>.cs이 있습니다. 샘플 C# 클래스 및 메서드가 포함된 이 파일을 사용하여 결과를 실행하고 어설션합니다. 특정 테스트 시나리오와 일치하도록 이 파일을 편집할 수 있습니다.

유닛 테스트 *.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 trigger data.
    var triggerMockOutput = new WhenMessagesAreAvailableInAQueuePeeklockTriggerOutput();
    // Sample that shows how to set the properties for triggerMockOutput
    // triggerMockOutput.Body.Id = "SampleId";
    var triggerMock = new WhenMessagesAreAvailableInAQueuePeeklockTriggerMock(outputs: triggerMockOutput);

    // Generate mock action data.
    var actionMockOutput = new CallExternalAPIActionOutput();
    // Sample that shows how to set the properties for actionMockOutput
    // actionMockOutput.Body.Name = "SampleResource";
    // actionMockOutput.Body.Id = "SampleId";
    var actionMock = new CallExternalAPIActionMock(name: "Call_External_API", outputs: actionMockOutput);

    // ACT: Create the UnitTestExecutor instance. Run the workflow with mock data.
    var testMock = new TestMockDefinition(
        triggerMock: triggerMock,
        actionMocks: new Dictionary<string, ActionMock>()
        {
            {actionMock.Name, actionMock}
        });
    var testRun = await this.TestExecutor
        .Create()
        .RunWorkflowAsync(testMock: testMock).ConfigureAwait(continueOnCapturedContext: false);

    // ASSERT: Confirm successful workflow execution and that the status is 'Succeeded'.
    Assert.IsNotNull(value: testRun);
    Assert.AreEqual(expected: TestWorkflowStatus.Succeeded, actual: te
    stRun.Status);
}

동적 모의 데이터 테스트

다음 메서드는 콜백 메서드와 함께 동적 모의 데이터를 사용하는 방법을 보여 줍니다. 이 방법은 모의 데이터를 동적으로 생성하는 두 가지 옵션을 제공합니다.

두 방법 모두 단위 테스트 실행 컨텍스트를 기반으로 동적 응답을 만들 수 있습니다.

[TestMethod]
public async Task <workflow-name>_<unit-test-name>_ExecuteWorkflow_SUCCESS_Sample2()
{
    // PREPARE: Generate mock trigger data.
    var triggerMockOutput = new WhenMessagesAreAvailableInAQueuePeeklockTriggerOutput();
    // Sample that shows how to set triggerMockOutput properties.
    // triggerMockOutput.Body.Flag = true;
    var triggerMock = new WhenMessagesAreAvailableInAQueuePeeklockTriggerMock(outputs: triggerMockOutput);

    // PREPARE: Generate mock action data.
    // OPTION 1: Define a callback class.
    var actionMock = new CallExternalAPIActionMock(name: "Call_External_API", onGetActionMock: CallExternalAPIActionMockOutputCallback);

    // OPTION 2: Define inline with a lambda function.
    /*var actionMock = 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 the UnitTestExecutor instance. Run the workflow with mock data.
    var testMock = new TestMockDefinition(
        triggerMock: triggerMock,
        actionMocks: new Dictionary<string, ActionMock>()
        {
            {actionMock.Name, actionMock}
        });
    var testRun = await this.TestExecutor
        .Create()
        .RunWorkflowAsync(testMock: testMock).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);
}

도우미 메서드

다음 섹션에서는 샘플 테스트 메서드에서 사용하는 메서드에 대해 설명합니다. 도우미 메서드는 클래스 정의의 테스트 메서드 아래에 표시됩니다.

콜백 메서드

다음 메서드는 모의 데이터를 동적으로 생성합니다. 메서드 이름은 정적 또는 동적 모의 데이터에 대한 테스트 메서드의 모의 작업 이름에 따라 달라집니다. 이 메서드를 편집하여 테스트 시나리오 요구 사항에 따라 다른 모의 응답을 반환하거나 템플릿으로 사용하여 고유한 동적 콜백 메서드를 만들 수 있습니다.

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()

        }
    );
}