001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.assertions;
018
019import static java.util.Arrays.*;
020import static org.apache.juneau.commons.utils.StringUtils.*;
021
022import java.io.*;
023import java.util.function.*;
024
025import org.apache.juneau.*;
026import org.apache.juneau.serializer.*;
027
028/**
029 * Used for fluent assertion calls against Java beans.
030 *
031 * <h5 class='section'>Test Methods:</h5>
032 * <p>
033 * <ul class='javatree'>
034 *    <li class='jc'>{@link FluentObjectAssertion}
035 *    <ul class='javatreec'>
036 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
037 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
038 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
039 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
040 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
041 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
042 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
043 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
044 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
046 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
047 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
048 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
049 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
052 *    </ul>
053 * </ul>
054 *
055 * <h5 class='section'>Transform Methods:</h5>
056 * <p>
057 * <ul class='javatree'>
058 *    <li class='jc'>{@link FluentBeanAssertion}
059 *    <ul class='javatreec'>
060 *       <li class='jm'>{@link FluentBeanAssertion#asPropertyMap(String...) asPropertyMap(String...)}
061 *       <li class='jm'>{@link FluentBeanAssertion#asProperty(String) asProperty(String)}
062 *       <li class='jm'>{@link FluentBeanAssertion#asProperties(String...) asProperties(String...)}
063 *    </ul>
064 *    <li class='jc'>{@link FluentObjectAssertion}
065 *    <ul class='javatreec'>
066 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
067 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
068 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
069 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
070 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
071 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
072 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
073 * </ul>
074 * </ul>
075 *
076 * <h5 class='section'>Configuration Methods:</h5>
077 * <p>
078 * <ul class='javatree'>
079 *    <li class='jc'>{@link Assertion}
080 *    <ul class='javatreec'>
081 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
082 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
083 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
084 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
085 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
086*  </ul>
087 * </ul>
088 *
089 * <h5 class='section'>See Also:</h5><ul>
090 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
091 * </ul>
092 *
093 * @param <T> The bean type.
094 * @param <R> The return type.
095 */
096public class FluentBeanAssertion<T,R> extends FluentObjectAssertion<T,R> {
097
098   /**
099    * Chained constructor.
100    *
101    * <p>
102    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
103    *
104    * @param creator
105    *    The assertion that created this assertion.
106    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
107    * @param value
108    *    The object being tested.
109    *    <br>Can be <jk>null</jk>.
110    * @param returns
111    *    The object to return after a test method is called.
112    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
113    * used on the same assertion.
114    */
115   public FluentBeanAssertion(Assertion creator, T value, R returns) {
116      super(creator, value, returns);
117   }
118
119   /**
120    * Constructor.
121    *
122    * @param value
123    *    The object being tested.
124    *    <br>Can be <jk>null</jk>.
125    * @param returns
126    *    The object to return after a test method is called.
127    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
128    * used on the same assertion.
129    */
130   public FluentBeanAssertion(T value, R returns) {
131      this(null, value, returns);
132   }
133
134   /**
135    * Extracts the specified property as an {@link FluentListAssertion}.
136    *
137    * @param names The names of the properties to extract.  Can also pass in comma-delimited lists.
138    * @return An assertion of the property values.
139    */
140   public FluentListAssertion<Object,R> asProperties(String...names) {
141      BeanMap<T> bm = toBeanMap();
142      return new FluentListAssertion<>(this, stream(names).map(bm::get).toList(), returns());
143   }
144
145   /**
146    * Extracts the specified property as an {@link FluentAnyAssertion}.
147    *
148    * @param name The property to extract.  Can also pass in comma-delimited lists.
149    * @return An assertion of the property value.
150    */
151   public FluentAnyAssertion<Object,R> asProperty(String name) {
152      return new FluentAnyAssertion<>(this, toBeanMap().get(name), returns());
153   }
154
155   /**
156    * Extracts the specified fields of this bean into a simple map of key/value pairs and returns it as
157    * a new {@link MapAssertion}.
158    *
159    * @param names The fields to extract.  Can also pass in comma-delimited lists.
160    * @return This object.
161    */
162   public FluentMapAssertion<String,Object,R> asPropertyMap(String...names) {
163      return new FluentMapAssertion<>(this, toBeanMap().getProperties(splita(names, ',')), returns());
164   }
165
166   @Override /* Overridden from FluentObjectAssertion */
167   public FluentBeanAssertion<T,R> asTransformed(Function<T,T> function) { // NOSONAR - Intentional.
168      return new FluentBeanAssertion<>(this, function.apply(orElse(null)), returns());
169   }
170
171   @Override /* Overridden from Assertion */
172   public FluentBeanAssertion<T,R> setMsg(String msg, Object...args) {
173      super.setMsg(msg, args);
174      return this;
175   }
176
177   @Override /* Overridden from Assertion */
178   public FluentBeanAssertion<T,R> setOut(PrintStream value) {
179      super.setOut(value);
180      return this;
181   }
182
183   @Override /* Overridden from Assertion */
184   public FluentBeanAssertion<T,R> setSilent() {
185      super.setSilent();
186      return this;
187   }
188
189   @Override /* Overridden from Assertion */
190   public FluentBeanAssertion<T,R> setStdOut() {
191      super.setStdOut();
192      return this;
193   }
194
195   @Override /* Overridden from Assertion */
196   public FluentBeanAssertion<T,R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
197      super.setThrowable(value);
198      return this;
199   }
200
201   private BeanMap<T> toBeanMap() {
202      return BeanMap.of(value());
203   }
204}