com.github.aoreshin.junit5.extensions.allure.AllureEncodeStepNamesExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of allure-junit5-extensions Show documentation

Project to ease pain of test automation

There is a newer version: 83

Show newest version

package com.github.aoreshin.junit5.extensions.allure;

import static java.util.stream.Collectors.toList;

import io.qameta.allure.Allure;
import io.qameta.allure.AllureLifecycle;
import io.qameta.allure.model.StepResult;
import java.util.List;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;

/**
 * Extension that is used to erase all sensitive information (passwords, tokens, etc) from Allure's
 * test step names
 *
 * Can be used in two flavours:
 *
 * 

 *   @ExtendWith(AllureEncodeStepNamesExtension.class) then you must specify
 *       allureEncodeStepNamesRegex property in order to make it work properly
 *   
Use com.github.aoreshin.junit5.extensions.TestTemplateInvocationContextBuilder addExtension
 *       method and pass regex through constructor.
 * 
 */
public class AllureEncodeStepNamesExtension implements AfterEachCallback {
  private final String regex;

  public AllureEncodeStepNamesExtension() {
    this.regex = System.getProperty("allureEncodeStepNamesRegex");
  }

  public AllureEncodeStepNamesExtension(String regex) {
    this.regex = regex;
  }

  @Override
  public void afterEach(ExtensionContext context) {
    lifecycle()
        .updateTestCase(
            update -> {
              List processed = processStepResult(update.getSteps());
              update.setSteps(processed);
            });
  }

  List processStepResult(List stepResults) {
    if (stepResults.size() != 0) {
      return stepResults.stream()
          .peek(
              stepResult -> {
                String name = stepResult.getName();

                name = name.replaceAll(regex, "*****");

                stepResult.setName(name);

                stepResult.setSteps(processStepResult(stepResult.getSteps()));
              })
          .collect(toList());
    }

    return List.of();
  }

  /** Only for testing */
  String getRegex() {
    return regex;
  }

  private AllureLifecycle lifecycle() {
    return Allure.getLifecycle();
  }
}