src/tuningfork/tools/validation/src/test/java/com/google/tuningfork/validation/ValidationUtilTest.java

/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * 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.google.tuningfork.validation;

import static com.google.common.truth.Truth.assertThat;

import com.google.protobuf.ByteString;
import com.google.protobuf.Descriptors.Descriptor;
import com.google.testing.testsize.MediumTest;
import com.google.tuningfork.Tuningfork.Settings;
import com.google.tuningfork.Tuningfork.Settings.AggregationStrategy;
import com.google.tuningfork.Tuningfork.Settings.Histogram;
import java.io.File;
import java.util.Arrays;
import java.util.Optional;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
@MediumTest
public final class ValidationUtilTest {

  @Rule
  // Override default behavior to allow overwriting files.
  public TemporaryFolder tempFolder =
      new TemporaryFolder() {
        @Override
        public File newFile(String filename) {
          return new File(getRoot(), filename);
        }
      };

  private final ProtoCompilerHelper helper = new ProtoCompilerHelper(tempFolder);

  final String tuningforkPath = "assets/tuningfork";

  private final ErrorCollector errors = new ParserErrorCollector();

  @Test
  public void settingsValid() throws Exception {
    AggregationStrategy aggregation =
        AggregationStrategy.newBuilder()
            .addAllAnnotationEnumSize(Arrays.asList(5, 10))
            .setMaxInstrumentationKeys(100)
            .build();
    Settings settings =
        Settings.newBuilder()
            .setAggregationStrategy(aggregation)
            .addHistograms(Histogram.getDefaultInstance())
            .build();

    Optional<Settings> parsedSettings =
        ValidationUtil.validateSettings(Arrays.asList(5, 10), settings.toString(), errors);

    assertThat(errors.getErrorCount()).isEqualTo(0);
    assertThat(parsedSettings.get()).isEqualTo(settings);
  }

  @Test
  public void settingsHistogramsValid() throws Exception {
    Settings settings = Settings.newBuilder().addHistograms(Histogram.getDefaultInstance()).build();

    ValidationUtil.validateSettingsHistograms(settings, errors);
    assertThat(errors.getErrorCount()).isEqualTo(0);
  }

  @Test
  public void settingsAggregationValid() throws Exception {
    AggregationStrategy aggregation =
        AggregationStrategy.newBuilder()
            .addAllAnnotationEnumSize(Arrays.asList(5, 10))
            .setMaxInstrumentationKeys(100)
            .build();

    Settings settings = Settings.newBuilder().setAggregationStrategy(aggregation).build();

    ValidationUtil.validateSettingsAggregation(settings, Arrays.asList(5, 10), errors);
    assertThat(errors.getErrorCount()).isEqualTo(0);
  }

  @Test
  public void settingsAggregationIncorrectCount() throws Exception {
    AggregationStrategy aggregation =
        AggregationStrategy.newBuilder()
            .addAllAnnotationEnumSize(Arrays.asList(5, 10))
            .setMaxInstrumentationKeys(100)
            .build();

    Settings settings = Settings.newBuilder().setAggregationStrategy(aggregation).build();

    ValidationUtil.validateSettingsAggregation(settings, Arrays.asList(5, 10, 20), errors);
    assertThat(errors.getErrorCount(ErrorType.AGGREGATION_ANNOTATIONS)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void settingsAggregationWrongInstrumentationKey() throws Exception {
    AggregationStrategy aggregation =
        AggregationStrategy.newBuilder()
            .addAllAnnotationEnumSize(Arrays.asList(5, 10))
            .setMaxInstrumentationKeys(99999)
            .build();

    Settings settings = Settings.newBuilder().setAggregationStrategy(aggregation).build();
    ValidationUtil.validateSettingsAggregation(settings, Arrays.asList(5, 10), errors);
    assertThat(errors.getErrorCount(ErrorType.AGGREGATION_INSTRUMENTATION_KEY)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void settingsAggregationIncorrectSizes() throws Exception {
    AggregationStrategy aggregation =
        AggregationStrategy.newBuilder()
            .addAllAnnotationEnumSize(Arrays.asList(5, 10, 20))
            .setMaxInstrumentationKeys(100)
            .build();

    Settings settings = Settings.newBuilder().setAggregationStrategy(aggregation).build();

    ValidationUtil.validateSettingsAggregation(settings, Arrays.asList(6, 11, 21, 31), errors);
    assertThat(errors.getErrorCount(ErrorType.AGGREGATION_ANNOTATIONS)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void devFidelityParamsValid() throws Exception {
    ByteString content = TestdataHelper.readByteString("dev_tuningfork_fidelityparams_valid.bin");
    Descriptor desc =
        helper.getDescriptor(
            "fidelity_params_valid.proto",
            "Getting FidelityParams field from proto",
            "FidelityParams");

    ValidationUtil.validateDevFidelityParams(content, desc, errors);
    assertThat(errors.getErrorCount()).isEqualTo(0);
  }

  @Test
  public void devFidelityParamsInvalid() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "fidelity_params_valid.proto",
            "Getting FidelityParams field from proto",
            "FidelityParams");

    // not a valid file
    ByteString content = TestdataHelper.readByteString("annotation_complex.proto");

    ValidationUtil.validateDevFidelityParams(content, desc, errors);
    assertThat(errors.getErrorCount(ErrorType.DEV_FIDELITY_PARAMETERS_PARSING)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void fidelityParamsComplex() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "fidelity_params_complex.proto",
            "Getting FidelityParams field from proto",
            "FidelityParams");
    assertThat(desc).isNotNull();
    ValidationUtil.validateFidelityParams(desc, errors);
    assertThat(errors.getErrorCount(ErrorType.FIDELITY_PARAMS_COMPLEX)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void fidelityParamsNotScalar() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "fidelity_params_not_scalar.proto",
            "Getting FidelityParams field from proto",
            "FidelityParams");
    assertThat(desc).isNotNull();
    ValidationUtil.validateFidelityParams(desc, errors);
    assertThat(errors.getErrorCount(ErrorType.FIDELITY_PARAMS_TYPE)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void fidelityParamsValid() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "fidelity_params_valid.proto",
            "Getting FidelityParams field from proto",
            "FidelityParams");
    assertThat(desc).isNotNull();
    ValidationUtil.validateFidelityParams(desc, errors);
    assertThat(errors.getErrorCount()).isEqualTo(0);
  }

  @Test
  public void annotationComplex() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "annotation_complex.proto", "Getting Annotation field from proto", "Annotation");
    assertThat(desc).isNotNull();
    assertThat(ValidationUtil.validateAnnotationAndGetEnumSizes(desc, errors)).isEqualTo(null);
    assertThat(errors.getErrorCount(ErrorType.ANNOTATION_COMPLEX)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void annotationEmpty() throws Exception {
    assertThat(ValidationUtil.validateAnnotationAndGetEnumSizes(null, errors)).isNull();
    assertThat(errors.getErrorCount(ErrorType.ANNOTATION_EMPTY)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void annotationNotOnlyEnums() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "annotation_not_only_enums.proto", "Getting Annotation field from proto", "Annotation");
    assertThat(desc).isNotNull();
    assertThat(ValidationUtil.validateAnnotationAndGetEnumSizes(desc, errors)).isNull();
    assertThat(errors.getErrorCount(ErrorType.ANNOTATION_TYPE)).isEqualTo(1);
    assertThat(errors.getErrorCount()).isEqualTo(1);
  }

  @Test
  public void annotationValid() throws Exception {
    Descriptor desc =
        helper.getDescriptor(
            "annotation_valid.proto", "Getting Annotation field from proto", "Annotation");
    assertThat(desc).isNotNull();
    assertThat(ValidationUtil.validateAnnotationAndGetEnumSizes(desc, errors))
        .isEqualTo(Arrays.asList(2, 3, 6, 6));
    assertThat(errors.getErrorCount()).isEqualTo(0);
  }
}