Import initial r3 of littlemock library.
Change-Id: Ieead9f3add2ee379a0c34daac9b857630c1bf398
diff --git a/Android.mk b/Android.mk
new file mode 100644
index 0000000..fa62e1e
--- /dev/null
+++ b/Android.mk
@@ -0,0 +1,25 @@
+# Copyright (C) 2011 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.
+
+LOCAL_PATH := $(call my-dir)
+include $(CLEAR_VARS)
+
+# Include all the java files.
+LOCAL_SRC_FILES := $(call all-java-files-under, src)
+
+# The name of the jar file to create.
+LOCAL_MODULE := littlemock-r2
+
+# Build a static jar file.
+include $(BUILD_STATIC_JAVA_LIBRARY)
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
diff --git a/CleanSpec.mk b/CleanSpec.mk
new file mode 100644
index 0000000..b84e1b6
--- /dev/null
+++ b/CleanSpec.mk
@@ -0,0 +1,49 @@
+# Copyright (C) 2007 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.
+#
+
+# If you don't need to do a full clean build but would like to touch
+# a file or delete some intermediate files, add a clean step to the end
+# of the list. These steps will only be run once, if they haven't been
+# run before.
+#
+# E.g.:
+# $(call add-clean-step, touch -c external/sqlite/sqlite3.h)
+# $(call add-clean-step, rm -rf $(PRODUCT_OUT)/obj/STATIC_LIBRARIES/libz_intermediates)
+#
+# Always use "touch -c" and "rm -f" or "rm -rf" to gracefully deal with
+# files that are missing or have been moved.
+#
+# Use $(PRODUCT_OUT) to get to the "out/target/product/blah/" directory.
+# Use $(OUT_DIR) to refer to the "out" directory.
+#
+# If you need to re-do something that's already mentioned, just copy
+# the command and add it to the bottom of the list. E.g., if a change
+# that you made last week required touching a file and a change you
+# made today requires touching the same file, just copy the old
+# touch step and add it to the end of the list.
+#
+# ************************************************
+# NEWER CLEAN STEPS MUST BE AT THE END OF THE LIST
+# ************************************************
+
+# For example:
+#$(call add-clean-step, rm -rf $(OUT_DIR)/target/common/obj/APPS/AndroidTests_intermediates)
+#$(call add-clean-step, rm -rf $(OUT_DIR)/target/common/obj/JAVA_LIBRARIES/core_intermediates)
+#$(call add-clean-step, find $(OUT_DIR) -type f -name "IGTalkSession*" -print0 | xargs -0 rm -f)
+#$(call add-clean-step, rm -rf $(PRODUCT_OUT)/data/*)
+
+# ************************************************
+# NEWER CLEAN STEPS MUST BE AT THE END OF THE LIST
+# ************************************************
diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_APACHE2
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
diff --git a/README b/README
new file mode 100644
index 0000000..fba3f30
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+This folder contains the littlemock library.
+
+The latest version of littlemock can be found at this url:
+ http://code.google.com/p/littlemock
+
+Version: r3
+License: Apache 2.0
+
+Description:
+Mocking framework. Looks very like Mockito (see http://mockito.org).
+Has a number of restrictions - mocks interfaces only, no class
+generation. Has no dependencies, consequently can be used on Android.
+
+Local Modifications:
+No modifications.
+
diff --git a/src/com/google/testing/littlemock/ArgumentCaptor.java b/src/com/google/testing/littlemock/ArgumentCaptor.java
new file mode 100644
index 0000000..99e9b55
--- /dev/null
+++ b/src/com/google/testing/littlemock/ArgumentCaptor.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+import java.util.List;
+
+/**
+ * Simple capture object for use in tests.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ *
+ * @param <T> the type we are going to capture
+ */
+public interface ArgumentCaptor<T extends Object> extends LittleMock.ArgumentMatcher {
+ /** Gets the last value captured, or null if no value has been captured. */
+ public T getValue();
+
+ /** Gets the list of all values that have been captured. */
+ public List<T> getAllValues();
+
+ /** Use this argument captor to perform the capture. */
+ public T capture();
+}
diff --git a/src/com/google/testing/littlemock/Behaviour.java b/src/com/google/testing/littlemock/Behaviour.java
new file mode 100644
index 0000000..f298285
--- /dev/null
+++ b/src/com/google/testing/littlemock/Behaviour.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+/**
+ * An action to be performed, yet to be attached to a method call.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ */
+public interface Behaviour {
+ /** Attaches the given behaviour to the next method call of this mock. */
+ public <T> T when(T mock);
+}
diff --git a/src/com/google/testing/littlemock/Captor.java b/src/com/google/testing/littlemock/Captor.java
new file mode 100644
index 0000000..4fde58b
--- /dev/null
+++ b/src/com/google/testing/littlemock/Captor.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Used to automatically inject a {@link ArgumentCaptor} object for use in your tests.
+ *
+ * <p>Just annotate your capture field on your test as follows:
+ * <pre>
+ * @Captor private ArgumentCaptor<String> mCaptureString;
+ * </pre>
+ *
+ * <p>Then when the {@link LittleMock#initMocks(Object)} method is called (which should be
+ * done in your setUp() call, or in a test base class) all your capture objects will be
+ * automatically constructed.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ */
+@Target({ ElementType.FIELD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Captor {
+}
diff --git a/src/com/google/testing/littlemock/LittleMock.java b/src/com/google/testing/littlemock/LittleMock.java
new file mode 100644
index 0000000..03e2c7a
--- /dev/null
+++ b/src/com/google/testing/littlemock/LittleMock.java
@@ -0,0 +1,881 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.lang.reflect.Proxy;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.Callable;
+
+/**
+ * Very lightweight and simple mocking framework, inspired by Mockito, http://mockito.org.
+ *
+ * <p>It has a number of limitations, including:
+ * <ul>
+ * <li>Doesn't support mocking concrete classes, <b>interfaces only</b>.</li>
+ *
+ * <li><b>Is not thread-safe.</b> You'll need to provide your own synchronization if you want to
+ * run multi-threaded unit tests.</li>
+ *
+ * <li>It supports only a <b>small subset</b> of the APIs provided by Mockito and other mocking
+ * frameworks.</li>
+ * </ul>
+ *
+ * <p>This project was designed to be lightweight and suitable for platforms that don't support
+ * dynamic class generation, for example Android.
+ *
+ * <p>Here is an example of how to use the framework.
+ *
+ * <p>Suppose that we have this interface:
+ * <pre>
+ * public interface Foo {
+ * public String aString(int input);
+ * public void doSomething();
+ * }
+ * </pre>
+ *
+ * <p>Then stubbing out mocks works as follows:
+ * <pre>
+ * Foo mockFoo = mock(Foo.class); // Create the mock.
+ * doReturn("hello").when(mockFoo).aString(anyInt()); // Stub the mock to return "hello".
+ * doThrow(new IOException("oh noes")).when(mockFoo).doSomething();
+ * assertEquals("hello", mockFoo.aString(5)); // Use the mock - performs as expected.
+ * mockFoo.doSomething(); // This will throw an IOException.
+ * </pre>
+ *
+ * <p>You can verify in the 'natural place', after the method call has happened, like this:
+ * <pre>
+ * Foo mockFoo = mock(Foo.class);
+ * assertEquals(null, mockFoo.aString(6)); // Unstubbed method calls return a sensible default.
+ * verify(mockFoo).aString(6); // This will pass, aString() was called once.
+ * verify(mockFoo, never()).doSomething(); // This will pass, doSomething was never called.
+ * verify(mockFoo, times(3)).aString(anyInt()); // This will fail, was called once only.
+ * </pre>
+ *
+ * <p>The documentation is still incomplete. You can look at the {@link LittleMockTest} class and
+ * its unit tests - since they tell you exactly what operations are supported and how to use them.
+ *
+ * <p>The reasons I much prefer Mockito's approach to the one of EasyMock are as follows:
+ * <ul>
+ * <li>No need to remember to put your mocks in replay mode.</li>
+ * <li>No need to remember to call verify, a dangerous source of false-positive tests or
+ * alternatively over-specified tests.</li>
+ * <li>Much less over-specification: only verify what you actually care about.</li>
+ * <li>Which in turn leads to better separated tests, each test verifying only a part of the
+ * desired behaviour.</li>
+ * <li>Which also leads to less fragile tests, where adding another method call on your
+ * dependencies doesn't break unrelated tests.</li>
+ * <li>More natural order for tests: set up stubs, execute tests, verify that it worked.</li>
+ * <li>More unified syntax that doesn't require special case for differences between void method
+ * calls and method calls that return a value.</li>
+ * </ul>
+ *
+ * <p>There were enough reasons that I wanted to give Mockito a try. It didn't work on Android
+ * because of issues with class generation. So I looked at the documentation and examples page and
+ * added tests for all the examples, and then implemented the this framework. I should stress that
+ * this is a clean-room implementation, and as such it's possible that there are a couple of methods
+ * that don't work in the same way as Mockito's implementation. Where that is the case I think we
+ * should fix once we discover them. There is also some functionality missing, but it will be added
+ * in due course.
+ *
+ * <p>Over time, the API has diverged slightly from the one of Mockito, as I have added APIs that I
+ * found convenient but that did not have an equivalent in Mockite itself. For anything that has an
+ * equivalent in Mockito I tried to keep the same name and syntax, to make it easier to transition
+ * between using one framework to using the other, e.g., when developing both an Android application
+ * using this framework and a desktop application using Mockito.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ */
+/*@NotThreadSafe*/
+public class LittleMock {
+ /** Generates a {@link Behaviour} suitable for void methods. */
+ public static Behaviour doNothing() { return doReturn(null); }
+
+ /** Generates a {@link Behaviour} that returns the given result. */
+ public static <T> Behaviour doReturn(final T result) {
+ return new BehaviourImpl(new Action() {
+ @Override public T doAction(Method method, Object[] args) { return result; }
+ @Override public Class<?> getReturnType() {
+ return (result == null) ? null : result.getClass();
+ }
+ });
+ }
+
+ /**
+ * Gets a {@link Behaviour} that will execute the given {@link Callable} and return its result.
+ */
+ public static <T> Behaviour doAnswer(final Callable<T> callable) {
+ return new BehaviourImpl(new Action() {
+ @Override
+ public T doAction(Method method, Object[] args) throws Throwable { return callable.call(); }
+ @Override
+ public Class<?> getReturnType() { return null; }
+ });
+ }
+
+ /** Returns a {@link Behaviour} that throws the given {@link Throwable}. */
+ public static <T extends Throwable> Behaviour doThrow(final T exception) {
+ return new BehaviourImpl(new Action() {
+ @Override
+ public Object doAction(Method method, Object[] args) throws Throwable { throw exception; }
+ @Override
+ public Class<?> getReturnType() { return null; }
+ });
+ }
+
+ /** Begins a verification step on a mock: the next method invocation on that mock will verify. */
+ public static <T> T verify(T mock, CallCount howManyTimes) {
+ if (howManyTimes == null) {
+ throw new IllegalArgumentException("Can't pass null for howManyTimes parameter");
+ }
+ checkNoMatchers();
+ getHandlerFrom(mock).mHowManyTimes = howManyTimes;
+ return mock;
+ }
+
+ /** Begins a verification step for exactly one method call. */
+ public static <T> T verify(T mock) { return verify(mock, times(1)); }
+
+ /** Assert that no method calls at all happened on these mocks. */
+ public static void verifyZeroInteractions(Object... mocks) {
+ checkNoMatchers();
+ for (Object mock : mocks) {
+ LinkedList<MethodCall> mMethodCalls = getHandlerFrom(mock).mRecordedCalls;
+ expect(mMethodCalls.isEmpty(), "Mock expected zero interactions, had " + mMethodCalls);
+ }
+ }
+
+ /** Assert that there are no unverified method calls on these mocks. */
+ public static void verifyNoMoreInteractions(Object... mocks) {
+ StackTraceElement callSite = new Exception().getStackTrace()[1];
+ for (Object mock : mocks) {
+ verifyNoMoreInteractions(mock, callSite);
+ }
+ }
+
+ /** Check that there are no unverified actions on the given mock. */
+ private static void verifyNoMoreInteractions(Object mock, StackTraceElement callSite) {
+ checkNoMatchers();
+ DefaultInvocationHandler handlerFrom = getHandlerFrom(mock);
+ List<MethodCall> unverifiedCalls = new ArrayList<MethodCall>();
+ for (MethodCall method : handlerFrom.mRecordedCalls) {
+ if (!method.mWasVerified) {
+ unverifiedCalls.add(method);
+ }
+ }
+ if (unverifiedCalls.size() > 0) {
+ StringBuffer sb = new StringBuffer();
+ sb.append("\nWe found these unverified calls:");
+ for (MethodCall method : unverifiedCalls) {
+ appendDebugStringForMethodCall(sb, method.mMethod,
+ method.mElement, handlerFrom.mFieldName, false);
+ }
+ sb.append("\n\nAfter final interaction was verified:\n");
+ sb.append(" at ").append(callSite).append("\n");
+ throw new AssertionError(sb.toString());
+ }
+ }
+
+ /** Creates a {@link CallCount} that matches exactly the given number of calls. */
+ public static CallCount times(long n) { return new CallCount(n, n); }
+
+ /** Creates a {@link CallCount} that only matches if the method was never called. */
+ public static CallCount never() { return new CallCount(0, 0); }
+
+ /** Creates a {@link CallCount} that matches at least one method call. */
+ public static CallCount atLeastOnce() { return new CallCount(1, Long.MAX_VALUE); }
+
+ /** Creates a {@link CallCount} that matches any number of method calls, including none at all. */
+ public static CallCount anyTimes() { return new CallCount(0, Long.MAX_VALUE); }
+
+ /** Creates a {@link CallCount} that matches at least the given number of calls. */
+ public static CallCount atLeast(long n) { return new CallCount(n, Long.MAX_VALUE); }
+
+ /** Creates a {@link CallCount} that matches up to the given number of calls but no more. */
+ public static CallCount atMost(long n) { return new CallCount(0, n); }
+
+ /** Creates a {@link CallCount} that matches any number of calls between the two given bounds. */
+ public static CallCount between(long lower, long upper) { return new CallCount(lower, upper); }
+
+ /**
+ * Creates an argument matcher that matches any object, don't use for primitives.
+ * <p>
+ * <b>Note</b>: This does not enforce that the object is of type {@code T}; use
+ * {@link #isA(Class)} to do that.
+ */
+ public static <T> T anyObject() { return LittleMock.<T>addMatcher(new MatchAnything(), null); }
+
+ /** Generates an argument matcher that matches any string. */
+ public static String anyString() { return isA(String.class); }
+
+ /** Generates an argument matcher that matches any int. */
+ public static int anyInt() { return addMatcher(new MatchAnything(), 0); }
+
+ /** Generates an argument matcher that matches any float. */
+ public static float anyFloat() { return addMatcher(new MatchAnything(), 0f); }
+
+ /** Generates an argument matcher that matches any double. */
+ public static double anyDouble() { return addMatcher(new MatchAnything(), 0.0); }
+
+ /** Generates an argument matcher that matches any boolean. */
+ public static boolean anyBoolean() { return addMatcher(new MatchAnything(), false); }
+
+ /** Generates an argument matcher that matches any short. */
+ public static short anyShort() { return addMatcher(new MatchAnything(), (short) 0); }
+
+ /** Generates an argument matcher that matches any char. */
+ public static char anyChar() { return addMatcher(new MatchAnything(), '\u0000'); }
+
+ /** Generates an argument matcher that matches any long. */
+ public static long anyLong() { return addMatcher(new MatchAnything(), 0L); }
+
+ /** Generates an argument matcher that matches any byte. */
+ public static byte anyByte() { return addMatcher(new MatchAnything(), (byte) 0); }
+
+ /** Generates an argument matcher that matches exactly this value. */
+ public static <T> T eq(final T expected) {
+ return addMatcher(new ArgumentMatcher() {
+ @Override
+ public boolean matches(Object value) {
+ return (expected == null) ? (value == null) : expected.equals(value);
+ }
+ }, expected);
+ }
+
+ /** An argument matcher that matches any value of the given type or a subtype thereof. */
+ public static <T> T isA(final Class<T> clazz) {
+ return LittleMock.<T>addMatcher(new ArgumentMatcher() {
+ @Override
+ public boolean matches(Object value) {
+ return value == null || clazz.isAssignableFrom(value.getClass());
+ }
+ }, null);
+ }
+
+ /**
+ * Injects fields annotated with {@link Mock} with a newly created mock, and those
+ * annotated with {@link Captor} with a suitable capture object.
+ *
+ * <p>This operation is recursive, and travels up the class hierarchy, in order to set all
+ * suitably annotated fields.
+ */
+ public static void initMocks(Object instance) throws Exception {
+ injectMocksForClass(instance, instance.getClass());
+ }
+
+ /** Recurse up the class hierarchy injecting mocks as we go, stopping when we reach Object. */
+ private static void injectMocksForClass(Object instance, Class<?> clazz)
+ throws Exception {
+ if (clazz.equals(Object.class)) {
+ return;
+ }
+ for (Field field : clazz.getDeclaredFields()) {
+ if (field.getAnnotation(Mock.class) != null) {
+ setField(field, instance, mock(field.getType(), field.getName()));
+ } else if (field.getAnnotation(Captor.class) != null) {
+ setField(field, instance, createCaptor());
+ }
+ }
+ injectMocksForClass(instance, clazz.getSuperclass());
+ }
+
+ /**
+ * Creates a correctly typed {@link ArgumentCaptor} , it's easier to use
+ * {@link #initMocks(Object)}.
+ */
+ public static <T> ArgumentCaptor<T> createCaptor() {
+ return new ArgumentCaptorImpl<T>();
+ }
+
+ /** Implementation of the {@link ArgumentCaptor} interface. */
+ private static class ArgumentCaptorImpl<T extends Object> implements ArgumentCaptor<T> {
+ private final ArrayList<T> mAllValues = new ArrayList<T>();
+ private T mValue;
+
+ private ArgumentCaptorImpl() {
+ }
+
+ public void setValue(T value) {
+ mValue = value;
+ mAllValues.add(mValue);
+ }
+
+ @Override
+ public T getValue() {
+ return mValue;
+ }
+
+ @Override
+ public List<T> getAllValues() {
+ return mAllValues;
+ }
+
+ @Override
+ public T capture() {
+ return LittleMock.<T>addMatcher(this, null);
+ }
+
+ @Override
+ public boolean matches(Object value) {
+ // A capture always matches any argument.
+ // This is so that verify(mMock).someMethod(capture(mCapture)) will match any and all calls
+ // to someMethod() and we will capture the values into mCapture.
+ return true;
+ }
+ }
+
+ /**
+ * Creates a mock, more easily done via the {@link #initMocks(Object)} method.
+ *
+ * <p>Also if you use this method to create your mock, the field in the error messages will
+ * be named the same as your class passed in, you only get the actual field name if you
+ * use the annotation.
+ *
+ * @throws IllegalArgumentException if the class you pass in is null
+ */
+ public static <T> T mock(Class<T> clazz) {
+ if (clazz == null) {
+ throw new IllegalArgumentException("Class to mock was null");
+ }
+ return mock(clazz, getDefaultFieldNameFor(clazz));
+ }
+
+ /** Creates a mock, more easily done via the {@link #initMocks(Object)} method. */
+ private static <T> T mock(Class<T> clazz, String fieldName) {
+ return LittleMock.<T>newProxy(clazz, new DefaultInvocationHandler(clazz, fieldName));
+ }
+
+ /** Pick a suitable name for a field of the given clazz. */
+ private static String getDefaultFieldNameFor(Class<?> clazz) {
+ return clazz.getSimpleName().substring(0, 1).toLowerCase()
+ + clazz.getSimpleName().substring(1);
+ }
+
+ /** Clears out the expectations on these mocks. */
+ public static void reset(Object... mocks) {
+ for (Object mock : mocks) {
+ getHandlerFrom(mock).reset();
+ }
+ }
+
+ /** Use this in tear down to check for programming errors. */
+ public static void checkForProgrammingErrorsDuringTearDown() { checkNoMatchers(); }
+
+ /** Implementation of {@link Behaviour}. */
+ private static class BehaviourImpl implements Behaviour {
+ private final Action mAction;
+
+ private BehaviourImpl(Action action) {
+ mAction = action;
+ }
+
+ @Override
+ public <T> T when(T mock) {
+ getHandlerFrom(mock).mStubbingAction = mAction;
+ return mock;
+ }
+ }
+
+ /**
+ * The static list of argument matchers, used in the next method call to the mock.
+ *
+ * <p>In order to support the syntax like this: verify(mFoo).someMethod(anyInt()), it is
+ * required that the anyInt() method store the value somewhere for use when the someMethod
+ * is invoked. That somewhere has to be static. I don't like it any more than you do.
+ *
+ * <p>The same goes for anything that is passed into the someMethod as an argument - be it
+ * a capture(mCaptureString) or eq(5) or whatever.
+ *
+ * <p>Avoiding the use of statics requires that we change the syntax of the verify statement,
+ * and I can't think of an elegant way of doing it, and in any case I really like the current
+ * syntax, so for now a static variable it is.
+ *
+ * <p>This match arguments list should contain either zero elements (the next method call will
+ * not use any argument matchers) or it should contain exactly one argument matcher for
+ * every argument being passed to the next method call. You can't mix argument matchers and
+ * raw values.
+ */
+ private static final List<ArgumentMatcher> sMatchArguments = new ArrayList<ArgumentMatcher>();
+
+ /** Encapsulates a single call of a method with associated arguments. */
+ private static class MethodCall {
+ /** The method call. */
+ private final Method mMethod;
+ /** The arguments provided at the time the call happened. */
+ private final Object[] mArgs;
+ /** The line from the test that invoked the handler to create this method call. */
+ private final StackTraceElement mElement;
+ /** Keeps track of method calls that have been verified, for verifyNoMoreInteractions(). */
+ public boolean mWasVerified = false;
+
+ public MethodCall(Method method, StackTraceElement element, Object[] args) {
+ mMethod = method;
+ mElement = element;
+ mArgs = args;
+ }
+
+ public boolean argsMatch(Object[] args) {
+ return Arrays.equals(mArgs, args);
+ }
+
+ @Override
+ public String toString() {
+ return "MethodCall [method=" + mMethod + ", args=" + Arrays.toString(mArgs) + "]";
+ }
+ }
+
+ /**
+ * Magically handles the invoking of method calls.
+ *
+ * <p>This object is in one of three states, default (where invoking methods returns default
+ * values and records the call), verifying (where invoking method calls makes sure that those
+ * method calls happen with the supplied arguments or matchers) or stubbing (where the next method
+ * call tells us which arguments to match in order to perform the desired behaviour).
+ */
+ private static class DefaultInvocationHandler implements InvocationHandler {
+ private static Method sEqualsMethod;
+ private static Method sHashCodeMethod;
+ private static Method sToStringMethod;
+
+ static {
+ try {
+ sEqualsMethod = Object.class.getMethod("equals", Object.class);
+ sHashCodeMethod = Object.class.getMethod("hashCode");
+ sToStringMethod = Object.class.getMethod("toString");
+ } catch (SecurityException e) {
+ // Should never happen.
+ throw new RuntimeException("Your JVM/classloader is broken", e);
+ } catch (NoSuchMethodException e) {
+ // Should never happen.
+ throw new RuntimeException("Your JVM/classloader is broken", e);
+ }
+ }
+
+ /** The class of the mocked objects. */
+ private final Class<?> mClazz;
+ /** The field name in which the mock is assigned. */
+ private final String mFieldName;
+
+ /** The list of method calls executed on the mock. */
+ private LinkedList<MethodCall> mRecordedCalls = new LinkedList<MethodCall>();
+ /** The list of method calls that were stubbed out and their corresponding actions. */
+ private LinkedList<StubbedCall> mStubbedCalls = new LinkedList<StubbedCall>();
+ /**
+ * The number of times a given call should be verified.
+ *
+ * <p>It is not null when in the verification state, and it is actually used to determine if we
+ * are in the verification state.
+ *
+ * <p>It is reset to null once the verification has occurred.
+ */
+ private CallCount mHowManyTimes = null;
+ /**
+ * The action to be associated with the stubbed method.
+ *
+ * <p>It is not null when in the stubbing state, and it is actually used to determine if we are
+ * in the stubbing state.
+ */
+ private Action mStubbingAction = null;
+
+ /**
+ * Creates a new invocation handler for an object.
+ *
+ * @param clazz the class the object belongs to
+ * @param fieldName The name to be used to refer to the object. This may either be the name of
+ * the field this mock will be stored into (in case it uses @Mock) or a suitable name to
+ * use to refer to the object in error messages, based on the name of the class itself.
+ */
+ public DefaultInvocationHandler(Class<?> clazz, String fieldName) {
+ mClazz = clazz;
+ mFieldName = fieldName;
+ }
+
+ @Override
+ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
+ ArgumentMatcher[] matchers = checkClearAndGetMatchers(method);
+ StackTraceElement callSite = new Exception().getStackTrace()[2];
+ MethodCall methodCall = new MethodCall(method, callSite, args);
+ if (mHowManyTimes != null) {
+ innerVerify(method, matchers, methodCall, proxy, callSite);
+ mHowManyTimes = null;
+ return defaultReturnValue(method.getReturnType());
+ } else if (mStubbingAction != null) {
+ innerStub(method, matchers, methodCall, callSite);
+ mStubbingAction = null;
+ return defaultReturnValue(method.getReturnType());
+ } else {
+ return innerRecord(method, args, methodCall, proxy, callSite);
+ }
+ }
+
+ /**
+ * Checks whether the given method is one of the special object methods that should not
+ * verified or stubbed.
+ * <p>
+ * If this is one of such methods, it throws an AssertionException.
+ *
+ * @param method the method to be checked
+ * @param operation the name of the operation, used for generating a helpful message
+ */
+ private void checkSpecialObjectMethods(Method method, String operation) {
+ if (method.equals(sEqualsMethod)
+ || method.equals(sHashCodeMethod)
+ || method.equals(sToStringMethod)) {
+ fail("cannot " + operation + " call to " + method);
+ }
+ }
+
+ private void reset() {
+ mRecordedCalls.clear();
+ mStubbedCalls.clear();
+ mHowManyTimes = null;
+ mStubbingAction = null;
+ }
+
+ private Object innerRecord(Method method, final Object[] args,
+ MethodCall methodCall, Object proxy, StackTraceElement callSite) throws Throwable {
+ if (method.equals(sEqualsMethod)) {
+ // Use identify for equality, the default behavior on object.
+ return proxy == args[0];
+ } else if (method.equals(sHashCodeMethod)) {
+ // This depends on the fact that each mock has its own DefaultInvocationHandler.
+ return hashCode();
+ } else if (method.equals(sToStringMethod)) {
+ // This is used to identify this is a mock, e.g., in error messages.
+ return "Mock<" + mClazz.getName() + ">";
+ }
+ mRecordedCalls.add(methodCall);
+ for (StubbedCall stubbedCall : mStubbedCalls) {
+ if (stubbedCall.mMethodCall.mMethod.equals(methodCall.mMethod)) {
+ if (stubbedCall.mMethodCall.argsMatch(methodCall.mArgs)) {
+ methodCall.mWasVerified = true;
+ return stubbedCall.mAction.doAction(method, args);
+ }
+ }
+ }
+ // If no stub is defined, return the default value.
+ return defaultReturnValue(method.getReturnType());
+ }
+
+ private void innerStub(Method method, final ArgumentMatcher[] matchers, MethodCall methodCall,
+ StackTraceElement callSite) {
+ final Action stubbingAction = mStubbingAction;
+ checkSpecialObjectMethods(method, "stub");
+ checkThisActionCanBeUsedForThisMethod(method, stubbingAction, callSite);
+ if (matchers.length == 0) {
+ // If there are no matchers, then this is a simple stubbed method call with an action.
+ mStubbedCalls.addFirst(new StubbedCall(methodCall, stubbingAction));
+ return;
+ }
+ // If there are matchers, then we need to make a new method call which matches only
+ // when all the matchers match. Further, the action that method call needs to take
+ // is to first record the values into any captures that may be present, and only then
+ // proceed to execute the original action.
+ MethodCall matchMatchersMethodCall = new MethodCall(method, callSite, matchers) {
+ @Override
+ public boolean argsMatch(Object[] args) { return doMatchersMatch(matchers, args); }
+ };
+ Action setCapturesThenAction = new Action() {
+ @Override
+ public Object doAction(Method innerMethod, Object[] innerArgs) throws Throwable {
+ setCaptures(matchers, innerArgs);
+ return stubbingAction.doAction(innerMethod, innerArgs);
+ }
+ @Override
+ public Class<?> getReturnType() {
+ return stubbingAction.getReturnType();
+ }
+ };
+ mStubbedCalls.addFirst(new StubbedCall(matchMatchersMethodCall, setCapturesThenAction));
+ }
+
+ private void checkThisActionCanBeUsedForThisMethod(Method method, final Action stubbingAction,
+ StackTraceElement callSite) {
+ Class<?> methodType = method.getReturnType();
+ Class<?> actionType = stubbingAction.getReturnType();
+ if (actionType == null) {
+ // We could not determine the type returned by this action at the time we
+ // created it. At this time we cannot check that the returned value is
+ // appropriate to the return type of the method.
+ // However, if the type is not correct, any actual invocation of the method
+ // will fail later on.
+ return;
+ }
+ if (!methodType.isAssignableFrom(actionType)) {
+ if (methodType.isPrimitive() &&
+ actionType.equals(PRIMITIVE_TO_BOXED_LOOKUP.get(methodType))) {
+ return;
+ }
+ StringBuffer sb = new StringBuffer();
+ sb.append("\nCan't return ").append(actionType.getSimpleName()).append(" from stub for:");
+ appendDebugStringForMethodCall(sb, method, callSite, mFieldName, true);
+ sb.append("\n");
+ throw new IllegalArgumentException(sb.toString());
+ }
+ }
+
+ private boolean doMatchersMatch(ArgumentMatcher[] matchers, Object[] args) {
+ for (int i = 0; i < matchers.length; ++i) {
+ if (!matchers[i].matches(args[i])) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ private void innerVerify(Method method, ArgumentMatcher[] matchers, MethodCall methodCall,
+ Object proxy, StackTraceElement callSite) {
+ checkSpecialObjectMethods(method, "verify");
+ int total = 0;
+ for (MethodCall call : mRecordedCalls) {
+ if (call.mMethod.equals(method)) {
+ if ((matchers.length > 0 && doMatchersMatch(matchers, call.mArgs)) ||
+ call.argsMatch(methodCall.mArgs)) {
+ setCaptures(matchers, call.mArgs);
+ ++total;
+ call.mWasVerified = true;
+ }
+ }
+ }
+ expect(mHowManyTimes.matches(total), formatFailedVerifyMessage(methodCall, total));
+ }
+
+ private String formatFailedVerifyMessage(MethodCall methodCall, int total) {
+ StringBuffer sb = new StringBuffer();
+ sb.append("\nExpected ").append(mHowManyTimes).append(" to:");
+ appendDebugStringForMethodCall(sb, methodCall.mMethod,
+ methodCall.mElement, mFieldName, false);
+ sb.append("\n\n");
+ if (mRecordedCalls.size() == 0) {
+ sb.append("No method calls happened to this mock");
+ } else {
+ sb.append("Method calls that did happen:");
+ for (MethodCall recordedCall : mRecordedCalls) {
+ appendDebugStringForMethodCall(sb, recordedCall.mMethod,
+ recordedCall.mElement, mFieldName, false);
+ }
+ }
+ sb.append("\n");
+ return sb.toString();
+ }
+
+ /** All matchers that are captures will store the corresponding arg value. */
+ // This suppress warning means that I'm calling setValue with something that I can't promise
+ // is of the right type. But I think it is unavoidable. Certainly I could give a better
+ // error message than the class cast exception you'll get when you try to retrieve the value.
+ @SuppressWarnings("unchecked")
+ private void setCaptures(ArgumentMatcher[] matchers, Object[] args) {
+ for (int i = 0; i < matchers.length; ++i) {
+ if (matchers[i] instanceof ArgumentCaptorImpl) {
+ ArgumentCaptorImpl.class.cast(matchers[i]).setValue(args[i]);
+ }
+ }
+ }
+
+ /** An empty array of matchers, to optimise the toArray() call below. */
+ private static final ArgumentMatcher[] EMPTY_MATCHERS_ARRAY = new ArgumentMatcher[0];
+
+ /** Makes sure that we have the right number of MATCH_ARGUMENTS for the given method. */
+ private ArgumentMatcher[] checkClearAndGetMatchers(Method method) {
+ ArgumentMatcher[] matchers = sMatchArguments.toArray(EMPTY_MATCHERS_ARRAY);
+ sMatchArguments.clear();
+ if (matchers.length > 0 && method.getParameterTypes().length != matchers.length) {
+ throw new IllegalArgumentException("You can't mix matchers and regular objects.");
+ }
+ return matchers;
+ }
+ }
+
+ private static void appendDebugStringForMethodCall(StringBuffer sb, Method method,
+ StackTraceElement callSite, String fieldName, boolean showReturnType) {
+ sb.append("\n ");
+ if (showReturnType) {
+ sb.append("(").append(method.getReturnType().getSimpleName()).append(") ");
+ }
+ sb.append(fieldName).append(".").append(method.getName()).append("(");
+ int i = 0;
+ for (Class<?> type : method.getParameterTypes()) {
+ if (++i > 1) {
+ sb.append(", ");
+ }
+ sb.append(type.getSimpleName());
+ }
+ sb.append(")\n at ").append(callSite);
+ }
+
+ /** Call this function when you don't expect there to be any outstanding matcher objects. */
+ private static void checkNoMatchers() {
+ if (sMatchArguments.size() > 0) {
+ sMatchArguments.clear();
+ throw new IllegalStateException("You have outstanding matchers, must be programming error");
+ }
+ }
+
+ /** A pairing of a method call and an action to be performed when that call happens. */
+ private static class StubbedCall {
+ private final MethodCall mMethodCall;
+ private final Action mAction;
+
+ public StubbedCall(MethodCall methodCall, Action action) {
+ mMethodCall = methodCall;
+ mAction = action;
+ }
+
+ @Override
+ public String toString() {
+ return "StubbedCall [methodCall=" + mMethodCall + ", action=" + mAction + "]";
+ }
+ }
+
+ /** Represents an action to be performed as a result of a method call. */
+ private interface Action {
+ public Object doAction(Method method, Object[] arguments) throws Throwable;
+ /** The type of the action, or null if we can't determine the type at stub time. */
+ public Class<?> getReturnType();
+ }
+
+ /** Represents something capable of testing if it matches an argument or not. */
+ /*package*/ interface ArgumentMatcher {
+ public boolean matches(Object value);
+ }
+
+ /** A matcher that matches any argument. */
+ private static class MatchAnything implements ArgumentMatcher {
+ @Override
+ public boolean matches(Object value) { return true; }
+ }
+
+ /** Encapsulates the number of times a method is called, between upper and lower bounds. */
+ private static class CallCount {
+ long mLowerBound;
+ long mUpperBound;
+
+ private CallCount(long lowerBound, long upperBound) {
+ mLowerBound = lowerBound;
+ mUpperBound = upperBound;
+ }
+
+ /** Tells us if this call count matches a desired count. */
+ public boolean matches(long total) {
+ return total >= mLowerBound && total <= mUpperBound;
+ }
+
+ @Override
+ public String toString() {
+ if (mLowerBound == mUpperBound) {
+ return "exactly " + mLowerBound + plural(" call", mLowerBound);
+ } else {
+ return "between " + mLowerBound + plural(" call", mLowerBound) + " and " +
+ mUpperBound + plural(" call", mUpperBound);
+ }
+ }
+ }
+
+ /** Helper method to add an 's' to a string iff the count is not 1. */
+ private static String plural(String prefix, long count) {
+ return (count == 1) ? prefix : (prefix + "s");
+ }
+
+ /** Helps us implement the eq(), any() and capture() and other methods on one line. */
+ private static <T> T addMatcher(ArgumentMatcher argument, T value) {
+ sMatchArguments.add(argument);
+ return value;
+ }
+
+ /** Utility method to throw an AssertionError if an assertion fails. */
+ private static void expect(boolean result, String message) {
+ if (!result) {
+ fail(message);
+ }
+ }
+
+ /** Throws an AssertionError exception with a message. */
+ private static void fail(String message) {
+ throw new AssertionError(message);
+ }
+
+ /** Static mapping from class type to default value for that type. */
+ private static final Map<Class<?>, Object> DEFAULT_RETURN_VALUE_LOOKUP;
+ static {
+ DEFAULT_RETURN_VALUE_LOOKUP = new HashMap<Class<?>, Object>();
+ DEFAULT_RETURN_VALUE_LOOKUP.put(int.class, 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(boolean.class, false);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(byte.class, (byte) 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(long.class, (long) 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(short.class, (short) 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(float.class, (float) 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(double.class, (double) 0);
+ DEFAULT_RETURN_VALUE_LOOKUP.put(char.class, '\u0000');
+ DEFAULT_RETURN_VALUE_LOOKUP.put(String.class, null);
+ }
+
+ /** Static lookup from primitive types to their boxed versions. */
+ private static final Map<Class<?>, Class<?>> PRIMITIVE_TO_BOXED_LOOKUP;
+ static {
+ PRIMITIVE_TO_BOXED_LOOKUP = new HashMap<Class<?>, Class<?>>();
+ PRIMITIVE_TO_BOXED_LOOKUP.put(int.class, Integer.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(boolean.class, Boolean.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(byte.class, Byte.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(long.class, Long.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(short.class, Short.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(float.class, Float.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(double.class, Double.class);
+ PRIMITIVE_TO_BOXED_LOOKUP.put(char.class, Character.class);
+ }
+
+ /** For a given class type, returns the default value for that type. */
+ private static Object defaultReturnValue(Class<?> returnType) {
+ return DEFAULT_RETURN_VALUE_LOOKUP.get(returnType);
+ }
+
+ /**
+ * If the input object is one of our mocks, returns the {@link DefaultInvocationHandler}
+ * we constructed it with. Otherwise fails with {@link IllegalArgumentException}.
+ */
+ private static DefaultInvocationHandler getHandlerFrom(Object mock) {
+ InvocationHandler invocationHandler = Proxy.getInvocationHandler(mock);
+ if (!(invocationHandler instanceof DefaultInvocationHandler)) {
+ throw new IllegalArgumentException("not a valid mock: " + mock);
+ }
+ return (DefaultInvocationHandler) invocationHandler;
+ }
+
+ /** Builds a dynamic proxy that implements the given interface, delegating to given handler. */
+ @SuppressWarnings("unchecked")
+ private static <T> T newProxy(Class<?> theInterface, InvocationHandler theHandler) {
+ return (T) Proxy.newProxyInstance(getClassLoader(), new Class<?>[]{ theInterface }, theHandler);
+ }
+
+ /** Gets a suitable class loader for use with the proxy. */
+ private static ClassLoader getClassLoader() {
+ return LittleMock.class.getClassLoader();
+ }
+
+ /** Sets a member field on an object via reflection (can set private members too). */
+ private static void setField(Field field, Object object, Object value) throws Exception {
+ field.setAccessible(true);
+ field.set(object, value);
+ field.setAccessible(false);
+ }
+}
diff --git a/src/com/google/testing/littlemock/Mock.java b/src/com/google/testing/littlemock/Mock.java
new file mode 100644
index 0000000..f4667b7
--- /dev/null
+++ b/src/com/google/testing/littlemock/Mock.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Use this to inject a mock into your test class.
+ *
+ * <p>Just add the correct annotation to your field like this:
+ * <pre>
+ * @Mock private MyInterface mMockMyInterface;
+ * </pre>
+ *
+ * <p>You just have to make sure that {@link LittleMock#initMocks(Object)} is called from
+ * your setUp() (or from a test base class), and then all your mocks will be automatically
+ * constructed for you.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ */
+@Target({ ElementType.FIELD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Mock {
+}
diff --git a/tests/com/google/testing/littlemock/LittleMockTest.java b/tests/com/google/testing/littlemock/LittleMockTest.java
new file mode 100644
index 0000000..9d3cf38
--- /dev/null
+++ b/tests/com/google/testing/littlemock/LittleMockTest.java
@@ -0,0 +1,1310 @@
+/*
+ * Copyright 2011 Google Inc.
+ *
+ * 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.testing.littlemock;
+
+import static com.google.testing.littlemock.LittleMock.anyBoolean;
+import static com.google.testing.littlemock.LittleMock.anyByte;
+import static com.google.testing.littlemock.LittleMock.anyChar;
+import static com.google.testing.littlemock.LittleMock.anyDouble;
+import static com.google.testing.littlemock.LittleMock.anyFloat;
+import static com.google.testing.littlemock.LittleMock.anyInt;
+import static com.google.testing.littlemock.LittleMock.anyLong;
+import static com.google.testing.littlemock.LittleMock.anyObject;
+import static com.google.testing.littlemock.LittleMock.anyShort;
+import static com.google.testing.littlemock.LittleMock.anyString;
+import static com.google.testing.littlemock.LittleMock.anyTimes;
+import static com.google.testing.littlemock.LittleMock.atLeast;
+import static com.google.testing.littlemock.LittleMock.atLeastOnce;
+import static com.google.testing.littlemock.LittleMock.atMost;
+import static com.google.testing.littlemock.LittleMock.between;
+import static com.google.testing.littlemock.LittleMock.checkForProgrammingErrorsDuringTearDown;
+import static com.google.testing.littlemock.LittleMock.doAnswer;
+import static com.google.testing.littlemock.LittleMock.doNothing;
+import static com.google.testing.littlemock.LittleMock.doReturn;
+import static com.google.testing.littlemock.LittleMock.doThrow;
+import static com.google.testing.littlemock.LittleMock.eq;
+import static com.google.testing.littlemock.LittleMock.initMocks;
+import static com.google.testing.littlemock.LittleMock.isA;
+import static com.google.testing.littlemock.LittleMock.mock;
+import static com.google.testing.littlemock.LittleMock.never;
+import static com.google.testing.littlemock.LittleMock.reset;
+import static com.google.testing.littlemock.LittleMock.times;
+import static com.google.testing.littlemock.LittleMock.verify;
+import static com.google.testing.littlemock.LittleMock.verifyNoMoreInteractions;
+import static com.google.testing.littlemock.LittleMock.verifyZeroInteractions;
+
+import junit.framework.TestCase;
+
+import java.io.IOException;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.lang.reflect.Proxy;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Callable;
+
+/**
+ * Unit tests for the LittleMock class.
+ *
+ * @author hugohudson@gmail.com (Hugo Hudson)
+ */
+public class LittleMockTest extends TestCase {
+ /**
+ * Used in these unit tests to indicate that the method should throw a given type of exception.
+ */
+ @Target({ ElementType.METHOD })
+ @Retention(RetentionPolicy.RUNTIME)
+ public @interface ShouldThrow {
+ public Class<? extends Throwable> value();
+ public String[] messages() default {};
+ }
+
+ @Mock private Foo mFoo;
+ @Mock private Bar mBar;
+ @Mock private BarSubtype mBarSubtype;
+ @Captor private ArgumentCaptor<String> mCaptureString;
+ @Captor private ArgumentCaptor<String> mCaptureAnotherString;
+ @Captor private ArgumentCaptor<Integer> mCaptureInteger;
+ @Captor private ArgumentCaptor<Callback> mCaptureCallback;
+
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ LittleMock.initMocks(this);
+ }
+
+ @Override
+ protected void runTest() throws Throwable {
+ Method method = getClass().getMethod(getName(), (Class[]) null);
+ ShouldThrow shouldThrowAnnotation = method.getAnnotation(ShouldThrow.class);
+ if (shouldThrowAnnotation != null) {
+ try {
+ super.runTest();
+ fail("Should have thrown " + shouldThrowAnnotation.value());
+ } catch (Throwable e) {
+ if (!e.getClass().equals(shouldThrowAnnotation.value())) {
+ fail("Should have thrown " + shouldThrowAnnotation.value() + " but threw " + e);
+ }
+ for (String requiredSubstring : shouldThrowAnnotation.messages()) {
+ if (!e.getMessage().contains(requiredSubstring)) {
+ fail("Error message didn't contain " + requiredSubstring + ", was " + e.getMessage());
+ }
+ }
+ // Good, test passes.
+ }
+ } else {
+ super.runTest();
+ }
+ }
+
+ /** Simple interface for testing against. */
+ public interface Callback {
+ public void callMeNow();
+ }
+
+ /** Simple interface for testing against. */
+ public interface Foo {
+ public int anInt();
+ public boolean aBoolean();
+ public byte aByte();
+ public short aShort();
+ public long aLong();
+ public float aFloat();
+ public double aDouble();
+ public char aChar();
+ public String aString();
+ public Object anObject();
+ public Foo anInterface();
+ public void add(String input);
+ public void clear();
+ public String get(int index);
+ public String lookup(String string);
+ public void getResultLater(Callback callback);
+ public String findByInt(int input);
+ public String findByBoolean(boolean input);
+ public String findByByte(byte input);
+ public String findByShort(short input);
+ public String findByLong(long input);
+ public String findByFloat(float input);
+ public String findByDouble(double input);
+ public String findByChar(char input);
+ public void takesObject(Object input);
+ public void takesList(List<String> input);
+ public void takesBar(Bar bar);
+ public void exceptionThrower() throws Exception;
+ public Bar aBar();
+ public BarSubtype aBarSubtype();
+ }
+
+ /** Simple interface for testing against. */
+ public interface Bar {
+ public void doSomething();
+ public String twoStrings(String first, String second);
+ public void mixedArguments(int first, String second);
+ public void getResultLater(Callback callback);
+ }
+
+ /** Subtype of Bar. */
+ public interface BarSubtype extends Bar {
+ public void doSomethingElse();
+ }
+
+ /** Another interface for testing with. */
+ public interface OnClickListener {
+ void onClick(Bar bar);
+ }
+
+ public void testDefaultReturnTypesForNewMocks() {
+ assertEquals(0, mFoo.anInt());
+ assertEquals(false, mFoo.aBoolean());
+ assertEquals(0, mFoo.aByte());
+ assertEquals(0, mFoo.aShort());
+ assertEquals(0L, mFoo.aLong());
+ assertEquals(0.0f, mFoo.aFloat());
+ assertEquals(0.0d, mFoo.aDouble());
+ assertEquals('\u0000', mFoo.aChar());
+ assertEquals(null, mFoo.aString());
+ assertEquals(null, mFoo.anObject());
+ assertEquals(null, mFoo.anInterface());
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testVerify_FailsIfNotDoneOnAProxy() {
+ verify("hello").contains("something");
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testVerify_FailsIfNotCreatedByOurMockMethod() {
+ verify(createNotARealMock()).add("something");
+ }
+
+ public void testVerify_SuccessfulVerification() {
+ mFoo.add("something");
+ verify(mFoo).add("something");
+ }
+
+ public void testVerify_SuccessfulVerification_NormalOrder() {
+ mFoo.add("something");
+ mFoo.add("something else");
+ verify(mFoo).add("something");
+ verify(mFoo).add("something else");
+ }
+
+ public void testVerify_SuccessfulVerification_ReverseOrder() {
+ mFoo.add("something");
+ mFoo.add("something else");
+ verify(mFoo).add("something else");
+ verify(mFoo).add("something");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_MeansOnlyOnceSoShouldFailIfCalledTwice() {
+ mFoo.add("something");
+ mFoo.add("something");
+ verify(mFoo).add("something");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_FailedVerification_CalledWithWrongArgument() {
+ mFoo.add("something else");
+ verify(mFoo).add("something");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_FailedVerification_WasNeverCalled() {
+ verify(mFoo).add("something");
+ }
+
+ public void testVerify_TimesTwice_Succeeds() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, LittleMock.times(2)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_TimesTwice_ButThreeTimesFails() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, LittleMock.times(2)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_TimesTwice_ButOnceFails() {
+ mFoo.add("jim");
+ verify(mFoo, LittleMock.times(2)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_TimesTwice_DifferentStringsFails() {
+ mFoo.add("jim");
+ mFoo.add("bob");
+ verify(mFoo, LittleMock.times(2)).add("jim");
+ }
+
+ public void testVerify_TimesTwice_WorksWithAnyString() {
+ mFoo.add("jim");
+ mFoo.add("bob");
+ verify(mFoo, LittleMock.times(2)).add(anyString());
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_TimesTwice_FailsIfJustOnceWithAnyString() {
+ mFoo.add("bob");
+ verify(mFoo, LittleMock.times(2)).add(anyString());
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_TimesTwice_FailsIfThreeTimesWithAnyString() {
+ mFoo.add("bob");
+ mFoo.add("jim");
+ mFoo.add("james");
+ verify(mFoo, LittleMock.times(2)).add(anyString());
+ }
+
+ public void testVerify_Never_Succeeds() {
+ verify(mFoo, never()).add("jim");
+ verify(mFoo, never()).anInt();
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_Never_FailsIfWasCalled() {
+ mFoo.add("jim");
+ verify(mFoo, never()).add("jim");
+ }
+
+ public void testVerify_Never_PassesIfArgumentsDontMatch() {
+ mFoo.add("bobby");
+ verify(mFoo, never()).add("jim");
+ }
+
+ public void testVerify_AtLeastOnce_SuceedsForOneCall() {
+ mFoo.add("jim");
+ verify(mFoo, atLeastOnce()).add("jim");
+ }
+
+ public void testVerify_AtLeastOnce_SuceedsForThreeCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atLeastOnce()).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_AtLeastOnce_FailsForNoCalls() {
+ verify(mFoo, atLeastOnce()).add("jim");
+ }
+
+ public void testVerify_AtLeastThreeTimes_SuceedsForThreeCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atLeast(3)).add("jim");
+ }
+
+ public void testVerify_AtLeastThreeTimes_SuceedsForFiveCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atLeast(3)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_AtLeastThreeTimes_FailsForTwoCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atLeast(3)).add("jim");
+ }
+
+ public void testVerify_AtMostThreeTimes_SuceedsForThreeCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atMost(3)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_AtMostThreeTimes_FailsForFiveCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atMost(3)).add("jim");
+ }
+
+ public void testVerify_AtMostThreeTimes_SucceedsForTwoCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, atMost(3)).add("jim");
+ }
+
+ public void testVerify_AtMostThreeTimes_SucceedsForNoCalls() {
+ verify(mFoo, atMost(3)).add("jim");
+ }
+
+ public void testVerify_BetweenTwoAndFour_SucceedsForTwoCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, between(2, 4)).add("jim");
+ }
+
+ public void testVerify_BetweenTwoAndFour_SucceedsForFourCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, between(2, 4)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_BetweenTwoAndFour_FailsForOneCall() {
+ mFoo.add("jim");
+ verify(mFoo, between(2, 4)).add("jim");
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerify_BetweenTwoAndFour_FailsForFiveCalls() {
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ mFoo.add("jim");
+ verify(mFoo, LittleMock.between(2, 4)).add("jim");
+ }
+
+ public void testDoReturnWhen_SimpleReturn() {
+ doReturn("first").when(mFoo).get(0);
+ assertEquals("first", mFoo.get(0));
+ }
+
+ public void testDoReturnWhen_LastStubCallWins() {
+ doReturn("first").when(mFoo).get(0);
+ doReturn("second").when(mFoo).get(0);
+ assertEquals("second", mFoo.get(0));
+ }
+
+ public void testDoReturnWhen_CorrectStubMethodIsChosen() {
+ doReturn("one").when(mFoo).get(1);
+ doReturn("two").when(mFoo).get(2);
+ assertEquals("one", mFoo.get(1));
+ assertEquals("two", mFoo.get(2));
+ }
+
+ public void testDoReturnWhen_UnstubbedMethodStillReturnsDefault() {
+ doReturn("one").when(mFoo).get(1);
+ assertEquals(null, mFoo.get(2));
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturnWhen_CalledOnString() {
+ doReturn("first").when("hello").contains("something");
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturnWhen_CalledOnNonMock() {
+ doReturn("first").when(createNotARealMock()).get(0);
+ }
+
+ public void testDoReturnWhen_CanAlsoBeVerified() {
+ // Mockito home page suggests that you don't verify stubbed calls.
+ // I agree. They support it anyway. So will I.
+ doReturn("one").when(mFoo).get(8);
+ mFoo.get(8);
+ verify(mFoo).get(8);
+ }
+
+ public void testDoReturn_CanPassIntForIntMethod() {
+ doReturn(90).when(mFoo).anInt();
+ assertEquals(90, mFoo.anInt());
+ }
+
+ // Interesting, you have to explicity convert the Integer class back into an int before it
+ // is happy to accept this.
+ public void testDoReturn_CanPassIntegerClassForIntMethod() {
+ doReturn((int) Integer.valueOf(10)).when(mFoo).anInt();
+ assertEquals(10, mFoo.anInt());
+ }
+
+ public void testDoReturn_PrimitiveLong() {
+ doReturn((long) Long.valueOf(10L)).when(mFoo).aLong();
+ assertEquals(10L, mFoo.aLong());
+ }
+
+ public void testDoReturn_PrimitiveTypes() {
+ doReturn(5).when(mFoo).anInt();
+ assertEquals(5, mFoo.anInt());
+ doReturn((short) 5).when(mFoo).aShort();
+ assertEquals(5, mFoo.aShort());
+ doReturn(true).when(mFoo).aBoolean();
+ assertEquals(true, mFoo.aBoolean());
+ doReturn((byte) 3).when(mFoo).aByte();
+ assertEquals(3, mFoo.aByte());
+ doReturn(0.6f).when(mFoo).aFloat();
+ assertEquals(0.6f, mFoo.aFloat());
+ doReturn(0.7).when(mFoo).aDouble();
+ assertEquals(0.7, mFoo.aDouble());
+ doReturn('c').when(mFoo).aChar();
+ assertEquals('c', mFoo.aChar());
+ assertEquals(null, mFoo.anInterface());
+ }
+
+ @ShouldThrow(RuntimeException.class)
+ public void testDoThrow_SimpleException() {
+ doThrow(new RuntimeException()).when(mFoo).aDouble();
+ mFoo.aDouble();
+ }
+
+ public void testDoThrow_IfItDoesntMatchItIsntThrown() {
+ doThrow(new RuntimeException()).when(mFoo).aDouble();
+ mFoo.aChar();
+ }
+
+ @ShouldThrow(RuntimeException.class)
+ public void testDoThrow_KeepsThrowingForever() {
+ doThrow(new RuntimeException()).when(mFoo).aDouble();
+ try {
+ mFoo.aDouble();
+ fail("Should have thrown a RuntimeException");
+ } catch (RuntimeException e) {
+ // Expected.
+ }
+ // This second call should also throw a RuntimeException.
+ mFoo.aDouble();
+ }
+
+ public void testDoNothing() {
+ doNothing().when(mFoo).add("first");
+ mFoo.add("first");
+ }
+
+ public void testVerifyZeroInteractions_PassesWhenNothingHasHappened() {
+ verifyZeroInteractions(mFoo);
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyZeroInteractions_FailsIfSomethingHasHappened() {
+ mFoo.aBoolean();
+ verifyZeroInteractions(mFoo);
+ }
+
+ public void testVerifyZeroInteractions_HappyWithMultipleArguments() {
+ verifyZeroInteractions(mFoo, mBar);
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyZeroInteractions_ShouldFailEvenIfOtherInteractionsWereFirstVerified() {
+ mFoo.add("test");
+ verify(mFoo).add("test");
+ verifyZeroInteractions(mFoo);
+ }
+
+ public void testVerifyEq_Method() {
+ mFoo.add("test");
+ verify(mFoo).add(eq("test"));
+ }
+
+ public void testVerifyEq_MethodWithTwoSameTypeParameters() {
+ mBar.twoStrings("first", "test");
+ verify(mBar).twoStrings(eq("first"), eq("test"));
+ }
+
+ public void testVerifyEq_MethodWithTwoDifferentTypeParameters() {
+ mBar.mixedArguments(8, "test");
+ verify(mBar).mixedArguments(eq(8), eq("test"));
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyEq_MethodFailsIfNotEqual() {
+ mFoo.add("bob");
+ verify(mFoo).add(eq("jim"));
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyEq_MethodFailsIfJustOneIsNotEqual() {
+ mBar.twoStrings("first", "second");
+ verify(mBar).twoStrings(eq("first"), eq("third"));
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyEq_MethodFailsIfSameParamsButInWrongOrder() {
+ mBar.twoStrings("first", "second");
+ verify(mBar).twoStrings(eq("second"), eq("first"));
+ }
+
+ public void testCapture_SimpleCapture() {
+ // We verify that there are zero matchers by using the check for programming errors method.
+ checkForProgrammingErrorsDuringTearDown();
+ mFoo.add("test");
+ verify(mFoo).add(mCaptureString.capture());
+ assertEquals("test", mCaptureString.getValue());
+ checkForProgrammingErrorsDuringTearDown();
+ }
+
+ public void testCapture_DuringStubbing() {
+ checkForProgrammingErrorsDuringTearDown();
+ doReturn("hello").when(mFoo).lookup(mCaptureString.capture());
+
+ assertEquals("hello", mFoo.lookup("what"));
+ assertEquals("what", mCaptureString.getValue());
+ }
+
+ public void testCapture_TwoCallbacksDuringStubbing() {
+ checkForProgrammingErrorsDuringTearDown();
+ doNothing().when(mFoo).add(mCaptureString.capture());
+ doNothing().when(mFoo).getResultLater(mCaptureCallback.capture());
+
+ mFoo.add("hi");
+ assertEquals("hi", mCaptureString.getValue());
+
+ Callback callback = createNoOpCallback();
+ mFoo.getResultLater(callback);
+ assertEquals(callback, mCaptureCallback.getValue());
+ }
+
+ // TODO(hugohudson): 6. Is this impossible to fix? You can't pass a
+ // createCapture().capture() into a method expecting an int, because the capture
+ // method returns null, and that gets auto-boxed to Integer on the way out of the
+ // capture method, then auto-unboxed into an int when being passed to the underlying
+ // method, which gives the NPE. How best can we fix this?
+ // It's not like you need to anyway - there's no point / need to capture a primitive,
+ // just use eq(5) for example.
+ public void testCapture_NPEWhenUnboxing() {
+ try {
+ mBar.mixedArguments(5, "ten");
+ verify(mBar).mixedArguments(mCaptureInteger.capture(), mCaptureString.capture());
+ // These lines are never reached, the previous line throws an NPE.
+ fail("You shouldn't be able to reach here");
+ assertEquals(Integer.valueOf(5), mCaptureInteger.getValue());
+ assertEquals("ten", mCaptureString.getValue());
+ } catch (NullPointerException e) {
+ // Expected, unfortunately.
+ // Now also we're in the situation where we have some captures hanging about in the static
+ // variable, which will cause the tear down of this method to fail - we can clear them
+ // as follows:
+ try {
+ checkForProgrammingErrorsDuringTearDown();
+ fail("Expected an IllegalStateException");
+ } catch (IllegalStateException e2) {
+ // Expected.
+ }
+ }
+ }
+
+ public void testCapture_MultiCapture() {
+ mFoo.lookup("james");
+ mFoo.add("whinny");
+ mFoo.add("jessica");
+ verify(mFoo).lookup(mCaptureString.capture());
+ verify(mFoo, atLeastOnce()).add(mCaptureAnotherString.capture());
+ assertEquals("james", mCaptureString.getValue());
+ assertEquals("jessica", mCaptureAnotherString.getValue());
+ assertEquals(newList("whinny", "jessica"), mCaptureAnotherString.getAllValues());
+ }
+
+ public static <T> List<T> newList(T... things) {
+ ArrayList<T> list = new ArrayList<T>();
+ for (T thing : things) {
+ list.add(thing);
+ }
+ return list;
+ }
+
+ public void testAnyString() {
+ doReturn("jim").when(mFoo).lookup(anyString());
+ assertEquals("jim", mFoo.lookup("barney"));
+ }
+
+ public void testAnyString_ObjectArgument() {
+ // It can also be passed to a method that takes object.
+ mFoo.takesObject("barney");
+ verify(mFoo).takesObject(anyString());
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testAnyString_ObjectValue() {
+ mFoo.takesObject(new Object());
+ verify(mFoo).takesObject(anyString());
+ }
+
+ public void testAnyObject() {
+ doReturn("jim").when(mFoo).lookup((String) anyObject());
+ assertEquals("jim", mFoo.lookup("barney"));
+ }
+
+ public void testAnyPrimitives() {
+ mFoo.findByBoolean(true);
+ mFoo.findByInt(10000);
+ mFoo.findByByte((byte) 250);
+ mFoo.findByShort((short) 6666);
+ mFoo.findByLong(13L);
+ mFoo.findByFloat(8f);
+ mFoo.findByDouble(1.1);
+ mFoo.findByChar('h');
+ verify(mFoo).findByBoolean(anyBoolean());
+ verify(mFoo).findByInt(anyInt());
+ verify(mFoo).findByByte(anyByte());
+ verify(mFoo).findByShort(anyShort());
+ verify(mFoo).findByLong(anyLong());
+ verify(mFoo).findByFloat(anyFloat());
+ verify(mFoo).findByDouble(anyDouble());
+ verify(mFoo).findByChar(anyChar());
+ }
+
+ public void testAnyPrimitivesWhenMatching() {
+ doReturn("a").when(mFoo).findByBoolean(anyBoolean());
+ doReturn("b").when(mFoo).findByInt(anyInt());
+ doReturn("c").when(mFoo).findByByte(anyByte());
+ doReturn("d").when(mFoo).findByShort(anyShort());
+ doReturn("e").when(mFoo).findByLong(anyLong());
+ doReturn("f").when(mFoo).findByFloat(anyFloat());
+ doReturn("g").when(mFoo).findByDouble(anyDouble());
+ doReturn("h").when(mFoo).findByChar(anyChar());
+ assertEquals("a", mFoo.findByBoolean(true));
+ assertEquals("b", mFoo.findByInt(388));
+ assertEquals("c", mFoo.findByByte((byte) 38));
+ assertEquals("d", mFoo.findByShort((short) 16));
+ assertEquals("e", mFoo.findByLong(1000000L));
+ assertEquals("f", mFoo.findByFloat(15.3f));
+ assertEquals("g", mFoo.findByDouble(13.3));
+ assertEquals("h", mFoo.findByChar('i'));
+ }
+
+ public void testReset_NoInteractionsAfterReset() {
+ mFoo.aByte();
+ reset(mFoo);
+ verifyZeroInteractions(mFoo);
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testReset_VerifyFailsAfterReset() {
+ mFoo.aByte();
+ reset(mFoo);
+ verify(mFoo).aByte();
+ }
+
+ public void testCapture_BothBeforeAndAfter() {
+ doNothing().when(mFoo).add(mCaptureString.capture());
+ mFoo.add("first");
+ verify(mFoo).add(mCaptureAnotherString.capture());
+ assertEquals("first", mCaptureString.getValue());
+ assertEquals("first", mCaptureAnotherString.getValue());
+ }
+
+ public void testDoAction_NormalOperation() {
+ doAnswer(new Callable<Boolean>() {
+ @Override
+ public Boolean call() throws Exception {
+ return Boolean.TRUE;
+ }
+ }).when(mFoo).aBoolean();
+ assertEquals(true, mFoo.aBoolean());
+ }
+
+ public void testComplexSituationWithCallback() {
+ // I want to specify that when hasCallback(Callback) method is called, the framework
+ // should immediately call on the captured callback.
+ doAnswer(new CallCapturedCallbackCallable())
+ .when(mBar).getResultLater(mCaptureCallback.capture());
+
+ // The test.
+ mBar.getResultLater(new Callback() {
+ @Override
+ public void callMeNow() {
+ mFoo.add("yes");
+ }
+ });
+
+ verify(mFoo).add("yes");
+ }
+
+ @ShouldThrow(IOException.class)
+ public void testDoAction_CanThrowDeclaredException() throws Exception {
+ doAnswer(new Callable<Void>() {
+ @Override
+ public Void call() throws Exception {
+ throw new IOException("Problem");
+ }
+ }).when(mFoo).exceptionThrower();
+ mFoo.exceptionThrower();
+ }
+
+ @ShouldThrow(RuntimeException.class)
+ public void testDoAction_CanThrowUndelcaredException() {
+ doAnswer(new Callable<Void>() {
+ @Override
+ public Void call() throws Exception {
+ throw new RuntimeException("Problem");
+ }
+ }).when(mFoo).aBoolean();
+ mFoo.aBoolean();
+ }
+
+ public void testRunThisIsAnAliasForDoAction() {
+ doAnswer(new Callable<Boolean>() {
+ @Override
+ public Boolean call() throws Exception {
+ return Boolean.TRUE;
+ }
+ }).when(mFoo).aBoolean();
+ assertEquals(true, mFoo.aBoolean());
+ }
+
+ public void testVerifyingTwice() {
+ // Behaviour from Mockito docs online seems to be undefined for what should happen if you
+ // try to verify the same behaviour twice.
+ // I'm going to make a call on this one until I have more concrete information, and my
+ // call is that it is okay to verify the same thing twice - a verify doesn't "consume"
+ // the other verifications.
+ // Thus this will pass:
+ mFoo.aByte();
+ verify(mFoo).aByte();
+ verify(mFoo).aByte();
+ }
+
+ public void testVerifyNoMoreInteractions_SuccessWhenNoInteractions() {
+ // Not absolutely certain how this is supposed to behave.
+ // My guess is that every verify "tags" all the methods it verifies against.
+ // Then verifyNoMoreInteractions() will pass only if there are no "untagged" method calls.
+ // Thus, for a start, no interactions will pass.
+ verifyNoMoreInteractions(mFoo, mBar);
+ }
+
+ public void testVerifyNoMoreInteractions_SuccessWhenOneActionWasVerified() {
+ mFoo.aBoolean();
+ verify(mFoo).aBoolean();
+ verifyNoMoreInteractions(mFoo, mBar);
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyNoMoreInteractions_FailsWhenOneActionWasNotVerified() {
+ mFoo.aBoolean();
+ verifyNoMoreInteractions(mFoo, mBar);
+ }
+
+ public void testVerifyNoMoreInteractions_SucceedsWhenAllActionsWereVerified() {
+ mFoo.get(3);
+ mFoo.get(20);
+ verify(mFoo, atLeastOnce()).get(anyInt());
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testVerifyNoMoreInteractions_FailsWhenMostButNotAllActionsWereVerified() {
+ mFoo.get(3);
+ mFoo.get(20);
+ mFoo.aByte();
+ verify(mFoo, atLeastOnce()).get(anyInt());
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ public void testVerifyNoMoreInteractions_ShouldIngoreStubbedCalls() {
+ doReturn("hi").when(mFoo).get(8);
+ mFoo.get(8);
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testMatchers_WrongNumberOfMatchersOnStubbingCausesError() {
+ doReturn("hi").when(mBar).twoStrings("jim", eq("bob"));
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testMatchers_WrongNumberOfMatchersOnVerifyCausesError() {
+ verify(mBar).twoStrings("jim", eq("bob"));
+ }
+
+ @ShouldThrow(IllegalStateException.class)
+ public void testCreateACaptureButDontUseItShouldFailAtNextVerify() {
+ // If we create a capture illegally, outside of a method call, like so:
+ mCaptureString.capture();
+ // Then we will have illegally created an extra matcher object that we shouldn't have
+ // created that is now sitting on the stack, and that will confuse the next true method
+ // call on the mock object.
+ // Thus we should check in the verify() method that there are *no matchers* on the static
+ // list, as this would indicate a programming error such as the above.
+ verify(mFoo, anyTimes()).aBoolean();
+ }
+
+ @ShouldThrow(IllegalStateException.class)
+ public void testCreateACaptureButDontUseItShouldFailAtNextVerify_AlsoNoMoreInteractions() {
+ // Same result desired as in previous test.
+ mCaptureString.capture();
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ @ShouldThrow(IllegalStateException.class)
+ public void testCreateACaptureButDontUseItShouldFailAtNextVerify_AlsoZeroInteraction() {
+ mCaptureString.capture();
+ verifyZeroInteractions(mFoo);
+ }
+
+ @ShouldThrow(IllegalStateException.class)
+ public void testCheckStaticVariablesMethod() {
+ // To help us avoid programming errors, I'm adding a method that you can call from tear down,
+ // which will explode if there is anything still left in your static variables at the end
+ // of the test (so that you know you did something wrong) and that also clears that static
+ // variable (so that the next test won't fail). It should fail if we create a matcher
+ // be it a capture or anything else that is then not consumed.
+ anyInt();
+ checkForProgrammingErrorsDuringTearDown();
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testCantPassNullToVerifyCount() {
+ verify(mFoo, null).aBoolean();
+ }
+
+ public void testInjectionInNestedClasses() throws Exception {
+ class Outer {
+ @Mock protected Foo outerMock;
+ }
+ class Inner extends Outer {
+ @Mock protected Foo innerMock;
+ }
+ Inner inner = new Inner();
+ assertNull(inner.innerMock);
+ assertNull(inner.outerMock);
+ initMocks(inner);
+ assertNotNull(inner.innerMock);
+ assertNotNull(inner.outerMock);
+ }
+
+ public void testIsA_Succeeds() {
+ mFoo.takesObject(new Object());
+ verify(mFoo).takesObject(isA(Object.class));
+ }
+
+ public void testIsA_WithSubclass() {
+ mFoo.takesObject("hello");
+ verify(mFoo).takesObject(isA(Object.class));
+ verify(mFoo).takesObject(isA(String.class));
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testIsA_FailsWithSuperclass() {
+ mFoo.takesObject(new Object());
+ verify(mFoo).takesObject(isA(String.class));
+ }
+
+ public void testIsA_WillAcceptNull() {
+ mFoo.takesObject(null);
+ verify(mFoo).takesObject(isA(Object.class));
+ verify(mFoo).takesObject(isA(String.class));
+ }
+
+ public void testIsA_MatchSubtype() {
+ mFoo.takesBar(mBarSubtype);
+ verify(mFoo).takesBar(isA(BarSubtype.class));
+ }
+
+ @ShouldThrow(AssertionError.class)
+ public void testIsA_MatchSubtypeFailed() {
+ mFoo.takesBar(mBar);
+ verify(mFoo).takesBar(isA(BarSubtype.class));
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot verify call to", "boolean java.lang.Object.equals(java.lang.Object)"})
+ public void testVerifyEquals_ShouldFail() {
+ mFoo.equals(null);
+ verify(mFoo).equals(null);
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot verify call to", "int java.lang.Object.hashCode()"})
+ public void testVerifyHashCode_ShouldFail() {
+ mFoo.hashCode();
+ verify(mFoo).hashCode();
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot verify call to", "java.lang.String java.lang.Object.toString()"})
+ public void testVerifyToString_ShouldFail() {
+ mFoo.toString();
+ verify(mFoo).toString();
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot stub call to", "boolean java.lang.Object.equals(java.lang.Object)"})
+ public void testStubEquals_ShouldFail() {
+ doReturn(false).when(mFoo).equals(null);
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot stub call to", "int java.lang.Object.hashCode()"})
+ public void testStubHashCode_ShouldFail() {
+ doReturn(0).when(mFoo).hashCode();
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = {"cannot stub call to", "java.lang.String java.lang.Object.toString()"})
+ public void testStubToString_ShouldFail() {
+ doReturn("party").when(mFoo).toString();
+ }
+
+ public void testEqualsMethod_DoesntCountAsInteraction() {
+ mFoo.takesBar(mBar);
+ verify(mFoo).takesBar(mBar);
+ verifyNoMoreInteractions(mBar);
+ }
+
+ public void testHashCodeMethod_DoesntCountAsInteraction() {
+ mFoo.hashCode();
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ public void testToStringMethod_DoesntCountAsInteraction() {
+ mFoo.toString();
+ verifyNoMoreInteractions(mFoo);
+ }
+
+ public void testEquals_OnMock() {
+ assertTrue(mFoo.equals(mFoo));
+ }
+
+ public void testHashCode_OnMock() {
+ // The hashCode() is checked against zero, the default int value, to make sure it is actually
+ // being treated differently.
+ // It is possible for a hashCode() to be zero, but very unlikely.
+ assertNotSame(0, mFoo.hashCode());
+ }
+
+ public void testToString_OnMock() {
+ assertTrue(mFoo.toString().contains(Foo.class.getName()));
+ }
+
+ public void testErrorMessages_NoArgMethodAndNoInteractions() {
+ /* I would like the error message to look like this:
+ * Expected exactly 2 calls to:
+ * mFoo.aBoolean()
+ * at the.line.where.the.verify.happened:xxx
+ *
+ * No method calls happened to this mock
+ */
+ int verifyLineNumber = 0;
+ try {
+ verifyLineNumber = getNextLineNumber();
+ verify(mFoo, times(2)).aBoolean();
+ fail("Should have thrown an assertion error");
+ } catch (AssertionError e) {
+ // Good, verify that the message is exactly as expected.
+ String expectedMessage =
+ "\nExpected exactly 2 calls to:\n"
+ + " mFoo.aBoolean()\n"
+ + " at " + singleLineStackTrace(verifyLineNumber) + "\n"
+ + "\n"
+ + "No method calls happened to this mock\n";
+ assertEquals(expectedMessage, e.getMessage());
+ }
+ }
+
+ public void testErrorMessages_SomeArgsMethodAndSomeInteractions() {
+ /* I would like the error message to look like this:
+ * Expected exactly 1 call to:
+ * mFoo.add(String)
+ * at the.line.where.the.verify.happened:xxx
+ *
+ * Method calls that did happen:
+ * mFoo.aByte()
+ * at the.line.where.the.byte.happened:xxx
+ * mFoo.findByBoolean(boolean)
+ * at the line.where.the.boolean.happened:xxx
+ */
+ int aByteLineNumber = 0;
+ int findByBooleanLineNumber = 0;
+ int verifyLineNumber = 0;
+ try {
+ aByteLineNumber = getNextLineNumber();
+ mFoo.aByte();
+ findByBooleanLineNumber = getNextLineNumber();
+ mFoo.findByBoolean(true);
+ verifyLineNumber = getNextLineNumber();
+ verify(mFoo).add("jim");
+ fail("Should have thrown an assertion error");
+ } catch (AssertionError e) {
+ // Good, verify that the message is exactly as expected.
+ String expectedMessage =
+ "\nExpected exactly 1 call to:\n"
+ + " mFoo.add(String)\n"
+ + " at " + singleLineStackTrace(verifyLineNumber) + "\n"
+ + "\n"
+ + "Method calls that did happen:\n"
+ + " mFoo.aByte()\n"
+ + " at " + singleLineStackTrace(aByteLineNumber) + "\n"
+ + " mFoo.findByBoolean(boolean)\n"
+ + " at " + singleLineStackTrace(findByBooleanLineNumber) + "\n";
+ assertEquals(expectedMessage, e.getMessage());
+ }
+ }
+
+ public void testErrorMessage_DoReturnExplainsWhatWentWrong() {
+ /* I would like the error message to look like this:
+ * Can't return Long from stub for:
+ * (int) mFoo.anInt()
+ * at the.line.where.the.assignment.happened:xxx
+ */
+ int lineNumber = 0;
+ try {
+ lineNumber = getNextLineNumber();
+ doReturn(10L).when(mFoo).anInt();
+ fail("Should have thrown an IllegalArgumentException");
+ } catch (IllegalArgumentException e) {
+ // Good, expected, verify the message.
+ String expectedMessage =
+ "\nCan't return Long from stub for:\n"
+ + " (int) mFoo.anInt()\n"
+ + " at " + singleLineStackTrace(lineNumber) + "\n";
+ assertEquals(expectedMessage, e.getMessage());
+ }
+ }
+
+ public void testErrorMessage_DoReturnAlsoHasGoodErrorMessageForVoidMethods() {
+ /* I would like the error message to look like this:
+ * Can't return String from stub for:
+ * (void) mFoo.add(String)
+ * at the.line.where.the.assignment.happened:xxx
+ */
+ int lineNumber = 0;
+ try {
+ lineNumber = getNextLineNumber();
+ doReturn("hello").when(mFoo).add("jim");
+ fail("Should have thrown an IllegalArgumentException");
+ } catch (IllegalArgumentException e) {
+ // Good, expected, verify the message.
+ String expectedMessage =
+ "\nCan't return String from stub for:\n"
+ + " (void) mFoo.add(String)\n"
+ + " at " + singleLineStackTrace(lineNumber) + "\n";
+ assertEquals(expectedMessage, e.getMessage());
+ }
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturn_ThisShouldFailSinceDoubleIsNotAString() {
+ doReturn("hello").when(mFoo).aDouble();
+ }
+
+ public void testDoReturn_ThisShouldPassSinceStringCanBeReturnedFromObjectMethod() {
+ doReturn("hello").when(mFoo).anObject();
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturn_ThisShouldFailSinceObjectCantBeReturnedFromString() {
+ doReturn(new Object()).when(mFoo).aString();
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturn_ThisShouldFailSinceBarIsNotSubtypeOfBarSubtype() {
+ doReturn(mBar).when(mFoo).aBarSubtype();
+ }
+
+ public void testDoReturn_ThisShouldPassSinceBarSubTypeIsABar() {
+ doReturn(mBarSubtype).when(mFoo).aBar();
+ }
+
+ // TODO(hugohudson): 7. Should fix this.
+// @ShouldThrow(IllegalArgumentException.class)
+ public void testDoReturn_ThisShouldFailBecauseNullIsNotAByte() {
+ doReturn(null).when(mFoo).aByte();
+ }
+
+ // TODO(hugohudson): 7. Should fix this.
+ // Once we fix the previous test we won't need this one.
+ // I'm just demonstrating that currently this fails with NPE at use-time not at stub-time.
+ @ShouldThrow(NullPointerException.class)
+ public void testDoReturn_ThisShouldFailBecauseNullIsNotAByte2() {
+ doReturn(null).when(mFoo).aByte();
+ mFoo.aByte();
+ }
+
+ public void testDoReturn_ThisShouldPassSinceNullIsAnObject() {
+ doReturn(null).when(mFoo).anObject();
+ }
+
+ // TODO(hugohudson): 7. Should fix this.
+ // At present we aren't catching this, and would have difficulty doing so since we don't know
+ // the type of the callable.
+// @ShouldThrow(IllegalArgumentException.class)
+ public void testDoAnswer_ThisShouldFailSinceStringIsNotAByte() {
+ doAnswer(new Callable<String>() {
+ @Override public String call() throws Exception { return "hi"; }
+ }).when(mFoo).aByte();
+ }
+
+ // TODO(hugohudson): 7. Should fix this to give proper message.
+ // We could at least give a good message saying why you get failure - saying that your string
+ // is not a byte, and pointing to where you stubbed it.
+ @ShouldThrow(ClassCastException.class)
+ public void testDoAnswer_ThisShouldFailSinceStringIsNotAByte2() {
+ doAnswer(new Callable<String>() {
+ @Override public String call() throws Exception { return "hi"; }
+ }).when(mFoo).aByte();
+ mFoo.aByte();
+ }
+
+ @ShouldThrow(value = IllegalArgumentException.class,
+ messages = { " (Bar) mFoo.aBar()" })
+ public void testDoAnswer_ShouldHaveSimpleNameOnReturnValue() {
+ doReturn("hi").when(mFoo).aBar();
+ }
+
+ @ShouldThrow(IllegalArgumentException.class)
+ public void testCantCreateMockOfNullType() {
+ mock(null);
+ }
+
+ @ShouldThrow(value = AssertionError.class,
+ messages = { "Expected exactly 1 call to:", "onClickListener.onClick(Bar)" })
+ public void testCreateMockWithNullFieldName() {
+ OnClickListener mockClickListener = mock(OnClickListener.class);
+ verify(mockClickListener).onClick(null);
+ }
+
+ public void testDoubleVerifyNoProblems() {
+ // Reusing a mock after a verify should be fine.
+ // There was a bug with this, let's check it doesn't regress.
+ mFoo.aBar();
+ verify(mFoo).aBar();
+
+ mFoo.aByte();
+ verify(mFoo).aByte();
+ }
+
+ // TODO(hugohudson): 5. Every @ShouldThrow method should be improved by adding test for the
+ // content of the error message. First augment the annotation to take a String which must
+ // form a substring of the getMessage() for the Exception, then check that the exceptions
+ // thrown are as informative as possible.
+
+ // TODO(hugohudson): 5. Add InOrder class, so that we can check that the given methods on
+ // the given mocks happen in the right order. It will be pretty easy to do. The syntax
+ // looks like this:
+ // InOrder inOrder = inOrder(firstMock, secondMock);
+ // inOrder.verify(firstMock).firstMethod();
+ // inOrder.verify(secondMock).secondMethod();
+ // This allows us to verify that the calls happened in the desired order.
+ // By far the simplest way to do this is have a static AtomicInteger on the class which
+ // indicates exactly when every method call happened, and then just compare order based on
+ // that.
+
+ // TODO(hugohudson): 5. Make the doReturn() method take variable arguments.
+ // The syntax is:
+ // doReturn(1, 2, 3).when(mFoo).anInt();
+ // And of course means that the method returns 1 the first time, 2, the second and 3 the third.
+ // Note that this doesn't imply verification, and I presume that the 3 is always returned for
+ // the 4th and subsequent times.
+
+ // TODO(hugohudson): 6. Could also offer a nicer syntax for multiple returns like this:
+ // How about doReturn().thenThrow().thenReturn().when(mFoo).aDouble();
+
+ // TODO(hugohudson): 5. Get around to implementing Mockito's when() syntax.
+ // I don't really like it, because it means a lot more static nonsense, with yet more
+ // opportunities to shoot oneself in the foot.
+ // Plus, where's the upside in more than one way to do the same thing - it just gets confusing.
+ // But, I imagine that plenty of people who are familiar with Mockito will want this, so I
+ // probably should do it, plus there's a good argument that it allows typechecking of the
+ // method calls, so I guess we probably should. Looks like this:
+ // when(mock.foo(0)).thenReturn(1);
+ // when(mock.foo(1)).thenThrow(new RuntimeException)
+ // when(mock.foo(anyInt())).thenReturn("bar")
+ // when(mock.foo(argThat(isValid()))).thenReturn("element")
+ // when(mock.someMethod("some arg")).thenThrow(new RuntimeException()).thenReturn("foo");
+ // when(mock.someMethod("some arg")).thenReturn("one", "two", "three");
+ // when(mock.someMethod(anyString())).thenAnswer(new Answer() {
+ // @Override
+ // Object answer(InvocationOnMock invocation) {
+ // Object[] args = invocation.getArguments();
+ // Object mock = invocation.getMock();
+ // return "called with arguments: " + args;
+ // }
+ // }
+
+ // TODO(hugohudson): 6. Again we can chain things like doNothing() then doThrow() I suppose.
+ // doNothing().doThrow(new RuntimeException()).when(mock).someVoidMethod();
+
+ // TODO(hugohudson): 6. I really like the idea of implementing the Spy, which is a wrapper on
+ // a real object and delegates all calls to that real object, but allows you to intercept
+ // the ones that you want to.
+ // Sounds like it will be particularly good for testing legacy code.
+ // But also wouldn't be so much use without us being able to mock concrete classes, which I
+ // imagine is not on the cards for a while yet.
+
+ // TODO(hugohudson): 6. Could possibly look into more aliases for the common methods, so that
+ // you can do the 'given... when... assertThat...' pattern as follows:
+ // //given
+ // given(seller.askForBread()).willReturn(new Bread());
+ // //when
+ // Goods goods = shop.buyBread();
+ // //then
+ // assertThat(goods, containBread());
+
+ // TODO(hugohudson): 6. How about timeouts that are mentioned in Mockito docs?
+ // Sounds like a good idea. Would look like this:
+ // verify(mFoo, within(50).milliseconds()).get(0);
+
+ // TODO(hugohudson): 6. Consider bringing back in the async code I wrote for the AndroidMock
+ // framework so that you can expect to wait for the method call.
+ // Although obviously we're more keen on encouraging people to write unit tests that don't
+ // require async behaviour in the first place.
+
+ /** Returns the line number of the line following the method call. */
+ private int getNextLineNumber() {
+ return new Exception().getStackTrace()[1].getLineNumber() + 1;
+ }
+
+ /** Returns a string like: "com.google.foo.TestFoo.testMethod(TestFoo:50)" */
+ private String singleLineStackTrace(int lineNumber) {
+ return getClass().getName() + "." + getName() + "(" + getClass().getSimpleName() +
+ ".java:" + lineNumber + ")";
+ }
+
+ /** Simple callable that invokes the callback captured in the callback member variable. */
+ private class CallCapturedCallbackCallable implements Callable<Object> {
+ @Override
+ public Object call() {
+ mCaptureCallback.getValue().callMeNow();
+ return null;
+ }
+ }
+
+ private Foo createNotARealMock() {
+ InvocationHandler handler = new InvocationHandler() {
+ @Override
+ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
+ return null;
+ }
+ };
+ Foo notARealMock = (Foo) Proxy.newProxyInstance(
+ getClass().getClassLoader(), new Class<?>[]{ Foo.class }, handler);
+ assertNotNull(notARealMock);
+ return notARealMock;
+ }
+
+ private static Callback createNoOpCallback() {
+ return new Callback() {
+ @Override
+ public void callMeNow() {
+ }
+ };
+ }
+}
