Feature/8 implement methods by miroslavpojer · Pull Request #27 · AbsaOSS/ScAPI

miroslavpojer · 2023-08-23T06:58:26Z

#8 - Implement method ideas
Implemented full expected methods for Log 'ResponseAction'.

def logError(message: String): Boolean
def logWarn(message: String): Boolean
def logInfo(message: String): Boolean
def logDebug(message: String): Boolean

Implemented methods for Log 'ResponseAction'.

response-time-...

def assertResponseTimeIsBelow(response: Response, limit: String): Boolean
def assertResponseTimeIsAbove(response: Response, limit: String): Boolean

status-code-...

def assertStatusCodeEquals(response: Response): Boolean
def assertStatusCodeSuccess(response: Response): Boolean
def assertStatusCodeIsClientError(response: Response): Boolean
def assertStatusCodeIsServerError(response: Response): Boolean

header-...

def assertHeaderExists(response: Response, headerName: String): Boolean
def assertHeaderValueEquals(response: Response, headerName: String, expectedValue: String): Boolean

content-type-...

def assertContentTypeIsJson(response: Response): Boolean
def assertContentTypeIsXml(response: Response): Boolean
def assertContentTypeIsHtml(response: Response): Boolean

cookie-...

def assertCookieExists(response: Response, cookieName: String): Boolean
def assertCookieValueEquals(response: Response, cookieName: String, expectedValue: String): Boolean
def assertCookieIsSecured(response: Response, cookieName: String): Boolean
def assertCookieIsNotSecured(response: Response, cookieName: String): Boolean

body-.

def assertBodyContainsText(response: Response, text: String): Boolean

Done several refactoring changes:

improved logging messages
Set to Seq to keep defined actions order.
small improvements solved when found

* Renamed assertion json tag to responseAction. * Refactored related logic and doc.

…tion

* Simplified json files for ResponseAction - ResponseActions group and name by method with meaning "group.name". In code this value is separated for more intuitive usage.

* Refactored responseActions logic to accept random parameter names. * Correct parameters are validated in time of project loading.

* Extended json schemas by descriptions and version.

* Implemented full expected methods for Log 'ResponseAction'.

github-actions · 2023-08-23T06:59:45Z

JaCoCo code coverage report - ScAPI

File	Coverage [88.5%]	🍏
CookieValue.scala	100%	🍏
StdOutReporter.scala	100%	🍏
RequestBody.scala	100%	🍏
EnvironmentFactory.scala	100%	🍏
SuiteTestScenario.scala	100%	🍏
SuitePreAndPostProcessing.scala	100%	🍏
AfterTestSet.scala	100%	🍏
TestSet.scala	100%	🍏
Method.scala	100%	🍏
Suite.scala	100%	🍏
BeforeTestSet.scala	100%	🍏
Exceptions.scala	100%	🍏
JsonSchemaValidator.scala	100%	🍏
ExtractJsonResponseActionType.scala	100%	🍏
ResponseActionGroupType.scala	100%	🍏
AssertResponseActionType.scala	100%	🍏
LogResponseActionType.scala	100%	🍏
ScAPIRunnerConfig.scala	100%	🍏
SuiteResultType.scala	100%	🍏
SuiteRunner.scala	99.21%	🍏
ReferenceResolver.scala	96.76%	🍏
ScAPIRunner.scala	94.06%	🍏
SuiteResult.scala	93.75%	🍏
ExtractJsonResponseAction.scala	93.48%	🍏
RuntimeCache.scala	91.43%	🍏
RequestHeaders.scala	90.48%	🍏
SuiteFactory.scala	84.67%	🍏
AssertionResponseAction.scala	82.28%	🍏
LogResponseAction.scala	78.33%	❌
ContentValidator.scala	72.99%	❌
Response.scala	71.05%	❌
ScAPIRequestSender.scala	2.74%	❌

Total Project Coverage	88.75%	🍏

…. part

…... part * Implemented methods for Assertion 'ResponseAction' - header-... part * Implemented methods for Assertion 'ResponseAction' - content-type-... part * Updated log message to keep same format - on debug level. * Migrate several Set to Seq to keep order of elements which is required by logic of test design.

# Conflicts: # testApi/src/main/resources/schema/after.schema.json # testApi/src/main/resources/schema/before.schema.json # testApi/src/main/resources/schema/suite.schema.json # testApi/src/main/scala/africa/absa/testing/scapi/json/Requestable.scala # testApi/src/main/scala/africa/absa/testing/scapi/model/Method.scala # testApi/src/main/scala/africa/absa/testing/scapi/model/SuiteTestScenario.scala # testApi/src/main/scala/africa/absa/testing/scapi/rest/response/AssertionResponseAction.scala # testApi/src/main/scala/africa/absa/testing/scapi/rest/response/LogResponseAction.scala # testApi/src/main/scala/africa/absa/testing/scapi/rest/response/Response.scala # testApi/src/test/resources/project_with_issues/suites/aulgui-controller/undefinedConstantIssue.suite.json # testApi/src/test/resources/test_project/suites/gui-controller/deleteQuestion.suite.json # testApi/src/test/resources/test_project/suites/gui-controller/getUserCurrent.after.json # testApi/src/test/resources/test_project/suites/gui-controller/getUserCurrent.before.json # testApi/src/test/resources/test_project/suites/gui-controller/getUserCurrent.suite.json # testApi/src/test/resources/test_project/suites/gui-controller/postQuestion.suite.json # testApi/src/test/resources/test_project/suites/gui-controller/putQuestion.suite.json # testApi/src/test/scala/africa/absa/testing/scapi/json/SuiteFactoryTest.scala # testApi/src/test/scala/africa/absa/testing/scapi/rest/response/ResponseAssertionsTest.scala # testApi/src/test/scala/africa/absa/testing/scapi/rest/response/ResponseExtractTest.scala # testApi/src/test/scala/africa/absa/testing/scapi/rest/response/ResponseLogTest.scala # testApi/src/test/scala/africa/absa/testing/scapi/rest/response/ResponseTest.scala # testApi/src/test/scala/africa/absa/testing/scapi/suite/runner/SuiteRunnerTest.scala

testApi/src/main/scala/africa/absa/testing/scapi/model/Method.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/request/sender/ScAPIRequestSender.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/LogResponseAction.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/Response.scala

* Fix not used method parameters review note.

dk1844

Not part of this PR, but the Logger with var level getting set around is very weird.

Some of the intercept[xxx] call do not check the error message, wouldn't it be worth being present everywhere? Or are there some exceptions?

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/LogResponseAction.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/Response.scala

testApi/src/main/scala/africa/absa/testing/scapi/utils/validation/ContentValidator.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/LogResponseAction.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/Response.scala

* Fix - not used method parameters review note. * Fix - String to Enum * Fix - replace boolean return values in XYZResponseAction methods.

* Fix - replace Log type of response actions by enum. * Fix - replace ExtractJson type of response actions by enum.

…eturn values. * Fix - make response perform method private. * Fix - Update tests checking exceptions to check meesages too. * Fix - Update assert method to assert values with clues where missing.

miroslavpojer · 2023-10-06T07:48:40Z

Not part of this PR, but the Logger with var level getting set around is very weird.

Some of the intercept[xxx] call do not check the error message, wouldn't it be worth being present everywhere? Or are there some exceptions?

All intercepts reviewed and now all of them should check message too.

* Fix - update of visibility on methods and attributes. * Fix - removed old no more used object LoggerConfig.

* Rename of variable in code to fit to real usage.

* Fix - moved Suite related models classes to new suite package in model package.

* Fix - rename SuiteAround to SuitePreAndPostProcessing. * Fix - rename SuiteBefore to BeforeTestSet * Fix - rename SuiteAfter to AfterTestSet * Fix - rename SuiteBundle to Suite * Fix - rename ResponsePerformer to ResponseActions * Fix - move ResponseAction related file into new package action * Fix - rename "endpoint" to "name" as this parameters is used as name for suite not as endpoint.

… name and location.

… name and location. Second part: refactor Enumeration for SuiteResultType.

miroslavpojer · 2023-10-13T12:25:25Z

I have finished all review notes. See commits in review note answers.
I have done big amount of refactoring changes. Please @dk1844 and @Zejnilovic to do fully new review of current state.

dk1844

Looks better, thanks for the fixes from last time.

testApi/src/main/scala/africa/absa/testing/scapi/suite/runner/SuiteRunner.scala

...rc/main/scala/africa/absa/testing/scapi/rest/response/action/ExtractJsonResponseAction.scala

testApi/src/main/scala/africa/absa/testing/scapi/rest/response/action/LogResponseAction.scala

.../main/scala/africa/absa/testing/scapi/rest/response/action/types/LogResponseActionType.scala

...in/scala/africa/absa/testing/scapi/rest/response/action/types/AssertResponseActionType.scala

...ala/africa/absa/testing/scapi/rest/response/action/types/ExtractJsonResponseActionType.scala

testApi/src/test/scala/africa/absa/testing/scapi/json/SuiteFactoryTest.scala

testApi/src/test/scala/africa/absa/testing/scapi/reporter/StdOutReporterTest.scala

testApi/src/test/scala/africa/absa/testing/scapi/rest/response/ResponseExtractTest.scala

…are used only in tests.

dk1844

LGTM

miroslavpojer added 7 commits August 22, 2023 08:22

#17 - Assertion rename and simplification

ca67acc

* Renamed assertion json tag to responseAction. * Refactored related logic and doc.

Merge branch 'master' into feature/17_assertion_rename_and_simplifica…

b1e3ade

…tion

#17 - Assertion rename and simplification

9d89dc1

* Simplified json files for ResponseAction - ResponseActions group and name by method with meaning "group.name". In code this value is separated for more intuitive usage.

#18 - Refactoring of ResponseAction to dynamic

0b5a476

* Refactored responseActions logic to accept random parameter names. * Correct parameters are validated in time of project loading.

#18 - Refactoring of ResponseAction to dynamic

2e68674

* Extended json schemas by descriptions and version.

* Repairs of unit tests.

4d5a6bc

#8 - Implement method ideas

f14b81f

* Implemented full expected methods for Log 'ResponseAction'.

miroslavpojer self-assigned this Aug 23, 2023

miroslavpojer requested review from Zejnilovic and removed request for Zejnilovic August 23, 2023 06:58

* Implemented methods for Assertion 'ResponseAction' - status-code-..…

104415f

…. part

miroslavpojer marked this pull request as ready for review August 23, 2023 07:53

miroslavpojer requested a review from Zejnilovic as a code owner August 23, 2023 07:53

miroslavpojer removed the request for review from Zejnilovic August 23, 2023 07:53

miroslavpojer added 3 commits August 24, 2023 13:26

* Implemented methods for Assertion 'ResponseAction' - cookie-... part

643a68a

miroslavpojer requested a review from Zejnilovic August 26, 2023 15:28

miroslavpojer requested a review from dk1844 September 7, 2023 07:21

Zejnilovic reviewed Sep 7, 2023

View reviewed changes

* Fix multiline strings review note.

6032a64

* Fix not used method parameters review note.

dk1844 suggested changes Sep 8, 2023

View reviewed changes

miroslavpojer added 3 commits September 21, 2023 09:03

* Fix - multiline strings review note.

c203ab6

* Fix - not used method parameters review note. * Fix - String to Enum * Fix - replace boolean return values in XYZResponseAction methods.

* Fix - replace Assert type of response actions by enum.

2e251ae

* Fix - replace Log type of response actions by enum. * Fix - replace ExtractJson type of response actions by enum.

* Fix - Update of javaDoc after migration from boolean to Try[Unit] r…

3dc366b

…eturn values. * Fix - make response perform method private. * Fix - Update tests checking exceptions to check meesages too. * Fix - Update assert method to assert values with clues where missing.

miroslavpojer added 3 commits October 6, 2023 10:15

* Fix - replaced tuple by new CookieValue class.

02a2447

* Fix - add missed class file.

11293dc

* Fix - review of code warnings.

0227000

* Fix - update of visibility on methods and attributes. * Fix - removed old no more used object LoggerConfig.

miroslavpojer added 8 commits October 9, 2023 13:16

* Fix - Removed no more used class and object TestResults.scala.

8b4c12e

* Rename of variable in code to fit to real usage.

* Fix - moved Factory classes to dedicated package.

1aa261b

* Fix - moved Suite related models classes to new suite package in model package.

* Fix - removed only keyword.

0f82356

* Change: set jacoco-report debug to find source of logic failing.

2f579ac

* Change: set jacoco-report debug to find source of logic failing.

f353d54

* Fix - expected change to fix jacoco report issue and better package…

aca8587

… name and location.

* Fix - expected change to fix jacoco report issue and better package…

1d2c8ab

… name and location. Second part: refactor Enumeration for SuiteResultType.

dk1844 reviewed Nov 1, 2023

View reviewed changes

miroslavpojer added 7 commits November 1, 2023 13:25

* Fix - log action methods returns Unit.

e2fec8f

* Fix - Improved usage of resultType enums.

470efbf

* Fix - Removed usage of Success from Action implementations.

a15a420

* Fix - Renamed and moved Type to String implicit conversion as they …

5ec5a73

…are used only in tests.

* Fix - correct usage clue calls in assert (not assertEquals) method.

e4ce58a

* Fix - removed used only keyword from test name.

236cbae

* Fix - Applied Scala CamelCase to enumaration contants.

4e0d029

dk1844 approved these changes Nov 2, 2023

View reviewed changes

miroslavpojer merged commit 03dca9c into master Nov 3, 2023

miroslavpojer deleted the feature/8-implement_methods branch November 3, 2023 12:28

Conversation

miroslavpojer commented Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JaCoCo code coverage report - ScAPI

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dk1844 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

miroslavpojer commented Oct 6, 2023

Uh oh!

miroslavpojer commented Oct 13, 2023

Uh oh!

dk1844 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dk1844 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

miroslavpojer commented Aug 23, 2023 •

edited

Loading

github-actions bot commented Aug 23, 2023 •

edited

Loading