Get Events by Foundation SFDC

[dealako]

Summary

Get Events by Foundation SFDC

Background

Fetch events by FoundationSFDC.

See PRD table 1 step 3.

User Story

As a project manager, I want to see the events for the CLA Group at the foundation level.

Acceptance Criteria

The "done" criteria when this feature or problem is resolved. Such as:

1. Unit Tests added and running in CI
2. Functional Tests updated to cover feature, if applicable
3. Demonstrate the set of capabilities to the product team while the code is running in the STAGING environment.

References

• PRD

[dealako]

Added PR for the Swagger: #1238

[dealako]

Depoyed Swagger spec to DEV - need to complete the repository impl and confirm CSV writer works.

[prasannamahajan]

API: https://api-gw.dev.platform.linuxfoundation.org/cla-service/v4/api-docs#operation/getFoundationEvents

[nirupamav]

Tested and observed below issues
Endpoint https://api-gw.dev.platform.linuxfoundation.org/cla-service/v4/events/foundation/a0941000005osNmAAI

1. Observed that few events were not fetched. Tried below actions and they were not fetched in events.

• Delete CLA group
• Add github username in approval list
• Individual contribution ICLA signature
• Corporate contribution ICLA signature
  @pranab-bajpai @dealako Could you please me know what all events are fetched by this endpoint

2. For event type "UserAssociatedWithCompany" below is the event data where None is displayed instead of user details. Also is this even when contributor is added to approval list? If it is different which event is this?
   

3. For event type "cla_manager.added" observed that company name and project name is not displayed in event data
   

4. Also when CLA group is created even data mentions it as project created
   

5. When CCLA is signed by CLA Manager the event is displayed as EmployeeSignature. Doesn't employee signature mean ICLA signature by employee?
   

[dealako]

@nirupamav thanks so much for reviewing the above.

• Regarding Update code license statements #1
  • CLAMangerDelted event looks to be configured correctly via this bit of code
  • Add GitHub username to the approval list is configured to log the even per this bit of code. All the events relating to the approval list should be generated from this function. Type is: cla_manager.approval_list_updated
  • Updated event code for ICLA and CCLA signature signing
• Resolved Update code license statements #2 added additional details/parameters
• Resolved Add license text for keycloak #3 item above, parameters were not provided to event logger
• Resolved Documentation Update #4 updated text
• Resolved Update DEV.md #5: ICLA is individual, CCLA is slang for both Corporate CLA signed by CLA Manager and Employee Signature. But, in this case you are mentioning it is the CLA document signed by the signatory. I have updated the event logging logic to account for logging all events.

Here's the PR