com.code_intelligence.jazzer.junit.Lifecycle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jazzer-junit Show documentation
JUnit 5 support for Jazzer fuzz tests
The newest version!
/*
 * Copyright 2023 Code Intelligence GmbH
 *
 * 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 com.code_intelligence.jazzer.junit;

/** Possible values for the {@link FuzzTest#lifecycle()} option. */
public enum Lifecycle {
  /**
   * Fuzz tests with this lifecycle only go through the JUnit test method lifecycle once during
   * fuzzing, i.e., per-test lifecycle methods such as {@link org.junit.jupiter.api.BeforeEach}
   * methods are executed once for each fuzz test.
   *
   * This mode is usually more efficient than {@link Lifecycle#PER_EXECUTION}, but is more likely
   * to unintentionally preserve state between fuzz test executions, which can result in
   * non-reproducible findings.
   */
  PER_TEST,

  /**
   * Fuzz tests with this lifecycle go through the JUnit test method lifecycle once for every test
   * method execution during fuzzing, i.e., per-test lifecycle methods such as {@link
   * org.junit.jupiter.api.BeforeEach} methods are executed before each individual invocation of the
   * fuzz test method and every execution uses its own test class instance.
   *
   * 
This mode is usually less efficient than {@link Lifecycle#PER_TEST}, but makes it easier to
   * write stateless fuzz tests that interoperate correctly with JUnit extensions used by test
   * frameworks.
   *
   * 
The following lifecycle methods and extensions are currently supported:
   *
   * 

   *   {@link org.junit.jupiter.api.extension.BeforeEachCallback}
   *   
{@link org.junit.jupiter.api.extension.TestInstancePostProcessor}
   *   
{@link org.junit.jupiter.api.BeforeEach}
   *   
{@link org.junit.jupiter.api.AfterEach}
   *   
{@link org.junit.jupiter.api.extension.AfterEachCallback}
   * 
   *
   * Note: Lifecycle methods for different test class instances may be invoked concurrently,
   * which can lead to issues if these methods are using global resources (e.g. file locks).
   */
  PER_EXECUTION,
}