Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Integration][ADO] Added Support for boards and columns #1034

Merged

Conversation

oiadebayo
Copy link
Member

@oiadebayo oiadebayo commented Sep 19, 2024

Description

What - Added functionality to fetch boards and their respective columns from Azure DevOps.

Why - This feature is necessary to support synchronization of Azure DevOps boards and their columns, allowing for more detailed management and tracking of board data within the system.

How - Implemented a method that fetches boards from Azure DevOps and retrieves their columns. The method also handles cases where the columns field may be missing from the board, ensuring that the system does not break when such cases occur.

Type of change

Please leave one option from the following and delete the rest:

  • New feature (non-breaking change which adds functionality)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

  • Integration able to create all default resources from scratch
  • Resync finishes successfully
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Scheduled resync able to abort existing resync and start a new one
  • Tested with at least 2 integrations from scratch
  • Tested with Kafka and Polling event listeners
  • Tested deletion of entities that don't pass the selector

Integration testing checklist

  • Integration able to create all default resources from scratch
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Resync finishes successfully
  • If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
  • If resource kind is updated, run the integration with the example data and check if the expected result is achieved
  • If new resource kind is added or updated, validate that live-events for that resource are working as expected
  • Docs PR link here

Preflight checklist

  • Handled rate limiting
  • Handled pagination
  • Implemented the code in async
  • Support Multi account

Screenshots

Include screenshots from your environment showing how the resources of the integration will look.
image
image

API Documentation

Provide links to the API documentation used for this integration.
Columns Documentation
Board Documentation

@oiadebayo oiadebayo requested a review from a team as a code owner September 19, 2024 15:34
@oiadebayo oiadebayo requested review from phalbert and PeyGis and removed request for a team September 19, 2024 15:34
@github-actions github-actions bot added size/L and removed size/M labels Sep 19, 2024
Copy link
Contributor

@PeyGis PeyGis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. just some comments

}
},
{
"identifier": "column",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make the identifier consistent with the others azureDevopsBoard, azureDevopsColumn

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The none of the kinds in the default blueprint has this prefix azureDevops

yield [
{
**column,
"__board_id": board.get("id"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return the full board data instead of just the id

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

"__board_id": board.get("id"),
"__project": board.get("__project"),
}
for column in board.get("columns", [])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how this will fit in since the boards API return only name, id and url. How do we get the columns to be returned as part of the boards?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is another function that enriches the data on line 273

@oiadebayo oiadebayo removed the request for review from phalbert September 26, 2024 09:33
Copy link
Member

@matan84 matan84 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mainly add tests, looks good

oiadebayo and others added 4 commits October 2, 2024 11:06
…ent.py

Co-authored-by: Matan <51418643+matan84@users.noreply.github.com>
…ent.py

Co-authored-by: Matan <51418643+matan84@users.noreply.github.com>
@github-actions github-actions bot added size/XL and removed size/L labels Oct 2, 2024
Copy link
Contributor

@omby8888 omby8888 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@PeyGis PeyGis merged commit c4be90e into main Oct 10, 2024
18 checks passed
@PeyGis PeyGis deleted the PORT-10285-Azure-Devops-Integration-Add-Support-for-Boards branch October 10, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants