Add event-notification feature file template by bigludo7 · Pull Request #470 · camaraproject/Commonalities

bigludo7 · 2025-05-28T13:33:39Z

What type of PR is this?

documentation

What this PR does / why we need it:

This is a proposal of Subscription feature template.
I used the nice work done by @maxl2287 in several subscriptions API ;)

Which issue(s) this PR fixes:

Fixes #293

Does this PR introduce a breaking change?

Yes
No

Special notes for reviewers:

Changelog input

 release-note
- add a template for subscription test case.

Additional documentation

This section can be blank.

docs

rartych · 2025-05-28T14:30:09Z

Thanks @bigludo7
We have https://github.com/camaraproject/Commonalities/tree/main/artifacts/testing folder with tests templates, so we need to decide if group together all artifacts related to testing or related to Cloudevents.

The template should be updated with changes included in #464 (when it is merged)

patrice-conil · 2025-06-02T06:54:25Z

artifacts/camara-cloudevents/event-subscription-template.feature

+    When the request "createSubscription" is sent 
+    Then the response code is 201
+    And the response header "Content-Type" is "application/json"
+    And the response header "x-correlator" has same value as the request header "x-correlator"


Maybe we have to mention Location header that points to created subscription?

jlurien

We may include some additional scenario to test the "initialEvent". e.g.

 @<xxx>_subscriptions_XX_subscription_creation_initial_event
  Scenario: Receive initial event notification on creation
    Given the API supports initial events to be sent
    And a valid subscription request body with property "$.config.initialEvent" set to true
    When the request "create<xxx>Subscription" is sent
    Then the response code is 201 or 202	
    And an event notification of the subscribed type is received on callback-url
    And notification body complies with the OAS schema at "#/components/schemas/Subscription"
```
This optional scenario may apply for some implementations

@_subscriptions_XX_subscription_creation_multievent_not_supported
Scenario: Multi event subscription not supported
Given the API provider only allows one event to be subscribed per subscription request
And a valid subscription request body
And the request body property "$.types" is set to an array of 2 valid items
When the request "createSubscription" is sent
Then the response code is 422
And the response property "$.status" is 422
And the response property "$.code" is "MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED"
And the response property "$.message" contains a user friendly text

artifacts/camara-cloudevents/event-subscription-template.feature

jlurien · 2025-06-04T15:27:46Z

artifacts/camara-cloudevents/event-subscription-template.feature

+    And the response property "$.code" is "NOT_FOUND"
+    And the response property "$.message" contains a user friendly text
+
+########Specific Subscription error scenarios when Device object is  used ################


As we have these scenarios included in dedicated artifacts we may just reference the other artifacts to not maintain equivalent scenarios in several places

Yes agree with your proposal @jlurien to remove them to avoid redundancy.
Before to remove them looking for OK from other "usual suspects": @PedroDiez @rartych @patrice-conil OK for you?

I would keep here these tests because the dedicated artifacts
https://github.com/camaraproject/Commonalities/blob/main/artifacts/testing/C02-phoneNumber-errors.feature
https://github.com/camaraproject/Commonalities/blob/main/artifacts/testing/C01-device-errors.feature

They refer to "$.phoneNumber" or "$.device", and in subscription APIs, they are both under "$.config.subscriptionDetail." path so somehow it may be misleading for the reader.

Would this makes sense?

Have aligned with Jose, please forget previous comment, yes we can take out this section from this PR and manage within ongoing #479.
There is a way to make it generic enough to cover both cases of "regular" APIs and "Subscription" APIs

cc @bigludo7 @rartych @patrice-conil

Yes, I have updated #479, so now artifacts are compatible with APIs having device or phoneNumber in paths other than $.xxx

jlurien · 2025-06-04T15:52:34Z

@maxl2287 You may also be interested in reviewing my comments as a common agreement here will ease porting this artifact to the APIs

artifacts/camara-cloudevents/event-subscription-template.feature

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

jlurien · 2025-06-05T12:06:53Z

@bigludo7 please ask me to re-review when you think is ready

bigludo7 · 2025-06-05T13:26:40Z

We may include some additional scenario to test the "initialEvent". e.g.

 @<xxx>_subscriptions_XX_subscription_creation_initial_event
  Scenario: Receive initial event notification on creation
    Given the API supports initial events to be sent
    And a valid subscription request body with property "$.config.initialEvent" set to true
    When the request "create<xxx>Subscription" is sent
    Then the response code is 201 or 202	
    And an event notification of the subscribed type is received on callback-url
    And notification body complies with the OAS schema at "#/components/schemas/Subscription"

This optional scenario may apply for some implementations


@_subscriptions_XX_subscription_creation_multievent_not_supported Scenario: Multi event subscription not supported Given the API provider only allows one event to be subscribed per subscription request And a valid subscription request body And the request body property "$.types" is set to an array of 2 valid items When the request "createSubscription" is sent Then the response code is 422 And the response property "$.status" is 422 And the response property "$.code" is "MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED" And the response property "$.message" contains a user friendly text

Thanks - I added both.
I've add one for INVALID_SINK as well (@<xxx>_subscription_33_invalid_url)

bigludo7 · 2025-06-05T13:33:05Z

@rartych @jlurien @PedroDiez @patrice-conil Thanks all for your review !
I've considered all of them except 2 that need additional work

the one from my colleague @patrice-conil about the header location (will check with Patrice how to accommodate this one)
the comment about keeping the device error cases - I tend to think we can keep it for now waiting that we have a specific .feature file for device error.

Edit: Oh I misunderstood Pedro comment and we have already this feature file for device. I'm fine with Jose proposal just to avoid redundancy and regarding your comment Pedro we can add a note on this on the feature ?

@jlurien

Editorial changes proposed by @jlurien Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Trailing spaces deleted. In line 118: And instead of Then

rartych · 2025-06-13T15:35:23Z

I have commited @jlurien suggestions and then check the linter output and resolved all errors in: cbc4879

Typo

rartych

Reapproved

bigludo7 · 2025-06-16T06:20:16Z

I have commited @jlurien suggestions and then check the linter output and resolved all errors in: cbc4879

Thank you @rartych !!! I was off this last Friday :)

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

artifacts/camara-cloudevents/event-subscription-template.feature

jlurien

LGTM

PedroDiez

LGTM

rartych

LGTM

Add files via upload

4a36e97

bigludo7 requested review from PedroDiez, jlurien, patrice-conil, rartych and shilpa-padgaonkar as code owners May 28, 2025 13:33

patrice-conil reviewed Jun 2, 2025

View reviewed changes

jlurien mentioned this pull request Jun 3, 2025

Improve test-definitions regarding style, structure and format camaraproject/DeviceLocation#331

Merged

rartych added the Fall25 label Jun 3, 2025

jlurien reviewed Jun 4, 2025

View reviewed changes

PedroDiez reviewed Jun 4, 2025

View reviewed changes

bigludo7 and others added 13 commits June 5, 2025 10:25

Update artifacts/camara-cloudevents/event-subscription-template.feature

751223f

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

3ce83a5

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

76103c4

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

6bd50d0

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

f9f23eb

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

fd7dd18

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

b534de0

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

d7e31b6

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

db7931d

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

930ba4e

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

da59d3b

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

695c127

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update artifacts/camara-cloudevents/event-subscription-template.feature

6a7358c

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

Update following team review

39232ba

Apply suggestions from code review

f2cc346

Editorial changes proposed by @jlurien Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

rartych dismissed stale reviews from PedroDiez and themself via f2cc346 June 13, 2025 15:28

Linter problems removed

cbc4879

Trailing spaces deleted. In line 118: And instead of Then

rartych requested review from PedroDiez, jlurien and rartych June 13, 2025 15:35

Update event-subscription-template.feature

ce4bc2f

Typo

rartych previously approved these changes Jun 13, 2025

View reviewed changes

Update artifacts/camara-cloudevents/event-subscription-template.feature

a296876

Co-authored-by: Jose Luis Urien <jlurien@gmail.com>

PedroDiez dismissed rartych’s stale review via a296876 June 16, 2025 07:19

PedroDiez reviewed Jun 16, 2025

View reviewed changes

artifacts/camara-cloudevents/event-subscription-template.feature Outdated Show resolved Hide resolved

jlurien previously approved these changes Jun 16, 2025

View reviewed changes

Update event-subscription-template.feature

c957451

PedroDiez dismissed jlurien’s stale review via c957451 June 16, 2025 08:02

Update event-subscription-template.feature

56915bd

PedroDiez approved these changes Jun 16, 2025

View reviewed changes

PedroDiez requested review from jlurien and rartych June 16, 2025 08:04

jlurien approved these changes Jun 16, 2025

View reviewed changes

rartych approved these changes Jun 16, 2025

View reviewed changes

rartych merged commit bf076e1 into camaraproject:main Jun 16, 2025
1 check passed

Kevsy mentioned this pull request Jun 16, 2025

test: all .feature files need to provide schema context #481

Closed

PedroDiez mentioned this pull request Jul 1, 2025

Fall 25 Feature Files to provide schema context #492

Merged

2 tasks

Conversation

bigludo7 commented May 28, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR introduce a breaking change?

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

rartych commented May 28, 2025

Uh oh!

patrice-conil Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

jlurien 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!

jlurien Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

bigludo7 Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

PedroDiez Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

PedroDiez Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

jlurien Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jlurien commented Jun 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jlurien commented Jun 5, 2025

Uh oh!

bigludo7 commented Jun 5, 2025

Uh oh!

bigludo7 commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rartych commented Jun 13, 2025

Uh oh!

rartych left a comment

Choose a reason for hiding this comment

Uh oh!

bigludo7 commented Jun 16, 2025

Uh oh!

Uh oh!

jlurien left a comment

Choose a reason for hiding this comment

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

rartych left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

jlurien Jun 6, 2025 •

edited

Loading

bigludo7 commented Jun 5, 2025 •

edited

Loading