Skip to content

Support Single Select field mapping for storypoints #452

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.

Sign up for GitHub

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

Merged
Bala-Sakabattula merged 7 commits into from
Apr 16, 2026
Merged

Support Single Select field mapping for storypoints #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
99c899b
Support Single Select field mapping for storypoints
Apr 10, 2026
d967795
Add TypeError handling and better error logging for storypoints
Apr 10, 2026
3e0822f
Refactor storypoints processing per code review
Apr 12, 2026
eb3786b
Improve storypoints error logging and add test coverage
Apr 14, 2026
1b9762c
Refactor storypoints code and convert tests to table-driven
Apr 14, 2026
892e7bf
Fix Black formatting for test file
Apr 14, 2026
682541f
Fix storypoints tests to actually exercise the new code paths
Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 47 additions & 11 deletions sync2jira/upstream_issue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,18 +289,54 @@ def add_project_values(issue, upstream, headers, config):
if gh_field_name == prio_field:
issue["priority"] = item.get("name")
continue
sp_field = github_project_fields.get("storypoints", {}).get("gh_field")
sp_dict = github_project_fields.get("storypoints", {})
sp_field = sp_dict.get("gh_field")
if gh_field_name == sp_field:
try:
issue["storypoints"] = int(item["number"])
except (ValueError, KeyError) as err:
log.info(
"Error while processing storypoints for issue %s/%s#%s: %s",
orgname,
reponame,
issuenumber,
err,
)
# Check if there's an options mapping (for Single Select fields); if
# so, convert...
if sp_options := sp_dict.get("options"):
# Single Select field - get name and map it
sp_value = item.get("name")
if not sp_value:
log.warning(
"No Single Select name found for storypoints options in message for issue %s/%s#%s",
orgname,
reponame,
issuenumber,
)
elif (sp_number := sp_options.get(sp_value)) is None:
log.info(
"Storypoints value '%s' not found in options mapping for issue %s/%s#%s",
sp_value,
orgname,
reponame,
issuenumber,
)
else:
try:
issue["storypoints"] = int(sp_number)
except (ValueError, TypeError) as err:
log.info(
"Error converting Single Select storypoints value '%s' to int for issue %s/%s#%s: %s",
sp_number,
orgname,
reponame,
issuenumber,
err,
)
else:
# Number field - get number directly
try:
issue["storypoints"] = int(item["number"])
except (ValueError, TypeError, KeyError) as err:
log.info(
"Error converting Number field storypoints value '%s' to int for issue %s/%s#%s: %s",
item.get("number", "missing"),
orgname,
reponame,
issuenumber,
err,
)
Comment thread
webbnh marked this conversation as resolved.
continue


Expand Down
241 changes: 241 additions & 0 deletions tests/test_upstream_issue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,6 +768,247 @@ def test_add_project_values_early_exit(self, mock_requests_post):
# Reset mock
mock_requests_post.reset_mock()

@mock.patch(PATH + "requests.post")
def test_add_project_values_storypoints(self, mock_requests_post):
"""
Test 'add_project_values' storypoints processing.
Table-driven test covering both error paths and success paths.

Every scenario includes a Priority field as a canary: if the
function returns early (e.g. because of a missing status_code
mock), priority would not be set and the test would fail.
"""
# Set up base config
upstream_config = {
"issue_updates": ["github_project_fields"],
"github_project_number": 1,
}
self.mock_config["sync2jira"]["map"]["github"]["org/repo"] = upstream_config

mock_issue = {
"number": 1234,
"storypoints": None,
"priority": None,
}

# Ensure the mock HTTP response indicates success so the function
# proceeds past the status_code check.
mock_requests_post.return_value.status_code = 200

# Each scenario: (description, github_project_fields,
# field_values_nodes, expected_storypoints)
# All scenarios include a Priority node so we can assert
# priority == "High" as proof we entered the field-processing loop.
scenarios = (
# --- Error scenarios: storypoints should remain None ---
# Test 1: No "storypoints" key in github_project_fields
(
"No storypoints in config",
{"priority": {"gh_field": "Priority"}},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Small"},
],
None,
),
# Test 2: No "gh_field" in storypoints config
(
"No gh_field in storypoints",
{
"priority": {"gh_field": "Priority"},
"storypoints": {"options": {"Small": 5}},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Small"},
],
None,
),
# Test 3: Empty options dict falls through to Number field path
(
"Empty options dict with invalid number",
{
"priority": {"gh_field": "Priority"},
"storypoints": {"gh_field": "Size", "options": {}},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "number": "invalid"},
],
None,
),
# Test 4: Single Select - no "name" in item
(
"Single Select missing name",
{
"priority": {"gh_field": "Priority"},
"storypoints": {
"gh_field": "Size",
"options": {"Small": 5},
},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}},
],
None,
),
# Test 5: Single Select - value not in options mapping
(
"Single Select unmapped value",
{
"priority": {"gh_field": "Priority"},
"storypoints": {
"gh_field": "Size",
"options": {"Small": 5, "Medium": 8},
},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Large"},
],
None,
),
# Test 6: Single Select - ValueError converting mapped value
(
"Single Select invalid mapped value",
{
"priority": {"gh_field": "Priority"},
"storypoints": {
"gh_field": "Size",
"options": {"Small": "not_a_number"},
},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Small"},
],
None,
),
# Test 7: Number field - ValueError from invalid number
(
"Number field invalid value",
{
"priority": {"gh_field": "Priority"},
"storypoints": {"gh_field": "Estimate"},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Estimate"}, "number": "invalid"},
],
None,
),
# Test 8: Number field - KeyError from missing "number" key
(
"Number field missing number key",
{
"priority": {"gh_field": "Priority"},
"storypoints": {"gh_field": "Estimate"},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Estimate"}},
],
None,
),
# --- Success scenarios: storypoints should be set ---
# Test 9: Single Select - valid mapping
(
"Single Select valid mapping",
{
"priority": {"gh_field": "Priority"},
"storypoints": {
"gh_field": "Size",
"options": {"Small": 1, "Medium": 3, "Large": 8},
},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Medium"},
],
3,
),
# Test 10: Single Select - mapped value is a string int
(
"Single Select string mapped value",
{
"priority": {"gh_field": "Priority"},
"storypoints": {
"gh_field": "Size",
"options": {"Small": "2"},
},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Size"}, "name": "Small"},
],
2,
),
# Test 11: Number field - valid number
(
"Number field valid value",
{
"priority": {"gh_field": "Priority"},
"storypoints": {"gh_field": "Estimate"},
},
[
{"fieldName": {"name": "Priority"}, "name": "High"},
{"fieldName": {"name": "Estimate"}, "number": 5},
],
5,
),
)

for description, gpf, field_nodes, expected_sp in scenarios:
with self.subTest(description=description):
upstream_config["github_project_fields"] = gpf
mock_issue["storypoints"] = None
mock_issue["priority"] = None

mock_requests_post.return_value.json.return_value = {
"data": {
"repository": {
"issue": {
"projectItems": {
"nodes": [
{
"project": {
"title": "Project 1",
"number": 1,
},
"fieldValues": {"nodes": field_nodes},
}
]
}
}
}
}
}

u.add_project_values(
issue=mock_issue,
upstream="org/repo",
headers={},
config=self.mock_config,
)

# Priority must be set in every scenario — this is
# our canary that the function actually reached the
# field-processing loop rather than returning early.
self.assertEqual(
mock_issue["priority"],
"High",
f"{description}: priority was not set — function "
f"may have returned early",
)
self.assertEqual(
mock_issue.get("storypoints"),
expected_sp,
f"{description}: expected storypoints={expected_sp}, "
f"got {mock_issue.get('storypoints')}",
)
mock_requests_post.reset_mock()

def test_passes_github_filters(self):
"""
Test passes_github_filters for labels, milestone, and other fields.
Expand Down
Loading