Skip to content

[JAVA][Rest-assured] Added constants #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Aug 1, 2018
Merged

[JAVA][Rest-assured] Added constants #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class {{classname}} {
* @see #{{#isPathParam}}{{paramName}}Path{{/isPathParam}}{{#isQueryParam}}{{paramName}}Query{{/isQueryParam}}{{#isFormParam}}{{^isFile}}{{paramName}}Form{{/isFile}}{{#isFile}}{{paramName}}MultiPart{{/isFile}}{{/isFormParam}}{{#isHeaderParam}}{{paramName}}Header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
{{/allParams}}
{{#returnType}}
* return {{returnType}}
* return {{{returnType}}}
{{/returnType}}
{{#isDeprecated}}
* @deprecated
Expand All @@ -85,7 +85,9 @@ public class {{classname}} {
{{/isDeprecated}}
public class {{operationIdCamelCase}}Oper {

public static final String REQ_METHOD = "{{httpMethod}}";
public static final String REQ_URI = "{{path}}";
public static final String SUMMARY = "{{{summary}}}";
Copy link
Copy Markdown
Member

@wing328 wing328 Jul 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@viclovsky what's the use case for this constant storing the summary (which is included in the javadoc string above)?

Copy link
Copy Markdown
Contributor Author

@viclovsky viclovsky Jul 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Constants are necessary to fill report.
Rest-assured is mostly client for testing. Tests often has integration with test report (such as Allure). Test report has detailed information about tests run results, curl arguments, command line etc.

Copy link
Copy Markdown
Member

@wing328 wing328 Jul 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@viclovsky thanks for the explanation 👍

Copy link
Copy Markdown
Contributor Author

@viclovsky viclovsky Jul 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also intended to do the same with tags, but I haven't found easy way to do it.


private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -131,7 +133,7 @@ public class {{classname}} {
/**
* {{httpMethod}} {{path}}
* @param handler handler
* @return {{returnType}}
* @return {{{returnType}}}
*/
public {{{returnType}}} executeAs(Function<Response, Response> handler) {
Type type = new TypeToken<{{{returnType}}}>(){}.getType();
Expand All @@ -141,7 +143,7 @@ public class {{classname}} {
{{#bodyParams}}

/**
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) {
Expand All @@ -154,7 +156,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_HEADER = "{{baseName}}";

/**
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) {
Expand All @@ -167,7 +169,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_PATH = "{{baseName}}";

/**
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) {
Expand All @@ -180,7 +182,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_QUERY = "{{baseName}}";

/**
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) {
Expand All @@ -194,7 +196,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_FORM = "{{baseName}}";

/**
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) {
Expand All @@ -209,7 +211,7 @@ public class {{classname}} {
/**
* It will assume that the control name is file and the &lt;content-type&gt; is &lt;application/octet-stream&gt;
* @see #reqSpec for customise
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) {
Expand Down
2 changes: 2 additions & 0 deletions .../petstore/java/rest-assured/src/main/java/org/openapitools/client/api/AnotherFakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ public AnotherFakeApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
*/
public class TestSpecialTagsOper {

public static final String REQ_METHOD = "PATCH";
public static final String REQ_URI = "/another-fake/dummy";
public static final String SUMMARY = "To test special tags";

private RequestSpecBuilder reqSpec;

Expand Down
30 changes: 26 additions & 4 deletions .../client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ public FakeApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
*/
public class FakeOuterBooleanSerializeOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/outer/boolean";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -195,7 +197,9 @@ public FakeOuterBooleanSerializeOper respSpec(Consumer<ResponseSpecBuilder> cons
*/
public class FakeOuterCompositeSerializeOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/outer/composite";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -273,7 +277,9 @@ public FakeOuterCompositeSerializeOper respSpec(Consumer<ResponseSpecBuilder> co
*/
public class FakeOuterNumberSerializeOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/outer/number";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -351,7 +357,9 @@ public FakeOuterNumberSerializeOper respSpec(Consumer<ResponseSpecBuilder> consu
*/
public class FakeOuterStringSerializeOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/outer/string";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -428,7 +436,9 @@ public FakeOuterStringSerializeOper respSpec(Consumer<ResponseSpecBuilder> consu
*/
public class TestBodyWithFileSchemaOper {

public static final String REQ_METHOD = "PUT";
public static final String REQ_URI = "/fake/body-with-file-schema";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -496,7 +506,9 @@ public TestBodyWithFileSchemaOper respSpec(Consumer<ResponseSpecBuilder> consume
*/
public class TestBodyWithQueryParamsOper {

public static final String REQ_METHOD = "PUT";
public static final String REQ_URI = "/fake/body-with-query-params";
public static final String SUMMARY = "";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -575,7 +587,9 @@ public TestBodyWithQueryParamsOper respSpec(Consumer<ResponseSpecBuilder> consum
*/
public class TestClientModelOper {

public static final String REQ_METHOD = "PATCH";
public static final String REQ_URI = "/fake";
public static final String SUMMARY = "To test \"client\" model";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -665,7 +679,9 @@ public TestClientModelOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class TestEndpointParametersOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake";
public static final String SUMMARY = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -884,7 +900,9 @@ public TestEndpointParametersOper respSpec(Consumer<ResponseSpecBuilder> consume
*/
public class TestEnumParametersOper {

public static final String REQ_METHOD = "GET";
public static final String REQ_URI = "/fake";
public static final String SUMMARY = "To test enum parameters";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -917,7 +935,7 @@ public <T> T execute(Function<Response, T> handler) {
public static final String ENUM_HEADER_STRING_ARRAY_HEADER = "enum_header_string_array";

/**
* @param enumHeaderStringArray (List&lt;String&gt;) Header parameter enum test (string array) (optional)
* @param enumHeaderStringArray (List<String>) Header parameter enum test (string array) (optional)
* @return operation
*/
public TestEnumParametersOper enumHeaderStringArrayHeader(String enumHeaderStringArray) {
Expand All @@ -939,7 +957,7 @@ public TestEnumParametersOper enumHeaderStringHeader(String enumHeaderString) {
public static final String ENUM_QUERY_STRING_ARRAY_QUERY = "enum_query_string_array";

/**
* @param enumQueryStringArray (List&lt;String&gt;) Query parameter enum test (string array) (optional)
* @param enumQueryStringArray (List<String>) Query parameter enum test (string array) (optional)
* @return operation
*/
public TestEnumParametersOper enumQueryStringArrayQuery(Object... enumQueryStringArray) {
Expand Down Expand Up @@ -983,7 +1001,7 @@ public TestEnumParametersOper enumQueryDoubleQuery(Object... enumQueryDouble) {
public static final String ENUM_FORM_STRING_ARRAY_FORM = "enum_form_string_array";

/**
* @param enumFormStringArray (List&lt;String&gt;) Form parameter enum test (string array) (optional, default to $)
* @param enumFormStringArray (List<String>) Form parameter enum test (string array) (optional, default to $)
* @return operation
*/
public TestEnumParametersOper enumFormStringArrayForm(Object... enumFormStringArray) {
Expand Down Expand Up @@ -1030,7 +1048,9 @@ public TestEnumParametersOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class TestInlineAdditionalPropertiesOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/inline-additionalProperties";
public static final String SUMMARY = "test inline additionalProperties";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -1061,7 +1081,7 @@ public <T> T execute(Function<Response, T> handler) {
}

/**
* @param requestBody (Map&lt;String, String&gt;) request body (required)
* @param requestBody (Map<String, String>) request body (required)
* @return operation
*/
public TestInlineAdditionalPropertiesOper body(Map<String, String> requestBody) {
Expand Down Expand Up @@ -1098,7 +1118,9 @@ public TestInlineAdditionalPropertiesOper respSpec(Consumer<ResponseSpecBuilder>
*/
public class TestJsonFormDataOper {

public static final String REQ_METHOD = "GET";
public static final String REQ_URI = "/fake/jsonFormData";
public static final String SUMMARY = "test json serialization of form data";

private RequestSpecBuilder reqSpec;

Expand Down
2 changes: 2 additions & 0 deletions .../java/rest-assured/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ public FakeClassnameTags123Api reqSpec(Consumer<RequestSpecBuilder> consumer) {
*/
public class TestClassnameOper {

public static final String REQ_METHOD = "PATCH";
public static final String REQ_URI = "/fake_classname_test";
public static final String SUMMARY = "To test class name in snake case";

private RequestSpecBuilder reqSpec;

Expand Down
30 changes: 24 additions & 6 deletions ...s/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/PetApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,9 @@ public PetApi reqSpec(Consumer<RequestSpecBuilder> consumer) {
*/
public class AddPetOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/pet";
public static final String SUMMARY = "Add a new pet to the store";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -172,7 +174,9 @@ public AddPetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class DeletePetOper {

public static final String REQ_METHOD = "DELETE";
public static final String REQ_URI = "/pet/{petId}";
public static final String SUMMARY = "Deletes a pet";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -247,11 +251,13 @@ public DeletePetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
* Multiple status values can be provided with comma separated strings
*
* @see #statusQuery Status values that need to be considered for filter (required)
* return List&lt;Pet&gt;
* return List<Pet>
*/
public class FindPetsByStatusOper {

public static final String REQ_METHOD = "GET";
public static final String REQ_URI = "/pet/findByStatus";
public static final String SUMMARY = "Finds Pets by status";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -282,7 +288,7 @@ public <T> T execute(Function<Response, T> handler) {
/**
* GET /pet/findByStatus
* @param handler handler
* @return List&lt;Pet&gt;
* @return List<Pet>
*/
public List<Pet> executeAs(Function<Response, Response> handler) {
Type type = new TypeToken<List<Pet>>(){}.getType();
Expand All @@ -292,7 +298,7 @@ public List<Pet> executeAs(Function<Response, Response> handler) {
public static final String STATUS_QUERY = "status";

/**
* @param status (List&lt;String&gt;) Status values that need to be considered for filter (required)
* @param status (List<String>) Status values that need to be considered for filter (required)
* @return operation
*/
public FindPetsByStatusOper statusQuery(Object... status) {
Expand Down Expand Up @@ -325,13 +331,15 @@ public FindPetsByStatusOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
*
* @see #tagsQuery Tags to filter by (required)
* return List&lt;Pet&gt;
* return List<Pet>
* @deprecated
*/
@Deprecated
public class FindPetsByTagsOper {

public static final String REQ_METHOD = "GET";
public static final String REQ_URI = "/pet/findByTags";
public static final String SUMMARY = "Finds Pets by tags";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -362,7 +370,7 @@ public <T> T execute(Function<Response, T> handler) {
/**
* GET /pet/findByTags
* @param handler handler
* @return List&lt;Pet&gt;
* @return List<Pet>
*/
public List<Pet> executeAs(Function<Response, Response> handler) {
Type type = new TypeToken<List<Pet>>(){}.getType();
Expand All @@ -372,7 +380,7 @@ public List<Pet> executeAs(Function<Response, Response> handler) {
public static final String TAGS_QUERY = "tags";

/**
* @param tags (List&lt;String&gt;) Tags to filter by (required)
* @param tags (List<String>) Tags to filter by (required)
* @return operation
*/
public FindPetsByTagsOper tagsQuery(Object... tags) {
Expand Down Expand Up @@ -409,7 +417,9 @@ public FindPetsByTagsOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class GetPetByIdOper {

public static final String REQ_METHOD = "GET";
public static final String REQ_URI = "/pet/{petId}";
public static final String SUMMARY = "Find pet by ID";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -486,7 +496,9 @@ public GetPetByIdOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class UpdatePetOper {

public static final String REQ_METHOD = "PUT";
public static final String REQ_URI = "/pet";
public static final String SUMMARY = "Update an existing pet";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -555,7 +567,9 @@ public UpdatePetOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class UpdatePetWithFormOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/pet/{petId}";
public static final String SUMMARY = "Updates a pet in the store with form data";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -649,7 +663,9 @@ public UpdatePetWithFormOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class UploadFileOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/pet/{petId}/uploadImage";
public static final String SUMMARY = "uploads an image";

private RequestSpecBuilder reqSpec;

Expand Down Expand Up @@ -753,7 +769,9 @@ public UploadFileOper respSpec(Consumer<ResponseSpecBuilder> consumer) {
*/
public class UploadFileWithRequiredFileOper {

public static final String REQ_METHOD = "POST";
public static final String REQ_URI = "/fake/{petId}/uploadImageWithRequiredFile";
public static final String SUMMARY = "uploads an image (required)";

private RequestSpecBuilder reqSpec;

Expand Down
Loading