Skip to content

Commit 8bcc4c6

Browse files
KMariuszKMariusz
committedJan 17, 2023
Version 2023.01.17: Moved base methods of StepLogger to core module, extend BFLogger with warning
·
JDK_8_EOL2023.01.17
1 parent 66c8fff commit 8bcc4c6

File tree

12 files changed

+205
-176
lines changed

12 files changed

+205
-176
lines changed
 

‎mrchecker-framework-modules/mrchecker-cli-module/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<parent>
77
<artifactId>mrchecker-test-framework</artifactId>
88
<groupId>com.capgemini.mrchecker</groupId>
9-
<version>2023.01.16</version>
9+
<version>2023.01.17</version>
1010
</parent>
1111

1212
<artifactId>mrchecker-cli-module</artifactId>
13-
<version>2023.01.16</version>
13+
<version>2023.01.17</version>
1414
<packaging>jar</packaging>
1515
<name>MrChecker - CLI - Module</name>
1616
<description>MrChecker CLI Module supports:
@@ -60,7 +60,7 @@
6060
<dependency>
6161
<groupId>${project.groupId}</groupId>
6262
<artifactId>mrchecker-core-module</artifactId>
63-
<version>2023.01.16</version>
63+
<version>2023.01.17</version>
6464
</dependency>
6565
</dependencies>
6666

‎mrchecker-framework-modules/mrchecker-core-module/pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<parent>
88
<artifactId>mrchecker-test-framework</artifactId>
99
<groupId>com.capgemini.mrchecker</groupId>
10-
<version>2023.01.16</version>
10+
<version>2023.01.17</version>
1111
</parent>
1212

1313
<artifactId>mrchecker-core-module</artifactId>
14-
<version>2023.01.16</version>
14+
<version>2023.01.17</version>
1515
<packaging>jar</packaging>
1616
<name>MrChecker - Test core - Module</name>
1717
<description>MrChecker Test Framework Core is responsible for:

‎mrchecker-framework-modules/mrchecker-core-module/src/main/java/com/capgemini/mrchecker/test/core/logger/BFLogger.java

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ public static void logFunctionEnd() {
4343
getLog().logFunctionEnd();
4444
}
4545

46+
public static void logWarning(String message) {
47+
getLog().logWarning(message);
48+
}
49+
4650
// logger - log ERROR message
4751
public static void logError(String message) {
4852
getLog().logError(message);

‎mrchecker-framework-modules/mrchecker-core-module/src/main/java/com/capgemini/mrchecker/test/core/logger/BFLoggerInstance.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ public void logInfo(String message) {
4545
log(Level.INFO, message);
4646
}
4747

48+
public void logWarning(String message) {
49+
log(Level.WARN, message);
50+
}
51+
4852
public void logError(String message) {
4953
log(Level.ERROR, message);
5054
}
@@ -95,4 +99,4 @@ public String dumpSeparateLog() {
9599
return "";
96100
}
97101
}
98-
}
102+
}

‎mrchecker-framework-modules/mrchecker-core-module/src/main/java/com/capgemini/mrchecker/test/core/utils/StepLogger.java

+173
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
package com.capgemini.mrchecker.test.core.utils;
2+
3+
import com.capgemini.mrchecker.test.core.logger.BFLogger;
4+
import io.qameta.allure.Allure;
5+
import io.qameta.allure.Attachment;
6+
import io.qameta.allure.Step;
7+
import io.qameta.allure.model.Link;
8+
import io.qameta.allure.model.Status;
9+
import io.qameta.allure.util.ResultsUtils;
10+
11+
import java.io.File;
12+
import java.io.FileInputStream;
13+
import java.io.FileOutputStream;
14+
import java.io.IOException;
15+
import java.nio.file.Files;
16+
import java.nio.file.Paths;
17+
import java.text.MessageFormat;
18+
import java.util.List;
19+
import java.util.zip.ZipEntry;
20+
import java.util.zip.ZipOutputStream;
21+
22+
import static java.nio.file.StandardOpenOption.APPEND;
23+
24+
public class StepLogger {
25+
protected StepLogger() {
26+
}
27+
28+
public static void step(String step) {
29+
step(step, Status.PASSED);
30+
}
31+
32+
public static void error(String error) {
33+
step(error, Status.FAILED);
34+
}
35+
36+
public static void warning(String warning) {
37+
step(warning, Status.BROKEN);
38+
}
39+
40+
public static void info(String info) {
41+
step("[INFO] " + info);
42+
}
43+
44+
public static void step(String step, Status status) {
45+
switch (status) {
46+
case BROKEN:
47+
BFLogger.logWarning(step);
48+
break;
49+
case FAILED:
50+
BFLogger.logError(step);
51+
break;
52+
default:
53+
BFLogger.logInfo(step);
54+
}
55+
Allure.step(step, status);
56+
}
57+
58+
public static void issue(String name, String url) {
59+
link(ResultsUtils.ISSUE_LINK_TYPE, name, url);
60+
}
61+
62+
public static void tmsLink(String name, String url) {
63+
link(ResultsUtils.TMS_LINK_TYPE, name, url);
64+
}
65+
66+
public static void link(String type, String name, String url) {
67+
try {
68+
Allure.addLinks(new Link().setType(type).setName(name).setUrl(url));
69+
} catch (NullPointerException e) {
70+
// Catch when no allure report
71+
step(MessageFormat.format("[{0}][{1}] {2}", type, name, url));
72+
}
73+
}
74+
75+
@Step("{step}")
76+
public static void stepsTree(String step, List<String> subSteps) {
77+
for (String s : subSteps) {
78+
step(s);
79+
}
80+
}
81+
82+
@Step("{step}")
83+
public static void stepsTree(String step, List<String> subSteps, Status status) {
84+
for (String s : subSteps) {
85+
step(s, status);
86+
}
87+
}
88+
89+
@Attachment(value = "{attachName}", type = "text/plain")
90+
public static String saveTextAttachmentToLog(String attachName, String message) {
91+
BFLogger.logInfo("Saved attachment: " + attachName);
92+
return message;
93+
}
94+
95+
@Attachment(value = "{name}", type = "text/csv")
96+
public static byte[] attachCSVFile(File file, String name) throws IOException {
97+
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
98+
}
99+
100+
@Attachment(value = "{name}", type = "text/plain")
101+
public static byte[] attachTXTFile(File file, String name) throws IOException {
102+
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
103+
}
104+
105+
@Attachment("Zipped [{name}]")
106+
public static byte[] attachZippedFile(File fileToAttach, String name) throws IOException {
107+
String tempPath = System.getProperty("java.io.tmpdir");
108+
String zipFileName = "attachement.zip";
109+
File zipFile = new File(tempPath, zipFileName);
110+
byte[] buffer = new byte[1024];
111+
try (FileOutputStream fos = new FileOutputStream(zipFile); ZipOutputStream zos = new ZipOutputStream(
112+
fos); FileInputStream fis = new FileInputStream(fileToAttach)) {
113+
zos.putNextEntry(new ZipEntry(fileToAttach.getName()));
114+
int length;
115+
while ((length = fis.read(buffer)) > 0) {
116+
zos.write(buffer, 0, length);
117+
}
118+
zos.closeEntry();
119+
}
120+
return Files.readAllBytes(Paths.get(zipFile.getAbsolutePath()));
121+
}
122+
123+
@Attachment(value = "{name}", type = "application/pdf")
124+
public static byte[] attachPDFFile(File file, String name) throws IOException {
125+
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
126+
}
127+
128+
@Attachment(value = "{name}", type = "image/png")
129+
public static byte[] attachPNGFile(File file, String name) throws IOException {
130+
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
131+
}
132+
133+
@Attachment(value = "{name}", type = "application/zip")
134+
public static byte[] attachZIPFile(File file, String name) throws IOException {
135+
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
136+
}
137+
138+
public static void attachFile(File file, String name) throws IOException {
139+
String fileName = file.getName();
140+
String extension = fileName.substring(fileName.lastIndexOf(".") + 1);
141+
if (file.length() == 0) {
142+
Files.write(Paths.get(file.toURI()), " ".getBytes(), APPEND);
143+
}
144+
switch (extension.toLowerCase()) {
145+
case "pdf": {
146+
attachPDFFile(file, name);
147+
break;
148+
}
149+
case "xlsx": {
150+
attachZippedFile(file, name);
151+
break;
152+
}
153+
case "csv": {
154+
attachCSVFile(file, name);
155+
break;
156+
}
157+
case "png": {
158+
attachPNGFile(file, name);
159+
break;
160+
}
161+
case "zip": {
162+
attachZIPFile(file, name);
163+
break;
164+
}
165+
case "txt": {
166+
attachTXTFile(file, name);
167+
break;
168+
}
169+
default:
170+
error("Couldn't attach file with extension: " + extension);
171+
}
172+
}
173+
}

‎mrchecker-framework-modules/mrchecker-database-module/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<parent>
77
<artifactId>mrchecker-test-framework</artifactId>
88
<groupId>com.capgemini.mrchecker</groupId>
9-
<version>2023.01.16</version>
9+
<version>2023.01.17</version>
1010
</parent>
1111

1212
<artifactId>mrchecker-database-module</artifactId>
13-
<version>2023.01.16</version>
13+
<version>2023.01.17</version>
1414
<packaging>jar</packaging>
1515
<name>MrChecker - Database - Module</name>
1616
<description>MrChecker Database Module:
@@ -80,7 +80,7 @@
8080
<dependency>
8181
<groupId>${project.groupId}</groupId>
8282
<artifactId>mrchecker-core-module</artifactId>
83-
<version>2023.01.16</version>
83+
<version>2023.01.17</version>
8484
</dependency>
8585

8686
<!-- JPA dependencies -->

‎mrchecker-framework-modules/mrchecker-mobile-module/pom.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<parent>
88
<artifactId>mrchecker-test-framework</artifactId>
99
<groupId>com.capgemini.mrchecker</groupId>
10-
<version>2023.01.16</version>
10+
<version>2023.01.17</version>
1111
</parent>
1212

1313
<artifactId>mrchecker-mobile-module</artifactId>
14-
<version>2023.01.16</version>
14+
<version>2023.01.17</version>
1515
<packaging>jar</packaging>
1616
<name>MrChecker - Mobile - Module</name>
1717
<description>MrChecker Test Framework name supports:
@@ -52,12 +52,12 @@
5252
<dependency>
5353
<groupId>${project.groupId}</groupId>
5454
<artifactId>mrchecker-core-module</artifactId>
55-
<version>2023.01.16</version>
55+
<version>2023.01.17</version>
5656
</dependency>
5757
<dependency>
5858
<groupId>${project.groupId}</groupId>
5959
<artifactId>mrchecker-selenium-module</artifactId>
60-
<version>2023.01.16</version>
60+
<version>2023.01.17</version>
6161
</dependency>
6262

6363
<!--This dependency is necessary for Appium plugin. -->

‎mrchecker-framework-modules/mrchecker-security-module/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<parent>
88
<artifactId>mrchecker-test-framework</artifactId>
99
<groupId>com.capgemini.mrchecker</groupId>
10-
<version>2023.01.16</version>
10+
<version>2023.01.17</version>
1111
</parent>
1212

1313
<artifactId>mrchecker-security-module</artifactId>
14-
<version>2023.01.16</version>
14+
<version>2023.01.17</version>
1515
<packaging>jar</packaging>
1616
<name>MrChecker - Security - Module</name>
1717
<description>MrChecker Test Framework Security supports:
@@ -63,7 +63,7 @@
6363
<dependency>
6464
<groupId>${project.groupId}</groupId>
6565
<artifactId>mrchecker-core-module</artifactId>
66-
<version>2023.01.16</version>
66+
<version>2023.01.17</version>
6767
</dependency>
6868

6969
<!-- Needed to perform all API calls -->

‎mrchecker-framework-modules/mrchecker-selenium-module/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<parent>
88
<artifactId>mrchecker-test-framework</artifactId>
99
<groupId>com.capgemini.mrchecker</groupId>
10-
<version>2023.01.16</version>
10+
<version>2023.01.17</version>
1111
</parent>
1212

1313
<artifactId>mrchecker-selenium-module</artifactId>
14-
<version>2023.01.16</version>
14+
<version>2023.01.17</version>
1515
<packaging>jar</packaging>
1616
<name>MrChecker - Selenium - Module</name>
1717
<description>MrChecker Test Framework Selenium supports:
@@ -98,7 +98,7 @@
9898
<dependency>
9999
<groupId>${project.groupId}</groupId>
100100
<artifactId>mrchecker-core-module</artifactId>
101-
<version>2023.01.16</version>
101+
<version>2023.01.17</version>
102102
</dependency>
103103

104104
<!--This dependency is necessary for Selenium plugin. -->

‎mrchecker-framework-modules/mrchecker-selenium-module/src/main/java/com/capgemini/mrchecker/selenium/core/utils/StepLogger.java

+1-153
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,16 @@
44
import com.capgemini.mrchecker.test.core.logger.BFLogger;
55
import io.qameta.allure.Allure;
66
import io.qameta.allure.AllureLifecycle;
7-
import io.qameta.allure.Attachment;
87
import io.qameta.allure.Step;
9-
import io.qameta.allure.model.Link;
108
import io.qameta.allure.model.Status;
119
import io.qameta.allure.model.StepResult;
12-
import io.qameta.allure.util.ResultsUtils;
1310
import org.openqa.selenium.By;
1411
import org.openqa.selenium.WebElement;
1512

16-
import java.io.File;
17-
import java.io.FileInputStream;
18-
import java.io.FileOutputStream;
19-
import java.io.IOException;
20-
import java.nio.file.Files;
21-
import java.nio.file.Paths;
22-
import java.text.MessageFormat;
23-
import java.util.List;
2413
import java.util.NoSuchElementException;
2514
import java.util.UUID;
26-
import java.util.zip.ZipEntry;
27-
import java.util.zip.ZipOutputStream;
28-
29-
import static java.nio.file.StandardOpenOption.APPEND;
30-
31-
public class StepLogger {
32-
private StepLogger() {
33-
}
34-
35-
public static void step(String step) {
36-
BFLogger.logInfo(step);
37-
Allure.step(step);
38-
}
39-
40-
public static void step(String step, Status status) {
41-
BFLogger.logInfo(step);
42-
Allure.step(step, status);
43-
}
44-
45-
public static void info(String info) {
46-
step("[INFO] " + info);
47-
}
4815

16+
public class StepLogger extends com.capgemini.mrchecker.test.core.utils.StepLogger {
4917
public static void error(String error, boolean makeScreenShot) {
5018
String message = "[ERROR] " + error;
5119
String uuid = UUID.randomUUID().toString();
@@ -62,41 +30,6 @@ public static void error(String error, boolean makeScreenShot) {
6230
}
6331
}
6432

65-
public static void error(String error) {
66-
error(error, true);
67-
}
68-
69-
public static void issue(String name, String url) {
70-
link(ResultsUtils.ISSUE_LINK_TYPE, name, url);
71-
}
72-
73-
public static void tmsLink(String name, String url) {
74-
link(ResultsUtils.TMS_LINK_TYPE, name, url);
75-
}
76-
77-
private static void link(String type, String name, String url) {
78-
try {
79-
Allure.addLinks(new Link().setType(type).setName(name).setUrl(url));
80-
} catch (NullPointerException e) {
81-
// Catch when no allure report
82-
step(MessageFormat.format("[{0}][{1}] {2}", type, name, url));
83-
}
84-
}
85-
86-
@Step("{step}")
87-
public static void stepsTree(String step, List<String> subSteps) {
88-
for (String s : subSteps) {
89-
step(s);
90-
}
91-
}
92-
93-
@Step("{step}")
94-
public static void stepsTree(String step, List<String> subSteps, Status status) {
95-
for (String s : subSteps) {
96-
step(s, status);
97-
}
98-
}
99-
10033
@Step("--Screenshot--")
10134
public static void makeScreenShot() {
10235
BasePage.makeScreenShot("Screenshot");
@@ -111,89 +44,4 @@ public static void makeScreenShot(WebElement element, String elementName) {
11144
public static void makeScreenShot(By selector, String elementName) {
11245
BasePage.makeScreenShot(elementName + " Screenshot", selector);
11346
}
114-
115-
@Attachment(value = "{attachName}", type = "text/plain")
116-
public static String saveTextAttachmentToLog(String attachName, String message) {
117-
BFLogger.logInfo("Saved attachment: " + attachName);
118-
return message;
119-
}
120-
121-
@Attachment(value = "{name}", type = "text/csv")
122-
private static byte[] attachCSVFile(File file, String name) throws IOException {
123-
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
124-
}
125-
126-
@Attachment(value = "{name}", type = "text/plain")
127-
private static byte[] attachTXTFile(File file, String name) throws IOException {
128-
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
129-
}
130-
131-
@Attachment("Zipped [{name}]")
132-
private static byte[] attachZippedFile(File fileToAttach, String name) throws IOException {
133-
String tempPath = System.getProperty("java.io.tmpdir");
134-
String zipFileName = "attachement.zip";
135-
File zipFile = new File(tempPath, zipFileName);
136-
byte[] buffer = new byte[1024];
137-
try (FileOutputStream fos = new FileOutputStream(zipFile); ZipOutputStream zos = new ZipOutputStream(
138-
fos); FileInputStream fis = new FileInputStream(fileToAttach)) {
139-
zos.putNextEntry(new ZipEntry(fileToAttach.getName()));
140-
int length;
141-
while ((length = fis.read(buffer)) > 0) {
142-
zos.write(buffer, 0, length);
143-
}
144-
zos.closeEntry();
145-
}
146-
return Files.readAllBytes(Paths.get(zipFile.getAbsolutePath()));
147-
}
148-
149-
@Attachment(value = "{name}", type = "application/pdf")
150-
private static byte[] attachPDFFile(File file, String name) throws IOException {
151-
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
152-
}
153-
154-
@Attachment(value = "{name}", type = "image/png")
155-
private static byte[] attachPNGFile(File file, String name) throws IOException {
156-
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
157-
}
158-
159-
@Attachment(value = "{name}", type = "application/zip")
160-
private static byte[] attachZIPFile(File file, String name) throws IOException {
161-
return Files.readAllBytes(Paths.get(file.getAbsolutePath()));
162-
}
163-
164-
public static void attachFile(File file, String name) throws IOException {
165-
String fileName = file.getName();
166-
String extension = fileName.substring(fileName.lastIndexOf(".") + 1);
167-
if (file.length() == 0) {
168-
Files.write(Paths.get(file.toURI()), " ".getBytes(), APPEND);
169-
}
170-
switch (extension.toLowerCase()) {
171-
case "pdf": {
172-
attachPDFFile(file, name);
173-
break;
174-
}
175-
case "xlsx": {
176-
attachZippedFile(file, name);
177-
break;
178-
}
179-
case "csv": {
180-
attachCSVFile(file, name);
181-
break;
182-
}
183-
case "png": {
184-
attachPNGFile(file, name);
185-
break;
186-
}
187-
case "zip": {
188-
attachZIPFile(file, name);
189-
break;
190-
}
191-
case "txt": {
192-
attachTXTFile(file, name);
193-
break;
194-
}
195-
default:
196-
error("Couldn't attach file with extension: " + extension);
197-
}
198-
}
19947
}

‎mrchecker-framework-modules/mrchecker-webapi-module/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<parent>
88
<artifactId>mrchecker-test-framework</artifactId>
99
<groupId>com.capgemini.mrchecker</groupId>
10-
<version>2023.01.16</version>
10+
<version>2023.01.17</version>
1111
</parent>
1212

1313
<artifactId>mrchecker-webapi-module</artifactId>
14-
<version>2023.01.16</version>
14+
<version>2023.01.17</version>
1515
<packaging>jar</packaging>
1616
<name>MrChecker - WebApi - Module</name>
1717
<description>
@@ -80,7 +80,7 @@
8080
<dependency>
8181
<groupId>${project.groupId}</groupId>
8282
<artifactId>mrchecker-core-module</artifactId>
83-
<version>2023.01.16</version>
83+
<version>2023.01.17</version>
8484
</dependency>
8585

8686
<!-- Dependency to REST and SOAP lib -->

‎mrchecker-framework-modules/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<modelVersion>4.0.0</modelVersion>
66
<groupId>com.capgemini.mrchecker</groupId>
77
<artifactId>mrchecker-test-framework</artifactId>
8-
<version>2023.01.16</version>
8+
<version>2023.01.17</version>
99
<name>MrChecker</name>
1010
<description>MrChecker Test Framework is an automated testing framework for functional testing of web applications,
1111
native mobile apps, webservices and database.

0 commit comments

Comments
 (0)
Please sign in to comment.