content: /*
   * Copyright (C) 2014 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.espresso.assertion;
  
  import static androidx.test.espresso.matcher.ViewMatchers.assertThat;
  import static androidx.test.espresso.util.TreeIterables.breadthFirstViewTraversal;
  import static androidx.test.internal.util.Checks.checkNotNull;
  import static org.hamcrest.Matchers.is;
  
  import android.view.View;
  import androidx.annotation.VisibleForTesting;
  import androidx.test.espresso.NoMatchingViewException;
  import androidx.test.espresso.ViewAssertion;
  import androidx.test.espresso.remote.annotation.RemoteMsgConstructor;
  import androidx.test.espresso.remote.annotation.RemoteMsgField;
  import androidx.test.espresso.util.HumanReadables;
  import androidx.test.espresso.util.IterablesKt;
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Locale;
  import junit.framework.AssertionFailedError;
  import org.hamcrest.Matcher;
  import org.hamcrest.StringDescription;
  
  /** Collection of common {@link ViewAssertion ViewAssertions}. */
  public final class ViewAssertions {
  
    private static final String TAG = ViewAssertions.class.getSimpleName();
  
    private ViewAssertions() {}
  
    /**
     * Returns an assert that ensures the view matcher does not find any matching view in the
     * hierarchy.
     */
    public static ViewAssertion doesNotExist() {
      return new DoesNotExistViewAssertion();
    }
  
    /**
     * Returns a generic {@link ViewAssertion} that asserts that a view exists in the view hierarchy
     * and is matched by the given view matcher.
     */
    public static ViewAssertion matches(final Matcher<? super View> viewMatcher) {
      return new MatchesViewAssertion(checkNotNull(viewMatcher));
    }
  
    /**
     * Returns a generic {@link ViewAssertion} that asserts that the descendant views selected by the
     * selector match the specified matcher.
     *
     * <p>Example: {@code
     * onView(rootView).check(selectedDescendantsMatch(not(isAssignableFrom(TextView.class)),
     * hasContentDescription()))};
     */
    public static ViewAssertion selectedDescendantsMatch(
        final Matcher<View> selector, final Matcher<View> matcher) {
      return new SelectedDescendantsMatchViewAssertion(selector, matcher);
    }
  
    @VisibleForTesting
    static class MatchesViewAssertion implements ViewAssertion {
      @VisibleForTesting
      @RemoteMsgField(order = 0)
      final Matcher<? super View> viewMatcher;
  
      @RemoteMsgConstructor
      private MatchesViewAssertion(final Matcher<? super View> viewMatcher) {
        this.viewMatcher = viewMatcher;
      }
  
      @Override
      public void check(View view, NoMatchingViewException noViewException) {
        if (noViewException != null) {
          throw noViewException;
        }
  
        StringDescription description = new StringDescription();
        description.appendText("'");
        viewMatcher.describeTo(description);
        description.appendText("' doesn't match the selected view.");
        assertThat(description.toString(), view, viewMatcher);
      }
  
      @Override
      public String toString() {
        return String.format(Locale.ROOT, "MatchesViewAssertion{viewMatcher=%s}", viewMatcher);
      }
    }
  
    @VisibleForTesting
    static class DoesNotExistViewAssertion implements ViewAssertion {
      @RemoteMsgConstructor
      private DoesNotExistViewAssertion() {}
  
      @Override
      public void check(View view, NoMatchingViewException noView) {
        if (view != null) {
          assertThat(
              "View is present in the hierarchy: " + HumanReadables.describe(view), true, is(false));
        }
      }
    }
  
    @VisibleForTesting
    static class SelectedDescendantsMatchViewAssertion implements ViewAssertion {
      @RemoteMsgField(order = 0)
      private final Matcher<View> selector;
  
      @RemoteMsgField(order = 1)
      private final Matcher<View> matcher;
  
      @RemoteMsgConstructor
      private SelectedDescendantsMatchViewAssertion(
          final Matcher<View> selector, final Matcher<View> matcher) {
        this.selector = selector;
        this.matcher = matcher;
      }
  
      @Override
      public void check(View view, NoMatchingViewException noViewException) {
        checkNotNull(view);
  
        Iterator<View> selectedViewIterator =
            IterablesKt.filter(breadthFirstViewTraversal(view), selector).iterator();
  
        List<View> nonMatchingViews = new ArrayList<>();
        while (selectedViewIterator.hasNext()) {
          View selectedView = selectedViewIterator.next();
  
          if (!matcher.matches(selectedView)) {
            nonMatchingViews.add(selectedView);
          }
        }
  
        if (nonMatchingViews.size() > 0) {
          String errorMessage =
              HumanReadables.getViewHierarchyErrorMessage(
                  view,
                  nonMatchingViews,
                  String.format(
                      Locale.ROOT,
                      "At least one view did not match the required matcher: %s",
                      matcher),
                  "****DOES NOT MATCH****");
          throw new AssertionFailedError(errorMessage);
        }
      }
  
      @Override
      public String toString() {
        return String.format(
            Locale.ROOT,
            "SelectedDescendantsMatchViewAssertion{selector=%s, matcher=%s}",
            selector,
            matcher);
      }
    }
  }
  