/*
 * 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 androidx.test.services.events.run;

import static androidx.test.internal.util.Checks.checkNotNull;

import android.os.Parcel;
import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.test.services.events.FailureInfo;
import androidx.test.services.events.TestCaseInfo;

/**
 * Denotes that the test ended with a TEST_FAILURE. It has the {@link FailureInfo} object to denote
 * what was the cause of the failure/error.
 *
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class TestFailureEvent extends TestRunEventWithTestCase {
  @NonNull public final FailureInfo failure;

  /**
   * Constructor to create {@link TestFailureEvent}.
   *
   * @param testCase the test case that this event is for.
   * @param failure the failure associated with the test case.
   */
  public TestFailureEvent(@NonNull TestCaseInfo testCase, @NonNull FailureInfo failure) {
    super(testCase);
    checkNotNull(failure, "failure cannot be null");
    this.failure = failure;
  }

  TestFailureEvent(Parcel source) {
    super(source);
    failure = new FailureInfo(source);
  }

  @Override
  EventType instanceType() {
    return EventType.TEST_FAILURE;
  }

  @Override
  public void writeToParcel(Parcel parcel, int i) {
    super.writeToParcel(parcel, 0);
    failure.writeToParcel(parcel, 0);
  }
}