How to mock a static method from JMockit

Question

I have a static method which will be invoking from test method in a class as bellow

public class MyClass
{
   private static boolean mockMethod( String input )
    {
       boolean value;
       //do something to value
       return value; 
    }

    public static boolean methodToTest()
    {
       boolean getVal = mockMethod( "input" );
       //do something to getVal
       return getVal; 
    }
}

I want to write a test case for method methodToTest by mocking mockMethod. Tried as bellow and it doesn't give any output

@Before
public void init()
{
    Mockit.setUpMock( MyClass.class, MyClassMocked.class );
}

public static class MyClassMocked extends MockUp<MyClass>
{
    @Mock
    private static boolean mockMethod( String input )
    {
        return true;
    }
}

@Test
public void testMethodToTest()
{
    assertTrue( ( MyClass.methodToTest() );
}

score 37 · Answer 1 · answered Oct 21 '14 at 17:14

37

To mock your static method:

new MockUp<MyClass>()
{
    @Mock
    boolean mockMethod( String input ) // no access modifier required
    {
        return true; 
    }
};

answered Oct 21 '14 at 17:14

jimmygchen

785
4
8

2

How do you verify the call? – PCH Jul 08 '20 at 20:20

score 9 · Answer 2 · edited Jun 16 '16 at 20:12

To mock the static private method:

@Mocked({"mockMethod"})
MyClass myClass;

String result;

@Before
public void init()
{
    new Expectations(myClass)
    {
        {
            invoke(MyClass.class, "mockMethod", anyString);
            returns(result);
        }
    }
}

@Test
public void testMethodToTest()
{
    result = "true"; // Replace result with what you want to test...
    assertTrue( ( MyClass.methodToTest() );
}

From JavaDoc:

Object mockit.Invocations.invoke(Class methodOwner, String methodName, Object... methodArgs)

Specifies an expected invocation to a given static method, with a given list of arguments.

Since the imports are missing here: I guess the invoke() method ist a static import of Deencapsulation.invoke(). In case anyone else wonders at first... — Ruik, Feb 05 '19 at 15:53

Eugene Maysyuk · Answer 3 · 2023-03-18T12:13:38.320

There is another way of mocking static methods using JMockit (using Delegate class). I find it more convenient and elegant.

public class Service {
  public String addSuffix(String str) { // method to be tested
    return Utils.staticMethod(str);
  }
}

public class Utils {
  public static String staticMethod(String s) { // method to be mocked
    String suffix = DatabaseManager.findSuffix("default_suffix");
    return s.concat(suffix);
  }
}

public class Test {

  @Tested
  Service service;

  @Mocked
  Utils utils; // @Mocked will make sure all methods will be mocked (including static methods)

  @Test
  public void test() {
    new Expectations() {{
      Utils.staticMethod(anyString); times = 1; result = new Delegate() {
        public String staticMethod(String s) { // should have the same signature (method name and parameters) as Utils#staticMethod
          return ""; // provide custom implementation for your Utils#staticMethod
        }
      }
    }}
    
    service.addSuffix("test_value");

    new Verifications() {{
      String s;
      Utils.staticMethod(s = withCapture()); times = 1;
      assertEquals("test_value", s); // assert that Service#addSuffix propagated "test_value" to Utils#staticMethod
    }}
  }
}

Reference:

https://jmockit.github.io/tutorial/Mocking.html#delegates https://jmockit.github.io/tutorial/Mocking.html#withCapture

Looks elegant, and I personally think it can be improved further. The mocked `utils` can be moved to the parameter of the test methods. Benefits are the mocked methods only take effect within the test methods that injected the mocked parameter. — Kevin Yue, Oct 20 '22 at 02:03
This code doesn't seem to work. There needs to be parenthesis after Expectations for the constructor. new Expectations() {{ instead of new Expectations {{. Also you can't declare a static method at that level. — Walter D, Mar 17 '23 at 02:05
@WalterD I adjusted the code. Indeed "static" is non needed inside of Delegate. Should work now. — Eugene Maysyuk, Mar 18 '23 at 12:15

How to mock a static method from JMockit

3 Answers3

Linked

Related