public interface

TestOutputHandler

 androidx.test.internal.platform.util.TestOutputHandler

Gradle dependencies

compile group: 'androidx.test', name: 'monitor', version: '1.6.0-alpha03'

  • groupId: androidx.test
  • artifactId: monitor
  • version: 1.6.0-alpha03

Artifact androidx.test:monitor:1.6.0-alpha03 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.test:monitor com.android.support.test:monitor

Overview

An extension definition for outputting debugging information to the test execution environment.

Implementations should be provided via

Summary

Methods
public booleanaddOutputProperties(java.util.Map<java.lang.String, java.io.Serializable> properties)

Add output properties for the test.

public booleancaptureWindowHierarchy(java.lang.String outputName)

Dump the window hierarchy and store it in test outputs

public voiddumpThreadStates(java.lang.String outputName)

Output the stack traces of all running threads back to the execution environment.

public booleantakeScreenshot(java.lang.String outputName)

Take a screenshot and store it in test outputs

Methods

public void dumpThreadStates(java.lang.String outputName)

Output the stack traces of all running threads back to the execution environment.

public boolean takeScreenshot(java.lang.String outputName)

Take a screenshot and store it in test outputs

public boolean captureWindowHierarchy(java.lang.String outputName)

Dump the window hierarchy and store it in test outputs

public boolean addOutputProperties(java.util.Map<java.lang.String, java.io.Serializable> properties)

Add output properties for the test.

Source

/*
 * Copyright (C) 2018 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.internal.platform.util;

import java.io.Serializable;
import java.util.Map;

/**
 * An extension definition for outputting debugging information to the test execution environment.
 *
 * <p>Implementations should be provided via {@link ServiceLoader}
 *
 * @hide
 */
public interface TestOutputHandler {

  /** Output the stack traces of all running threads back to the execution environment. */
  void dumpThreadStates(String outputName);

  /** Take a screenshot and store it in test outputs */
  boolean takeScreenshot(String outputName);

  /** Dump the window hierarchy and store it in test outputs */
  boolean captureWindowHierarchy(String outputName);

  /** Add output properties for the test. */
  boolean addOutputProperties(Map<String, Serializable> properties);
}