swagger-api/swagger-codegen

[JaxRsCxfServer] Improvements for generated Unittests and Attachments

Open

#4,513 opened on Jan 6, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: GeneralServer: Javahelp wanted

Description

Description

From #4088:

1.) currently in the tests the api invocations are commented out and thus cannot be compiled. Wouldn't it be good to activate them and run the CI maven build with -DskipTests?

2.) Handling CXF Attachments is not totally intuitive, do you think it makes sense to add an assistance snippet here like this at api_test.mustache (for #isFile):

InputStream mybytesInput = new FileInputStream("....");
org.apache.cxf.jaxrs.ext.multipart.ContentDisposition cd = new org.apache.cxf.jaxrs.ext.multipart.ContentDisposition("attachment;filename=file.txt");
Attachment attachment = new Attachment("file", mybytesInput, cd);

or does that go too far and we should leave with the default Attachment attachment = null;?

Swagger-codegen version

2.2.2-SNAPSHOT

Related issues

#4088 Minor improvements JaxRsCXFServer

Suggest a Fix

Contributor guide

Tech stack
java
Domain
testingtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaMavenSwagger CodegenMustache templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
This issue requests two changes to the JAX RS CXF server code generation: activating commented out test invocations and adding a CXF attachment snippet in api test.mustache. Review the current state of the mustache template (e.g., modules/swagger codegen/src/main/resources/JavaJaxRS/cxf/api test.mustache) and the related issue #4088 for context. Implement both changes, ensuring the tests compile with DskipTests, and add the attachment code snippet as described.