add help documentation regarding module limitations of mocking

JamesDawson · Oct 29, 2012 · 3235727 · 3235727
1 parent 6c4b25e
commit 3235727
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/Functions/Mock.ps1 b/Functions/Mock.ps1
@@ -31,6 +31,12 @@ used to check if all Verifiable mocks were actually called. If any
 verifiable mock is not called, Assert-VerifiableMocks will throw an 
 exception and indicate all mocks not called.
 
+The SUT (code being tested) that calls the actual commands that you have 
+mocked must not be executing from inside a module. Otherwise, the mocked 
+commands will not be invoked and the real commands will run. The SUT must 
+be in the same Script scope as the test. So it must be either dot sourced, 
+in the same file, or in a script file.
+
 .PARAMETER CommandName
 The name of the command to be mocked.
 

diff --git a/en-US/about_Mocking.help.txt b/en-US/about_Mocking.help.txt
@@ -70,6 +70,13 @@ EXAMPLE
         }
     }
 
+LIMITATIONS
+	The SUT (code being tested) that calls the actual commands that you have 
+	mocked must not be executing from inside a module. Otherwise, the mocked 
+	commands will not be invoked and the real commands will run. The SUT must 
+	be in the same Script scope as the test. So it must be either dot sourced, 
+	in the same file, or in a script file.
+
 SEE ALSO
 	Mock
 	Assert-VerifiableMocks