PitestComputer.java

/*
 * Sonar Pitest Plugin
 * Copyright (C) 2009-2018 Vinod Anandan
 * vinod@owasp.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.pitest;

import java.util.stream.Stream;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.ce.ComputeEngineSide;
import org.sonar.api.ce.measure.Measure;
import org.sonar.api.ce.measure.MeasureComputer;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;

/**
 * MeasureComputer that processes the aggregated quantitative metric for a component from all the quantitative metrics
 * of its children.
 */
@ComputeEngineSide
@ExtensionPoint
public class PitestComputer implements MeasureComputer {

  private static final Logger log = Loggers.get(PitestComputer.class);

  private static final String[] measureKeys = {PitestMetrics.MUTATIONS_NOT_COVERED_KEY,
    PitestMetrics.MUTATIONS_GENERATED_KEY,
    PitestMetrics.MUTATIONS_KILLED_KEY,
    PitestMetrics.MUTATIONS_SURVIVED_KEY,
    PitestMetrics.MUTATIONS_ERROR_KEY,
    PitestMetrics.MUTATIONS_UNKNOWN_KEY
  };
  
  private static final String[] derivedKeys = {PitestMetrics.MUTATIONS_DATA_KEY,
    PitestMetrics.MUTATIONS_KILLED_PERCENT_KEY};

  @Override
  public MeasureComputerDefinition define(final MeasureComputerDefinitionContext defContext) {
    return defContext.newDefinitionBuilder()
      .setOutputMetrics(Stream.of(measureKeys, derivedKeys).flatMap(Stream::of).toArray(String[]::new))
      .build();
  }

  @Override
  public void compute(final MeasureComputerContext context) {
    for (String metricKey : measureKeys) {
      if (context.getMeasure(metricKey) == null) {
        computeChildrenMeasurements(context, metricKey);
      }
    }
    computeDerived(context) ;
  }

  private void computeChildrenMeasurements(final MeasureComputerContext context, String key) {
    if (context.getMeasure(key) == null) {
      int sum = 0;
      for (Measure m : context.getChildrenMeasures(key)) {
        try {
          sum += m.getIntValue();
        } catch (IllegalStateException e) {
          log.error("Failed to compute value for {}.", key, e);
        }
      }
      context.addMeasure(key, sum);
    }

  }
  private void computeDerived(final MeasureComputerContext context) {
    final Measure mutationsTotal = context.getMeasure(PitestMetrics.MUTATIONS_GENERATED_KEY);
    if (mutationsTotal != null) {
      final Integer elements = mutationsTotal.getIntValue();
      final Measure killed = context.getMeasure(PitestMetrics.MUTATIONS_KILLED_KEY);
      if (elements > 0 && killed != null) {
        final Integer coveredElements = killed.getIntValue();
        final Double coverage = 100.0 * coveredElements / elements;
        context.addMeasure(PitestMetrics.MUTATIONS_KILLED_PERCENT_KEY, coverage);
      }
    }
  }
}