diff --git a/core/pom.xml b/core/pom.xml index de612cc51..8c6275864 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -4,7 +4,7 @@ zerocode-tdd-parent org.jsmart - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT zerocode-tdd @@ -257,7 +257,7 @@ org.apache.maven.plugins maven-gpg-plugin - 1.5 + 3.1.0 sign-artifacts diff --git a/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeAssertionsProcessorImpl.java b/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeAssertionsProcessorImpl.java index e083918fc..8df167c5a 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeAssertionsProcessorImpl.java +++ b/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeAssertionsProcessorImpl.java @@ -79,9 +79,6 @@ import static org.jsmart.zerocode.core.utils.TokenUtils.populateParamMap; import static org.slf4j.LoggerFactory.getLogger; -; -; - public class ZeroCodeAssertionsProcessorImpl implements ZeroCodeAssertionsProcessor { private static final org.slf4j.Logger LOGGER = getLogger(ZeroCodeAssertionsProcessorImpl.class); @@ -385,8 +382,7 @@ public List assertAllAndReturnFailed(List a * First the logic checks if dig-deep needed to avoid unwanted recursions. If not needed, the step definition is * returned intact. Otherwise calls the dig deep method to perform the operation. * - * @param thisStep - * @return The effective step definition + * returns: The effective step definition */ @Override public Step resolveJsonContent(Step thisStep, ScenarioExecutionState scenarioExecutionState) { diff --git a/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java b/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java index 7c899c664..8965f1116 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java +++ b/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java @@ -20,30 +20,29 @@ import static org.slf4j.LoggerFactory.getLogger; /** - *

Parameterized Tests Steps

- *

+ * Parameterized Tests Steps + * * Processes the Step for each line in the parameterized/parameterizedCsv section. - *

- *

+ * * Parameters can be * "parameterized": [ * 200, * "Hello", * true * ] - *

+ * * -or- - *

+ * * "parameterizedCsv": [ * "1, 2, 200", * "11, 22, 400", * "21, 31, 500" * ] - *

+ * * In each the above cases, the step will execute 3 times. - *

+ * * For "parameterized" case, ${0} will resolve to 200, "Hello", true respectively for each run. - *

+ * * For "parameterizedCsv" case, ${0}, ${1}, ${2} will resolve to "1", "2", "200" for the first run. * Then it will resolve to "11", "22", "400" for the 2nd run ans so on. */ diff --git a/core/src/main/java/org/jsmart/zerocode/core/httpclient/BasicHttpClient.java b/core/src/main/java/org/jsmart/zerocode/core/httpclient/BasicHttpClient.java index 8ad27d794..07b603e37 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/httpclient/BasicHttpClient.java +++ b/core/src/main/java/org/jsmart/zerocode/core/httpclient/BasicHttpClient.java @@ -69,7 +69,7 @@ public BasicHttpClient(CloseableHttpClient httpclient) { * - org.jsmart.zerocode.core.httpclient.ssl.CorporateProxyNoSslContextHttpClient#createHttpClient() * } * - * @return CloseableHttpClient + * return CloseableHttpClient * @throws Exception */ public CloseableHttpClient createHttpClient() throws Exception { @@ -100,14 +100,13 @@ public CloseableHttpClient createHttpClient() throws Exception { * Override this method in case you want to execute the http call differently via your http client. * Otherwise the framework falls back to this implementation by default. * - * @param httpUrl : path to end point - * @param methodName : e.g. GET, PUT etc - * @param headers : headers, cookies etc - * @param queryParams : key-value query params after the ? in the url - * @param body : json body + * httpUrl : path to end point + * methodName : e.g. GET, PUT etc + * headers : headers, cookies etc + * queryParams : key-value query params after the ? in the url + * body : json body * - * @return : Http response consists of status code, entity, headers, cookies etc - * @throws Exception + * returns : Http response consists of status code, entity, headers, cookies etc */ public Response execute(String httpUrl, String methodName, @@ -151,9 +150,9 @@ public Response execute(String httpUrl, * Once the client executes the http call, then it receives the http response. This method takes care of handling * that. In case you need to handle it differently you can override this method. * - * @param httpResponse : Received Apache http response from the server + * httpResponse : Received Apache http response from the server * - * @return : Effective response with handled http session. + * : Effective response with handled http session. * @throws IOException */ public Response handleResponse(CloseableHttpResponse httpResponse) throws IOException { @@ -178,12 +177,11 @@ public Response handleResponse(CloseableHttpResponse httpResponse) throws IOExce * use the Charset sent by the server e.g. UAT-8 or UTF-16 or UTF-32 etc. * * Note- - * See implementation of java.nio.charset.Charset#defaultCharset. Here the default is UTF-8 if the + * See the implementation of java.nio.charset.Charset#defaultCharset. Here the default is UTF-8 if the * defaultCharset is not set by the JVM, otherwise it picks the JVM provided defaultCharset * - * @param httpResponse - * @return : A http response compatible with Charset received from the http server e.g. UTF-8, UTF-16 etc - * @throws IOException + * httpResponse: + * A http response compatible with Charset received from the http server e.g. UTF-8, UTF-16 etc * */ public Response createCharsetResponse(CloseableHttpResponse httpResponse) throws IOException { @@ -214,9 +212,9 @@ public Response createCharsetResponse(CloseableHttpResponse httpResponse) throws * In case you need to handle it differently you can override this method to change this behaviour to roll your own * feature. * - * @param httpUrl - Url of the target service - * @param queryParams - Query parameters to pass - * @return : Effective url + * httpUrl - Url of the target service + * queryParams - Query parameters to pass + * return : Effective url * */ public String handleUrlAndQueryParams(String httpUrl, Map queryParams) throws URISyntaxException { @@ -231,9 +229,9 @@ public String handleUrlAndQueryParams(String httpUrl, Map queryP * If you want to override any headers, you can do that by overriding the * amendRequestHeaders(headers) method. * - * @param headers - * @param requestBuilder - * @return : An effective Apache http request builder object with processed headers. + * headers + * requestBuilder + * return : An effective Apache http request builder object with processed headers. */ public RequestBuilder handleHeaders(Map headers, RequestBuilder requestBuilder) { Map amendedHeaders = amendRequestHeaders(headers); @@ -246,8 +244,8 @@ public RequestBuilder handleHeaders(Map headers, RequestBuilder * - Add more headers to the http request or * - Amend or modify the headers which were supplied from the JSON test-case request step. * - * @param headers : The headers passed from the JSON test step request - * @return : An effective headers map. + * headers : The headers passed from the JSON test step request + * return : An effective headers map. */ public Map amendRequestHeaders(Map headers) { return headers; @@ -257,8 +255,8 @@ public Map amendRequestHeaders(Map headers) { * Override this method when you want to manipulate the request body passed from your test cases. * Otherwise the framework falls back to this default implementation. * You can override this method via @UseHttpClient(YourCustomHttpClient.class) - * @param body - * @return + * body + * return */ public String handleRequestBody(Object body) { return getContentAsItIsJson(body); @@ -273,10 +271,10 @@ public String handleRequestBody(Object body) { * * You can override this method via @UseHttpClient(YourCustomHttpClient.class) * - * @param httpUrl - * @param methodName - * @param reqBodyAsString - * @return + * httpUrl + * methodName + * reqBodyAsString + * return */ public RequestBuilder createDefaultRequestBuilder(String httpUrl, String methodName, String reqBodyAsString) { RequestBuilder requestBuilder = RequestBuilder @@ -298,11 +296,6 @@ public RequestBuilder createDefaultRequestBuilder(String httpUrl, String methodN * is passed in the request. In case you want to build or prepare the requests differently, * you can override this method via @UseHttpClient(YourCustomHttpClient.class). * - * @param httpUrl - * @param methodName - * @param reqBodyAsString - * @return - * @throws IOException */ public RequestBuilder createFormUrlEncodedRequestBuilder(String httpUrl, String methodName, String reqBodyAsString) throws IOException { RequestBuilder requestBuilder = RequestBuilder @@ -333,11 +326,9 @@ public RequestBuilder createFormUrlEncodedRequestBuilder(String httpUrl, String * * You can override this method via @UseHttpClient(YourCustomHttpClient.class) * - * @param httpUrl - * @param methodName - * @param reqBodyAsString - * @return - * @throws IOException + * httpUrl: The end pint + * methodName: meaningful name of a method + * reqBodyAsString: */ public RequestBuilder createFileUploadRequestBuilder(String httpUrl, String methodName, String reqBodyAsString) throws IOException { Map fileFieldNameValueMap = getFileFieldNameValue(reqBodyAsString); @@ -367,8 +358,8 @@ public RequestBuilder createFileUploadRequestBuilder(String httpUrl, String meth * In case the session is not needed or to be handled differently, then this * method can be overridden to do nothing or to roll your own feature. * - * @param serverResponse - * @param headerKey + * serverResponse + * headerKey */ public void handleHttpSession(Response serverResponse, String headerKey) { /** --------------- diff --git a/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodePackageRunner.java b/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodePackageRunner.java index 236adc735..f4f493963 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodePackageRunner.java +++ b/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodePackageRunner.java @@ -113,7 +113,6 @@ protected List getChildren() { * Returns a {@link Description} for {@code child}, which can be assumed to * be an element of the list returned by {@link ParentRunner#getChildren()} * - * @param child */ @Override protected Description describeChild(ScenarioSpec child) { @@ -163,8 +162,6 @@ protected RunListener createTestUtilityListener() { * Subclasses are responsible for making sure that relevant test events are * reported through {@code notifier} * - * @param child - * @param notifier */ @Override protected void runChild(ScenarioSpec child, RunNotifier notifier) { diff --git a/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeUnitRunner.java b/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeUnitRunner.java index 2da5aeaeb..6c659e247 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeUnitRunner.java +++ b/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeUnitRunner.java @@ -70,8 +70,8 @@ public class ZeroCodeUnitRunner extends BlockJUnit4ClassRunner { /** * Creates a BlockJUnit4ClassRunner to run {@code klass} * - * @param klass - * @throws InitializationError if the test class is malformed. + * klass: + * InitializationError if the test class is malformed. */ public ZeroCodeUnitRunner(Class klass) throws InitializationError { super(klass); diff --git a/core/src/main/java/org/jsmart/zerocode/core/utils/SmartUtils.java b/core/src/main/java/org/jsmart/zerocode/core/utils/SmartUtils.java index 819746ff0..9d1b1b27b 100644 --- a/core/src/main/java/org/jsmart/zerocode/core/utils/SmartUtils.java +++ b/core/src/main/java/org/jsmart/zerocode/core/utils/SmartUtils.java @@ -245,11 +245,9 @@ public static String getEnvPropertyValue(String envPropertyKey) { } /** - * - * @param thisStep --> Currently executing step - * @param tokenString --> JSON_PAYLAOD_FILE or JSON_CONTENT - * @return if there is a match for the token, then the json traversal will happen - * @throws JsonProcessingException + * thisStep : Currently executing step + * tokenString : JSON_PAYLAOD_FILE or JSON_CONTENT + * if there is a match for the token, then the json traversal will happen */ public static boolean checkDigNeeded(ObjectMapper mapper, Step thisStep, String tokenString) throws JsonProcessingException { String stepJson = mapper.writeValueAsString(thisStep); diff --git a/http-testing/pom.xml b/http-testing/pom.xml index 7e2b18472..45ffb2bcc 100644 --- a/http-testing/pom.xml +++ b/http-testing/pom.xml @@ -4,7 +4,7 @@ zerocode-tdd-parent org.jsmart - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT org.jsmart diff --git a/junit5-testing/pom.xml b/junit5-testing/pom.xml index 03cbdcdeb..b0ce0a518 100644 --- a/junit5-testing/pom.xml +++ b/junit5-testing/pom.xml @@ -4,7 +4,7 @@ zerocode-tdd-parent org.jsmart - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT zerocode-tdd-jupiter diff --git a/kafka-testing/pom.xml b/kafka-testing/pom.xml index 0a15cbefb..1deb71ba5 100644 --- a/kafka-testing/pom.xml +++ b/kafka-testing/pom.xml @@ -4,7 +4,7 @@ zerocode-tdd-parent org.jsmart - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT kafka-testing diff --git a/pom.xml b/pom.xml index e19726b09..bca45f22e 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ zerocode-tdd-parent org.jsmart - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT pom ZeroCode TDD Parent diff --git a/zerocode-maven-archetype/pom.xml b/zerocode-maven-archetype/pom.xml index 69716bc33..ebd9871a8 100644 --- a/zerocode-maven-archetype/pom.xml +++ b/zerocode-maven-archetype/pom.xml @@ -4,7 +4,7 @@ org.jsmart zerocode-tdd-parent - 1.3.36-SNAPSHOT + 1.3.38-SNAPSHOT zerocode-maven-archetype