io.camunda.process.test.api.CamundaSpringProcessTest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-process-test-spring Show documentation

Camunda's testing library for processes and process applications with Spring

There is a newer version: 8.7.0-alpha2

Show newest version

/*
 * Copyright © 2017 camunda services GmbH ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.camunda.process.test.api;

import io.camunda.process.test.impl.configuration.CamundaProcessTestAutoConfiguration;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.TestExecutionListeners;
import org.springframework.test.context.TestExecutionListeners.MergeMode;

/**
 * Marks a class as a process test and adds the Spring test execution listener {@link
 * CamundaProcessTestExecutionListener}. Use {@link CamundaAssert} to verify the expected result of
 * a test.
 *
 * Example usage:
 *
 * 
 * @CamundaSpringProcessTest
 * public class MyProcessTest {
 *
 *   @Autowired
 *   private ZeebeClient client;
 *
 *   @Test
 *   void shouldWork() {
 *     // given
 *     final ProcessInstanceEvent processInstance =
 *         client
 *             .newCreateInstanceCommand()
 *             .bpmnProcessId("process")
 *             .latestVersion()
 *             .send()
 *             .join();
 *
 *     // when
 *
 *     // then
 *     CamundaAssert.assertThat(processInstance)
 *         .isCompleted()
 *         .hasCompletedElements("A", "B");
 *   }
 * }
 * 
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
// this pulls in the Configuration NOT as AutoConfiguration but directly creates beans, so the
// marker is present when the normal CamundaAutoConfiguration is used by the normal
// meta-inf/services way
@Import({CamundaProcessTestAutoConfiguration.class})
// this listener hooks up into test execution
@TestExecutionListeners(
    listeners = CamundaProcessTestExecutionListener.class,
    mergeMode = MergeMode.MERGE_WITH_DEFAULTS)
public @interface CamundaSpringProcessTest {}