NOISSUE - Add property based testing to users service #2087

rodneyosodo · 2024-02-20T11:30:43Z

What type of PR is this?

This is a feature PR as it adds property-based testing to users API. In addition it is a refactor to error handling on the API

What does this do?

Adds schemathesis, property-based testing to users service

Which issue(s) does this PR fix/relate to?

No issue

Have you included tests for your changes?

Yes, I have included tests for my changes.

Did you document any new/modified feature?

No

Notes

Stranger6667 · 2024-02-21T09:16:40Z

.github/workflows/api-tests.yml

+          base-url: http://localhost:9002
+          checks: all
+          report: false
+          args: '--header "Authorization: Bearer ${{ env.USER_TOKEN }}" --contrib-unique-data --contrib-openapi-formats-uuid --hypothesis-suppress-health-check=filter_too_much --stateful=links'


The --contrib-unique-data option is deprecated and going to be removed in the next major version of Schemathesis. I suggest avoiding it as it leads to unstable tests

@rodneyosodo can you please inspect this and see if we can remove --contrib-unique-data and what implications it will make (i.e. how we can find a future-proof approach)

drasko · 2024-02-21T15:10:48Z

.github/workflows/api-tests.yml

+          base-url: http://localhost:9002
+          checks: all
+          report: false
+          args: '--header "Authorization: Bearer ${{ env.USER_TOKEN }}" --contrib-unique-data --contrib-openapi-formats-uuid --hypothesis-suppress-health-check=filter_too_much --stateful=links'


@rodneyosodo can you please inspect this and see if we can remove --contrib-unique-data and what implications it will make (i.e. how we can find a future-proof approach)

api/openapi/users.yml

users/api/clients.go

arvindh123

LGTM

At here in users repository , we are using svcerr, instead of svcerr, does the repoerr will fit there ?

Makefile

arvindh123 · 2024-03-14T14:48:33Z

Got the below warnings from schemathesis in local and in CI,
Is it possible to provision Magistrala with domain and groups ? , so that schemathesis could test all the cases.

WARNINGS:
  - Most of the responses from `GET /groups/{groupID}` have a 403 status code. Did you specify proper API credentials?
  - Most of the responses from `PUT /groups/{groupID}` have a 403 status code. Did you specify proper API credentials?
  - Most of the responses from `DELETE /groups/{groupID}` have a 403 status code. Did you specify proper API credentials?
  - Most of the responses from `POST /groups/{groupID}/enable` have a 403 status code. Did you specify proper API credentials?
  - Most of the responses from `POST /groups/{groupID}/disable` have a 403 status code. Did you specify proper API credentials?

internal/groups/service.go

rodneyosodo · 2024-03-15T09:38:25Z

Is it possible to provision Magistrala with domain and groups ? , so that schemathesis could test all the cases.

This is completely fine. Most of the endpoints schemathesis is probing are not valid hence we get an authorization error because the id is not for a valid entity

Signed-off-by: Rodney Osodo <[email protected]>

Removed the `--contrib-unique-data` option from API test arguments in `.github/workflows/api-tests.yml` and `Makefile` since it will be deprecated Signed-off-by: Rodney Osodo <[email protected]>

Signed-off-by: Rodney Osodo <[email protected]>

This was referenced Feb 20, 2024

NOISSUE - Add property based testing to users service absmach/magistrala-old#146

Closed

NOISSUE - Add property based testing to things service #2088

Merged

Stranger6667 reviewed Feb 21, 2024

View reviewed changes

rodneyosodo force-pushed the users-schemathesis branch from d47354e to 3a8d3d9 Compare February 21, 2024 12:29

drasko requested changes Feb 21, 2024

View reviewed changes

rodneyosodo force-pushed the users-schemathesis branch 6 times, most recently from 9afecd6 to 88932de Compare February 26, 2024 16:46

rodneyosodo force-pushed the users-schemathesis branch 2 times, most recently from 8f20e95 to 64e7f91 Compare March 8, 2024 07:58

rodneyosodo force-pushed the users-schemathesis branch 2 times, most recently from f983000 to 5e139ad Compare March 13, 2024 13:04

arvindh123 reviewed Mar 14, 2024

View reviewed changes

api/openapi/users.yml Show resolved Hide resolved

arvindh123 reviewed Mar 14, 2024

View reviewed changes

users/api/clients.go Show resolved Hide resolved

arvindh123 requested changes Mar 14, 2024

View reviewed changes

arvindh123 reviewed Mar 14, 2024

View reviewed changes

Makefile Show resolved Hide resolved

rodneyosodo force-pushed the users-schemathesis branch 2 times, most recently from 55dc245 to 0f0c948 Compare March 14, 2024 13:55

arvindh123 previously approved these changes Mar 14, 2024

View reviewed changes

rodneyosodo dismissed arvindh123’s stale review via badfe59 March 14, 2024 14:53

rodneyosodo force-pushed the users-schemathesis branch from badfe59 to 58cff82 Compare March 14, 2024 15:30

arvindh123 self-requested a review March 14, 2024 15:40

arvindh123 reviewed Mar 15, 2024

View reviewed changes

internal/groups/service.go Show resolved Hide resolved

arvindh123 approved these changes Mar 15, 2024

View reviewed changes

rodneyosodo force-pushed the users-schemathesis branch from 89037a6 to a3ae2ca Compare March 15, 2024 11:00

rodneyosodo force-pushed the users-schemathesis branch from a3ae2ca to 1a71b80 Compare March 18, 2024 09:00

rodneyosodo added 4 commits March 20, 2024 23:36

Add property based testing to users API using schemathesis

1c775c0

Signed-off-by: Rodney Osodo <[email protected]>

Refactor API test arguments to remove deprecated options

7af5fcb

Removed the `--contrib-unique-data` option from API test arguments in `.github/workflows/api-tests.yml` and `Makefile` since it will be deprecated Signed-off-by: Rodney Osodo <[email protected]>

check USER_TOKEN is not empty

7363e2f

Signed-off-by: Rodney Osodo <[email protected]>

remove svcerr errors from repository layer

b2d87d2

Signed-off-by: Rodney Osodo <[email protected]>

rodneyosodo force-pushed the users-schemathesis branch from 1a71b80 to 5cc92fb Compare March 20, 2024 20:36

add domain login

98af96f

Signed-off-by: Rodney Osodo <[email protected]>

rodneyosodo force-pushed the users-schemathesis branch from 5cc92fb to 98af96f Compare March 20, 2024 20:45

dborovcanin approved these changes Mar 22, 2024

View reviewed changes

dborovcanin merged commit 70c3d65 into absmach:main Mar 22, 2024
6 checks passed

JeffMboya pushed a commit to JeffMboya/supermq that referenced this pull request Apr 3, 2024

NOISSUE - Add property based testing to users service (absmach#2087)

44b58b5

Signed-off-by: Rodney Osodo <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NOISSUE - Add property based testing to users service #2087

NOISSUE - Add property based testing to users service #2087

rodneyosodo commented Feb 20, 2024

Stranger6667 Feb 21, 2024

drasko Feb 21, 2024

drasko Feb 21, 2024

arvindh123 left a comment •

edited

Loading

arvindh123 commented Mar 14, 2024 •

edited

Loading

rodneyosodo commented Mar 15, 2024

NOISSUE - Add property based testing to users service #2087

NOISSUE - Add property based testing to users service #2087

Conversation

rodneyosodo commented Feb 20, 2024

What type of PR is this?

What does this do?

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

Did you document any new/modified feature?

Notes

Stranger6667 Feb 21, 2024

Choose a reason for hiding this comment

drasko Feb 21, 2024

Choose a reason for hiding this comment

drasko Feb 21, 2024

Choose a reason for hiding this comment

arvindh123 left a comment • edited Loading

Choose a reason for hiding this comment

arvindh123 commented Mar 14, 2024 • edited Loading

rodneyosodo commented Mar 15, 2024

arvindh123 left a comment •

edited

Loading

arvindh123 commented Mar 14, 2024 •

edited

Loading