Mock file download

[marcin-brzozowski]

Hi,

I've been going through the Internet and cannot find an example of how to configure Microcks to e.g. mock file download with some dummy data. I have hosted sample file via Nginx server that is accessible to Microcks via http://contracts-repository:8081.

I run Microcks inside docker. When I try to download the sample.zip file from inside the Microcks container (e.g. curl -X GET http://contracts-repository:8081/sample.zip) then it works perfectly fine. So Microcks has access to this resource.

Microcks version: 1.6.1

Below, you can find a sample OpenAPI document that I use:

openapi: 3.0.0
info:
  title: CSV Download API
  version: 1.0.0
paths:
  /data.zip:
    get:
      summary: Download ZIP data
      responses:
        '200':
          description: OK
          content:
            application/zip:
              schema:
                type: string
                format: binary
              examples:
                hello_world:
                  externalValue: http://contracts-repository:8081/sample.zip
          headers:
            Content-Disposition:
              schema:
                type: string
                description: Used only with `application/zip` responses
                example: attachment; filename="sample.zip"

However, when I try to download the file from my mock endpoint, I get the the following Exception in Microcks:

microcks                | 12:38:14.318  INFO 1 --- [080-exec-3] i.github.microcks.web.RestController     : Servicing mock response for service [CSV+Download+API, 1.0.0] on uri /rest/CSV+Download+API/1.0.0/data.zip with verb GET
microcks                | 12:38:14.318 DEBUG 1 --- [080-exec-3] i.github.microcks.web.RestController     : Request body: null
microcks                | 12:38:14.324 DEBUG 1 --- [080-exec-3] i.github.microcks.web.RestController     : Found resourcePath: /data.zip
microcks                | 12:38:14.335 DEBUG 1 --- [080-exec-3] i.github.microcks.web.RestController     : Found a valid operation GET /data.zip with rules: null
microcks                | 12:38:14.336 DEBUG 1 --- [080-exec-3] i.github.microcks.web.RestController     : Dispatch criteria for finding response is null
microcks                | 12:38:14.346 ERROR 1 --- [080-exec-3] o.a.c.c.C.[.[.[.[dispatcherServlet]      : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing 
failed; nested exception is java.lang.NullPointerException] with root cause
microcks                |
microcks                | java.lang.NullPointerException: null
microcks                |       at io.github.microcks.web.MockControllerCommons.renderResponseContent(MockControllerCommons.java:127)
microcks                |       at io.github.microcks.web.RestController.execute(RestController.java:246)
microcks                |       at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
microcks                |       at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
microcks                |       at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
microcks                |       at java.base/java.lang.reflect.Method.invoke(Method.java:566)
microcks                |       at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
microcks                |       at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150)
microcks                |       at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)
microcks                |       at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
microcks                |       at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
microcks                |       at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
microcks                |       at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)
microcks                |       at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)
microcks                |       at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
microcks                |       at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)
microcks                |       at javax.servlet.http.HttpServlet.service(HttpServlet.java:655)
microcks                |       at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
microcks                |       at javax.servlet.http.HttpServlet.service(HttpServlet.java:764)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
microcks                |       at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
microcks                |       at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter.doFilterInternal(WebMvcMetricsFilter.java:96)
microcks                |       at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
microcks                |       at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
microcks                |       at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
microcks                |       at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197)
microcks                |       at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)
microcks                |       at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
microcks                |       at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135)
microcks                |       at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
microcks                |       at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)
microcks                |       at org.apache.catalina.valves.RemoteIpValve.invoke(RemoteIpValve.java:769)
microcks                |       at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:360)
microcks                |       at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)
microcks                |       at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
microcks                |       at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:890)
microcks                |       at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1743)
microcks                |       at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
microcks                |       at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
microcks                |       at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
microcks                |       at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
microcks                |       at java.base/java.lang.Thread.run(Thread.java:829)

[lbroudoux]

Hey @marcin-brzozowski,

Sorry for the delay in this response (was very busy those last weeks). Currently, we do not support externalValue fetching in examples. If you find any way to represent this within a value attribute this should work. However, we may plan a new feature request for that.

Let me know.

[marcin-brzozowski]

Thank you @lbroudoux for the response, I appreciate you found some time amongst all the work stuff 😄

I think that this would be an useful feature, enabling certain scenarios. How would we go about creating a feature request for this one? Shall I create a new issue or will you handle that? Please let me know.

Best regards,
Marcin

[lbroudoux]

It would be awesome if you could create the issue, describing your goal and usage context with the most details possible. Having a user implies as the issue creator also helps us when looking for someone to test and validate the feature 😉

Thanks a lot!