com.carrotsearch.randomizedtesting.rules.SystemPropertiesInvariantRule Maven / Gradle / Ivy

Go to download
package com.carrotsearch.randomizedtesting.rules;

import java.util.*;

import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.MultipleFailureException;
import org.junit.runners.model.Statement;

/**
 * A {@link TestRule} that ensures system properties remain unmodified by the nested
 * {@link Statement}. This can be applied both at suite level and at test level.
 * 
 * This rule requires appropriate security permission to read and write 
 * system properties ({@link System#getProperties()}) if running under a security
 * manager.  
 * 
 * @see SystemPropertiesRestoreRule
 * @see ClassRule
 * @see Rule
 */
public class SystemPropertiesInvariantRule implements TestRule {
  /**
   * Ignored property keys.
   */
  private final HashSet ignoredProperties;

  /**
   * Cares about all properties. 
   */
  public SystemPropertiesInvariantRule() {
    this(Collections.emptySet());
  }

  /**
   * Don't care about the given set of properties. 
   */
  public SystemPropertiesInvariantRule(String... ignoredProperties) {
    this.ignoredProperties = new HashSet(Arrays.asList(ignoredProperties));
  }

  /**
   * Don't care about the given set of properties. 
   */
  public SystemPropertiesInvariantRule(Set ignoredProperties) {
    this.ignoredProperties = new HashSet(ignoredProperties);
  }

  @Override
  public Statement apply(final Statement s, Description d) {
    return new Statement() {
      @Override
      public void evaluate() throws Throwable {
        TreeMap before = SystemPropertiesRestoreRule.systemPropertiesAsMap();
        ArrayList errors = new ArrayList();
        try {
          s.evaluate();
        } catch (Throwable t) {
          errors.add(t);
        } finally {
          final TreeMap after = SystemPropertiesRestoreRule.systemPropertiesAsMap();

          // Remove ignored if they exist.
          before.keySet().removeAll(ignoredProperties);
          after.keySet().removeAll(ignoredProperties);

          if (!after.equals(before)) {
            errors.add(
                new AssertionError("System properties invariant violated.\n" + 
                    collectErrorMessage(before, after)));
          }

          // Restore original properties.
          SystemPropertiesRestoreRule.restore(before, after, ignoredProperties);
        }

        MultipleFailureException.assertEmpty(errors);
      }

      private StringBuilder collectErrorMessage(
          TreeMap before, TreeMap after) {
        TreeSet newKeys = new TreeSet(after.keySet());
        newKeys.removeAll(before.keySet());
        
        TreeSet missingKeys = new TreeSet(before.keySet());
        missingKeys.removeAll(after.keySet());
        
        TreeSet differentKeyValues = new TreeSet(before.keySet());
        differentKeyValues.retainAll(after.keySet());
        for (Iterator i = differentKeyValues.iterator(); i.hasNext();) {
          String key = i.next();
          String valueBefore = before.get(key);
          String valueAfter = after.get(key);
          if ((valueBefore == null && valueAfter == null) ||
              (valueBefore.equals(valueAfter))) {
            i.remove();
          }
        }

        final StringBuilder b = new StringBuilder();
        if (!missingKeys.isEmpty()) {
          b.append("Missing keys:\n");
          for (String key : missingKeys) {
            b.append("  ").append(key)
              .append("=")
              .append(before.get(key))            
              .append("\n");
          }
        }
        if (!newKeys.isEmpty()) {
          b.append("New keys:\n");
          for (String key : newKeys) {
            b.append("  ").append(key)
              .append("=")
              .append(after.get(key))
              .append("\n");
          }
        }
        if (!differentKeyValues.isEmpty()) {
          b.append("Different values:\n");
          for (String key : differentKeyValues) {
            b.append("  [old]").append(key)
              .append("=")
              .append(before.get(key)).append("\n");
            b.append("  [new]").append(key)
              .append("=")
              .append(after.get(key)).append("\n");
          }
        }
        return b;
      }
    };
  }
}