Mocktrofit

Mocking Client for Retrofit

Common Usage

Include the mocktrofit gradle plugin in buildscript

classpath 'io.vokal.gradle:mocktrofit-processor:0.1.2'

Apply the plugin

apply plugin: 'io.vokal.mocktrofit'

Retrofit 2 Usage

Include Mocktrofit

compile 'io.vokal.mock:mocktrofit2:1.0.0'

Use the Client

  OkHttpClient mockClient = OkHttpClient.Builder()
            .addInterceptor(new OkMockInterceptor(ctx, "mocks"))
            .build();

  Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(MockServer.BASE_URL)
            .setClient(mockClient)
            .build();

Retrofit 1 Usage

Include Mocktrofit

compile 'io.vokal.mock:mocktrofit:1.0.0'

Use the Client

  RestAdapter restAdapter = new RestAdapter.Builder()
            .setEndpoint(MockClient.BASE_URL)
            .setClient(new MockClient(getContext(), "mocks"))
            .build();

Notes

If you are unsure what to name your mocks, check the logs. It will include both the expected name and the hash in case the filename is too long for your file system.

Limitations

Mocktrofit utilizes the names of mock files to determine the path and parameters of the request. Due to limitations in the Android Asset system, we need a compile time processor to hash the names such that the name is always a consistent length. Because of this, there are still some unimplemented features that VOKMockUrlProtocol has.

Implemented

• Basic Mocks ending with .http
• Mocks in both App and Test applications will work properly
• Double hashing for long names (Most operating systems have a 255 character limit)

Unimplemented

• .json and .xml file names
• Fallback hashing of body and path