Re-group HTTP steps and related logic (#5243)

docs/modules/plugins/pages/plugin-rest-api.adoc

@@ -873,6 +873,30 @@ Then HTTP resources are valid:
 | https://vividus-test-site-a92k.onrender.com/img/vividus.png |
 ----
 
+=== Validate redirects
+
+Check that all URLs from xref:ROOT:glossary.adoc#_examplestable[ExamplesTable] redirect to proper pages with correct redirects number. Validation fails if either actual final URL or number of redirects do not match the expected values.
+
+NOTE: The step throws the error in case if https://developer.mozilla.org/en-US/docs/Web/HTTP/Status[HTTP response status code] of checked URL out of range 200-207.
+
+[source,gherkin]
+----
+Then I validate HTTP redirects:$expectedRedirects
+----
+
+. `$expectedRedirects` - The xref:ROOT:glossary.adoc#_examplestable[ExamplesTable] with redirect parameters containing the following columns:
+** [subs=+quotes]`*startUrl*` - The URL from which redirection starts.
+** [subs=+quotes]`*endUrl*` - The expected final URL to redirect to.
+** [subs=+quotes]`*redirectsNumber*` - The expected number of redirects between `startUrl` and `endUrl` (optional).
+
+.Validate redirects
+[source,gherkin]
+----
+Then I validate HTTP redirects:
+|startUrl                    |endUrl                          |redirectsNumber |
+|http://example.com/redirect |http://example.com/get-response |1               |
+----
+
 
 == HTTP cookie steps
 

docs/modules/plugins/pages/plugin-web-app-to-rest-api.adoc

@@ -502,27 +502,10 @@ Then all resources found by CSS selector `a,img` in ${source-code} are valid
 
 === Validate redirects
 
-Check that all URLs from xref:ROOT:glossary.adoc#_examplestable[ExamplesTable] redirect to proper pages with correct redirects number. Validation fails if either actual final URL or number of redirects do not match the expected values.
-
-NOTE: The step throws the error in case if https://developer.mozilla.org/en-US/docs/Web/HTTP/Status[HTTP response status code] of checked URL out of range 200-207.
-
-[source,gherkin]
-----
-Then I validate HTTP redirects: $expectedRedirects
-----
-
-. `$expectedRedirects` - The xref:ROOT:glossary.adoc#_examplestable[ExamplesTable] with redirect parameters containing the following columns:
-** [subs=+quotes]`*startUrl*` - The URL from which redirection starts.
-** [subs=+quotes]`*endUrl*` - The expected final URL to redirect to.
-** [subs=+quotes]`*redirectsNumber*` - The expected number of redirects between `startUrl` and `endUrl` (optional).
-
-.Validate redirects
-[source,gherkin]
-----
-Then I validate HTTP redirects:
-|startUrl                    |endUrl                          |redirectsNumber |
-|http://example.com/redirect |http://example.com/get-response |1               |
-----
+[WARNING]
+====
+The step xref:plugins:plugin-rest-api.adoc#_validate_redirects[has been moved] to `vividus-plugin-rest-api`.
+====
 
 === Validate SSL rating
 

vividus-plugin-rest-api/src/main/java/org/vividus/http/PublishingAttachmentInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -95,6 +95,6 @@ private void attachApiMessage(String title, Header[] headers, byte[] body, Strin
         dataMap.put("bodyContentType", mimeType);
         dataMap.put("statusCode", statusCode);
 
-        attachmentPublisher.publishAttachment("/org/vividus/http/attachment/api-message.ftl", dataMap, title);
+        attachmentPublisher.publishAttachment("/org/vividus/http/steps/attachment/api-message.ftl", dataMap, title);
     }
 }

vividus-plugin-rest-api/src/main/java/org/vividus/steps/ByteArrayValidationRule.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/ByteArrayValidationRule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps;
+package org.vividus.http.steps;
 
 import org.hamcrest.Matchers;
 import org.vividus.softassert.ISoftAssert;
@@ -30,7 +30,7 @@ public void assertMatchesRule(ISoftAssert softAssert, byte[] expected, byte[] ac
             {
                 if (Matchers.equalTo(expected).matches(actual))
                 {
-                    softAssert.recordPassedAssertion(ByteArrayValidationRule.ARRAYS_ARE_EQUAL);
+                    softAssert.recordPassedAssertion(ARRAYS_ARE_EQUAL);
                 }
                 else
                 {
@@ -59,7 +59,7 @@ public void assertMatchesRule(ISoftAssert softAssert, byte[] expected, byte[] ac
             }
             else
             {
-                softAssert.recordFailedAssertion(ByteArrayValidationRule.ARRAYS_ARE_EQUAL);
+                softAssert.recordFailedAssertion(ARRAYS_ARE_EQUAL);
             }
         }
     };

vividus-plugin-rest-api/src/main/java/org/vividus/steps/api/HttpCookieSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/HttpCookieSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.api;
+package org.vividus.http.steps;
 
 import static org.hamcrest.Matchers.greaterThan;
 

vividus-plugin-rest-api/src/main/java/org/vividus/steps/api/HttpRequestSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/HttpRequestSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.api;
+package org.vividus.http.steps;
 
 import static java.util.stream.Collectors.toList;
 
@@ -27,11 +27,14 @@
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.hc.client5.http.config.RequestConfig;
 import org.apache.hc.client5.http.entity.UrlEncodedFormEntity;
+import org.apache.hc.client5.http.entity.mime.ByteArrayBody;
 import org.apache.hc.client5.http.entity.mime.ContentBody;
 import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
+import org.apache.hc.client5.http.entity.mime.StringBody;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.http.HttpEntity;
@@ -48,8 +51,8 @@
 import org.vividus.http.HttpMethod;
 import org.vividus.http.HttpRequestExecutor;
 import org.vividus.http.HttpTestContext;
-import org.vividus.model.RequestPartType;
 import org.vividus.steps.DataWrapper;
+import org.vividus.util.ResourceUtils;
 
 public class HttpRequestSteps
 {
@@ -273,4 +276,80 @@ public void setApiEndpoint(String apiEndpoint)
     {
         this.apiEndpoint = apiEndpoint;
     }
+
+    public enum RequestPartType
+    {
+        STRING
+        {
+            @Override
+            public ContentType getDefaultContentType()
+            {
+                return ContentType.DEFAULT_TEXT;
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType)
+            {
+                return new StringBody(value, contentType);
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType, String fileName)
+            {
+                throw new IllegalArgumentException(
+                        String.format("'fileName' parameter is not allowed for %s request part type", name()));
+            }
+        },
+        FILE
+        {
+            @Override
+            public ContentType getDefaultContentType()
+            {
+                return ContentType.DEFAULT_BINARY;
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType) throws IOException
+            {
+                String fileName = FilenameUtils.getName(value);
+                return createPart(value, contentType, fileName);
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType, String fileName) throws IOException
+            {
+                byte[] byteArray = ResourceUtils.loadResourceOrFileAsByteArray(value);
+                return new ByteArrayBody(byteArray, contentType, fileName);
+            }
+        },
+        BINARY
+        {
+            @Override
+            public ContentType getDefaultContentType()
+            {
+                return ContentType.DEFAULT_BINARY;
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType)
+            {
+                throw new IllegalArgumentException(
+                        String.format("'fileName' parameter is required for %s request part type", name()));
+            }
+
+            @Override
+            public ContentBody createPart(String value, ContentType contentType, String fileName)
+            {
+                byte[] byteArray = value.getBytes(StandardCharsets.UTF_8);
+                return new ByteArrayBody(byteArray, contentType, fileName);
+            }
+        };
+
+        public abstract ContentType getDefaultContentType();
+
+        public abstract ContentBody createPart(String value, ContentType contentType) throws IOException;
+
+        public abstract ContentBody createPart(String value, ContentType contentType, String fileName)
+                throws IOException;
+    }
 }

vividus-plugin-rest-api/src/main/java/org/vividus/steps/http/HttpResourceValidationSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/HttpResourceValidationSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.http;
+package org.vividus.http.steps;
 
 import java.util.List;
 import java.util.Map;
 
 import org.jbehave.core.annotations.Then;
 import org.jbehave.core.model.ExamplesTable;
+import org.vividus.http.validation.ResourceValidation;
 import org.vividus.http.validation.ResourceValidator;
-import org.vividus.http.validation.model.ResourceValidation;
 import org.vividus.reporter.event.AttachmentPublisher;
 import org.vividus.softassert.ISoftAssert;
 import org.vividus.util.UriUtils;
@@ -63,7 +63,8 @@ public void verifyHttpResources(ExamplesTable resources)
                                                         .sorted()
                                                         .toList();
 
-            attachmentPublisher.publishAttachment("http-resources-validation-results.ftl",
+            attachmentPublisher.publishAttachment(
+                    "/org/vividus/http/steps/attachment/http-resources-validation-results.ftl",
                     Map.of("results", validations), "HTTP resources validation results");
         });
     }

vividus-plugin-rest-api/src/main/java/org/vividus/steps/api/HttpResponseValidationSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/HttpResponseValidationSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.api;
+package org.vividus.http.steps;
 
 import static org.hamcrest.Matchers.contains;
 
@@ -39,7 +39,6 @@
 import org.vividus.http.HttpTestContext;
 import org.vividus.http.client.HttpResponse;
 import org.vividus.softassert.ISoftAssert;
-import org.vividus.steps.ByteArrayValidationRule;
 import org.vividus.steps.ComparisonRule;
 import org.vividus.steps.StringComparisonRule;
 import org.vividus.steps.SubSteps;

vividus-plugin-rest-api/src/main/java/org/vividus/steps/api/JsonResponseValidationSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/JsonResponseValidationSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.api;
+package org.vividus.http.steps;
 
 import java.time.Duration;
 import java.util.Optional;

vividus-plugin-rest-api/src/main/java/org/vividus/steps/api/JwtSteps.java → vividus-plugin-rest-api/src/main/java/org/vividus/http/steps/JwtSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.vividus.steps.api;
+package org.vividus.http.steps;
 
 import static java.lang.String.format;
 import static java.nio.charset.StandardCharsets.UTF_8;