Merge pull request #10 from abhishekkadavil/dev

Added @author and @category tag support and done refactoring

Author: abhishekkadavil

README.md

@@ -1,6 +1,14 @@
 # RestAssured-Cucumber-Hybrid-Framework
 RestAssured cucumber hybrid framework template
 
+## Features
+* Cucumber test case
+* Parallel/sequential execution
+* Execute through maven and java class [TestSuitRunner.java](src/test/java/testSuit/runners/TestSuitRunner.java)
+* Auto/customisable reporting
+* Scenario context
+* Added `@Author` and `@Category` tags in reporting so that we can
+
 # Test execution
 
 * Test application: `https://gorest.co.in/`
@@ -342,7 +350,7 @@ Note: the file name sorting is case-sensitive, so uppercase A is executed before
   * Added functionality of ScenarioContext to accommodate all the common function in a scenario perspective eg: contextValues
 * The output of the test execution like response body, status, DB values etc. can be logged in report for the later use, so
   didn't create any other mechanism for that.
-  **RestAssuredLoggingFilter:** Adding rest assured logs to console including all the details of request and response.
+  **[RALoggerUtil.java](src/test/java/testSuit/utils/RALoggerUtil.java):** Adding rest assured logs to console including all the details of request and response.
   **Configuration:** Configurations for the test suits are done through `com.utils.ConfigUtil` interface which extends `org.aeonbits.owner.Config`. Suit level configuration are done in `ScenarioContext` class.
 
 # Why and why not

src/test/java/testSuit/utils/ScenarioContext.java renamed to src/test/java/testSuit/contexts/ScenarioContext.java

@@ -1,4 +1,4 @@
-package testSuit.utils;
+package testSuit.contexts;
 
 import com.github.tomakehurst.wiremock.client.MappingBuilder;
 import io.cucumber.guice.ScenarioScoped;

src/test/java/testSuit/utils/TestContext.java renamed to src/test/java/testSuit/contexts/TestContext.java

@@ -1,11 +1,12 @@
-package testSuit.utils;
+package testSuit.contexts;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
 import net.datafaker.Faker;
 import org.aeonbits.owner.ConfigFactory;
 import testSuit.pojos.User;
+import testSuit.utils.ConfigUtil;
 
 import java.io.FileReader;
 import java.io.IOException;

src/test/java/testSuit/utils/DataSourceFactory.java renamed to src/test/java/testSuit/factories/DataSourceFactory.java

@@ -1,7 +1,8 @@
-package testSuit.utils;
+package testSuit.factories;
 
 import lombok.SneakyThrows;
 import org.postgresql.ds.PGSimpleDataSource;
+import testSuit.contexts.TestContext;
 
 import javax.sql.DataSource;
 

src/test/java/testSuit/utils/ReporterFactory.java renamed to src/test/java/testSuit/factories/ReporterFactory.java

@@ -1,4 +1,4 @@
-package testSuit.utils;
+package testSuit.factories;
 
 import com.aventstack.extentreports.ExtentTest;
 

src/test/java/testSuit/runners/RunnerHelper.java

@@ -3,7 +3,7 @@
 import com.aventstack.extentreports.ExtentReports;
 import com.aventstack.extentreports.reporter.ExtentSparkReporter;
 import com.github.tomakehurst.wiremock.WireMockServer;
-import testSuit.utils.TestContext;
+import testSuit.contexts.TestContext;
 
 import java.io.IOException;
 import java.text.SimpleDateFormat;

src/test/java/testSuit/stepDef/CommonAssertions.java

@@ -12,8 +12,8 @@
 import org.skyscreamer.jsonassert.JSONCompareMode;
 import org.skyscreamer.jsonassert.comparator.CustomComparator;
 import org.testng.Assert;
-import testSuit.utils.ReporterFactory;
-import testSuit.utils.ScenarioContext;
+import testSuit.factories.ReporterFactory;
+import testSuit.contexts.ScenarioContext;
 
 import java.nio.file.Files;
 import java.nio.file.Paths;

src/test/java/testSuit/stepDef/CommonStepDef.java

@@ -16,6 +16,9 @@
 import io.restassured.specification.RequestSpecification;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
+import testSuit.contexts.ScenarioContext;
+import testSuit.contexts.TestContext;
+import testSuit.factories.ReporterFactory;
 import testSuit.utils.*;
 
 import java.io.File;

src/test/java/testSuit/stepDef/DBOpsStepDef.java

@@ -11,10 +11,10 @@
 import org.dbunit.dataset.CachedDataSet;
 import org.dbunit.dataset.IDataSet;
 import org.dbunit.dataset.ITable;
-import testSuit.utils.DataSourceFactory;
+import testSuit.factories.DataSourceFactory;
 import testSuit.utils.DbOpsUtil;
-import testSuit.utils.ReporterFactory;
-import testSuit.utils.ScenarioContext;
+import testSuit.factories.ReporterFactory;
+import testSuit.contexts.ScenarioContext;
 
 import javax.sql.DataSource;
 import java.net.URL;

src/test/java/testSuit/stepDef/Hooks.java

@@ -0,0 +1,64 @@
+package testSuit.stepDef;
+
+import io.cucumber.java.After;
+import io.cucumber.java.Before;
+import io.cucumber.java.Scenario;
+import lombok.extern.slf4j.Slf4j;
+import testSuit.factories.ReporterFactory;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * @author Abhishek Kadavil
+ */
+@Slf4j
+public class Hooks {
+
+    @Before
+    public void beforeScenario(Scenario scenario) {
+        log.info("beforeScenario {}", scenario.getName());
+    }
+
+    @After
+    public void afterScenario(Scenario scenario) {
+        log.info("afterScenario {}", scenario.getName());
+
+        /* Code to manage @Author and @Category tags */
+        Collection<String> tagsCollection = scenario.getSourceTagNames();
+        Set<String> tags = new HashSet<>(tagsCollection);
+
+        tags.forEach(tag -> {
+            if (tag.startsWith("@Author")) {
+                ReporterFactory.getInstance().getExtentTest().assignAuthor(extractedTagValue(tag));
+            } else if (tag.startsWith("@Category")) {
+                ReporterFactory.getInstance().getExtentTest().assignCategory(extractedTagValue(tag));
+            }
+        });
+    }
+
+    private String extractedTagValue(String tag) {
+
+        Pattern pattern;
+        Matcher matcher = null;
+        if (tag.startsWith("@Author")) {
+            pattern = Pattern.compile("@Author\\(\"([^\"]+)\"\\)");
+            matcher = pattern.matcher(tag);
+        }
+        if (tag.startsWith("@Category")) {
+            pattern = Pattern.compile("@Category\\(\"([^\"]+)\"\\)");
+            matcher = pattern.matcher(tag);
+        }
+
+        if(matcher != null)
+        {
+            if (matcher.find()) {
+                return matcher.group(1);  // Return the author's name
+            }
+        }
+        return "Unknown";
+    }
+}